pickle 0.1.22 → 0.1.23

data/History.txt

@@ -1,7 +1,17 @@
+== 0.1.23 - 22 Nov 2009
+
+* 1 major improvement
+  * script/generate pickle now adds its own pickle.rb support file, making it easier to regenerate cucumber
+    when a new release of cucumber appears [schlick, ianwhite]
+
+* 1 minor improvement
+  * docs: more links
+  
+
 == 0.1.22 - 7 Nov 2009
 
 * 2 minor enhancements
-  * Improved docs to include instructions for FactoryGirl users, and linksresources for pickle users
+  * Improved docs to include instructions for FactoryGirl users, and links/resources for pickle users
   * Ruby 1.9.1 compatibility changes
 
 

data/README.rdoc

@@ -19,6 +19,8 @@ building complex givens which require a bunch of models collaborating
 
 <b>Railscast</b> presentation: http://railscasts.com/episodes/186-pickle-with-cucumber
 
+<b>Blog articles</b>: {dynamic50: Integration testing with cucumber and pickle}[http://blog.dynamic50.com/index.php/2009/04/integration-testing-with-cucumber-and-pickle/], {rubyflare: pickle my cucumber}[http://rubyflare.com/2009/10/28/pickle-my-cucumber/]
+
 == Install
 
 Install pickle either as a rails plugin, or a gem
@@ -27,7 +29,7 @@ Install pickle either as a rails plugin, or a gem
   sudo gem install pickle
 
   # gem dependency (in config/environments/cucumber.rb)
-  gem 'pickle'
+  config.gem 'pickle'
 
   # plugin
   script/plugin install git://github.com/ianwhite/pickle.git
@@ -101,7 +103,9 @@ If that doesn't solve loading issues then require your factories.rb file directl
 
 You can tell pickle to use another factory adapter (see Pickle::Adapter), or
 create mappings from english expressions to pickle model names.  You can also
-override many of the options on the Pickle::Config object if you so choose
+override many of the options on the Pickle::Config object if you so choose.
+
+In: <tt>features/support/pickle.rb</tt>
 
   require 'pickle/world'
 

data/VERSION

@@ -1 +1 @@
-0.1.22
+0.1.23

data/features/generator/generators.feature

@@ -3,52 +3,58 @@ Feature: allow pickle to generate steps
   As a dev
   I want to be able to generate steps
 
-  Scenario: cucumber is not yet installed
-    When I run "script/generate pickle"
-    Then I should see "try running script/generate cucumber"
-    
-  Scenario Outline: script/generate pickle on fresh cuc install
+  # Do we care anymore?
+  # Scenario: cucumber is not yet installed
+  #   When I run "script/generate pickle"
+  #   Then I should see "try running script/generate cucumber"
+
+  Scenario: script/generate pickle on fresh cuke install
     Given cucumber has been freshly generated
-    When I run "<GENERATE PICKLE>"
-    Then the file <STEPS FILE> should exist
-    And the file features/support/env.rb should match /<ENV.RB SHOULD MATCH>/
-    
-  Examples:
-    | GENERATE PICKLE             | STEPS FILE                                | ENV.RB SHOULD MATCH             |
-    | script/generate pickle      | features/step_definitions/pickle_steps.rb | require 'pickle\/world'         |
-    | script/generate pickle      | features/step_definitions/pickle_steps.rb | Example of configuring pickle:  |
-    | script/generate pickle email| features/step_definitions/email_steps.rb  | require 'pickle\/email\/world'  |
+    When I run "script/generate pickle"
+    Then the file features/support/pickle.rb should exist
+    And the file features/support/pickle.rb should match /require 'pickle\/world'/
+    And the file features/step_definitions/pickle_steps.rb should be identical to the local step_definitions/pickle_steps.rb
     
-  Scenario: script/generate pickle path on fresh cuc install
+  Scenario: script/generate pickle path on fresh cuke install
     Given cucumber has been freshly generated
     When I run "script/generate pickle path"
-    Then the file features/support/env.rb should match /require 'pickle\/world'/
-    And the file features/support/paths.rb should match /added by script/generate pickle path/
+    Then the file features/support/pickle.rb should exist
+    And the file features/support/pickle.rb should match /require 'pickle\/world'/
+    And the file features/support/pickle.rb should match /require 'pickle\/path\/world'/
+    And the file features/step_definitions/pickle_steps.rb should be identical to the local step_definitions/pickle_steps.rb
     And the file features/support/paths.rb should be identical to the local support/paths.rb
 
-  Scenario Outline: script/generate pickle, when env.rb has already requires pickle
+  Scenario: script/generate pickle email on fresh cuke install
     Given cucumber has been freshly generated
-    And env.rb already requires <ENV.RB CONTAINS>
-    When I run "<GENERATE PICKLE>"
-    Then the file features/support/env.rb should not match /<ENV.RB SHOULD NOT MATCH>/
-  
-  Examples:
-    | ENV.RB CONTAINS   | GENERATE PICKLE               | ENV.RB SHOULD NOT MATCH                                       |
-    | pickle/world      | script/generate pickle        | Example of configuring pickle:                                |
-    | pickle/world      | script/generate pickle        | require 'pickle\/world'.*require 'pickle\/world'              |
-    | pickle/path/world | script/generate pickle path   | require 'pickle\/path\/world'.*require 'pickle\/path\/world'  |
-    | pickle/email/world| script/generate pickle email  | require 'pickle\/email\/world'.*require 'pickle\/email\/world'|
-    
-  Scenario: script/generate pickle page email
+    When I run "script/generate pickle email"
+    Then the file features/support/pickle.rb should exist
+    And the file features/support/pickle.rb should match /require 'pickle\/world'/
+    And the file features/support/pickle.rb should match /require 'pickle\/email\/world'/
+    And the file features/step_definitions/pickle_steps.rb should be identical to the local step_definitions/pickle_steps.rb
+    And the file features/step_definitions/email_steps.rb should be identical to the local step_definitions/email_steps.rb
+
+  Scenario: script/generate pickle path email on fresh cuke install
     Given cucumber has been freshly generated
     When I run "script/generate pickle path email"
-    Then the file features/step_definitions/email_steps.rb should exist
-    And the file features/step_definitions/pickle_steps.rb should exist
-    And the file features/support/env.rb should match /require 'pickle\/world'/
-    And the file features/support/env.rb should match /require 'pickle\/path\/world'/
-    And the file features/support/env.rb should match /require 'pickle\/email\/world'/
-    And the file features/support/paths.rb should match /added by script/generate pickle path/
-
-
+    Then the file features/support/pickle.rb should exist
+    And the file features/support/pickle.rb should be identical to the local support/pickle.rb
+    And the file features/support/pickle.rb should match /require 'pickle\/world'/
+    And the file features/support/pickle.rb should match /require 'pickle\/path\/world'/
+    And the file features/support/pickle.rb should match /require 'pickle\/email\/world'/
+    And the file features/step_definitions/pickle_steps.rb should be identical to the local step_definitions/pickle_steps.rb
+    And the file features/support/paths.rb should be identical to the local support/paths.rb
+    And the file features/step_definitions/email_steps.rb should be identical to the local step_definitions/email_steps.rb
 
-  
+  Scenario: regenerating pickle
+    Given cucumber has been freshly generated
+    And pickle path email has been freshly generated
+    When I run "script/generate pickle path email"
+    Then the file features/support/pickle.rb should match /require 'pickle\/world'/
+    And the file features/support/pickle.rb should match /require 'pickle\/path\/world'/
+    And the file features/support/pickle.rb should match /require 'pickle\/email\/world'/
+    And the file features/step_definitions/pickle_steps.rb should be identical to the local step_definitions/pickle_steps.rb
+    And the file features/support/paths.rb should be identical to the local support/paths.rb
+    And the file features/step_definitions/email_steps.rb should be identical to the local step_definitions/email_steps.rb
+    But the file features/support/pickle.rb should not match /require 'pickle\/world'.*require 'pickle\/world'/
+    And the file features/support/pickle.rb should not match /require 'pickle\/path\/world'.*require 'pickle\/path\/world'/
+    And the file features/support/pickle.rb should not match /require 'pickle\/email\/world'.*require 'pickle\/email\/world'/

data/features/step_definitions/generator_steps.rb

@@ -11,6 +11,10 @@ Given(/^cucumber has been freshly generated$/) do
   `cd #{Rails.root}; script/generate cucumber -f`
 end
 
+Given(/^pickle path email has been freshly generated$/) do
+  `cd #{Rails.root}; script/generate pickle path email`
+end
+
 Given(/^env\.rb already requires (.+)$/) do |file|
   File.open("#{Rails.root}/features/support/env.rb", "a") do |env|
     env << "require '#{file}'\n"
@@ -37,6 +41,6 @@ Then(/^the file (.+?) should not match \/(.*?)\/$/) do |file, regexp|
   File.read("#{Rails.root}/#{file}").should_not match(/#{regexp}/m)
 end
 
-Then /^the file features\/support\/paths\.rb should be identical to the local support\/paths\.rb$/ do
-  File.read("#{Rails.root}/features/support/paths.rb").should == File.read("#{File.dirname(__FILE__)}/../support/paths.rb")
-end
+Then /^the file ([^ ]+) should be identical to the local (.+)$/ do |generated_file, source_file|
+  File.read("#{Rails.root}/#{generated_file}").should == File.read("#{File.dirname(__FILE__)}/../#{source_file}")
+end

data/features/support/env.rb

@@ -1,35 +1,47 @@
+# IMPORTANT: This file was generated by Cucumber 0.4.4
+# Edit at your own peril - it's recommended to regenerate this file
+# in the future when you upgrade to a newer version of Cucumber.
+# Consider adding your own code to a new file instead of editing this one.
+
 # Sets up the Rails environment for Cucumber
-ENV["RAILS_ENV"] = "test"
-require File.expand_path(File.dirname(__FILE__) + '../../../../../../config/environment')
+ENV["RAILS_ENV"] ||= "cucumber"
+require File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
 require 'cucumber/rails/world'
 
+# 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 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
+
+# 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
+
+require 'cucumber'
+# Comment out the next line if you don't want Cucumber Unicode support
 require 'cucumber/formatter/unicode'
+require 'cucumber/webrat/element_locator' # Lets you do table.diff!(element_at('#my_table_or_dl_or_ul_or_ol').to_table)
+require 'cucumber/rails/rspec'
 
 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
 
-
-# Comment out the next line if you're not using RSpec's matchers (should / should_not) in your steps.
-require 'cucumber/rails/rspec'
-require 'webrat/core/matchers'
-
-Cucumber::Rails::World.use_transactional_fixtures = true
-
-# Pickle
-require 'pickle/world'
-require 'pickle/path/world'
-require 'pickle/email/world'
-
-Pickle.configure do |c|
-  c.map 'I', :to => 'user: "me"'
-  c.map 'killah fork', :to => 'fancy fork: "of cornwood"'
-end
-
-# test app setup
-__APP__ = File.expand_path(File.join(File.dirname(__FILE__), '../app'))
-require "#{__APP__}/app"
-require "#{__APP__}/factories"
-require "#{__APP__}/blueprints"

data/features/support/pickle.rb

@@ -0,0 +1,26 @@
+# this file generated by script/generate pickle [paths] [email]
+#
+# Make sure that you are loading your factory of choice in your cucumber environment
+#
+# For machinist add: features/support/machinist.rb
+#
+#    require 'machinist/active_record' # or your chosen adaptor
+#    require File.dirname(__FILE__) + '/../../spec/blueprints' # or wherever your blueprints are
+#    Before { Sham.reset } # to reset Sham's seed between scenarios so each run has same random sequences
+#
+# For FactoryGirl add: features/support/factory_girl.rb
+#
+#    require 'factory_girl'
+#    require File.dirname(__FILE__) + '/../../spec/factories' # or wherever your factories are
+#
+# You may also need to add gem dependencies on your factory of choice in <tt>config/environments/cucumber.rb</tt>
+
+require 'pickle/world'
+# Example of configuring pickle:
+#
+# Pickle.configure do |config|
+#   config.adapters = [:machinist]
+#   config.map 'I', 'myself', 'me', 'my', :to => 'user: "me"'
+# end
+require 'pickle/path/world'
+require 'pickle/email/world'

data/features/support/pickle_app.rb

@@ -0,0 +1,10 @@
+# test app setup
+__APP__ = File.expand_path(File.join(File.dirname(__FILE__), '../app'))
+require "#{__APP__}/app"
+require "#{__APP__}/factories"
+require "#{__APP__}/blueprints"
+
+Pickle.configure do |c|
+  c.map 'I', :to => 'user: "me"'
+  c.map 'killah fork', :to => 'fancy fork: "of cornwood"'
+end

data/pickle.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pickle}
-  s.version = "0.1.22"
+  s.version = "0.1.23"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ian White"]
-  s.date = %q{2009-11-07}
+  s.date = %q{2009-11-22}
   s.description = %q{Easy model creation and reference in your cucumber features}
   s.email = %q{ian.w.white@gmail.com}
   s.extra_rdoc_files = [
@@ -43,6 +43,8 @@ Gem::Specification.new do |s|
      "features/step_definitions/pickle_steps.rb",
      "features/support/env.rb",
      "features/support/paths.rb",
+     "features/support/pickle.rb",
+     "features/support/pickle_app.rb",
      "garlic.rb",
      "init.rb",
      "lib/pickle.rb",
@@ -62,8 +64,8 @@ Gem::Specification.new do |s|
      "pickle.gemspec",
      "rails_generators/pickle/pickle_generator.rb",
      "rails_generators/pickle/templates/email_steps.rb",
-     "rails_generators/pickle/templates/env.rb",
      "rails_generators/pickle/templates/paths.rb",
+     "rails_generators/pickle/templates/pickle.rb",
      "rails_generators/pickle/templates/pickle_steps.rb",
      "spec/lib/pickle_adapter_spec.rb",
      "spec/lib/pickle_config_spec.rb",

data/rails_generators/pickle/pickle_generator.rb

@@ -1,7 +1,6 @@
 class PickleGenerator < Rails::Generator::Base
   def initialize(args, options)
     super(args, options)
-    File.exists?('features/support/env.rb') or raise "features/support/env.rb not found, try running script/generate cucumber"
     @generate_email_steps = args.include?('email')
     if @generate_path_steps = args.include?('path') || args.include?('paths')
       File.exists?('features/support/paths.rb') or raise "features/support/paths.rb not found, is your cucumber up to date?"
@@ -11,31 +10,30 @@ class PickleGenerator < Rails::Generator::Base
   def manifest
     record do |m|
       m.directory File.join('features/step_definitions')
+      m.directory File.join('features/support')
       
-      current_env = File.read('features/support/env.rb')
-      env_assigns = {:current_env => current_env, :pickle => false, :pickle_path => false, :pickle_email => false}
+      current_pickle = File.exists?('features/support/pickle.rb') ? File.read('features/support/pickle.rb') : ''
+      pickle_assigns = {:pickle_path => false, :pickle_email => false}
       
       if @generate_path_steps
-        env_assigns[:pickle_path] = true unless current_env.include?("require 'pickle/path/world'")
+        pickle_assigns[:pickle_path] = true
         current_paths = File.read('features/support/paths.rb')
         unless current_paths.include?('#{capture_model}')
           if current_paths =~ /^(.*)(\n\s+else\n\s+raise "Can't find.*".*$)/m
-            env_assigns[:current_paths_header] = $1
-            env_assigns[:current_paths_footer] = $2
-            m.template 'paths.rb', File.join('features/support', "paths.rb"), :assigns => env_assigns, :collision => :force
+            pickle_assigns[:current_paths_header] = $1
+            pickle_assigns[:current_paths_footer] = $2
+            m.template 'paths.rb', File.join('features/support', 'paths.rb'), :assigns => pickle_assigns, :collision => :force
           end
         end
       end
       
       if @generate_email_steps
-        env_assigns[:pickle_email] = true unless current_env.include?("require 'pickle/email/world'")
-        m.template 'email_steps.rb', File.join('features/step_definitions', "email_steps.rb") 
+        pickle_assigns[:pickle_email] = true
+        m.template 'email_steps.rb', File.join('features/step_definitions', 'email_steps.rb')
       end
-      
-      env_assigns[:pickle] = true unless current_env.include?("require 'pickle/world'")
-      m.template 'pickle_steps.rb', File.join('features/step_definitions', "pickle_steps.rb")
-      
-      m.template 'env.rb', File.join('features/support', "env.rb"), :assigns => env_assigns, :collision => :force
+
+      m.template 'pickle_steps.rb', File.join('features/step_definitions', 'pickle_steps.rb')      
+      m.template 'pickle.rb', File.join('features/support', 'pickle.rb'), :assigns => pickle_assigns
     end
   end
 end

data/rails_generators/pickle/templates/pickle.rb

@@ -0,0 +1,28 @@
+# this file generated by script/generate pickle [paths] [email]
+#
+# Make sure that you are loading your factory of choice in your cucumber environment
+#
+# For machinist add: features/support/machinist.rb
+#
+#    require 'machinist/active_record' # or your chosen adaptor
+#    require File.dirname(__FILE__) + '/../../spec/blueprints' # or wherever your blueprints are
+#    Before { Sham.reset } # to reset Sham's seed between scenarios so each run has same random sequences
+#
+# For FactoryGirl add: features/support/factory_girl.rb
+#
+#    require 'factory_girl'
+#    require File.dirname(__FILE__) + '/../../spec/factories' # or wherever your factories are
+#
+# You may also need to add gem dependencies on your factory of choice in <tt>config/environments/cucumber.rb</tt>
+
+require 'pickle/world'
+# Example of configuring pickle:
+#
+# Pickle.configure do |config|
+#   config.adapters = [:machinist]
+#   config.map 'I', 'myself', 'me', 'my', :to => 'user: "me"'
+# end
+<%- if pickle_path -%>require 'pickle/path/world'
+<%- end -%>
+<%- if pickle_email -%>require 'pickle/email/world'
+<%- end -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pickle
 version: !ruby/object:Gem::Version 
-  version: 0.1.22
+  version: 0.1.23
 platform: ruby
 authors: 
 - Ian White
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 +00:00
+date: 2009-11-22 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -49,6 +49,8 @@ files:
 - features/step_definitions/pickle_steps.rb
 - features/support/env.rb
 - features/support/paths.rb
+- features/support/pickle.rb
+- features/support/pickle_app.rb
 - garlic.rb
 - init.rb
 - lib/pickle.rb
@@ -68,8 +70,8 @@ files:
 - pickle.gemspec
 - rails_generators/pickle/pickle_generator.rb
 - rails_generators/pickle/templates/email_steps.rb
-- rails_generators/pickle/templates/env.rb
 - rails_generators/pickle/templates/paths.rb
+- rails_generators/pickle/templates/pickle.rb
 - rails_generators/pickle/templates/pickle_steps.rb
 - spec/lib/pickle_adapter_spec.rb
 - spec/lib/pickle_config_spec.rb

data/rails_generators/pickle/templates/env.rb

@@ -1,14 +0,0 @@
-<%= current_env -%>
-<%- if pickle -%>
-require 'pickle/world'
-# Example of configuring pickle:
-#
-# Pickle.configure do |config|
-#   config.adapters = [:machinist]
-#   config.map 'I', 'myself', 'me', 'my', :to => 'user: "me"'
-# end
-<%- end -%>
-<%- if pickle_path -%>require 'pickle/path/world'
-<%- end -%>
-<%- if pickle_email -%>require 'pickle/email/world'
-<%- end -%>