cucumber_rails3_gen 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+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.

data/README

@@ -0,0 +1,19 @@
+Description:
+    Sets up Cucumber in your Rails 3 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 feature generator, which you can use to generate skeletons
+    for new features.
+    
+Examples: Generator
+    ./script/generate cucumber:skeleton
+
+You can also provide a language argument for localized webrat steps:
+    ./script/generate cucumber de
+    
+Examples: Executable
+    $ cucumber_skeleton    
+
+    $ cucumber_skeleton de

data/README.rdoc

@@ -0,0 +1,19 @@
+= Description:
+    Sets up Cucumber in your Rails 3 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 feature generator, which you can use to generate skeletons
+    for new features.
+    
+== Examples: Generator
+    ./script/generate cucumber:skeleton
+
+You can also provide a language argument for localized webrat steps:
+    ./script/generate cucumber de
+    
+== Examples: Executable
+    $ cucumber_skeleton    
+
+    $ cucumber_skeleton de

data/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Sets up Cucumber in your Rails 3 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 feature generator, which you can use to generate skeletons
+    for new features.
+    
+Examples: Generator
+    ./script/generate cucumber:skeleton
+
+You can also provide a language argument for localized webrat steps:
+    ./script/generate cucumber de
+    
+Examples: Executable
+    $ cucumber_skeleton    
+
+    $ cucumber_skeleton de

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/cucumber_skeleton

@@ -0,0 +1,19 @@
+#!/user/local/bin/ruby
+
+begin
+  require 'rails/ruby_version_check'
+rescue LoadError
+  # If people are not using gems, the load path must still
+  # be correct.
+  # TODO: Remove the begin / rescue block somehow
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  $:.unshift File.expand_path('../../../activesupport/lib', __FILE__)
+  $:.unshift File.expand_path('../../../actionpack/lib', __FILE__)
+end
+
+Signal.trap("INT") { puts; exit }
+
+require 'rails/generators'
+require 'generators/cucumber/skeleton/skeleton_generator'
+
+Cucumber::SkeletonGenerator.start

data/lib/generators/cucumber/skeleton/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Sets up Cucumber in your Rails 3 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 feature generator, which you can use to generate skeletons
+    for new features.
+    
+Examples: Generator
+    ./script/generate cucumber:skeleton
+
+You can also provide a language argument for localized webrat steps:
+    ./script/generate cucumber de
+    
+Examples: Executable
+    $ cucumber_skeleton    
+
+    $ cucumber_skeleton de   

data/lib/generators/cucumber/skeleton/skeleton_generator.rb

@@ -0,0 +1,178 @@
+# This generator bootstraps a Rails project for use with Cucumber
+module Cucumber
+  class SkeletonGenerator < Rails::Generators::Base
+
+    argument :language, :type => :string, :required => false, :default => 'en'
+
+    class_option :shebang, :type => :boolean, :aliases => "--shebang", :group => :cucumber,
+                           :desc => "Adds shebang marker to script files"
+
+    class_option :webrat, :type => :boolean, :aliases => "--webrat", :group => :cucumber,
+                          :desc => "Use webrat"
+
+    class_option :capybara, :type => :boolean, :aliases => "--capybara", :group => :cucumber,
+                           :desc => "Use capybara"
+
+    class_option :rspec, :type => :boolean, :aliases => "--rspec", :group => :cucumber,
+                          :desc => "Use rspec"
+
+    class_option :testunit, :type => :boolean, :aliases => "--testunit", :group => :cucumber,
+                          :desc => "Use testunit"
+
+    class_option :spork, :type => :boolean, :aliases => "--spork", :group => :cucumber,
+                          :desc => "Use spork"
+
+    DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                                Config::CONFIG['ruby_install_name'])
+
+
+    def self.source_root 
+      @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))  
+    end 
+  
+  
+    def initialize(*args, &block)
+      super
+      # @language = args.empty? ? 'en' : args.first
+    end
+  
+    def my_options
+      @my_options ||= {}      
+    end      
+  
+    def spork?
+      options[:spork]
+    end
+  
+    def framework
+      my_options[:framework] ||= detect_current_framework || detect_default_framework
+    end
+
+    def driver
+      my_options[:driver] ||= detect_current_driver || detect_default_driver
+    end
+    
+    # def embed_template(source, indent='')
+    #   template = File.join(File.dirname(__FILE__), 'templates', source)
+    #   ERB.new(IO.read(template), nil, '-').result(binding).gsub(/^/, indent)
+    # end
+  
+    def version
+      filename = File.dirname(__FILE__) + '/../../../../VERSION'
+      path = File.expand_path(filename)
+      IO.read(filename).chomp
+    end  
+    
+    def create_files      
+      if File.exist?('features/step_definitions/webrat_steps.rb')
+        STDERR.puts "Please remove features/step_definitions/webrat_steps.rb\n" + 
+        "See upgrading instructions for 0.2.0 in History.txt"
+        exit(1)
+      end
+      if File.exist?('features/support/version_check.rb')
+        STDERR.puts "Please remove features/support/version_check.rb\n" + 
+        "See upgrading instructions for 0.2.0 in History.txt"
+        exit(1)
+      end
+
+      template 'config/cucumber.yml.erb', 'config/cucumber.yml'
+      template 'environments/cucumber.rb.erb', 'config/environments/cucumber.rb'
+      
+      copy_file 'script/cucumber', 'script/cucumber'      
+      chmod 'script/cucumber', 0755, :verbose => false, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang]
+
+      empty_directory 'features/step_definitions'      
+      template "step_definitions/#{driver}_steps.rb.erb", 'features/step_definitions/web_steps.rb'
+      if language != 'en'
+        template "step_definitions/web_steps_#{language}.rb.erb", "features/step_definitions/web_steps_#{language}.rb"
+      end
+
+      empty_directory 'features/support'
+      if spork?
+        template 'support/rails_spork.rb.erb', 'features/support/env.rb'
+      else
+        template 'support/rails.rb.erb',       'features/support/env.rb'
+      end
+      copy_file       'support/paths.rb',           'features/support/paths.rb'
+
+      empty_directory 'lib/tasks'
+      template  'tasks/cucumber.rake.erb',     'lib/tasks/cucumber.rake'
+      
+      gsub_file 'config/database.yml', /test:.*\n/, "test: &TEST\n"
+      unless File.read('config/database.yml').include? 'cucumber:'
+        gsub_file 'config/database.yml', /\z/, "\ncucumber:\n  <<: *TEST"
+      end
+         
+    end
+
+    def banner
+      "Usage: #{$0} cucumber (language)"
+    end
+
+  private
+    def empty_directory_with_gitkeep(destination, config = {})
+      empty_directory(destination, config)
+      create_file("#{destination}/.gitkeep") unless options[:skip_git]
+    end    
+  
+    def first_loadable(libraries)
+      require 'rubygems'
+      libraries.each do |library|
+        begin
+          require library[0]
+          return library[1]
+        rescue LoadError => ignore
+        end
+      end
+      return nil
+    end
+  
+    def detect_current_driver
+      detect_in_env([['capybara', :capybara], ['webrat', :webrat ]])
+    end
+  
+    def detect_default_driver
+      @default_driver = first_loadable([['capybara', :capybara], ['webrat', :webrat ]])
+      raise "I don't know which driver you want. Use --capybara or --webrat, or gem install capybara or webrat." unless @default_driver
+      @default_driver
+    end
+  
+    def detect_current_framework
+      detect_in_env([['spec', :rspec], ['test/unit', :testunit]])
+    end
+  
+    def detect_default_framework
+      @default_framework = first_loadable([['spec', :rspec], ['test/unit', :testunit]])
+      raise "I don't know what test framework you want. Use --rspec or --testunit, or gem install rspec or test-unit." unless @default_framework
+      @default_framework
+    end
+  
+    def detect_in_env(choices)
+      env = File.file?("features/support/env.rb") ? IO.read("features/support/env.rb") : ''
+      choices.each do |choice|
+        detected = choice[1] if env =~ /#{choice[0]}/n
+        return detected if detected
+      end
+      return nil
+    end
+  end
+end
+
+module Cucumber
+  module Helper
+    class << self
+      attr_accessor :framework
+    end
+    
+    def self.embed_file(source, indent='')
+      IO.read(File.join(File.dirname(__FILE__), 'templates', source)).gsub(/^/, indent)
+    end
+  
+    def self.embed_template(source, indent='')
+      template = File.join(File.dirname(__FILE__), 'templates', source)
+      ERB.new(IO.read(template), nil, '-').result(binding).gsub(/^/, indent)
+    end
+  end
+end    
+    
+

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

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

data/lib/generators/cucumber/skeleton/templates/environments/cucumber.rb.erb

@@ -0,0 +1,37 @@
+# Edit at your own peril - it's recommended to regenerate this file
+# in the future when you upgrade to a newer version of Cucumber.
+
+# IMPORTANT: Setting config.cache_classes to false is known to
+# break Cucumber's use_transactional_fixtures method.
+# For more information see https://rspec.lighthouseapp.com/projects/16211/tickets/165
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+config.gem 'cucumber-rails',   :lib => false, :version => '>=<%= version %>' unless File.directory?(File.join(Rails.root, 'vendor/plugins/cucumber-rails'))
+config.gem 'database_cleaner', :lib => false, :version => '>=0.4.3' unless File.directory?(File.join(Rails.root, 'vendor/plugins/database_cleaner'))
+<% if driver == :capybara -%>
+config.gem 'capybara',         :lib => false, :version => '>=0.3.0' unless File.directory?(File.join(Rails.root, 'vendor/plugins/capybara'))
+<% else -%>
+config.gem 'webrat',           :lib => false, :version => '>=0.6.0' unless File.directory?(File.join(Rails.root, 'vendor/plugins/webrat'))
+<% end -%>
+<% if framework == :rspec -%>
+config.gem 'rspec',            :lib => false, :version => '>=1.3.0' unless File.directory?(File.join(Rails.root, 'vendor/plugins/rspec'))
+config.gem 'rspec-rails',      :lib => false, :version => '>=1.3.2' unless File.directory?(File.join(Rails.root, 'vendor/plugins/rspec-rails'))
+<% end %>
+<% if spork? -%>
+config.gem 'spork',            :lib => false, :version => '>=0.7.5' unless File.directory?(File.join(Rails.root, 'vendor/plugins/spork'))
+<% end %>

data/lib/generators/cucumber/skeleton/templates/script/cucumber

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+vendored_cucumber_bin = Dir["#{File.dirname(__FILE__)}/../vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+if vendored_cucumber_bin
+  load File.expand_path(vendored_cucumber_bin)
+else
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'cucumber'
+  load Cucumber::BINARY
+end

data/lib/generators/cucumber/skeleton/templates/step_definitions/capybara_steps.rb.erb

@@ -0,0 +1,187 @@
+<%= Cucumber::Helper.embed_file('support/edit_warning.txt') %>
+
+require 'uri'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(locator) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+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 "([^\"]*)"(?: within "([^\"]*)")?$/ do |button, selector|
+  with_scope(selector) do
+    click_button(button)
+  end
+end
+
+When /^(?:|I )follow "([^\"]*)"(?: within "([^\"]*)")?$/ do |link, selector|
+  with_scope(selector) do
+    click_link(link)
+  end
+end
+
+When /^(?:|I )fill in "([^\"]*)" with "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, value, selector|
+  with_scope(selector) do
+    fill_in(field, :with => value)
+  end
+end
+
+When /^(?:|I )fill in "([^\"]*)" for "([^\"]*)"(?: within "([^\"]*)")?$/ do |value, field, selector|
+  with_scope(selector) do
+    fill_in(field, :with => value)
+  end
+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(?: within "([^\"]*)")?:$/ do |selector, fields|
+  with_scope(selector) do
+    fields.rows_hash.each do |name, value|
+      When %{I fill in "#{name}" with "#{value}"}
+    end
+  end
+end
+
+When /^(?:|I )select "([^\"]*)" from "([^\"]*)"(?: within "([^\"]*)")?$/ do |value, field, selector|
+  with_scope(selector) do
+    select(value, :from => field)
+  end
+end
+
+When /^(?:|I )check "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, selector|
+  with_scope(selector) do
+    check(field)
+  end
+end
+
+When /^(?:|I )uncheck "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, selector|
+  with_scope(selector) do
+    uncheck(field)
+  end
+end
+
+When /^(?:|I )choose "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, selector|
+  with_scope(selector) do
+    choose(field)
+  end
+end
+
+When /^(?:|I )attach the file "([^\"]*)" to "([^\"]*)"(?: within "([^\"]*)")?$/ do |path, field, selector|
+  with_scope(selector) do
+    attach_file(field, path)
+  end
+end
+
+Then /^(?:|I )should see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, selector|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      page.should have_content(text)
+    else
+      assert page.has_content?(text)
+    end
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/(?: within "([^\"]*)")?$/ do |regexp, selector|
+  regexp = Regexp.new(regexp)
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      page.should have_xpath('//*', :text => regexp)
+    else
+      assert page.has_xpath?('//*', :text => regexp)
+    end
+  end
+end
+
+Then /^(?:|I )should not see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, selector|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      page.should have_no_content(text)
+    else
+      assert page.has_no_content?(text)
+    end
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/(?: within "([^\"]*)")?$/ do |regexp, selector|
+  regexp = Regexp.new(regexp)
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      page.should have_no_xpath('//*', :text => regexp)
+    else
+      assert page.has_no_xpath?('//*', :text => regexp)
+    end
+  end
+end
+
+Then /^the "([^\"]*)" field(?: within "([^\"]*)")? should contain "([^\"]*)"$/ do |field, selector, value|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      find_field(field).value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field_labeled(field).value)
+    end
+  end
+end
+
+Then /^the "([^\"]*)" field(?: within "([^\"]*)")? should not contain "([^\"]*)"$/ do |field, selector, value|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      find_field(field).value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, find_field(field).value)
+    end
+  end
+end
+
+Then /^the "([^\"]*)" checkbox(?: within "([^\"]*)")? should be checked$/ do |label, selector|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      find_field(label)['checked'].should == 'checked'
+    else
+      assert field_labeled(label)['checked'] == 'checked'
+    end
+  end
+end
+
+Then /^the "([^\"]*)" checkbox(?: within "([^\"]*)")? should not be checked$/ do |label, selector|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      find_field(label)['checked'].should_not == 'checked'
+    else
+      assert field_labeled(label)['checked'] != 'checked'
+    end
+  end
+end
+
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = URI.parse(current_url).select(:path, :query).compact.join('?')
+  if defined?(Spec::Rails::Matchers)
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end