Merge pull request #101 from jbatte47/meta/issue-80

Issue #80: changelog and readme updated

Author: TheTribe

README.md

@@ -1,14 +1,13 @@
-Welcome!
+Welcome to code-patterns
 =============
 
-## You've found my .NET utility belt. ##
-## It's constantly growing, and its entire goal is to make life easier for .NET developers. ##
+## A general-purpose set of libraries designed to make life easier for .NET developers ##
 
 Here are the highlights:
 
-* This is the official codebase used for [NuGet distributions of Patterns](https://nuget.org/packages?q=id%3A+Patterns%3B+author%3A+%22John+Batte%22).
-* Check the [official code patterns site](http://jbatte47.github.io/code-patterns/) for API documentation and additional information.
-* Head over to [the wiki](https://github.com/jbatte47/code-patterns/wiki) for user-contributed content.
-* You can also check out [the license file](https://github.com/jbatte47/code-patterns/blob/master/license.txt "FreeBSD (2-Clause)") if you're wondering about that.
+* This is the official codebase used for [NuGet distributions of Patterns](https://nuget.org/packages?q=id%3A+Patterns%3B+author%3A+%22John+Batte%22 "'Patterns' packages with 'John Batte' listed as the author").
+* Check the [official code patterns site](http://TheTribe.github.io/code-patterns/ "featuring code samples and Doxygen-generated html") for API documentation and additional information.
+* Head over to [the wiki](https://github.com/TheTribe/code-patterns/wiki) for user-contributed content.
+* You can also check out [the license file](https://github.com/TheTribe/code-patterns/blob/master/license.txt "FreeBSD (2-Clause)") if you're wondering about that.
 
 Hopefully you'll find these libraries as useful as I do. Cheers!

changelog.md

@@ -1,37 +1,128 @@
-## Patterns Changelog ##
+# Patterns Changelog #
 
-**3.9.0**
+The following log details the outward-facing changes made to code-patterns since its first migration to GitHub.
 
-- Added `Patterns.Collections.ConfigurableEqualityComparer<TValue>` (Issue #66)
-- Fixed type casting error in `Patterns.Testing.Autofac.Moq.AutofacMoqContainer` (Issue #67)
-- Fixed issue with up-front service type inspection in `Patterns.Testing.Autofac.Moq.MoqRegistrationSource` (Issue #68)
-- Added `IRegexEvaluator` and `RegexEvaluator` to the `Patterns.Text.RegularExpressions` namespace (Issue #69)
-- Added `Evaluator` and `EvaluatorAccessor` to `System.Text.RegularExpressions.CompiledRegex` (Issue #70)
+## 3.10-beta.1 ##
+
+- Additions / changes made to `Patterns.Logging` and `Patterns.Interception` ([issue 96](https://github.com/TheTribe/code-patterns/issues/96)):
+ - New type: `Patterns.Interception.DelegateInterceptor` &rarr; implements `IInterceptor` by allowing interception actions taken at each step to be injected
+ - Updated `LoggingInterceptor` to inherit from new `DelegateInterceptor` type
+
+## 3.9.4 ##
+
+- Fixes for `Patterns.Logging` / `Patterns.Autofac.Logging` ([issue 92](https://github.com/TheTribe/code-patterns/issues/92)):
+ - Extracted `ILoggingConfig` from `LoggingConfig`
+ - Switched to interface usage everywhere
+ - Modified `LoggingModule` logic to allow config source to be unregistered / config section to be missing; either case results in a default instance of `LoggingConfig` to be registered
+- Changed `MoqRegistrationSource` to only return registrations when creating new Mock-based ones; now returns an empty set in all other cases ([issue 93](https://github.com/TheTribe/code-patterns/issues/93))
+
+
+## 3.9.3 ##
+
+- Updated out-of-date NuGet references ([issue 73](https://github.com/TheTribe/code-patterns/issues/73))
+
+## 3.9.2 ##
+
+- Changed `AutofacMoqContainer` to defensively call `Create` from within `Mock` using `Try.Get` ([issue 84](https://github.com/TheTribe/code-patterns/issues/84))
+
+## 3.9.1 ##
+
+- Changed `LoggingInterceptor` to use the CLR `JavaScriptSerializer` to format complex values for display ([issue 81](https://github.com/TheTribe/code-patterns/issues/81))
+
+## 3.9.0 ##
+
+- Added `Patterns.Collections.ConfigurableEqualityComparer<TValue>` ([issue 66](https://github.com/TheTribe/code-patterns/issues/66))
+- Fixed type casting error in `Patterns.Testing.Autofac.Moq.AutofacMoqContainer` ([issue 67](https://github.com/TheTribe/code-patterns/issues/67))
+- Fixed issue with up-front service type inspection in `Patterns.Testing.Autofac.Moq.MoqRegistrationSource` ([issue 68](https://github.com/TheTribe/code-patterns/issues/68))
+- Added `IRegexEvaluator` and `RegexEvaluator` to the `Patterns.Text.RegularExpressions` namespace ([issue 69](https://github.com/TheTribe/code-patterns/issues/69))
+- Added `Evaluator` and `EvaluatorAccessor` to `System.Text.RegularExpressions.CompiledRegex` ([issue 70](https://github.com/TheTribe/code-patterns/issues/70))
 - Added `Patterns.Runtime.TemporaryScope`
 - Added `ActionValueStrategies<TValue>`
 - Added `FuncValueStrategies<TValue, TOut>`
 
-**3.8.1** - Expanded capabilities of `Patterns.Mapping.IMappingServices` (issue #65)
+## 3.8.1 ##
+
+- Expanded capabilities of `Patterns.Mapping.IMappingServices` ([issue 65](https://github.com/TheTribe/code-patterns/issues/65))
+
+## 3.8.0 ##
+
+- Renamed `Patterns.Autofac.Sources.ResolveAnythingSource` to `Patterns.Autofac.Sources.ResolveCreatableSource` ([issue 43](https://github.com/TheTribe/code-patterns/issues/43))
+- Moved Moq-related components from `Patterns.Testing.Autofac` to `Patterns.Testing.Autofac.Moq` ([issue 59](https://github.com/TheTribe/code-patterns/issues/59))
+- Added the "strategy dictionary" pattern to the `Patterns.Collections.Strategies` namespace ([issue 59](https://github.com/TheTribe/code-patterns/issues/59))
+- Added a short-circuit `Map<TSource,TDestination>` method to `Patterns.Mapping.IMappingServices` ([issue 61](https://github.com/TheTribe/code-patterns/issues/61))
+
+## 3.7.2 ##
+
+- Fixed `sectionGroup` bug in `TestConfigurationSource` ([Issue 60](https://github.com/TheTribe/code-patterns/issues/60)) 
+
+## 3.7.1 ##
+
+- Fixes for Autofac ([issue 57](https://github.com/TheTribe/code-patterns/issues/57))
+ - Moved/renamed `MoqContainer` to `Patterns.Testing.Autofac.AutofacMoqContainer`
+ - Extracted new interface, `Patterns.Testing.Autofac.IAutofacMoqContainer` &rarr; provides access to Autofac-specific features
+
+## 3.7.0 ##
+
+- New component in `Patterns.Testing.Configuration`: `TestConfigurationSource` &rarr; implements `IConfigurationSource` by accepting XML in its constructor and using the in-memory XML as the basis for retrievals of `AppSettings` and `ConnectionStrings` as well as calls to `GetSection` ([issue 35](https://github.com/TheTribe/code-patterns/issues/35))
+
+## 3.6.0-beta ##
+
+- New components in `Patterns.Mapping` (new dependency: [AutoMapper](https://www.nuget.org/packages/AutoMapper/)):
+	- `IMappingServices` &rarr; encapsulates `IMappingEngine`, `IConfiguration`, and `IConfigurationProvider` from AutoMapper ([issue 53](https://github.com/TheTribe/code-patterns/issues/53))
+	- `MappingServices` &rarr; simplest implementation of `IMappingEngine`; uses constructor injection
+- New module in `Patterns.Autofac.Mapping`: `MappingModule` &rarr; registers static AutoMapper assets to facilitate injection into `MappingServices` ([issue 54](https://github.com/TheTribe/code-patterns/issues/54))
 
-**3.8.0**
+## 3.5.1-beta ##
 
-- Renamed `Patterns.Autofac.Sources.ResolveAnythingSource` to `Patterns.Autofac.Sources.ResolveCreatableSource` (issue #43)
-- Moved Moq-related components from `Patterns.Testing.Autofac` to `Patterns.Testing.Autofac.Moq` (issue #58)
-- Added the "strategy dictionary" pattern to the `Patterns.Collections.Strategies` namespace (issue #59)
-- Added a short-circuit `Map<TSource,TDestination>` method to `Patterns.Mapping.IMappingServices` (issue #61)
+- Changes to `Patterns.Logging`:
+ - New type: `LoggingConfig` &rarr; inherits from `ConfigurationSection`; encapsulates the `bool TrapExceptions` option
+ - Changed `LoggingInterceptor` to use `LoggingConfig` rather than explicit `bool` option for exception trapping
+- Solution-wide refactor: moved components to more appropriate locations
 
-**3.7.2**
+## 3.5.0-beta ##
 
-**3.7.1**
+- Removed `Patterns.Testing.Runtime.TestDateTimeInfo` &rarr; mocks are easier to work with than this type
+- New components in `Patterns.Reflection`:
+ - `PropertyValue` &rarr; holds metadata and runtime value of a property
+ - `IEnumerable<PropertyValue> object.GetPropertyValues()` (extension)
 
-**3.7.0**
+## 3.4.0-beta ##
 
-**3.6.0-beta**
+- New logging components in `Patterns.Logging` (new dependency: [Castle.Core](https://www.nuget.org/packages/Castle.Core/)):
+ - `LoggingInterceptor` &rarr; implements `IInterceptor` by calling the appropriate `ILog` methods throughout interception ([issue 12](https://github.com/TheTribe/code-patterns/issues/12))
+ - `string Exception.ToFullString()` (extension) &rarr; concatenates exception messages, stack traces and inner exceptions (recursive)
+- New Autofac support for `Patterns.Logging` in `Patterns.Autofac.Modules`:
+ - `LoggingModule` &rarr; registers `LoggingInterceptor`, as well as attaching to all registrations in order to provide appropriately type-bound instances of `ILog` on-demand
+- New Autofac container type for increased accessibility: `Patterns.Autofac.AccessibleContainer`
+- New Moq / IoC components in `Patterns.Testing.Moq`:
+ - `IMoqContainer` (depends on Microsoft.Practices.ServiceLocation and Moq) &rarr; exposes `IServiceLocator`; provides full IoC container support; provides `Mock{TObject}` creation support
+ - `MoqRegistrationSource` &rarr; implements Autofac's `IRegistrationSource` by creating Mocks of services when registrations are missing
+ - `MoqContainer` &rarr; implements `IMoqContainer` by using Autofac with `MoqRegistrationSource`
 
-**3.5.1-beta**
+## 3.3.1-beta ##
 
-**3.5.0-beta**
+- New Autofac-based components (new dependencies [Autofac](https://www.nuget.org/packages/Autofac/) and [Autofac.CommonServiceLocator.Indy](https://www.nuget.org/packages/Autofac.CommonServiceLocator.Indy/)):
+ - `Patterns.Autofac.Modules.CoreModule` &rarr; registers all non-specialized interface-based components in Patterns
+ - `Patterns.Autofac.Modules.ConfigurationModule` &rarr; registers all components needed to support `IConfigurationSource` injection ([issue 3](https://github.com/TheTribe/code-patterns/issues/3))
+ - `Patterns.Autofac.Sources.ResolveAnythingSource` &rarr; resolve-anything-creatable implementation of Autofac's `IRegistrationSource` 
+- New extensions in `Patterns.Collections`:
+ - `void ICollection{TItem}.AddRange(IEnumerable{TItem} newItems)`
+ - `void IEnumerable{TItem}.Each(Action{TItem} action[, bool parallel = false])`
+- New configuration abstraction types in `Patterns.Configuration`:
+ - `IConfiguration` / `ConfigurationWrapper`
+ - `IConfigurationManager` / `ConfigurationManagerWrapper`
+ - `IConfigurationSource` / `ConfigurationSource`
+- New exception-handling delegate runners as well as a default error-handling strategy in `Patterns.ExceptionHandling`:
+ - `TValue Try.Get(Func{TValue} valueAccessor[, Func{Exception, ExceptionState} errorHandler = null])`
+ - `void Try.Do(Action action[, Func{Exception, ExceptionState} errorHandler = null])`
+ - `Func{Exception, ExceptionState} Try.HandleErrors.DefaultStrategy` (new dependency: [Common.Logging](https://www.nuget.org/packages/Common.Logging/)) &rarr; uses self-bound `ILog` instance to log exception; marks exception as "handled"
+- New DateTime components for testability in `Patterns.Runtime`:
+ - `Patterns.Runtime.IDateTimeInfo` &rarr; `GetNow()` method returns `DateTime`
+ - `Patterns.Runtime.DefaultDateTimeInfo` &rarr; proxies `DateTime.Now`
+ - `Patterns.Testing.Runtime.TestDateTimeInfo` &rarr; accepts a specific `DateTime` value and always uses that
+ - `DateTime DateTime.AccurateToOneSecond()` (extension)
+- New ease-of-use type for regular expressions: `Patterns.Text.RegularExpressions.CompiledRegex`
 
-**3.4.0-beta**
+## just after 3.3.0-beta ##
 
-**3.3.1-beta**
+- MOVED TO GITHUB!!