locator 0.0.5 → 0.0.6

data/Rakefile

@@ -1,10 +1,21 @@
+require 'rubygems'
+require 'rake'
 require 'rake/testtask'
+require 'rake/rdoctask'
 
-require File.expand_path("../lib/locator/version", __FILE__)
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Run all tests.'
+Rake::TestTask.new(:test) do |t|
+  load 'test/all.rb'
+end
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
+    require File.expand_path("../lib/locator/version", __FILE__)
+
     s.name = "locator"
     s.version = Locator::VERSION
     s.summary = "Generic html element locators for integration testing"
@@ -13,6 +24,7 @@ begin
     s.description = "Generic html element locators for integration testing"
     s.authors = ['Sven Fuchs']
     s.files =  FileList["[A-Z]*", "{lib,test,vendor}/**/*"]
+    s.add_dependency 'htmlentities'
   end
 rescue LoadError
   puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/lib/locator.rb

@@ -1,12 +1,15 @@
 require 'core_ext/string/underscore'
 
 module Locator
-  autoload :Boolean, 'locator/boolean'
-  autoload :Dom,     'locator/dom'
-  autoload :Element, 'locator/element'
-  autoload :Matcher, 'locator/matcher'
-  autoload :Result,  'locator/result'
-  autoload :Xpath,   'locator/xpath'
+  autoload :Boolean,  'locator/boolean'
+  autoload :Dom,      'locator/dom'
+  autoload :Decoding, 'locator/decoding'
+  autoload :Element,  'locator/element'
+  autoload :Matcher,  'locator/matcher'
+  autoload :Result,   'locator/result'
+  autoload :Xpath,    'locator/xpath'
+
+  extend Decoding
 
   class ElementNotFound < StandardError
     def initialize(*args)
@@ -28,7 +31,7 @@ module Locator
 
       def locators
         @locators ||= Hash[*Element.constants.map do |name|
-          [name.underscore.to_sym, Element.const_get(name)]
+          [name.to_s.underscore.to_sym, Element.const_get(name)]
         end.flatten]
       end
   end
@@ -97,4 +100,4 @@ module Locator
     end
 
   extend(self)
-end
+end

data/lib/locator/boolean.rb

@@ -34,7 +34,7 @@ module Locator
       self.operator = ' AND '
 
       def initialize(lft, rgt)
-        replace(lft.map { |l| rgt.map { |r| "#{l}#{self.class.operator}#{r}" } })
+        replace(Array(lft).map { |l| Array(rgt).map { |r| "#{l}#{self.class.operator}#{r}" } })
       end
     end
 
@@ -47,4 +47,4 @@ module Locator
       end
     end
   end
-end
+end

data/lib/locator/decoding.rb

@@ -0,0 +1,28 @@
+module Locator
+  module Decoding
+    def decode_entities?
+      @decode_entities ||= true
+    end
+
+    def decode_entities=(decode_entities)
+      @decode_entities = decode_entities
+    end
+
+    def decode_attributes(hash)
+      Hash[*hash.map { |name, value| [name, decode(value)] }.flatten]
+    end
+
+    def decode(value)
+      value.is_a?(String) ? html_entities.decode(value) : value
+    end
+    
+    protected
+
+      def html_entities
+        html_entities ||= begin
+          require 'htmlentities'
+          HTMLEntities.new
+        end
+      end
+  end
+end

data/lib/locator/dom/nokogiri/element.rb

@@ -25,10 +25,6 @@ module Locator
           element.css_path.to_s
         end
 
-        def content
-          element.content
-        end
-
         def value
           case name
           when 'input'
@@ -45,6 +41,10 @@ module Locator
           checked ? checked.value : nil
         end
 
+        def content
+          element.content
+        end
+
         def inner_html
           element.inner_html
         end

data/lib/locator/element.rb

@@ -52,6 +52,8 @@ module Locator
     protected
 
       def lookup(scope, selector, attributes = {})
+        attributes = Locator.decode_attributes(attributes) if Locator.decode_entities?
+
         scope = scope.respond_to?(:elements_by_xpath) ? scope : Locator::Dom.page(scope)
         xpath = xpath(attributes)
         xpath = ".#{xpath}" unless xpath[0, 1] == '.'

data/lib/locator/result.rb

@@ -8,6 +8,7 @@ module Locator
 
     class << self
       def matches?(name, value, selector)
+        value, selector = Locator.decode(value), Locator.decode(selector) if Locator.decode_entities?
         value = normalize_whitespace(value)
         case selector
         when Regexp

data/lib/locator/version.rb

@@ -1,3 +1,3 @@
 module Locator
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/locator/xpath.rb

