rsel 0.0.4 → 0.0.5

data/lib/rsel/support.rb

@@ -0,0 +1,138 @@
+#require File.join(File.dirname(__FILE__), 'exceptions')
+
+require 'xpath'
+
+module Rsel
+  # Support functions for Rsel
+  module Support
+
+    # Execute the given block, and return false if it raises an exception.
+    # Otherwise, return true.
+    #
+    # @example
+    #   return_error_status do
+    #     # some code that might raise an exception
+    #   end
+    #
+    def return_error_status
+      begin
+        yield
+      rescue => e
+        #puts e.message
+        #puts e.backtrace
+        return false
+      else
+        return true
+      end
+    end
+
+    # Convert the given locator to a format accepted by Selenium. If `locator`
+    # starts with `id=`, `name=`, `dom=`, `xpath=` `link=` or `css=`, then the
+    # locator is returned unchanged. Otherwise, `locator` is assumed to be a
+    # plain string, and a Selenium-style `xpath=` locator is returned, matching
+    # HTML elements of the given kind, in the given scope. This allows you to
+    # use simple human-readable locator strings, or more specific
+    # Selenium-style locators.
+    #
+    # @param [String] locator
+    #   A Selenium-style locator beginning with `id=`, `name=`, `dom=`,
+    #   `xpath=`, `link=` or `css=`, or a plain text string that will
+    #   automatically match on the `id`, `name`, label, value, or text content
+    #   depending on the value of `kind`.
+    # @param [String] kind
+    #   What kind of locator you're using (link, button, checkbox, field etc.).
+    #   This must correspond to a method name in `XPath::HTML`. If you're using
+    #   a raw Selenium-style `locator` string, this argument can be omitted.
+    # @param [Hash] scope
+    #   Keywords to restrict the scope of matching elements. Ignored when
+    #   a Selenium-style locator is used. See the {#xpath} documentation for
+    #   allowed options.
+    #
+    def loc(locator, kind='', scope={})
+      if locator.empty?
+        raise ArgumentError, "locator is required."
+      elsif locator =~ /^(id=|name=|dom=|xpath=|link=|css=)/
+        return locator
+      else
+        return xpath(kind, locator, scope)
+      end
+    end
+
+
+    # Return a Selenium-style xpath generated by calling `XPath::HTML.<kind>`
+    # with the given `locator`. If `scope` options are provided, the xpath is
+    # modified accordingly, to match only elements in the given scope.
+    #
+    # @param [String] kind
+    #   What kind of locator you're using (link, button, checkbox, field etc.).
+    #   This must correspond to a method name in `XPath::HTML`.
+    # @param [String] locator
+    #   Name, id, value, label or whatever other locators are accepted by
+    #   `XPath::HTML.<kind>`
+    # @param [Hash] scope
+    #   Keywords to restrict the scope of matching elements
+    # @option scope [String] :within
+    #   Restrict scope to elements having this id, matching `locator` only if
+    #   it's contained within an element with this id.
+    # @option scope [String] :in_row
+    #   Restrict scope to a table row containing this text, matching `locator`
+    #   only if that locator is in the same row as the given text.
+    #
+    # @example
+    #   xpath('link', 'Log in')
+    #   xpath('button', 'Submit')
+    #   xpath('field', 'First name')
+    #   xpath('table_row', ['First', 'Last'])
+    #
+    def xpath(kind, locator, scope={})
+      if !XPath::HTML.respond_to?(kind)
+        raise ArgumentError, "Unknown kind of locator: '#{kind}'"
+      end
+      loc_xp = XPath::HTML.send(kind, locator)
+      if scope[:within]
+        parent = XPath.descendant[XPath.attr(:id).equals(scope[:within])]
+        result = apply_scope(parent, loc_xp)
+      elsif scope[:in_row]
+        row = XPath.descendant(:tr)[XPath.contains(scope[:in_row])]
+        result = apply_scope(row, loc_xp)
+      else
+        result = loc_xp.to_s
+      end
+      return "xpath=#{result}"
+    end
+
+
+    # Restrict the scope of all XPath expressions in `inner` by prepending
+    # `container` to each of them, and return new union expression where
+    # `inner` matches only if it's a child of `container`.
+    #
+    def apply_scope(container, inner)
+      scoped_expressions = xpath_expressions(inner).collect do |expr|
+        container.child(expr)
+      end
+      return XPath::Union.new(*scoped_expressions).to_s
+    end
+
+
+    # Return an array of individual Expressions in the given XPath::Union, or
+    # just `[union]` if it has no sub-expressions. This is an ugly recursive
+    # hack, designed to allow splitting up unions into their constituents for
+    # the purpose of modifying them individually and re-combining them.
+    #
+    # @param [XPath::Union, XPath::Expression] union
+    #   The xpath you want to break down into individual expressions
+    #
+    # @since 0.0.3
+    #
+    def xpath_expressions(union)
+      if union.respond_to?(:expressions)
+        return union.expressions.collect do |expr|
+          xpath_expressions(expr)
+        end.flatten
+      else
+        return [union]
+      end
+    end
+  end
+end
+

