adjust solution structure

Author: NeVeSpl

NetArchTest.eNhancedEdition.sln

@@ -3,31 +3,46 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.3.32819.101
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest", "src\NetArchTest.Rules\NetArchTest.csproj", "{2FDD6DBD-F203-4EC9-9F9B-6771713CC353}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest", "sources\NetArchTest\NetArchTest.csproj", "{2FDD6DBD-F203-4EC9-9F9B-6771713CC353}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{660FEA1B-C886-4B72-AD70-1D7DD248CD76}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{660FEA1B-C886-4B72-AD70-1D7DD248CD76}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.UnitTests", "test\NetArchTest.Rules.UnitTests\NetArchTest.UnitTests.csproj", "{D56F6954-7CCA-41D6-BA81-850F0C81FE3A}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.UnitTests", "tests\NetArchTest.Rules.UnitTests\NetArchTest.UnitTests.csproj", "{D56F6954-7CCA-41D6-BA81-850F0C81FE3A}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.TestStructure", "test\NetArchTest.TestStructure\NetArchTest.TestStructure.csproj", "{D91C182D-DC97-4F9B-AFFE-8C7A62501DA6}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.TestStructure", "tests\NetArchTest.TestStructure\NetArchTest.TestStructure.csproj", "{D91C182D-DC97-4F9B-AFFE-8C7A62501DA6}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "examples", "examples", "{460F2EC0-8774-4A26-835C-2FFFCAEEE1FA}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.SampleRules", "samples\NetArchTest.SampleRules\NetArchTest.SampleRules.csproj", "{4C5B170E-CAA1-421E-9FA5-9C2D6BEDB27C}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.SampleLibrary", "samples\NetArchTest.SampleLibrary\NetArchTest.SampleLibrary.csproj", "{7123A8AE-678D-4D14-82E5-EB5607ABDC4A}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.CrossAssemblyTest.A", "test\NetArchTest.CrossAssemblyTest.A\NetArchTest.CrossAssemblyTest.A.csproj", "{70B787F2-8B79-4AA5-8C73-26682A605B6B}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.CrossAssemblyTest.A", "tests\NetArchTest.CrossAssemblyTest.A\NetArchTest.CrossAssemblyTest.A.csproj", "{70B787F2-8B79-4AA5-8C73-26682A605B6B}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.CrossAssemblyTest.B", "test\NetArchTest.CrossAssemblyTest.B\NetArchTest.CrossAssemblyTest.B.csproj", "{28692D43-3E08-43E4-BCBB-5940B9F741C6}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.CrossAssemblyTest.B", "tests\NetArchTest.CrossAssemblyTest.B\NetArchTest.CrossAssemblyTest.B.csproj", "{28692D43-3E08-43E4-BCBB-5940B9F741C6}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "documentation", "documentation", "{AD4F8A0F-6F5B-45A6-AC8B-822999097CA3}"
 	ProjectSection(SolutionItems) = preProject
 		documentation\api.md = documentation\api.md
-		api.nt = api.nt
+		documentation\api.nt = documentation\api.nt
 		readme.md = readme.md
+		documentation\readme.nt = documentation\readme.nt
 	EndProjectSection
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NetArchTest.SampleTests", "samples\NetArchTest.SampleTests\NetArchTest.SampleTests.csproj", "{C86E2D57-4566-4713-88DF-0AA265B0EDAC}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SampleApp.BuildingBlocks", "samples\SampleApp.BuildingBlocks\SampleApp.BuildingBlocks.csproj", "{4E5A47CB-2F0B-4F7B-B898-D8BD2B8797C2}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SampleApp", "SampleApp", "{FD532FD5-BB0C-4731-87A5-747FE1A32FBD}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SampleApp.API", "samples\SampleApp.API\SampleApp.API.csproj", "{F54503C5-B053-45EF-967C-B625B876ED88}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SampleApp.ModuleAlpha", "samples\SampleApp.ModuleAlpha\SampleApp.ModuleAlpha.csproj", "{D46D6289-81C2-41D1-B252-0B88BF825660}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SampleApp.ModuleOmega", "samples\SampleApp.ModuleOmega\SampleApp.ModuleOmega.csproj", "{22600143-A90D-42B5-8FA0-9FEC0E962BCC}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SampleApp.SharedKernel", "samples\SampleApp.SharedKernel\SampleApp.SharedKernel.csproj", "{674DBCB9-5F7E-45A1-9862-1CDA64C83B3D}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -62,6 +77,30 @@ Global
 		{28692D43-3E08-43E4-BCBB-5940B9F741C6}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{28692D43-3E08-43E4-BCBB-5940B9F741C6}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{28692D43-3E08-43E4-BCBB-5940B9F741C6}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C86E2D57-4566-4713-88DF-0AA265B0EDAC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C86E2D57-4566-4713-88DF-0AA265B0EDAC}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C86E2D57-4566-4713-88DF-0AA265B0EDAC}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C86E2D57-4566-4713-88DF-0AA265B0EDAC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4E5A47CB-2F0B-4F7B-B898-D8BD2B8797C2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4E5A47CB-2F0B-4F7B-B898-D8BD2B8797C2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4E5A47CB-2F0B-4F7B-B898-D8BD2B8797C2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4E5A47CB-2F0B-4F7B-B898-D8BD2B8797C2}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F54503C5-B053-45EF-967C-B625B876ED88}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F54503C5-B053-45EF-967C-B625B876ED88}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F54503C5-B053-45EF-967C-B625B876ED88}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F54503C5-B053-45EF-967C-B625B876ED88}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D46D6289-81C2-41D1-B252-0B88BF825660}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D46D6289-81C2-41D1-B252-0B88BF825660}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D46D6289-81C2-41D1-B252-0B88BF825660}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D46D6289-81C2-41D1-B252-0B88BF825660}.Release|Any CPU.Build.0 = Release|Any CPU
