webrat 0.4.1 → 0.4.2

data/History.txt

@@ -1,3 +1,28 @@
+== 0.4.2 / 2009-02-24
+
+* Major enhancements
+
+  * Significant improvements to have_selector. It now supports specifying
+    attributes in a hash and :count and :content options. See
+    have_selector_spec.rb for more.
+  * Add the same functionality mentioned above to have_xpath
+    
+* Minor enhancements
+
+  * Squeeze extra whitespace out of failures messages from contain
+    matcher
+  * Detect infinite redirects and raise a Webrat::InfiniteRedirectError
+    (Daniel Lucraft)
+
+* Bug fixes
+
+  * Properly quote single and double quotes strings in XPath
+  * Fix warning caused by Nokogiri deprecating CSS::Parser.parse
+    (Aaron Patterson)
+  * Accept do/end blocks in matchers. [#157] (Peter Jaros)
+  * Quote --chdir option to mongrel_rails to support RAILS_ROOTs with spaces
+    (T.J. VanSlyke)
+
 == 0.4.1 / 2009-01-31
 
 * Minor enhancements

data/Rakefile

@@ -28,7 +28,7 @@ spec = Gem::Specification.new do |s|
   s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
 
   # Dependencies
-  s.add_dependency "nokogiri", ">= 1.1.0"
+  s.add_dependency "nokogiri", ">= 1.2.0"
 
   s.rubyforge_project = "webrat"
 end

data/lib/webrat/core/configuration.rb

@@ -51,6 +51,10 @@ module Webrat
     # Set the key that Selenium uses to determine the browser running. Default *firefox
     attr_accessor :selenium_browser_key
 
+    # 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.parse_with_nokogiri = !Webrat.on_java?
@@ -58,6 +62,7 @@ module Webrat
       self.application_port = 3001
       self.application_address = 'localhost'
       self.selenium_server_port = 4444
+      self.infinite_redirect_limit = 10
       self.selenium_browser_key = '*firefox'
     end
 

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

@@ -26,15 +26,19 @@ module Webrat
       # ==== Returns
       # String:: The failure message.
       def failure_message
-        "expected the following element's content to #{content_message}:\n#{@element}"
+        "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#{@element}"
+        "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

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

@@ -1,24 +1,46 @@
+require "webrat/core/matchers/have_xpath"
+
 module Webrat
   module Matchers
     
     class HaveSelector < HaveXpath #:nodoc:
-
       # ==== Returns
       # String:: The failure message.
       def failure_message
-        "expected following text to match selector #{@expected}:\n#{@document}"
+        "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 text to not match selector #{@expected}:\n#{@document}"
+        "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::Parser.parse(*super).map { |ast| ast.to_xpath }
+        Nokogiri::CSS.parse(@expected.to_s).map do |ast|
+          ast.to_xpath
+        end.first
       end
-  
+      
     end
     
     # Matches HTML content against a CSS 3 selector.
@@ -28,24 +50,24 @@ module Webrat
     #
     # ==== Returns
     # HaveSelector:: A new have selector matcher.
-    def have_selector(expected, &block)
-      HaveSelector.new(expected, &block)
+    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(expected)
-      hs = HaveSelector.new(expected)
-      assert hs.matches?(response_body), hs.failure_message
+    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(expected)
-      hs = HaveSelector.new(expected)
-      assert !hs.matches?(response_body), hs.negative_failure_message
+    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

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

@@ -1,70 +1,20 @@
+require "webrat/core/matchers/have_selector"
+
 module Webrat
-  
   module HaveTagMatcher
 
-    class HaveTag < ::Webrat::Matchers::HaveSelector #: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 = @expected.last.dup
-        content = options.delete(:content)
-
-        html = "<#{@expected.first}"
-        options.each do |k,v|
-          html << " #{k}='#{v}'"
-        end
-
-        if content
-          html << ">#{content}</#{@expected.first}>"
-        else
-          html << "/>"
-        end
-
-        html
-      end
-
-      def query
-        options  = @expected.last.dup
-        selector = @expected.first.to_s
-
-        selector << ":contains('#{options.delete(:content)}')" if options[:content]
-
-        options.each do |key, value|
-          selector << "[#{key}='#{value}']"
-        end
-
-        Nokogiri::CSS::Parser.parse(selector).map { |ast| ast.to_xpath }
-      end
-    end
-
-    def have_tag(name, attributes = {}, &block)
-      HaveTag.new([name, attributes], &block)
+    def have_tag(*args, &block)
+      have_selector(*args, &block)
     end
     
     alias_method :match_tag, :have_tag
     
-    # Asserts that the body of the response contains
-    # the supplied tag with the associated selectors
-    def assert_have_tag(name, attributes = {})
-      ht = HaveTag.new([name, attributes])
-      assert ht.matches?(response_body), ht.failure_message
+    def assert_have_tag(*args, &block)
+      assert_have_selector(*args, &block)
     end
     
-    # Asserts that the body of the response
-    # does not contain the supplied string or regepx
-    def assert_have_no_tag(name, attributes = {})
-      ht = HaveTag.new([name, attributes])
-      assert !ht.matches?(response_body), ht.negative_failure_message
+    def assert_have_no_tag(*args, &block)
+      assert_have_no_selector(*args, &block)
     end
 
   end

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

@@ -5,53 +5,90 @@ 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'//', './') }
         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
@@ -64,7 +101,24 @@ 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
@@ -74,18 +128,18 @@ 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)
+    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)
+    def assert_have_no_xpath(expected, options = {}, &block)
+      hs = HaveXpath.new(expected, options, &block)
       assert !hs.matches?(response_body), hs.negative_failure_message
     end
     

data/lib/webrat/core/session.rb

@@ -9,6 +9,9 @@ module Webrat
   class PageLoadError < WebratError
   end
 
+  class InfiniteRedirectError < WebratError
+  end
+  
   def self.session_class
     case Webrat.configuration.mode
     when :rails
@@ -112,11 +115,30 @@ For example:
       @http_method  = http_method
       @data         = data
 
-      request_page(response_location, :get, {}) if internal_redirect?
+      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

data/lib/webrat/merb_session.rb

@@ -5,7 +5,7 @@ gem "extlib"
 require "extlib"
 require "merb-core"
 
-HashWithIndifferentAccess = Mash
+# HashWithIndifferentAccess = Mash
 
 module Webrat
   class MerbSession < Session #:nodoc:

data/lib/webrat/selenium/matchers/have_tag.rb

@@ -43,7 +43,7 @@ module Webrat
             selector << "[#{key}='#{value}']"
           end
   
-          Nokogiri::CSS::Parser.parse(selector).map { |ast| ast.to_xpath }
+          Nokogiri::CSS.parse(selector).map { |ast| ast.to_xpath }
         end
       end
   

data/lib/webrat/selenium.rb

@@ -27,7 +27,7 @@ module Webrat
 
   def self.start_app_server #:nodoc:
     pid_file = prepare_pid_file("#{RAILS_ROOT}/tmp/pids", "mongrel_selenium.pid")
-    system("mongrel_rails start -d --chdir=#{RAILS_ROOT} --port=#{Webrat.configuration.application_port} --environment=#{Webrat.configuration.application_environment} --pid #{pid_file} &")
+    system("mongrel_rails start -d --chdir='#{RAILS_ROOT}' --port=#{Webrat.configuration.application_port} --environment=#{Webrat.configuration.application_environment} --pid #{pid_file} &")
     TCPSocket.wait_for_service :host => Webrat.configuration.application_address, :port => Webrat.configuration.application_port.to_i
   end
 

data/lib/webrat.rb

@@ -7,7 +7,7 @@ module Webrat
   class WebratError < StandardError
   end
 
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 
   def self.require_xml
     gem "nokogiri", ">= 1.0.6"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webrat
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Bryan Helmkamp
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-31 00:00:00 -05:00
+date: 2009-02-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.0
+        version: 1.2.0
     version: 
 description: Webrat. Ruby Acceptance Testing for Web applications
 email: bryan@brynary.com
@@ -83,7 +83,6 @@ files:
 - lib/webrat/core_extensions/blank.rb
 - lib/webrat/core_extensions/deprecate.rb
 - lib/webrat/core_extensions/detect_mapped.rb
-- lib/webrat/core_extensions/hash_with_indifferent_access.rb
 - lib/webrat/core_extensions/meta_class.rb
 - lib/webrat/core_extensions/nil_to_param.rb
 - lib/webrat/mechanize.rb

data/lib/webrat/core_extensions/hash_with_indifferent_access.rb

@@ -1,131 +0,0 @@
-# This class has dubious semantics and we only have it so that
-# people can write params[:key] instead of params['key']
-# and they get the same value for both keys.
-class HashWithIndifferentAccess < Hash #:nodoc:
-  def initialize(constructor = {})
-    if constructor.is_a?(Hash)
-      super()
-      update(constructor)
-    else
-      super(constructor)
-    end
-  end
-
-  def default(key = nil)
-    if key.is_a?(Symbol) && include?(key = key.to_s)
-      self[key]
-    else
-      super
-    end
-  end
-
-  alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
-  alias_method :regular_update, :update unless method_defined?(:regular_update)
-
-  #
-  # Assigns a new value to the hash.
-  #
-  # Example:
-  #
-  #   hash = HashWithIndifferentAccess.new
-  #   hash[:key] = "value"
-  #
-  def []=(key, value)
-    regular_writer(convert_key(key), convert_value(value))
-  end
-
-  # 
-  # Updates the instantized hash with values from the second.
-  # 
-  # Example:
-  # 
-  #   >> hash_1 = HashWithIndifferentAccess.new
-  #   => {}
-  # 
-  #   >> hash_1[:key] = "value"
-  #   => "value"
-  # 
-  #   >> hash_2 = HashWithIndifferentAccess.new
-  #   => {}
-  # 
-  #   >> hash_2[:key] = "New Value!"
-  #   => "New Value!"
-  # 
-  #   >> hash_1.update(hash_2)
-  #   => {"key"=>"New Value!"}
-  # 
-  def update(other_hash)
-    other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
-    self
-  end
-
-  alias_method :merge!, :update
-
-  # Checks the hash for a key matching the argument passed in
-  def key?(key)
-    super(convert_key(key))
-  end
-
-  alias_method :include?, :key?
-  alias_method :has_key?, :key?
-  alias_method :member?, :key?
-
-  # Fetches the value for the specified key, same as doing hash[key]
-  def fetch(key, *extras)
-    super(convert_key(key), *extras)
-  end
-
-  # Returns an array of the values at the specified indicies. 
-  def values_at(*indices)
-    indices.collect {|key| self[convert_key(key)]}
-  end
-
-  # Returns an exact copy of the hash.
-  def dup
-    HashWithIndifferentAccess.new(self)
-  end
-
-  # Merges the instantized and the specified hashes together, giving precedence to the values from the second hash
-  # Does not overwrite the existing hash.
-  def merge(hash)
-    self.dup.update(hash)
-  end
-
-  # Removes a specified key from the hash.
-  def delete(key)
-    super(convert_key(key))
-  end
-
-  def stringify_keys!; self end
-  def symbolize_keys!; self end
-  def to_options!; self end
-
-  # Convert to a Hash with String keys.
-  def to_hash
-    Hash.new(default).merge(self)
-  end
-
-  protected
-    def convert_key(key)
-      key.kind_of?(Symbol) ? key.to_s : key
-    end
-
-    def convert_value(value)
-      case value
-      when Hash
-        value.with_indifferent_access
-      when Array
-        value.collect { |e| e.is_a?(Hash) ? e.with_indifferent_access : e }
-      else
-        value
-      end
-    end
-end
-
-class Hash #:nodoc:
-  def with_indifferent_access
-    hash = HashWithIndifferentAccess.new(self)
-    hash.default = self.default
-    hash
-  end
-end