Merge branch 'master' into release

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+end_of_line = CRLF
+indent_style = space
+trim_trailing_whitespace = true
+indent_size = 4
+
+[*.csproj]
+indent_style = space
+indent_size = 2
+
+[*.resx]
+indent_style = space
+indent_size = 2

.gitignore

@@ -42,7 +42,7 @@ _ReSharper*/
 
 
 #Project files
-[Bb]uild/
+[Bb]uild/*
 
 #Subversion files
 .svn
@@ -74,4 +74,7 @@ src/Pickles/PrecompiledWeb/
 
 
 # FAKE stuff
-packages/FAKE/
+packages/FAKE/
+
+# Fody
+!src/Pickles/packages/Fody*/build/*

ReleaseNotes.md

@@ -1,5 +1,24 @@
 # Pickles Release Notes
 
+## v0.19.0 - 2014-11-25
+
+### Breaking Change
+
+- DITA support has been discontinued. ([#153](https://github.com/picklesdoc/pickles/pull/153))
+
+### New Features
+
+- Each runner has its own download package
+- Several improvements to the DHTML version
+  - A progress indicator when loading features for the first time
+  - Add a toggle to show/hide folder contents (top level folders are collapsed by default)
+- The Nuget package for the MSBuild runner adds an msbuild target file - see [MSBuild Task](http://www.picklesdoc.com/#!Pages/MSBuildTask.md) for documentation ([#157](https://github.com/picklesdoc/pickles/pull/157))
+- The text "pickled on" was replaced with "generated on".
+
+### For developers
+
+We are now using a new assert library: [NFluent](http://n-fluent.net/).
+
 ## v0.18.2 - 2014-09-12
 
 ### Bug(s) Fixed

build.bat

@@ -1,11 +1,12 @@
 @echo off
 cls
 
-cd ".\src\Pickles\packages\NuGet.CommandLine.2.8.2\tools\"
+cd ".\src\Pickles\packages\NuGet.CommandLine.2.8.3\tools\"
 
 ".\NuGet.exe" "Install" "FAKE" "-OutputDirectory" "..\..\..\..\..\packages" "-ExcludeVersion"
 
 cd ..\..\..\..\..
 
-"packages\FAKE\tools\Fake.exe" build.fsx --envvar version 0.18.2
-"packages\FAKE\tools\Fake.exe" nuget.fsx --envvar version 0.18.2
+"packages\FAKE\tools\Fake.exe" build.fsx --envvar version 0.19.0
+"packages\FAKE\tools\Fake.exe" nuget.fsx --envvar version 0.19.0
+"packages\FAKE\tools\Fake.exe" chocolatey.fsx --envvar version 0.19.0

build.fsx

@@ -70,16 +70,23 @@ Target "BuildTest" (fun _ ->
       |> Log "AppBuild-Output: "
 )
 
+let createZip (packageType : string) = 
+    !! (buildDir + "/" + packageType + "/*.*") -- "*.zip"
+        |> Zip (buildDir + packageType) (deployDir + "Pickles-" + packageType + "-" + version + ".zip")
+
 Target "Zip" (fun _ ->
-    !! (buildDir + "/**/*.*")
-        -- "*.zip"
-        |> Zip buildDir (deployDir + "Pickles-" + version + ".zip")
+    createZip "exe"
+    createZip "gui"
+    createZip "msbuild"
+    createZip "nant"
+    createZip "powershell"
 )
 
 Target "Default" (fun _ ->
     trace ("Starting build of Pickles version " + version)
 )
 
+
 // Dependencies
 "Clean"
   ==> "AssemblyInfo"
