watigiri 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0573759dcdc508e0d1445e64121d8dff494644d5'
-  data.tar.gz: 0d6a2fd88afc9a12c41feae7734a48f481fba322
+  metadata.gz: da263e5f7d120b61e288323b90693c26727443db
+  data.tar.gz: 269323c23f8984029d65ab06111ca5ad229592cf
 SHA512:
-  metadata.gz: 7163363a5f37d845a95afa02321fbf1c4a744cd047688cf006f0de0a9e2bf336fd8e633070b46cb50768606d34521bf3fdcebb19cde3d950da379617345473a0
-  data.tar.gz: 3655a22870d163bc7d93bd691127cec5eab639f4173e5559d977dc83dbee68b6c996c0b3af6d91da7d12d02ac6cd87a3c8f1bb87521fbe2bf319937319a37201
+  metadata.gz: f556b15ed2568fc2522ae72d0cbf661d3c72968675a1ac74709c234a74dcea78d53e95798c0c624aa4cacd1a5e428365f46aa2fd31318307689387e836089889
+  data.tar.gz: 4841c01d4994f8b1994ce634d6162b6341cb77dc69126aa9589aa267e3ad575568c29ded15732a9308c77cbb1f75badbddc87b4122b0bf2c2b3d22527d20734b

data/.rubocop.yml

@@ -1,39 +1,36 @@
 AllCops:
-  TargetRubyVersion: 2.3.7
+  TargetRubyVersion: 2.3.8
+
+#
+# Default Preferences
+#
 
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: when_needed, always, never
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
-# SupportedStyles: space, no_space, compact
-# SupportedStylesForEmptyBraces: space, no_space
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
 Style/CommentedKeyword:
   Enabled: false
 
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
 Metrics/LineLength:
   Max: 120
 
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+Style/Documentation:
+  Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
-Style/Documentation:
-  Enabled: false
+#
+# Adjustable Parameters
+#
 
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 13
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/locator_spec_helper.rb'
 
-Metrics/CyclomaticComplexity:
-  Max: 10
+Metrics/MethodLength:
+  Max: 11

data/Gemfile

@@ -2,5 +2,7 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
+gem 'watir', path: File.expand_path('../watir/') if ENV['LOCAL_WATIR']
+
 # Specify your gem's dependencies in watigiri.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # Watigiri
 
-Watigiri is an add-on to Watir that attempts to make it seamless for actions to be taken using Nokogiri 
+Watigiri is an extension gem to Watir that attempts to make it seamless for actions to be taken using Nokogiri 
 instead of Selenium in the places it makes sense to do so.
 
 The advantage of Nokogiri is that it parses the DOM very quickly. This provides two primary opportunities for speeding
@@ -11,8 +11,8 @@ The advantage of Nokogiri is that it parses the DOM very quickly. This provides
  dozen wire calls to locate and obtain text information from each, you can make one wire call to obtain the DOM and then 
  quickly locate and obtain all of the information necessary at each element location.
   
-2. Iterating over a collection of elements. One of the times this happens is when locating elements using Regular
-Expressions. Watir implements this by locating a subset of elements that might match and then making wire calls
+2. Iterating over a collection of elements to match a regular expression. 
+Watir implements this by locating a subset of elements that might match and then making wire calls
 on each to check if they actually match the provided regular expression. 
 If the number of elements to be checked is large, using Nokogiri can show a significant performance improvement.
 
@@ -40,10 +40,13 @@ require 'watigiri'
 ```
 
 Once required, Watigiri will automatically speed up the location of elements using regular expression values.
+If you would like to turn this feature off, you can set: `Watigiri.match_regexp = false`
 
 To speed up the gathering of text values, use the text-bang method (`Element#text!` instead of `Element#text`).
-Watigiri flushes the cached DOM whenever a user takes an action that might have changed the DOM (clicks, navigations, etc).
-So the performance improvement will come with the number of successive calls of `#text!` before taking other actions. 
+Watigiri flushes the cached DOM whenever a user takes an action that might have changed the DOM 
+(clicks, navigations, etc).
+So the performance improvement will be based on the number of successive calls of `#text!` 
+before taking other actions. 
 
 ## Contributing
 

data/lib/extensions/watir/browser.rb

