pickle 0.2.1 → 0.2.2

data/History.txt

@@ -1,3 +1,11 @@
+== 0.2.2 - 25 Feb 2010
+
+* 3 improvements
+  * Added ability to follow links in emails (see email_steps.rb) [Michael Moen]
+  * Added a step definition for doing stuff like: Then the user's name should be "Tobi" [Tobi Knaup]
+  * Docfixes, mostly about testing [Nicholas Rutherford]
+  
+  
 == 0.2.1 - 1 Dec 2009
 
 * 2 minor improvements

data/README.rdoc

@@ -13,7 +13,7 @@ building complex givens which require a bunch of models collaborating
 
 <b>Gemcutter</b> for the gem: http://gemcutter.org/gems/pickle
 
-<b>API</b> docs: http://ianwhite.github.com/pickle/doc
+<b>API</b> docs: {Pickle rdoc on github}[http://ianwhite.github.com/pickle/doc/]
 
 <b>Google group</b> for questions: http://groups.google.com/group/pickle-cucumber
 
@@ -43,13 +43,29 @@ Install pickle either as a rails plugin, or a gem
 
 It's tested against all stable branches of 2.x rails, and edge, with the latest versions of rspec, cucumber, factory_girl, machinist.
 
+== Run the tests
+
+You can run the test with <b>garlic</b> http://github.com/ianwhite/garlic, which tests against different versions of rails.
+  
+Or, you can make a test rails app:
+
+  cd ~/wherever_you_work
+  rails pickle_test_project; cd pickle_test_project
+  script/generate rspec
+  script/generate cucumber --rspec
+  script/plugin install git://github.com/ianwhite/pickle.git
+  cd vendor/plugins/pickle
+  rake spec
+  cucumber features
+
 == Contributors
 
 The following people have made Pickle better:
 
 * {Nick Rutherford}[http://github.com/nruth]
-* Tobi Knaup
+* {Tobi Knaup}[http://github.com/guenter]
 * {Michael MacDonald}[http://github.com/schlick]
+* {Michael Moen}[http://github.com/UnderpantsGnome]
 
 == Get Started
 

data/Rakefile

@@ -23,7 +23,7 @@ Spec::Rake::SpecTask.new(:rcov) do |t|
   t.spec_files  = FileList['spec/**/*_spec.rb']
   t.rcov        = true
   t.rcov_dir    = 'doc/coverage'
-  t.rcov_opts   = ['--text-report', '--exclude', "spec/,rcov.rb,#{File.expand_path(File.join(File.dirname(__FILE__),'../../..'))}"] 
+  t.rcov_opts   = ['--text-report', '--exclude', "gems/,features/,/Library,spec/,rcov.rb,#{File.expand_path(File.join(File.dirname(__FILE__),'../../..'))}"] 
 end
 
 namespace :rcov do

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/features/email/email.feature

@@ -36,4 +36,25 @@ Feature: I can test emails are sent
     And the user's email is delivered
     Then 1 email should be delivered to the user
     And the email should contain "Dear Fred"
-    And the email should link to the user's page
+    And the email should link to the user's page
+
+  Scenario: Following the first link in an email
+  	Given a user exists with name: "Fred", email: "fred@gmail.com"
+  	And an email "cool" with body: "some text <a href='http://example.com/users/1'>example page</a> more text" is delivered to fred@gmail.com
+    Then 1 email should be delivered to the user
+		And I click the first link in the email
+		Then I should be at the user's page
+
+  Scenario: Following a link in an email by url
+  	Given a user exists with name: "Fred", email: "fred@gmail.com"
+  	And an email "cool" with body: "some text <a href='http://example.com/users/1'>example page</a> more text" is delivered to fred@gmail.com
+    Then 1 email should be delivered to the user
+		And I follow "example.com/" in the email
+		Then I should be at the user's page
+
+  Scenario: Following a link in an email by the text
+  	Given a user exists with name: "Fred", email: "fred@gmail.com"
+  	And an email "cool" with body: "some text <a href='http://example.com/users/1'>example page</a> more text" is delivered to fred@gmail.com
+    Then 1 email should be delivered to the user
+		And I follow "example page" in the email
+		Then I should be at the user's page

data/features/step_definitions/email_steps.rb

@@ -18,6 +18,14 @@ Given(/^(\d)+ emails? should be delivered$/) do |count|
   emails.size.should == count.to_i
 end
 
+When(/^(?:I|they) follow "([^"]*?)" in #{capture_email}$/) do |link, email_ref|
+  visit_in_email(email(email_ref), link)
+end
+
+When(/^(?:I|they) click the first link in #{capture_email}$/) do |email_ref|
+  click_first_link_in_email(email(email_ref))
+end
+
 Then(/^(\d)+ emails? should be delivered to (.*)$/) do |count, to|
   emails("to: \"#{email_for(to)}\"").size.should == count.to_i
 end

data/features/step_definitions/generator_steps.rb

@@ -8,7 +8,7 @@ After('@gen') do
 end
 
 Given(/^cucumber has been freshly generated$/) do
-  `cd #{Rails.root}; script/generate cucumber -f`
+  `cd #{Rails.root}; script/generate cucumber -f --webrat`
 end
 
 Given(/^pickle path email has been freshly generated$/) do

data/features/step_definitions/pickle_steps.rb

@@ -70,4 +70,20 @@ end
 # assert not model.predicate?
 Then(/^#{capture_model} should not (?:be|have) (?:an? )?#{capture_predicate}$/) do |name, predicate|
   model!(name).should_not send("be_#{predicate.gsub(' ', '_')}")
-end
+end
+
+# model.attribute.should eql(value)
+# model.attribute.should_not eql(value)
+Then(/^#{capture_model}'s (\w+) (should(?: not)?) be #{capture_value}$/) do |name, attribute, expectation, expected|
+  actual_value  = model(name).send(attribute)
+  expectation   = expectation.gsub(' ', '_')
+  
+  case expected
+  when 'nil', 'true', 'false'
+    actual_value.send(expectation, send("be_#{expected}"))
+  when /^-?[0-9_]+$/
+    actual_value.send(expectation, eql(expected.to_i))
+  else
+    actual_value.to_s.send(expectation, eql(expected))
+  end
+end

data/features/support/env.rb

@@ -1,25 +1,25 @@
-# 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.
+# 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.
 
-# Sets up the Rails environment for Cucumber
 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
 require 'cucumber/rails/world'
+require 'cucumber/rails/active_record'
+require 'cucumber/web/tableish'
+
+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
 
-# 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
@@ -32,16 +32,21 @@ Cucumber::Rails::World.use_transactional_fixtures = true
 # 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
+# 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/features/support/paths.rb

@@ -3,7 +3,7 @@ module NavigationHelpers
   #
   #   When /^I go to (.+)$/ do |page_name|
   #
-  # step definition in webrat_steps.rb
+  # step definition in web_steps.rb
   #
   def path_to(page_name)
     case page_name
@@ -12,7 +12,7 @@ module NavigationHelpers
       '/'
     
     # Add more mappings here.
-    # Here is a more fancy example:
+    # Here is an example that pulls values out of the Regexp:
     #
     #   when /^(.*)'s profile page$/i
     #     user_profile_path(User.find_by_login($1))

data/features/support/pickle_app.rb

@@ -1,9 +1,3 @@
-# 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"'

data/garlic.rb

@@ -5,6 +5,7 @@ garlic do
   repo 'factory_girl', :url => 'git://github.com/thoughtbot/factory_girl'
   repo 'machinist', :url => 'git://github.com/notahat/machinist'
   repo 'cucumber', :url => 'git://github.com/aslakhellesoy/cucumber'
+  repo 'cucumber-rails', :url => 'git://github.com/aslakhellesoy/cucumber-rails'
   repo 'webrat', :url => 'git://github.com/brynary/webrat'
   repo 'pickle', :path => '.'
 
@@ -18,11 +19,12 @@ garlic do
           `script/generate rspec -f`
         end
         plugin 'factory_girl'
-        plugin 'cucumber' do
-          `script/generate cucumber -f`
-        end
+        plugin 'cucumber'
         plugin 'machinist'
         plugin 'webrat'
+        plugin 'cucumber-rails' do
+          `script/generate cucumber --webrat -f`
+        end
       end
   
       run do

data/lib/pickle/email.rb

@@ -18,7 +18,17 @@ module Pickle
       end
       true
     end
-    
+
+    def visit_in_email(email, link_text)
+      visit(parse_email_for_link(email, link_text))
+    end
+
+    def click_first_link_in_email(email)
+      link = links_in_email(email).first
+      request_uri = URI::parse(link).request_uri
+      visit request_uri
+    end
+  
   protected
     # Saves the emails out to RAILS_ROOT/tmp/ and opens it in the default
     # web browser if on OS X. (depends on webrat)
@@ -32,5 +42,31 @@ module Pickle
       end
       open_in_browser(filename)
     end
+
+    def parse_email_for_link(email, text_or_regex)
+      url = parse_email_for_explicit_link(email, text_or_regex)
+      url ||= parse_email_for_anchor_text_link(email, text_or_regex)
+      raise "No link found matching #{text_or_regex.inspect} in #{email}" unless url
+      url
+    end
+
+    # e.g. confirm in http://confirm
+    def parse_email_for_explicit_link(email, regex)
+      regex = /#{Regexp.escape(regex)}/ unless regex.is_a?(Regexp)
+      url = links_in_email(email).detect { |link| link =~ regex }
+      URI::parse(url).request_uri if url
+    end
+
+    # e.g. Click here in  <a href="http://confirm">Click here</a>
+    def parse_email_for_anchor_text_link(email, link_text)
+      email.body =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
+      URI.split($~[1])[5..-1].compact!.join("?").gsub("&amp;", "&")
+      # sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002)
+    end
+
+    def links_in_email(email, protos=['http', 'https'])
+      URI.extract(email.body, protos)
+    end
+
   end
 end

data/lib/pickle/world.rb

@@ -5,5 +5,5 @@ World(Pickle::Session)
 
 # shortcuts to regexps for use in step definition regexps
 class << self
-  delegate :capture_model, :capture_fields, :capture_factory, :capture_plural_factory, :capture_predicate, :to => 'Pickle.parser'
+  delegate :capture_model, :capture_fields, :capture_factory, :capture_plural_factory, :capture_predicate, :capture_value, :to => 'Pickle.parser'
 end

data/pickle.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{pickle}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ian White"]
-  s.date = %q{2009-12-01}
+  s.date = %q{2010-02-27}
   s.description = %q{Easy model creation and reference in your cucumber features}
   s.email = %q{ian.w.white@gmail.com}
   s.extra_rdoc_files = [
@@ -83,7 +83,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/ianwhite/pickle/tree}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Easy model creation and reference in your cucumber features}
   s.test_files = [
     "spec/lib/pickle_adapter_spec.rb",
@@ -108,3 +108,4 @@ Gem::Specification.new do |s|
   else
   end
 end
+

data/rails_generators/pickle/templates/email_steps.rb

@@ -18,6 +18,14 @@ Given(/^(\d)+ emails? should be delivered$/) do |count|
   emails.size.should == count.to_i
 end
 
+When(/^(?:I|they) follow "([^"]*?)" in #{capture_email}$/) do |link, email_ref|
+  visit_in_email(email(email_ref), link)
+end
+
+When(/^(?:I|they) click the first link in #{capture_email}$/) do |email_ref|
+  click_first_link_in_email(email(email_ref))
+end
+
 Then(/^(\d)+ emails? should be delivered to (.*)$/) do |count, to|
   emails("to: \"#{email_for(to)}\"").size.should == count.to_i
 end

data/rails_generators/pickle/templates/pickle_steps.rb

@@ -70,4 +70,20 @@ end
 # assert not model.predicate?
 Then(/^#{capture_model} should not (?:be|have) (?:an? )?#{capture_predicate}$/) do |name, predicate|
   model!(name).should_not send("be_#{predicate.gsub(' ', '_')}")
-end
+end
+
+# model.attribute.should eql(value)
+# model.attribute.should_not eql(value)
+Then(/^#{capture_model}'s (\w+) (should(?: not)?) be #{capture_value}$/) do |name, attribute, expectation, expected|
+  actual_value  = model(name).send(attribute)
+  expectation   = expectation.gsub(' ', '_')
+  
+  case expected
+  when 'nil', 'true', 'false'
+    actual_value.send(expectation, send("be_#{expected}"))
+  when /^-?[0-9_]+$/
+    actual_value.send(expectation, eql(expected.to_i))
+  else
+    actual_value.to_s.send(expectation, eql(expected))
+  end
+end

data/spec/lib/pickle_email_spec.rb

@@ -128,4 +128,26 @@ describe Pickle::Email do
       save_and_open_emails
     end
   end
+  
+  describe "following links in emails" do
+    before do
+      stub!(:open_in_browser)
+      @email1.stub!(:body).and_return('some text <a href="http://example.com/page">example page</a> more text')
+    end
+    
+    it "should find a link for http://example.com/page" do
+      should_receive(:visit).with('/page')
+      visit_in_email(@email1, 'http://example.com/page')
+    end
+
+    it "should find a link for \"example page\"" do
+      should_receive(:visit).with('/page')
+      visit_in_email(@email1, 'example page')
+    end
+    
+    it "should follow the first link in an email" do
+      should_receive(:visit).with('/page')
+      click_first_link_in_email(@email1)
+    end
+  end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: pickle
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Ian White
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 +00:00
+date: 2010-02-27 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -98,18 +103,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Easy model creation and reference in your cucumber features