Ruby gem to convert gherkin feature files into html and pdf flavour.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
css
js
lib
sample
template
testing
.gitignore
.travis.yml
CNAME
Gemfile
LICENSE
README.md
Rakefile
_config.yml
appveyor.yml
fg.ico
flavored_gherkin.gemspec

README.md

FlavoredGherkin

Gem Version Build status Windows Build status

Ruby gem to convert gherkin feature files into html and pdf flavour.

Html Flavour Sample

Pdf Flavour Sample

More flavours coming soon!

Installation

gem install flavored_gherkin

Information

Usage

Options:

Option Type Default Values
title [String] 'Flavored Gherkin' Flavored Gherkin Title
feature_path / input_path [String] Present Working Directory Feature Files Path
output_path [String] Present Working Directory Flavored Gherkin Output Path
flavour [String] 'Html' 'Html' or 'Pdf'

Code Examples:

     require 'flavored_gherkin'
    
    # Example 1:
    
    FlavoredGherkin.configure do |config|
      config.title = 'My Features'
      config.feature_path = 'myFolder/features'
      config.output_path = 'myFolder/my_features'
    end
    
    FlavoredGherkin.build
    
    # Example 2:
    
    options = {
       title: 'My Features',
       feature_path: 'myFolder/features',
       output_path: 'myFolder/my_features'
     }
    
    FlavoredGherkin.build options
        
    # Example 3:
    
    FlavoredGherkin.set 'title', 'My Features'
    FlavoredGherkin.set 'feature_path', 'myFolder/features'
    FlavoredGherkin.set  'output_path', 'myFolder/my_features'
    
    FlavoredGherkin.build
    
    # Example 4:
    
    FlavoredGherkin.title = 'My Features'
    FlavoredGherkin.feature_path = 'myFolder/features'
    FlavoredGherkin.output_path  = 'myFolder/my_features'
    FlavoredGherkin.flavour  = 'pdf'
    
    FlavoredGherkin.build
                

CLI Options:

Option Values Explanation
-t, --source TITLE Flavored Gherkin Title
-f, --features / -i, --in FEATURE_PATH Feature Files Path
-o, --out OUTPUT_PATH Flavored Gherkin Output Path
-F, --flavour FLAVOUR 'Html' or 'Pdf'

CLI Example:

     flavored_gherkin
     
     flavored_gherkin -f 'myFolder/features'
     
     flavored_gherkin -t 'My Features' -f 'myFolder/features' -o 'myFolder/my_features'

Contributing

We're open to any contribution. It has to be tested properly though.

Collaborators

License

Copyright (c) 2017 MIT LICENSE