unobtainium-multifind 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 392fa2fb38d4cec4325a05a5b69243a5f9f4be07
-  data.tar.gz: c56559898399e3d17d8642d6e819c8983aa5edbb
+  metadata.gz: c8353b1d5e748ec3304a0279b370b43a78914df5
+  data.tar.gz: a73f7d17ed12dccace0cfb453874373f5bc6acb1
 SHA512:
-  metadata.gz: 1774529bf9115b1ab19348ba2e34acf6110d841f90a2aea769f40ade372cceddc7224a120d06048b25255f7ce9ec731a058735ec29fc79b8c1d09b025120fa63
-  data.tar.gz: ec8e6dff393173d2a35eb9547b79de88b37cda555a74c5df10ea8557b598f69ae7ac8de12b544b3c37f9b10ecda6f21091cacb27c783d8f8c2f28a28ccc0ea6d
+  metadata.gz: 89196e5772927c51b4e0a07700a2b9dc348380ec2633b6fe779d1aaf2cf9050777b8a4c005e0c9c90a8163bc02e6f17fee39220c5043a6fe06032d3b9341760f
+  data.tar.gz: b7f000cd8f7159f3ba083a629437953e5a70b7e15e1a2ec8d798a84f843c1047dec7611cb6d2228591ceab8113c3ef8382293ab8c9d0e17cd652deb1a156e1e7

data/.rubocop.yml

@@ -70,3 +70,6 @@ Style/NumericLiterals:
 
 Style/FileName:
   Enabled: false
+
+Style/SpaceAfterNot:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unobtainium-multifind (0.2.0)
+    unobtainium-multifind (0.3.0)
       unobtainium (~> 0.5)
 
 GEM
@@ -35,8 +35,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.39.0)
-      parser (>= 2.3.0.7, < 3.0)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
@@ -68,11 +68,11 @@ DEPENDENCIES
   phantomjs
   rake (~> 11.1)
   rspec (~> 3.4)
-  rubocop (~> 0.39)
+  rubocop (~> 0.40)
   selenium-webdriver
   simplecov (~> 0.11)
   unobtainium-multifind!
   yard (~> 0.8)
 
 BUNDLED WITH
-   1.12.1
+   1.12.3

data/lib/unobtainium-multifind/multifind.rb

@@ -36,6 +36,10 @@ module Unobtainium
         # that Selenium::WebDriver::Element responds to, or :exists? if you only
         # care whether the element exists.
         check_element: :displayed?,
+        # The default method to perform the actual find is :find_element, but
+        # you can override this here. The most sensible case would be to use
+        # :find_elements instead, of course.
+        find_method: :find_element,
       }.freeze
 
       class << self
@@ -54,9 +58,9 @@ module Unobtainium
 
       ##
       # Find multiple elements. Each argument is a Hash of selector options
-      # that are passed to #find_element. If one argument contains keys from
-      # the DEFAULT_OPTIONS Hash, it is instead treated as an options Hash for
-      # the #multifind method.
+      # that are passed to options[:find_method]. If one argument contains keys
+      # from the DEFAULT_OPTIONS Hash, it is instead treated as an options Hash
+      # for the #multifind method.
       # @return Array of found elements or nil entries if no matching element
       #   was found.
       def multifind(*args)
@@ -67,7 +71,7 @@ module Unobtainium
         results = []
         selectors.each do |selector|
           begin
-            results << find_element(selector)
+            results << send(options[:find_method], selector)
           rescue ::Selenium::WebDriver::Error::NoSuchElementError => err
             if options[:raise_on_error]
               raise
@@ -153,24 +157,13 @@ module Unobtainium
         end
 
         # Filter all results according to the :check_element option
-        filtered = []
-        results.each do |result|
-          if result.nil?
-            filtered << result
-            next
-          end
-          if result.is_a?(::Selenium::WebDriver::Error::NoSuchElementError)
-            filtered << result
-            next
-          end
-
-          # Run check_element
-          if result.send(options[:check_element])
-            filtered << result
-            next
+        filtered = results.map do |result|
+          if result.is_a? Array
+            next result.map do |inner|
+              next apply_filter(inner, options)
+            end
           end