@@ -7,7 +7,7 @@ module Locator
         string =~ %r(^\.?//)
       end
     end
-    
+
     def initialize(name = nil, attributes = {})
       super(Array(name || '*').map { |name| self.class.xpath?(name) ? name : ".//#{name}" })
 
@@ -43,7 +43,7 @@ module Locator
     end
 
     def and!(other)
-      replace(self.map { |l| other.map { |r| "#{l}#{r}" } })
+      replace(self.map { |l| Array(other).map { |r| "#{l}#{r}" } }.flatten)
     end
 
     def or!(other)
@@ -60,4 +60,4 @@ module Locator
         self.class.xpath?(value) ? value : "\"#{value}\""
       end
   end
-end
+end

data/test/all.rb

@@ -2,5 +2,5 @@ files = Dir[File.dirname(__FILE__) + '/**/*_test.rb']
 # files.reject! { |file| file.include?('htmlunit') }
 
 files.each do |filename|
-  require filename unless filename.include?('_locator')
+  require filename # unless filename.include?('_locator')
 end

data/test/locator/dom/htmlunit_test.rb

@@ -1,77 +1,81 @@
 require File.expand_path('../../../test_helper', __FILE__)
 
 $: << '~/Development/projects/steam/lib'
-require 'steam'
-include Steam
+begin
+  require 'steam'
+  include Steam
 
-Java.load(Dir["#{Steam.config[:html_unit][:java_path]}/*.jar"].join(':'))
-Java.import 'com.gargoylesoftware.htmlunit.WebClient'
-Java.import 'com.gargoylesoftware.htmlunit.BrowserVersion'
+  Java.load(Dir["#{Steam.config[:html_unit][:java_path]}/*.jar"].join(':'))
+  Java.import 'com.gargoylesoftware.htmlunit.WebClient'
+  Java.import 'com.gargoylesoftware.htmlunit.BrowserVersion'
 
-class HtmlunitElementTest < Test::Unit::TestCase
-  include Locator, Java::Com::Gargoylesoftware::Htmlunit
+  class HtmlunitElementTest < Test::Unit::TestCase
+    include Locator, Java::Com::Gargoylesoftware::Htmlunit
 
-  def setup
-    connection = Connection::Mock.new
-    client = WebClient.new(BrowserVersion.FIREFOX_3)
-    client.setWebConnection(Rjb::bind(Browser::HtmlUnit::Connection.new(connection), 'com.gargoylesoftware.htmlunit.WebConnection'))
+    def setup
+      connection = Connection::Mock.new
+      client = WebClient.new(BrowserVersion.FIREFOX_3)
+      client.setWebConnection(Rjb::bind(Browser::HtmlUnit::Connection.new(connection), 'com.gargoylesoftware.htmlunit.WebConnection'))
 
-    connection.mock(:get, 'http://localhost:3000/', '<a href="#" class="foo">the link</a><div id="bar"></div>')
-    @dom = Dom::Htmlunit::Page.new(client.getPage('http://localhost:3000/'))
-  end
+      connection.mock(:get, 'http://localhost:3000/', '<a href="#" class="foo">the link</a><div id="bar"></div>')
+      @dom = Dom::Htmlunit::Page.new(client.getPage('http://localhost:3000/'))
+    end
 
-  test "Element takes a Htmlunit::Page adapter" do
-    element = Element::Link.new.locate(@dom, 'the link', :class => 'foo')
-    assert element.name
-  end
+    test "Element takes a Htmlunit::Page adapter" do
+      element = Element::Link.new.locate(@dom, 'the link', :class => 'foo')
+      assert element.name
+    end
 
-  test "responds to name" do
-    element = Element::Link.new.locate(@dom, 'the link')
-    assert_equal 'a', element.name
-  end
+    test "responds to name" do
+      element = Element::Link.new.locate(@dom, 'the link')
+      assert_equal 'a', element.name
+    end
 
-  test "responds to xpath" do
-    element = Element::Link.new.locate(@dom, 'the link')
-    assert_equal '/html/body/a', element.xpath
-  end
+    test "responds to xpath" do
+      element = Element::Link.new.locate(@dom, 'the link')
+      assert_equal '/html/body/a', element.xpath
+    end
 
-  test "responds to to_s" do
-    element = Element::Link.new.locate(@dom, 'the link')
-    assert_equal "<a href=\"#\" class=\"foo\">\n  the link\n</a>\n", element.to_s
-  end
+    test "responds to to_s" do
+      element = Element::Link.new.locate(@dom, 'the link')
+      assert_equal "<a href=\"#\" class=\"foo\">\n  the link\n</a>\n", element.to_s
+    end
 
-  test "responds to content" do
-    element = Element::Link.new.locate(@dom, 'the link')
-    assert_equal "the link", element.content
-  end
+    test "responds to content" do
+      element = Element::Link.new.locate(@dom, 'the link')
+      assert_equal "the link", element.content
+    end
 
-  test "responds to attribute" do
-    element = Element::Link.new.locate(@dom, 'the link')
-    assert_equal 'foo', element.attribute('class')
-  end
+    test "responds to attribute" do
+      element = Element::Link.new.locate(@dom, 'the link')
+      assert_equal 'foo', element.attribute('class')
+    end
 
-  test "responds to element_by_id" do
-    element = Element.new(:html).locate(@dom)
-    assert_equal 'bar', element.element_by_id('bar').attribute('id')
-  end
+    test "responds to element_by_id" do
+      element = Element.new(:html).locate(@dom)
+      assert_equal 'bar', element.element_by_id('bar').attribute('id')
+    end
 
-  test "responds to element_by_xpath" do
-    element = Element.new(:html).locate(@dom)
-    assert_equal 'bar', element.element_by_xpath('//html/body/div[@id="bar"]').attribute('id')
-  end
+    test "responds to element_by_xpath" do
+      element = Element.new(:html).locate(@dom)
+      assert_equal 'bar', element.element_by_xpath('//html/body/div[@id="bar"]').attribute('id')
+    end
   
-  test "responds to elements_by_xpath" do
-    element = Element::Link.new.locate(@dom, 'the link')
-    assert_equal 'foo', element.attribute('class')
-  end
+    test "responds to elements_by_xpath" do
+      element = Element::Link.new.locate(@dom, 'the link')
+      assert_equal 'foo', element.attribute('class')
+    end
 
-  test "responds to ancestors" do
-    element = Element.new(:a).locate(@dom)
-    assert_equal %w(html body), element.ancestors.map { |e| e.name }
-  end
+    test "responds to ancestors" do
+      element = Element.new(:a).locate(@dom)
+      assert_equal %w(html body), element.ancestors.map { |e| e.name }
+    end
 
-  test "responds to ancestor_of?" do
-    element = Element.new(:a).locate(@dom)
-    assert_equal %w(html body), element.ancestors.map { |e| e.name }
+    test "responds to ancestor_of?" do
+      element = Element.new(:a).locate(@dom)
+      assert_equal %w(html body), element.ancestors.map { |e| e.name }
+    end
   end
+rescue LoadError
+  puts "skipping HtmlUnit tests because Steam is not available"
 end

data/test/locator/dom/nokogiri_test.rb

@@ -13,4 +13,30 @@ class NokogiriTest < Test::Unit::TestCase
     dom = Locator::Dom::Nokogiri::Page.new('<a href="#">the link</a>')
     assert Element.new.locate(dom, 'the link')
   end
+
+  # test "Nokogiri and Umlauts" do
+  #   encoded = '<p>&ouml;</p>'
+  #   unencoded = '<p>ö</p>'
+  #
+  #   # this is ok
+  #   fragment = Nokogiri::HTML.fragment(encoded)
+  #   assert_equal encoded, fragment.to_s
+  #
+  #   # this seems weird ... wtf experiences ahead
+  #   fragment = Nokogiri::HTML.fragment(unencoded)
+  #   assert_equal encoded, fragment.to_s
+  #
+  #   options =
+  #     Nokogiri::XML::ParseOptions::RECOVER |
+  #     Nokogiri::XML::ParseOptions::NOERROR |
+  #     Nokogiri::XML::ParseOptions::NOWARNING
+  #
+  #   # this is ok
+  #   node = Nokogiri::HTML.parse(encoded, nil, nil, options)
+  #   assert_equal encoded, node.xpath('//p').first.to_s
+  #
+  #   # this is ok
+  #   node = Nokogiri::HTML.parse(unencoded, nil, 'utf-8', options)
+  #   assert_equal unencoded, node.xpath('//p').first.to_s
+  # end
 end

data/test/locator/element_test.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require File.expand_path('../../test_helper', __FILE__)
 
 class LocatorElementTest < Test::Unit::TestCase
@@ -122,4 +123,14 @@ class LocatorElementTest < Test::Unit::TestCase
     html = '<a class="foo" href="#"></a><a class="bar" href="#"></a>'
     assert_equal 'bar', Element::Link.new.locate(html, :css => '.bar').attribute('class')
   end
+
+  test "locate selects an element containing an umlaut" do
+    html = '<a href="#">the lünk</a>'
+    assert Element.new.locate(html, 'the lünk')
+  end
+
+  test "locate selects an element with an attribute containing an umlaut" do
+    html = '<input type="text" value="München" />'
+    assert Element.new.locate(html, :value => 'München')
+  end
 end

data/test/locator/xpath_test.rb

@@ -19,8 +19,8 @@ class XpathTest < Test::Unit::TestCase
   end
 
   test "xpath with attributes" do
-    path = Xpath.new(['input', 'button'], :type => 'text', :id => 'foo').to_s
-    assert_equal %(.//input[@type="text"][@id="foo"] | .//button[@type="text"][@id="foo"]), path
+    path = Xpath.new(['input', 'button'], :type => 'text', :id => 'foo')
+    assert_equal %(.//input[@type="text"][@id="foo"] | .//button[@type="text"][@id="foo"]), path.to_s
   end
 
   test "xpath with alternate nodenames and attributes" do

data/test/locator_test.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require File.expand_path('../test_helper', __FILE__)
 
 class LocatorTest < Test::Unit::TestCase
@@ -86,4 +87,46 @@ class LocatorTest < Test::Unit::TestCase
     html = '<form></form><div><form><p id="foo"><p></form></div>'
     assert_nil locate(html, :div) { locate(html, :form, :class => 'bar')  { locate(html, :p) } }
   end
+
+  # locate with umlauts
+
+  test "locates an element by encoded selector from html containing an encoded umlaut" do
+    html = '<span>Berlin</span><span>M&uuml;nchen</span>'
+    assert_equal 'München', locate(html, 'M&uuml;nchen').content
+  end
+
+  test "locates an element by encoded selector from html containing an non-encoded umlaut" do
+    html = '<span>Berlin</span><span>München</span>'
+    assert_equal 'München', locate(html, 'M&uuml;nchen').content
+  end
+
+  test "locates an element by non-encoded selector from html containing an encoded umlaut" do
+    html = '<span>Berlin</span><span>M&uuml;nchen</span>'
+    assert_equal 'München', locate(html, 'München').content
+  end
+
+  test "locates an element by non-encoded selector from html containing a non-encoded umlaut" do
+    html = '<span>Berlin</span><span>München</span>'
+    assert_equal 'München', locate(html, 'München').content
+  end
+
+  test "locates an element by encoded attribute from html containing an encoded umlaut" do
+    html = '<input type="text" value="M&uuml;nchen">'
+    assert_equal 'München', locate(html, :value => 'M&uuml;nchen').value
+  end
+
+  test "locates an element by encoded attribute from html containing an non-encoded umlaut" do
+    html = '<input type="text" value="München">'
+    assert_equal 'München', locate(html, :value => 'M&uuml;nchen').value
+  end
+
+  test "locates an element by non-encoded attribute from html containing an encoded umlaut" do
+    html = '<input type="text" value="M&uuml;nchen">'
+    assert_equal 'München', locate(html, :value => 'München').value
+  end
+
+  test "locates an element by non-encoded attribute from html containing a non-encoded umlaut" do
+    html = '<input type="text" value="München">'
+    assert_equal 'München', locate(html, :value => 'München').value
+  end
 end

data/test/test_helper.rb

@@ -1,5 +1,4 @@
 $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
-$:.unshift(File.expand_path(File.dirname(__FILE__)))
 
 require 'test/unit'
 require 'locator'
@@ -7,7 +6,7 @@ require 'locator'
 module TestMethod
   def self.included(base)
     base.class_eval do
-      def test(name, &block)
+      def self.test(name, &block)
         test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
         defined = instance_method(test_name) rescue false
         raise "#{test_name} is already defined in #{self}" if defined
@@ -29,4 +28,4 @@ end
 
 class Test::Unit::TestCase
   include TestMethod
-end
+end

data/test/webrat.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require File.expand_path('../test_helper', __FILE__)
+require 'action_pack'
+require 'webrat'
+require 'rack/test'
+
+Webrat.configure do |config|
+  config.mode = :rack
+end
+
+class WebratBehaviorTest < Test::Unit::TestCase
+  include Webrat::Methods
+  
+  def last_response
+    @last_response ||= Rack::Response.new
+  end
+
+  def with_html(html)
+    last_response.body = html
+  end
+
+  test "foo" do
+    with_html '<span>München</span>'
+    field = field_by_xpath(".//span")
+    p field.element.to_s
+  end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: locator
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Sven Fuchs
@@ -9,10 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-28 00:00:00 +01:00
+date: 2010-04-02 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: htmlentities
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: Generic html element locators for integration testing
 email: svenfuchs@artweb-design.de
 executables: []
@@ -31,6 +47,7 @@ files:
 - lib/core_ext/string/underscore.rb
 - lib/locator.rb
 - lib/locator/boolean.rb
+- lib/locator/decoding.rb
 - lib/locator/dom.rb
 - lib/locator/dom/htmlunit.rb
 - lib/locator/dom/htmlunit/element.rb
@@ -81,6 +98,7 @@ files:
 - test/locator/xpath_test.rb
 - test/locator_test.rb
 - test/test_helper.rb
+- test/webrat.rb
 has_rdoc: true
 homepage: http://github.com/svenfuchs/locator
 licenses: []
@@ -94,18 +112,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Generic html element locators for integration testing
@@ -129,3 +149,4 @@ test_files:
 - test/locator/xpath_test.rb
 - test/locator_test.rb
 - test/test_helper.rb
+- test/webrat.rb