kbaum-webrat 0.5.1

data/lib/webrat/core/configuration.rb

@@ -0,0 +1,96 @@
+require "webrat/core_extensions/deprecate"
+
+module Webrat
+
+  # Configures Webrat. If this is not done, Webrat will be created
+  # with all of the default settings.
+  def self.configure(configuration = Webrat.configuration)
+    yield configuration if block_given?
+    @@configuration = configuration
+  end
+
+  def self.configuration # :nodoc:
+    @@configuration ||= Webrat::Configuration.new
+  end
+
+  # Webrat can be configured using the Webrat.configure method. For example:
+  #
+  #   Webrat.configure do |config|
+  #     config.mode = :sinatra
+  #   end
+  class Configuration
+
+    # Webrat's mode, set automatically when requiring webrat/rails, webrat/merb, etc.
+    attr_reader :mode # :nodoc:
+
+    # Save and open pages with error status codes (500-599) in a browser? Defualts to true.
+    attr_writer :open_error_files
+
+    # Which rails environment should the selenium tests be run in? Defaults to selenium.
+    attr_accessor :application_environment
+    webrat_deprecate :selenium_environment, :application_environment
+    webrat_deprecate :selenium_environment=, :application_environment=
+
+    # Which port is the application running on for selenium testing? Defaults to 3001.
+    attr_accessor :application_port
+    webrat_deprecate :selenium_port, :application_port
+    webrat_deprecate :selenium_port=, :application_port=
+
+    # Which underlying app framework we're testing with selenium
+    attr_accessor :application_framework
+
+    # Which server the application is running on for selenium testing? Defaults to localhost
+    attr_accessor :application_address
+
+    # Which server Selenium server is running on. Defaults to nil(server starts in webrat process and runs locally)
+    attr_accessor :selenium_server_address
+
+    # Which server Selenium port is running on. Defaults to 4444
+    attr_accessor :selenium_server_port
+
+    # Set the key that Selenium uses to determine the browser running. Default *firefox
+    attr_accessor :selenium_browser_key
+
+    # Set the timeout for waiting for the browser process to start
+    attr_accessor :selenium_browser_startup_timeout
+
+    # Set the selenium wait general response wait time
+    attr_accessor :selenium_response_wait_time
+
+    # How many redirects to the same URL should be halted as an infinite redirect
+    # loop? Defaults to 10
+    attr_accessor :infinite_redirect_limit
+
+    def initialize # :nodoc:
+      self.open_error_files = true
+      self.application_environment = :test
+      self.application_port = 3001
+      self.application_address = 'localhost'
+      self.application_framework = :rails
+      self.selenium_server_port = 4444
+      self.infinite_redirect_limit = 10
+      self.selenium_browser_key = '*firefox'
+      self.selenium_browser_startup_timeout = 5
+      self.selenium_response_wait_time = 5
+    end
+
+    def open_error_files? #:nodoc:
+      @open_error_files ? true : false
+    end
+
+    # Allows setting of webrat's mode, valid modes are:
+    # :rails, :selenium, :rack, :sinatra, :mechanize, :merb
+    def mode=(mode)
+      @mode = mode.to_sym
+
+      begin
+        require("webrat/integrations/#{mode}")
+      rescue LoadError
+        # Only some modes have integration code that needs to
+        # be loaded, so this is OK
+      end
+    end
+
+  end
+
+end

data/lib/webrat/core/elements/area.rb

@@ -0,0 +1,31 @@
+require "webrat/core/elements/element"
+
+module Webrat
+  class Area < Element #:nodoc:
+
+    def self.xpath_search
+      [".//area"]
+    end
+
+    def click(method = nil, options = {})
+      @session.request_page(absolute_href, :get, {})
+    end
+
+  protected
+
+    def href
+      @element["href"]
+    end
+
+    def absolute_href
+      if href =~ /^\?/
+        "#{@session.current_url}#{href}"
+      elsif href !~ %r{^https?://[\w|.]+(/.*)} && (href !~ /^\//)
+        "#{@session.current_url}/#{href}"
+      else
+        href
+      end
+    end
+
+  end
+end

data/lib/webrat/core/elements/element.rb

@@ -0,0 +1,33 @@
+module Webrat
+
+  class Element # :nodoc:
+
+    def self.load_all(session, dom)
+      dom.xpath(*xpath_search).map do |element|
+        load(session, element)
+      end
+    end
+
+    def self.load(session, element)
+      return nil if element.nil?
+      session.elements[element.path] ||= self.new(session, element)
+    end
+
+    attr_reader :element
+
+    def initialize(session, element)
+      @session  = session
+      @element  = element
+    end
+
+    def path
+      @element.path
+    end
+
+    def inspect
+      "#<#{self.class} @element=#{element.inspect}>"
+    end
+
+  end
+
+end

data/lib/webrat/core/elements/field.rb

@@ -0,0 +1,487 @@
+require "cgi"
+require "webrat/core_extensions/blank"
+require "webrat/core_extensions/nil_to_param"
+
+require "webrat/core/elements/element"
+
+module Webrat
+  # Raised when Webrat is asked to manipulate a disabled form field
+  class DisabledFieldError < WebratError
+  end
+
+  class Field < Element #:nodoc:
+    attr_reader :value
+
+    def self.xpath_search
+      [".//button", ".//input", ".//textarea", ".//select"]
+    end
+
+    def self.xpath_search_excluding_hidden
+      [".//button", ".//input[ @type != 'hidden']", ".//textarea", ".//select"]
+    end
+
+    def self.field_classes
+      @field_classes || []
+    end
+
+    def self.inherited(klass)
+      @field_classes ||= []
+      @field_classes << klass
+      # raise args.inspect
+    end
+
+    def self.load(session, element)
+      return nil if element.nil?
+      session.elements[element.path] ||= field_class(element).new(session, element)
+    end
+
+    def self.field_class(element)
+      case element.name
+      when "button"   then ButtonField
+      when "select"
+        if element.attributes["multiple"].nil?
+          SelectField
+        else
+          MultipleSelectField
+        end
+      when "textarea" then TextareaField
+      else
+        case element["type"]
+        when "checkbox" then CheckboxField
+        when "hidden"   then HiddenField
+        when "radio"    then RadioField
+        when "password" then PasswordField
+        when "file"     then FileField
+        when "reset"    then ResetField
+        when "submit"   then ButtonField
+        when "button"   then ButtonField
+        when "image"    then ButtonField
+        else  TextField
+        end
+      end
+    end
+
+    def initialize(*args)
+      super
+      @value = default_value
+    end
+
+    def label_text
+      return nil if labels.empty?
+      labels.first.text
+    end
+
+    def id
+      @element["id"]
+    end
+
+    def disabled?
+      @element.attributes.has_key?("disabled") && @element["disabled"] != 'false'
+    end
+
+    def raise_error_if_disabled
+      return unless disabled?
+      raise DisabledFieldError.new("Cannot interact with disabled form element (#{self})")
+    end
+
+    def to_param
+      return nil if disabled?
+
+      params = case Webrat.configuration.mode
+      when :rails
+        parse_rails_request_params("#{name}=#{escaped_value}")
+      when :merb
+        ::Merb::Parse.query("#{name}=#{escaped_value}")
+      else
+        { name => [*@value].first.to_s }
+      end
+
+      unescape_params(params)
+    end
+
+    def set(value)
+      @value = value
+    end
+
+    def unset
+      @value = default_value
+    end
+
+  protected
+
+    def parse_rails_request_params(params)
+      if defined?(ActionController::AbstractRequest)
+        ActionController::AbstractRequest.parse_query_parameters(params)
+      elsif defined?(ActionController::UrlEncodedPairParser)
+        # For Rails > 2.2
+        ActionController::UrlEncodedPairParser.parse_query_parameters(params)
+      else
+        # For Rails > 2.3
+        Rack::Utils.parse_nested_query(params)
+      end
+    end
+
+    def form
+      Form.load(@session, form_element)
+    end
+
+    def form_element
+      parent = @element.parent
+
+      while parent.respond_to?(:parent)
+        return parent if parent.name == 'form'
+        parent = parent.parent
+      end
+    end
+
+    def name
+      @element["name"]
+    end
+
+    def escaped_value
+      CGI.escape(@value.to_s)
+    end
+
+    # Because we have to escape it before sending it to the above case statement,
+    # we have to make sure we unescape each value when it gets back so assertions
+    # involving characters like <, >, and &  work as expected
+    def unescape_params(params)
+      case params.class.name
+      when 'Hash', 'Mash'
+        params.each { |key,value| params[key] = unescape_params(value) }
+        params
+      when 'Array'
+        params.collect { |value| unescape_params(value) }
+      else
+        CGI.unescapeHTML(params)
+      end
+    end
+
+    def labels
+      @labels ||= label_elements.map do |element|
+        Label.load(@session, element)
+      end
+    end
+
+    def label_elements
+      return @label_elements unless @label_elements.nil?
+      @label_elements = []
+
+      parent = @element.parent
+      while parent.respond_to?(:parent)
+        if parent.name == 'label'
+          @label_elements.push parent
+          break
+        end
+        parent = parent.parent
+      end
+
+      unless id.blank?
+        @label_elements += form.element.xpath(".//label[@for = '#{id}']")
+      end
+
+      @label_elements
+    end
+
+    def default_value
+      @element["value"]
+    end
+
+    def replace_param_value(params, oval, nval)
+      output = Hash.new
+      params.each do |key, value|
+        case value
+        when Hash
+          value = replace_param_value(value, oval, nval)
+        when Array
+          value = value.map { |o| o == oval ? nval : oval }
+        when oval
+          value = nval
+        end
+        output[key] = value
+      end
+      output
+    end
+  end
+
+  class ButtonField < Field #:nodoc:
+
+    def self.xpath_search
+      [".//button", ".//input[@type = 'submit']", ".//input[@type = 'button']", ".//input[@type = 'image']"]
+    end
+
+    def to_param
+      return nil if @value.nil?
+      super
+    end
+
+    def default_value
+      nil
+    end
+
+    def click
+      raise_error_if_disabled
+      set(@element["value"]) unless @element["name"].blank?
+      form.submit
+    end
+
+  end
+
+  class HiddenField < Field #:nodoc:
+
+    def self.xpath_search
+      ".//input[@type = 'hidden']"
+    end
+
+    def to_param
+      if collection_name?
+        super
+      else
+        checkbox_with_same_name = form.field_named(name, CheckboxField)
+
+        if checkbox_with_same_name.to_param.blank?
+          super
+        else
+          nil
+        end
+      end
+    end
+
+  protected
+
+    def collection_name?
+      name =~ /\[\]/
+    end
+
+  end
+
+  class CheckboxField < Field #:nodoc:
+
+    def self.xpath_search
+      ".//input[@type = 'checkbox']"
+    end
+
+    def to_param
+      return nil if @value.nil?
+      super
+    end
+
+    def check
+      raise_error_if_disabled
+      set(@element["value"] || "on")
+    end
+
+    def checked?
+      @element["checked"] == "checked"
+    end
+
+    def uncheck
+      raise_error_if_disabled
+      set(nil)
+    end
+
+  protected
+
+    def default_value
+      if @element["checked"] == "checked"
+        @element["value"] || "on"
+      else
+        nil
+      end
+    end
+
+  end
+
+  class PasswordField < Field #:nodoc:
+
+    def self.xpath_search
+      ".//input[@type = 'password']"
+    end
+
+  end
+
+  class RadioField < Field #:nodoc:
+
+    def self.xpath_search
+      ".//input[@type = 'radio']"
+    end
+
+    def to_param
+      return nil if @value.nil?
+      super
+    end
+
+    def choose
+      raise_error_if_disabled
+      other_options.each do |option|
+        option.set(nil)
+      end
+
+      set(@element["value"] || "on")
+    end
+
+    def checked?
+      @element["checked"] == "checked"
+    end
+
+  protected
+
+    def other_options
+      form.fields.select { |f| f.name == name }
+    end
+
+    def default_value
+      if @element["checked"] == "checked"
+        @element["value"] || "on"
+      else
+        nil
+      end
+    end
+
+  end
+
+  class TextareaField < Field #:nodoc:
+
+    def self.xpath_search
+      ".//textarea"
+    end
+
+  protected
+
+    def default_value
+      @element.inner_html
+    end
+
+  end
+
+  class FileField < Field #:nodoc:
+
+    def self.xpath_search
+      ".//input[@type = 'file']"
+    end
+
+    attr_accessor :content_type
+
+    def set(value, content_type = nil)
+      super(value)
+      @content_type = content_type
+    end
+
+    def to_param
+      if @value.nil?
+        super
+      else
+        replace_param_value(super, @value, test_uploaded_file)
+      end
+    end
+
+  protected
+
+    def test_uploaded_file
+      case Webrat.configuration.mode
+      when :rails
+        if content_type
+          ActionController::TestUploadedFile.new(@value, content_type)
+        else
+          ActionController::TestUploadedFile.new(@value)
+        end
+      when :rack, :merb
+        Rack::Test::UploadedFile.new(@value, content_type)
+      end
+    end
+
+  end
+
+  class TextField < Field #:nodoc:
+    def self.xpath_search
+      [".//input[@type = 'text']", ".//input[not(@type)]"]
+    end
+  end
+
+  class ResetField < Field #:nodoc:
+    def self.xpath_search
+      [".//input[@type = 'reset']"]
+    end
+  end
+
+  class SelectField < Field #:nodoc:
+
+    def self.xpath_search
+      [".//select[not(@multiple)]"]
+    end
+
+    def options
+      @options ||= SelectOption.load_all(@session, @element)
+    end
+
+    def unset(value)
+      @value = nil
+    end
+
+  protected
+
+    def default_value
+      selected_options = @element.xpath(".//option[@selected = 'selected']")
+      selected_options = @element.xpath(".//option[position() = 1]") if selected_options.empty?
+
+      selected_options.map do |option|
+        return "" if option.nil?
+        option["value"] || option.inner_html
+      end.uniq.first
+    end
+
+  end
+
+  class MultipleSelectField < Field #:nodoc:
+
+    def self.xpath_search
+      [".//select[@multiple='multiple']"]
+    end
+
+    def options
+      @options ||= SelectOption.load_all(@session, @element)
+    end
+
+    def set(value)
+      @value << value
+    end
+
+    def unset(value)
+      @value.delete(value)
+    end
+
+    # We have to overide how the uri string is formed when dealing with multiples
+    # Where normally a select field might produce   name=value   with a multiple,
+    # we need to form something like   name[]=value1&name[]=value2
+    def to_param
+      return nil if disabled?
+
+      uri_string = @value.collect {|value| "#{name}=#{CGI.escape(value)}"}.join("&")
+      params = case Webrat.configuration.mode
+      when :rails
+        parse_rails_request_params(uri_string)
+      when :merb
+        ::Merb::Parse.query(uri_string)
+      else
+        { name => @value }
+      end
+
+      unescape_params(params)
+    end
+
+  protected
+
+    # Overwrite SelectField definition because we don't want to select the first option
+    # (mutliples don't select the first option unlike their non multiple versions)
+    def default_value
+      selected_options = @element.xpath(".//option[@selected = 'selected']")
+
+      selected_options.map do |option|
+        return "" if option.nil?
+        option["value"] || option.inner_html
+      end.uniq
+    end
+
+  end
+
+end