site_prism 2.17.1 → 3.0.beta

data/lib/site_prism.rb

@@ -13,37 +13,8 @@ module SitePrism
 
   class << self
     def configure
-      yield self
-    end
-
-    attr_reader :use_implicit_waits
-
-    def use_implicit_waits=(value)
-      show_removed_config_warning_messages
-      @use_implicit_waits = value
-    end
-
-    attr_reader :raise_on_wait_fors
-
-    def raise_on_wait_fors=(value)
-      show_removed_config_warning_messages
-      @raise_on_wait_fors = value
-    end
-
-    attr_reader :default_load_validations
-
-    def default_load_validations=(value)
-      show_removed_config_warning_messages
-      @default_load_validations = value
-    end
-
-    def show_removed_config_warning_messages
-      warn 'This config option is being removed in SitePrism v3. See UPGRADING.md on the repo for more details.'
-      warn 'Going forwards the configuration / configurability will more closely mimic Capybara.'
+      warn 'SitePrism configuration is now removed.'
+      warn 'All options fed directly from Capybara.'
     end
   end
-
-  @default_load_validations = true
-  @use_implicit_waits = false
-  @raise_on_wait_fors = false
 end

data/lib/site_prism/addressable_url_matcher.rb

@@ -96,7 +96,7 @@ module SitePrism
       begin
         Addressable::URI.parse(url)
       rescue Addressable::URI::InvalidURIError
-        raise SitePrism::InvalidUrlMatcher
+        raise SitePrism::InvalidUrlMatcherError
       end
     end
 

data/lib/site_prism/element_checker.rb

@@ -3,30 +3,30 @@
 module SitePrism
   module ElementChecker
     def all_there?
-      elements_to_check.all? { |element| there?(element) }
+      elements_to_check.all? { |element| present?(element) }
     end
 
     def elements_present
-      mapped_items.select { |item_name| there?(item_name) }
+      mapped_items.select { |item_name| present?(item_name) }
     end
 
     private
 
     def elements_to_check
       if self.class.expected_items
-        mapped_items.select do |el|
-          self.class.expected_items.include?(el)
-        end
+        mapped_items.select { |el| self.class.expected_items.include?(el) }
       else
         mapped_items
       end
     end
 
     def mapped_items
+      return unless self.class.mapped_items
+
       self.class.mapped_items.uniq
     end
 
-    def there?(element)
+    def present?(element)
       send("has_#{element}?")
     end
   end

data/lib/site_prism/element_container.rb

@@ -12,63 +12,35 @@ module SitePrism
       Capybara.default_max_wait_time
     end
 
-    def checker_wait_time
-      if SitePrism.use_implicit_waits
-        wait_time
-      else
-        0
-      end
-    end
-
     def raise_if_block(obj, name, has_block, type)
       return unless has_block
       warn "Type passed in: #{type}"
 
-      raise SitePrism::UnsupportedBlock, "#{obj.class}##{name}"
-    end
-
-    def raise_wait_for_if_failed(obj, name, timeout, failed)
-      return unless SitePrism.raise_on_wait_fors && failed
-
-      deprecate('Listening for TimeOutWaitingForExistenceError')
-      raise SitePrism::TimeOutWaitingForExistenceError, \
-            "Timed out after #{timeout}s waiting for #{obj.class}##{name}"
-    end
-
-    def raise_wait_for_no_if_failed(obj, name, timeout, failed)
-      return unless SitePrism.raise_on_wait_fors && failed
-
-      deprecate('Listening for TimeOutWaitingForNonExistenceError')
-      raise SitePrism::TimeOutWaitingForNonExistenceError, \
-            "Timed out after #{timeout}s waiting for no #{obj.class}##{name}"
+      raise SitePrism::UnsupportedBlockError, "#{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 = {})
+    # Initially it will duplicate all locators and run-time arguments,
+    # then it will combine them with any visibility arguments if defined.
+    def merge_args(find_args, runtime_args, visibility_args = {})
       find_args = find_args.dup
       runtime_args = runtime_args.dup
-      options = {}
+
+      options = visibility_args
       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)
