watigiri 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b36e470816ed59fba3a8f7cd7357b9e75c8aeba
-  data.tar.gz: a28a573735e93769350e3334a765a9517bc9740e
+  metadata.gz: b54f1a44d2ce370b82465ea35623426beb9cc700
+  data.tar.gz: 16c9d06260d4a01271bc7f789a816e9d20cbdee3
 SHA512:
-  metadata.gz: f683a88e709c46de0d7d8cbc91adaba4c4e6641c8e450b630768ccc8f43b0dc454b272b0e833ca27a770904c9d4ff867bda4faae1f8f969411112b850de6e445
-  data.tar.gz: e46b1b71bb6d266d6b24492ab6ba989c3cbd8da455f5183d28d21694f60c65ba87ecece979204d6be072784a8b7a6c813d41913f3296c7ec4dd35bcdc4956da7
+  metadata.gz: 68cad5b608ac6b3eebc53f1c36b62371c968db2af9035cfa352a5f96c915a5ca0cb9eb3651f275d3b634fabf44f68fd360905298d7db485a0ce9d9c75ff3a10c
+  data.tar.gz: be6cb2c9ff17d61c292c4b26a86ed4ddc9da9eabc95a8ec777cafa0cecaad50ad8f9bae0143b7b6513a6fcf553f95d0e5c5b06e18124c78151c738d8cbb0032b

data/README.md

@@ -1,8 +1,20 @@
 # 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
+Watigiri is an add-on 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
+ up Watir usage.
+ 
+1. Obtaining multiple successive pieces of information about elements from a static DOM. For instance, to verify 
+ that the text displayed on a page is the data that was previously entered into a form. Rather than making several
+ 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
+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.
 
 ## Installation
 
@@ -22,17 +34,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+First require it in your code:
+```ruby
+require 'watigiri'
+```
 
-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.
+Once required, Watigiri will automatically speed up the location of elements using regular expression values.
 
-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).
+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. 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/watigiri.
+Bug reports and pull requests are welcome on GitHub at https://github.com/titusfortner/watigiri.
 
 ## License
 

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

@@ -17,7 +17,7 @@ module Watigiri
         return super unless @nokogiri || @regex
         @query_scope.browser.doc ||= Nokogiri::HTML(@query_scope.html).tap { |d| d.css('script').remove }
 
-        element = find_first_by_multiple
+        element = using_watir(:first)
         return if element.nil?
         @nokogiri ? element.element : nokogiri_to_selenium(element)
       end
@@ -29,7 +29,7 @@ module Watigiri
         return super unless @nokogiri || @regex
         @query_scope.browser.doc ||= Nokogiri::HTML(@query_scope.html).tap { |d| d.css('script').remove }
 
-        elements = find_all_by_multiple
+        elements = using_watir(:all)
         @nokogiri ? elements : elements.map { |element| nokogiri_to_watir element }
       end
 
@@ -50,19 +50,20 @@ module Watigiri
         end
       end
 
-      def filter_elements noko_elements, visible, idx, number
+      def filter_elements_by_locator noko_elements, visible = nil, visible_text = nil, idx = nil, tag_name: nil, filter: :first
         return super unless @nokogiri || @regex
         return super if noko_elements.first.is_a?(Selenium::WebDriver::Element)
 
         unless visible.nil?
           noko_elements.select! { |el| visible == nokogiri_to_watir(el.element).visible? }
         end
-        number == :single ? noko_elements[idx || 0] : noko_elements
+        filter == :first ? noko_elements[idx || 0] : noko_elements
       end
 
-      def filter_elements_by_regex(noko_elements, rx_selector, method)
+      def filter_elements_by_regex(noko_elements, rx_selector, filter)
         return if noko_elements.empty?
         return super if noko_elements.first.is_a?(Selenium::WebDriver::Element)
+        method = filter == :first ? :find : :select
 
         if @nokogiri || !@regex
           return noko_elements.__send__(method) { |el| matches_selector?(el.element, rx_selector) }

data/watigiri.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "watigiri"
-  spec.version       = "0.2.1"
+  spec.version       = "0.2.2"
   spec.authors       = ["Titus Fortner"]
   spec.email         = ["titusfortner@gmail.com"]
 
@@ -28,6 +28,6 @@ with Nokogiri calls where designated.
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webdrivers", "~> 3.0"
 
-  spec.add_runtime_dependency "watir", "~> 6.8", ">= 6.8.2"
+  spec.add_runtime_dependency "watir", "~> 6.10"
   spec.add_runtime_dependency "nokogiri"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watigiri
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Titus Fortner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,20 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.8.2
+        version: '6.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.8.2
+        version: '6.10'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement