mkuklis-webrat 0.5.1

data/lib/webrat/core/session.rb

@@ -0,0 +1,306 @@
+require "forwardable"
+require "ostruct"
+
+require "webrat/core/mime"
+require "webrat/core/save_and_open_page"
+
+module Webrat
+  # A page load or form submission returned an unsuccessful response code (500-599)
+  class PageLoadError < WebratError
+  end
+
+  class InfiniteRedirectError < WebratError
+  end
+
+  def self.session_class
+    if Webrat.configuration.mode == :selenium
+      SeleniumSession
+    else
+      Session
+    end
+  end
+
+  def self.adapter_class
+    case Webrat.configuration.mode
+    when :rails
+      RailsAdapter
+    when :merb
+      MerbAdapter
+    when :rack
+      RackAdapter
+    when :rack_test
+      warn("The :rack_test mode is deprecated. Please use :rack instead")
+      require "webrat/rack"
+      RackAdapter
+    when :sinatra
+      warn("The :sinatra mode is deprecated. Please use :rack instead")
+      SinatraAdapter
+    when :mechanize
+      MechanizeAdapter
+    else
+      raise WebratError.new(<<-STR)
+Unknown Webrat mode: #{Webrat.configuration.mode.inspect}
+
+Please ensure you have a Webrat configuration block that specifies a mode
+in your test_helper.rb, spec_helper.rb, or env.rb (for Cucumber).
+
+This configure block supercedes the need to require "webrat/<framework>".
+
+For example:
+
+  Webrat.configure do |config|
+    config.mode = :rails
+  end
+      STR
+    end
+  end
+
+  class Session
+    extend Forwardable
+    include Logging
+    include SaveAndOpenPage
+
+    attr_accessor :adapter
+
+    attr_reader :current_url
+    attr_reader :elements
+
+    def_delegators :@adapter, :response, :response_code, :response_body,
+      :response_body=, :response_code=,
+      :get, :post, :put, :delete
+
+    def initialize(adapter = nil)
+      @adapter         = adapter
+      @http_method     = :get
+      @data            = {}
+      @default_headers = {}
+      @custom_headers  = {}
+      reset
+    end
+
+    def current_dom #:nodoc:
+      current_scope.dom
+    end
+
+    # For backwards compatibility -- removing in 1.0
+    def current_page #:nodoc:
+      warn "current_page is deprecated and will be going away in the next release. Use current_url instead."
+      page = OpenStruct.new
+      page.url = @current_url
+      page.http_method = @http_method
+      page.data = @data
+      page
+    end
+
+    def doc_root #:nodoc:
+      nil
+    end
+
+    def header(key, value)
+      @custom_headers[key] = value
+    end
+
+    def http_accept(mime_type)
+      header('Accept', Webrat::MIME.mime_type(mime_type))
+    end
+
+    def basic_auth(user, pass)
+      encoded_login = ["#{user}:#{pass}"].pack("m*")
+      header('HTTP_AUTHORIZATION', "Basic #{encoded_login}")
+    end
+
+    def headers #:nodoc:
+      @default_headers.dup.merge(@custom_headers.dup)
+    end
+
+    def request_page(url, http_method, data) #:nodoc:
+      h = headers
+      h['HTTP_REFERER'] = @current_url if @current_url
+
+      debug_log "REQUESTING PAGE: #{http_method.to_s.upcase} #{url} with #{data.inspect} and HTTP headers #{h.inspect}"
+
+      process_request(http_method, url, data, h)
+
+      save_and_open_page if exception_caught? && Webrat.configuration.open_error_files?
+      raise PageLoadError.new("Page load was not successful (Code: #{response_code.inspect}):\n#{formatted_error}") unless success_code?
+
+      reset
+
+      @current_url  = url
+      @http_method  = http_method
+      @data         = data
+
+      if internal_redirect?
+        check_for_infinite_redirects
+        request_page(response_location, :get, {})
+      end
+
+      return response
+    end
+
+    def check_for_infinite_redirects
+      if current_url == response_location
+        @_identical_redirect_count ||= 0
+        @_identical_redirect_count += 1
+      end
+
+      if infinite_redirect_limit_exceeded?
+        raise InfiniteRedirectError.new("#{Webrat.configuration.infinite_redirect_limit} redirects to the same URL (#{current_url.inspect})")
+      end
+    end
+
+    def infinite_redirect_limit_exceeded?
+       Webrat.configuration.infinite_redirect_limit &&
+       (@_identical_redirect_count || 0) > Webrat.configuration.infinite_redirect_limit
+    end
+
+    def success_code? #:nodoc:
+      (200..499).include?(response_code)
+    end
+
+    def redirect? #:nodoc:
+      (response_code / 100).to_i == 3
+    end
+
+    def internal_redirect?
+      return false unless redirect?
+      #should keep internal_redirects if the subdomain changes
+      current_host_domain = current_host.split('.')[-2..-1].join('.') rescue current_host
+      response_location_host_domain = response_location_host.split('.')[-2..-1].join('.') rescue response_location_host
+      current_host_domain == response_location_host_domain
+    end
+
+    #easy helper to pull out where we were redirected to
+    def redirected_to
+      redirect? ? response_location : nil
+    end
+
+    def exception_caught? #:nodoc:
+      response_body =~ /Exception caught/
+    end
+
+    def current_scope #:nodoc:
+      scopes.last || page_scope
+    end
+
+    # Reloads the last page requested. Note that this will resubmit forms
+    # and their data.
+    def reload
+      request_page(@current_url, @http_method, @data)
+    end
+
+    webrat_deprecate :reloads, :reload
+
+
+    # Works like click_link, but only looks for the link text within a given selector
+    #
+    # Example:
+    #   click_link_within "#user_12", "Vote"
+    def click_link_within(selector, link_text)
+      within(selector) do
+        click_link(link_text)
+      end
+    end
+
+    webrat_deprecate :clicks_link_within, :click_link_within
+
+    def within(selector)
+      scopes.push(Scope.from_scope(self, current_scope, selector))
+      ret = yield(current_scope)
+      scopes.pop
+      return ret
+    end
+
+    # Issues a GET request for a page, follows any redirects, and verifies the final page
+    # load was successful.
+    #
+    # Example:
+    #   visit "/"
+    def visit(url = nil, http_method = :get, data = {})
+      request_page(url, http_method, data)
+    end
+
+    webrat_deprecate :visits, :visit
+
+    # Subclasses can override this to show error messages without html
+    def formatted_error #:nodoc:
+      response_body
+    end
+
+    def scopes #:nodoc:
+      @_scopes ||= []
+    end
+
+    def page_scope #:nodoc:
+      @_page_scope ||= Scope.from_page(self, response, response_body)
+    end
+
+    def dom
+      page_scope.dom
+    end
+
+    def xml_content_type?
+      false
+    end
+
+    def simulate
+      return if Webrat.configuration.mode == :selenium
+      yield
+    end
+
+    def automate
+      return unless Webrat.configuration.mode == :selenium
+      yield
+    end
+
+    def_delegators :current_scope, :fill_in,            :fills_in
+    def_delegators :current_scope, :set_hidden_field
+    def_delegators :current_scope, :submit_form
+    def_delegators :current_scope, :check,              :checks
+    def_delegators :current_scope, :uncheck,            :unchecks
+    def_delegators :current_scope, :choose,             :chooses
+    def_delegators :current_scope, :select,             :selects
+    def_delegators :current_scope, :unselect,           :unselects
+    def_delegators :current_scope, :select_datetime,    :selects_datetime
+    def_delegators :current_scope, :select_date,        :selects_date
+    def_delegators :current_scope, :select_time,        :selects_time
+    def_delegators :current_scope, :attach_file,        :attaches_file
+    def_delegators :current_scope, :click_area,         :clicks_area
+    def_delegators :current_scope, :click_link,         :clicks_link
+    def_delegators :current_scope, :click_button,       :clicks_button
+    def_delegators :current_scope, :field_labeled
+    def_delegators :current_scope, :field_by_xpath
+    def_delegators :current_scope, :field_with_id
+    def_delegators :current_scope, :select_option
+    def_delegators :current_scope, :field_named
+
+  private
+
+    def process_request(http_method, url, data, headers)
+      if headers.empty?
+        send "#{http_method}", url, data || {}
+      else
+        send "#{http_method}", url, data || {}, headers
+      end
+    end
+
+    def response_location
+      response.headers["Location"]
+    end
+
+    def current_host
+      URI.parse(current_url).host || @custom_headers["Host"] || "www.example.com"
+    end
+
+    def response_location_host
+      URI.parse(response_location).host || "www.example.com"
+    end
+
+    def reset
+      @elements     = {}
+      @_scopes      = nil
+      @_page_scope  = nil
+    end
+
+  end
+end