+      options[:wait] = wait_time unless wait_key_present?(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
-
-    def deprecate(previous, new = nil)
-      warn "Usage of #{previous} is now deprecated and should be not used."
-      warn "Use #{new} instead." if new
+    def wait_key_present?(options)
+      options.key?(:wait)
     end
 
     # rubocop:disable Metrics/ModuleLength
@@ -125,7 +97,7 @@ module SitePrism
         add_to_mapped_items(name)
         add_iframe_helper_methods(name, *element_find_args)
         define_method(name) do |&block|
-          raise BlockMissingError unless block
+          raise MissingBlockError unless block
 
           within_frame(*scope_find_args) do
             block.call(klass.new)
@@ -153,8 +125,6 @@ module SitePrism
       def add_helper_methods(name, *find_args)
         create_existence_checker(name, *find_args)
         create_nonexistence_checker(name, *find_args)
-        create_waiter(name, *find_args)
-        create_nonexistence_waiter(name, *find_args)
         create_visibility_waiter(name, *find_args)
         create_invisibility_waiter(name, *find_args)
       end
@@ -162,8 +132,6 @@ module SitePrism
       def add_iframe_helper_methods(name, *find_args)
         create_existence_checker(name, *find_args)
         create_nonexistence_checker(name, *find_args)
-        create_waiter(name, *find_args)
-        create_nonexistence_waiter(name, *find_args)
       end
 
       def create_helper_method(proposed_method_name, *find_args)
@@ -178,8 +146,7 @@ module SitePrism
         method_name = "has_#{element_name}?"
         create_helper_method(method_name, *find_args) do
           define_method(method_name) do |*runtime_args|
-            visibility_args = { wait: checker_wait_time }
-            args = merge_args(find_args, runtime_args, visibility_args)
+            args = merge_args(find_args, runtime_args)
             element_exists?(*args)
           end
         end
@@ -189,49 +156,19 @@ module SitePrism
         method_name = "has_no_#{element_name}?"
         create_helper_method(method_name, *find_args) do
           define_method(method_name) do |*runtime_args|
-            visibility_args = { wait: checker_wait_time }
-            args = merge_args(find_args, runtime_args, visibility_args)
+            args = merge_args(find_args, runtime_args)
             element_does_not_exist?(*args)
           end
         end
       end
 
-      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 = wait_time, *runtime_args|
-            deprecate('wait_for methods', 'wait key assignment at runtime')
-            visibility_args = { wait: timeout }
-            args = merge_args(find_args, runtime_args, visibility_args)
-            result = element_exists?(*args)
-            raise_wait_for_if_failed(self, element_name, timeout, !result)
-            result
-          end
-        end
-      end
-
-      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 = wait_time, *runtime_args|
-            deprecate('wait_for_no methods', 'wait key assignment at runtime')
-            visibility_args = { wait: timeout }
-            args = merge_args(find_args, runtime_args, visibility_args)
-            result = element_does_not_exist?(*args)
-            raise_wait_for_no_if_failed(self, element_name, timeout, !result)
-            result
-          end
-        end
-      end
-
       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 = wait_time, *runtime_args|
-            visibility_args = { visible: true, wait: timeout }
-            args = merge_args(find_args, runtime_args, visibility_args)
+          define_method(method_name) do |*runtime_args|
+            args = merge_args(find_args, runtime_args, visible: true)
             return true if element_exists?(*args)
-            raise SitePrism::TimeOutWaitingForElementVisibility
+            raise SitePrism::ElementVisibilityTimeoutError
           end
         end
       end
@@ -239,18 +176,17 @@ 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 = wait_time, *runtime_args|
-            visibility_args = { visible: true, wait: timeout }
-            args = merge_args(find_args, runtime_args, visibility_args)
+          define_method(method_name) do |*runtime_args|
+            args = merge_args(find_args, runtime_args, visible: true)
             return true if element_does_not_exist?(*args)
-            raise SitePrism::TimeOutWaitingForElementInvisibility
+            raise SitePrism::ElementInvisibilityTimeoutError
           end
         end
       end
 
       def create_no_selector(method_name)
         define_method(method_name) do
-          raise SitePrism::NoSelectorForElement, "#{self.class}##{method_name}"
+          raise SitePrism::InvalidElementError, "#{self.class}##{method_name}"
         end
       end
 

data/lib/site_prism/error.rb

@@ -8,13 +8,16 @@ module SitePrism
   class PageLoadError < SitePrismError; end
 
   # A page calls #load with no URL set
+  # Formerly known as `NoUrlForPage`
   class NoUrlForPageError < PageLoadError; end
 
   # A page calls #displayed? with no URL matcher set
+  # Formerly known as `NoUrlMatcherForPage`
   class NoUrlMatcherForPageError < PageLoadError; end
 
   # The URL matcher was not recognised as a Regex or String and as such
   # it couldn't be parsed by Addressable
+  # Formerly known as `InvalidUrlMatcher`
   class InvalidUrlMatcherError < PageLoadError
     def message
       warn 'Templated port numbers are unsupported.'
@@ -24,6 +27,7 @@ module SitePrism
   end
 
   # A SitePrism defined DSL item was defined without a selector
+  # Formerly known as `NoSelectorForElement`
   class InvalidElementError < SitePrismError
     def message
       "#{super} has been derived from an item with no selectors defined."
@@ -32,22 +36,28 @@ module SitePrism
 
   # The condition that was being evaluated inside the block did not evaluate
   # to true within the time limit
-  class TimeoutError < SitePrismError
-    def message
-      "Timed out after #{super}s."
-    end
-  end
+  # Formerly known as `TimeoutException`
+  class TimeoutError < SitePrismError; end
 
   # These errors are not yet migrated and are fired from their source
   # They are raised when the meta-programmed method has not yielded true
   # in the prescribed time limit
+  # Formerly known as `TimeOutWaitingForExistenceError`,
+  # `TimeOutWaitingForNonExistenceError`
+  # `TimeOutWaitingForElementVisibility` and
+  # `TimeOutWaitingForElementInvisibility` respectively
+
   class ExistenceTimeoutError < TimeoutError; end
   class NonExistenceTimeoutError < TimeoutError; end
   class ElementVisibilityTimeoutError < TimeoutError; end
   class ElementInvisibilityTimeoutError < TimeoutError; end
 
+  # Generic Block validation family of errors inherit from this error
+  class BlockError < SitePrismError; end
+
   # A Block was passed to the method, which it cannot interpret
-  class UnsupportedBlockError < SitePrismError
+  # Formerly known as `UnsupportedBlock`
+  class UnsupportedBlockError < BlockError
     def message
       warn 'section and iframe are the only items which can accept a block.'
 
@@ -56,7 +66,8 @@ module SitePrism
   end
 
   # A Block was required, but not passed into the iframe at runtime
-  class MissingBlockError < SitePrismError
+  # Formerly known as `BlockMissingError`
+  class MissingBlockError < BlockError
     def message
       'You can only use iFrames in a block context - Please pass in a block.'
     end
@@ -64,6 +75,7 @@ module SitePrism
 
   # A page was loaded via #load - And then failed one of the load validations
   # that was either pre-defined or defined by the user
+  # Formerly known as `NotLoadedError`
   class FailedLoadValidationError < PageLoadError
     def message
       if super == self.class.to_s
@@ -73,19 +85,4 @@ module SitePrism
       end
     end
   end
-
-  # Legacy Error Code aliases for backwards compatibility
-  NoUrlForPage                         = NoUrlForPageError
-  NoUrlMatcherForPage                  = NoUrlMatcherForPageError
-  InvalidUrlMatcher                    = InvalidUrlMatcherError
-  NoSelectorForElement                 = InvalidElementError
-  TimeoutException                     = TimeoutError
-  # Below four have different inheritance for now to avoid message leaking
-  TimeOutWaitingForExistenceError      = Class.new(StandardError)
-  TimeOutWaitingForNonExistenceError   = Class.new(StandardError)
-  TimeOutWaitingForElementVisibility   = Class.new(StandardError)
-  TimeOutWaitingForElementInvisibility = Class.new(StandardError)
-  UnsupportedBlock                     = UnsupportedBlockError
-  BlockMissingError                    = MissingBlockError
-  NotLoadedError                       = FailedLoadValidationError
 end

data/lib/site_prism/loadable.rb

@@ -28,7 +28,7 @@ module SitePrism
       # This block can contain up to 2 elements in an array
       # The first is the physical validation test to be truthily evaluated
       # If this does not pass, then the 2nd item (If defined), is output
-      # as an error message to the NotLoadedError Error that will be thrown
+      # as an error message to the FailedLoadValidationError that is thrown
       def load_validation(&block)
         _load_validations << block
       end
@@ -36,32 +36,7 @@ module SitePrism
       private
 
       def _load_validations
-        @_load_validations ||= default_validations
-      end
-
-      def default_validations
-        if enabled?
-          [displayed_validation]
-        else
-          []
-        end
-      end
-
-      def enabled?
-        siteprism_page? && SitePrism.default_load_validations
-      end
-
-      def siteprism_page?
-        self == SitePrism::Page
-      end
-
-      def displayed_validation
-        proc do
-          [
-            displayed?,
-            "Expected #{current_url} to match #{url_matcher} but it did not."
-          ]
-        end
+        @_load_validations ||= []
       end
     end
 
@@ -91,7 +66,7 @@ module SitePrism
       # Within the block, cache loaded? to optimize performance.
       self.loaded = loaded?
 
-      raise SitePrism::NotLoadedError, load_error unless loaded
+      raise SitePrism::FailedLoadValidationError, load_error unless loaded
 
       yield self
     ensure

data/lib/site_prism/page.rb

@@ -33,7 +33,7 @@ module SitePrism
         yield self if block_given?
       else
         expanded_url = url(expansion_or_html)
-        raise SitePrism::NoUrlForPage if expanded_url.nil?
+        raise SitePrism::NoUrlForPageError unless expanded_url
         visit expanded_url
         when_loaded(&block) if block_given?
       end
@@ -43,10 +43,10 @@ module SitePrism
       expected_mappings = args.last.is_a?(::Hash) ? args.pop : {}
       seconds = !args.empty? ? args.first : Capybara.default_max_wait_time
 
-      raise SitePrism::NoUrlMatcherForPage if url_matcher.nil?
+      raise SitePrism::NoUrlMatcherForPageError unless url_matcher
       begin
         Waiter.wait_until_true(seconds) { url_matches?(expected_mappings) }
-      rescue SitePrism::TimeoutException
+      rescue SitePrism::TimeoutError
         false
       end
     end
@@ -122,7 +122,7 @@ module SitePrism
       elsif url_matcher.respond_to?(:to_str)
         url_matches_by_template?(expected_mappings)
       else
-        raise SitePrism::InvalidUrlMatcher
+        raise SitePrism::InvalidUrlMatcherError
       end
     end