casebook-webrat 0.4.4.1

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

@@ -0,0 +1,103 @@
+require "webrat/core/elements/field"
+require "webrat/core_extensions/blank"
+
+require "webrat/core/elements/element"
+require "webrat/core/locators/field_named_locator"
+
+module Webrat
+  class Form < Element #:nodoc:
+    attr_reader :element
+
+    def self.xpath_search
+      ".//form"
+    end
+
+    def fields
+      @fields ||= Field.load_all(@session, @element)
+    end
+
+    def submit
+      @session.request_page(form_action, form_method, params)
+    end
+
+    def field_named(name, *field_types)
+      Webrat::Locators::FieldNamedLocator.new(@session, dom, name, *field_types).locate
+    end
+
+  protected
+
+    def dom
+      Webrat::XML.xpath_at(@session.dom, path)
+    end
+
+    def fields_by_type(field_types)
+      if field_types.any?
+        fields.select { |f| field_types.include?(f.class) }
+      else
+        fields
+      end
+    end
+
+    def params
+      all_params = {}
+
+      fields.each do |field|
+        next if field.to_param.nil?
+        merge(all_params, field.to_param)
+      end
+
+      all_params
+    end
+
+    def form_method
+      Webrat::XML.attribute(@element, "method").blank? ? :get : Webrat::XML.attribute(@element, "method").downcase
+    end
+
+    def form_action
+      Webrat::XML.attribute(@element, "action").blank? ? @session.current_url : Webrat::XML.attribute(@element, "action")
+    end
+
+    def merge(all_params, new_param)
+      new_param.each do |key, value|
+        case all_params[key]
+        when *hash_classes
+          merge_hash_values(all_params[key], value)
+        when Array
+          all_params[key] += value
+        else
+          all_params[key] = value
+        end
+      end
+    end
+
+    def merge_hash_values(a, b) # :nodoc:
+      a.keys.each do |k|
+        if b.has_key?(k)
+          case [a[k], b[k]].map{|value| value.class}
+          when *hash_classes.zip(hash_classes)
+            a[k] = merge_hash_values(a[k], b[k])
+            b.delete(k)
+          when [Array, Array]
+            a[k] += b[k]
+            b.delete(k)
+          end
+        end
+      end
+      a.merge!(b)
+    end
+
+    def hash_classes
+      klasses = [Hash]
+
+      case Webrat.configuration.mode
+      when :rails
+        klasses << HashWithIndifferentAccess
+      when :merb
+        klasses << Mash
+      end
+
+      klasses
+    end
+
+  end
+end

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

