site_prism 3.7.1 → 3.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5deda0d9df9e83e2a66663a217cf5c434fd3ed25abae0d14778d99cd5db1c0f
-  data.tar.gz: 6c86aff27c00c5e91b01667f7da1f9ee6e2d33d4f95d18fbb0cfdd9fd44779c5
+  metadata.gz: 177884e3ba39ca8a9e1fa0025274c31dd1d765adbba6983f86150feeef4fa301
+  data.tar.gz: 0ecc59ece70808dbb774128d1cf5e7f3fcdaa4d449b27be29f403633b3535c24
 SHA512:
-  metadata.gz: 254398e151d390326bf085d0746391aedd247d1ed8bf47909d8fb87752b6cedd056ff32c14f324d5b33f4b922734ed01ec2467f64be59a8d97a07cf8aa002eea
-  data.tar.gz: 652781ebe825ed5f943ca0f8480a9b5fbd511e81e6c12d9ce95de7c3239073d4499f4165044c8c58888aeabf0cf2d9bc76e4ca6f2ae6baa6996093117577005a
+  metadata.gz: 5f402e20e4888f02d4c7695289239c1b4dfca44b47e90029699efe4ec050b2d173f78c1e427f1dbd0647c9b8238397f1c34d22697601b5f36689266f942729b7
+  data.tar.gz: 549ac4b1187a96807c34475961999bcfaa6761fceba70cf13bdcedfdce13c86b23aad1fa700bcda122841a057bd258023f26ffc270194a8258d98756b3bf294c

data/lib/site_prism/deprecator.rb

@@ -5,6 +5,7 @@ module SitePrism
   class Deprecator
     class << self
       # @return SitePrism.logger.warn(msg)
+      #
       # Tells the user that they are using old functionality, which needs removing in the
       # next major version
       def deprecate(old, new = nil)
@@ -18,6 +19,7 @@ module SitePrism
       end
 
       # @return SitePrism.logger.debug(msg)
+      #
       # Tells the user that they are using functionality which is non-optimal
       #   The functionality should usually provide a reason for it being poor, as well as an
       #   optional way of upgrading to something different

data/lib/site_prism/dsl.rb

@@ -197,6 +197,9 @@ module SitePrism
         end
       end
 
+      # Return a list of all mapped items on a SitePrism class instance (Page or Section)
+      # If legacy is set to true (Default) -> @return [Array]
+      # If legacy is set to false (New behaviour) -> @return [Hash]
       def mapped_items(legacy: true)
         return old_mapped_items if legacy
 
@@ -342,7 +345,7 @@ module SitePrism
 
       def deduce_section_class(base_class, &block)
         klass = base_class
-        klass = Class.new(klass || SitePrism::Section, &block) if block_given?
+        klass = Class.new(klass || SitePrism::Section, &block) if block
         return klass if klass
 
         raise ArgumentError, 'You should provide descendant of SitePrism::Section class or/and a block as the second argument.'

data/lib/site_prism/element_checker.rb

@@ -35,10 +35,16 @@ module SitePrism
       end
     end
 
+    # Returns each element that is currently present inside the scope being tested
+    #
+    # @return [Array]
     def elements_present
       _mapped_items.select { |name| there?(name) }
     end
 
+    # Returns each element that is not currently present inside the scope being tested
+    #
+    # @return [Array]
     def elements_missing
       elements_to_check.reject { |name| there?(name) }
     end

data/lib/site_prism/page.rb

@@ -10,19 +10,34 @@ module SitePrism
     class << self
       attr_reader :url
 
+      # Sets and returns the specific url that will be loaded for a page object
+      #
+      # @return [String]
       def set_url(page_url)
         @url = page_url.to_s
       end
 
+      # Sets and returns the specific url matcher that will be used to validate the page is loaded
+      #
+      # @return [Regexp]
       def set_url_matcher(page_url_matcher)
         @url_matcher = page_url_matcher
       end
 
+      # The specific url matcher that is used to validate the page is loaded.
+      # When one hasn't been previously set, use the url that was set as a direct Regexp exact matcher
+      #
+      # @return [Regexp]
       def url_matcher
         @url_matcher ||= url
       end
     end
 
+    # Where a Capybara HTML fragment has been directly injected into `#load` as a block return this loaded fragment
+    # Where a page has been directly navigated to through traditional means (i.e. Selenium), return an instance of the
+    # current Capybara session (With all applicable methods)
+    #
+    # @return [Capybara::Node::Simple || Capybara::Session]
     def page
       (defined?(@page) && @page) || Capybara.current_session
     end
@@ -134,7 +149,7 @@ module SitePrism
       visit expanded_url
       if with_validations
         when_loaded(&block)
-      elsif block_given?
+      elsif block
         yield self
       end
     end

data/lib/site_prism/section.rb

@@ -34,7 +34,7 @@ module SitePrism
     def initialize(parent, root_element, &block)
       @parent = parent
       @root_element = root_element
-      within(&block) if block_given?
+      within(&block) if block
     end
 
     # Send all root_element methods through `#root_element`

data/lib/site_prism/timer.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
 module SitePrism
+  # [SitePrism::Timer]
+  #
+  # Used to count asynchronously towards an overall desired duration or condition (Block)
   class Timer
     attr_reader :wait_time
 
+    # Return &block
+    #
+    # Count towards a specified time (Supplied)
     def self.run(wait_time, &block)
       new(wait_time).run(&block)
     end
@@ -13,10 +19,16 @@ module SitePrism
       @done = false
     end
 
+    # Return Boolean
+    #
+    # Whether the timer has completed
     def done?
       @done == true
     end
 
+    # Return &block
+    #
+    # Start the Timer and re-evaluate the block repeatedly
     def run
       start
       yield self
@@ -24,6 +36,9 @@ module SitePrism
       stop
     end
 
+    # Return [Boolean, Nil]
+    #
+    # Start the Timer in a separate process
     def start
       stop
       return if wait_time.zero?
@@ -35,6 +50,9 @@ module SitePrism
       end
     end
 
+    # Return True
+    #
+    # Forcibly stop the timer, and kill any threads created by it
     def stop
       if @thread
         @thread.kill

data/lib/site_prism/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SitePrism
-  VERSION = '3.7.1'
+  VERSION = '3.7.2'
 end

data/lib/site_prism/waiter.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
 module SitePrism
+  # [SitePrism::Waiter]
   class Waiter
-    def self.sleep_duration
-      0.05
-    end
-
+    # @return Boolean
+    #
+    # A looper that will wait until the passed in block evaluates to true
+    # Alternatively it will time out once the wait_time is exceeded
     def self.wait_until_true(wait_time = Capybara.default_max_wait_time)
       Timer.run(wait_time) do |timer|
         loop do
           return true if yield
           break if timer.done?
 
-          sleep(sleep_duration)
+          sleep(0.05)
         end
         raise SitePrism::TimeoutError, "Timed out after #{wait_time}s."
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.7.2
 platform: ruby
 authors:
 - Luke Hill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-19 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -63,16 +63,22 @@ dependencies:
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -121,42 +127,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 0.93.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 0.93.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.10.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.38.0
+        version: 1.44.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.38.0
+        version: 1.44.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -183,28 +189,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.5'
 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.
 email: