aslakhellesoy-webrat 0.3.2.2 → 0.4.4.1

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

@@ -3,57 +3,94 @@ require "webrat/core/xml/rexml"
 
 module Webrat
   module Matchers
-    
+
     class HaveXpath #:nodoc:
-      def initialize(expected, &block)
+      def initialize(expected, options = {}, &block)
         @expected = expected
+        @options  = options
         @block    = block
       end
-    
-      def matches?(stringlike)
+
+      def matches?(stringlike, &block)
+        @block ||= block
+        matched = matches(stringlike)
+
+        if @options[:count]
+          matched.size == @options[:count] && (!@block || @block.call(matched))
+        else
+          matched.any? && (!@block || @block.call(matched))
+        end
+      end
+
+      def matches(stringlike)
         if Webrat.configuration.parse_with_nokogiri?
-          matches_nokogiri?(stringlike)
+          nokogiri_matches(stringlike)
         else
-          matches_rexml?(stringlike)
+          rexml_matches(stringlike)
         end
       end
-    
-      def matches_rexml?(stringlike)
+
+      def rexml_matches(stringlike)
         if REXML::Node === stringlike || Array === stringlike
-          @query = query.map { |q| q.gsub(%r'//', './') }
+          @query = query.map { |q| q.gsub(%r'^//', './/') }
         else
           @query = query
         end
 
+        add_options_conditions_to(@query)
+
         @document = Webrat.rexml_document(stringlike)
 
-        matched = @query.map do |q|
+        @query.map do |q|
           if @document.is_a?(Array)
             @document.map { |d| REXML::XPath.match(d, q) }
           else
             REXML::XPath.match(@document, q)
           end
         end.flatten.compact
-
-        matched.any? && (!@block || @block.call(matched))
       end
-    
-      def matches_nokogiri?(stringlike)
+
+      def nokogiri_matches(stringlike)
         if Nokogiri::XML::NodeSet === stringlike
-          @query = query.map { |q| q.gsub(%r'//', './') }
+          @query = query.gsub(%r'^//', './/')
         else
           @query = query
         end
-        
+
+        add_options_conditions_to(@query)
+
         @document = Webrat::XML.document(stringlike)
-        matched = @document.xpath(*@query)
-        matched.any? && (!@block || @block.call(matched))
+        @document.xpath(*@query)
+      end
+
+      def add_options_conditions_to(query)
+        add_attributes_conditions_to(query)
+        add_content_condition_to(query)
       end
-      
+
+      def add_attributes_conditions_to(query)
+        attribute_conditions = []
+
+        @options.each do |key, value|
+          next if [:content, :count].include?(key)
+          attribute_conditions << "@#{key} = #{xpath_escape(value)}"
+        end
+
+        if attribute_conditions.any?
+          query << "[#{attribute_conditions.join(' and ')}]"
+        end
+      end
+
+      def add_content_condition_to(query)
+        if @options[:content]
+          query << "[contains(., #{xpath_escape(@options[:content])})]"
+        end
+      end
+
       def query
-        [@expected].flatten.compact
+        @expected
       end
-    
+
       # ==== Returns
       # String:: The failure message.
       def failure_message
@@ -64,9 +101,26 @@ module Webrat
       # String:: The failure message to be displayed in negative matches.
       def negative_failure_message
         "expected following text to not match xpath #{@expected}:\n#{@document}"
-      end    
+      end
+
+    protected
+
+      def xpath_escape(string)
+        if string.include?("'") && string.include?('"')
+          parts = string.split("'").map do |part|
+            "'#{part}'"
+          end
+
+          "concat(" + parts.join(", \"'\", ") + ")"
+        elsif string.include?("'")
+          "\"#{string}\""
+        else
+          "'#{string}'"
+        end
+      end
+
     end
-    
+
     # Matches HTML content against an XPath query
     #
     # ==== Parameters
@@ -74,20 +128,20 @@ module Webrat
     #
     # ==== Returns
     # HaveXpath:: A new have xpath matcher.
-    def have_xpath(expected, &block)
-      HaveXpath.new(expected, &block)
+    def have_xpath(expected, options = {}, &block)
+      HaveXpath.new(expected, options, &block)
     end
     alias_method :match_xpath, :have_xpath
-    
-    def assert_have_xpath(expected, &block)
-      hs = HaveXpath.new(expected, &block)
-      raise Test::Unit::AssertionFailedError.new(hs.failure_message) unless hs.matches?(response_body)
+
+    def assert_have_xpath(expected, options = {}, &block)
+      hs = HaveXpath.new(expected, options, &block)
+      assert hs.matches?(response_body), hs.failure_message
     end
-    
-    def assert_have_no_xpath(expected, &block)
-      hs = HaveXpath.new(expected, &block)
-      raise Test::Unit::AssertionFailedError.new(hs.negative_failure_message) if hs.matches?(response_body)
+
+    def assert_have_no_xpath(expected, options = {}, &block)
+      hs = HaveXpath.new(expected, options, &block)
+      assert !hs.matches?(response_body), hs.negative_failure_message
     end
-    
+
   end
-end
+end

data/lib/webrat/core/methods.rb

@@ -10,15 +10,19 @@ module Webrat
         RUBY
       end
     end
-    
+
     def webrat
       webrat_session
     end
-    
+
     def webrat_session
-      @_webrat_session ||= ::Webrat.session_class.new(self)
+      @_webrat_session ||= ::Webrat::Session.new(webrat_adapter)
     end
-    
+
+    def webrat_adapter
+      @_webrat_adapter ||= Webrat.session_class.new(self)
+    end
+
     # all of these methods delegate to the @session, which should
     # be created transparently.
     #
@@ -31,7 +35,7 @@ module Webrat
       :header, :http_accept, :basic_auth,
       :save_and_open_page,
       :fills_in, :fill_in,
-      :checks, :check, 
+      :checks, :check,
       :unchecks, :uncheck,
       :chooses, :choose,
       :selects, :select,
@@ -47,15 +51,13 @@ module Webrat
       :select_option,
       :set_hidden_field, :submit_form,
       :request_page, :current_dom,
-      :response_body, 
+      :response_body,
       :selects_date, :selects_time, :selects_datetime,
       :select_date, :select_time, :select_datetime,
       :field_by_xpath,
       :field_with_id,
       :selenium,
-      :simulate, :automate
-      
-      
-    
+      :simulate, :automate,
+      :field_named
   end
-end
+end

data/lib/webrat/core/mime.rb

@@ -1,6 +1,6 @@
 module Webrat #:nodoc:
   module MIME #:nodoc:
-    
+
     def self.mime_type(string_or_symbol) #:nodoc:
       if string_or_symbol.is_a?(String)
         string_or_symbol
@@ -24,6 +24,6 @@ module Webrat #:nodoc:
         end
       end
     end
-    
+
   end
-end
+end

data/lib/webrat/core/save_and_open_page.rb

@@ -2,21 +2,21 @@ module Webrat
   module SaveAndOpenPage
     # Saves the page out to RAILS_ROOT/tmp/ and opens it in the default
     # web browser if on OS X. Useful for debugging.
-    # 
+    #
     # Example:
     #   save_and_open_page
     def save_and_open_page
       return unless File.exist?(saved_page_dir)
 
       filename = "#{saved_page_dir}/webrat-#{Time.now.to_i}.html"
-      
+
       File.open(filename, "w") do |f|
         f.write rewrite_css_and_image_references(response_body)
       end
 
       open_in_browser(filename)
     end
-    
+
     def open_in_browser(path) # :nodoc
       platform = ruby_platform
       if platform =~ /cygwin/ || platform =~ /win32/
@@ -25,26 +25,26 @@ module Webrat
         `open #{path}`
       end
     end
