site_prism 2.14 → 2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b74604cbe9c1815149c4bce7c747d9087098ade
-  data.tar.gz: 5043802657e6d0f88d6f52ea8790b49b8e634dd5
+  metadata.gz: f4e3fd2e00cf2bb78219d9f9fbeabd2f7508acc6
+  data.tar.gz: 49f28a586eead92eaf7be65e8471a713a9d07f49
 SHA512:
-  metadata.gz: 4683666aa25142921dfab489841ef22eed10768978cd6c0ba69d768517a28cfcd7ef236fa5291c9a951836ea3bf3f762e2c25451ff5ad30940ec7db071c204cb
-  data.tar.gz: 5ade19c3956fbf314b096831c72f9c0d9f572ab5995384d389cfd795ada012b4e63e3036ca612fafa3b78658bb037391bddc19f09a1e6fa97f27772901a0a1c1
+  metadata.gz: 054cfa56172cf001d9c3e3b131f9fb382fe901034bbf913831189a6b091e01f4ddc2e73af69c9c60ac5c7ad5fe32e1dc615eca04e84fe4a5aec398166c430b16
+  data.tar.gz: c539b113a2b70cb84467675346132599cc75512012860676ab21c53fd1b1e853d633809df6122d3bbaa0cc0295bc5ae2be5dc44626529799db25ac685c827ce0

data/README.md

@@ -17,7 +17,7 @@ We have a brief set of setup docs [HERE](https://github.com/natritmeyer/site_pri
 
 ## Supported Rubies / Browsers
 
-SitePrism is built and tested to work on Ruby 2.1 - 2.5. There is also some limited support for Ruby 2.0.0.
+SitePrism is built and tested to work on Ruby 2.2 - 2.5. There is also some limited support for the Ruby 2.1 series.
 
 SitePrism should run on all major browsers. The gem's integration tests are ran on the latest versions of Chrome and Firefox.
 
@@ -521,7 +521,7 @@ Another method added by calling `element` is the
 `wait_until_<element_name>_visible` method. Calling this method will
 cause the test to wait for Capybara's default wait time for the element
 to become visible (*not* the same as existence!). You can customise the
-wait time be supplying a number of seconds to wait. Using the above
+wait time by supplying a number of seconds to wait. Using the above
 example:
 
 ```ruby
@@ -651,7 +651,7 @@ it wil return `false`. For example, with the following page:
 
 ```ruby
 class Friends < SitePrism::Page
-  elements(:names, 'ul#names li a')
+  elements :names, 'ul#names li a'
 end
 ```
 
@@ -1733,6 +1733,18 @@ with this:
 @search_page.search_results
 ```
 
+Note that even with implicit waits on you can temporarily modify wait times in SitePrism to help work-around special circumstances.  
+
+```rb
+# Option 1: using wait_for
+@search_page.wait_for_search_results(30) # will wait up to 30seconds
+
+# Option 2: using Capybara directly 
+Capybara.using_wait_time(30) do
+  @search_page.subsection.search_results
+end
+```
+
 ## Raising Errors on wait_for
 
 By default, when using `wait_for_*` and `wait_for_no_*` methods, SitePrism will not raise

data/lib/site_prism/addressable_url_matcher.rb

@@ -47,10 +47,9 @@ module SitePrism
     def all_expected_mappings_match?(expected_mappings, actual_mappings)
       expected_mappings.all? do |key, expected_value|
         actual_value = actual_mappings[key.to_s]
-        case expected_value
-        when Numeric
+        if expected_value.is_a?(Numeric)
           actual_value == expected_value.to_s
-        when Regexp
+        elsif expected_value.is_a?(Regexp)
           actual_value.match(expected_value)
         else
           expected_value == actual_value

data/lib/site_prism/element_container.rb

@@ -8,6 +8,10 @@ module SitePrism
 
     private
 
+    def max_wait_time
+      Capybara.default_max_wait_time
+    end
+
     def raise_if_block(obj, name, has_block)
       return unless has_block
 
@@ -28,6 +32,11 @@ module SitePrism
             "Timed out after #{timeout}s waiting for no #{obj.class}##{name}"
     end
 
+    # Sanitize method called before calling any SitePrism DSL method or
+    # meta-programmed method. This ensures that the Capybara query is correct.
+    #
+    # Accepts any combination of arguments sent at DSL definition or runtime
+    # and combines them in such a way that Capybara can operate with them.
     def merge_args(find_args, runtime_args, override_options = {})
       find_args = find_args.dup
       runtime_args = runtime_args.dup
@@ -35,64 +44,81 @@ module SitePrism
       options.merge!(find_args.pop) if find_args.last.is_a? Hash
       options.merge!(runtime_args.pop) if runtime_args.last.is_a? Hash
       options.merge!(override_options)
+      options[:wait] = false unless wait_required?(options)
+
+      return [*find_args, *runtime_args] if options.empty?
+
       [*find_args, *runtime_args, options]
     end
 
+    def wait_required?(options)
+      SitePrism.use_implicit_waits || options.key?(:wait)
+    end
+
+    # rubocop:disable Metrics/ModuleLength
     module ClassMethods
       attr_reader :mapped_items, :expected_items
 
-      def element(element_name, *find_args)
-        build(element_name, *find_args) do
-          define_method(element_name.to_s) do |*runtime_args, &element_block|
-            raise_if_block(self, element_name.to_s, !element_block.nil?)
-            find_first(*merge_args(find_args, runtime_args))
+      def element(name, *find_args)
+        build(name, *find_args) do
+          define_method(name) do |*runtime_args, &element_block|
+            raise_if_block(self, name, !element_block.nil?)
+            _find(*merge_args(find_args, runtime_args))
           end
         end
       end
 
-      def elements(collection_name, *find_args)
-        build(collection_name, *find_args) do
-          define_method(collection_name.to_s) do |*runtime_args, &element_block|
-            raise_if_block(self, collection_name.to_s, !element_block.nil?)
-            find_all(*merge_args(find_args, runtime_args))
+      def elements(name, *find_args)
+        build(name, *find_args) do
+          define_method(name) do |*runtime_args, &element_block|
+            raise_if_block(self, name, !element_block.nil?)
+            _all(*merge_args(find_args, runtime_args))
           end
         end
       end
-      alias collection elements
+
+      def collection(name, *find_args)
+        warn 'Using collection is now deprecated and will be removed.'
+        warn 'Use elements DSL notation instead.'
+        elements(name, *find_args)
+      end
 
       def expected_elements(*elements)
         @expected_items = elements
       end
 
-      def section(section_name, *args, &block)
+      def section(name, *args, &block)
         section_class, find_args = extract_section_options(args, &block)
-        build(section_name, *find_args) do
-          define_method section_name do |*runtime_args, &runtime_block|
-            section_class.new self, find_first(*merge_args(find_args, runtime_args)), &runtime_block
+        build(name, *find_args) do
+          define_method(name) do |*runtime_args, &runtime_block|
+            section_element = _find(*merge_args(find_args, runtime_args))
+            section_class.new(self, section_element, &runtime_block)
           end
         end
       end
 
-      def sections(section_collection_name, *args, &block)
+      def sections(name, *args, &block)
         section_class, find_args = extract_section_options(args, &block)
-        build(section_collection_name, *find_args) do
-          define_method(section_collection_name) do |*runtime_args, &element_block|
-            raise_if_block(self, section_collection_name.to_s, !element_block.nil?)
-            find_all(*merge_args(find_args, runtime_args)).map do |element|
+        build(name, *find_args) do
+          define_method(name) do |*runtime_args, &element_block|
+            raise_if_block(self, name, !element_block.nil?)
+            _all(*merge_args(find_args, runtime_args)).map do |element|
               section_class.new(self, element)
             end
           end
         end
       end
 
-      def iframe(iframe_name, iframe_page_class, *args)
+      def iframe(name, klass, *args)
         element_find_args = deduce_iframe_element_find_args(args)
         scope_find_args = deduce_iframe_scope_find_args(args)
-        add_to_mapped_items(iframe_name)
-        add_iframe_helper_methods(iframe_name, *element_find_args)
-        define_method(iframe_name) do |&block|
+        add_to_mapped_items(name)
+        add_iframe_helper_methods(name, *element_find_args)
+        define_method(name) do |&block|
+          raise BlockMissingError unless block
+
           within_frame(*scope_find_args) do
-            block.call iframe_page_class.new
+            block.call(klass.new)
           end
         end
       end
@@ -142,10 +168,9 @@ module SitePrism
         method_name = "has_#{element_name}?"
         create_helper_method(method_name, *find_args) do
           define_method(method_name) do |*runtime_args|
-            wait_time = SitePrism.use_implicit_waits ? Capybara.default_max_wait_time : 0
-            Capybara.using_wait_time(wait_time) do
-              element_exists?(*merge_args(find_args, runtime_args))
-            end
+            wait_time = SitePrism.use_implicit_waits ? max_wait_time : 0
+            visibility_args = { wait: wait_time }
+            element_exists?(*merge_args(find_args, runtime_args, **visibility_args))
           end
         end
       end
@@ -154,10 +179,11 @@ module SitePrism
         method_name = "has_no_#{element_name}?"
         create_helper_method(method_name, *find_args) do
           define_method(method_name) do |*runtime_args|
-            wait_time = SitePrism.use_implicit_waits ? Capybara.default_max_wait_time : 0
-            Capybara.using_wait_time(wait_time) do
-              element_does_not_exist?(*merge_args(find_args, runtime_args))
-            end
+            wait_time = SitePrism.use_implicit_waits ? max_wait_time : 0
+            visibility_args = { wait: wait_time }
+            element_does_not_exist?(
+              *merge_args(find_args, runtime_args, **visibility_args)
+            )
           end
         end
       end
@@ -165,10 +191,9 @@ module SitePrism
       def create_waiter(element_name, *find_args)
         method_name = "wait_for_#{element_name}"
         create_helper_method(method_name, *find_args) do
-          define_method(method_name) do |timeout = Capybara.default_max_wait_time, *runtime_args|
-            result = Capybara.using_wait_time(timeout) do
-              element_exists?(*merge_args(find_args, runtime_args))
-            end
+          define_method(method_name) do |timeout = max_wait_time, *runtime_args|
+            visibility_args = { wait: timeout }
+            result = element_exists?(*merge_args(find_args, runtime_args, **visibility_args))
             raise_wait_for_if_failed(self, element_name.to_s, timeout, !result)
             result
           end
@@ -178,12 +203,11 @@ module SitePrism
       def create_nonexistence_waiter(element_name, *find_args)
         method_name = "wait_for_no_#{element_name}"
         create_helper_method(method_name, *find_args) do
-          define_method(method_name) do |timeout = Capybara.default_max_wait_time, *runtime_args|
-            result = Capybara.using_wait_time(timeout) do
-              element_does_not_exist?(*merge_args(find_args, runtime_args))
-            end
-            raise_wait_for_no_if_failed(self, element_name.to_s, timeout, !result)
-            result
+          define_method(method_name) do |timeout = max_wait_time, *runtime_args|
+            visibility_args = { wait: timeout }
+            res = element_does_not_exist?(*merge_args(find_args, runtime_args, **visibility_args))
+            raise_wait_for_no_if_failed(self, element_name.to_s, timeout, !res)
+            res
           end
         end
       end
@@ -191,10 +215,11 @@ module SitePrism
       def create_visibility_waiter(element_name, *find_args)
         method_name = "wait_until_#{element_name}_visible"
         create_helper_method(method_name, *find_args) do
-          define_method(method_name) do |timeout = Capybara.default_max_wait_time, *runtime_args|
-            unless element_exists?(*merge_args(find_args, runtime_args, visible: true, wait: timeout))
-              raise SitePrism::TimeOutWaitingForElementVisibility
-            end
+          define_method(method_name) do |timeout = max_wait_time, *runtime_args|
+            visibility_args = { visible: true, wait: timeout }
+            args = merge_args(find_args, runtime_args, **visibility_args)
+            return true if element_exists?(*args)
+            raise SitePrism::TimeOutWaitingForElementVisibility
           end
         end
       end
@@ -202,17 +227,19 @@ module SitePrism
       def create_invisibility_waiter(element_name, *find_args)
         method_name = "wait_until_#{element_name}_invisible"
         create_helper_method(method_name, *find_args) do
-          define_method(method_name) do |timeout = Capybara.default_max_wait_time, *runtime_args|
-            unless element_does_not_exist?(*merge_args(find_args, runtime_args, visible: true, wait: timeout))
-              raise SitePrism::TimeOutWaitingForElementInvisibility
-            end
+          define_method(method_name) do |timeout = max_wait_time, *runtime_args|
+            visibility_args = { visible: true, wait: timeout }
+            args = merge_args(find_args, runtime_args, **visibility_args)
+            return true if element_does_not_exist?(*args)
+            raise SitePrism::TimeOutWaitingForElementInvisibility
           end
         end
       end
 
       def create_no_selector(method_name)
         define_method(method_name) do
-          raise SitePrism::NoSelectorForElement.new, "#{self.class.name} => :#{method_name} needs a selector"
+          raise SitePrism::NoSelectorForElement.new,
+                "#{self.class.name} => :#{method_name} needs a selector"
         end
       end
 
@@ -255,8 +282,8 @@ module SitePrism
         klass = Class.new(klass || SitePrism::Section, &block) if block_given?
 
         unless klass
-          raise ArgumentError, "You should provide descendant of SitePrism::Section \
-class or/and a block as the second argument."
+          raise ArgumentError, "You should provide descendant of \
+SitePrism::Section class or/and a block as the second argument."
         end
         klass
       end
@@ -272,5 +299,6 @@ in section creation or set_default_search_arguments within section class")
         args if args && !args.empty?
       end
     end
+    # rubocop:enable Metrics/ModuleLength
   end
 end

data/lib/site_prism/exceptions.rb

@@ -30,5 +30,11 @@ Templated port numbers are unsupported."
     end
   end
 
+  class BlockMissingError < StandardError
+    def message
+      'You can only use iFrames in a block context. See docs for more details.'
+    end
+  end
+
   NotLoadedError = Class.new(StandardError)
 end

data/lib/site_prism/page.rb

@@ -80,8 +80,8 @@ module SitePrism
       @url_matcher = page_url_matcher
     end
 
-    def self.url
-      @url
+    class << self
+      attr_reader :url
     end
 
     def self.url_matcher
@@ -103,11 +103,11 @@ module SitePrism
 
     private
 
-    def find_first(*find_args)
+    def _find(*find_args)
       page.find(*find_args)
     end
 
-    def find_all(*find_args)
+    def _all(*find_args)
       page.all(*find_args)
     end
 

data/lib/site_prism/section.rb

@@ -51,9 +51,9 @@ module SitePrism
     end
 
     def parent_page
-      candidate_page = parent
-      candidate_page = candidate_page.parent until candidate_page.is_a?(SitePrism::Page)
-      candidate_page
+      candidate = parent
+      candidate = candidate.parent until candidate.is_a?(SitePrism::Page)
+      candidate
     end
 
     def native
@@ -62,16 +62,20 @@ module SitePrism
 
     private
 
-    def find_first(*find_args)
-      root_element.find(*find_args)
+    def _find(*find_args)
+      page.find(*find_args)
+    end
+
+    def _all(*find_args)
+      page.all(*find_args)
     end
 
     def element_exists?(*find_args)
-      root_element.has_selector?(*find_args) unless root_element.nil?
+      page && page.has_selector?(*find_args)
     end
 
     def element_does_not_exist?(*find_args)
-      root_element.has_no_selector?(*find_args) unless root_element.nil?
+      page && page.has_no_selector?(*find_args)
     end
   end
 end

data/lib/site_prism/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SitePrism
-  VERSION = '2.14'.freeze
+  VERSION = '2.15'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: '2.14'
+  version: '2.15'
 platform: ruby
 authors:
 - Nat Ritmeyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -29,44 +29,50 @@ dependencies:
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,28 +93,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -129,14 +135,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
 description: |-
   SitePrism gives you a simple, clean and semantic DSL for describing your site.
   SitePrism implements the Page Object Model pattern on top of Capybara.
@@ -159,10 +165,13 @@ files:
 - lib/site_prism/section.rb
 - lib/site_prism/version.rb
 - lib/site_prism/waiter.rb
-homepage: http://github.com/natritmeyer/site_prism
+homepage: https://github.com/natritmeyer/site_prism
 licenses:
-- BSD3
-metadata: {}
+- BSD-3-Clause
+metadata:
+  bug_tracker_uri: https://github.com/natritmeyer/site_prism/issues
+  changelog_uri: https://github.com/natritmeyer/site_prism/blob/master/HISTORY.md
+  source_code_uri: https://github.com/natritmeyer/site_prism
 post_install_message: 
 rdoc_options: []
 require_paths: