Merge branch 'release/2.1.x'

Author: kbilsted

CHANGELOG.md

@@ -4,24 +4,22 @@
 
 Full documentation on usage and motivating examples at https://github.com/kbilsted/StatePrinter/tree/master/doc
 
-
-## v2.1.198-rc
+## v2.1.xx
 
 Added
 
-* Functionality for including or excluding fields and properties based on one or more type descriptions. See IncludeByType() and ExcludeByType()
-
-## v2.1.186-rc
+  * Functionality for controlling automatic test rewrite using an environment variable.
+  * Functionality for including or excluding fields and properties based on one or more type descriptions. See `IncludeByType()` and `ExcludeByType()`.
+  * Added `AreAlike()`, replacing `IsSame()` (which is deprecated). Similar story for `PrintAreAlike` replacing `PrintIsSame()`. 
+  * Made error message tell about `AreAlike()` when two strings are alike but not equals, when using `AreEquals()`.
+  * Prepared for future expansion of functionality, by placing unit testing configuration in a sub-configuration class.
+  * Obsoleted a lot of methods, describing the alternative API introduced in v2.1
+  
 
 Fixed
 
   * [#22 Make error message configurable upon assertion failure](https://github.com/kbilsted/StatePrinter/issues/22)
 
-Added
-
-  * Added `AreAlike()`, replacing `IsSame()` (which is deprecated).
-  * Made error message tell about `AreAlike()` when two strings are alike but not equals, when using `AreEquals()`.
-  * Prepared for future expansion of functionality, by placing unit testing configuration in a sub-configuration class.
 
 
 

DeployToNuget.cmd

@@ -2,8 +2,8 @@ REM ON FIRST RUN, RUN THIS (change the key to whatever is found on your profile
 REM .nuget\NuGet.exe setapikey e39ea-get-the-full-key-on-nuget.org
 
 call CreateNuget.cmd
-.nuget\NuGet.exe push nuget_packages\StatePrinter.2.0.*.nupkg
-.nuget\NuGet.exe push nuget_packages\StatePrinter.2.0.*.symbols.nupkg
+.nuget\NuGet.exe push nuget_packages\StatePrinter.2.*.*.symbols.nupkg
+.nuget\NuGet.exe push nuget_packages\StatePrinter.2.*.*.nupkg
 
 cd nuget_packages
 del /q *

README.md

@@ -1,7 +1,5 @@
 #  ![](https://raw.github.com/kbilsted/StatePrinter/master/StatePrinter/gfx/stateprinter.png) StatePrinter 
 
-[![Join the chat at https://gitter.im/kbilsted/StatePrinter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kbilsted/StatePrinter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 [![Build status](https://ci.appveyor.com/api/projects/status/vx0nl4y4iins506u/branch/master?svg=true)](https://ci.appveyor.com/project/kbilsted/stateprinter/branch/master)
 [![Nuget](https://img.shields.io/nuget/dt/stateprinter.svg)](http://nuget.org/packages/stateprinter)
 [![Nuget](https://img.shields.io/nuget/v/stateprinter.svg)](http://nuget.org/packages/stateprinter)
@@ -10,14 +8,14 @@
 [![Stats](https://img.shields.io/badge/Code_lines-3,3_K-ff69b4.svg)]()
 [![Stats](https://img.shields.io/badge/Doc_lines-1,4_K-ff69b4.svg)]()
 
-# What is Stateprinter
-A simple framework for **automatic** `Assert.AreEquals()`, `Assert.That()` and `ToString()` 
+[![Join the chat at https://gitter.im/kbilsted/StatePrinter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kbilsted/StatePrinter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-StatePrinter is a little library that turn any object-graph into a string representation. It is mainly intended automating writing `ToString` methods and help automating aspects of writing and maintaining unit tests. Code which is rather dreary and boring to write. 
+# What is Stateprinter
+A simple framework for **automating** aspects of unit testing and implementing ToString methods. 
 
 Why you should take StatePrinter for a spin
 
-* *No more manual .ToString()* - it is much easier to write robus and self-sufficient `ToString()` methods. 
+* *No more manual .ToString()* - it is much easier to write robust and self-sufficient `ToString()` methods. 
 * *No more manual writing/updating Asserts* - both for new tests and when the code changes, all tests can automatically be corrected.
 * *No more screens full of asserts*. Especially testing against object-graphs is a bliss. 
 * Very configurable and extensible.
@@ -26,9 +24,10 @@ Why you should take StatePrinter for a spin
 
 
 
-# How do I get started
+## How do I get started
 
 The documentation is split into
+
 * [Automating ToStrings](https://github.com/kbilsted/StatePrinter/blob/master/doc/AutomatingToStrings.md)
 
 and
@@ -41,7 +40,7 @@ and
 * [Configuration and exension](https://github.com/kbilsted/StatePrinter/blob/master/doc/HowToConfigure.md) 
 
 
-# Where can I get it?
+## Where can I get it?
 Install Stateprinter from the package manager console:
 
 ```
@@ -55,12 +54,12 @@ PM> Install-Package StatePrinter -Pre
 ```
 
 
-# How can I get help?
+## How can I get help?
 For quick questions, [Stack Overflow](http://stackoverflow.com/questions/tagged/stateprinter?sort=newest) is your best bet. For harder questions, bugs, issues or feature requests, [create a GitHub Issue (and let's chat)](https://github.com/kbilsted/StatePrinter/issues/new).
 
 
 
-# How can I help out
+## How can I help out
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
 * Blog about your experinces with the tool. We highly need publicity. I'll gladly link from here to your blog.
 * [Report bugs](https://github.com/kbilsted/StatePrinter/issues/new)
@@ -73,23 +72,41 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 
 
 
-# History
+## Versioning
+Stateprinter is maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:
+
+`<major>.<minor>.<build>`
+
+and constructed with the following guidelines:
+
+* Breaking backward compatibility bumps the major
+* New additions without breaking backward compatibility bumps the minor
+* Bug fixes and misc changes increase the build number
+
+For more information on SemVer, please visit http://semver.org/.
+
+
+
+## History
 Version History: http://github.com/kbilsted/StatePrinter/blob/master/CHANGELOG.md
 
 This file describes the latest pushed changes. For documentation of earlier releases see:
 [1.0.6](https://github.com/kbilsted/StatePrinter/blob/1.0.6/README.md), [1.0.5](https://github.com/kbilsted/StatePrinter/blob/1.0.5/README.md), [1.0.4](https://github.com/kbilsted/StatePrinter/blob/1.0.4/README.md)
 
 Upgrading from v1.xx to v2.0.x should be a matter of configuring the `Configuration.LegacyBehaviour`
 
+Upgrading from v2.0 to v2.1 simply follow the documentation in the obsolete attributes.
+
+
 
 
-# Requirements
+## Requirements
 Requires .NET 3.5 or newer.
 
 
 
 
-# License
+## License
 Stateprinter is under the Apache License 2.0, meaning that you can freely use this in other open source or commercial products. If you use it for commercial products please have the courtesy to leave me an email with a 'thank you'. 
 
 

StatePrinter.Tests/Configurations/ConfigurationTest.cs

@@ -21,6 +21,7 @@
 using System.Linq;
 using NUnit.Framework;
 using StatePrinter.Configurations;
+using StatePrinter.FieldHarvesters;
 using StatePrinter.ValueConverters;
 
 namespace StatePrinter.Tests.Configurations
@@ -44,9 +45,17 @@ public void SettingNullValues()
         {
             var sut = new Configuration();
             Assert.Throws<ArgumentNullException>(() => sut.SetCulture(null));
+            Assert.Throws<ArgumentNullException>(() => sut.SetIndentIncrement(null));
             Assert.Throws<ArgumentNullException>(() => sut.SetNewlineDefinition(null));
+            Assert.Throws<ArgumentNullException>(() => sut.SetOutputFormatter(null));
             Assert.Throws<ArgumentNullException>(() => sut.SetAreEqualsMethod(null));
-            Assert.Throws<ArgumentNullException>(() => sut.SetAutomaticTestRewrite(null));
+
+            Assert.Throws<ArgumentNullException>(() => sut.Add((IFieldHarvester)null));
+            Assert.Throws<ArgumentNullException>(() => sut.Add((IValueConverter)null));
+
+
+            Assert.Throws<ArgumentNullException>(() => sut.Test.SetAreEqualsMethod(null));
+            Assert.Throws<ArgumentNullException>(() => sut.Test.SetAutomaticTestRewrite(null));
         }
     }
 }

StatePrinter.Tests/ExamplesForDocumentation/ExampleEndlessAsserts.cs

@@ -61,7 +61,7 @@ public void EndlessAssertsAlternative()
     PremiumInternalCostAfterDiscount = 37
     Tax = 110
 }";
-            printer.Assert.PrintIsSame(expected, allocateData);
+            printer.Assert.PrintAreAlike(expected, allocateData);
         }
 
     }

StatePrinter.Tests/ExamplesForDocumentation/ExampleListAndArrays.cs

@@ -66,7 +66,7 @@ public void ExampleListAndArraysAlternative()
     Share = 50
 }";
 
-            TestHelper.CreateTestPrinter().Assert.PrintIsSame(expected, vendorManager.VendorJobSplit);
+            TestHelper.Assert().PrintAreAlike(expected, vendorManager.VendorJobSplit);
         }
     }
 

StatePrinter.Tests/FieldHarvesters/ProjectionHarvesterByTypeTest.cs

@@ -0,0 +1,117 @@
+// Copyright 2014 Kasper B. Graversen
+// 
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+// 
+//   http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+using NUnit.Framework;
+
+using StatePrinter.TestAssistance;
+
+namespace StatePrinter.Tests.FieldHarvesters
+{
+    [TestFixture]
+    public class TypeFilteringTests
+    {
+        interface IA
+        {
+            int A { get; set; }
+        }
+
+        interface IB
+        {
+            int B { get; set; }
+        }
+
+        interface IC
+        {
+            int C { get; set; }
+        }
+
+        interface ID
+        {
+            int D { get; set; }
+        }
+
+        class AtoD : IA, IB, IC, ID
+        {
+            public int A { get; set; }
+            public int B { get; set; }
+            public int C { get; set; }
+            public int D { get; set; }
+
+            public AtoD()
+            {
+                A = 1;
+                B = 2;
+                C = 3;
+                D = 4;
+            }
+        }
+
+        [Test]
+        public void TestIncludeByType()
+        {
+            var sut = new AtoD();
+            Asserter assert;
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.PrintEquals("new AtoD() { A = 1 B = 2 C = 3 D = 4 }", sut);
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.Project.IncludeByType<AtoD, IA>();
+            assert.PrintEquals("new AtoD() { A = 1 }", sut);
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.Project.IncludeByType<AtoD, IA, IB>();
+            assert.PrintEquals("new AtoD() { A = 1 B = 2 }", sut);
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.Project.IncludeByType<AtoD, IA, IB, IC>();
+            assert.PrintEquals("new AtoD() { A = 1 B = 2 C = 3 }", sut);
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.Project.IncludeByType<AtoD, IA, IB, IC, ID>();
+            assert.PrintEquals("new AtoD() { A = 1 B = 2 C = 3 D = 4 }", sut);
+        }
+
+        [Test]
+        public void TestExcludeByType()
+        {
+            var sut = new AtoD();
+            Asserter assert;
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.PrintEquals("new AtoD() { A = 1 B = 2 C = 3 D = 4 }", sut);
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.Project.ExcludeByType<AtoD, IA>();
+            assert.PrintEquals("new AtoD() { B = 2 C = 3 D = 4 }", sut);
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.Project.ExcludeByType<AtoD, IA, IB>();
+            assert.PrintEquals("new AtoD() { C = 3 D = 4 }", sut);
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.Project.ExcludeByType<AtoD, IA, IB, IC>();
+            assert.PrintEquals("new AtoD() { D = 4 }", sut);
+
+            assert = TestHelper.CreateShortAsserter();
+            assert.Project.ExcludeByType<AtoD, IA, IB, IC, ID>();
+            assert.PrintEquals("new AtoD() { }", sut);
+        }
+    }
+}