site_prism 3.5 → 3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95c8d9ff0cf7f2b818a8b8cb987ca39f2b512138d572a08533b8466feae6cb63
-  data.tar.gz: 6239a4a2cd9be9233396f2b221328645dcb50a56e531ee0d5b63faa3dbd9bf53
+  metadata.gz: 1ec5104247e3512bd7ebf0a48c579cc92041ef21b9c130531ef0cb4ff5a52f88
+  data.tar.gz: a44ff822766bb37ff023048349037c0467ae47333d4b421bc53d8a59cb2af087
 SHA512:
-  metadata.gz: a9a7a79356b8f4c16aad85f923db99a549bba2c78ec23624f245504ce3bbffd7698bad6a572ddbb34cbf9f2406da76bda7ce5d2433d874270112025e5e9d79ea
-  data.tar.gz: 897ae6d1b6a944b52bc5f36ebb81e2796657a276bfa41994fd0a5315031457d404b46408660556644eb262258c8033b72aa5d7400bd79d13f8085993575df826
+  metadata.gz: 1a6991ecd0110bb53533fb848c40753a13067aed17913f2dd261a5d0b4c8c1747f9f54d1be83d954856037e6cbd24abd665d498b74ff0ad835ab1bea1e0a084a
+  data.tar.gz: bcfe1f63bcaf2b20c64241c03b1c9c718628609fa0bdaa67c01a78b02964b809135aa815e6b0073d4272235226eda5ad802b8b6852d8b118d0806d96e09e2068

data/README.md

@@ -736,6 +736,28 @@ use the bleeding edge version of the logic. Then simply set the following config
 SitePrism.use_all_there_gem = true
 ```
 
+### Getting the list of missing elements
+
+If `#all_there?` returns false and you wish to get the list of missing elements for debugging purposes
+you may want to use `#elements_missing` method. It will return all missing elements from the expected_elements list
+
+If you do not provide a list of `expected_elements` this method will return all elements that are missing on the page;
+from those which are defined.
+
+```ruby
+class Home < SitePrism::Page
+  element :name, '#name'
+  element :address, '#address'
+  element :success_message, 'span.alert-success'
+
+  expected_elements :name, :address
+end
+
+# and... Only `address` is on the page
+
+@test_page.elements_missing #=> [:name]
+```
+
 ## Sections
 
 SitePrism allows you to model sections of a page that appear on multiple
@@ -1688,7 +1710,7 @@ end
 ```
 
 Note that even with implicit waits on you can dynamically modify the wait times
-in any SitePrism method to help work-around special circumstances.  
+in any SitePrism method to help work-around special circumstances.
 
 ```ruby
 # Option 1: using wait key assignment

data/lib/site_prism.rb

@@ -5,13 +5,16 @@ require 'addressable/template'
 
 module SitePrism
   autoload :AddressableUrlMatcher, 'site_prism/addressable_url_matcher'
-  autoload :Deprecator, 'site_prism/deprecator'
   autoload :DSL, 'site_prism/dsl'
+  autoload :Deprecator, 'site_prism/deprecator'
   autoload :ElementChecker, 'site_prism/element_checker'
-  autoload :RecursionChecker, 'site_prism/recursion_checker'
+  autoload :Loadable, 'site_prism/loadable'
   autoload :Logger, 'site_prism/logger'
   autoload :Page, 'site_prism/page'
+  autoload :RecursionChecker, 'site_prism/recursion_checker'
+  autoload :RspecMatchers, 'site_prism/rspec_matchers'
   autoload :Section, 'site_prism/section'
+  autoload :Timer, 'site_prism/timer'
   autoload :Waiter, 'site_prism/waiter'
 
   class << self

data/lib/site_prism/dsl.rb

@@ -8,6 +8,30 @@ module SitePrism
 
     private
 
+    # Call `find` inside context set on page/section
+    def _find(*find_args)
+      kwargs = find_args.pop
+      page.find(*find_args, **kwargs)
+    end
+
+    # Call `all` inside context set on page/section
+    def _all(*find_args)
+      kwargs = find_args.pop
+      page.all(*find_args, **kwargs)
+    end
+
+    # Call `has_selector?` inside context set on page/section
+    def element_exists?(*find_args)
+      kwargs = find_args.pop
+      page.has_selector?(*find_args, **kwargs)
+    end
+
+    # Call `has_no_selector?` inside context set on page/section
+    def element_does_not_exist?(*find_args)
+      kwargs = find_args.pop
+      page.has_no_selector?(*find_args, **kwargs)
+    end
+
     # The default waiting time set by Capybara's configuration settings.
     def wait_time
       Capybara.default_max_wait_time
@@ -170,7 +194,7 @@ module SitePrism
           elements: [],
           section: [],
           sections: [],
-          iframe: [],
+          iframe: []
         }
       end
 
@@ -192,7 +216,7 @@ module SitePrism
       def add_helper_methods(name, *find_args)
         create_existence_checker(name, *find_args)
         create_nonexistence_checker(name, *find_args)
-        create_rspec_existence_matchers(name) if defined?(RSpec)
+        SitePrism::RspecMatchers.new(name)._create_rspec_existence_matchers if defined?(RSpec)
         create_visibility_waiter(name, *find_args)
         create_invisibility_waiter(name, *find_args)
       end
@@ -205,16 +229,6 @@ module SitePrism
         end
       end
 
-      def create_rspec_existence_matchers(element_name)
-        matcher = "has_#{element_name}?"
-        negated_matcher = "has_no_#{element_name}?"
-
-        RSpec::Matchers.define "have_#{element_name}" do |*args|
-          match { |actual| actual.public_send(matcher, *args) }
-          match_when_negated { |actual| actual.public_send(negated_matcher, *args) }
-        end
-      end
-
       def create_existence_checker(element_name, *find_args)
         method_name = "has_#{element_name}?"
         create_helper_method(method_name, *find_args) do

data/lib/site_prism/element_checker.rb

@@ -35,6 +35,10 @@ module SitePrism
       _mapped_items.select { |name| there?(name) }
     end
 
+    def elements_missing
+      elements_to_check.reject { |name| there?(name) }
+    end
+
     private
 
     def all_there_with_recursion

data/lib/site_prism/error.rb

@@ -25,14 +25,6 @@ module SitePrism
   # Formerly known as `NoSelectorForElement`
   class InvalidElementError < SitePrismError; end
 
-  # A tool like Timecop is being used to "freeze time" by overriding Time.now
-  # and similar methods. In this case, our waiter functions won't work, because
-  # Time.now does not change.
-  # If you encounter this issue, check that you are not doing Timecop.freeze without
-  # an accompanying Timecop.return.
-  # Also check out Timecop.safe_mode https://github.com/travisjeffery/timecop#timecopsafe_mode
-  class FrozenInTimeError < SitePrismError; end
-
   # The condition that was being evaluated inside the block did not evaluate
   # to true within the time limit
   # Formerly known as `TimeoutException`

data/lib/site_prism/page.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'site_prism/loadable'
-
 module SitePrism
   class Page
     include Capybara::DSL
@@ -26,11 +24,7 @@ module SitePrism
     end
 
     def page
-      if defined?(@page)
-        @page
-      else
-        Capybara.current_session
-      end
+      (defined?(@page) && @page) || Capybara.current_session
     end
 
     # Loads the page.
@@ -78,18 +72,13 @@ module SitePrism
 
     def url_matches(seconds = wait_time)
       return unless displayed?(seconds)
+      return regexp_backed_matches if url_matcher.is_a?(Regexp)
 
-      if url_matcher.is_a?(Regexp)
-        regexp_backed_matches
-      else
-        template_backed_matches
-      end
+      template_backed_matches
     end
 
     def url(expansion = {})
-      return nil if self.class.url.nil?
-
-      Addressable::Template.new(self.class.url).expand(expansion).to_s
+      self.class.url && Addressable::Template.new(self.class.url).expand(expansion).to_s
     end
 
     def url_matcher
@@ -102,26 +91,6 @@ module SitePrism
 
     private
 
-    def _find(*find_args)
-      kwargs = find_args.pop
-      page.find(*find_args, **kwargs)
-    end
-
-    def _all(*find_args)
-      kwargs = find_args.pop
-      page.all(*find_args, **kwargs)
-    end
-
-    def element_exists?(*find_args)
-      kwargs = find_args.pop
-      page.has_selector?(*find_args, **kwargs)
-    end
-
-    def element_does_not_exist?(*find_args)
-      kwargs = find_args.pop
-      page.has_no_selector?(*find_args, **kwargs)
-    end
-
     def regexp_backed_matches
       url_matcher.match(page.current_url)
     end

data/lib/site_prism/recursion_checker.rb

@@ -28,7 +28,7 @@ module SitePrism
         expected(mapped_items, :elements),
         expected(mapped_items, :section),
         expected(mapped_items, :sections),
-        expected(mapped_items, :iframe),
+        expected(mapped_items, :iframe)
       ]
     end
 