data/lib/webrat/core/xml.rb

@@ -0,0 +1,72 @@
+require "webrat/core_extensions/meta_class"
+
+module Webrat #:nodoc:
+  module XML #:nodoc:
+
+    def self.document(stringlike) #:nodoc:
+      return stringlike.dom if stringlike.respond_to?(:dom)
+
+      if Nokogiri::HTML::Document === stringlike
+        stringlike
+      elsif Nokogiri::XML::NodeSet === stringlike
+        stringlike
+      elsif stringlike.respond_to?(:body)
+        Nokogiri::HTML(stringlike.body.to_s)
+      else
+        Nokogiri::HTML(stringlike.to_s)
+      end
+    end
+
+    def self.html_document(stringlike) #:nodoc:
+      return stringlike.dom if stringlike.respond_to?(:dom)
+
+      if Nokogiri::HTML::Document === stringlike
+        stringlike
+      elsif Nokogiri::XML::NodeSet === stringlike
+        stringlike
+      elsif stringlike.respond_to?(:body)
+        Nokogiri::HTML(stringlike.body.to_s)
+      else
+        Nokogiri::HTML(stringlike.to_s)
+      end
+    end
+
+    def self.xml_document(stringlike) #:nodoc:
+      return stringlike.dom if stringlike.respond_to?(:dom)
+
+      if Nokogiri::HTML::Document === stringlike
+        stringlike
+      elsif Nokogiri::XML::NodeSet === stringlike
+        stringlike
+      elsif stringlike.respond_to?(:body)
+        Nokogiri::XML(stringlike.body.to_s)
+      else
+        Nokogiri::XML(stringlike.to_s)
+      end
+    end
+
+    def self.define_dom_method(object, dom) #:nodoc:
+      object.meta_class.send(:define_method, :dom) do
+        dom
+      end
+    end
+
+  end
+end
+
+module Nokogiri #:nodoc:
+  module CSS #:nodoc:
+    class XPathVisitor #:nodoc:
+
+      def visit_pseudo_class_text(node) #:nodoc:
+        "@type='text'"
+      end
+
+      def visit_pseudo_class_password(node) #:nodoc:
+        "@type='password'"
+      end
+
+    end
+  end
+end
+

