cucumber-rails 0.3.0 → 1.0.0

data/lib/generators/cucumber/feature/feature_generator.rb

@@ -1,11 +1,9 @@
 require File.join(File.dirname(__FILE__), 'named_arg')
-require File.join(File.dirname(__FILE__), 'feature_base')
 
 module Cucumber
-  class FeatureGenerator < Rails::Generators::NamedBase
+  class FeatureGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
 
-    include Cucumber::Generators::FeatureBase
-  
     argument :fields, :optional => true, :type => :array, :banner => "[field:type, field:type]"
 
     attr_reader :named_args
@@ -15,23 +13,16 @@ module Cucumber
     end    
 
     def generate
-      create_directory
-      create_feature_file
-      create_steps_file
-      create_support_file
+      empty_directory 'features/step_definitions'
+      template 'feature.erb', "features/manage_#{plural_name}.feature"
+      template 'steps.erb', "features/step_definitions/#{singular_name}_steps.rb"
+      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
   
     def self.banner
       "#{$0} cucumber:feature ModelName [field:type, field:type]"
     end
-  
-    def self.gem_root
-      File.expand_path("../../../../../", __FILE__)
-    end
-  
-    def self.source_root
-      File.join(gem_root, 'templates', 'feature')
-    end
-  
   end
 end

data/lib/generators/cucumber/feature/named_arg.rb

@@ -9,6 +9,8 @@ class NamedArg
   def value(n)
     if @type == 'boolean'
       (n % 2) == 0
+    elsif @type == 'integer'
+      n
     else
       "#{@name} #{n}"
     end

data/{templates/feature → lib/generators/cucumber/feature/templates}/feature.erb

@@ -25,28 +25,26 @@ Feature: Manage <%= plural_name %>
   # 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.
+  # Capybara must use Culerity/Celerity or Selenium2 (webdriver) when pages rely
+  # on Javascript events. Only Culerity/Celerity supports clicking on confirmation
+  # dialogs.
   #
-  # Since Culerity and Selenium2 has some overhead, Cucumber-Rails will detect 
-  # the presence of Javascript behind Delete links and issue a DELETE request 
+  # Since Culerity/Celerity and Selenium2 has some overhead, Cucumber-Rails will
+  # detect the presence of Javascript behind Delete links and issue a DELETE request 
   # instead of a GET request.
   #
-  # You can turn off this emulation by tagging your scenario with @selenium, 
-  # @culerity, @celerity or @javascript. (See the Capybara documentation for 
-  # details about those tags). If any of these tags are present, Cucumber-Rails
+  # You can turn this emulation off by tagging your scenario with @no-js-emulation.
+  # Turning on browser testing with @selenium, @culerity, @celerity or @javascript
+  # will also turn off the emulation. (See the Capybara documentation for 
+  # details about those tags). If any of the browser tags are present, Cucumber-Rails
   # will also turn off transactions and clean the database with DatabaseCleaner 
   # after the scenario has finished. This is to prevent data from leaking into 
   # the next scenario.
   #
-  # Another way to avoid Cucumber-Rails'' javascript emulation without using any
+  # Another way to avoid Cucumber-Rails' javascript emulation without using any
   # of the tags above is to modify your views to use <button> instead. You can
   # see how in http://github.com/jnicklas/capybara/issues#issue/12
   #
-  # TODO: Verify with Rob what this means: The rack driver will detect the 
-  # onclick javascript and emulate its behaviour without a real Javascript
-  # interpreter.
-  #
 <% if options[:capybara] -%>
   @<%= options[:capybara] %>  
 <% end -%>

data/{templates/feature → lib/generators/cucumber/feature/templates}/steps.erb

@@ -3,7 +3,7 @@ Given /^the following <%= plural_name %>:$/ do |<%= plural_name %>|
 end
 
 When /^I delete the (\d+)(?:st|nd|rd|th) <%= singular_name %>$/ do |pos|
-  visit <%= plural_name %>_url
+  visit <%= plural_name %>_path
   within("table tr:nth-child(#{pos.to_i+1})") do
     click_link "Destroy"
   end

data/lib/generators/cucumber/install/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Sets up Cucumber in your Rails project. After running this generator you will
+    get a new rake task called features.
+    
+    This also generates the necessary files in the features directory.
+    
+    Also see the cucumber:feature generator.
+    
+Examples:
+    `rails generate cucumber:install`
+
+    `rails generate cucumber:install --help`
+
+    You can also provide a language argument for localized web_steps:
+    `rails generate cucumber:install de`

data/lib/generators/cucumber/install/install_generator.rb