@@ -19,16 +19,6 @@ module Watir
       after_hooks.delete(@reset_doc_hook)
     end
 
-    #
-    # Uses Nokogiri to return the text of page body.
-    #
-    # @return [String]
-    #
-
-    def text!
-      body.text!
-    end
-
     def locator_namespace
       @locator_namespace ||= Watigiri::Locators
     end

data/lib/extensions/watir/element.rb

@@ -10,7 +10,7 @@ module Watir
       @doc = html
       return if html.nil?
 
-      @reset_doc_hook = ->(element) { element.reset_doc }
+      @reset_doc_hook = ->(*) { reset_doc }
       browser.after_hooks.add(@reset_doc_hook)
     end
 
@@ -19,8 +19,6 @@ module Watir
       browser.after_hooks.delete(@reset_doc_hook)
     end
 
-    #
-    # TODO - reimplement with Watir Executor when available
     #
     # Uses Nokogiri to return the text of the element.
     #
@@ -28,7 +26,7 @@ module Watir
     #
 
     def text!
-      @selector[:nokogiri] = true
+      selector_builder.built[:nokogiri] = true
       text.strip
     end
 

data/lib/watigiri.rb

@@ -3,7 +3,18 @@ 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/matcher'
+
+module Watigiri
+  @match_regexp = true
+
+  class << self
+    attr_writer :match_regexp
+
+    def match_regexp?
+      @match_regexp
+    end
+  end
+end

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

@@ -1,192 +1,98 @@
 module Watigiri
-  class Element
-    attr_reader :element, :selector
-
-    def initialize(element:, selector:)
-      @element = element
-      @selector = selector
-    end
+  module Locators
+    class Element
+      class Locator < Watir::Locators::Element::Locator
+        private
 
-    def tag_name
-      element.name.downcase
-    end
-  end
+        def matching_elements
+          return super unless use_nokogiri?
 
-  module Locators
-    module LocatorHelpers
-      def locate
-        @nokogiri = @selector.delete(:nokogiri)
-        return super unless @nokogiri || regex?
-
-        set_nokogiri
-
-        element = using_watir(:first)
-        return if element.nil?
-        @nokogiri ? element.element : nokogiri_to_selenium(element)
-      rescue Selenium::WebDriver::Error::NoSuchElementError, Selenium::WebDriver::Error::StaleElementReferenceError
-        nil
-      end
+          # Element should be using `#fragment` instead of `#inner_html`, but can't because of
+          # https://github.com/sparklemotion/nokogiri/issues/572
+          command = locator_scope.is_a?(Watir::Browser) ? :html : :inner_html
 
-      def locate_all
-        @nokogiri = @selector.delete(:nokogiri)
-        return super unless @nokogiri || regex?
+          args = wd_locator.to_a.flatten
+          args[0] = "at_#{args[0]}" unless match_regexp?
 
-        set_nokogiri
+          result = populate_doc command, *args
+          match_regexp? ? filter_elements(result) : result
+        end
 
-        elements = using_watir(:all)
-        @nokogiri ? elements.map(&:element) : elements.map { |el| nokogiri_to_selenium(el) }
-      end
+        def filter_elements(elements)
+          element_matcher.nokogiri = true
+          found = [element_matcher.match(elements, match_values, @filter)].flatten.compact
 
-      # Is only used when there is no regex, index or visibility locators
-      def locate_element(how, what, _driver_scope = @query_scope.wd)
-        return super unless @nokogiri
+          se_elements = nokogiri_to_selenium(elements, found)
+          @filter == :first ? se_elements.first : se_elements
+        end
 
-        el = @query_scope.doc.send("at_#{how}", what)
-        Watigiri::Element.new element: el, selector: {how => what}
-      end
+        def use_nokogiri?
+          @nokogiri = @built.delete(:nokogiri)
 
-      # "how" can only be :css or :xpath
-      def locate_elements(how, what, _scope = @query_scope.wd)
-        return super unless @nokogiri || regex?
+          # Neither CSS nor XPath locator found
+          return false if wd_locator.empty? || @selector.key?(:adjacent)
 
-        @query_scope.doc.send(how, what).map do |el|
-          Watigiri::Element.new element: el, selector: {how => what}
+          @nokogiri && match_values.empty? || match_regexp?
         end
