Merge branch 'master' into release

picklesdoc · Jul 7, 2014 · 6a18337 · 6a18337
2 parents 2431637 + 81d5a6a
commit 6a18337
Show file tree

Hide file tree

Showing 159 changed files with 7,749 additions and 56,539 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 Introduction
 ============
 
-![Build Status](https://www.myget.org/BuildSource/Badge/pickles?identifier=ef7c6ed5-3845-4524-96dd-ad39d6da9a3c, "Build Status")
+[![Build status](https://ci.appveyor.com/api/projects/status/rqt59hq1m2jt2a5v)](https://ci.appveyor.com/project/dirkrombauts/pickles-715)
 
 Pickles is an open source living documentation generator that works on feature files written in the Gherkin language, popularized in tools like Cucumber and SpecFlow.  Pickles can be incorporated into your build process to produce living documenation in a format that is more accessible to your clients.  Gherkin language files are written in plain text and stored in your source folder.  This can make them inaccessible to clients who may not know how to work with source control or who are not interested in seeing all of the source code, just the features.
 

diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -0,0 +1,136 @@
+# Pickles Release Notes
+
+## v0.18.0 - 2013-07-07
+
+### New Feature(s)
+
+- **Potential Breaking Change**: the folder structure of the dependencies of the static HTML version was changed. If you override the .css files, you will need to update your workflow to account for that.
+
+### Bug(s) Fixed
+
+- Fixed issue where multiple results files for a single feature causes exceptions when processing scenario outline examples ([#123](https://github.com/picklesdoc/pickles/pull/123))
+- Fixed issue where pickles would crash when a specified test results file does not exist ([#126](https://github.com/picklesdoc/pickles/issues/126))
+
+## v0.17.4 - 2013-06-04
+
+### Bug(s) Fixed
+
+- Description blocks are rendered as code elements in DHtml version ([#118](https://github.com/picklesdoc/pickles/issues/118))
+
+## v0.17.3 - 2013-05-28
+
+### Bug(s) Fixed
+
+- PowerShell version works again
+
+## v0.17.2 - 2013-05-28
+
+Some things went wrong during the publication of versions 0.17.0 and 0.17.1. Therefore 0.17.2 is the first published 0.17.x version.
+
+### New Feature(s)
+
+- Added test status in the DHTML browsing section (left nav) (#110)
+
+### Bug(s) Fixed
+
+- Crash because of nunit result (#108)
+- Avoid crash on start of GUI (#112)
+
+## v0.16.0 - 2013-05-15
+
+### New Feature(s)
+
+- Enable results for individual example results in a scenario outline (in the Html version) ([#105](https://github.com/picklesdoc/pickles/pull/105))
+
+### Bug Fixed
+
+- Features don't render correctly when there are less than 4 spaces ([#106](https://github.com/picklesdoc/pickles/pull/106))
+
+## v0.15.0 - 2013-04-11
+
+### New Feature(s)
+
+- Allow multiple result files ([#83](https://github.com/picklesdoc/pickles/issues/83)): it is now possible to use multiple test result files. This will come in handy if you need to partition your test runs. Simple use a semicolon-separated list of file paths instead of the single file path as an argument
+
+## v0.14.0 - 2013-03-27
+
+### New Feature(s)
+
+- The (static) Html version now supports images with .png, .gif, .jpg and .bmp extensions. This partially addresses issue ([#12](https://github.com/picklesdoc/pickles/issues/12))
+- Several updates of external dependencies, including the long out-of-date IKVM. Yay!
+- All production code and test code now use the excellent [System.IO.Abstraction](https://github.com/tathamoddie/System.IO.Abstractions) library and its TestingHelpers classes.
+- We are using build services provided by [MyGet](http://www.myget.org/)
+
+## v0.13.1 - 2013-12-20
+
+### Bug(s) Fixed
+
+- DHTML uses the Feature's description for the Background ([#74](https://github.com/picklesdoc/pickles/issues/74))
+- Nuget manifest should mention PicklesDoc instead of only Jeffrey Cameron ([#84](https://github.com/picklesdoc/pickles/issues/84))
+- Crash when a feature is not present in the test result (with NUnit) ([#85](https://github.com/picklesdoc/pickles/issues/85))
+
+## v0.13.0 - 2013-11-29
+
+### New Feature(s)
+
+- The UI version now includes the option to generate each selected output format in its own directory ([#78](https://github.com/picklesdoc/pickles/pull/78))
+
+### Bug(s) Fixed
+
+- Left nav bug fix in DHTML format ([#73](https://github.com/picklesdoc/pickles/pull/73))
+- DHTML uses the Feature's description for the Background ([#74](https://github.com/picklesdoc/pickles/issues/74))
+
+
+## v0.12.1 - 2013-10-28
+
+### Bug(s) Fixed
+
+- Fixes a .NET runtime version issue caused by combining all Pickles runners in one directory. We are back to each runner in a separate directory, and will likely remain so until all assemblies use the same .NET framework version.
+
+## v0.12 - 2013-10-25
+
+### New Feature(s)
+
+- DHTML output format should render Markdown correctly (one step closer toward feature parity for all export formats) ([#60](https://github.com/picklesdoc/pickles/issues/60))
+- The .zip file contains all 5 Pickles runners in one directory, reducing the size of the download by roughly three quarters.
+
+### Bug(s) Fixed
+
+- When selecting multiple output formats in the UI, pickles generates the first output format multiple times ([#66](https://github.com/picklesdoc/pickles/issues/66))
+
+## v0.11 - 2013-09-26
+
+### New Feature(s)
+
+- Better Error Reporting: both the command line client and the UI show a log ([#36](https://github.com/picklesdoc/pickles/issues/36))
+
+### Bug(s) Fixed
+
+- Pickles crashes when generating excel with really long descriptions ([#62](https://github.com/picklesdoc/pickles/issues/62))
+- Calling pickles.exe without any arguments in a directory without features causes a crash ([#63](https://github.com/picklesdoc/pickles/issues/63))
+
+## v0.10 - 2013-08-29
+
+### New Feature(s)
+
+- Add support for SpecRun test results ([#21](https://github.com/picklesdoc/pickles/issues/21)). Refer to the wiki page for instructions on how to configure SpecRun correctly: [Integrating Test Results From SpecRun](http://www.picklesdoc.com/#!Pages/IntegratingTestResultsFromSpecRun.md).
+
+### Bug(s) Fixed
+
+- Please implement marking ignored test cases with yellow sign rather than red for all Test Result providers (not just MSTest) ([#47](https://github.com/picklesdoc/pickles/issues/47))
+- Remove duplication of example feature files ([#50](https://github.com/picklesdoc/pickles/issues/50))
+- Adding background to features in word ([#58](https://github.com/picklesdoc/pickles/pull/58))
+- Handle cucumber feature with no scenarios ([#59](https://github.com/picklesdoc/pickles/pull/59))
+
+
+## Older Releases without Release Notes
+
+- v0.9 - 2013-07-23 
+- v0.8 - 2012-12-17
+- v0.7 - 2012-08-07
+- v0.6 was skipped
+- v0.5 - 2012-03-13
+- v0.4 - 2012-01-20
+- v0.3 - 2011-12-13
+- v0.2 - 2011-11-14
+- v0.1 - 2011-10-22
diff --git a/project.build b/project.build
@@ -4,8 +4,8 @@
 
   <!-- set the major and minor version number here -->
   <property name="version.major" value="0" />
-  <property name="version.minor" value="17" />
-  <property name="version.revision" value="4" />
+  <property name="version.minor" value="18" />
+  <property name="version.revision" value="0" />
 
   <!-- set build number from continuous integration tool -->
   <if test="${environment::variable-exists('BUILD_NUMBER')}">
@@ -29,7 +29,7 @@
     <property name="revision" value="0" />
   </ifnot>
 
-  <property name="version" value="${version.major}.${version.minor}.${version.revision}.${build.number}" />
+  <property name="version" value="${version.major}.${version.minor}.${version.revision}" />
   <property name="msbuild.dir" value="${environment::get-variable('ProgramFiles(x86)')}\MSBuild\12.0\Bin" />
   <property name="framework.dir" value="${msbuild.dir}" />
   <property name="assemblies.dir" value="C:\dev\pickles\src\Pickles\Pickles.CommandLine\bin\Release" />
@@ -52,7 +52,7 @@
 
   <target name="set" depends="init">
     <exec program="tools\AssemblyInfoUtil.exe">
-      <arg value="-setver:${version}" />
+      <arg value="-setver:${version}.0" />
       <arg value="src\Pickles\VersionInfo.cs" />
     </exec>
   </target>

diff --git a/src/Pickles/.nuget/packages.config b/src/Pickles/.nuget/packages.config
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="NuGet.CommandLine" version="2.8.1" />
+  <package id="NuGet.CommandLine" version="2.8.2" />
   <package id="NUnit.Runners" version="2.6.3" />
 </packages>
diff --git a/src/Pickles/Pickles.BaseDhtmlFiles/Index.html b/src/Pickles/Pickles.BaseDhtmlFiles/Index.html
@@ -75,7 +75,7 @@
     <div class="navbar navbar-inverse navbar-fixed-top" id="TopNav">
         <div class="navbar-inner">
             <div class="container-fluid">
-                <a class="brand" href="#">Features</a>
+                <a class="brand" href="#" data-bind="text: configuration().SutName != null ? configuration().SutName : 'Features'"></a>
                 <div class="navbar-search pull-left">
                     <input type="text" id="TypeAheadSearchBox" class="search-query" data-bind="value: whatToSearchFor" style="width: 300px" placeholder="@tag or feature name" />
                     <a id="SearchButton" data-bind="click: search" class="btn">Search</a>
@@ -93,6 +93,11 @@
                     <div id="InnerNav">
                         <div data-bind="template: { name: 'features-template', foreach: featuresByFolder().features }"></div>
                         <div data-bind="template: { name: 'featuresByFolder-template', foreach: featuresByFolder().SubDirectories }"></div>
+                        <div id="SutInfo">
+                            <div data-bind="if: configuration().SutName, text: configuration().SutName"></div>
+                            <div data-bind="if: configuration().SutVersion, text: configuration().SutVersion"></div>
+                            <div>Pickled On: <span data-bind="text: configuration().PickledOn"></span></div>
+                        </div>
                     </div>
                 </div>
 
@@ -196,14 +201,15 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
     <script src="js/typeaheadList.js" type="text/javascript"></script>
     <script src="js/featureSearch.js" type="text/javascript"></script>
     <script type="text/javascript">
-        function ViewModel(features) {
+        function ViewModel(features, configuration) {
             var self = this;
 
             features = $.map(features, function(el, i) { return new FeatureParent(el); });
 
             self.originalFeaturesList = ko.observableArray(features);
             self.featuresByFolder = ko.observable(buildFullHierarchy(getFeaturesFromScenariosList(features)));
             self.currentFeature = ko.observable();
+            self.configuration = ko.observable(configuration);
 
             self.setCurrentFeature = function () {
                 if (window.location.hash != '') {
@@ -281,14 +287,14 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
         }
 
         function jsonPWrapper(data) {
-            data.reverse();
+            data.Features.reverse();
 
-            var viewModel = new window.ViewModel(data);
+            var viewModel = new window.ViewModel(data.Features, data.Configuration);
             viewModel.setCurrentFeature();
 
             window.ko.applyBindings(viewModel);
 
-            var searchItems = getTagsAndFeatureAndScenarioNames(data);
+            var searchItems = getTagsAndFeatureAndScenarioNames(data.Features);
             $('#TypeAheadSearchBox').typeahead({
                 source: searchItems
             });

diff --git a/src/Pickles/Pickles.BaseDhtmlFiles/css/styles.css b/src/Pickles/Pickles.BaseDhtmlFiles/css/styles.css
@@ -120,6 +120,11 @@ li.step {
     cursor: pointer;
 }
 
+#SutInfo {
+    margin-top: 30px;
+    border-top: 1px lightgrey solid;
+}
+
 .clickable {    
     cursor: pointer;
 }