data/rsel.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "rsel"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
   s.summary = "Runs Selenium tests from FitNesse"
   s.description = <<-EOS
     Rsel provides a Slim fixture for running Selenium tests, with

data/spec/selenium_test_spec.rb

@@ -1,6 +1,15 @@
 require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
 
 describe Rsel::SeleniumTest do
+  before(:all) do
+    @st = Rsel::SeleniumTest.new('http://localhost:8070/')
+    @st.open_browser
+  end
+
+  after(:all) do
+    @st.close_browser
+  end
+
   context "initialization" do
     before(:each) do
       @st.visit("/")
@@ -37,6 +46,18 @@ describe Rsel::SeleniumTest do
             @st.enable_checkbox("Like", :in_row => "Marcus").should be_true
           end
         end
+
+        context "checkbox with id=" do
+          it "exists" do
+            @st.enable_checkbox("id=like_cheese").should be_true
+          end
+        end
+
+        context "checkbox with xpath=" do
+          it "exists" do
+            @st.enable_checkbox("xpath=//input[@id='like_cheese']").should be_true
+          end
+        end
       end
 
       context "fails when" do
@@ -77,6 +98,18 @@ describe Rsel::SeleniumTest do
             @st.disable_checkbox("Like", :in_row => "Marcus").should be_true
           end
         end
+
+        context "checkbox with id=" do
+          it "exists" do
+            @st.disable_checkbox("id=like_cheese").should be_true
+          end
+        end
+
+        context "checkbox with xpath=" do
+          it "exists" do
+            @st.disable_checkbox("xpath=//input[@id='like_cheese']").should be_true
+          end
+        end
       end
 
       context "fails when" do
@@ -338,18 +371,33 @@ describe Rsel::SeleniumTest do
     context "#dropdown_equals" do
       context "passes when" do
         it "option is selected in the dropdown" do
-          @st.select_from_dropdown("Short", "Height")
-          @st.dropdown_equals("Height", "Short").should be_true
+          ["Short", "Average", "Tall"].each do |height|
+            @st.select_from_dropdown(height, "Height")
+            @st.dropdown_equals("Height", height).should be_true
+          end
+        end
 
-          @st.select_from_dropdown("Average", "Height")
-          @st.dropdown_equals("Height", "Average").should be_true
+        it "option is selected in the dropdown, within scope" do
+          ["Short", "Average", "Tall"].each do |height|
+            @st.select_from_dropdown(height, "Height", :within => "spouse_form")
+            @st.dropdown_equals("Height", height, :within => "spouse_form").should be_true
+          end
+        end
 
-          @st.select_from_dropdown("Tall", "Height")
-          @st.dropdown_equals("Height", "Tall").should be_true
+        it "option is selected in the dropdown, in table row" do
+          @st.visit("/table")
+          ["Male", "Female"].each do |gender|
+            @st.select_from_dropdown(gender, "Gender", :in_row => "Eric")
+            @st.dropdown_equals("Gender", gender, :in_row => "Eric")
+          end
         end
       end
 
       context "fails when" do
+        it "no such dropdown exists" do
+          @st.dropdown_equals("Eggs", "Over easy").should be_false
+        end
+
         it "dropdown exists, but the option is not selected" do
           @st.select_from_dropdown("Short", "Height")
           @st.dropdown_equals("Height", "Average").should be_false
@@ -364,8 +412,17 @@ describe Rsel::SeleniumTest do
           @st.dropdown_equals("Height", "Average").should be_false
         end
 
