Browse your cucumber features from within your Rails app with Courgette, a Rails engine.
Ruby JavaScript
Switch branches/tags
Nothing to show
Pull request Compare This branch is 10 commits ahead of jmgarnier:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.bundle
app
config
doc
features
fixture_rails_root
lib
public/courgette
spec
.gitignore
Gemfile
Rakefile
Readme.rdoc
courgette.gemspec
init.rb

Readme.rdoc

Courgette

Courgette is a Rails 3 engine which makes your cucumber features files viewable through your browser.

![“Screenshot”]()

Installing / Getting started


Courgette is only compatible with Rails 3.

Add to your `Gemfile`:

gem 'courgette'

And run:

bundle install

Now start your app and go to [/features](localhost:3000/features). From there you can navigate to the specific feature file you want to look at.

Preventing unauthorized access


To prevent unauthorized users from viewing your feature files, it is recommended that you add a before_filter to the FeaturesController, such as this:

FeaturesController.class_eval do
  before_filter :authorize

private
  def authorize
    authorize! :view, Courgette::Feature
  end
end

This example uses the authorize! method from CanCan.

Contribute


You can contribute to the project with Git:

  • Fork the project

  • bundle install

  • rake # should have no failures

  • Make your feature addition or bug fix (please specify ruby & rails versions)

  • Add tests for it. This is important so I don't break it in a future version unintentionally.

  • Commit and push

  • Send me a pull request

Please vote for the next features: github.com/21croissants/courgette/issues#sort=votes

Similar projects


  • versapay/viewcumber — Cucumber formatter for easily viewing each step of your scenarios with screenshots (Rails 3 only)

  • github.com/cs3b/cucumber_fm — Very active, very nice dashboard with integrated editor

  • github.com/7digital/7features — a simple CSS formatter to ouput features in a more business readable way

  • github.com/christophermoura/rcumber — not updated since nov 2008

  • www.relishapp.com/relish/relish/ — Formatter is closed source. Client for pushing projects to www.relishapp.com is open source.

License


(The MIT License)

Copyright © 2009 Jonas Nicklas - 2010 Jean-Michel Garnier

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

To do