watir-nokogiri 1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Justin Ko
+Copyright (c) 2009-2013 Jari Bakken (code copied from the watir-webdriver gem)
+Copyright (c) 2009-2013 FINN.no AS (code copied from the watirspec gem)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+Watir-Nokogiri
+==============
+
+Watir-Nokogiri is an HTML parser using Watir's API.
+
+Background
+-----------
+
+Watir (classic and webdriver) can have performance issues when parsing large HTML pages. One solution has been to extract the page's HTML using Watir and then parse the HTML with an HTML parser (ex Nokogiri). This required learning two APIs - Watir and the HTML parser. Watir-Nokogiri eliminates the need to learn an HTML parser API by applying the Watir API to the HTML parser Nokogiri.
+
+Installation
+-----------
+
+```ruby
+gem install 'watir-nokogiri'
+```
+
+Usage
+-----------
+
+To use Watir-Nokogiri:
+
+```ruby 
+require 'watir-nokogiri'
+```
+
+Watir-Nokogiri can parse a string containing HTML.
+
+This is typically supplied by a Watir browser:
+
+```ruby
+doc = WatirNokogiri::Document.new(browser.html)
+```
+
+However, you can also read from a file:
+
+```ruby
+doc = WatirNokogiri::Document.start('C:\some_file.html')
+```
+
+With the parsed document, you can use the standard Watir API to locate elements and validate text/attributes.
+
+Check if an element exists
+
+```ruby
+doc.div(:id => 'my_id').exists?
+```
+
+Get the text of an element
+
+```ruby
+doc.span(:id => 'my_span').text
+```
+
+Get an attribute value of an element
+
+```ruby
+doc.span(:id => 'my_span').attribute_value('name')
+```
+
+Count the number of elements
+
+```ruby
+doc.text_fields.length
+```

data/lib/watir-nokogiri.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require 'nokogiri'
+
+require_relative 'watir-nokogiri/version'
+require_relative 'watir-nokogiri/exception'
+require_relative 'watir-nokogiri/xpath_support'
+require_relative 'watir-nokogiri/container'
+require_relative 'watir-nokogiri/locators/element_locator'
+require_relative 'watir-nokogiri/locators/button_locator'
+require_relative 'watir-nokogiri/locators/text_area_locator'
+require_relative 'watir-nokogiri/locators/text_field_locator'
+require_relative 'watir-nokogiri/locators/child_row_locator'
+require_relative 'watir-nokogiri/locators/child_cell_locator'
+require_relative 'watir-nokogiri/document'
+
+module WatirNokogiri
+  class << self
+
+    #
+    # @api private
+    #
+
+    def tag_to_class
+      @tag_to_class ||= {}
+    end
+
+    #
+    # @api private
+    #
+
+    def element_class_for(tag_name)
+      tag_to_class[tag_name.to_sym] || HTMLElement
+    end
+    
+  end
+end #WatirNokogiri
+
+require_relative 'watir-nokogiri/attribute_helper'
+require_relative 'watir-nokogiri/row_container'
+require_relative 'watir-nokogiri/cell_container'
+require_relative 'watir-nokogiri/user_editable'
+require_relative 'watir-nokogiri/element_collection'
+require_relative 'watir-nokogiri/elements/element'
+require_relative 'watir-nokogiri/elements/generated'
+
+require_relative 'watir-nokogiri/elements/button'
+require_relative 'watir-nokogiri/elements/checkbox'
+require_relative 'watir-nokogiri/elements/dlist'
+require_relative 'watir-nokogiri/elements/file_field'
+require_relative 'watir-nokogiri/elements/font'
+require_relative 'watir-nokogiri/elements/form'
+require_relative 'watir-nokogiri/elements/frame'
+require_relative 'watir-nokogiri/elements/hidden'
+require_relative 'watir-nokogiri/elements/image'
+require_relative 'watir-nokogiri/elements/input'
+require_relative 'watir-nokogiri/elements/link'
+require_relative 'watir-nokogiri/elements/option'
+require_relative 'watir-nokogiri/elements/radio'
+require_relative 'watir-nokogiri/elements/select'
+require_relative 'watir-nokogiri/elements/table'
+require_relative 'watir-nokogiri/elements/table_cell'
+require_relative 'watir-nokogiri/elements/table_row'
+require_relative 'watir-nokogiri/elements/table_section'
+require_relative 'watir-nokogiri/elements/text_area'
+require_relative 'watir-nokogiri/elements/text_field'
+
+require_relative 'watir-nokogiri/aliases'
+
+WatirNokogiri.tag_to_class.freeze

data/lib/watir-nokogiri/aliases.rb

@@ -0,0 +1,6 @@
+module WatirNokogiri
+  module Container
+    alias_method :field_set, :fieldset
+    alias_method :field_sets, :fieldsets
+  end # Container
+end # WatirNokogiri

data/lib/watir-nokogiri/attribute_helper.rb

@@ -0,0 +1,145 @@
+module WatirNokogiri
+
+  #
+  # @private
+  #
+  # Extended by Element, provides methods for defining attributes on the element classes.
+  #
+
+  module AttributeHelper
+
+    IGNORED_ATTRIBUTES = [:text, :hash]
+
+    def typed_attributes
+      @typed_attributes ||= Hash.new { |hash, type| hash[type] = []  }
+    end
+
+    def attribute_list
+      @attribute_list ||= (
+        list = typed_attributes.values.flatten
+        list += ancestors[1..-1].map do |e|
+          e.attribute_list if e.respond_to?(:attribute_list)
+        end.compact.flatten
+      ).uniq
+    end
+
+    def attributes(attribute_map = nil)
+      attribute_map or return attribute_list
+
+      add_attributes attribute_map
+
+      attribute_map.each do |type, attribs|
+        attribs.each do |name|
+          # we don't want to override methods like :text or :hash
+          next if IGNORED_ATTRIBUTES.include?(name)
+          define_attribute(type, name)
+        end
+      end
+    end
+
+    private
+
+    def self.extended(klass)
+      klass.class_eval do
+        # undefine deprecated methods to use them for Element attributes
+        [:id, :type].each { |m| undef_method m if method_defined? m }
+      end
+    end
+
+    def define_attribute(type, name)
+      method_name    = method_name_for(type, name)
+      attribute_name = attribute_for_method(name)
+
+      (@attributes ||= []) << attribute_name
+
+      case type
+      when :string
+        define_string_attribute(method_name, attribute_name)
+      when :bool
+        define_boolean_attribute(method_name, attribute_name)
+      when :int
+        define_int_attribute(method_name, attribute_name)
+      when :float
+        define_float_attribute(method_name, attribute_name)
+      else
+        # $stderr.puts "treating #{type.inspect} as string for now"
+      end
+    end
+
+    def define_string_attribute(mname, aname)
+      define_method mname do
+        assert_exists
+        @element.get_attribute(aname).to_s
+      end
+    end
+
+    def define_boolean_attribute(mname, aname)
+      define_method mname do
+        assert_exists
+        @element.get_attribute(aname)
+      end
+    end
+
+    def define_int_attribute(mname, aname)
+      define_method mname do
+        assert_exists
+        value = @element.get_attribute(aname)
+        value && Integer(value)
+      end
+    end
+
+    def define_float_attribute(mname, aname)
+      define_method mname do
+        assert_exists
+        value = @element.get_attribute(aname)
+        value && Float(value)
+      end
+    end
+
+    def add_attributes(attributes)
+      attributes.each do |type, attr_list|
+        typed_attributes[type] += attr_list
+      end
+    end
+
+    def method_name_for(type, attribute)
+      # http://github.com/jarib/watir-webdriver/issues/issue/26
+      name = case attribute
+             when :html_for
+               'for'
+             when :col_span
+               'colspan'
+             when :row_span
+               'rowspan'
+             else
+               attribute.to_s
+             end
+
+      name << "?" if type == :bool
+
+      name
+    end
+
+    def attribute_for_method(method)
+      # http://github.com/jarib/watir-webdriver/issues/issue/26
+
+      case method.to_sym
+      when :class_name
+        'class'
+      when :html_for
+        'for'
+      when :read_only
+        'readonly'
+      when :http_equiv
+        'http-equiv'
+      when :col_span
+        'colspan'
+      when :row_span
+        'rowspan'
+      else
+        method.to_s
+      end
+    end
+
+  end # AttributeHelper
+end # Watir

data/lib/watir-nokogiri/cell_container.rb