@@ -94,4 +101,5 @@ Target "Default" (fun _ ->
 
 
 // start build
-RunTargetOrDefault "Default"
+RunTargetOrDefault "Default"
+

chocolatey.fsx

@@ -0,0 +1,45 @@
+// include Fake lib
+#r @"packages\FAKE\tools\FakeLib.dll"
+open Fake
+
+// Properties
+let cmdDir = "./build/exe/"
+let deployDir  = "./deploy/chocolatey/"
+let packagingDir = "./packaging/"
+let chocoDir = "./chocolatey/"
+
+// version info
+let version = environVar "version" // or retrieve from CI server
+
+Target "Clean" (fun _ ->
+    CleanDirs [deployDir; packagingDir]
+)
+
+Target "CreatePackage" (fun _ ->
+    CopyFiles packagingDir [chocoDir + "chocolateyInstall.ps1"; cmdDir + "Pickles.exe"; cmdDir + "NLog.config"]
+    WriteFile (packagingDir + "version.ps1") [("$version = \"" + version + "\"")]
+    NuGet (fun p -> 
+        {p with
+            OutputPath = deployDir
+            WorkingDir = packagingDir
+            Version = version
+            Publish = false }) 
+            (chocoDir + "Pickles.nuspec")
+)
+
+
+Target "Default" (fun _ ->
+    trace ("Starting build of Pickles version " + version)
+    DeleteDir packagingDir
+)
+
+
+// Dependencies
+"Clean"
+  ==> "CreatePackage"
+  ==> "Default"
+
+
+// start build
+RunTargetOrDefault "Default"
+

chocolatey/chocolateyInstall.ps1

@@ -0,0 +1,12 @@
+
+$packageName = "pickles"
+$toolsPath = Split-Path -parent $MyInvocation.MyCommand.Definition
+
+# Newer choco.exe will support passing the package's version number to this script; so this
+# can eventually be cleaned up and version.ps1 removed.
+Write-Debug "toolsPath is: $toolsPath"
+$versionFile = Join-Path $toolsPath "version.ps1"
+Import-Module $versionFile
+$url = "https://github.com/picklesdoc/pickles/releases/download/v$version/Pickles-exe-$version.zip"
+
+Install-ChocolateyZipPackage $packageName $url $toolsPath

chocolatey/pickles.nuspec

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
+	<metadata>
+		<id>pickles</id>
+		<title>Pickles - The Open Source Living Documentation Generator</title>
+		<version>@build.number@</version>
+		<authors>PicklesDoc and contributors</authors>
+		<owners>Jeffrey Cameron, Dirk Rombauts</owners>
+		<summary>A documentation generator for features written in the Gherkin language</summary>
+		<description>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.</description>
+		<projectUrl>http://www.picklesdoc.com/</projectUrl>
+		<tags>SpecificationByExample BDD SpecFlow Gherkin Cucumber SpecByEx LivingDocumentation Documentation </tags>
+		<copyright></copyright>
+		<licenseUrl>http://apache.org/licenses/LICENSE-2.0.html</licenseUrl>
+		<requireLicenseAcceptance>false</requireLicenseAcceptance>
+		<iconUrl>https://cdn.rawgit.com/picklesdoc/pickles/master/pickles.jpeg</iconUrl>
+	</metadata>
+	<files>
+		<file src="pickles.exe" target="tools" />
+		<file src="chocolateyInstall.ps1" target="tools" />
+		<file src="version.ps1" target="tools" />
+	</files>
+</package>
+

nuget.fsx

@@ -33,7 +33,7 @@ Target "CreatePackageCommandLine" (fun _ ->
 
 Target "CreatePackageMsBuild" (fun _ ->
     // Copy all the package files into a package folder
-    CopyFiles packagingDir [msBuildDir + "PicklesDoc.Pickles.MSBuild.Tasks.dll"; ]
+    CopyFiles packagingDir [msBuildDir + "PicklesDoc.Pickles.MSBuild.Tasks.dll"; msBuildDir + "build/Pickles.MSBuild.targets";]
 
     NuGet (fun p -> 
         {p with

src/Pickles/.nuget/packages.config

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="NuGet.CommandLine" version="2.8.2" />
+  <package id="NuGet.CommandLine" version="2.8.3" />
   <package id="NUnit.Runners" version="2.6.3" />
 </packages>

src/Pickles/Pickles.BaseDhtmlFiles/Index.html

@@ -17,16 +17,23 @@
 </head>
 
 <body>
-
+    <div id="progress" style="width:100%;height:100%;position: absolute;left:0;top:0;background:#ffffff;z-index:100">
+        <span style="position: absolute;left:50%;top:50%;font-weight:bold">Loading...</span>
+    </div>
     <script type="text/html" id="features-template">
         <div class="feature" data-bind="click: $root.showFeature.bind(Path)"><a data-bind="text: Name, click: $root.showFeature.bind(Path), css: { selected: $root.isSelected(Path) }" href="#"></a><span data-bind="template: { name: 'testResults-template', data: Result }"></span></div>
     </script>
 
     <script type="text/html" id="featuresByFolder-template">
-        <div data-bind="text: Name" style="padding: 5px"></div>
-        <div style="margin-left: 15px">
-            <div data-bind="template: { name: 'features-template', foreach: features }"></div>
-            <div data-bind="template: { name: 'featuresByFolder-template', foreach: SubDirectories }"></div>
+        <div class="features-folder">
+            <div class="feature-folder-header" data-bind="click: toggleShowingFolderFeatures">
+                <span class="icon-chevron-down"></span>
+                <span data-bind="text: Name" style="padding: 5px"></span>
+            </div>
+            <div class="feature-folder-contents" style="margin-left: 15px;display:none">
+                <div data-bind="template: { name: 'features-template', foreach: features }"></div>
+                <div data-bind="template: { name: 'featuresByFolder-template', foreach: SubDirectories }"></div>
+            </div>
         </div>
     </script>
 
@@ -96,7 +103,7 @@
                         <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>Generated on: <span data-bind="text: configuration().GeneratedOn"></span></div>
                         </div>
                     </div>
                 </div>
@@ -298,6 +305,8 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
             $('#TypeAheadSearchBox').typeahead({
                 source: searchItems
             });
+
+            $('#progress').hide();
         }
 
         var navShown = true;
@@ -326,6 +335,20 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
 
             setupSubmitSearchWhenEnterKeyPressed();
         });
+
+        function toggleShowingFolderFeatures(element, event) {
+            var icon = $($(event.target).parent().children('span')[0]);
+            var folderContents = $($(event.target).parent().next('div'));
+            if (icon.hasClass("icon-chevron-right")) {
+                icon.removeClass("icon-chevron-right");
+                icon.addClass("icon-chevron-down");
+                folderContents.hide();
+            } else {
+                icon.addClass("icon-chevron-right");
+                icon.removeClass("icon-chevron-down");
+                folderContents.show();
+            }
+        };
     </script>
 </body>
 </html>

src/Pickles/Pickles.BaseDhtmlFiles/css/styles.css

@@ -11,6 +11,12 @@
     font-size: larger;
 }
 
+.feature-folder-header {
+    font-size: small;
+    font-weight: bolder;
+    margin-top: 5px;
+}
+
 #scenarios, .steps {
     list-style-type: none;
     margin: 0;

src/Pickles/Pickles.BaseDhtmlFiles/pickledFeatures.js

@@ -2306,6 +2306,6 @@ jsonPWrapper ({
     "Configuration": {
         "SutName": "SUT Name",
         "SutVersion": "SUT Version",
-        "PickledOn": "6 June 2014 12:00:00"
+        "GeneratedOn": "6 June 2014 12:00:00"
     }
 });

src/Pickles/Pickles.CommandLine/FodyWeavers.xml

@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Weavers>
 	<Costura/>
-
 </Weavers>

src/Pickles/Pickles.CommandLine/Pickles.CommandLine.csproj

@@ -13,7 +13,7 @@
     <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
     <SolutionDir Condition="$(SolutionDir) == '' Or $(SolutionDir) == '*Undefined*'">..\..\Pickles\</SolutionDir>
-    <NuGetPackageImportStamp>2b1ebfe6</NuGetPackageImportStamp>
+    <NuGetPackageImportStamp>a01d3d9d</NuGetPackageImportStamp>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <PlatformTarget>AnyCPU</PlatformTarget>
@@ -52,9 +52,8 @@
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
-    <Reference Include="System.IO.Abstractions, Version=1.4.0.86, Culture=neutral, PublicKeyToken=d480b5b72fb413da, processorArchitecture=MSIL">
-      <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\packages\System.IO.Abstractions.1.4.0.86\lib\net35\System.IO.Abstractions.dll</HintPath>
+    <Reference Include="System.IO.Abstractions">
+      <HintPath>..\packages\System.IO.Abstractions.1.4.0.92\lib\net35\System.IO.Abstractions.dll</HintPath>
     </Reference>
     <Reference Include="System.Xml.Linq" />
     <Reference Include="System.Data.DataSetExtensions" />
@@ -122,12 +121,12 @@ foreach (var item in filesToCleanup)
   <Target Name="CleanReferenceCopyLocalPaths" AfterTargets="AfterBuild;NonWinFodyTarget">
     <CosturaCleanup Config="FodyWeavers.xml" Files="@(ReferenceCopyLocalPaths->'$(OutDir)%(DestinationSubDirectory)%(Filename)%(Extension)')" />
   </Target>
-  <Import Project="..\packages\Fody.1.24.0\build\Fody.targets" Condition="Exists('..\packages\Fody.1.24.0\build\Fody.targets')" />
+  <Import Project="..\packages\Fody.1.26.1\build\Fody.targets" Condition="Exists('..\packages\Fody.1.26.1\build\Fody.targets')" />
   <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
     <PropertyGroup>
       <ErrorText>This project references NuGet package(s) that are missing on this computer. Enable NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
     </PropertyGroup>
-    <Error Condition="!Exists('..\packages\Fody.1.24.0\build\Fody.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Fody.1.24.0\build\Fody.targets'))" />
+    <Error Condition="!Exists('..\packages\Fody.1.26.1\build\Fody.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Fody.1.26.1\build\Fody.targets'))" />
   </Target>
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.

src/Pickles/Pickles.CommandLine/packages.config

@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Autofac" version="2.6.3.862" targetFramework="net35" />
-  <package id="Costura.Fody" version="1.3.2.0" targetFramework="net35" developmentDependency="true" />
-  <package id="Fody" version="1.24.0" targetFramework="net35" developmentDependency="true" />
+  <package id="Costura.Fody" version="1.3.3.0" targetFramework="net35" developmentDependency="true" />
+  <package id="Fody" version="1.26.1" targetFramework="net35" developmentDependency="true" />
   <package id="NDesk.Options" version="0.2.1" />
   <package id="NLog" version="3.1.0.0" targetFramework="net35" />
   <package id="NLog.Config" version="3.1.0.0" targetFramework="net35" />
   <package id="NLog.Schema" version="3.1.0.0" targetFramework="net35" />
-  <package id="System.IO.Abstractions" version="1.4.0.86" targetFramework="net35" />
+  <package id="System.IO.Abstractions" version="1.4.0.92" targetFramework="net35" />
 </packages>

src/Pickles/Pickles.MSBuild/FodyWeavers.xml

@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Weavers>
 	<Costura/>
-
 </Weavers>