Skip to content

Commit

Permalink
Merge branch 'master' into release
Browse files Browse the repository at this point in the history
  • Loading branch information
Dirk Rombauts committed Dec 23, 2015
2 parents eec0dd0 + abb7282 commit 3bca9ff
Show file tree
Hide file tree
Showing 9 changed files with 126 additions and 265 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Guidelines for Contributors

Pickles is a volunteer effort. We encourage you to pitch in!

## To Contribute Code

- Fork the `Pickles` repository
- Create your code
- Send a pull request.

## To Contribute Documentation

- Fork the `doc` repository
- Write documentation
- If you add a new page, you need to add a reference to it in `mkdocs.yml`
- Send a pull request

## To Request a Feature

- Create an issue.

## To Ask a Question

- Create an issue.

## To Report a Bug

- Create an issue
- Describe steps to reproduce the bug
- If at all possible, attach feature file(s) that cause the bug. In most cases you can remove the steps from the scenarios in order to protect your intellectual property.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Introduction

[![Documentation Status](https://readthedocs.org/projects/pickles/badge/?version=latest)](https://readthedocs.org/projects/pickles/?badge=latest)

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.
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 documentation 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.

Why stop with just the features though? Pickles can also read plain text files written in the Markdown format so you can add other files to your feature to add all sorts of context. Well-written features are great to have but even the best written features can leave out some important context information. Markdown is very simple to write and is designed to be easily read even in plain text files so they are a great way of adding additional context to your feature files to turn them into a real set of living documentation.

Expand Down
261 changes: 1 addition & 260 deletions ReleaseNotes.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build.bat
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@echo off
set "picklesVersion=2.0.2"
set "picklesVersion=2.0.3"

cls

Expand Down
Binary file modified packages/nuget/nuget.exe
Binary file not shown.
33 changes: 33 additions & 0 deletions src/Pickles/Pickles.Test/ObjectModel/MapperTestsForBackground.cs
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,38 @@ public void MapToScenario_BackgroundWithNullDescription_ReturnsScenarioWithEmpty

Check.That(result.Description).IsEqualTo(string.Empty);
}

[Test]
public void MapToFeature_Always_MapsFeaturePropertyOfBackground()
{
var scenario = this.factory.CreateScenario(
new[] { "unimportant tag" },
"My scenario title",
null,
new[] { this.factory.CreateStep("Given", "unimportant step") });
var background = this.factory.CreateBackground(
"Background",
"Description of the Background",
new[]
{
this.factory.CreateStep("Given", "another unimportant step"),
});
var feature = this.factory.CreateFeature(
"My Feature",
"My Description",
scenarioDefinitions: new G.ScenarioDefinition[] { scenario },
background: background);


var mapper = this.factory.CreateMapper();

var mappedFeature = mapper.MapToFeature(feature);

Check.That(mappedFeature.FeatureElements.Count).IsEqualTo(1);

var mappedBackground = mappedFeature.Background;

Check.That(mappedBackground.Feature).IsSameReferenceThan(mappedFeature);
}
}
}
52 changes: 52 additions & 0 deletions src/Pickles/Pickles.sln.GhostDoc.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<GhostDoc>
<IgnoreFilePatterns>
<IgnoreFilePattern>*.min.js</IgnoreFilePattern>
<IgnoreFilePattern>jquery*.js</IgnoreFilePattern>
</IgnoreFilePatterns>
<SpellChecker>
<IncludeExtensions>
</IncludeExtensions>
<IgnoreExtensions>
</IgnoreExtensions>
<IgnoreFiles>
</IgnoreFiles>
</SpellChecker>
<HelpConfigurations selected="HelpFile">
<HelpConfiguration name="HelpFile">
<OutputPath>.\Help</OutputPath>
<CleanupOutputPath>true</CleanupOutputPath>
<HelpFileName>Pickles</HelpFileName>
<ImageFolderPath />
<Theme />
<HtmlFormats>
<HtmlHelp>true</HtmlHelp>
<MSHelpViewer>false</MSHelpViewer>
<MSHelp2>false</MSHelp2>
<Website>false</Website>
</HtmlFormats>
<IncludeScopes>
<Public>true</Public>
<Internal>false</Internal>
<Protected>false</Protected>
<Private>false</Private>
<Inherited>true</Inherited>
<InheritedFromReferences>true</InheritedFromReferences>
<EnableTags>false</EnableTags>
<TagList />
<AutoGeneratedDocs />
<DocsThatRequireEditing />
</IncludeScopes>
<SyntaxLanguages>
<CSharp>true</CSharp>
<VisualBasic>true</VisualBasic>
<CPlusPlus>true</CPlusPlus>
</SyntaxLanguages>
<ResolveCrefLinks>true</ResolveCrefLinks>
<HeaderText />
<FooterText />
<SelectedProjects />
</HelpConfiguration>
</HelpConfigurations>
<GeneralProperties>
</GeneralProperties>
</GhostDoc>
5 changes: 5 additions & 0 deletions src/Pickles/Pickles/ObjectModel/Mapper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@ public Mapper(string featureLanguage = LanguageServices.DefaultLanguage)
{
featureElement.Feature = targetFeature;
}

if (targetFeature.Background != null)
{
targetFeature.Background.Feature = targetFeature;
}
});
}

Expand Down
6 changes: 3 additions & 3 deletions src/Pickles/VersionInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
[assembly: AssemblyTrademarkAttribute("")]
[assembly: AssemblyCultureAttribute("")]
[assembly: ComVisibleAttribute(false)]
[assembly: AssemblyVersionAttribute("2.0.2")]
[assembly: AssemblyFileVersionAttribute("2.0.2")]
[assembly: AssemblyVersionAttribute("2.0.3")]
[assembly: AssemblyFileVersionAttribute("2.0.3")]
namespace System {
internal static class AssemblyVersionInformation {
internal const string Version = "2.0.2";
internal const string Version = "2.0.3";
}
}

0 comments on commit 3bca9ff

Please sign in to comment.