@@ -0,0 +1,31 @@
+module WatirNokogiri
+  module CellContainer
+
+    #
+    # Returns table cell.
+    #
+    # @return [TableCell]
+    #
+
+    def cell(*args)
+      cell = TableCell.new(self, extract_selector(args).merge(:tag_name => /^(th|td)$/))
+      cell.locator_class = ChildCellLocator
+
+      cell
+    end
+
+    #
+    # Returns table cells collection.
+    #
+    # @return [TableCell]
+    #
+
+    def cells(*args)
+      cells = TableCellCollection.new(self, extract_selector(args).merge(:tag_name => /^(th|td)$/))
+      cells.locator_class = ChildCellLocator
+
+      cells
+    end
+
+  end # CellContainer
+end # Watir

data/lib/watir-nokogiri/container.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module WatirNokogiri
+  module Container
+  
+    #
+    # Returns element.
+    #
+    # @example
+    #   browser.element(:data_bind => 'func')
+    #
+    # @return [HTMLElement]
+    #
+
+    def element(*args)
+      HTMLElement.new(self, extract_selector(args))
+    end
+
+    #
+    # Returns element collection.
+    #
+    # @example
+    #   browser.elements(:data_bind => 'func')
+    #
+    # @return [HTMLElementCollection]
+    #
+
+    def elements(*args)
+      HTMLElementCollection.new(self, extract_selector(args))
+    end
+
+    #
+    # @api private
+    #
+
+    def extract_selector(selectors)
+      case selectors.size
+      when 2
+        return { selectors[0] => selectors[1] }
+      when 1
+        obj = selectors.first
+        return obj if obj.kind_of? Hash
+      when 0
+        return {}
+      end
+
+      raise ArgumentError, "expected Hash or (:how, 'what'), got #{selectors.inspect}"
+    end
+
+  end # Container
+end # WatirNokogiri

data/lib/watir-nokogiri/document.rb

@@ -0,0 +1,171 @@
+# encoding: utf-8
+module WatirNokogiri
+
+  #
+  # The main class through which you control the html.
+  #
+
+  class Document
+    include Container
+
+    attr_reader :driver
+    alias_method :nokogiri, :driver # ensures duck typing with WatirNokogiri::Element
+
+    class << self
+      def start(file_path)
+        b = new()
+        b.goto file_path
+
+        b
+      end
+    end
+
+    #
+    # Creates a WatirNokogiri::HTML instance.
+    #
+
+    def initialize(html = '')
+      @driver = Nokogiri::HTML.parse(html)
+    end
+
+    def inspect
+      '#<%s:0x%x>' % [self.class, hash*2]
+    rescue
+      '#<%s:0x%x closed=%s>' % [self.class, hash*2, exist?.to_s]
+    end
+
+    #
+    # Reads the given file as HTML.
+    #
+    # @example
+    #   browser.goto "www.google.com"
+    #
+    # @param [String] uri The url.
+    # @return [String] The url you end up at.
+    #
+
+    def goto(file_path)
+      html = File.read(file_path)
+      @driver = Nokogiri::HTML.parse(html)
+    end
+
+    def back
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def forward
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def url
+      assert_exists
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def title
+      @driver.title
+    end
+
+    def close
+      @driver = nil
+    end
+    alias_method :quit, :close # TODO: close vs quit
+
+    def cookies
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def name
+      :nokogiri
+    end
+
+    #
+    # Returns text of page body.
+    #
+    # @return [String]
+    #
+
+    def text
+      @driver.at_css('body').text
+    end
+
+    #
+    # Returns HTML code of current page.
+    #
+    # @return [String]
+    #
+
+    def html
+      # use body.html instead?
+      @driver.at_css('html').to_html
+    end
+
+    def alert
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def refresh
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def wait(timeout = 5)
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def ready_state
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def status
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def execute_script(script, *args)
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def send_keys(*args)
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def screenshot
+      Screenshot.new driver
+    end
+
+    def add_checker(checker = nil, &block)
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def disable_checker(checker)
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    def run_checkers
+      raise NotImplementedError, "not currently supported by WatirNokogiri"
+    end
+
+    #
+    # Returns true if html has been supplied and false otherwise.
+    #
+    # @return [Boolean]
+    #
+
+    def exist?
+      !@driver.nil?
+    end
+    alias_method :exists?, :exist?
+
+    def assert_exists
+        true
+    end
+
+    def reset!
+      # no-op
+    end
+
+    def document
+      self
+    end
+
+  end # Document
+end # WatirNokogiri