@@ -0,0 +1,88 @@
+require 'rbconfig'
+
+module Cucumber
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+
+    argument     :language,      :type => :string,  :banner => "LANG", :optional => true
+
+    class_option :rspec,         :type => :boolean, :desc => "Use RSpec"
+    class_option :testunit,      :type => :boolean, :desc => "Use Test::Unit"
+    class_option :spork,         :type => :boolean, :desc => "Use Spork"
+    class_option :skip_database, :type => :boolean, :desc => "Skip modification of database.yml", :aliases => '-D', :default => false
+
+    attr_reader :framework
+
+    def create_templates
+      template 'config/cucumber.yml.erb', 'config/cucumber.yml'
+    end
+
+    def create_scripts
+      copy_file 'script/cucumber', 'script/cucumber'
+      chmod     'script/cucumber', 0755
+    end
+
+    def create_step_definitions
+      empty_directory 'features/step_definitions'
+
+      template "step_definitions/web_steps.rb.erb", 'features/step_definitions/web_steps.rb'
+      if language
+        template "step_definitions/web_steps_#{language}.rb.erb", "features/step_definitions/web_steps_#{language}.rb"
+      end
+    end
+
+    def create_feature_support
+      empty_directory 'features/support'
+      copy_file       'support/paths.rb',     'features/support/paths.rb'
+      copy_file       'support/selectors.rb', 'features/support/selectors.rb'
+
+      if spork?
+        template 'support/rails_spork.rb.erb', 'features/support/env.rb'
+      else
+        template 'support/rails.rb.erb',       'features/support/env.rb'
+      end
+    end
+
+    def create_tasks
+      empty_directory 'lib/tasks'
+      template 'tasks/cucumber.rake.erb', 'lib/tasks/cucumber.rake'
+    end
+
+    def create_database
+      return unless File.exist?('config/database.yml')
+      unless File.read('config/database.yml').include? 'cucumber:'
+        gsub_file 'config/database.yml', /^test:.*\n/, "test: &test\n"
+        gsub_file 'config/database.yml', /\z/, "\ncucumber:\n  <<: *test"
+        
+        # Since gsub_file doesn't ask the user, just inform user that the file was overwritten.
+        puts "       force  config/database.yml"
+      end
+    end
+
+    protected
+
+    def spork?
+      options[:spork]
+    end
+
+    def embed_file(source, indent='')
+      IO.read(File.join(self.class.source_root, source)).gsub(/^/, indent)
+    end
+
+    def embed_template(source, indent='')
+      template = File.join(self.class.source_root, source)
+      ERB.new(IO.read(template), nil, '-').result(binding).gsub(/^/, indent)
+    end
+
+    private
+
+    def framework_from_options
+      return 'rspec-rails' if options[:rspec]
+      return 'testunit' if options[:testunit]
+      return 'rspec-rails'
+    end
+
+  end
+end

data/lib/generators/cucumber/install/templates/config/cucumber.yml.erb

@@ -0,0 +1,8 @@
+<%%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= spork? ? '--drb ' : '' %><%%= std_opts %> features
+wip: <%= spork? ? '--drb ' : '' %>--tags @wip:3 --wip features
+rerun: <%= spork? ? '--drb ' : '' %><%%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/lib/generators/cucumber/install/templates/step_definitions/web_steps.rb.erb

@@ -0,0 +1,192 @@
+<%= embed_file('support/web_steps_warning.txt') %>
+
+require 'uri'
+require 'cgi'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
+
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(*selector_for(locator)) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+# Single-line step scoper
+When /^(.*) within (.*[^:])$/ do |step, parent|
+  with_scope(parent) { When step }
+end
+
+# Multi-line step scoper
+When /^(.*) within (.*[^:]):$/ do |step, parent, table_or_string|
+  with_scope(parent) { When "#{step}:", table_or_string }
+end
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^(?:|I )follow "([^"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^(?:|I )fill in "([^"]*)" with "([^"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^(?:|I )fill in "([^"]*)" for "([^"]*)"$/ do |value, field|
+  fill_in(field, :with => value)
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    When %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^"]*)" from "([^"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+When /^(?:|I )check "([^"]*)"$/ do |field|
+  check(field)
+end
+
+When /^(?:|I )uncheck "([^"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^(?:|I )choose "([^"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
+  attach_file(field, File.expand_path(path))
+end
+
+Then /^(?:|I )should see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_content(text)
+  else
+    assert page.has_content?(text)
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_xpath('//*', :text => regexp)
+  else
+    assert page.has_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^(?:|I )should not see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_no_content(text)
+  else
+    assert page.has_no_content?(text)
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_no_xpath('//*', :text => regexp)
+  else
+    assert page.has_no_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should
+      field_value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should not contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should_not
+      field_value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_true
+    else
+      assert field_checked
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_false
+    else
+      assert !field_checked
+    end
+  end
+end
+ 
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = URI.parse(current_url).path
+  if current_path.respond_to? :should
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+  query = URI.parse(current_url).query
+  actual_params = query ? CGI.parse(query) : {}
+  expected_params = {}
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')} 
+  
+  if actual_params.respond_to? :should
+    actual_params.should == expected_params
+  else
+    assert_equal expected_params, actual_params
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end