data/lib/site_prism/rspec_matchers.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SitePrism
+  class RspecMatchers
+    attr_reader :element_name
+
+    def initialize(element_name)
+      @element_name = element_name
+    end
+
+    def _create_rspec_existence_matchers
+      SitePrism.logger.debug('Including all relevant matcher names / warnings in RSpec scope.')
+      create_rspec_existence_matchers(matcher, object_method, negated_object_method, warning)
+    end
+
+    private
+
+    def create_rspec_existence_matchers(matcher, object_method, negated_object_method, warning)
+      RSpec::Matchers.define(matcher) do |*args|
+        match { |actual| actual.public_send(object_method, *args) }
+        match_when_negated do |actual|
+          if actual.respond_to?(negated_object_method)
+            return actual.public_send(negated_object_method, *args)
+          end
+
+          SitePrism.logger.debug(warning)
+          !actual.public_send(object_method, *args)
+        end
+      end
+    end
+
+    def matcher
+      "have_#{element_name}"
+    end
+
+    def object_method
+      "has_#{element_name}?"
+    end
+
+    def negated_object_method
+      "has_no_#{element_name}?"
+    end
+
+    def warning
+      "The RSpec matcher '#{matcher}' was added by SitePrism, but the object under test "\
+        "does not respond to '#{negated_object_method}' and is probably not a SitePrism object. "\
+        'Falling back to the default RSpec matcher.'
+    end
+  end
+end

data/lib/site_prism/section.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'site_prism/loadable'
-
 module SitePrism
   class Section
     include Capybara::DSL
@@ -68,27 +66,5 @@ module SitePrism
     def native
       root_element.native
     end
-
-    private
-
-    def _find(*find_args)
-      kwargs = find_args.pop
-      page.find(*find_args, **kwargs)
-    end
-
-    def _all(*find_args)
-      kwargs = find_args.pop
-      page.all(*find_args, **kwargs)
-    end
-
-    def element_exists?(*find_args)
-      kwargs = find_args.pop
-      page.has_selector?(*find_args, **kwargs)
-    end
-
-    def element_does_not_exist?(*find_args)
-      kwargs = find_args.pop
-      page.has_no_selector?(*find_args, **kwargs)
-    end
   end
 end

data/lib/site_prism/timer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SitePrism
+  class Timer
+    attr_reader :wait_time
+
+    def self.run(wait_time, &block)
+      new(wait_time).run(&block)
+    end
+
+    def initialize(wait_time)
+      @wait_time = wait_time
+      @done = false
+    end
+
+    def done?
+      @done == true
+    end
+
+    def run
+      start
+      yield self
+    ensure
+      stop
+    end
+
+    def start
+      stop
+      return if wait_time.zero?
+
+      @done = false
+      @thread = Thread.start do
+        sleep wait_time
+        @done = true
+      end
+    end
+
+    def stop
+      if @thread
+        @thread.kill
+        @thread.join
+        @thread = nil
+      end
+      @done = true
+    end
+  end
+end

data/lib/site_prism/version.rb

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

data/lib/site_prism/waiter.rb

@@ -2,33 +2,20 @@
 
 module SitePrism
   class Waiter
-    class << self
-      def wait_until_true(wait_time = Capybara.default_max_wait_time)
-        start_time = Time.now
+    def self.sleep_duration
+      0.05
+    end
 
+    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 Time.now - start_time > wait_time
-
-          sleep(0.05)
+          break if timer.done?
 
-          check_for_time_stopped!(start_time)
+          sleep(sleep_duration)
         end
-
         raise SitePrism::TimeoutError, "Timed out after #{wait_time}s."
       end
-
-      private
-
-      def check_for_time_stopped!(start_time)
-        return unless start_time == Time.now
-
-        raise(
-          SitePrism::FrozenInTimeError,
-          'Time appears to be frozen. For more info, see ' \
-          'https://github.com/site-prism/site_prism/blob/master/lib/site_prism/error.rb'
-        )
-      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: '3.5'
+  version: '3.6'
 platform: ruby
 authors:
 - Luke Hill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -29,6 +29,9 @@ dependencies:
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
     - - "<="
       - !ruby/object:Gem::Version
         version: '3.29'
@@ -36,6 +39,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
     - - "<="
       - !ruby/object:Gem::Version
         version: '3.29'
@@ -121,14 +127,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -161,16 +167,22 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -191,14 +203,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
 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:
@@ -220,7 +232,9 @@ files:
 - lib/site_prism/logger.rb
 - lib/site_prism/page.rb
 - lib/site_prism/recursion_checker.rb
+- lib/site_prism/rspec_matchers.rb
 - lib/site_prism/section.rb
+- lib/site_prism/timer.rb
 - lib/site_prism/version.rb
 - lib/site_prism/waiter.rb
 homepage: https://github.com/site-prism/site_prism
@@ -238,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="