kelp 0.2.0 → 0.2.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kelp (0.2.0)
+    kelp (0.2.1)
       capybara (>= 0.4.0)
 
 GEM

data/History.md

@@ -1,6 +1,14 @@
 Kelp History
 ============
 
+0.2.1
+-----
+
+- Fixed arity mismatch bug in "I am on / I go to" step definition
+- Allow "an" in "should see ... button" step definitions
+- Allow empty strings in some stepdefs
+
+
 0.2.0
 -----
 

data/examples/sinatra_app/features/checkbox.feature

@@ -1,7 +1,7 @@
 Feature: Checkboxes
 
   Background:
-    Given I visit "/form"
+    Given I am on "/form"
 
   Scenario: Checkbox should be checked
     Then the "Like" checkbox next to "Apple" should be checked
@@ -10,3 +10,12 @@ Feature: Checkboxes
   Scenario: Checkbox should not be checked
     Then the "Like" checkbox next to "Banana" should be unchecked
     And the "Like" checkbox next to "Banana" should not be checked
+
+  Scenario: Check a checkbox
+    When I check "I like salami"
+    Then the "I like salami" checkbox should be checked
+
+  Scenario: Uncheck a checkbox
+    When I uncheck "I like cheese"
+    Then the "I like cheese" checkbox should be unchecked
+

data/examples/sinatra_app/features/checkbox_fail.feature

@@ -1,7 +1,7 @@
 Feature: Checkbox failures
 
   Background:
-    Given I visit "/form"
+    Given I am on "/form"
 
   Scenario: Checkbox should be checked (FAIL)
     Then the "Like" checkbox next to "Banana" should be checked

data/examples/sinatra_app/features/dropdown.feature

@@ -1,7 +1,7 @@
 Feature: Dropdowns
 
   Background:
-    Given I visit "/form"
+    Given I am on "/form"
 
   Scenario: Dropdown should equal
     Then the "Height" dropdown should equal "Average"
@@ -30,4 +30,7 @@ Feature: Dropdowns
       | Dwarf |
       | Behemoth |
 
+  Scenario: Select a value from a dropdown
+    When I select "Tall" from "Height"
+    Then the "Height" dropdown should equal "Tall"
 

data/examples/sinatra_app/features/dropdown_fail.feature

@@ -1,7 +1,7 @@
 Feature: Dropdown failures
 
   Background:
-    Given I visit "/form"
+    Given I am on "/form"
 
   Scenario: Dropdown should equal (FAIL)
     Then the "Height" dropdown should equal "Tall"

data/examples/sinatra_app/features/field.feature

@@ -1,7 +1,7 @@
 Feature: Fields
 
   Background:
-    Given I visit "/form"
+    Given I am on "/form"
 
 
   Scenario: Field should be empty
@@ -20,6 +20,16 @@ Feature: Fields
       | Message    | Your message goes here |
 
 
+  Scenario: Field should contain
+    Then the "First name" field should contain ""
+    And the "Message" field should contain "Your message goes here"
+
+
+  Scenario: Field should not contain
+    When I fill in "First name" with "Adam"
+    Then the "First name" field should not contain "Jamie"
+
+
   Scenario: Fill in single fields by label
     When I fill in "First name" with "Adam"
     And I fill in "Savage" for "Last name"

data/examples/sinatra_app/features/field_fail.feature

@@ -1,7 +1,7 @@
 Feature: Field failure test
 
   Background:
-    Given I visit "/form"
+    Given I am on "/form"
 
 
   Scenario: Field should be empty (FAIL)
@@ -19,6 +19,11 @@ Feature: Field failure test
     Then the "First name" field should contain "Alexy"
 
 
+  Scenario: Field should not contain (FAIL)
+    When I fill in "First name" with "Ivan"
+    Then the "First name" field should not contain "Ivan"
+
+
   Scenario: Fill in a single field (FAIL)
     When I fill in "Middle name" with "Fyodorovitch"
 

data/examples/sinatra_app/features/navigation.feature

@@ -0,0 +1,38 @@
+Feature: Navigation
+
+  Background:
+    Given I am on "/home"
+
+
+  Scenario: Go to page, should be on page
+    When I go to "/form"
+    Then I should be on "/form"
+
+
+  Scenario: Follow a link
+    When I follow "About Us"
+    Then I should be on "/about"
+
+
+  Scenario: Follow a link within a scope
+    When I follow "About Us" within "#links"
+    Then I should be on "/about"
+
+
+  Scenario: Follow a link next to something else
+    When I follow "Edit" next to "Eric"
+    Then I should be on "/edit1"
+
+
+  Scenario: Press a button
+    When I go to "/form"
+    And I press "Submit person form"
+    Then I should be on "/thanks"
+
+
+  Scenario: Press a button within a scope
+    When I am on "/form"
+    And I press "Save preferences" within "#preferences_form"
+    Then I should be on "/thanks"
+
+

data/examples/sinatra_app/features/navigation_fail.feature

@@ -0,0 +1,26 @@
+Feature: Navigation failures
+
+  Background:
+    Given I am on "/home"
+
+
+  Scenario: Should be on page (FAIL)
+    When I go to "/form"
+    Then I should be on "home"
+
+
+  Scenario: Follow a link (FAIL)
+    When I follow "Bogus link"
+
+
+  Scenario: Follow a bad link next to existing text (FAIL)
+    When I follow "555" next to "Eric"
+
+
+  Scenario: Follow a link next to nonexistent text (FAIL)
+    When I follow "Edit" next to "Ramses"
+
+
+  Scenario: Press a button (FAIL)
+    When I press "Big red button"
+

data/examples/sinatra_app/features/visibility.feature

@@ -1,7 +1,7 @@
 Feature: Visibility
 
   Background:
-    Given I visit "/home"
+    Given I am on "/home"
 
 
   Scenario: Should or shouldn't see text
@@ -122,13 +122,13 @@ Feature: Visibility
 
 
   Scenario: Should or shouldn't see button
-    When I visit "/form"
+    When I go to "/form"
     Then I should see a "Submit person form" button
     But I should not see a "Submit animal form" button
 
 
   Scenario: Should or shouldn't see button within a scope
-    When I visit "/form"
+    When I go to "/form"
     Then I should see a "Submit person form" button within "#person_form"
     But I should not see a "Submit person form" button within "#preferences_form"
 

data/examples/sinatra_app/features/visibility_fail.feature

@@ -1,7 +1,7 @@
 Feature: Visibility failures
 
   Background:
-    Given I visit "/home"
+    Given I am on "/home"
 
 
   Scenario: Should see text (FAIL)

data/features/kelp_step_definitions.feature

@@ -10,8 +10,8 @@ Feature: Kelp Step Definitions
     When I run cucumber on "checkbox.feature"
     Then the results should include:
       """
-      2 scenarios (2 passed)
-      6 steps (6 passed)
+      4 scenarios (4 passed)
+      12 steps (12 passed)
       """
 
   Scenario: Checkbox failure test
@@ -32,8 +32,8 @@ Feature: Kelp Step Definitions
     When I run cucumber on "dropdown.feature"
     Then the results should include:
       """
-      3 scenarios (3 passed)
-      11 steps (11 passed)
+      4 scenarios (4 passed)
+      14 steps (14 passed)
       """
 
   Scenario: Dropdown failure test
@@ -59,14 +59,17 @@ Feature: Kelp Step Definitions
       Scenario: Dropdown should not include multiple values (FAIL)
         Expected 'Height' dropdown to not include: ["Tiny", "Average", "Tall", "Enormous"]
         Did include: ["Average", "Tall"] (Kelp::Unexpected)
+
+      5 scenarios (5 failed)
+      10 steps (5 failed, 5 passed)
       """
 
   Scenario: Field test
     When I run cucumber on "field.feature"
     Then the results should include:
       """
-      7 scenarios (7 passed)
-      30 steps (30 passed)
+      9 scenarios (9 passed)
+      36 steps (36 passed)
       """
 
   Scenario: Field failure test
@@ -83,14 +86,18 @@ Feature: Kelp Step Definitions
         Expected 'First name' to contain 'Alexy'
         Got 'Dmitry' (Kelp::Unexpected)
 
+      Scenario: Field should not contain (FAIL)
+        Did not expect 'First name' to contain 'Ivan'
+        Got 'Ivan' (Kelp::Unexpected)
+
       Scenario: Fill in a single field (FAIL)
         No field with id, name, or label 'Middle name' found (Kelp::FieldNotFound)
 
       Scenario: Fill in multiple fields (FAIL)
         Field 'Height' has no option 'Diminutive' (Kelp::OptionNotFound)
 
-      5 scenarios (5 failed)
-      13 steps (5 failed, 8 passed)
+      6 scenarios (6 failed)
+      16 steps (6 failed, 10 passed)
       """
 
   Scenario: Visibility test
@@ -141,3 +148,35 @@ Feature: Kelp Step Definitions
       16 steps (8 failed, 8 passed)
       """
 
+  Scenario: Navigation test
+    When I run cucumber on "navigation.feature"
+    Then the results should include:
+      """
+      6 scenarios (6 passed)
+      20 steps (20 passed)
+      """
+
+  Scenario: Navigation failure test
+    When I run cucumber on "navigation_fail.feature"
+    Then the results should include:
+      """
+      Scenario: Should be on page (FAIL)
+        Expected to be on page: 'home'
+        Actually on page: '/form' (Kelp::Unexpected)
+
+      Scenario: Follow a link (FAIL)
+        No link with title, id or text 'Bogus link' found (Kelp::MissingLink)
+
+      Scenario: Follow a bad link next to existing text (FAIL)
+        No link with title, id or text '555' found in the same row as 'Eric' (Kelp::MissingLink)
+
+      Scenario: Follow a link next to nonexistent text (FAIL)
+        No table row found containing 'Edit' and 'Ramses' (Kelp::MissingRow)
+
+      Scenario: Press a button (FAIL)
+        No button with value, id or text 'Big red button' found (Kelp::MissingButton)
+
+      5 scenarios (5 failed)
+      11 steps (5 failed, 6 passed)
+      """
+

data/kelp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "kelp"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
   s.summary = "Cucumber helper methods"
   s.description = <<-EOS
     Kelp is a collection of helper methods for Cucumber to ease the process of

data/lib/kelp/checkbox.rb

@@ -22,7 +22,6 @@ module Kelp
     def checkbox_should_be_checked(checkbox, scope={})
       in_scope(scope) do
         field_checked = find_field(checkbox)['checked']
-        puts field_checked.inspect
         if !field_checked
           raise Kelp::Unexpected,
             "Expected '#{checkbox}' to be checked, but it is unchecked."

data/lib/kelp/dropdown.rb

@@ -35,7 +35,7 @@ module Kelp
         rescue Capybara::ElementNotFound
           # FIXME: Find a way to support multiple-selection dropdowns
           if field.value.class == Array
-            raise Exception, "Multiple-selection dropdowns are not supported"
+            raise NotImplementedError, "Multiple-selection dropdowns are not supported"
           end
           field_value = xpath_sanitize(field.value)
           selected = field.find(:xpath, ".//option[@value=#{field_value}]")

data/lib/kelp/exceptions.rb

@@ -3,5 +3,9 @@ module Kelp
   class Unexpected < KelpError; end
   class FieldNotFound < KelpError; end
   class OptionNotFound < KelpError; end
+  class MissingLink < KelpError; end
+  class MissingButton < KelpError; end
+  class MissingRow < KelpError; end
+  class InvalidScope < KelpError; end
 end
 

data/lib/kelp/field.rb

@@ -31,7 +31,7 @@ module Kelp
       begin
         select(value, :from => field)
       rescue Capybara::ElementNotFound => err
-        # The select method may raise ElementNotFound in two cases:
+        # The `select` method may raise ElementNotFound in two cases:
         # (1) The given field does not exist, in which case try a text field
         if err.message =~ /no select box with id, name, or label/
           begin
@@ -178,6 +178,28 @@ module Kelp
     end
 
 
+    # Return the string value found in the given field.
+    # If the field is `nil`, return the empty string.
+    #
+    # @param [String] field
+    #   Capybara locator for the field (name, id, or label text)
+    #
+    # @return [String]
+    #   The value found in the given field
+    #
+    # @since 0.2.1
+    #
+    def field_value(field)
+      element = find_field(field)
+      value = (element.tag_name == 'textarea') ? element.text : element.value
+      # If field value is an Array, take the first item
+      if value.class == Array
+        value = value.first
+      end
+      return value.to_s
+    end
+
+
     # Verify that the given field contains the given value.
     #
     # @param [String] field
@@ -192,37 +214,43 @@ module Kelp
     #
     def field_should_contain(field, value, scope={})
       in_scope(scope) do
-        # TODO: Make this work equally well with any kind of field
-        # (text, single-select, multi-select)
-        element = find_field(field)
-        field_value = (element.tag_name == 'textarea') ? element.text : element.value
-        # If field value is an Array, take the first item
-        if field_value.class == Array
-          field_value = field_value.first
-        end
+        actual = field_value(field)
         # Escape any problematic characters in the expected value
-        value = Regexp.escape(value)
+        expect = Regexp.escape(value)
         # Match actual to expected
-        if !(field_value =~ /#{value}/)
+        if !(actual =~ /#{expect}/)
           raise Kelp::Unexpected,
-            "Expected '#{field}' to contain '#{value}'" + \
-            "\nGot '#{field_value}'"
+            "Expected '#{field}' to contain '#{expect}'" + \
+            "\nGot '#{actual}'"
         end
       end
     end
 
 
+    # Verify that the given field does not contain the given value.
+    #
+    # @param [String] field
+    #   Capybara locator for the field (name, id, or label text)
+    # @param [String] value
+    #   Value you expect to not see in the text field
+    # @param [Hash] scope
+    #   Scoping keywords as understood by {#in_scope}
+    #
+    # @raise [Kelp::Unexpected]
+    #   If the given field contains `value`
+    #
     def field_should_not_contain(field, value, scope={})
-      raise NotImplementedError, "Not implemented yet"
-      #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
+      in_scope(scope) do
+        actual = field_value(field)
+        # Escape any problematic characters in the expected value
+        expect_not = Regexp.escape(value)
+        # Match actual to expected
+        if (actual =~ /#{expect_not}/)
+          raise Kelp::Unexpected,
+            "Did not expect '#{field}' to contain '#{expect_not}'" + \
+            "\nGot '#{actual}'"
+        end
+      end
     end
 
 

data/lib/kelp/navigation.rb

@@ -2,6 +2,7 @@ require 'uri'
 require 'cgi'
 require 'kelp/scoping'
 require 'kelp/xpath'
+require 'kelp/exceptions'
 
 module Kelp
   # This module defines helper methods for navigating a webpage, including
@@ -25,7 +26,12 @@ module Kelp
     #
     def follow(link, scope={})
       in_scope(scope) do
-        click_link(link)
+        begin
+          click_link(link)
+        rescue Capybara::ElementNotFound
+          raise Kelp::MissingLink,
+            "No link with title, id or text '#{link}' found"
+        end
       end
     end
 
@@ -42,7 +48,12 @@ module Kelp
     #
     def press(button, scope={})
       in_scope(scope) do
-        click_button(button)
+        begin
+          click_button(button)
+        rescue Capybara::ElementNotFound
+          raise Kelp::MissingButton,
+            "No button with value, id or text '#{button}' found"
+        end
       end
     end
 
@@ -58,8 +69,27 @@ module Kelp
     #   Other content that must be in the same row
     #
     def click_link_in_row(link, text)
-      row = find(:xpath, xpath_row_containing([link, text]))
-      row.click_link(link)
+      begin
+        row = find(:xpath, xpath_row_containing([link, text]))
+      rescue Capybara::ElementNotFound
+        raise Kelp::MissingRow,
+          "No table row found containing '#{link}' and '#{text}'"
+      end
+      begin
+        row.click_link(link)
+      rescue Capybara::ElementNotFound
+        raise Kelp::MissingLink,
+          "No link with title, id or text '#{link}' found in the same row as '#{text}'"
+      end
+    end
+
+
+    def go_to_page(page_name_or_path)
+      if defined? path_to
+        visit path_to(page_name_or_path)
+      else
+        visit page_name_or_path
+      end
     end
 
 

data/lib/kelp/scoping.rb

@@ -3,6 +3,18 @@ module Kelp
   # verifications on a webpage.
   #
   module Scoping
+    # Wrapper for Capybara's `within`, but raises Kelp::InvalidScope
+    # instead of Capybara::ElementNotFound
+    def kelp_within(kind, selector=nil)
+      begin
+        within(kind, selector) { yield }
+      rescue Capybara::ElementNotFound
+        raise Kelp::InvalidScope,
+          "Scope '#{selector || kind}' not found on page"
+      end
+    end
+
+
     # Execute a block of code within a given scope. If `locator` begins with
     # `/` or `./`, then it's assumed to be an XPath selector; otherwise, it's
     # assumed to be a CSS selector.
@@ -11,13 +23,13 @@ module Kelp
         # Use the selector_for method if it's defined. This may be provided
         # by features/support/selectors.rb, generated by cucumber-rails.
         if defined? selector_for
-          within(*selector_for(locator)) { yield }
+          kelp_within(*selector_for(locator)) { yield }
         # Otherwise, fall back on the Capybara locator syntax (CSS or XPath)
         else
           if locator =~ /\.?\//
-            within(:xpath, locator) { yield }
+            kelp_within(:xpath, locator) { yield }
           else
-            within(:css, locator) { yield }
+            kelp_within(:css, locator) { yield }
           end
         end
       else

data/rails_generators/kelp/templates/web_steps.rb

@@ -26,7 +26,8 @@ World(Kelp::Visibility)
 
 # Patterns shared by step definitions
 I = /(?:|I )/
-TEXT = /"([^\"]+)"/
+TEXT = /"([^\"]*)"/
+PAGE = /"?([^\"]+)"?/
 REGEX = /\/([^\/]*)\//
 WITHIN = /(?: within "?([^\"]+)"?)?/
 ELEMENT = /(?:field|checkbox|dropdown|button)/
@@ -46,8 +47,8 @@ ELEMENT = /(?:field|checkbox|dropdown|button)/
 #   When I go to my account page
 #   And I go to "/logout"
 #
-Given /^#{I}(am on|go to) (.+)$/ do |page_name|
-  visit path_to(page_name)
+Given /^#{I}(?:am on|go to) #{PAGE}$/ do |page_name|
+  go_to_page(page_name)
 end
 
 
@@ -89,7 +90,7 @@ end
 
 # Verify that the current path name matches that of the given page.
 #
-Then /^#{I}should be on (.+)$/ do |page_name|
+Then /^#{I}should be on #{PAGE}$/ do |page_name|
   should_be_on_page(page_name)
 end
 
@@ -256,11 +257,11 @@ end
 #   Then I should see a "Save" button
 #   But I should not see a "Delete" button
 #
-Then /^#{I}should see a #{TEXT} button#{WITHIN}$/ do |button, selector|
+Then /^#{I}should see an? #{TEXT} button#{WITHIN}$/ do |button, selector|
   should_see_button(button, :within => selector)
 end
 
-Then /^#{I}should not see a #{TEXT} button#{WITHIN}$/ do |button, selector|
+Then /^#{I}should not see an? #{TEXT} button#{WITHIN}$/ do |button, selector|
   should_not_see_button(button, :within => selector)
 end
 

data/spec/field_spec.rb

@@ -102,6 +102,58 @@ describe Kelp::Field, "field_should_contain" do
 end
 
 
+describe Kelp::Field, "field_should_not_contain" do
+  before(:each) do
+    visit('/form')
+  end
+
+  context "passes when" do
+    context "field with id" do
+      it "has a different value" do
+        fill_in "first_name", :with => "Brian"
+        field_should_not_contain "first_name", "Stewie"
+      end
+
+      it "is empty" do
+        field_should_not_contain "first_name", "Stewie"
+      end
+    end
+
+    context "field with label" do
+      it "has a different value" do
+        fill_in "First name", :with => "Brian"
+        field_should_not_contain "First name", "Stewie"
+      end
+
+      it "is empty" do
+        field_should_not_contain "First name", "Stewie"
+      end
+    end
+  end
+
+  context "fails when" do
+    context "field with id" do
+      it "has the given value" do
+        fill_in "first_name", :with => "Judith"
+        lambda do
+          field_should_not_contain "first_name", "Judith"
+        end.should raise_error(Kelp::Unexpected)
+      end
+    end
+
+    context "field with label" do
+      it "has the given value" do
+        fill_in "First name", :with => "Judith"
+        lambda do
+          field_should_not_contain "First name", "Judith"
+        end.should raise_error(Kelp::Unexpected)
+      end
+    end
+
+  end
+end
+
+
 describe Kelp::Field, "fields_should_contain" do
   before(:each) do
     visit('/form')

data/spec/navigation_spec.rb

@@ -21,13 +21,13 @@ describe Kelp::Navigation, "follow" do
     it "link does not exist" do
       lambda do
         follow "About Them"
-      end.should raise_error(Capybara::ElementNotFound)
+      end.should raise_error(Kelp::MissingLink)
     end
 
     it "link is not within the scope" do
       lambda do
         follow "About Us", :within => "#invalid_scope"
-      end.should raise_error(Capybara::ElementNotFound)
+      end.should raise_error(Kelp::InvalidScope)
     end
   end
 
@@ -53,13 +53,13 @@ describe Kelp::Navigation, "press" do
     it "button does not exist" do
       lambda do
         press "Poke"
-      end.should raise_error(Capybara::ElementNotFound)
+      end.should raise_error(Kelp::MissingButton)
     end
 
     it "button exists but is not within the scope" do
       lambda do
         press "Submit message", :within => "#greeting"
-      end.should raise_error(Capybara::ElementNotFound)
+      end.should raise_error(Kelp::MissingButton)
     end
   end
 end
@@ -81,7 +81,7 @@ describe Kelp::Navigation, "click_link_in_row" do
     it "link does not exist in the row" do
       lambda do
         click_link_in_row "Frob", "Eric"
-      end.should raise_error(Capybara::ElementNotFound)
+      end.should raise_error(Kelp::MissingRow)
     end
   end
 end

data/spec/visibility_spec.rb

@@ -113,7 +113,7 @@ describe Kelp::Visibility, "should_see" do
       it "is given a nonexistent XPath scope" do
         lambda do
           should_see "Goodbye world", :within => "//div[@id='nonexistent']"
-        end.should raise_error(Capybara::ElementNotFound)
+        end.should raise_error(Kelp::InvalidScope)
       end
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kelp
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Eric Pierce
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-11 00:00:00 -06:00
+date: 2011-05-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -145,10 +145,11 @@ files:
 - examples/sinatra_app/features/dropdown_fail.feature
 - examples/sinatra_app/features/field.feature
 - examples/sinatra_app/features/field_fail.feature
+- examples/sinatra_app/features/navigation.feature
+- examples/sinatra_app/features/navigation_fail.feature
 - examples/sinatra_app/features/support/env.rb
 - examples/sinatra_app/features/visibility.feature
 - examples/sinatra_app/features/visibility_fail.feature
-- examples/sinatra_app/features/web_steps.rb
 - examples/sinatra_app/views/about.erb
 - examples/sinatra_app/views/edit1.erb
 - examples/sinatra_app/views/edit2.erb

data/examples/sinatra_app/features/web_steps.rb

@@ -1,4 +0,0 @@
-Given /^I visit "(.+)"$/ do |path|
-  visit path
-end
-