-
-          filtered << nil
+          next apply_filter(result, options)
         end
 
         return filtered
@@ -205,10 +198,28 @@ module Unobtainium
         # or :last. An empty result is appropriate.
         return []
       end
+
+      ##
+      # Applies the :check_element filter
+      def apply_filter(elem, options)
+        if elem.nil?
+          return elem
+        end
+
+        if elem.is_a?(::Selenium::WebDriver::Error::NoSuchElementError)
+          return elem
+        end
+
+        if elem.send(options[:check_element])
+          return elem
+        end
+        return nil
+      end
     end # module DriverModule
   end # module MultiFind
 end # module Unobtainium
 
 ::Unobtainium::Driver.register_module(
     ::Unobtainium::MultiFind::DriverModule,
-    __FILE__)
+    __FILE__
+)

data/lib/unobtainium-multifind/version.rb

@@ -9,6 +9,6 @@
 module Unobtainium
   module MultiFind
     # The current release version
-    VERSION = "0.2.0".freeze
+    VERSION = "0.3.0".freeze
   end # module MultiFind
 end # module Unobtainium

data/spec/module_spec.rb

@@ -38,6 +38,10 @@ describe 'Unobtainium::MultiFind::DriverModule' do
   end
 
   describe "find functionality" do
+    before do
+      require 'unobtainium-multifind'
+    end
+
     it "can find a single element" do
       drv = @tester.driver(DRIVER)
       drv.navigate.to(TEST_URL)
@@ -181,6 +185,10 @@ describe 'Unobtainium::MultiFind::DriverModule' do
   end
 
   describe "find options" do
+    before do
+      require 'unobtainium-multifind'
+    end
+
     it "can throw on errors" do
       drv = @tester.driver(DRIVER)
       drv.navigate.to(TEST_URL)
@@ -252,5 +260,50 @@ describe 'Unobtainium::MultiFind::DriverModule' do
         drv.find(xpath: '//foo')
       end.to raise_error
     end
+
+    it "can override the find method with :find_elements" do
+      drv = @tester.driver(DRIVER)
+      drv.navigate.to(TEST_URL)
+
+      drv.multifind_options = { find_method: :find_elements }
+
+      elem = drv.find(xpath: '//foo/bar')
+      expect(elem).not_to be_nil
+      expect(elem).not_to be_empty
+      expect(elem.length).to eql 1
+      expect(elem[0]).not_to be_nil
+
+      expect(elem[0].is_a?(Array)).to be_truthy
+      expect(elem[0].length).to eql 1
+      expect(elem[0][0]).not_to be_nil
+    end
+
+    it "treats hidden elements well with :find_elements" do
+      drv = @tester.driver(DRIVER)
+      drv.navigate.to(TEST_URL)
+
+      drv.multifind_options = { find_method: :find_elements }
+
+      elem = drv.find(xpath: '//foo/hidden')
+      expect(elem).not_to be_nil
+      expect(elem).not_to be_empty
+      expect(elem.length).to eql 1
+      expect(elem[0]).not_to be_nil
+
+      expect(elem[0].is_a?(Array)).to be_truthy
+      expect(elem[0].length).to eql 1
+      expect(elem[0][0]).to be_nil
+    end
+
+    it "raises errors when the find method is invalid" do
+      drv = @tester.driver(DRIVER)
+      drv.navigate.to(TEST_URL)
+
+      drv.multifind_options = { find_method: :does_not_exist }
+
+      expect do
+        drv.find(xpath: '//foo/bar')
+      end.to raise_error
+    end
   end
 end

data/unobtainium-multifind.gemspec

@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.requirements  = "Unobtainium driver implementing the Selenium API"
 
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rubocop", "~> 0.39"
+  spec.add_development_dependency "rubocop", "~> 0.40"
   spec.add_development_dependency "rake", "~> 11.1"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "simplecov", "~> 0.11"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unobtainium-multifind
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
+        version: '0.40'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
+        version: '0.40'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement