auxesis-webrat 0.4.1

data/lib/webrat/rspec-rails.rb

@@ -0,0 +1,13 @@
+# Supports using the matchers in controller, helper, and view specs if you're
+# using rspec-rails. Just add a require statement to spec/spec_helper.rb or env.rb:
+# 
+#   require 'webrat/rspec-rails'
+#
+require "webrat/core/matchers"
+
+Spec::Runner.configure do |config|
+  # rspec should support :type => [:controller, :helper, :view] - but until it does ...
+  config.include(Webrat::Matchers, :type => :controller)
+  config.include(Webrat::Matchers, :type => :helper)
+  config.include(Webrat::Matchers, :type => :view)
+end

data/lib/webrat/selenium.rb

@@ -0,0 +1,99 @@
+require "webrat"
+gem "selenium-client", ">=1.2.9"
+require "selenium/client"
+require "webrat/selenium/selenium_session"
+require "webrat/selenium/matchers"
+
+module Webrat
+
+  def self.with_selenium_server #:nodoc:
+    start_selenium_server
+    yield
+    stop_selenium_server
+  end
+
+  def self.start_selenium_server #:nodoc:
+    unless Webrat.configuration.selenium_server_address
+      remote_control = ::Selenium::RemoteControl::RemoteControl.new("0.0.0.0", Webrat.configuration.selenium_server_port, 5)
+      remote_control.jar_file = File.expand_path(__FILE__ + "../../../../vendor/selenium-server.jar")
+      remote_control.start :background => true
+    end
+    TCPSocket.wait_for_service :host => (Webrat.configuration.selenium_server_address || "0.0.0.0"), :port => Webrat.configuration.selenium_server_port
+  end
+
+  def self.stop_selenium_server #:nodoc:
+    ::Selenium::RemoteControl::RemoteControl.new("0.0.0.0", Webrat.configuration.selenium_server_port, 5).stop unless Webrat.configuration.selenium_server_address
+  end
+
+  def self.start_app_server #:nodoc:
+    pid_file = prepare_pid_file("#{RAILS_ROOT}/tmp/pids", "mongrel_selenium.pid")
+    system("mongrel_rails start -d --chdir=#{RAILS_ROOT} --port=#{Webrat.configuration.application_port} --environment=#{Webrat.configuration.application_environment} --pid #{pid_file} &")
+    TCPSocket.wait_for_service :host => Webrat.configuration.application_address, :port => Webrat.configuration.application_port.to_i
+  end
+
+  def self.stop_app_server #:nodoc:
+    pid_file = File.expand_path(RAILS_ROOT + "/tmp/pids/mongrel_selenium.pid")
+    system "mongrel_rails stop -c #{RAILS_ROOT} --pid #{pid_file}"
+  end
+
+  def self.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
+
+  # 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
+  #
+  # == Auto-starting of the mongrel 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 3001.
+  #
+  # == 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
+
+module ActionController #:nodoc:
+  IntegrationTest.class_eval do
+    include Webrat::Methods
+    include Webrat::Selenium::Methods
+    include Webrat::Selenium::Matchers
+  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/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

data/lib/webrat/sinatra.rb

@@ -0,0 +1,30 @@
+require 'webrat/rack'
+require 'sinatra'
+require 'sinatra/test'
+
+class Sinatra::Application
+  # Override this to prevent Sinatra from barfing on the options passed from RSpec
+  def self.load_default_options_from_command_line!
+  end
+end
+
+disable :run
+disable :reload
+
+module Webrat
+  class SinatraSession < RackSession #:nodoc:
+    include Sinatra::Test
+
+    attr_reader :request, :response
+
+    %w(get head post put delete).each do |verb|
+      alias_method "orig_#{verb}", verb
+      define_method(verb) do |*args| # (path, data, headers = nil)
+        path, data, headers = *args
+        data = data.inject({}) {|data, (key,value)| data[key] = Rack::Utils.unescape(value); data }
+        params = data.merge(:env => headers || {})
+        self.__send__("orig_#{verb}", path, params)
+      end
+    end
+  end
+end