data/lib/webrat/core.rb

@@ -0,0 +1,13 @@
+require "webrat/core/configuration"
+require "webrat/core/xml"
+require "webrat/core/logging"
+require "webrat/core/elements/form"
+require "webrat/core/scope"
+require "webrat/core/elements/link"
+require "webrat/core/elements/area"
+require "webrat/core/elements/label"
+require "webrat/core/elements/select_option"
+require "webrat/core/session"
+require "webrat/core/methods"
+require "webrat/core/matchers"
+require "webrat/core/save_and_open_page"

data/lib/webrat/core_extensions/blank.rb

@@ -0,0 +1,58 @@
+class Object #:nodoc:
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, "", "   ", +nil+, [], and {} are blank.
+  #
+  # This simplifies
+  #
+  #   if !address.nil? && !address.empty?
+  #
+  # to
+  #
+  #   if !address.blank?
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  def present?
+    !blank?
+  end
+end
+
+class NilClass #:nodoc:
+  def blank?
+    true
+  end
+end
+
+class FalseClass #:nodoc:
+  def blank?
+    true
+  end
+end
+
+class TrueClass #:nodoc:
+  def blank?
+    false
+  end
+end
+
+class Array #:nodoc:
+  alias_method :blank?, :empty?
+end
+
+class Hash #:nodoc:
+  alias_method :blank?, :empty?
+end
+
+class String #:nodoc:
+  def blank?
+    self !~ /\S/
+  end
+end
+
+class Numeric #:nodoc:
+  def blank?
+    false
+  end
+end

data/lib/webrat/core_extensions/deprecate.rb

@@ -0,0 +1,8 @@
+class Module #:nodoc:
+  def webrat_deprecate(old_method_name, new_method_name)
+    define_method old_method_name do |*args|
+      warn "#{old_method_name} is deprecated. Use #{new_method_name} instead."
+      __send__(new_method_name, *args)
+    end
+  end
+end

data/lib/webrat/core_extensions/detect_mapped.rb

@@ -0,0 +1,12 @@
+class Array #:nodoc:
+
+  def detect_mapped
+    each do |element|
+      result = yield element
+      return result if result
+    end
+
+    return nil
+  end
+
+end