+		{22600143-A90D-42B5-8FA0-9FEC0E962BCC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{22600143-A90D-42B5-8FA0-9FEC0E962BCC}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{22600143-A90D-42B5-8FA0-9FEC0E962BCC}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{22600143-A90D-42B5-8FA0-9FEC0E962BCC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{674DBCB9-5F7E-45A1-9862-1CDA64C83B3D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{674DBCB9-5F7E-45A1-9862-1CDA64C83B3D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{674DBCB9-5F7E-45A1-9862-1CDA64C83B3D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{674DBCB9-5F7E-45A1-9862-1CDA64C83B3D}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -73,6 +112,13 @@ Global
 		{7123A8AE-678D-4D14-82E5-EB5607ABDC4A} = {460F2EC0-8774-4A26-835C-2FFFCAEEE1FA}
 		{70B787F2-8B79-4AA5-8C73-26682A605B6B} = {660FEA1B-C886-4B72-AD70-1D7DD248CD76}
 		{28692D43-3E08-43E4-BCBB-5940B9F741C6} = {660FEA1B-C886-4B72-AD70-1D7DD248CD76}
+		{C86E2D57-4566-4713-88DF-0AA265B0EDAC} = {460F2EC0-8774-4A26-835C-2FFFCAEEE1FA}
+		{4E5A47CB-2F0B-4F7B-B898-D8BD2B8797C2} = {FD532FD5-BB0C-4731-87A5-747FE1A32FBD}
+		{FD532FD5-BB0C-4731-87A5-747FE1A32FBD} = {460F2EC0-8774-4A26-835C-2FFFCAEEE1FA}
+		{F54503C5-B053-45EF-967C-B625B876ED88} = {FD532FD5-BB0C-4731-87A5-747FE1A32FBD}
+		{D46D6289-81C2-41D1-B252-0B88BF825660} = {FD532FD5-BB0C-4731-87A5-747FE1A32FBD}
+		{22600143-A90D-42B5-8FA0-9FEC0E962BCC} = {FD532FD5-BB0C-4731-87A5-747FE1A32FBD}
+		{674DBCB9-5F7E-45A1-9862-1CDA64C83B3D} = {FD532FD5-BB0C-4731-87A5-747FE1A32FBD}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {4388262D-A716-4918-A629-6072E4F8B668}

README.md

@@ -1,4 +1,4 @@
-[![net-workflow](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/actions/workflows/net-workflow.yml/badge.svg?branch=main)](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/actions/workflows/net-workflow.yml)
+[![net-workflow](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/actions/workflows/net-workflow.yml/badge.svg?branch=main)](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/actions/workflows/net-workflow.yml)
 [![Nuget](https://img.shields.io/nuget/v/NetArchTest.eNhancedEdition?color=%23004880&label=NetArchTest.eNhancedEdition%20nuget)](https://www.nuget.org/packages/NetArchTest.eNhancedEdition)
 
 # NetArchTest.eNhancedEdition
@@ -43,14 +43,14 @@ What **eNhancedEdition** has to offer, that is not available in the NetArchTest
 * [Options](#options)
 * [Limitations](#limitations)
 * API
-   * [Types](documentation/api.md#types)
-   * [Predicate](documentation/api.md#predicate)
-   * [PredicateList](documentation/api.md#predicateList)
-   * [Condition](documentation/api.md#condition)
-   * [ConditionList](documentation/api.md#conditionList)
-   * [TestResult](documentation/api.md#testResult)
-   * [IType](documentation/api.md#itype)
-   * [Options](documentation/api.md#options)
+   * [Types](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/blob/main/documentation/api.md#types)
+   * [Predicate](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/blob/main/documentation/api.md#predicate)
+   * [PredicateList](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/blob/main/documentation/api.md#predicateList)
+   * [Condition](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/blob/main/documentation/api.md#condition)
+   * [ConditionList](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/blob/main/documentation/api.md#conditionList)
+   * [TestResult](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/blob/main/documentation/api.md#testResult)
+   * [IType](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/blob/main/documentation/api.md#itype)
+   * [Options](https://github.com/NeVeSpl/NetArchTest.eNhancedEdition/blob/main/documentation/api.md#options)
 
 
 
@@ -61,37 +61,39 @@ The library is available as a package on NuGet: [NetArchTest.eNhancedEdition](ht
 ### Examples
 
 ```csharp
-static readonly Assembly TestCreationAssembly = typeof(Foo).Assembly;
-
-[TestMethod]
-public void DomainIsNotAccessibleFromOutsideOfModule()
+[TestClass]
+public class SampleApp_ModuleAlpha_Tests
 {
-    var result = Types.InAssembly(AssemblyUnderTest)
-                      .That()
-                      .ResideInNamespace("MyApp.Domain")
-                      .And()
-                      .DoNotHaveNameEndingWith("Const")
-                      .Should()
-                      .NotBePublic()
-                      .GetResult();
-    Assert.IsTrue(result.IsSuccessful);
-}
-
-[TestMethod]
-public void DomainIsIndependent()
-{
-    var result = Types.InAssembly(AssemblyUnderTest)
-                      .That()
-                      .ResideInNamespace("MyApp.Domain")
-                      .ShouldNot()
-                      .HaveDependencyOtherThan( 
-                        "System",                       
-                        "MyApp.SharedKernel.Domain",
-                        "MyApp.BuildingBlocks.Domain"
-                      ) 
-                      .GetResult(); 
-   
-    Assert.IsTrue(result.IsSuccessful, "Domain has lost its independence!");                           
+    static readonly Assembly AssemblyUnderTest = typeof(SampleApp.ModuleAlpha.TestUtils).Assembly;
+    [TestMethod]
+    public void PersistenceIsNotAccessibleFromOutsideOfModuleExceptOfDbContext()
+    {
+        var result = Types.InAssembly(AssemblyUnderTest)
+                          .That()
+                          .ResideInNamespace("SampleApp.ModuleAlpha.Persistence")                              
+                          .And()
+                          .DoNotHaveNameEndingWith("DbContext")
+                          .Should()
+                          .NotBePublic()
+                          .GetResult();
+        Assert.IsTrue(result.IsSuccessful);
+    }
+    [TestMethod]
+    public void DomainIsIndependent()
+    {
+        var result = Types.InAssembly(AssemblyUnderTest)
+                          .That()
+                          .ResideInNamespace("SampleApp.ModuleAlpha.Domain")
+                          .ShouldNot()
+                          .HaveDependencyOtherThan(
+                            "System",
+                            "SampleApp.ModuleAlpha.Domain",
+                            "SampleApp.SharedKernel.Domain",
+                            "SampleApp.BuildingBlocks.Domain"                              
+                          )
+                          .GetResult();
+        Assert.IsTrue(result.IsSuccessful, "Domain has lost its independence!");
+    }
 }
 ```
 
@@ -108,15 +110,15 @@ var types = Types.InAssembly(typeof(MyClass).Assembly);
 ```
 Once you have selected the types you can filter them using one or more predicates. These can be chained together using `And()` or `Or()` conjunctions:
 ```csharp
-types.That().ResideInNamespace(“MyProject.Data”);
+types.That().ResideInNamespace("MyProject.Data");
 ```
 Once the set of classes have been filtered you can apply a set of conditions using the `Should()` or `ShouldNot()` methods, e.g.
 ```csharp
-types.That().ResideInNamespace(“MyProject.Data”).Should().BeSealed();
+types.That().ResideInNamespace("MyProject.Data").Should().BeSealed();
 ```
 Finally, you obtain a result from the rule by using an executor, i.e. use `GetTypes()` to return the types that match the rule or `GetResult()` to determine whether the rule has been met. Note that the result will also return a list of types that failed to meet the conditions.
 ```csharp
-var result = types.That().ResideInNamespace(“MyProject.Data”).Should().BeSealed().GetResult();
+var result = types.That().ResideInNamespace("MyProject.Data").Should().BeSealed().GetResult();
 var isValid = result.IsSuccessful;
 var types = result.FailingTypes;
 ```
@@ -170,13 +172,13 @@ There is only one way, at least for now, to divide types into slices `ByNamespac
 `namespacePrefix.(sliceName).restOfNamespace`
 3) Types with the same `sliceName` part will be placed in the same slice. If `sliceName` is empty for a given type, the type will be also ignored (`BaseFeature` class from folowing image)
 
-![Slices](documentation/slices/slices.png)
+![Slices](https://raw.githubusercontent.com/NeVeSpl/NetArchTest.eNhancedEdition/main/documentation/slices/slices.png)
 
 When we already have our types divided into slices, we can apply condition: `NotHaveDependenciesBetweenSlices()`. As the name suggest it detects if any dependency exists between slices. Dependency from slice to type that is not part of any other slice is allowed.
 
 passing | failing
 --|---
-![Slices](documentation/slices/slices.ok.png)|![Slices](documentation/slices/slices.not.png)
+![Slices](https://raw.githubusercontent.com/NeVeSpl/NetArchTest.eNhancedEdition/main/documentation/slices/slices.ok.png)|![Slices](https://raw.githubusercontent.com/NeVeSpl/NetArchTest.eNhancedEdition/main/documentation/slices/slices.not.png)
 
 
 ## Custom rules
@@ -220,3 +222,4 @@ Available options:
 
 NetArchTest is build on top of [jbevain/cecil](https://github.com/jbevain/cecil) thus it works on CLI level. Unfortunately not every feature of C# language is represented in CLI, thus some things will never be available in NetArchTest, e.g.:
 - BenMorris/NetArchTest#81 - NetArchTest ignores a nameof expression 
+

api.nt

@@ -1 +1,57 @@
-
+{{- config.AddGeneratedFilesToVSProject = false
+capture output 
+      types_type =  data.Classes | Symbols.WhereNamespaceStartsWith "NetArchTest.Rules" | Symbols.WhereNameMatches "^Types$"
+      predicate_type =  data.Classes | Symbols.WhereNamespaceStartsWith "NetArchTest.Rules" | Symbols.WhereNameMatches "^Predicate" 
+      condition_type =  data.Classes | Symbols.WhereNamespaceStartsWith "NetArchTest.Rules" | Symbols.WhereNameMatches "^Condition"
+      testresult_type =  data.Classes | Symbols.WhereNamespaceStartsWith "NetArchTest.Rules" | Symbols.WhereNameMatches "^TestResult" 
+      itype_type =  data.Interfaces | Symbols.WhereNamespaceStartsWith "NetArchTest.Rules" | Symbols.WhereNameMatches "^IType"
+      options_type =  data.Classes | Symbols.WhereNamespaceStartsWith "NetArchTest.Rules" | Symbols.WhereNameMatches "^Options"
+      
+      all_types = types_type | Array.Concat predicate_type | Array.Concat condition_type | Array.Concat testresult_type | Array.Concat itype_type | Array.Concat options_type
+}}    
+
+
+{{- for type in all_types }}
+## {{ type.Name }}
+
+  {{- for method in type.Methods | Symbols.ThatArePublic | Symbols.ThatAreStatic   | Array.Sort "Name" }}
+- [{{method.Name}}](#{{type.BareName}}{{method.BareName}})
+  {{- end }}
+  {{~ for method in type.Methods | Symbols.ThatArePublic | Symbols.ThatAreNotStatic   | Array.Sort "Name" }}
+* [{{method.Name}}](#{{type.BareName}}{{method.BareName}})
+  {{- end }}
+  {{- for prop in type.Properties | Symbols.ThatArePublic | Symbols.ThatAreNotStatic   | Array.Sort "Name" }}
+* [{{prop.Name}}](#{{type.BareName}}{{prop.BareName}})
+  {{- end }}
+{{ end}}
+
+
+
+{{- for type in all_types }}
+## {{ type.Name }}
+
+  {{- for method in type.Methods | Symbols.ThatArePublic  | Array.Sort "Name" }}
+### {{type.BareName}}.{{method.Name}}
+```csharp
+{{method.FullName}}
+```
+{{ method.DocComment.Summary | String.StripNewlines }}
+  {{- end }}
+ 
+  {{- for prop in type.Properties | Symbols.ThatArePublic | Symbols.ThatAreNotStatic   | Array.Sort "Name" }}
+### {{type.BareName}}.{{prop.Name}}
+```csharp
+{{prop.FullName}}
+```
+  {{~ prop.DocComment.Summary | String.StripNewlines }}
+  {{- end }}
+{{ end}}
+
+ 
+
+
+    
+{{   
+    end
+    Save output "api.md"
+-}}