watigiri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88ad103bcf8deb0b774e803ba687e340e8ee5373
+  data.tar.gz: 3b29a90e092b817df788048b3f03a5acb2542848
+SHA512:
+  metadata.gz: 621425770d2df585d453c8aaa1874d81c21e003ed580ab9861118cc48f04a7e66c6ef4474a070cdb1af9753468d6e0772990e067fac3b7d6b03ba8037339b0db
+  data.tar.gz: 507d3b8fd60b950ee55a635e8adc7f2a3fd709bd94c6539ba0287c3677a187578115786104dfadee604f2ef0e963dc0380f499d64cbdda43a6a5e2fcdccc3fe6

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in watigiri.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Titus Fortner
+
+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,39 @@
+# Watigiri
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/watigiri`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'watigiri'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install watigiri
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/watigiri.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/extensions/watir/browser.rb

@@ -0,0 +1,29 @@
+module Watir
+
+  class Browser
+    attr_reader :doc
+
+    #
+    # Store instance of Nokogiri
+    #
+
+    def doc=(html)
+      @doc = html
+
+      return if @doc.nil?
+      reset_doc = ->(browser) { browser.doc = nil }
+      after_hooks.add(reset_doc)
+    end
+
+    #
+    # Uses Nokogiri to return the text of page body.
+    #
+    # @return [String]
+    #
+
+    def text!
+      body.text!
+    end
+
+  end # Browser
+end # Watir

data/lib/extensions/watir/element.rb

@@ -0,0 +1,19 @@
+module Watir
+
+  class Element
+
+    # TODO - reimplement with Watir Executor when available
+
+    #
+    # Uses Nokogiri to return the text of the element.
+    #
+    # @return [String]
+    #
+
+    def text!
+      @selector[:nokogiri] = true
+      text
+    end
+
+  end # Element
+end # Watir

data/lib/extensions/watir/iframe.rb

@@ -0,0 +1,25 @@
+module Watir
+  class IFrame < HTMLElement
+    #
+    # Uses Nokogiri to return the text of iframe body.
+    #
+    # @return [String]
+    #
+
+    def text!
+      body.text!
+    end
+  end
+
+  class FramedDriver
+
+    private
+
+    def switch!
+      @browser.doc = nil
+      super
+    end
+
+  end # FramedDriver
+
+end # Watir

data/lib/watigiri.rb

@@ -0,0 +1,12 @@
+require 'watir'
+require 'nokogiri'
+
+require 'extensions/watir/browser'
+require 'extensions/watir/element'
+require 'extensions/watir/iframe'
+
+require 'watigiri/locators/element/locator'
+require 'watigiri/locators/element/selector_builder'
+require 'watigiri/locators/element/validator'
+
+Watir.locator_namespace = Watigiri::Locators

data/lib/watigiri/locators/element/locator.rb

@@ -0,0 +1,129 @@
+module Watigiri
+  module Locators
+    class Element
+      class Locator < Watir::Locators::Element::Locator
+
+        def locate
+          @nokogiri = @selector.delete(:nokogiri)
+
+          return super unless @nokogiri
+          @query_scope.browser.doc ||= Nokogiri::HTML(@query_scope.html).tap {|d| d.css('script').remove }
+
+          reset_doc = ->(browser) { browser.doc = nil }
+          @query_scope.browser.after_hooks.add(reset_doc)
+
+          find_first_by_multiple
+        end
+
+        def locate_element(how, what)
+          unless @nokogiri
+            return ensure_scope_context.find_element(how, what)
+          end
+          case how
+          when :css
+            @query_scope.browser.doc.at_css(what)
+          when :xpath
+            @query_scope.browser.doc.at_xpath(what)
+          end
+        end
+
+        def locate_elements(how, what, _scope = nil)
+          unless @nokogiri
+            return ensure_scope_context.find_elements(how, what)
+          end
+          case how
+          when :css
+            @query_scope.browser.doc.css(what).to_a
+          when :xpath
+            @query_scope.browser.doc.xpath(what).to_a
+          end
+        end
+
+        def fetch_value(element, how)
+          return super unless @nokogiri
+          case how
+          when :text
+            element.inner_text
+          when :tag_name
+            element.name.to_s.downcase
+          when :href
+            (href = element.attribute('href')) && href.to_s.strip
+          else
+            element.attribute(how.to_s.tr("_", "-")).to_s
+          end
+        end
+
+        # TODO remove after https://github.com/watir/watir/pull/630
+        def find_first_by_multiple
+          selector = selector_builder.normalized_selector
+
+          idx = selector.delete(:index) unless selector[:adjacent]
+          visible = selector.delete(:visible)
+
+          how, what = selector_builder.build(selector)
+
+          if how
+            # could build xpath/css for selector
+            if idx || !visible.nil?
+              idx ||= 0
+              elements = locate_elements(how, what)
+              elements = elements.select { |el| visible == el.displayed? } unless visible.nil?
+              elements[idx] unless elements.nil?
+            else
+              locate_element(how, what)
+            end
+          else
+            # can't use xpath, probably a regexp in there
+            if idx || !visible.nil?
+              idx ||= 0
+              elements = wd_find_by_regexp_selector(selector, :select)
+              elements = elements.select { |el| visible == el.displayed? } unless visible.nil?
+              elements[idx] unless elements.nil?
+            else
+              wd_find_by_regexp_selector(selector, :find)
+            end
+          end
+        end
+
+        # TODO Remove after https://github.com/watir/watir/pull/630
+        def wd_find_by_regexp_selector(selector, method = :find)
+          query_scope = ensure_scope_context
+          rx_selector = delete_regexps_from(selector)
+
+          if rx_selector.key?(:label) && selector_builder.should_use_label_element?
+            label = label_from_text(rx_selector.delete(:label)) || return
+            if (id = label.attribute(:for))
+              selector[:id] = id
+            else
+              query_scope = label
+            end
+          end
+
+          how, what = selector_builder.build(selector)
+
+          unless how
+            raise Error, "internal error: unable to build Selenium selector from #{selector.inspect}"
+          end
+
+          if how == :xpath && can_convert_regexp_to_contains?
+            rx_selector.each do |key, value|
+              next if key == :tag_name || key == :text
+
+              predicates = regexp_selector_to_predicates(key, value)
+              what = "(#{what})[#{predicates.join(' and ')}]" unless predicates.empty?
+            end
+          end
+
+          elements = locate_elements(how, what, query_scope)
+          elements.__send__(method) { |el| matches_selector?(el, rx_selector) }
+        end
+
+        # TODO Remove after https://github.com/watir/watir/pull/630
+        def ensure_scope_context
+          @query_scope.wd
+        end
+
+      end
+    end
+  end
+end

data/lib/watigiri/locators/element/selector_builder.rb

@@ -0,0 +1,15 @@
+module Watigiri
+  module Locators
+    class Element
+      class SelectorBuilder < Watir::Locators::Element::SelectorBuilder
+
+        def initialize(query_scope, selector, attribute_list)
+          attribute_list << :nokogiri
+          super
+          @selector.delete :nokogiri
+        end
+
+      end
+    end
+  end
+end

data/lib/watigiri/locators/element/validator.rb

@@ -0,0 +1,8 @@
+module Watigiri
+  module Locators
+    class Element
+      class Validator < Watir::Locators::Element::Validator
+      end
+    end
+  end
+end

data/watigiri.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "watigiri"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Titus Fortner"]
+  spec.email         = ["titusfortner@gmail.com"]
+
+  spec.summary       = %q{Nokogiri locator engine for Watir}
+  spec.description = <<-DESCRIPTION_MESSAGE
+By default Watir locates elements with Selenium; this gem will replace Selenium calls
+with Nokogiri calls where designated.
+  DESCRIPTION_MESSAGE
+  spec.homepage      = "http://github.com/titusfortner/watigiri"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webdrivers", "~> 2.0"
+
+  spec.add_runtime_dependency "watir"
+  spec.add_runtime_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: watigiri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Titus Fortner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  By default Watir locates elements with Selenium; this gem will replace Selenium calls
+  with Nokogiri calls where designated.
+email:
+- titusfortner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/extensions/watir/browser.rb
+- lib/extensions/watir/element.rb
+- lib/extensions/watir/iframe.rb
+- lib/watigiri.rb
+- lib/watigiri/locators/element/locator.rb
+- lib/watigiri/locators/element/selector_builder.rb
+- lib/watigiri/locators/element/validator.rb
+- watigiri.gemspec
+homepage: http://github.com/titusfortner/watigiri
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Nokogiri locator engine for Watir
+test_files: []