thoughtbot-webrat 0.7.2.pre

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
+        @dom.xpath(*Label.xpath_search)
+      end
+
+      def error_message
+        "Could not find field labeled #{@value.inspect}"
+      end
+
+      def text(element)
+        str = element.inner_text
+        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

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

@@ -0,0 +1,25 @@
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class FieldLocator < Locator # :nodoc:
+
+      def locate
+        FieldByIdLocator.new(@session, @dom, @value).locate   ||
+        FieldNamedLocator.new(@session, @dom, @value, *@field_types).locate   ||
+        FieldLabeledLocator.new(@session, @dom, @value, *@field_types).locate
+      end
+
+      def error_message
+        "Could not find field: #{@value.inspect}"
+      end
+
+    end
+
+    def field(*args) # :nodoc:
+      FieldLocator.new(@session, dom, *args).locate!
+    end
+
+  end
+end

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

@@ -0,0 +1,41 @@
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class FieldNamedLocator < Locator # :nodoc:
+
+      def locate
+        Field.load(@session, field_element)
+      end
+
+      def field_element
+        field_elements.detect do |field_element|
+          field_element["name"] == @value.to_s
+        end
+      end
+
+      def field_elements
+        @dom.xpath(*xpath_searches)
+      end
+
+      def xpath_searches
+        if @field_types.any?
+          @field_types.map { |field_type| field_type.xpath_search }.flatten
+        else
+          Field.xpath_search
+        end
+      end
+
+      def error_message
+        "Could not find field named #{@value.inspect}"
+      end
+
+    end
+
+    def field_named(name, *field_types)
+      FieldNamedLocator.new(@session, dom, name, *field_types).locate!
+    end
+
+  end
+end

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

@@ -0,0 +1,19 @@
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class FormLocator < Locator # :nodoc:
+
+      def locate
+        Form.load(@session, form_element)
+      end
+
+      def form_element
+        @dom.css("#" + @value).first || @dom.css(@value).first
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,34 @@
+require "webrat/core_extensions/detect_mapped"
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class LabelLocator < Locator # :nodoc:
+
+      def locate
+        Label.load(@session, label_element)
+      end
+
+      def label_element
+        label_elements.detect do |label_element|
+          text(label_element) =~ /^\W*#{Regexp.escape(@value.to_s)}(\b|\Z)/i
+        end
+      end
+
+      def label_elements
+        @dom.xpath(*Label.xpath_search)
+      end
+
+      def text(label_element)
+        str = label_element.inner_text
+        str.gsub!("\n","")
+        str.strip!
+        str.squeeze!(" ")
+        str
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,74 @@
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class LinkLocator < Locator # :nodoc:
+
+      def locate
+        Link.load(@session, link_element)
+      end
+
+      def link_element
+        matching_links.min { |a, b| a.inner_text.length <=> b.inner_text.length }
+      end
+
+      def matching_links
+        @matching_links ||= link_elements.select do |link_element|
+          matches_text?(link_element) ||
+          matches_id?(link_element)
+        end
+      end
+
+      def matches_text?(link)
+        if @value.is_a?(Regexp)
+          matcher = @value
+        else
+          matcher = /#{Regexp.escape(@value.to_s)}/i
+        end
+
+        replace_nbsp(link.inner_text) =~ matcher ||
+        replace_nbsp_ref(link.inner_html) =~ matcher ||
+        link["title"] =~ matcher
+      end
+
+      def matches_id?(link)
+        if @value.is_a?(Regexp)
+          link["id"] =~ @value ? true : false
+        else
+          link["id"] == @value ? true : false
+        end
+      end
+
+      def link_elements
+        @dom.xpath(*Link.xpath_search)
+      end
+
+      def replace_nbsp(str)
+        if str.respond_to?(:valid_encoding?)
+          if str.valid_encoding?
+            str.gsub(/\xc2\xa0/u, ' ')
+          else
+            str.force_encoding('UTF-8').gsub(/\xc2\xa0/u, ' ')
+          end
+        else
+          str.gsub(/\xc2\xa0/u, ' ')
+        end
+      end
+
+      def replace_nbsp_ref(str)
+        str.gsub('&#xA0;',' ').gsub('&nbsp;', ' ')
+      end
+
+      def error_message
+        "Could not find link with text or title or id #{@value.inspect}"
+      end
+
+    end
+
+    def find_link(text_or_title_or_id) #:nodoc:
+      LinkLocator.new(@session, dom, text_or_title_or_id).locate!
+    end
+
+  end
+end

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

@@ -0,0 +1,20 @@
+module Webrat
+  module Locators
+
+    class Locator # :nodoc:
+
+      def initialize(session, dom, value, *field_types)
+        @session = session
+        @dom = dom
+        @value = value
+        @field_types = field_types
+      end
+
+      def locate!
+        locate || raise(NotFoundError.new(error_message))
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,59 @@
+require "webrat/core_extensions/detect_mapped"
+require "webrat/core/locators/locator"
+
+module Webrat
+  module Locators
+
+    class SelectOptionLocator < Locator # :nodoc:
+
+      def initialize(session, dom, option_text, id_or_name_or_label)
+        @session = session
+        @dom = dom
+        @option_text = option_text
+        @id_or_name_or_label = id_or_name_or_label
+      end
+
+      def locate
+        if @id_or_name_or_label
+          field = FieldLocator.new(@session, @dom, @id_or_name_or_label, SelectField, MultipleSelectField).locate!
+
+          field.options.detect do |o|
+            if @option_text.is_a?(Regexp)
+              o.element.inner_text =~ @option_text
+            else
+              o.inner_text == @option_text.to_s
+            end
+          end
+        else
+          option_element = option_elements.detect do |o|
+            if @option_text.is_a?(Regexp)
+              o.inner_text =~ @option_text
+            else
+              o.inner_text == @option_text.to_s
+            end
+          end
+
+          SelectOption.load(@session, option_element)
+        end
+      end
+
+      def option_elements
+        @dom.xpath(*SelectOption.xpath_search)
+      end
+
+      def error_message
+        if @id_or_name_or_label
+          "The '#{@option_text}' option was not found in the #{@id_or_name_or_label.inspect} select box"
+        else
+          "Could not find option #{@option_text.inspect}"
+        end
+      end
+
+    end
+
+    def select_option(option_text, id_or_name_or_label = nil) #:nodoc:
+      SelectOptionLocator.new(@session, dom, option_text, id_or_name_or_label).locate!
+    end
+
+  end
+end

