Merge branch 'master' into release

ReleaseNotes.md

@@ -1,5 +1,14 @@
 # Pickles Release Notes
 
+## v0.18.2 - 2014-09-12
+
+### Bug(s) Fixed
+
+- Fixed issue where the Html version didn't render the pass/fail icons ([#139](https://github.com/picklesdoc/pickles/issues/139))
+- Fixed issue where the Html version generated an unexpected entry for a file in obj/Debug ([#140](https://github.com/picklesdoc/pickles/issues/140))
+- Removed dependencies from the Nuget packages ([#142](https://github.com/picklesdoc/pickles/issues/142))
+- The nuget packages Pickles.CommandLine and Pickles.MSBuild contain the files twice ([#144](https://github.com/picklesdoc/pickles/issues/144))
+
 ## v0.18.1 - 2014-09-01
 
 ### Bug(s) Fixed

build.bat

@@ -7,4 +7,5 @@ cd ".\src\Pickles\packages\NuGet.CommandLine.2.8.2\tools\"
 
 cd ..\..\..\..\..
 
-"packages\FAKE\tools\Fake.exe" build.fsx
+"packages\FAKE\tools\Fake.exe" build.fsx --envvar version 0.18.2
+"packages\FAKE\tools\Fake.exe" nuget.fsx --envvar version 0.18.2

build.fsx

@@ -3,8 +3,6 @@
 open Fake
 open Fake.AssemblyInfoFile
 
-//RestorePackages()
-
 // Properties
 let buildDir = "./build/"
 let cmdDir = "./build/exe/"
@@ -16,7 +14,7 @@ let testDir  = "./test/"
 let deployDir = "./deploy/"
 
 // version info
-let version = "0.18.1"  // or retrieve from CI server
+let version = environVar "version" // or retrieve from CI server
 
 
 // Targets
@@ -72,23 +70,14 @@ Target "BuildTest" (fun _ ->
       |> Log "AppBuild-Output: "
 )
 
-Target "Test" (fun _ ->
-    !! (testDir + "PicklesDoc.Pickles.Test.dll")
-      |> NUnit (fun p ->
-          {p with
-             DisableShadowCopy = true;
-             OutputFile = testDir + "TestResults.xml" })
-)
-
-
 Target "Zip" (fun _ ->
     !! (buildDir + "/**/*.*")
         -- "*.zip"
         |> Zip buildDir (deployDir + "Pickles-" + version + ".zip")
 )
 
 Target "Default" (fun _ ->
-    trace "Hello World from FAKE"
+    trace ("Starting build of Pickles version " + version)
 )
 
 // Dependencies
@@ -100,7 +89,6 @@ Target "Default" (fun _ ->
   ==> "BuildPowerShell"
   ==> "BuildGui"
   ==> "BuildTest"
-  ==> "Test"
   ==> "Zip"
   ==> "Default"
 

nuget.fsx

@@ -0,0 +1,74 @@
+// include Fake lib
+#r @"packages\FAKE\tools\FakeLib.dll"
+open Fake
+
+// Properties
+let deployDir  = "./deploy/"
+let cmdDir = "./build/exe/"
+let msBuildDir = "./build/msbuild/"
+let powerShellDir = "./build/powershell/"
+let packagingDir = "./packaging/"
+
+// version info
+let version = environVar "version" // or retrieve from CI server
+
+// Targets
+Target "Clean" (fun _ ->
+    CleanDirs [packagingDir; ]
+)
+
+
+Target "CreatePackageCommandLine" (fun _ ->
+    // Copy all the package files into a package folder
+    CopyFiles packagingDir [cmdDir + "pickles.exe"; cmdDir + "NLog.config" ]
+
+    NuGet (fun p -> 
+        {p with
+            OutputPath = deployDir
+            WorkingDir = packagingDir
+            Version = version
+            Publish = false }) 
+            "src/Pickles/Pickles.CommandLine/Pickles.CommandLine.nuspec"
+)
+
+Target "CreatePackageMsBuild" (fun _ ->
+    // Copy all the package files into a package folder
+    CopyFiles packagingDir [msBuildDir + "PicklesDoc.Pickles.MSBuild.Tasks.dll"; ]
+
+    NuGet (fun p -> 
+        {p with
+            OutputPath = deployDir
+            WorkingDir = packagingDir
+            Version = version
+            Publish = false }) 
+            "src/Pickles/Pickles.MSBuild/Pickles.MSBuild.nuspec"
+)
+
+Target "CreatePackagePowerShell" (fun _ ->
+    // Copy all the package files into a package folder
+    CopyFiles packagingDir [powerShellDir + "PicklesDoc.Pickles.PowerShell.dll"; "src/Pickles/Pickles.PowerShell/init.ps1"  ]
+
+    NuGet (fun p -> 
+        {p with
+            OutputPath = deployDir
+            WorkingDir = packagingDir
+            Version = version
+            Publish = false }) 
+            "src/Pickles/Pickles.PowerShell/Pickles.nuspec"
+)
+
+Target "CreatePackage" (fun _ -> 
+    trace ("Starting build of nuget packages version " + version)
+    DeleteDir packagingDir
+)
+
+// Dependencies
+"Clean"
+  ==> "CreatePackageCommandLine"
+  ==> "CreatePackageMsBuild"
+  ==> "CreatePackagePowerShell"
+  ==> "CreatePackage"
+
+
+// start build
+RunTargetOrDefault "CreatePackage"

src/Pickles/Pickles.CommandLine/Pickles.CommandLine.nuspec

@@ -2,20 +2,20 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
   <metadata>
     <id>Pickles.CommandLine</id>
-    <version>$version$</version>
+    <version>@build.number@</version>
     <title>Command line version of Pickles - The Open Source Living Documentation Generator</title>
     <authors>PicklesDoc and contributors</authors>
     <owners>Jeffrey Cameron, Dirk Rombauts</owners>
     <projectUrl>http://www.picklesdoc.com/</projectUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
-	<licenseUrl>http://apache.org/licenses/LICENSE-2.0.html</licenseUrl>
+    <licenseUrl>http://apache.org/licenses/LICENSE-2.0.html</licenseUrl>
     <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>
     <summary>A documentation generator for features written in the Gherkin language</summary>
     <copyright>Copyright © 2010-2012 Jeffrey Cameron, Copyright © 2013-present PicklesDoc and contributors</copyright>
+    <tags>SpecificationByExample BDD SpecFlow Gherkin Cucumber SpecByEx LivingDocumentation Documentation</tags>
   </metadata>
   <files>
-    <file src="bin\Release\*.dll" target="tools" />
-    <file src="bin\Release\*.exe" target="tools" />
-    <file src="bin\Release\*.exe.config" target="tools" />
+    <file src="Pickles.exe" target="tools" />
+    <file src="NLog.config" target="tools" />
   </files>
 </package>

src/Pickles/Pickles.MSBuild/Pickles.MSBuild.nuspec

@@ -2,18 +2,19 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
   <metadata>
     <id>Pickles.MSBuild</id>
-    <version>$version$</version>
+    <version>@build.number@</version>
     <title>MSBuild Task for Pickles - The Open Source Living Documentation Generator</title>
     <authors>PicklesDoc and contributors</authors>
     <owners>Jeffrey Cameron, Dirk Rombauts</owners>
     <projectUrl>http://www.picklesdoc.com/</projectUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
-	<licenseUrl>http://apache.org/licenses/LICENSE-2.0.html</licenseUrl>
+    <licenseUrl>http://apache.org/licenses/LICENSE-2.0.html</licenseUrl>
     <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>
     <summary>A documentation generator for features written in the Gherkin language</summary>
     <copyright>Copyright © 2010-2012 Jeffrey Cameron, Copyright © 2013-present PicklesDoc and contributors</copyright>
+    <tags>SpecificationByExample BDD SpecFlow Gherkin Cucumber SpecByEx LivingDocumentation Documentation</tags>
   </metadata>
   <files>
-    <file src="bin\Release\*.dll" target="tools" />
+    <file src="PicklesDoc.Pickles.MSBuild.Tasks.dll" target="tools" />
   </files>
 </package>

src/Pickles/Pickles.PowerShell/Pickles.nuspec

@@ -2,19 +2,20 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
   <metadata>
     <id>Pickles</id>
-    <version>$version$</version>
+    <version>@build.number@</version>
     <title>Pickles - The Open Source Living Documentation Generator</title>
     <authors>PicklesDoc and contributors</authors>
     <owners>Jeffrey Cameron, Dirk Rombauts</owners>
     <projectUrl>http://www.picklesdoc.com/</projectUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
-	<licenseUrl>http://apache.org/licenses/LICENSE-2.0.html</licenseUrl>
+    <licenseUrl>http://apache.org/licenses/LICENSE-2.0.html</licenseUrl>
     <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>
     <summary>A documentation generator for features written in the Gherkin language</summary>
     <copyright>Copyright © 2010-2012 Jeffrey Cameron, Copyright © 2013-present PicklesDoc and contributors</copyright>
+    <tags>SpecificationByExample BDD SpecFlow Gherkin Cucumber SpecByEx LivingDocumentation Documentation</tags>
   </metadata>
   <files>
-    <file src="bin\Release\*.dll" target="tools" />
+    <file src="PicklesDoc.Pickles.PowerShell.dll" target="tools" />
     <file src="init.ps1" target="tools\init.ps1" />
   </files>
 </package>

src/Pickles/Pickles.Test/WhenDeterminingRelevantFilesToConsider.cs

@@ -26,6 +26,8 @@ public void ThenCanDetectFeatureFilesSuccessfully()
             relevantFileDetector.IsRelevant(FileSystem.FileInfo.FromFileName("test.pdf")).ShouldBeFalse();
             relevantFileDetector.IsRelevant(FileSystem.FileInfo.FromFileName("test.doc")).ShouldBeFalse();
             relevantFileDetector.IsRelevant(FileSystem.FileInfo.FromFileName("test.docx")).ShouldBeFalse();
+            relevantFileDetector.IsRelevant(FileSystem.FileInfo.FromFileName("test.docx")).ShouldBeFalse();
+            relevantFileDetector.IsRelevant(FileSystem.FileInfo.FromFileName("myproject.csproj.FileListAbsolute.txt")).ShouldBeFalse();
         }
     }
 }

src/Pickles/Pickles/DirectoryCrawler/RelevantFileDetector.cs

@@ -39,6 +39,11 @@ public bool IsFeatureFile(FileInfoBase file)
 
         public bool IsMarkdownFile(FileInfoBase file)
         {
+            if (file.Name.EndsWith("csproj.FileListAbsolute.txt"))
+            {
+              return false;
+            }
+
             switch (file.Extension.ToLowerInvariant())
             {
                 case ".markdown":

src/Pickles/Pickles/DocumentationBuilders/HTML/HtmlResourceWriter.cs

@@ -52,7 +52,7 @@ public void WriteTo(string folder)
             this.WriteScript(scriptsFolder, "jquery.js");
             this.WriteScript(scriptsFolder, "scripts.js");
 
-            string fontsFolder = this.FileSystem.Path.Combine(folder, "fonts");
+            string fontsFolder = this.FileSystem.Path.Combine(cssFolder, "fonts");
             this.EnsureFolder(fontsFolder);
             this.WriteFont(fontsFolder, "FontAwesome.ttf");
             this.WriteFont(fontsFolder, "fontawesome-webfont.eot");

src/Pickles/Pickles/DocumentationBuilders/HTML/ResourceWriter.cs

@@ -94,7 +94,7 @@ protected void WriteScript(string folder, string filename)
 
     protected void WriteFont(string folder, string filename)
     {
-      using (var input = GetResourceStream(this.namespaceOfResources + "fonts." + filename))
+      using (var input = GetResourceStream(this.namespaceOfResources + "css.fonts." + filename))
       {
         using (var output = this.fileSystem.File.Create(this.fileSystem.Path.Combine(folder, filename)))
         {

src/Pickles/Pickles/Pickles.csproj

@@ -329,10 +329,10 @@
       <Generator>ResXFileCodeGenerator</Generator>
       <LastGenOutput>Resources.Designer.cs</LastGenOutput>
     </EmbeddedResource>
-    <EmbeddedResource Include="Resources\Html\fonts\fontawesome-webfont.eot" />
-    <EmbeddedResource Include="Resources\Html\fonts\fontawesome-webfont.ttf" />
-    <EmbeddedResource Include="Resources\Html\fonts\fontawesome-webfont.woff" />
-    <EmbeddedResource Include="Resources\Html\fonts\FontAwesome.ttf" />
+    <EmbeddedResource Include="Resources\Html\css\fonts\fontawesome-webfont.eot" />
+    <EmbeddedResource Include="Resources\Html\css\fonts\fontawesome-webfont.ttf" />
+    <EmbeddedResource Include="Resources\Html\css\fonts\fontawesome-webfont.woff" />
+    <EmbeddedResource Include="Resources\Html\css\fonts\FontAwesome.ttf" />
     <None Include="Settings.StyleCop" />
   </ItemGroup>
   <ItemGroup>
@@ -361,7 +361,7 @@
     <EmbeddedResource Include="Resources\Html\css\font-awesome.css" />
   </ItemGroup>
   <ItemGroup>
-    <EmbeddedResource Include="Resources\Html\fonts\fontawesome-webfont.svg" />
+    <EmbeddedResource Include="Resources\Html\css\fonts\fontawesome-webfont.svg" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="..\Pickles.BaseDhtmlFiles\css\bootstrap.min.css">

src/Pickles/VersionInfo.cs

@@ -4,14 +4,14 @@
 
 [assembly: AssemblyProductAttribute("Pickles")]
 [assembly: AssemblyCompanyAttribute("Pickles")]
-[assembly: AssemblyCopyrightAttribute("Copyright (c) Jeffrey Cameron 2010-2012, PicklesDoc 2012-2013")]
+[assembly: AssemblyCopyrightAttribute("Copyright (c) Jeffrey Cameron 2010-2012, PicklesDoc 2012-present")]
 [assembly: AssemblyTrademarkAttribute("")]
 [assembly: AssemblyCultureAttribute("")]
 [assembly: ComVisibleAttribute(false)]
-[assembly: AssemblyVersionAttribute("0.18.0")]
-[assembly: AssemblyFileVersionAttribute("0.18.0")]
+[assembly: AssemblyVersionAttribute("0.18.2")]
+[assembly: AssemblyFileVersionAttribute("0.18.2")]
 namespace System {
     internal static class AssemblyVersionInformation {
-        internal const string Version = "0.18.0";
+        internal const string Version = "0.18.2";
     }
 }

test.bat

@@ -0,0 +1,3 @@
+@echo off
+
+"packages\FAKE\tools\Fake.exe" test.fsx

test.fsx

@@ -0,0 +1,19 @@
+// include Fake lib
+#r @"packages\FAKE\tools\FakeLib.dll"
+open Fake
+
+
+// Properties
+let testDir  = "./test/"
+
+Target "Test" (fun _ ->
+    !! (testDir + "PicklesDoc.Pickles.Test.dll")
+      |> NUnit (fun p ->
+          {p with
+             DisableShadowCopy = true;
+             OutputFile = testDir + "TestResults.xml" })
+)
+
+
+// start build
+RunTargetOrDefault "Test"

testOutput.cmd

@@ -1 +1 @@
-FOR %%A IN (Html Dhtml Word Excel Dita) DO .\deploy\pickles-%1\exe\Pickles.exe -f=.\src\Pickles\Examples\ -o=.\Output\%%A\ --sn=Pickles --sv=%1 --df=%%A
+FOR %%A IN (Html Dhtml Word Excel Dita JSON) DO .\deploy\pickles-%1\exe\Pickles.exe -f=.\src\Pickles\Examples\ -o=.\Output\%%A\ --sn=Pickles --sv=%1 --df=%%A

testOutput.proj

@@ -19,6 +19,9 @@
 		<OutputFormat Include="Dita">
 			<Name>Dita</Name>
 		</OutputFormat>
+		<OutputFormat Include="JSON">
+			<Name>JSON</Name>
+		</OutputFormat>
 	</ItemGroup>
 	<UsingTask AssemblyFile=".\deploy\pickles-$(Version)\msbuild\PicklesDoc.Pickles.MSBuild.Tasks.dll" TaskName="Pickles" />
 	<Target Name="document">

testOutput.ps1

@@ -1,5 +1,5 @@
 $version = $args[0]
-$formats = @("Html", "Dhtml", "Word", "Excel", "Dita")
+$formats = @("Html", "Dhtml", "Word", "Excel", "Dita", "JSON")
 $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent
 
 foreach ($format in $formats)