Merge branch 'master' of https://github.com/aspnetboilerplate/aspnetboilerplate

Author: ltvan

.gitignore

@@ -5,9 +5,13 @@
 # Logs
 Logs/
 
+# Generated files
+project.lock.json
+.vs/
+
 # Nuget packages
 nupkg/*.nupkg
-nupkg/push_abp_framework.bat
+nupkg/push.bat
 
 # Profile images
 ProfileImages/
@@ -119,4 +123,6 @@ UpgradeLog*.XML
 src/.vs/config/applicationhost.config
 
 # GitLink
-!GitLink.exe
+!GitLink.exe
+!nuget.exe
+!SQLite.Interop.dll

Abp.sln

@@ -2,6 +2,8 @@
 ASP.NET Boilerplate
 ===================
 
+AppVeyor: [![Build status](https://ci.appveyor.com/api/projects/status/tvad583r9lbimxh4?svg=true)](https://ci.appveyor.com/project/hikalkan/aspnetboilerplate)
+
 What is ABP?
 ------------
 

AbpLayers.png

@@ -0,0 +1,17 @@
+version: 1.0.{build}
+before_build:
+- cmd: dotnet.exe restore
+build:
+  verbosity: minimal
+test:
+  assemblies:
+  - test\Abp.AutoMapper.Tests\bin\Debug\net452\win7-x64\Abp.AutoMapper.dll
+  - test\Abp.EntityFramework.Tests\bin\Debug\net452\win7-x64\Abp.EntityFramework.Tests.dll
+  - test\Abp.MemoryDb.Tests\bin\Debug\net452\win7-x64\Abp.MemoryDb.Tests.dll
+  - test\Abp.NHibernate.Tests\bin\Debug\net452\win7-x64\Abp.NHibernate.Tests.dll
+  - test\Abp.TestBase.SampleApplication.Tests\bin\Debug\net452\win7-x64\Abp.TestBase.SampleApplication.Tests.dll
+  - test\Abp.TestBase.Tests\bin\Debug\net452\win7-x64\Abp.TestBase.Tests.dll
+  - test\Abp.Tests\bin\Debug\net452\win7-x64\Abp.Tests.dll
+  - test\Abp.Web.Api.Tests\bin\Debug\net452\win7-x64\Abp.Web.Api.Tests.dll
+  - test\Abp.Web.Mvc.Tests\bin\Debug\net452\win7-x64\Abp.Web.Mvc.Tests.dll
+  - test\Abp.Web.Tests\bin\Debug\net452\win7-x64\Abp.Web.Tests.dll

README.md

@@ -114,6 +114,95 @@ <h3>Configuration</h3>
 first request). Configuration is not restricted to DefaultSlidingExpireTime 
 only, since cache object is an ICache, you can use it's properties and methods 
 freely configure and initialize it.</p>
+			<h3>Entity Caching</h3>
+			<p>While ASP.NET Boilerplate's cache system is general purpose, 
+			there is an <strong>EntityCache </strong> base class that can help you if you want to 
+			cache entities. We can use this base class if we get entities by 
+			their Ids and we want to <strong>cache them by Id</strong> to not 
+			query from database frequently. Assume that we have a Person entity 
+			like that:</p>
+			<pre lang="cs">public class Person : Entity
+{
+    public string Name { get; set; }
+
+    public int Age { get; set; }
+}</pre>
+			<p>And assume that we frequently want to get <strong>Name</strong> of people while we know their 
+			<strong>Id</strong>. 
+			First, we should create a class to store <strong>cache items</strong>:</p>
+			<pre lang="cs"><strong>[AutoMapFrom(typeof(Person))]</strong>
+public class PersonCacheItem
+{
+    public string Name { get; set; }
+}
+</pre>
+			<p>We <strong>should not directly store entities in the cache</strong> since 
+			caching may need to <strong>serialize</strong> cached objects and 
+			entities may not be serialized (especially if they have navigation 
+			properties). That's why we defined a simple class to store data in 
+			the cache. We added <strong>
+			AutoMapFrom</strong> attribute since we want to use AutoMapper to 
+			convert Person entities to PersonCacheItem objects. If we don't use 
+			AutoMapper, we should <strong>override MapToCacheItem</strong> 
+			method of EntityCache class to manually convert/map it.</p>
+			<p>While it's <strong>not required</strong>, we may want to define an interface for 
+			our cache class:</p>
+			<pre lang="cs">public interface IPersonCache : <strong>IEntityCache&lt;PersonCacheItem&gt;</strong>
+{
+
+}</pre>
+			<p>Finally, we can create the cache class to cache Person entities:</p>
+			<pre lang="cs">public class PersonCache : <strong>EntityCache&lt;Person, PersonCacheItem&gt;</strong>, IPersonCache, <strong>ITransientDependency</strong>
+{
+    public PersonCache(ICacheManager cacheManager, IRepository&lt;Person&gt; repository)
+        : base(cacheManager, repository)
+    {
+
+    }
+}</pre>
+			<p>That's all. Our person cache is ready to use. Cache class can be 
+			transient (as in this example) or singleton. This does not mean the 
+			cached data is transient. It's always cached globally and accessed 
+			thread-safe in your application.</p>
+			<p>Now, whenever we 
+			need <strong>Name</strong> of a person, we can get it from cache by 
+			the person's 
+			<strong>Id</strong>. An example class that uses the Person cache:</p>
+			<pre lang="cs">public class MyPersonService : ITransientDependency
+{
+    private readonly IPersonCache _personCache;
+
+    public MyPersonService(<strong>IPersonCache personCache</strong>)
+    {
+        _personCache = personCache;
+    }
+
+    public string GetPersonNameById(int id)
+    {
+        <strong>return _personCache[id].Name;</strong> //alternative: _personCache.Get(id).Name;
+    }
+}</pre>
+			<p>We simply <a href="Dependency-Injection.html">injected</a> 
+			IPersonCache, got the cache item and got the Name property.</p>
+			<h4>How EntityCache Works</h4>
+			<ul>
+				<li>It gets entity from repository (from database) in first 
+				call. Then gets from cache in subsequent calls.</li>
+				<li>It automatically invalidates cached entity if this entity is 
+				updated or deleted. Thus, it will be retrieved from database in 
+				the next call.</li>
+				<li>It uses IObjectMapper to map entity to cache item. 
+				IObjectMapper is implemented by AutoMapper module. So, you need 
+				to
+				<a href="/Pages/Documents/Data-Transfer-Objects#DocAutoMappingHelpers">
+				AutoMapper module</a> if you are using it. You can override 
+				MapToCacheItem method to manually map entity to cache item.</li>
+				<li>It uses cache class's FullName as cache name. You can change 
+				it by passing a cache name to the base constructor.</li>
+				<li>It's thread-safe.</li>
+			</ul>
+			<p>If you need more complex caching requirements, you can extend 
+			EntityCache or create your own solution.</p>
 			<h3>Redis Cache Integration</h3>
 			<p>Default cache manager uses <strong>in-memory</strong> caches. So, it can be a 
 			problem if you have more than one concurrent web server running the 

appveyor.yml

@@ -55,8 +55,6 @@ <h3>ABP Framework</h3>
 						<li>
 							<a href="/Pages/Documents/OWIN">OWIN Integration</a>
 						</li>
-						<li>
-							<a href="/Pages/Documents/Debugging">Debugging</a></li>
 					</ul>
 				</li>
 				<li>Common Structures</li>

doc/WebSite/Caching.html

@@ -90,6 +90,12 @@ <h3 id="DocDefiningSettings">Defining settings</h3>
 				<li>
 					<strong>IsVisibleToClients</strong>: Set true to make a setting usable 
 	on the client side.</li>
+				<li>
+					<strong>isInherited</strong>: Used to set if this setting is 
+					inherited by tenant and users (See setting scope section).</li>
+				<li>
+					<strong>customData</strong>: Can be used to set a custom 
+					data for this setting definition.</li>
 			</ul>
 			<p>After creating a setting provider, we should register it in PreIntialize 
 method of our module:</p>
@@ -117,7 +123,8 @@ <h4 id="DocSettingScopes">Setting scope</h4>
 			</ul>
 			<p>SettingScopes enum has <strong>Flags </strong>attribute, so we can define a 
 setting with <strong>more than one scopes</strong>.</p>
-			<p>Setting scope is <strong>hierarchic</strong>. For example, if we define a 
+			<p>Setting scope is <strong>hierarchic</strong> by default (unless 
+			you set <strong>isInherited</strong> to false). For example, if we define a 
 setting's scope as "Application | Tenant | User" and try to get <strong>current value 
 				</strong>of the the 
 setting;</p>

doc/WebSite/Documents.html

@@ -0,0 +1,6 @@
+{
+  "projects": [ "src", "test" ],
+  "sdk": {
+    "version": "1.0.0-preview1-002702"
+  }
+}

doc/WebSite/Setting-Management.html

@@ -0,0 +1,24 @@
+REM "..\tools\gitlink\GitLink.exe" ..\ -u https://github.com/aspnetboilerplate/aspnetboilerplate -c release
+
+@ECHO OFF
+SET /P VERSION_SUFFIX=Please enter version-suffix (can be left empty): 
+
+dotnet "pack" "..\src\Abp" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.AutoMapper" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.HangFire" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.EntityFramework" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.FluentMigrator" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.MemoryDb" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.MongoDB" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.NHibernate" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.RedisCache" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.Owin" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.Web" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.Web.Api" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.Web.Mvc" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.Web.SignalR" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.Web.Api.OData" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.TestBase" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+dotnet "pack" "..\src\Abp.Web.Resources" -c "Release" -o "." --version-suffix "%VERSION_SUFFIX%"
+
+pause