Fixed broken link

Added documentation about construction, indexers and events

Author: oswaldsql

docs/ADR/README.md

@@ -24,7 +24,7 @@ All the ADRs have been approved and are considered final decisions for the proje
 - [Support for Events](feature/SupportForEvents.md) - Decision on supporting events in the mocking framework.
 - [Support for Indexers](feature/SupportForIndexers.md) - Decision on supporting indexers in the mocking framework.
 - Special cases
-  - [Allowing Skipping Arguments in Mock Setup](general/SupportSkippingArguments.md) - Allows skipping arguments in mock setups for flexibility.
+  - [Allowing Skipping Arguments in Mock Setup](feature/SupportSkippingArguments.md) - Allows skipping arguments in mock setups for flexibility.
   - [Support for Protected Methods](feature/SupportingProtectedMethods.md) - Decision on whether to support mocking protected methods.
   - [Support for Generic Methods (WIP)](feature/SupportForGenericMethods.md) - Decision on supporting generic methods in the mocking framework.
   - [Support for Asynchronous Methods (WIP)](feature/SupportForAsynchronousMethods.md) - Handling asynchronous methods in the mocking framework.

docs/README.md

@@ -32,8 +32,8 @@ MiniMock offers a _minimalistic_ approach to mocking in .NET with a focus on sim
 
 Try it out or continue with [Getting started](guide/getting-started.md) to learn more or read the [Mocking guidelines](guide/mocking-guidelines.md) to get a better understanding of when, why and how to mock and when not to.
 
-For more details on specific aspects you can read about [Methods](guide/methods.md), [Properties](guide/properties.md), [Events](guide/events.md) or 
-[Indexers](guide/indexers.md). 
+For more details on specific aspects you can read about [Construction](guide/construction.md) [Methods](guide/methods.md), [Properties](guide/properties.md), [Events](guide/events.md) or 
+[Indexers](guide/indexers.md).
 Or you shift into high gear with [Advanced Features](advanced-features.md), [FaQ](faq.md) or [Troubleshooting](troubleshooting.md).
 
-If you are more into the ins and outs of MiniMock you can read the [Motivation](motivation.md) behind MiniMock or the [ADRs](../ADR/README.md).
+If you are more into the ins and outs of MiniMock you can read the [Motivation](motivation.md) behind MiniMock or the [ADRs](ADR/README.md).

docs/guide/construction.md

@@ -0,0 +1,29 @@
+# Construction
+
+__TL;DR__
+
+```csharp
+[Fact]
+[Mock<IVersionLibrary>] // Signals minimock to build a mock object for IVersionLibrary.
+public void MockInitialization()
+{
+    // Mock without anything mocked used to satisfy dependencies not used in the tests execution path
+    var emptyMock = Mock.IVersionLibrary();
+
+    // Mock with inline configuration useful for most setup scenarios
+    var inlineMock = Mock.IVersionLibrary(config => config
+        .DownloadExists(true)
+    );
+
+    // Mock with external configuration useful for more complex scenarios like testing events and modifying mock behaviour.
+    var externalMock = Mock.IVersionLibrary(out var config);
+    config.DownloadExists(true);
+
+    // Direct access to the mock implementation.
+    var implementationMock = new MockOf_IVersionLibrary(config => config
+        .DownloadExists(true)
+    );
+}
+```
+
+~~~~

docs/guide/events.md

@@ -0,0 +1,35 @@
+# Events
+
+__TL;DR__
+
+```csharp
+public interface IVersionLibrary
+{
+    event EventHandler<Version> NewVersionAdded;
+}
+
+Action<Version> triggerNewVersionAdded = _ => { };
+
+var versionLibrary = Mock.IVersionLibrary(config => config
+        .NewVersionAdded(raise: new Version(2, 0, 0, 0)) // Raises the event right away
+        .NewVersionAdded(trigger: out triggerNewVersionAdded) // Provides a trigger for when a new version is added
+);
+
+// Inject into system under test
+
+triggerNewVersionAdded(new Version(2, 0, 0, 0));
+```
+
+Alternative to creating a action for triggering the is to use the out parameter for configuration instead. 
+```csharp
+var versionLibrary = Mock.IVersionLibrary(out var config);
+
+// Inject into system under test
+
+config.NewVersionAdded(raise: new Version(2, 0, 0, 0));
+```
+
+__Please note__
+
+- Parameter-names can be omitted but makes the code more readable.
+- Unlike other members, events does not need to be specified in order to be subscribed to by the system under test.

docs/guide/indexers.md

@@ -0,0 +1,25 @@
+# Indexers
+
+__TL;DR__
+
+```csharp
+public interface IVersionLibrary
+{
+    Version this[string key] { get; set; }
+}
+
+var versions = new Dictionary<string, Version> { { "current", new Version(2, 0, 0, 0) } };
+
+var versionLibrary = Mock.IVersionLibrary(config => config
+        .Indexer(get: key => new Version(2, 0, 0, 0), set: (key, value) => { }) // Overwrites the indexer getter and setter
+        .Indexer(values: versions) // Provides a dictionary to retrieve and store versions
+);
+
+// Inject into system under test
+```
+
+__Please note__
+
+- Multiple specifications for an indexer will overwrite each other with the last one taking precedence.
+- Parameter-names can be omitted but make the code more readable.
+- Any indexer that is not explicitly specified will throw an `InvalidOperationException` when called.

