mattscilipoti-cucumber-rails 0.2.4

data/generators/cucumber/templates/support/_rails_each_run.rb

@@ -0,0 +1,29 @@
+# If you set this to false, any error raised from within your app will bubble 
+# up to your step definition and out to cucumber unless you catch it somewhere
+# on the way. You can make Rails rescue errors and render error pages on a
+# per-scenario basis by tagging a scenario or feature with the @allow-rescue tag.
+#
+# If you set this to true, Rails will rescue all errors and render error
+# pages, more or less in the same way your application would behave in the
+# default production environment. It's not recommended to do this for all
+# of your scenarios, as this makes it hard to discover errors in your application.
+ActionController::Base.allow_rescue = false
+
+# If you set this to true, each scenario will run in a database transaction.
+# You can still turn off transactions on a per-scenario basis, simply tagging 
+# a feature or scenario with the @no-txn tag. If you are using Capybara,
+# tagging with @culerity or @javascript will also turn transactions off.
+#
+# If you set this to false, transactions will be off for all scenarios,
+# regardless of whether you use @no-txn or not.
+#
+# Beware that turning transactions off will leave data in your database 
+# after each scenario, which can lead to hard-to-debug failures in 
+# subsequent scenarios. If you do this, we recommend you create a Before
+# block that will explicitly put your database in a known state.
+Cucumber::Rails::World.use_transactional_fixtures = true
+
+# How to clean your database when transactions are turned off. See
+# http://github.com/bmabey/database_cleaner for more info.
+require 'database_cleaner'
+DatabaseCleaner.strategy = :truncation

data/generators/cucumber/templates/support/_rails_prefork.rb.erb

@@ -0,0 +1,10 @@
+ENV["RAILS_ENV"] ||= "cucumber"
+require File.expand_path(File.dirname(__FILE__) + '/../../config/environment')
+
+require 'cucumber/formatter/unicode' # Remove this line if you don't want Cucumber Unicode support
+<% if framework == :rspec -%>
+require 'cucumber/rails/rspec'
+<% end -%>
+require 'cucumber/rails/world'
+require 'cucumber/rails/active_record'
+require 'cucumber/web/tableish'

data/generators/cucumber/templates/support/capybara.rb

@@ -0,0 +1,9 @@
+require 'capybara/rails'
+require 'capybara/cucumber'
+require 'capybara/session'
+require 'cucumber/rails/capybara_javascript_emulation' # Lets you click links with onclick javascript handlers without using @culerity or @javascript
+# Capybara defaults to XPath selectors rather than Webrat's default of CSS3. In
+# order to ease the transition to Capybara we set the default here. If you'd
+# prefer to use XPath just remove this line and adjust any selectors in your
+# steps to use the XPath syntax.
+Capybara.default_selector = :css

data/generators/cucumber/templates/support/edit_warning.txt

@@ -0,0 +1,5 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.

data/generators/cucumber/templates/support/paths.rb

@@ -0,0 +1,27 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in web_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+    
+    when /the home\s?page/
+      '/'
+    
+    # Add more mappings here.
+    # Here is an example that pulls values out of the Regexp:
+    #
+    #   when /^(.*)'s profile page$/i
+    #     user_profile_path(User.find_by_login($1))
+
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/generators/cucumber/templates/support/rails.rb.erb

@@ -0,0 +1,4 @@
+<%= embed_file('support/edit_warning.txt') %>
+<%= embed_template('support/_rails_prefork.rb.erb') %>
+<%= embed_file("support/#{driver}.rb") %>
+<%= embed_file('support/_rails_each_run.rb') %>

data/generators/cucumber/templates/support/rails_spork.rb.erb

@@ -0,0 +1,13 @@
+<%= embed_file('support/edit_warning.txt') %>
+require 'rubygems'
+require 'spork'
+ 
+Spork.prefork do
+<%= embed_template('support/_rails_prefork.rb.erb', '  ') %>
+
+<%= embed_file("support/#{driver}.rb", '  ') %>
+end
+ 
+Spork.each_run do
+<%= embed_file('support/_rails_each_run.rb', '  ') %>
+end

data/generators/cucumber/templates/support/webrat.rb

@@ -0,0 +1,8 @@
+require 'webrat'
+require 'webrat/core/matchers'
+
+Webrat.configure do |config|
+  config.mode = :rails
+  config.open_error_files = false # Set to true if you want error pages to pop up in the browser
+end
+

data/generators/cucumber/templates/tasks/cucumber.rake.erb

@@ -0,0 +1,42 @@
+<%= embed_file('support/edit_warning.txt') %>
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{RAILS_ROOT}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/generators/feature/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Generates a skeleton for a new feature. Both a simple .feature file and
+    a steps.rb file is generated. This generator should be used with moderation.
+    See http://github.com/aslakhellesoy/cucumber/wikis/feature-coupled-steps-antipattern
+    for details about the dangers involved.
+
+    This generator can take an optional list of attribute pairs similar to Rails'
+    built-in resource generator.
+
+Examples:
+    `./script/generate feature post` # no attributes
+    `./script/generate feature post title:string body:text published:boolean`

data/generators/feature/feature_generator.rb

@@ -0,0 +1,41 @@
+# This generator generates a baic feature.
+class FeatureGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.directory 'features/step_definitions'
+      m.template  'feature.erb', "features/manage_#{plural_name}.feature"
+      m.template  'steps.erb', "features/step_definitions/#{singular_name}_steps.rb"
+
+      m.gsub_file 'features/support/paths.rb', /'\/'/mi do |match|
+        "#{match}\n    when /the new #{singular_name} page/\n      new_#{singular_name}_path\n"
+      end
+    end
+  end
+
+  class NamedArg
+    attr_reader :name
+    attr_reader :type
+
+    def initialize(s)
+      @name, @type = *s.split(':')
+    end
+
+    def value(n)
+      if @type == 'boolean'
+        (n % 2) == 0
+      else
+        "#{@name} #{n}"
+      end
+    end
+  end
+
+  def named_args
+    args.map{|arg| NamedArg.new(arg)}
+  end
+
+  protected
+
+  def banner
+    "Usage: #{$0} feature ModelName [field:type, field:type]"
+  end
+end

data/generators/feature/templates/feature.erb

@@ -0,0 +1,59 @@
+Feature: Manage <%= plural_name %>
+  In order to [goal]
+  [stakeholder]
+  wants [behaviour]
+  
+  Scenario: Register new <%= singular_name %>
+    Given I am on the new <%= singular_name %> page
+<% keyword = 'When' -%>
+<% named_args.each do |arg| -%>
+<% if arg.type == 'boolean' -%>
+    <%= keyword %> I uncheck "<%= arg.name.humanize %>"
+<% else -%>
+    <%= keyword %> I fill in "<%= arg.name.humanize %>" with "<%= arg.value(1) %>"
+<% end -%>
+<% keyword = 'And' -%>
+<% end -%>
+    And I press "Create"
+<% keyword = 'Then' -%>
+<% named_args.each do |arg| -%>
+    <%= keyword %> I should see "<%= arg.value(1) %>"
+<% keyword = 'And' -%>
+<% end -%>
+
+<% if IO.read('features/support/env.rb') =~ /capybara/n -%>
+  # Rails generates Delete links that use Javascript to pop up a confirmation
+  # dialog and then do a HTTP POST request (emulated DELETE request).
+  #
+  # Capybara must use Culerity or Selenium2 (webdriver) when pages rely on
+  # Javascript events. Only Culerity supports confirmation dialogs.
+  # 
+  # cucumber-rails will turn off transactions for scenarios tagged with 
+  # @selenium, @culerity, @javascript or @no-txn and clean the database with 
+  # DatabaseCleaner after the scenario has finished. This is to prevent data 
+  # from leaking into the next scenario.
+  #
+  # Culerity has some performance overhead, and there are two alternatives to using
+  # Culerity:
+  #
+  # a) You can remove the @culerity tag and run everything in-process, but then you 
+  # also have to modify your views to use <button> instead: http://github.com/jnicklas/capybara/issues#issue/12
+  #
+  # b) Replace the @culerity tag with @emulate_rails_javascript. This will detect
+  # the onclick javascript and emulate its behaviour without a real Javascript
+  # interpreter.
+  #
+  @culerity
+<% end -%>
+  Scenario: Delete <%= singular_name %>
+    Given the following <%= plural_name %>:
+      |<%= named_args.map(&:name).join('|') %>|
+<% (1..4).each do |n| -%>
+      |<%= named_args.map{|arg| arg.value(n)}.join('|') %>|
+<% end -%>
+    When I delete the 3rd <%= singular_name %>
+    Then I should see the following <%= plural_name %>:
+      |<%= named_args.map{|arg| arg.name.humanize}.join('|') %>|
+<% [1,2,4].each do |n| -%>
+      |<%= named_args.map{|arg| arg.value(n)}.join('|') %>|
+<% end -%>

data/generators/feature/templates/steps.erb

@@ -0,0 +1,14 @@
+Given /^the following <%= plural_name %>:$/ do |<%= plural_name %>|
+  <%= class_name %>.create!(<%= plural_name %>.hashes)
+end
+
+When /^I delete the (\d+)(?:st|nd|rd|th) <%= singular_name %>$/ do |pos|
+  visit <%= plural_name %>_url
+  within("table tr:nth-child(#{pos.to_i+1})") do
+    click_link "Destroy"
+  end
+end
+
+Then /^I should see the following <%= plural_name %>:$/ do |expected_<%= plural_name %>_table|
+  expected_<%= plural_name %>_table.diff!(tableish('table tr', 'td,th'))
+end

data/lib/cucumber/rails/action_controller.rb

@@ -0,0 +1,65 @@
+if Rails.version.to_f >= 3.0
+  module ActionController #:nodoc:
+    module AllowRescueException
+      extend ActiveSupport::Concern
+      include ActiveSupport::Rescuable
+
+      private
+        def process_action(*args)
+          if ActionController::Base.allow_rescue
+            super
+          else
+            begin
+              super
+            rescue Exception => exception
+              raise(exception)
+            end
+          end
+        end
+    end
+  end
+
+  ActionController::Base.class_eval do
+    cattr_accessor :allow_rescue
+    include ActionController::AllowRescueException
+  end
+else
+  ActionController::Base.class_eval do
+    cattr_accessor :allow_rescue
+    
+    alias_method :rescue_action_without_bypass, :rescue_action
+  
+    def rescue_action(exception)
+      if ActionController::Base.allow_rescue
+        rescue_action_without_bypass(exception)
+      else
+        raise exception
+      end
+    end
+  end
+end
+
+begin
+  ActionController::Failsafe.class_eval do
+    alias_method :failsafe_response_without_bypass, :failsafe_response
+  
+    def failsafe_response(exception)
+      raise exception
+    end
+  end
+rescue NameError # Failsafe was introduced in Rails 2.3.2
+  ActionController::Dispatcher.class_eval do
+    def self.failsafe_response(output, status, exception = nil)
+      raise exception
+    end
+  end
+end
+
+Before('@allow-rescue') do
+  @__orig_allow_rescue = ActionController::Base.allow_rescue
+  ActionController::Base.allow_rescue = true
+end
+
+After('@allow-rescue') do
+  ActionController::Base.allow_rescue = @__orig_allow_rescue
+end

data/lib/cucumber/rails/active_record.rb

@@ -0,0 +1,36 @@
+puts 'INFO: Using mattscilipoti-cucumber-rails -v0.2.4'
+if defined?(ActiveRecord::Base)
+  Before do
+    $__cucumber_global_use_txn = !!Cucumber::Rails::World.use_transactional_fixtures if $__cucumber_global_use_txn.nil?
+  end
+
+  Before('~@no-txn', '~@selenium', '~@culerity', '~@celerity', '~@javascript') do
+    Cucumber::Rails::World.use_transactional_fixtures = $__cucumber_global_use_txn
+  end
+
+  Before('@no-txn,@selenium,@culerity,@celerity,@javascript') do
+    Cucumber::Rails::World.use_transactional_fixtures = false
+  end
+
+  Before do
+    DatabaseCleaner.clean #WORKAROUND: transactional mysql does not reset pk seed unless 'cleaned'
+    if Cucumber::Rails::World.use_transactional_fixtures
+      run_callbacks :setup if respond_to?(:run_callbacks)
+    else
+      DatabaseCleaner.start
+    end
+    ActionMailer::Base.deliveries = [] if defined?(ActionMailer::Base)
+  end
+
+  After do
+    if Cucumber::Rails::World.use_transactional_fixtures
+      run_callbacks :teardown if respond_to?(:run_callbacks)
+    else
+      DatabaseCleaner.clean if Cucumber::Rails::World.clean_database_after
+    end
+  end
+else
+  module Cucumber::Rails
+    def World.fixture_table_names; []; end # Workaround for projects that don't use ActiveRecord
+  end
+end

data/lib/cucumber/rails/capybara_javascript_emulation.rb

@@ -0,0 +1,61 @@
+module Cucumber
+  module Rails
+    module CapybaraJavascriptEmulation
+      def self.included(base)
+        base.class_eval do
+          alias_method :click_without_rails_javascript_emulation, :click
+        end
+      end
+  
+      def click_with_rails_javascript_emulation
+        if link_with_onclick_from_rails?
+          Capybara::Driver::RackTest::Form.new(driver, js_form(self[:href], emulated_method)).submit(self)
+        else
+          click_without_rails_javascript_emulation
+        end
+      end
+      
+
+      private
+      def js_form(action, emulated_method, method = 'POST')
+        js_form = node.document.create_element('form')
+        js_form['action'] = action
+        js_form['method'] = method
+
+        if emulated_method and emulated_method.downcase != method.downcase
+          input = node.document.create_element('input')
+          input['type'] = 'hidden'
+          input['name'] = '_method'
+          input['value'] = emulated_method
+          js_form.add_child(input)
+        end
+        
+        js_form
+      end
+
+      def link_with_onclick_from_rails?
+        tag_name == 'a' and node['onclick'] =~ /var f = document\.createElement\('form'\); f\.style\.display = 'none';/
+      end
+
+      def emulated_method
+        node['onclick'][/m\.setAttribute\('value', '([^']*)'\)/, 1]
+      end
+    end
+  end
+end
+
+class Capybara::Driver::RackTest::Node
+  include Cucumber::Rails::CapybaraJavascriptEmulation
+end
+ 
+Before('@emulate_rails_javascript') do
+  Capybara::Driver::RackTest::Node.class_eval do
+    alias_method :click, :click_with_rails_javascript_emulation
+  end
+end
+ 
+After('@emulate_rails_javascript') do
+  Capybara::Driver::RackTest::Node.class_eval do
+    alias_method :click, :click_without_rails_javascript_emulation
+  end
+end