data/lib/webrat/core_extensions/meta_class.rb

@@ -0,0 +1,6 @@
+class ::Object #:nodoc:
+  def meta_class
+    class << self; self end
+  end
+end
+

data/lib/webrat/core_extensions/nil_to_param.rb

@@ -0,0 +1,5 @@
+class NilClass #:nodoc:
+  def to_param
+    nil
+  end
+end

data/lib/webrat/core_extensions/tcp_socket.rb

@@ -0,0 +1,27 @@
+class TCPSocket
+
+  def self.wait_for_service_with_timeout(options)
+    start_time = Time.now
+
+    until listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not open within #{options[:timeout]} seconds")
+      end
+    end
+  end
+
+  def self.wait_for_service_termination_with_timeout(options)
+    start_time = Time.now
+
+    while listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not terminate within #{options[:timeout]} seconds")
+      end
+    end
+  end
+
+end

data/lib/webrat/integrations/merb.rb

@@ -0,0 +1,10 @@
+module Merb #:nodoc:
+  module Test #:nodoc:
+    module RequestHelper #:nodoc:
+      def request(uri, env = {})
+        @_webrat_session ||= Webrat::MerbAdapter.new
+        @_webrat_session.response = @_webrat_session.request(uri, env)
+      end
+    end
+  end
+end

data/lib/webrat/integrations/rails.rb

@@ -0,0 +1,25 @@
+require "action_controller"
+require "action_controller/integration"
+
+module ActionController #:nodoc:
+  IntegrationTest.class_eval do
+    include Webrat::Methods
+    include Webrat::Matchers
+
+    # The Rails version of within supports passing in a model and Webrat
+    # will apply a scope based on Rails' dom_id for that model.
+    #
+    # Example:
+    #   within User.last do
+    #     click_link "Delete"
+    #   end
+    def within(selector_or_object, &block)
+      if selector_or_object.is_a?(String)
+        super
+      else
+        super('#' + RecordIdentifier.dom_id(selector_or_object), &block)
+      end
+    end
+
+  end
+end

data/lib/webrat/integrations/rspec-rails.rb

@@ -0,0 +1,10 @@
+# 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|
+  config.include(Webrat::Matchers, :type => [:controller, :helper, :view])
+end

data/lib/webrat/integrations/selenium.rb

@@ -0,0 +1,11 @@
+require "webrat/selenium"
+
+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/merb.rb

@@ -0,0 +1,9 @@
+require "webrat"
+
+# This is a temporary hack to support backwards compatibility
+# with Merb 1.0.8 until it's updated to use the new Webrat.configure
+# syntax
+
+Webrat.configure do |config|
+  config.mode = :merb
+end

data/lib/webrat/rspec-rails.rb

@@ -0,0 +1,2 @@
+warn("Requiring 'webrat/rspec-rails' is deprecated. Please require 'webrat/integrations/rspec-rails' instead")
+require "webrat/integrations/rspec-rails"

data/lib/webrat/selenium/application_server_factory.rb

@@ -0,0 +1,40 @@
+module Webrat
+  module Selenium
+
+    class ApplicationServerFactory
+
+      def self.app_server_instance
+        case Webrat.configuration.application_framework
+        when :sinatra
+          require "webrat/selenium/application_servers/sinatra"
+          return Webrat::Selenium::ApplicationServers::Sinatra.new
+        when :merb
+          require "webrat/selenium/application_servers/merb"
+          return Webrat::Selenium::ApplicationServers::Merb.new
+        when :rails
+          require "webrat/selenium/application_servers/rails"
+          return Webrat::Selenium::ApplicationServers::Rails.new
+        when :external
+          require "webrat/selenium/application_servers/external"
+          return Webrat::Selenium::ApplicationServers::External.new
+        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
+
+    end
+
+  end
+end

data/lib/webrat/selenium/application_servers/base.rb

@@ -0,0 +1,54 @@
+require "webrat/selenium/silence_stream"
+require "selenium/client"
+module Webrat
+  module Selenium
+    module ApplicationServers
+      class Base
+        include Webrat::Selenium::SilenceStream
+        
+        def initialize
+          @shell = Nautilus::Shell.new
+        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     => "127.0.0.1",
+              :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
+        
+        def windows?
+          RUBY_PLATFORM =~ /mswin/
+        end
+
+      end
+    end
+  end
+end