-        it "no such dropdown exists" do
-          @st.dropdown_equals("Eggs", "Over easy").should be_false
+        it "dropdown exists, and option is selected, but not in scope" do
+          @st.select_from_dropdown("Tall", "Height", :within => "person_form")
+          @st.select_from_dropdown("Short", "Height", :within => "spouse_form")
+          @st.dropdown_equals("Height", "Tall", :within => "spouse_form").should be_false
+        end
+
+        it "dropdown exists, and option is selected, but not in table row" do
+          @st.visit("/table")
+          @st.select_from_dropdown("Female", "Gender", :in_row => "Eric")
+          @st.select_from_dropdown("Male", "Gender", :in_row => "Marcus")
+          @st.dropdown_equals("Gender", "Female", :in_row => "Marcus").should be_false
         end
       end
     end
@@ -604,13 +661,26 @@ describe Rsel::SeleniumTest do
         end
 
         it "field exists, but not within scope" do
-          @st.type_into_field("Long story", "Life story", :within => 'spouse_form').should be_false
+          @st.type_into_field("Long story", "Life story",
+                              :within => 'spouse_form').should be_false
         end
       end
     end
 
     describe "#field_contains" do
       context "passes when" do
+        context "text field with label" do
+          it "equals the text" do
+            @st.fill_in_with("First name", "Marcus")
+            @st.field_contains("First name", "Marcus").should be_true
+          end
+
+          it "contains the text" do
+            @st.fill_in_with("First name", "Marcus")
+            @st.field_contains("First name", "Marc").should be_true
+          end
+        end
+
         context "textarea with label" do
           it "contains the text" do
             @st.fill_in_with("Life story", "Blah dee blah")
@@ -620,6 +690,13 @@ describe Rsel::SeleniumTest do
       end
 
       context "fails when" do
+        context "text field with label" do
+          it "does not contain the text" do
+            @st.fill_in_with("First name", "Marcus")
+            @st.field_contains("First name", "Eric").should be_false
+          end
+        end
+
         context "textarea with label" do
           it "does not contain the text" do
             @st.fill_in_with("Life story", "Blah dee blah")
@@ -632,7 +709,15 @@ describe Rsel::SeleniumTest do
     describe "#field_equals" do
       context "passes when" do
         context "text field with label" do
-          # TODO
+          it "equals the text" do
+            @st.fill_in_with("First name", "Ken")
+            @st.field_equals("First name", "Ken").should be_true
+          end
+
+          it "equals the text, and is within scope" do
+            @st.fill_in_with("First name", "Eric", :within => "person_form")
+            @st.field_equals("First name", "Eric", :within => "person_form")
+          end
         end
 
         context "textarea with label" do
@@ -642,7 +727,10 @@ describe Rsel::SeleniumTest do
           end
 
           it "equals the text, and is within scope" do
-            # TODO
+            @st.fill_in_with("Life story", "Blah dee blah",
+                             :within => "person_form")
+            @st.field_equals("Life story", "Blah dee blah",
+                             :within => "person_form").should be_true
           end
 
           it "equals the text, and is in table row" do
@@ -653,7 +741,10 @@ describe Rsel::SeleniumTest do
 
       context "fails when" do
         context "text field with label" do
-          # TODO
+          it "does not exactly equal the text" do
+            @st.fill_in_with("First name", "Marcus")
+            @st.field_equals("First name", "Marc").should be_false
+          end
         end
 
         context "textarea with label" do

data/spec/spec_helper.rb

@@ -6,16 +6,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test', 'app'))
 
 RSpec.configure do |config|
   config.include Rsel
-
-  config.before(:all) do
-    @st = Rsel::SeleniumTest.new('http://localhost:8070/')
-    @st.open_browser
-  end
-
-  config.after(:all) do
-    @st.close_browser
-  end
-
+  config.include Rsel::Support
 end
 
 

data/spec/support_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe Rsel::Support do
+  describe "#loc" do
+    it "returns Selenium-style locators unchanged" do
+      locators = [
+        "id=foo_bar",
+        "name=foo_bar",
+        "xpath=//input[@id='foo_bar']",
+        "css=div#foo_bar",
+      ]
+      locators.each do |locator|
+        loc(locator).should == locator
+      end
+    end
+
+    it "returns Rsel-style locators as Selenium xpaths" do
+      locators = [
+        "First name",
+        "first_name",
+      ]
+      locators.each do |locator|
+        loc(locator, 'field').should =~ /^xpath=/
+      end
+    end
+
+    it "requires a non-empty locator" do
+      lambda do
+        loc('')
+      end.should raise_error
+    end
+
+    it "requires element kind for Rsel-style locators" do
+      lambda do
+        loc('foo')
+      end.should raise_error
+    end
+  end
+
+  describe "#xpath" do
+    it "requires a valid kind" do
+      lambda do
+        xpath('junk', 'hello')
+      end.should raise_error
+    end
+  end
+end
+