@@ -0,0 +1,31 @@
+require "webrat/core/elements/element"
+
+module Webrat
+  class Label < Element #:nodoc:
+
+    attr_reader :element
+
+    def self.xpath_search
+      ".//label"
+    end
+
+    def for_id
+      Webrat::XML.attribute(@element, "for")
+    end
+
+    def field
+      Field.load(@session, field_element)
+    end
+
+  protected
+
+    def field_element
+      if for_id.blank?
+        Webrat::XML.xpath_at(@element, *Field.xpath_search_excluding_hidden)
+      else
+        Webrat::XML.css_search(@session.current_dom, "#" + for_id).first
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,92 @@
+require "webrat/core_extensions/blank"
+
+require "webrat/core/elements/element"
+
+module Webrat
+  class Link < Element #:nodoc:
+
+    def self.xpath_search
+      ".//a[@href]"
+    end
+
+    def click(options = {})
+      method = options[:method] || http_method
+      return if href =~ /^#/ && method == :get
+
+      options[:javascript] = true if options[:javascript].nil?
+
+      if options[:javascript]
+        @session.request_page(absolute_href, method, data)
+      else
+        @session.request_page(absolute_href, :get, {})
+      end
+    end
+
+  protected
+
+    def id
+      Webrat::XML.attribute(@element, "id")
+    end
+
+    def data
+      authenticity_token.blank? ? {} : {"authenticity_token" => authenticity_token}
+    end
+
+    def title
+      Webrat::XML.attribute(@element, "title")
+    end
+
+    def href
+      Webrat::XML.attribute(@element, "href")
+    end
+
+    def absolute_href
+      if href =~ /^\?/
+        "#{@session.current_url}#{href}"
+      elsif href !~ %r{^https?://} && (href !~ /^\//)
+        "#{@session.current_url}/#{href}"
+      else
+        href
+      end
+    end
+
+    def authenticity_token
+      return unless onclick && onclick.include?("s.setAttribute('name', 'authenticity_token');") &&
+        onclick =~ /s\.setAttribute\('value', '([a-f0-9]{40})'\);/
+      $LAST_MATCH_INFO.captures.first
+    end
+
+    def onclick
+      Webrat::XML.attribute(@element, "onclick")
+    end
+
+    def http_method
+      if !onclick.blank? && onclick.include?("f.submit()")
+        http_method_from_js_form
+      else
+        :get
+      end
+    end
+
+    def http_method_from_js_form
+      if onclick.include?("m.setAttribute('name', '_method')")
+        http_method_from_fake_method_param
+      else
+        :post
+      end
+    end
+
+    def http_method_from_fake_method_param
+      if onclick.include?("m.setAttribute('value', 'delete')")
+        :delete
+      elsif onclick.include?("m.setAttribute('value', 'put')")
+        :put
+      elsif onclick.include?("m.setAttribute('value', 'post')")
+        :post
+      else
+        raise Webrat::WebratError.new("No HTTP method for _method param in #{onclick.inspect}")
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,35 @@
+require "webrat/core/elements/element"
+
+module Webrat
+  class SelectOption < Element #:nodoc:
+
+    def self.xpath_search
+      ".//option"
+    end
+
+    def choose
+      select.raise_error_if_disabled
+      select.set(value)
+    end
+
+  protected
+
+    def select
+      SelectField.load(@session, select_element)
+    end
+
+    def select_element
+      parent = @element.parent
+
+      while parent.respond_to?(:parent)
+        return parent if parent.name == 'select'
+        parent = parent.parent
+      end
+    end
+
+    def value
+      Webrat::XML.attribute(@element, "value") || Webrat::XML.inner_html(@element)
+    end
+
+  end
+end

data/lib/webrat/core/locators.rb

@@ -0,0 +1,20 @@
+require "webrat/core/locators/area_locator"
+require "webrat/core/locators/button_locator"
+require "webrat/core/locators/field_labeled_locator"
+require "webrat/core/locators/label_locator"
+require "webrat/core/locators/field_named_locator"
+require "webrat/core/locators/field_by_id_locator"
+require "webrat/core/locators/select_option_locator"
+require "webrat/core/locators/link_locator"
+require "webrat/core/locators/field_locator"
+require "webrat/core/locators/form_locator"
+
+module Webrat
+  module Locators
+
+    def field_by_xpath(xpath)
+      Field.load(@session, Webrat::XML.xpath_at(dom, xpath))
+    end
+
+  end
+end

data/lib/webrat/core/locators/area_locator.rb

@@ -0,0 +1,38 @@
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class AreaLocator < Locator # :nodoc:
+
+      def locate
+        Area.load(@session, area_element)
+      end
+
+      def area_element
+        area_elements.detect do |area_element|
+          Webrat::XML.attribute(area_element, "title") =~ matcher ||
+          Webrat::XML.attribute(area_element, "id") =~ matcher
+        end
+      end
+
+      def matcher
+        /#{Regexp.escape(@value.to_s)}/i
+      end
+
+      def area_elements
+        Webrat::XML.xpath_search(@dom, Area.xpath_search)
+      end
+
+      def error_message
+        "Could not find area with name #{@value}"
+      end
+
+    end
+
+    def find_area(id_or_title) #:nodoc:
+      AreaLocator.new(@session, dom, id_or_title).locate!
+    end
+
+  end
+end

data/lib/webrat/core/locators/button_locator.rb

@@ -0,0 +1,54 @@
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class ButtonLocator < Locator # :nodoc:
+
+      def locate
+        ButtonField.load(@session, button_element)
+      end
+
+      def button_element
+        button_elements.detect do |element|
+          @value.nil?             ||
+          matches_id?(element)    ||
+          matches_value?(element) ||
+          matches_html?(element)  ||
+          matches_alt?(element)
+        end
+      end
+
+      def matches_id?(element)
+        (@value.is_a?(Regexp) && Webrat::XML.attribute(element, "id") =~ @value) ||
+        (!@value.is_a?(Regexp) && Webrat::XML.attribute(element, "id") == @value.to_s)
+      end
+
+      def matches_value?(element)
+        Webrat::XML.attribute(element, "value") =~ /^\W*#{Regexp.escape(@value.to_s)}/i
+      end
+
+      def matches_html?(element)
+        Webrat::XML.inner_html(element) =~ /#{Regexp.escape(@value.to_s)}/i
+      end
+
+      def matches_alt?(element)
+        Webrat::XML.attribute(element, "alt") =~ /^\W*#{Regexp.escape(@value.to_s)}/i
+      end
+
+      def button_elements
+        Webrat::XML.xpath_search(@dom, *ButtonField.xpath_search)
+      end
+
+      def error_message
+        "Could not find button #{@value.inspect}"
+      end
+
+    end
+
+    def find_button(value) #:nodoc:
+      ButtonLocator.new(@session, dom, value).locate!
+    end
+
+  end
+end

data/lib/webrat/core/locators/field_by_id_locator.rb

@@ -0,0 +1,37 @@
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class FieldByIdLocator < Locator # :nodoc:
+
+      def locate
+        Field.load(@session, field_element)
+      end
+
+      def field_element
+        field_elements.detect do |field_element|
+          if @value.is_a?(Regexp)
+            Webrat::XML.attribute(field_element, "id") =~ @value
+          else
+            Webrat::XML.attribute(field_element, "id") == @value.to_s
+          end
+        end
+      end
+
+      def field_elements
+        Webrat::XML.xpath_search(@dom, *Field.xpath_search)
+      end
+
+      def error_message
+        "Could not find field with id #{@value.inspect}"
+      end
+
+    end
+
+    def field_with_id(id, *field_types)
+      FieldByIdLocator.new(@session, dom, id, *field_types).locate!
+    end
+
+  end
+end

data/lib/webrat/core/locators/field_labeled_locator.rb

@@ -0,0 +1,56 @@
+require "webrat/core_extensions/detect_mapped"
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class FieldLabeledLocator < Locator # :nodoc:
+
+      def locate
+        matching_labels.any? && matching_labels.detect_mapped { |label| label.field }
+      end
+
+      def matching_labels
+        matching_label_elements.sort_by do |label_element|
+          text(label_element).length
+        end.map do |label_element|
+          Label.load(@session, label_element)
+        end
+      end
+
+      def matching_label_elements
+        label_elements.select do |label_element|
+          text(label_element) =~ /^\W*#{Regexp.escape(@value.to_s)}(\b|\Z)/i
+        end
+      end
+
+      def label_elements
+        Webrat::XML.xpath_search(@dom, Label.xpath_search)
+      end
+
+      def error_message
+        "Could not find field labeled #{@value.inspect}"
+      end
+
+      def text(element)
+        str = Webrat::XML.all_inner_text(element)
+        str.gsub!("\n","")
+        str.strip!
+        str.squeeze!(" ")
+        str
+      end
+
+    end
+
+    # Locates a form field based on a <tt>label</tt> element in the HTML source.
+    # This can be useful in order to verify that a field is pre-filled with the
+    # correct value.
+    #
+    # Example:
+    #   field_labeled("First name").value.should == "Bryan"
+    def field_labeled(label, *field_types)
+      FieldLabeledLocator.new(@session, dom, label, *field_types).locate!
+    end
+
+  end
+end