data/lib/generators/cucumber/install/templates/step_definitions/web_steps_cs.rb.erb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+<%= embed_file('support/web_steps_warning.txt') %>
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
+
+# Single-line step scoper
+When /^(.*) uvnitř ([^:]+)$/ do |step, parent|
+  with_scope(parent) { When step }
+end
+
+# Multi-line step scoper
+When /^(.*) uvnitř ([^:]+):$/ do |step, parent, table_or_string|
+  with_scope(parent) { When "#{step}:", table_or_string }
+end
+
+Given /^jsem na (.+)$/ do |page_name|
+  Given %{I am on #{page_name}}
+end
+
+When /^jdu na (.+)$/ do |page_name|
+  When %{I go to #{page_name}}
+end
+
+When /^stisknu tlačítko "([^"]*)"$/ do |button|
+  When %{I press "#{button}"}
+end
+
+When /^kliknu na "([^"]*)"$/ do |link|
+  When %{I follow "#{link}"}
+end
+
+When /^vyplním pole "([^"]*)" hodnotou "([^"]*)"$/ do |field, value|
+  When %{I fill in "#{field}" with "#{value}"}
+end
+
+When /^vyplním "([^"]*)" do pole "([^"]*)"$/ do |value, field|
+  When %{I fill in "#{value}" for "#{field}"}
+end
+
+When /^vyplním následující:$/ do |fields|
+  When %{I fill in the following:}, fields
+end
+
+When /^vyberu "([^"]*)" z "([^"]*)"$/ do |value, field|
+  When %{I select "#{value}" from "#{field}"}
+end
+
+When /^vyberu "([^"]*)" jako datum a čas$/ do |time|
+  When %{I select "#{time}" as the date and time}
+end
+
+When /^vyberu "([^"]*)" jako "([^"]*)" datum a čas$/ do |datetime, datetime_label|
+  When %{I select "#{datetime}" as the "#{datetime_label}" date and time}
+end
+
+When /^vyberu "([^"]*)" jako čas$/ do |time|
+  When %{I select "#{time}" as the time}
+end
+
+When /^vyberu "([^"]*)" jako "([^"]*)" čas$/ do |time, time_label|
+  When %{I select "#{time}" as the "#{time_label}" time}
+end
+
+When /^vyberu cd  jako datum$/ do |date|
+  When %{I select "#{date}" as the date}
+end
+
+When /^vyberu "([^"]*)" jako "([^"]*)" datum$/ do |date, date_label|
+  When %{I select "#{date}" as the "#{date_label}" date}
+end
+
+When /^zaškrtnu "([^"]*)"$/ do |field|
+  When %{I check "#{field}"}
+end
+
+When /^vyškrtnu "([^"]*)"$/ do |field|
+  When %{I uncheck "#{field}"}
+end
+
+When /^vyberu "([^"]*)"$/ do |field|
+  When %{I choose "#{field}"}
+end
+
+When /^připojím soubor "([^"]*)" do pole "([^"]*)"$/ do |path, field|
+  When %{I attach the file "#{path}" to "#{field}"}
+end
+
+Then /^(?:|také )bych měl vidět "([^"]*)"$/ do |text|
+  Then %{I should see "#{text}"}
+end
+
+Then /^(?:|také )bych měl vidět \/([^\/]*)\/$/ do |regexp|
+  Then %{I should see /#{regexp}/}
+end
+
+Then /^(?:|také )bych neměl vidět "([^"]*)"$/ do |text|
+  Then %{I should not see "#{text}"}
+end
+
+Then /^(?:|také )bych neměl vidět \/([^\/]*)\/$/ do |regexp|
+  Then %{I should not see /#{regexp}/}
+end
+
+Then /^pole "([^"]*)" by mělo obsahovat "([^"]*)"$/ do |field, value|
+  Then %{the "#{field}" field should contain "#{value}"}
+end
+
+Then /^pole "([^"]*)" by nemělo obsahovat "([^"]*)"$/ do |field, value|
+  Then %{the "#{field}" field should not contain "#{value}"}
+end
+
+Then /^pole "([^"]*)" by mělo být zaškrtnuté$/ do |label|
+  Then %{the "#{label}" checkbox should be checked}
+end
+
+Then /^pole "([^"]*)" by nemělo být zaškrtnuté$/ do |label|
+  Then %{the "#{label}" checkbox should not be checked}
+end
+
+Then /^(?:|také )bych měl být na (.+)$/ do |page_name|
+  Then %{I should be on #{page_name}}
+end
+
+Then /^(?:|také )mi ukaž stránku$/ do
+  Then %{show me the page}
+end

data/lib/generators/cucumber/install/templates/step_definitions/web_steps_da.rb.erb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+<%= embed_file('support/web_steps_warning.txt') %>
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
+
+# Single-line step scoper
+Når /^(.*) under ([^:]+)$/ do |step, parent|
+  with_scope(parent) { Når step }
+end
+
+# Multi-line step scoper
+Når /^(.*) under ([^:]+):$/ do |step, parent, table_or_string|
+  with_scope(parent) { Når "#{step}:", table_or_string }
+end
+
+Givet /^(?:|at )jeg står på (.*)$/ do |page_name|
+  Given %{I am on #{page_name}}
+end
+
+Når /^jeg går til (.*)$/ do |page_name|
+  When %{I go to #{page_name}}
+end
+
+Når /^jeg trykker "([^"]*)"$/ do |button|
+  When %{I press "#{button}"}
+end
+
+Når /^jeg klikker "([^"]*)"$/ do |link|
+  When %{I follow "#{link}"}
+end
+
+Når /^jeg fylder ud "([^"]*)" med "([^"]*)"$/ do |field, value|
+  When %{I fill in "#{field}" with "#{value}"}
+end
+
+Når /^jeg fylder ud "([^"]*)" for "([^"]*)"$/ do |value, field|
+  When %{I fill in "#{value}" for "#{field}"}
+end
+
+Når /^jeg fylder følgende ud:$/ do |fields|
+  When %{I fill in the following:}, fields
+end
+
+Når /^jeg vælger "([^"]*)" fra "([^"]*)"$/ do |value, field|
+  When %{I select "#{value}" from "#{field}"}
+end
+
+# Missing: date stuff
+
+Når /^jeg afkrydser "([^"]*)"$/ do |field|
+  When %{I check "#{field}"}
+end
+
+Når /^jeg fjerner afkrydsning for "([^"]*)"$/ do |field|
+  When %{I uncheck "#{field}"}
+end
+
+Når /^jeg vælger "([^"]*)"$/ do |field|
+  When %{I choose "#{field}"}
+end
+
+Når /^jeg tilsætter filen "([^"]*)" til "([^"]*)"$/ do |path, field|
+  When %{I attach the file "#{path}" to "#{field}"}
+end
+
+Så /^(?:skal jeg|jeg skal) se "([^"]*)"$/ do |text|
+  Then %{I should see "#{text}"}
+end
+
+Så /^(?:skal jeg|jeg skal) se \/([^\/]*)\/$/ do |regexp|
+  Then %{I should see /#{regexp}/}
+end
+
+Så /^(?:skal jeg|jeg skal) ikke se "([^"]*)"$/ do |text|
+  Then %{I should not see "#{text}"}
+end
+
+Så /^(?:skal jeg|jeg skal) ikke se \/([^\/]*)\/$/ do |regexp|
+  Then %{I should not see /#{regexp}/}
+end
+
+Så /^(?:skal )"([^"]*)" feltet (?:skal )indeholde "([^"]*)"$/ do |field, value|
+  Then %{the "#{field}" field should contain "#{value}"}
+end
+
+Så /^(?:skal ) "([^"]*)" feltet (?:skal )ikke indeholde "([^"]*)"$/ do |field, value|
+  Then %{the "#{field}" field should not contain "#{value}"}
+end
+
+Så /^(?:skal ) "([^"]*)" afkrydsningsboksen (?:skal )være krydset af$/ do |label|
+  Then %{the "#{label}" checkbox should be checked}
+end
+
+Så /^(?:skal ) "([^"]*)" afkrydsningsboksen (?:skal )ikke være krydset af$/ do |label|
+  Then %{the "#{label}" checkbox should not be checked}
+end
+
+Så /^(?:skal jeg|jeg skal) komme til (.+)$/ do |page_name|
+  Then %{I should be on #{page_name}}
+end
+
+Så /^vil jeg se siden$/ do |page_name|
+  Then %{show me the page}
+end