jferris-webrat 0.4.3

data/lib/webrat/selenium/selenium_session.rb

@@ -0,0 +1,247 @@
+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, :timeout_in_seconds => 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, :timeout_in_seconds => 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, :timeout_in_seconds => 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, :timeout_in_seconds => 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, :timeout_in_seconds => 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, :timeout_in_seconds => 5
+      selenium.click locator
+    end
+
+    webrat_deprecate :chooses, :choose
+
+    def check(label_text)
+      locator = "webrat=#{label_text}"
+      selenium.wait_for_element locator, :timeout_in_seconds => 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 silence_stream(stream)
+      old_stream = stream.dup
+      stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
+      stream.sync = true
+      yield
+    ensure
+      stream.reopen(old_stream)
+    end
+
+    def setup #:nodoc:
+      silence_stream(STDOUT) do
+        silence_stream(STDERR) do
+          Webrat.start_selenium_server
+          Webrat.start_app_server
+        end
+      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/selenium.rb

@@ -0,0 +1,154 @@
+require "webrat"
+gem "selenium-client", ">=1.2.14"
+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.pid_file
+    if File.exists?('config.ru')
+      prepare_pid_file(Dir.pwd, 'rack.pid')
+    else
+      prepare_pid_file("#{RAILS_ROOT}/tmp/pids", "mongrel_selenium.pid")
+    end
+  end
+  # Start the appserver for the underlying framework to test
+  #
+  # Sinatra: requires a config.ru in the root of your sinatra app to use this
+  # Merb: Attempts to use bin/merb and falls back to the system merb
+  # Rails: Calls mongrel_rails to startup the appserver
+  def self.start_app_server
+    case Webrat.configuration.application_framework
+    when :sinatra
+      fork do
+        File.open('rack.pid', 'w') { |fp| fp.write Process.pid }
+        exec 'rackup', File.expand_path(Dir.pwd + '/config.ru'), '-p', Webrat.configuration.application_port.to_s
+      end
+    when :merb
+      cmd = 'merb'
+      if File.exist?('bin/merb')
+        cmd = 'bin/merb'
+      end
+      system("#{cmd} -d -p #{Webrat.configuration.application_port} -e #{Webrat.configuration.application_environment}")
+    else # rails
+      system("mongrel_rails start -d --chdir='#{RAILS_ROOT}' --port=#{Webrat.configuration.application_port} --environment=#{Webrat.configuration.application_environment} --pid #{pid_file} &")
+    end
+    TCPSocket.wait_for_service :host => Webrat.configuration.application_address, :port => Webrat.configuration.application_port.to_i
+  end
+
+  # Stop the appserver for the underlying framework under test
+  #
+  # Sinatra: Reads and kills the pid from the pid file created on startup
+  # Merb: Reads and kills the pid from the pid file created on startup
+  # Rails: Calls mongrel_rails stop to kill the appserver
+  def self.stop_app_server 
+    case Webrat.configuration.application_framework
+    when :sinatra
+      pid = File.read('rack.pid')
+      system("kill -9 #{pid}")
+      FileUtils.rm_f 'rack.pid'
+    when :merb
+      pid = File.read("log/merb.#{Webrat.configuration.application_port}.pid")
+      system("kill -9 #{pid}")
+      FileUtils.rm_f "log/merb.#{Webrat.configuration.application_port}.pid"
+    else # rails
+      system "mongrel_rails stop -c #{RAILS_ROOT} --pid #{pid_file}"
+    end
+  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
+  #
+  # == 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/sinatra.rb

@@ -0,0 +1,53 @@
+require "webrat/rack"
+require "sinatra/test"
+
+module Webrat
+  class SinatraSession < RackSession
+    include Sinatra::Test
+
+    attr_reader :request, :response
+
+    def initialize(context = nil)
+      super(context)
+
+      app = context.respond_to?(:app) ? context.app : Sinatra::Application
+      @browser = Sinatra::TestHarness.new(app)
+      @cookies = []
+    end
+
+    %w(get head post put delete).each do |verb|
+      class_eval <<-RUBY
+        def #{verb}(path, data, headers = {})
+          params = data.inject({}) do |data, (key,value)|
+            data[key] = Rack::Utils.unescape(value)
+            data
+          end
+          headers["HTTP_HOST"] = "www.example.com"
+          headers["HTTP_COOKIE"] = @cookies.join(',')
+          @browser.#{verb}(path, params, headers)
+          set_cookies
+        end
+      RUBY
+    end
+
+    def response_body
+      @browser.body
+    end
+
+    def response_code
+      @browser.status
+    end
+
+    private
+
+      def set_cookies
+        if set_cookie = @browser.response.headers['Set-Cookie']
+          @cookies << set_cookie
+        end
+      end
+
+      def response
+        @browser.response
+      end
+  end
+end

data/lib/webrat.rb

@@ -0,0 +1,34 @@
+require "rubygems"
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Webrat
+  # The common base class for all exceptions raised by Webrat.
+  class WebratError < StandardError
+  end
+
+  VERSION = '0.4.3'
+
+  def self.require_xml
+    gem "nokogiri", ">= 1.0.6"
+    
+    if on_java?
+      # We need Nokogiri's CSS to XPath support, even if using REXML and Hpricot for parsing and searching
+      require "nokogiri/css"
+      require "hpricot"
+      require "rexml/document"
+    else
+      require "nokogiri"
+      require "webrat/core/xml/nokogiri"
+    end
+  end
+  
+  def self.on_java?
+    RUBY_PLATFORM =~ /java/
+  end
+  
+end
+
+Webrat.require_xml
+
+require "webrat/core"

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: jferris-webrat
+version: !ruby/object:Gem::Version 
+  version: 0.4.3
+platform: ruby
+authors: 
+- Bryan Helmkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-31 21:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+description: Webrat. Ruby Acceptance Testing for Web applications
+email: bryan@brynary.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE.txt
+files: 
+- History.txt
+- install.rb
+- MIT-LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/webrat
+- lib/webrat/core
+- lib/webrat/core/configuration.rb
+- lib/webrat/core/elements
+- lib/webrat/core/elements/area.rb
+- lib/webrat/core/elements/element.rb
+- lib/webrat/core/elements/field.rb
+- lib/webrat/core/elements/form.rb
+- lib/webrat/core/elements/label.rb
+- lib/webrat/core/elements/link.rb
+- lib/webrat/core/elements/select_option.rb
+- lib/webrat/core/locators
+- lib/webrat/core/locators/area_locator.rb
+- lib/webrat/core/locators/button_locator.rb
+- lib/webrat/core/locators/field_by_id_locator.rb
+- lib/webrat/core/locators/field_labeled_locator.rb
+- lib/webrat/core/locators/field_locator.rb
+- lib/webrat/core/locators/field_named_locator.rb
+- lib/webrat/core/locators/form_locator.rb
+- lib/webrat/core/locators/label_locator.rb
+- lib/webrat/core/locators/link_locator.rb
+- lib/webrat/core/locators/locator.rb
+- lib/webrat/core/locators/select_option_locator.rb
+- lib/webrat/core/locators.rb
+- lib/webrat/core/logging.rb
+- lib/webrat/core/matchers
+- lib/webrat/core/matchers/have_content.rb
+- lib/webrat/core/matchers/have_selector.rb
+- lib/webrat/core/matchers/have_tag.rb
+- lib/webrat/core/matchers/have_xpath.rb
+- lib/webrat/core/matchers.rb
+- lib/webrat/core/methods.rb
+- lib/webrat/core/mime.rb
+- lib/webrat/core/save_and_open_page.rb
+- lib/webrat/core/scope.rb
+- lib/webrat/core/session.rb
+- lib/webrat/core/xml
+- lib/webrat/core/xml/hpricot.rb
+- lib/webrat/core/xml/nokogiri.rb
+- lib/webrat/core/xml/rexml.rb
+- lib/webrat/core/xml.rb
+- lib/webrat/core.rb
+- lib/webrat/core_extensions
+- lib/webrat/core_extensions/blank.rb
+- lib/webrat/core_extensions/deprecate.rb
+- lib/webrat/core_extensions/detect_mapped.rb
+- lib/webrat/core_extensions/meta_class.rb
+- lib/webrat/core_extensions/nil_to_param.rb
+- lib/webrat/mechanize.rb
+- lib/webrat/merb.rb
+- lib/webrat/merb_session.rb
+- lib/webrat/rack.rb
+- lib/webrat/rails.rb
+- lib/webrat/rspec-rails.rb
+- lib/webrat/selenium
+- lib/webrat/selenium/location_strategy_javascript
+- lib/webrat/selenium/location_strategy_javascript/button.js
+- lib/webrat/selenium/location_strategy_javascript/label.js
+- lib/webrat/selenium/location_strategy_javascript/webrat.js
+- lib/webrat/selenium/location_strategy_javascript/webratlink.js
+- lib/webrat/selenium/location_strategy_javascript/webratlinkwithin.js
+- lib/webrat/selenium/location_strategy_javascript/webratselectwithoption.js
+- lib/webrat/selenium/matchers
+- lib/webrat/selenium/matchers/have_content.rb
+- lib/webrat/selenium/matchers/have_selector.rb
+- lib/webrat/selenium/matchers/have_tag.rb
+- lib/webrat/selenium/matchers/have_xpath.rb
+- lib/webrat/selenium/matchers.rb
+- lib/webrat/selenium/selenium_extensions.js
+- lib/webrat/selenium/selenium_session.rb
+- lib/webrat/selenium.rb
+- lib/webrat/sinatra.rb
+- lib/webrat.rb
+- vendor/selenium-server.jar
+has_rdoc: true
+homepage: http://github.com/brynary/webrat
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: webrat
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Webrat. Ruby Acceptance Testing for Web applications
+test_files: []
+