data/lib/webrat/core/logging.rb

@@ -0,0 +1,23 @@
+require "logger"
+
+module Webrat
+  module Logging #:nodoc:
+
+    def debug_log(message) # :nodoc:
+      return unless logger
+      logger.debug message
+    end
+
+    def logger # :nodoc:
+      case Webrat.configuration.mode
+      when :rails
+        defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : nil
+      when :merb
+        ::Merb.logger
+      else
+        @logger ||= ::Logger.new("webrat.log")
+      end
+    end
+
+  end
+end

data/lib/webrat/core/matchers.rb

@@ -0,0 +1,4 @@
+require "webrat/core/matchers/have_xpath"
+require "webrat/core/matchers/have_selector"
+require "webrat/core/matchers/have_tag"
+require "webrat/core/matchers/have_content"

data/lib/webrat/core/matchers/have_content.rb

@@ -0,0 +1,68 @@
+module Webrat
+  module Matchers
+
+    class HasContent #:nodoc:
+      def initialize(content)
+        @content = content
+      end
+
+      def matches?(stringlike)
+        @document = Webrat::XML.document(stringlike).xpath('//html')
+        @element = @document.inner_text
+
+        case @content
+        when String
+          @element.gsub(/\s+/, ' ').include?(@content)
+        when Regexp
+          @element.match(@content)
+        end
+      end
+
+      # ==== Returns
+      # String:: The failure message.
+      def failure_message
+        "expected the following element's content to #{content_message}:\n#{squeeze_space(@element)}"
+      end
+
+      # ==== Returns
+      # String:: The failure message to be displayed in negative matches.
+      def negative_failure_message
+        "expected the following element's content to not #{content_message}:\n#{squeeze_space(@element)}"
+      end
+
+      def squeeze_space(inner_text)
+        inner_text.gsub(/^\s*$/, "").squeeze("\n")
+      end
+
+      def content_message
+        case @content
+        when String
+          "include \"#{@content}\""
+        when Regexp
+          "match #{@content.inspect}"
+        end
+      end
+    end
+
+    # Matches the contents of an HTML document with
+    # whatever string is supplied
+    def contain(content)
+      HasContent.new(content)
+    end
+
+    # Asserts that the body of the response contain
+    # the supplied string or regexp
+    def assert_contain(content)
+      hc = HasContent.new(content)
+      assert hc.matches?(response_body), hc.failure_message
+    end
+
+    # Asserts that the body of the response
+    # does not contain the supplied string or regepx
+    def assert_not_contain(content)
+      hc = HasContent.new(content)
+      assert !hc.matches?(response_body), hc.negative_failure_message
+    end
+
+  end
+end

data/lib/webrat/core/matchers/have_selector.rb

@@ -0,0 +1,74 @@
+require "webrat/core/matchers/have_xpath"
+
+module Webrat
+  module Matchers
+
+    class HaveSelector < HaveXpath #:nodoc:
+      # ==== Returns
+      # String:: The failure message.
+      def failure_message
+        "expected following output to contain a #{tag_inspect} tag:\n#{@document}"
+      end
+
+      # ==== Returns
+      # String:: The failure message to be displayed in negative matches.
+      def negative_failure_message
+        "expected following output to omit a #{tag_inspect}:\n#{@document}"
+      end
+
+      def tag_inspect
+        options = @options.dup
+        count = options.delete(:count)
+        content = options.delete(:content)
+
+        html = "<#{@expected}"
+        options.each do |k,v|
+          html << " #{k}='#{v}'"
+        end
+
+        if content
+          html << ">#{content}</#{@expected}>"
+        else
+          html << "/>"
+        end
+
+        html
+      end
+
+      def query
+        Nokogiri::CSS.parse(@expected.to_s).map do |ast|
+          ast.to_xpath
+        end.first
+      end
+
+    end
+
+    # Matches HTML content against a CSS 3 selector.
+    #
+    # ==== Parameters
+    # expected<String>:: The CSS selector to look for.
+    #
+    # ==== Returns
+    # HaveSelector:: A new have selector matcher.
+    def have_selector(name, attributes = {}, &block)
+      HaveSelector.new(name, attributes, &block)
+    end
+    alias_method :match_selector, :have_selector
+
+
+    # Asserts that the body of the response contains
+    # the supplied selector
+    def assert_have_selector(name, attributes = {}, &block)
+      matcher = HaveSelector.new(name, attributes, &block)
+      assert matcher.matches?(response_body), matcher.failure_message
+    end
+
+    # Asserts that the body of the response
+    # does not contain the supplied string or regepx
+    def assert_have_no_selector(name, attributes = {}, &block)
+      matcher = HaveSelector.new(name, attributes, &block)
+      assert !matcher.matches?(response_body), matcher.negative_failure_message
+    end
+
+  end
+end