-      end
 
-      def fetch_value(element, how)
-        noko_element = noko_element(element)
-        return super if noko_element.nil?
-
-        case how
-        when :text
-          noko_element.inner_text
-        when :tag_name
-          noko_element.name.downcase
-        else
-          noko_element.attribute(how.to_s.tr('_', '-')).to_s.strip
+        def populate_doc(command, key, value)
+          @query_scope.doc ||= Nokogiri::HTML(locator_scope.send(command)).tap { |d| d.css('script').remove }
+          @query_scope.doc.send(key, value)
         end
-      end
-
-      def nokogiri_to_selenium(element)
-        return element if element.is_a?(Selenium::WebDriver::Element)
-        tag = element.tag_name
-        index = @query_scope.doc.xpath(".//#{tag}").find_index { |el| el == element.element }
-        Watir::Element.new(@query_scope, index: index, tag_name: tag).wd
-      end
 
-      def regex?
-        return @regex unless @regex.nil?
+        def wd_locator
+          @wd_locator ||= @built.select { |k, _v| %i[css xpath].include?(k) }
+        end
 
-        return false unless (@selector.keys & %i[adjacent visible label text visible_text visible_label]).empty?
-        @regex = @selector.values.any? { |v| v.is_a?(Regexp) }
-      end
+        def match_regexp?
+          @match_regexp ||= Watigiri.match_regexp? && match_values.all? do |k, v|
+            v.is_a?(Regexp) && !k.to_s.include?('visible') && !k.to_s.include?('label')
+          end &&
+                            !match_values.empty?
+        end
 
-      def noko_element(element)
-        if !(@nokogiri || regex?) || element.is_a?(Selenium::WebDriver::Element)
-          nil
-        elsif element.is_a?(Watigiri::Element)
-          element.element
-        else
-          element
+        def nokogiri_to_selenium(elements, found)
+          locator_scope.elements(wd_locator).map.each_with_index do |el, idx|
+            el.wd if found&.include? elements[idx]
+          end.compact
         end
       end
+    end
 
-      def set_nokogiri
-        return if @query_scope.doc
-
-        # should be using `#fragment` instead of `#inner_html`, but can't because of
-        # https://github.com/sparklemotion/nokogiri/issues/572
-        doc = if @query_scope.is_a?(Watir::Browser)
-                Nokogiri::HTML(@query_scope.html)
-              else
-                Nokogiri::HTML(@query_scope.inner_html)
-              end
-
-        @query_scope.doc = doc.tap { |d| d.css('script').remove }
-      end
+    class TextField
+      class Locator < Element::Locator
+        def use_nokogiri?
+          return false if @built.key?(:text)
 
-      def text_regexp_deprecation(*)
-        # Nokogiri can not determine visible text so no need to check
+          super
+        end
       end
     end
 
-    class Element
-      class Locator < Watir::Locators::Element::Locator
-        include LocatorHelpers
-      end
-    end
+    class TextArea
+      class Locator < Element::Locator
+        def use_nokogiri?
+          return false if @built.key?(:value)
 
-    class Button
-      class Locator < Watir::Locators::Button::Locator
-        include LocatorHelpers
+          super
+        end
       end
     end
 
     class Cell
-      class Locator < Watir::Locators::Cell::Locator
-        include LocatorHelpers
-
-        # Don't use for rows
-        def regex?
+      class Locator < Element::Locator
+        def use_nokogiri?
           false
         end
       end
     end
 
     class Row
-      class Locator < Watir::Locators::Row::Locator
-        include LocatorHelpers
-
-        # Don't use for rows
-        def regex?
+      class Locator < Element::Locator
+        def use_nokogiri?
           false
         end
       end
     end
-
-    class TextArea
-      class Locator < Watir::Locators::Element::Locator
-        include LocatorHelpers
-
-        def regex?
-          return @regex unless @regex.nil?
-
-          return false unless (@selector.keys & %i[adjacent visible label text visible_text visible_label]).empty?
-          @regex = @selector.any? { |k, v| v.is_a?(Regexp) && k != :value }
-        end
-      end
-    end
-
-    class TextField
-      class Locator < Watir::Locators::TextField::Locator
-        include LocatorHelpers
-
-        def matches_selector?(element, rx_selector)
-          return super if element.is_a? Selenium::WebDriver::Element
-          rx_selector = rx_selector.dup
-
-          tag_name = element.tag_name
-
-          %i[text value label].each do |key|
-            next unless rx_selector.key?(key)
-            correct_key = tag_name == 'input' ? :value : :text
-            rx_selector[correct_key] = rx_selector.delete(key)
-          end
-
-          rx_selector.all? do |how, what|
-            val = fetch_value(element, how)
-            what == val || val =~ /#{what}/
-          end
-        end
-
-        def regex?
-          return @regex unless @regex.nil?
-
-          return false unless (@selector.keys & %i[adjacent visible label text visible_text visible_label]).empty?
-          @regex = @selector.any? { |k, v| v.is_a?(Regexp) && k != :value }
-        end
-      end
-    end
   end
 end

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

@@ -0,0 +1,48 @@
+module Watigiri
+  module Locators
+    module MatcherHelpers
+      attr_accessor :nokogiri
+
+      def matching_labels(elements, *)
+        nokogiri ? elements : super
+      end
+
+      def fetch_value(element, how)
+        return super unless nokogiri
+
+        case how
+        when :text
+          element.inner_text
+        when :href
+          element.attribute('href')&.to_s&.strip
+        when :tag_name
+          element.name.downcase
+        else
+          super.to_s
+        end
+      end
+
+      def deprecate_text_regexp(*)
+        # not applicable to Watigiri
+      end
+    end
+
+    class Button
+      class Matcher < Watir::Locators::Button::Matcher
+        include MatcherHelpers
+      end
+    end
+
+    class Element
+      class Matcher < Watir::Locators::Element::Matcher
+        include MatcherHelpers
+      end
+    end
+
+    class TextField
+      class Matcher < Watir::Locators::TextField::Matcher
+        include MatcherHelpers
+      end
+    end
+  end
+end

data/watigiri.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'watigiri'
-  spec.version       = '0.6.3'
+  spec.version       = '0.7.0'
   spec.authors       = ['Titus Fortner']
   spec.email         = ['titusfortner@gmail.com']
 
@@ -22,12 +22,12 @@ Gem::Specification.new do |spec|
   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 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'webdrivers', '~> 3.3', '>= 3.3.3'
 
   spec.add_runtime_dependency 'nokogiri'
-  spec.add_runtime_dependency 'watir', '~> 6.15', '< 6.16'
+  spec.add_runtime_dependency 'watir', '~> 6.16.4'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: watigiri
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Titus Fortner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-16 00:00:00.000000000 Z
+date: 2018-12-25 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -106,20 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.15'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.16'
+        version: 6.16.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.15'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.16'
+        version: 6.16.4
 description: |
   By default Watir locates elements with Selenium; this gem will replace Selenium calls
   with Nokogiri calls where designated.
@@ -139,10 +133,9 @@ files:
 - 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/matcher.rb
 - support/travis.sh
 - watigiri.gemspec
 homepage: http://github.com/titusfortner/watigiri

data/lib/extensions/watir/iframe.rb

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

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

@@ -1,46 +0,0 @@
-module Watigiri
-  module Locators
-    module SelectorHelpers
-      def normalized_selector
-        @selector.delete(:nokogiri)
-        super
-      end
-    end
-
-    class Element
-      class SelectorBuilder < Watir::Locators::Element::SelectorBuilder
-        include SelectorHelpers
-      end
-    end
-
-    class Button
-      class SelectorBuilder < Watir::Locators::Button::SelectorBuilder
-        include SelectorHelpers
-      end
-    end
-
-    class Cell
-      class SelectorBuilder < Watir::Locators::Cell::SelectorBuilder
-        include SelectorHelpers
-      end
-    end
-
-    class Row
-      class SelectorBuilder < Watir::Locators::Row::SelectorBuilder
-        include SelectorHelpers
-      end
-    end
-
-    class TextArea
-      class SelectorBuilder < Watir::Locators::TextArea::SelectorBuilder
-        include SelectorHelpers
-      end
-    end
-
-    class TextField
-      class SelectorBuilder < Watir::Locators::TextField::SelectorBuilder
-        include SelectorHelpers
-      end
-    end
-  end
-end