public void all_user_commands_should_have_help_documentation(ICommandHelpCollection collection, IEnumerable <ICraneCommand> userCommands)
{
"Given I have a command help collection"
._(() => collection = ServiceLocator.Resolve <IHelpProvider>().HelpCollection);
"And I have all the user commands"
._(() => userCommands = ServiceLocator.Resolve <IPublicCommandResolver>().Resolve());
"Then there should be a command help instance for each command"
._(
() =>
userCommands.ForEach(
command =>
collection.Get(command.Name())
.Should()
.NotBeNull("missing command help for command {0}", command.Name())));
}
public XmlHelpProvider(ICommandHelpParser parser, IFileManager fileManager)
{
_helpCollection =
parser.Parse(
fileManager.ReadAllText(GetPath()));
}
public void can_parse_xml_comment_file_and_generate_command_help(string documentation, ICommandHelpParser parser, ICommandHelpCollection result)
{
"Given I have an xml comment file"
._(() => documentation = @"<?xml version=""1.0""?>
<doc>
<assembly>
<name>Crane.Core</name>
</assembly>
<members>
<member name=""T:Crane.Core.Commands.Init"">
<summary>
Initializes a new project
</summary>
<example>
EXAMPLE 1
<code>usage: crane init SallyFx</code>
This example initializes a new project 'SallyFx' in the current directory
</example>
</member>
<member name=""T:Crane.Core.Commands.Help"">
<summary>
Displays help for crane commands
</summary>
</member>
</members>
</doc>
");
"And I have a command help parser"
._(() => parser = ServiceLocator.Resolve <XmlCommentCommandHelpParser>());
"When I parse the comment file"
._(() => result = parser.Parse(documentation));
"Then it should return a command help collection"
._(() => result.Should().NotBeNull());
"And it should have help for each command referenced in the comment file"
._(() => result.Count.Should().Be(2));
"And it should contain parsed command help"
._(() => result.Get("init").Should().NotBeNull());
"And it should have parsed the description"
._(() => result.Get("init").Description.Should().Be("Initializes a new project"));
"And it should have parsed the example"
._(() => result.Get("init").Examples.First().Value.Should().Contain("This example initializes a new project 'SallyFx' in the current directory"));
}
public void xml_help_provider_returns_crane_help_collection(IHelpProvider xmlProvider, ICommandHelpCollection helpCollection)
{
"Given I have an instance of the xml help provider"
._(() => xmlProvider = ServiceLocator.Resolve <XmlHelpProvider>());
"It should return a help collection"
._(() =>
{
helpCollection = xmlProvider.HelpCollection;
helpCollection.Should().NotBeNull();
});
"It should contain help for the crane commands"
._(() => helpCollection.Get("init").Should().NotBeNull());
}
