jwilger-webrat 0.4.2

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

data/lib/webrat/selenium/selenium_extensions.js

@@ -0,0 +1,6 @@
+PatternMatcher.strategies['evalregex'] = function(regexpString) {
+  this.regexp = eval(regexpString);
+  this.matches = function(actual) {
+    return this.regexp.test(actual);
+  };
+};

data/lib/webrat/selenium/selenium_session.rb

@@ -0,0 +1,237 @@
+require "webrat/core/save_and_open_page"
+
+module Webrat
+  class TimeoutError < WebratError
+  end
+
+  class SeleniumResponse
+    attr_reader :body
+    attr_reader :session
+
+    def initialize(session, body)
+      @session = session
+      @body = body
+    end
+
+    def selenium
+      session.selenium
+    end
+  end
+
+  class SeleniumSession
+    include Webrat::SaveAndOpenPage
+
+    def initialize(*args) # :nodoc:
+    end
+
+    def simulate
+    end
+
+    def automate
+      yield
+    end
+
+    def visit(url)
+      selenium.open(url)
+    end
+
+    webrat_deprecate :visits, :visit
+
+    def fill_in(field_identifier, options)
+      locator = "webrat=#{Regexp.escape(field_identifier)}"
+      selenium.wait_for_element locator, 5
+      selenium.type(locator, "#{options[:with]}")
+    end
+
+    webrat_deprecate :fills_in, :fill_in
+
+    def response
+      SeleniumResponse.new(self, response_body)
+    end
+
+    def response_body #:nodoc:
+      selenium.get_html_source
+    end
+
+    def click_button(button_text_or_regexp = nil, options = {})
+      if button_text_or_regexp.is_a?(Hash) && options == {}
+        pattern, options = nil, button_text_or_regexp
+      elsif button_text_or_regexp
+        pattern = adjust_if_regexp(button_text_or_regexp)
+      end
+      pattern ||= '*'
+      locator = "button=#{pattern}"
+
+      selenium.wait_for_element locator, 5
+      selenium.click locator
+    end
+
+    webrat_deprecate :clicks_button, :click_button
+
+    def click_link(link_text_or_regexp, options = {})
+      pattern = adjust_if_regexp(link_text_or_regexp)
+      locator = "webratlink=#{pattern}"
+      selenium.wait_for_element locator, 5
+      selenium.click locator
+    end
+
+    webrat_deprecate :clicks_link, :click_link
+
+    def click_link_within(selector, link_text, options = {})
+      locator = "webratlinkwithin=#{selector}|#{link_text}"
+      selenium.wait_for_element locator, 5
+      selenium.click locator
+    end
+
+    webrat_deprecate :clicks_link_within, :click_link_within
+
+    def select(option_text, options = {})
+      id_or_name_or_label = options[:from]
+
+      if id_or_name_or_label
+        select_locator = "webrat=#{id_or_name_or_label}"
+      else
+        select_locator = "webratselectwithoption=#{option_text}"
+      end
+
+      selenium.wait_for_element select_locator, 5
+      selenium.select(select_locator, option_text)
+    end
+
+    webrat_deprecate :selects, :select
+
+    def choose(label_text)
+      locator = "webrat=#{label_text}"
+      selenium.wait_for_element locator, 5
+      selenium.click locator
+    end
+
+    webrat_deprecate :chooses, :choose
+
+    def check(label_text)
+      locator = "webrat=#{label_text}"
+      selenium.wait_for_element locator, 5
+      selenium.click locator
+    end
+    alias_method :uncheck, :check
+
+    webrat_deprecate :checks, :check
+
+    def fire_event(field_identifier, event)
+      locator = "webrat=#{Regexp.escape(field_identifier)}"
+      selenium.fire_event(locator, "#{event}")
+    end
+
+    def key_down(field_identifier, key_code)
+      locator = "webrat=#{Regexp.escape(field_identifier)}"
+      selenium.key_down(locator, key_code)
+    end
+
+    def key_up(field_identifier, key_code)
+      locator = "webrat=#{Regexp.escape(field_identifier)}"
+      selenium.key_up(locator, key_code)
+    end
+
+    def wait_for(params={})
+      timeout = params[:timeout] || 5
+      message = params[:message] || "Timeout exceeded"
+
+      begin_time = Time.now
+
+      while (Time.now - begin_time) < timeout
+        value = nil
+
+        begin
+          value = yield
+        rescue ::Spec::Expectations::ExpectationNotMetError, ::Selenium::CommandError, Webrat::WebratError
+          value = nil
+        end
+
+        return value if value
+
+        sleep 0.25
+      end
+
+      raise Webrat::TimeoutError.new(message + " (after #{timeout} sec)")
+      true
+    end
+
+    def selenium
+      return $browser if $browser
+      setup
+      $browser
+    end
+
+    webrat_deprecate :browser, :selenium
+
+
+    def save_and_open_screengrab
+      return unless File.exist?(saved_page_dir)
+
+      filename = "#{saved_page_dir}/webrat-#{Time.now.to_i}.png"
+
+      if $browser.chrome_backend?
+        $browser.capture_entire_page_screenshot(filename, '')
+      else
+        $browser.capture_screenshot(filename)
+      end
+        open_in_browser(filename)
+    end
+
+  protected
+
+    def setup #:nodoc:
+      silence_stream(STDOUT) do
+        Webrat.start_selenium_server
+        Webrat.start_app_server
+      end
+
+      create_browser
+      $browser.start
+      teardown_at_exit
+
+      extend_selenium
+      define_location_strategies
+      $browser.window_maximize
+    end
+
+
+    def create_browser
+      $browser = ::Selenium::Client::Driver.new(Webrat.configuration.selenium_server_address || "localhost",
+          Webrat.configuration.selenium_server_port, Webrat.configuration.selenium_browser_key, "http://#{Webrat.configuration.application_address}:#{Webrat.configuration.application_port}")
+      $browser.set_speed(0) unless Webrat.configuration.selenium_server_address
+    end
+
+    def teardown_at_exit #:nodoc:
+      at_exit do
+        silence_stream(STDOUT) do
+          $browser.stop
+          Webrat.stop_app_server
+          Webrat.stop_selenium_server
+        end
+      end
+    end
+
+    def adjust_if_regexp(text_or_regexp) #:nodoc:
+      if text_or_regexp.is_a?(Regexp)
+        "evalregex:#{text_or_regexp.inspect}"
+      else
+        "evalregex:/#{text_or_regexp}/"
+      end
+    end
+
+    def extend_selenium #:nodoc:
+      extensions_file = File.join(File.dirname(__FILE__), "selenium_extensions.js")
+      extenions_js = File.read(extensions_file)
+      selenium.get_eval(extenions_js)
+    end
+
+    def define_location_strategies #:nodoc:
+      Dir[File.join(File.dirname(__FILE__), "location_strategy_javascript", "*.js")].sort.each do |file|
+        strategy_js = File.read(file)
+        strategy_name = File.basename(file, '.js')
+        selenium.add_location_strategy(strategy_name, strategy_js)
+      end
+    end
+  end
+end