cukestep

Cukestep

Cukestep exposes your system's Gherkin steps to the outside world through a Rails Engine.

Installation

Add this line to your application's Gemfile:

gem 'cukestep'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cukestep

Usage

Mount the engine

# routes.rb
mount Cukestep::Engine => "/cukestep", as: "cukestep"

Start your Rails application and navigate to

/cukestep/steps

At this point - you should be seeing a JSON output of your Gherkin steps.

Configuration

Rails

To exclude a support file from the autoload path, create an initializer class and tell Cukestep which files to exclude.

# #{Rails.root}/config/initializers/cukestep_config.rb
Cukestep.configure do |c|
  c.excluded_code_file_paths = ['features/support/extranet.rb']
end

Browser

Modify Cukestep.url = within example/assets/bookmarklet.js and change the URL to point to your local development environment. For production, modify the URL to point to your production server.

Note: Pivotal Tracker and Trello run on SSL. In order to test locally, run Charles Proxy, map https->http, configure SSL proxying and visit the endpoint URL in the browser to accept the SSL certification restriction.

Pivotal Tracker and Trello

Inject example/assets/bookmarklet.js in your browser as a bookmarklet to decorate the Pivotal Tracker story/Trello description field.

Examples - Pivotal Tracker and Trello

Shoutouts

Cukestep makes heavy use of At.js.

Contributing

• Fork it ( https://github.com/[my-github-username]/cukestep/fork )
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create a new Pull Request