unobtainium-multifind 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b372724a026239958b189cca8eef2da19be56b32
-  data.tar.gz: 09e80f23d67eaa9038944a0d9b85eae6a04609c6
+  metadata.gz: 392fa2fb38d4cec4325a05a5b69243a5f9f4be07
+  data.tar.gz: c56559898399e3d17d8642d6e819c8983aa5edbb
 SHA512:
-  metadata.gz: c593de1984c2fd92e32379caf34104037fd249c7349c590c60df58042b349d5e67577977146ad1e85d4bd7e036e9a7d7b74897f6d49f3b92f93ae0729e10ad3d
-  data.tar.gz: 008eb7a5e629f1cf95113287c18f60d861af673e68bc17c4a00665d8eae0595cccc0542d30987e4563b33f7204f830d69c581795d1d850d0291e6eb77e5a5a43
+  metadata.gz: 1774529bf9115b1ab19348ba2e34acf6110d841f90a2aea769f40ade372cceddc7224a120d06048b25255f7ce9ec731a058735ec29fc79b8c1d09b025120fa63
+  data.tar.gz: ec8e6dff393173d2a35eb9547b79de88b37cda555a74c5df10ea8557b598f69ae7ac8de12b544b3c37f9b10ecda6f21091cacb27c783d8f8c2f28a28ccc0ea6d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unobtainium-multifind (0.1.0)
+    unobtainium-multifind (0.2.0)
       unobtainium (~> 0.5)
 
 GEM

data/lib/unobtainium-multifind/multifind.rb

@@ -32,6 +32,10 @@ module Unobtainium
         # If :last is specified, the last non-error result is
         #   returned.
         find: :all,
+        # Defaults to only finding :displayed? elements. You can use any method
+        # that Selenium::WebDriver::Element responds to, or :exists? if you only
+        # care whether the element exists.
+        check_element: :displayed?,
       }.freeze
 
       class << self
@@ -48,6 +52,13 @@ module Unobtainium
       attr_accessor :multifind_options
       @multifind_options = DEFAULT_OPTIONS
 
+      ##
+      # 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.
+      # @return Array of found elements or nil entries if no matching element
+      #   was found.
       def multifind(*args)
         # Parse options
         options, selectors = multifind_parse_options(*args)
@@ -118,6 +129,15 @@ module Unobtainium
             ":last, but is: #{options[:find]}"
         end
 
+        # Ensure that 'check_element' contains only valid options.
+        elem_klass = ::Selenium::WebDriver::Element
+        if options[:check_element] != :exists? and
+           not elem_klass.instance_methods.include?(options[:check_element])
+          raise ArgumentError, ":check_element must either be :exists? or "\
+            "a boolean method that ::Selenium::WebDriver::Element responds to, "\
+            "but got: #{options[:check_element]}"
+        end
+
         return options, selectors
       end
 
@@ -125,6 +145,40 @@ module Unobtainium
       # Filters results from multifind; this largely means honouring the
       # :find option.
       def multifind_filter_results(options, results)
+        results = multifind_collapse_results(options, results)
+
+        # If we're only checking for existence, we're done here.
+        if options[:check_element] == :exists?
+          return results
+        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
+          end
+
+          filtered << nil
+        end
+
+        return filtered
+      end
+
+      ##
+      # Collapses results to only return what's specified by :find.
+      def multifind_collapse_results(options, results)
         # That was easy!
         if options[:find] == :all
           return results

data/lib/unobtainium-multifind/version.rb

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

data/spec/data/foo.html

@@ -1,4 +1,5 @@
 <foo>
   <bar>
-    <something>else</something>
+    <something>else</something></bar>
+  <hidden style="display: none"></hidden>
 <foo>

data/spec/module_spec.rb

@@ -148,6 +148,29 @@ describe 'Unobtainium::MultiFind::DriverModule' do
       expect(elem).to be_empty
     end
 
+    it "does not find hidden elements by default" do
+      drv = @tester.driver(DRIVER)
+      drv.navigate.to(TEST_URL)
+
+      elem = drv.find(xpath: '//foo/hidden')
+      expect(elem).not_to be_nil
+      expect(elem).not_to be_empty
+      expect(elem[0]).to be_nil
+    end
+
+    it "finds hidden element with :exists?" do
+      drv = @tester.driver(DRIVER)
+      drv.navigate.to(TEST_URL)
+
+      # rubocop:disable Style/BracesAroundHashParameters
+      elem = drv.find({ xpath: '//hidden' },
+                      { check_element: :exists? })
+      # rubocop:enable Style/BracesAroundHashParameters
+      expect(elem).not_to be_nil
+      expect(elem).not_to be_empty
+      expect(elem[0]).not_to be_nil
+    end
+
     it "passes non-hash arguments without touching them" do
       drv = @tester.driver(DRIVER)
       drv.navigate.to(TEST_URL)
@@ -212,5 +235,22 @@ describe 'Unobtainium::MultiFind::DriverModule' do
         drv.find(xpath: '//foo')
       end.to raise_error
     end
+
+    it "validates :check_element" do
+      drv = @tester.driver(DRIVER)
+      drv.navigate.to(TEST_URL)
+
+      # Good option
+      drv.multifind_options = { check_element: :exists? }
+      expect do
+        drv.find(xpath: '//foo')
+      end.not_to raise_error
+
+      # Bad option
+      drv.multifind_options = { check_element: :foobar }
+      expect do
+        drv.find(xpath: '//foo')
+      end.to raise_error
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unobtainium-multifind
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler