casebook-webrat 0.4.4.1

data/lib/webrat/selenium.rb

@@ -0,0 +1,80 @@
+require "webrat"
+gem "selenium-client", ">=1.2.14"
+require "selenium/client"
+require "webrat/selenium/selenium_session"
+require "webrat/selenium/matchers"
+require "webrat/core_extensions/tcp_socket"
+
+module Webrat
+  # To use Webrat's Selenium support, you'll need the selenium-client gem installed.
+  # Activate it with (for example, in your <tt>env.rb</tt>):
+  #
+  #   require "webrat"
+  #
+  #   Webrat.configure do |config|
+  #     config.mode = :selenium
+  #   end
+  #
+  # == Dropping down to the selenium-client API
+  #
+  # If you ever need to do something with Selenium not provided in the Webrat API,
+  # you can always drop down to the selenium-client API using the <tt>selenium</tt> method.
+  # For example:
+  #
+  #   When "I drag the photo to the left" do
+  #     selenium.dragdrop("id=photo_123", "+350, 0")
+  #   end
+  #
+  # == Choosing the underlying framework to test
+  #
+  # Webrat assumes you're using rails by default but it can also work with sinatra
+  # and merb.  To take advantage of this you can use the configuration block to
+  # set the application_framework variable.
+  #   require "webrat"
+  #
+  #   Webrat.configure do |config|
+  #     config.mode = :selenium
+  #     config.application_port = 4567
+  #     config.application_framework = :sinatra  # could also be :merb
+  #   end
+  #
+  # == Auto-starting of the appserver and java server
+  #
+  # Webrat will automatically start the Selenium Java server process and an instance
+  # of Mongrel when a test is run. The Mongrel will run in the "selenium" environment
+  # instead of "test", so ensure you've got that defined, and will run on port
+  # Webrat.configuration.application_port.
+  #
+  # == Waiting
+  #
+  # In order to make writing Selenium tests as easy as possible, Webrat will automatically
+  # wait for the correct elements to exist on the page when trying to manipulate them
+  # with methods like <tt>fill_in</tt>, etc. In general, this means you should be able to write
+  # your Webrat::Selenium tests ignoring the concurrency issues that can plague in-browser
+  # testing, so long as you're using the Webrat API.
+  module Selenium
+    module Methods
+      def response
+        webrat_session.response
+      end
+
+      def wait_for(*args, &block)
+        webrat_session.wait_for(*args, &block)
+      end
+
+      def save_and_open_screengrab
+        webrat_session.save_and_open_screengrab
+      end
+    end
+  end
+end
+
+if defined?(ActionController::IntegrationTest)
+  module ActionController #:nodoc:
+    IntegrationTest.class_eval do
+      include Webrat::Methods
+      include Webrat::Selenium::Methods
+      include Webrat::Selenium::Matchers
+    end
+  end
+end

data/lib/webrat/selenium/application_server.rb

@@ -0,0 +1,71 @@
+module Webrat
+  module Selenium
+
+    class ApplicationServer
+
+      def self.boot
+        case Webrat.configuration.application_framework
+        when :sinatra
+          require "webrat/selenium/sinatra_application_server"
+          SinatraApplicationServer.new.boot
+        when :merb
+          require "webrat/selenium/merb_application_server"
+          MerbApplicationServer.new.boot
+        when :rails
+          require "webrat/selenium/rails_application_server"
+          RailsApplicationServer.new.boot
+        else
+          raise WebratError.new(<<-STR)
+Unknown Webrat application_framework: #{Webrat.configuration.application_framework.inspect}
+
+Please ensure you have a Webrat configuration block that specifies an application_framework
+in your test_helper.rb, spec_helper.rb, or env.rb (for Cucumber).
+
+For example:
+
+  Webrat.configure do |config|
+    # ...
+    config.application_framework = :rails
+  end
+      STR
+        end
+      end
+
+      def boot
+        start
+        wait
+        stop_at_exit
+      end
+
+      def stop_at_exit
+        at_exit do
+          stop
+        end
+      end
+
+      def wait
+        $stderr.print "==> Waiting for #{Webrat.configuration.application_framework} application server on port #{Webrat.configuration.application_port}... "
+        wait_for_socket
+        $stderr.print "Ready!\n"
+      end
+
+      def wait_for_socket
+        silence_stream(STDOUT) do
+          TCPSocket.wait_for_service_with_timeout \
+            :host     => Webrat.configuration.application_address,
+            :port     => Webrat.configuration.application_port.to_i,
+            :timeout  => 30 # seconds
+        end
+      rescue SocketError
+        fail
+      end
+
+      def prepare_pid_file(file_path, pid_file_name)
+        FileUtils.mkdir_p File.expand_path(file_path)
+        File.expand_path("#{file_path}/#{pid_file_name}")
+      end
+
+    end
+
+  end
+end

data/lib/webrat/selenium/location_strategy_javascript/button.js

@@ -0,0 +1,12 @@
+if (locator == '*') {
+  return selenium.browserbot.locationStrategies['xpath'].call(this, "//input[@type='submit']", inDocument, inWindow)
+}
+var inputs = inDocument.getElementsByTagName('input');
+return $A(inputs).find(function(candidate){
+  inputType = candidate.getAttribute('type');
+  if (inputType == 'submit' || inputType == 'image') {
+    var buttonText = $F(candidate);
+    return (PatternMatcher.matches(locator, buttonText));
+  }
+  return false;
+});

data/lib/webrat/selenium/location_strategy_javascript/label.js

@@ -0,0 +1,16 @@
+var allLabels = inDocument.getElementsByTagName("label");
+var candidateLabels = $A(allLabels).select(function(candidateLabel){
+  var regExp = new RegExp('^' + locator + '\\b', 'i');
+  var labelText = getText(candidateLabel).strip();
+  return (labelText.search(regExp) >= 0);
+});
+if (candidateLabels.length == 0) {
+  return null;      
+}
+candidateLabels = candidateLabels.sortBy(function(s) { return s.length * -1; }); //reverse length sort
+var locatedLabel = candidateLabels.first();
+var labelFor = locatedLabel.getAttribute('for');
+if ((labelFor == null) && (locatedLabel.hasChildNodes())) {
+  return locatedLabel.firstChild; //TODO: should find the first form field, not just any node
+}
+return selenium.browserbot.locationStrategies['id'].call(this, labelFor, inDocument, inWindow);

data/lib/webrat/selenium/location_strategy_javascript/webrat.js

@@ -0,0 +1,5 @@
+var locationStrategies = selenium.browserbot.locationStrategies;
+return locationStrategies['id'].call(this, locator, inDocument, inWindow)
+        || locationStrategies['name'].call(this, locator, inDocument, inWindow)
+        || locationStrategies['label'].call(this, locator, inDocument, inWindow)
+        || null;

data/lib/webrat/selenium/location_strategy_javascript/webratlink.js

@@ -0,0 +1,9 @@
+var links = inDocument.getElementsByTagName('a');
+var candidateLinks = $A(links).select(function(candidateLink) {
+  return PatternMatcher.matches(locator, getText(candidateLink));
+});
+if (candidateLinks.length == 0) {
+  return null;
+}
+candidateLinks = candidateLinks.sortBy(function(s) { return s.length * -1; }); //reverse length sort
+return candidateLinks.first();

data/lib/webrat/selenium/location_strategy_javascript/webratlinkwithin.js

@@ -0,0 +1,15 @@
+var locatorParts = locator.split('|');
+var cssAncestor = locatorParts[0];
+var linkText = locatorParts[1];
+var matchingElements = cssQuery(cssAncestor, inDocument);
+var candidateLinks = matchingElements.collect(function(ancestor){
+  var links = ancestor.getElementsByTagName('a');
+  return $A(links).select(function(candidateLink) {
+    return PatternMatcher.matches(linkText, getText(candidateLink));
+  });
+}).flatten().compact();
+if (candidateLinks.length == 0) {
+  return null;
+}
+candidateLinks = candidateLinks.sortBy(function(s) { return s.length * -1; }); //reverse length sort
+return candidateLinks.first();

data/lib/webrat/selenium/location_strategy_javascript/webratselectwithoption.js

@@ -0,0 +1,5 @@
+var optionElements = inDocument.getElementsByTagName('option');
+var locatedOption = $A(optionElements).find(function(candidate){
+  return (PatternMatcher.matches(locator, getText(candidate)));
+});
+return locatedOption ? locatedOption.parentNode : null;

data/lib/webrat/selenium/matchers.rb

@@ -0,0 +1,4 @@
+require "webrat/selenium/matchers/have_xpath"
+require "webrat/selenium/matchers/have_selector"
+# require "webrat/selenium/matchers/have_tag"
+require "webrat/selenium/matchers/have_content"

data/lib/webrat/selenium/matchers/have_content.rb

@@ -0,0 +1,66 @@
+module Webrat
+  module Selenium
+    module Matchers
+      class HasContent #:nodoc:
+        def initialize(content)
+          @content = content
+        end
+
+        def matches?(response)
+          if @content.is_a?(Regexp)
+            text_finder = "regexp:#{@content.source}"
+          else
+            text_finder = @content
+          end
+
+          response.session.wait_for do
+            response.selenium.is_text_present(text_finder)
+          end
+          rescue Webrat::TimeoutError
+            false
+        end
+
+        # ==== Returns
+        # String:: The failure message.
+        def failure_message
+          "expected the following element's content to #{content_message}:\n#{@element}"
+        end
+
+        # ==== Returns
+        # String:: The failure message to be displayed in negative matches.
+        def negative_failure_message
+          "expected the following element's content to not #{content_message}:\n#{@element}"
+        end
+
+        def content_message
+          case @content
+          when String
+            "include \"#{@content}\""
+          when Regexp
+            "match #{@content.inspect}"
+          end
+        end
+      end
+
+      # Matches the contents of an HTML document with
+      # whatever string is supplied
+      def contain(content)
+        HasContent.new(content)
+      end
+
+      # Asserts that the body of the response contain
+      # the supplied string or regexp
+      def assert_contain(content)
+        hc = HasContent.new(content)
+       assert hc.matches?(response), hc.failure_message
+      end
+
+      # Asserts that the body of the response
+      # does not contain the supplied string or regepx
+      def assert_not_contain(content)
+        hc = HasContent.new(content)
+        assert !hc.matches?(response), hc.negative_failure_message
+      end
+    end
+  end
+end

data/lib/webrat/selenium/matchers/have_selector.rb

@@ -0,0 +1,49 @@
+module Webrat
+  module Selenium
+    module Matchers
+      class HaveSelector
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(response)
+          response.session.wait_for do
+            response.selenium.is_element_present("css=#{@expected}")
+          end
+          rescue Webrat::TimeoutError
+            false
+        end
+
+        # ==== Returns
+        # String:: The failure message.
+        def failure_message
+          "expected following text to match selector #{@expected}:\n#{@document}"
+        end
+
+        # ==== Returns
+        # String:: The failure message to be displayed in negative matches.
+        def negative_failure_message
+          "expected following text to not match selector #{@expected}:\n#{@document}"
+        end
+      end
+
+      def have_selector(content)
+        HaveSelector.new(content)
+      end
+
+      # Asserts that the body of the response contains
+      # the supplied selector
+      def assert_have_selector(expected)
+        hs = HaveSelector.new(expected)
+        assert hs.matches?(response), hs.failure_message
+      end
+
+      # Asserts that the body of the response
+      # does not contain the supplied string or regepx
+      def assert_have_no_selector(expected)
+        hs = HaveSelector.new(expected)
+        assert !hs.matches?(response), hs.negative_failure_message
+      end
+    end
+  end
+end

data/lib/webrat/selenium/matchers/have_tag.rb

@@ -0,0 +1,72 @@
+module Webrat
+  module Selenium
+    module Matchers
+
+      class HaveTag < HaveSelector #:nodoc:
+        # ==== Returns
+        # String:: The failure message.
+        def failure_message
+          "expected following output to contain a #{tag_inspect} tag:\n#{@document}"
+        end
+
+        # ==== Returns
+        # String:: The failure message to be displayed in negative matches.
+        def negative_failure_message
+          "expected following output to omit a #{tag_inspect}:\n#{@document}"
+        end
+
+        def tag_inspect
+          options = @expected.last.dup
+          content = options.delete(:content)
+
+          html = "<#{@expected.first}"
+          options.each do |k,v|
+            html << " #{k}='#{v}'"
+          end
+
+          if content
+            html << ">#{content}</#{@expected.first}>"
+          else
+            html << "/>"
+          end
+
+          html
+        end
+
+        def query
+          options  = @expected.last.dup
+          selector = @expected.first.to_s
+
+          selector << ":contains('#{options.delete(:content)}')" if options[:content]
+
+          options.each do |key, value|
+            selector << "[#{key}='#{value}']"
+          end
+
+          Nokogiri::CSS.parse(selector).map { |ast| ast.to_xpath }
+        end
+      end
+
+      def have_tag(name, attributes = {}, &block)
+        HaveTag.new([name, attributes], &block)
+      end
+
+      alias_method :match_tag, :have_tag
+
+      # Asserts that the body of the response contains
+      # the supplied tag with the associated selectors
+      def assert_have_tag(name, attributes = {})
+        ht = HaveTag.new([name, attributes])
+        assert ht.matches?(response), ht.failure_message
+      end
+
+      # Asserts that the body of the response
+      # does not contain the supplied string or regepx
+      def assert_have_no_tag(name, attributes = {})
+        ht = HaveTag.new([name, attributes])
+        assert !ht.matches?(response), ht.negative_failure_message
+      end
+
+    end
+  end
+end

data/lib/webrat/selenium/matchers/have_xpath.rb

@@ -0,0 +1,45 @@
+module Webrat
+  module Selenium
+    module Matchers
+      class HaveXpath
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(response)
+          response.session.wait_for do
+            response.selenium.is_element_present("xpath=#{@expected}")
+          end
+          rescue Webrat::TimeoutError
+            false
+        end
+
+        # ==== Returns
+        # String:: The failure message.
+        def failure_message
+          "expected following text to match xpath #{@expected}:\n#{@document}"
+        end
+
+        # ==== Returns
+        # String:: The failure message to be displayed in negative matches.
+        def negative_failure_message
+          "expected following text to not match xpath #{@expected}:\n#{@document}"
+        end
+      end
+
+      def have_xpath(xpath)
+        HaveXpath.new(xpath)
+      end
+
+      def assert_have_xpath(expected)
+        hs = HaveXpath.new(expected)
+        assert hs.matches?(response), hs.failure_message
+      end
+
+      def assert_have_no_xpath(expected)
+        hs = HaveXpath.new(expected)
+        assert !hs.matches?(response), hs.negative_failure_message
+      end
+    end
+  end
+end