data/test/app.rb

@@ -14,12 +14,12 @@ class TestApp < Sinatra::Base
   end
 
   get '/:view' do |view|
-    erb view.to_sym
-  end
-
-  # Allow shutting down the app with a request
-  get '/shutdown' do
-    Process.kill('KILL', Process.pid)
+    # Allow shutting down the app with a request
+    if view == 'shutdown'
+      Process.kill('KILL', Process.pid)
+    else
+      erb view.to_sym
+    end
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rsel
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Marcus French
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-25 00:00:00 -06:00
+date: 2011-07-31 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -155,18 +155,22 @@ files:
 - Rakefile
 - docs/custom.md
 - docs/development.md
+- docs/examples.md
 - docs/history.md
 - docs/index.md
 - docs/install.md
+- docs/locators.md
 - docs/scoping.md
 - docs/todo.md
 - docs/usage.md
 - lib/rsel.rb
 - lib/rsel/exceptions.rb
 - lib/rsel/selenium_test.rb
+- lib/rsel/support.rb
 - rsel.gemspec
 - spec/selenium_test_spec.rb
 - spec/spec_helper.rb
+- spec/support_spec.rb
 - test/app.rb
 - test/config.ru
 - test/views/about.erb
@@ -177,41 +181,6 @@ files:
 - test/views/index.erb
 - test/views/table.erb
 - test/views/thanks.erb
-- vendor/rubyslim-0.1.1/.gitignore
-- vendor/rubyslim-0.1.1/README.md
-- vendor/rubyslim-0.1.1/Rakefile
-- vendor/rubyslim-0.1.1/bin/rubyslim
-- vendor/rubyslim-0.1.1/lib/rubyslim/list_deserializer.rb
-- vendor/rubyslim-0.1.1/lib/rubyslim/list_executor.rb
-- vendor/rubyslim-0.1.1/lib/rubyslim/list_serializer.rb
-- vendor/rubyslim-0.1.1/lib/rubyslim/ruby_slim.rb
-- vendor/rubyslim-0.1.1/lib/rubyslim/slim_error.rb
-- vendor/rubyslim-0.1.1/lib/rubyslim/slim_helper_library.rb
-- vendor/rubyslim-0.1.1/lib/rubyslim/socket_service.rb
-- vendor/rubyslim-0.1.1/lib/rubyslim/statement.rb
-- vendor/rubyslim-0.1.1/lib/rubyslim/statement_executor.rb
-- vendor/rubyslim-0.1.1/lib/rubyslim/table_to_hash_converter.rb
-- vendor/rubyslim-0.1.1/lib/test_module/library_new.rb
-- vendor/rubyslim-0.1.1/lib/test_module/library_old.rb
-- vendor/rubyslim-0.1.1/lib/test_module/should_not_find_test_slim_in_here/test_slim.rb
-- vendor/rubyslim-0.1.1/lib/test_module/simple_script.rb
-- vendor/rubyslim-0.1.1/lib/test_module/test_chain.rb
-- vendor/rubyslim-0.1.1/lib/test_module/test_slim.rb
-- vendor/rubyslim-0.1.1/lib/test_module/test_slim_with_arguments.rb
-- vendor/rubyslim-0.1.1/lib/test_module/test_slim_with_no_sut.rb
-- vendor/rubyslim-0.1.1/rubyslim.gemspec
-- vendor/rubyslim-0.1.1/spec/instance_creation_spec.rb
-- vendor/rubyslim-0.1.1/spec/it8f_spec.rb
-- vendor/rubyslim-0.1.1/spec/list_deserializer_spec.rb
-- vendor/rubyslim-0.1.1/spec/list_executor_spec.rb
-- vendor/rubyslim-0.1.1/spec/list_serialzer_spec.rb
-- vendor/rubyslim-0.1.1/spec/method_invocation_spec.rb
-- vendor/rubyslim-0.1.1/spec/slim_helper_library_spec.rb
-- vendor/rubyslim-0.1.1/spec/socket_service_spec.rb
-- vendor/rubyslim-0.1.1/spec/spec_helper.rb
-- vendor/rubyslim-0.1.1/spec/statement_executor_spec.rb
-- vendor/rubyslim-0.1.1/spec/statement_spec.rb
-- vendor/rubyslim-0.1.1/spec/table_to_hash_converter_spec.rb
 has_rdoc: true
 homepage: http://github.com/a-e/rsel
 licenses: []