docs/guide/methods.md

@@ -1,13 +1,35 @@
 # Methods
 
-Start by creating a mock of the interface or class you want to mock.
+__TL;DR__
 
 ```csharp
-var mockVersionLibrary = Mock.IVersionLibrary(config => config.
-    [Your mock setup here]
+public interface IVersionLibrary
+{
+        bool DownloadExists(string version);
+        bool DownloadExists(Version version);
+        Task<Uri> DownloadLinkAsync(string version);
+ }
+
+var versionLibrary = Mock.IVersionLibrary(config => config
+        .DownloadExists(returns: true) // Returns true for all versions
+        .DownloadExists(throws: new IndexOutOfRangeException()) // Throws IndexOutOfRangeException for all versions
+        .DownloadExists(call: s => s.StartsWith(value: "2.0.0")) // Returns true for version 2.0.0.x base on a string parameter
+        .DownloadExists(call: v => v is { Major: 2, Minor: 0, Revision: 0 }) // Returns true for version 2.0.0.x based on a version parameter
+        .DownloadExists(returnValues: [true, true, false]) // Returns true two times, then false
+
+        .DownloadLinkAsync(returns: Task.FromResult(result: new Uri(uriString: "http://downloads/2.0.0"))) // Returns a task containing a download link for all versions
+        .DownloadLinkAsync(call: s => Task.FromResult(result: s.StartsWith(value: "2.0.0") ? new Uri(uriString: "http://downloads/2.0.0") : new Uri(uriString: "http://downloads/UnknownVersion"))) // Returns a task containing a download link for version 2.0.0.x otherwise a error link
+        .DownloadLinkAsync(throws: new TaskCanceledException()) // Throws IndexOutOfRangeException for all parameters
+        .DownloadLinkAsync(returns: new Uri(uriString: "http://downloads/2.0.0")) // Returns a task containing a download link for all versions
+        .DownloadLinkAsync(call: s => s.StartsWith(value: "2.0.0") ? new Uri(uriString: "http://downloads/2.0.0") : new Uri(uriString: "http://downloads/UnknownVersion")) // Returns a task containing a download link for version 2.0.0.x otherwise a error link
+        .DownloadLinkAsync(returnValues: [Task.FromResult(result: new Uri(uriString: "http://downloads/1.0.0")), Task.FromResult(result: new Uri(uriString: "http://downloads/1.1.0")), Task.FromResult(result: new Uri(uriString: "http://downloads/2.0.0"))]) // Returns a task with a download link
+        .DownloadLinkAsync(returnValues: [new Uri(uriString: "http://downloads/2.0.0"), new Uri(uriString: "http://downloads/2.0.0"), new Uri(uriString: "http://downloads/2.0.0")]) // Returns a task with a download link
 );
+
+// Inject into system under test
 ```
-Please note
+
+__Please note__
 
 - Multiple specifications for a method will overwrite each other with the last one taking precedence.
 - Parameter-names can be omitted but makes the code more readable.

docs/guide/properties.md

@@ -1,3 +1,24 @@
 # Properties
 
-__WIP__
+__TL;DR__
+
+```csharp
+public interface IVersionLibrary
+{
+    Version CurrentVersion { get; set; }
+}
+
+var versionLibrary = Mock.IVersionLibrary(config => config
+    .CurrentVersion(get: () => new Version(major: 2, minor: 0, build: 0, revision: 0), set: version => throw new IndexOutOfRangeException()) // Overwrites the property getter and setter
+    .CurrentVersion(value: new Version(major: 2, minor: 0, build: 0, revision: 0)) // Sets the initial version to 2.0.0.0
+);
+
+// Inject into system under test
+
+```
+
+__Please note__ 
+
+- Multiple specifications for a property will overwrite each other with the last one taking precedence.
+- Parameter-names can be omitted but make the code more readable.
+- Any property that is not explicitly specified will throw an `InvalidOperationException` when called.

tests/MiniMock.Tests/Demo.cs

@@ -70,6 +70,28 @@ public async Task TestingAllTheOptions()
         triggerNewVersionAdded(new Version(2, 0, 0, 0));
     }
 
+    [Fact]
+    [Mock<IVersionLibrary>]
+    public void MockInitialization()
+    {
+        // Mock without anything mocked used to satisfy dependencies not used in the tests execution path
+        var emptyMock = Mock.IVersionLibrary();
+
+        // Mock with inline configuration useful for most setup scenarios
+        var inlineMock = Mock.IVersionLibrary(config => config
+            .DownloadExists(true)
+        );
+
+        // Mock with external configuration useful for more complex scenarios like testing events and modifying mock behaviour.
+        var externalMock = Mock.IVersionLibrary(out var config);
+        config.DownloadExists(true);
+
+        // Direct access to the mock implementation.
+        var implementationMock = new MockOf_IVersionLibrary(config => config
+            .DownloadExists(true)
+        );
+    }
+
     [Fact]
     [Mock<IVersionLibrary>]
     public void SimpleReturnValue()