-    
+
     def rewrite_css_and_image_references(response_html) # :nodoc:
       return response_html unless doc_root
       response_html.gsub(/"\/(stylesheets|images)/, doc_root + '/\1')
     end
-    
+
     def saved_page_dir #:nodoc:
       File.expand_path(".")
     end
-    
+
     def doc_root #:nodoc:
       nil
     end
-  
+
   private
 
     # accessor for testing
     def ruby_platform
       RUBY_PLATFORM
     end
-    
+
   end
-end
+end

data/lib/webrat/core/scope.rb

@@ -6,32 +6,36 @@ module Webrat
   # An HTML element (link, button, field, etc.) that Webrat expected was not found on the page
   class NotFoundError < WebratError
   end
-  
+
   class Scope
     include Logging
     include Locators
-    
+
     def self.from_page(session, response, response_body) #:nodoc:
       new(session) do
         @response = response
         @response_body = response_body
       end
     end
-    
+
     def self.from_scope(session, scope, selector) #:nodoc:
       new(session) do
         @scope = scope
         @selector = selector
       end
     end
-    
+
     attr_reader :session
-    
+
     def initialize(session, &block) #:nodoc:
       @session = session
       instance_eval(&block) if block_given?
+
+      if @selector && scoped_dom.nil?
+        raise Webrat::NotFoundError.new("The scope was not found on the page: #{@selector.inspect}")
+      end
     end
-    
+
     # Verifies an input field or textarea exists on the current page, and stores a value for
     # it which will be sent when the form is submitted.
     #
@@ -49,12 +53,17 @@ module Webrat
     end
 
     webrat_deprecate :fills_in, :fill_in
-    
+
+    # Verifies that a hidden field exists on the current page and sets
+    # the value to that given by the <tt>:to</tt> option.
+    #
+    # Example:
+    #   set_hidden_field 'user_id', :to => 1
     def set_hidden_field(field_locator, options = {})
       field = locate_field(field_locator, HiddenField)
       field.set(options[:to])
     end
-    
+
     # Verifies that an input checkbox exists on the current page and marks it
     # as checked, so that the value will be submitted with the form.
     #
@@ -65,7 +74,7 @@ module Webrat
     end
 
     webrat_deprecate :checks, :check
-    
+
     # Verifies that an input checkbox exists on the current page and marks it
     # as unchecked, so that the value will not be submitted with the form.
     #
@@ -76,7 +85,7 @@ module Webrat
     end
 
     webrat_deprecate :unchecks, :uncheck
-    
+
     # Verifies that an input radio button exists on the current page and marks it
     # as checked, so that the value will be submitted with the form.
     #
@@ -87,7 +96,7 @@ module Webrat
     end
 
     webrat_deprecate :chooses, :choose
-    
+
     # Verifies that a an option element exists on the current page with the specified
     # text. You can optionally restrict the search to a specific select list by
     # assigning <tt>options[:from]</tt> the value of the select list's name or
@@ -102,7 +111,7 @@ module Webrat
     end
 
     webrat_deprecate :selects, :select
-    
+
     DATE_TIME_SUFFIXES = {
       :year   => '1i',
       :month  => '2i',
@@ -111,9 +120,9 @@ module Webrat
       :minute => '5i'
     }
 
-    # Verifies that date elements (year, month, day) exist on the current page 
+    # Verifies that date elements (year, month, day) exist on the current page
     # with the specified values. You can optionally restrict the search to a specific
-    # date's elements by assigning <tt>options[:from]</tt> the value of the date's 
+    # date's elements by assigning <tt>options[:from]</tt> the value of the date's
     # label. Selects all the date elements with date provided.  The date provided may
     # be a string or a Date/Time object.
     #
@@ -127,15 +136,15 @@ module Webrat
     #   select_date Date.parse("December 25, 2000"), :from => "Event"
     #   select_date "April 26, 1982", :id_prefix => 'birthday'
     def select_date(date_to_select, options ={})
-      date = date_to_select.is_a?(Date) || date_to_select.is_a?(Time) ? 
-                date_to_select : Date.parse(date_to_select) 
-      
+      date = date_to_select.is_a?(Date) || date_to_select.is_a?(Time) ?
+                date_to_select : Date.parse(date_to_select)
+
       id_prefix = locate_id_prefix(options) do
         year_field = FieldByIdLocator.new(@session, dom, /(.*?)_#{DATE_TIME_SUFFIXES[:year]}$/).locate
         raise NotFoundError.new("No date fields were found") unless year_field && year_field.id =~ /(.*?)_1i/
         $1
       end
-        
+
       select date.year, :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:year]}"
       select date.strftime('%B'), :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:month]}"
       select date.day, :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:day]}"
@@ -143,9 +152,9 @@ module Webrat
 
     webrat_deprecate :selects_date, :select_date
 
-    # Verifies that time elements (hour, minute) exist on the current page 
+    # Verifies that time elements (hour, minute) exist on the current page
     # with the specified values. You can optionally restrict the search to a specific
-    # time's elements by assigning <tt>options[:from]</tt> the value of the time's 
+    # time's elements by assigning <tt>options[:from]</tt> the value of the time's
     # label. Selects all the time elements with date provided.  The time provided may
     # be a string or a Time object.
     #
@@ -155,28 +164,28 @@ module Webrat
     #
     # Note: Just like Rails' time_select helper this assumes the form is using
     # 24 hour select boxes, and not 12 hours with AM/PM.
-    # 
+    #
     # Examples:
     #   select_time "9:30"
     #   select_date "3:30PM", :from => "Party Time"
     #   select_date Time.parse("10:00PM"), :from => "Event"
     #   select_date "10:30AM", :id_prefix => 'meeting'
     def select_time(time_to_select, options ={})
-      time = time_to_select.is_a?(Time) ? time_to_select : Time.parse(time_to_select) 
+      time = time_to_select.is_a?(Time) ? time_to_select : Time.parse(time_to_select)
 
       id_prefix = locate_id_prefix(options) do
         hour_field = FieldByIdLocator.new(@session, dom, /(.*?)_#{DATE_TIME_SUFFIXES[:hour]}$/).locate
         raise NotFoundError.new("No time fields were found") unless hour_field && hour_field.id =~ /(.*?)_4i/
         $1
       end
-        
+
       select time.hour.to_s.rjust(2,'0'), :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:hour]}"
       select time.min.to_s.rjust(2,'0'), :from => "#{id_prefix}_#{DATE_TIME_SUFFIXES[:minute]}"
     end
 
     webrat_deprecate :selects_time, :select_time
-   
-    # Verifies and selects all the date and time elements on the current page. 
+
+    # Verifies and selects all the date and time elements on the current page.
     # See #select_time and #select_date for more details and available options.
     #
     # Examples:
@@ -185,39 +194,48 @@ module Webrat
     #   select_datetime Time.parse("December 25, 2000 15:30"), :from => "Event"
     #   select_datetime "April 26, 1982 5:50PM", :id_prefix => 'birthday'
     def select_datetime(time_to_select, options ={})
-      time = time_to_select.is_a?(Time) ? time_to_select : Time.parse(time_to_select) 
-      
+      time = time_to_select.is_a?(Time) ? time_to_select : Time.parse(time_to_select)
+
       options[:id_prefix] ||= (options[:from] ? FieldByIdLocator.new(@session, dom, options[:from]).locate : nil)
-      
+
       select_date time, options
       select_time time, options
     end
 
     webrat_deprecate :selects_datetime, :select_datetime
-    
+
     # Verifies that an input file field exists on the current page and sets
     # its value to the given +file+, so that the file will be uploaded
     # along with the form. An optional <tt>content_type</tt> may be given.
     #
     # Example:
-    #   attaches_file "Resume", "/path/to/the/resume.txt"
-    #   attaches_file "Photo", "/path/to/the/image.png", "image/png"
+    #   attach_file "Resume", "/path/to/the/resume.txt"
+    #   attach_file "Photo", "/path/to/the/image.png", "image/png"
     def attach_file(field_locator, path, content_type = nil)
       locate_field(field_locator, FileField).set(path, content_type)
     end
 
     webrat_deprecate :attaches_file, :attach_file
-    
+
+    # Issues a request for the URL pointed to by an <tt>area</tt> tag
+    # on the current page, follows any redirects, and verifies the
+    # final page load was successful.
+    #
+    # The area used is the first area whose title or id contains the
+    # given +area_name+ (case is ignored).
+    #
+    # Example:
+    #   click_area 'Australia'
     def click_area(area_name)
       find_area(area_name).click
     end
-    
+
     webrat_deprecate :clicks_area, :click_area
-    
+
     # Issues a request for the URL pointed to by a link on the current page,
     # follows any redirects, and verifies the final page load was successful.
-    # 
-    # click_link has very basic support for detecting Rails-generated 
+    #
+    # click_link has very basic support for detecting Rails-generated
     # JavaScript onclick handlers for PUT, POST and DELETE links, as well as
     # CSRF authenticity tokens if they are present.
     #
@@ -225,15 +243,15 @@ module Webrat
     #
     # Passing a :method in the options hash overrides the HTTP method used
     # for making the link request
-    # 
+    #
     # It will try to find links by (in order of precedence):
     #   innerHTML, with simple &nbsp; handling
     #   title
     #   id
-    #    
+    #
     # innerHTML and title are matchable by text subtring or Regexp
     # id is matchable by full text equality or Regexp
-    # 
+    #
     # Example:
     #   click_link "Sign up"
     #   click_link "Sign up", :javascript => false
@@ -243,7 +261,7 @@ module Webrat
     end
 
     webrat_deprecate :clicks_link, :click_link
-    
+
     # Verifies that a submit button exists for the form, then submits the form, follows
     # any redirects, and verifies the final page was successful.
     #
@@ -258,48 +276,50 @@ module Webrat
     end
 
     webrat_deprecate :clicks_button, :click_button
-    
+
+    # Submit the form with the given id.
+    #
+    # Note that +click_button+ is usually preferrable for simulating
+    # form submissions, as you may specify part of the button text
+    # rather than the form id.
+    #
+    # Example:
+    #   submit_form 'login'
     def submit_form(id)
       FormLocator.new(@session, dom, id).locate.submit
     end
-    
+
     def dom # :nodoc:
       return @dom if @dom
-      
+
       if @selector
         @dom = scoped_dom
       else
         @dom = page_dom
       end
-      
+
       return @dom
     end
-    
+
   protected
-    
+
     def page_dom #:nodoc:
       return @response.dom if @response.respond_to?(:dom)
-      
+
       if @session.xml_content_type?
         dom = Webrat::XML.xml_document(@response_body)
       else
         dom = Webrat::XML.html_document(@response_body)
       end
-      
+
       Webrat.define_dom_method(@response, dom)
       return dom
     end
-    
-    def scoped_dom #:nodoc:
-      source = Webrat::XML.to_html(Webrat::XML.css_search(@scope.dom, @selector).first)
-      
-      if @session.xml_content_type?
-        Webrat::XML.xml_document(source)
-      else
-        Webrat::XML.html_document(source)
-      end
+
+    def scoped_dom
+      Webrat::XML.css_at(@scope.dom, @selector)
     end
-    
+
     def locate_field(field_locator, *field_types) #:nodoc:
       if field_locator.is_a?(Field)
         field_locator
@@ -307,10 +327,10 @@ module Webrat
         field(field_locator, *field_types)
       end
     end
-    
+
     def locate_id_prefix(options, &location_strategy) #:nodoc:
       return options[:id_prefix] if options[:id_prefix]
-      
+
       if options[:from]
         if (label = LabelLocator.new(@session, dom, options[:from]).locate)
           label.for_id
@@ -321,10 +341,10 @@ module Webrat
         yield
       end
     end
-    
+
     def forms #:nodoc:
       @forms ||= Form.load_all(@session, dom)
     end
-    
+
   end
 end