site_prism 3.2 → 3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb0a772ccdabf209eba492206b0c664418fa46f1b2bdb2c8d08cbcf384b5522
-  data.tar.gz: be9c7ca220f2a20122a3bfd955fa617acda1ecb3d6aedac9472300f4c17ff014
+  metadata.gz: 21261a1fb826c5500f7bc30e44729cb733b2f75b1ea7d3d5243400d9d29e8b2c
+  data.tar.gz: e50ab9e1b7d6c0e651d15aa6888828b789f38b7aed80511caa96d50dc767dcda
 SHA512:
-  metadata.gz: d21079c647c16bcb896374557448fc9c514ce8d3d16379e77f64be741b2ef76f7c2438ff9fd3d0f5bdd96a3678d92b40e162d3847a04647de1ed553b7a786b2f
-  data.tar.gz: bf7ea9e4ff98d6ae92427a98b21a35bd519638080c5b3c55f9565e163710b748c11152374293ee783d32a1f1ef599bbac5be99a56f696d144fb1f53d0d7836d4
+  metadata.gz: 423f9ffb5d2b26f9619f81414074ab1006b72d7ac8516a355f6d4ffc3959aadb56bacda3a25f06c4bff8e4898609d6c5540e9e9856b3f53d613c5ec9e819125e
+  data.tar.gz: 1541d15de381f59d4b75c46ae322e26e3e89ccc80549f7b11d55fa05cd32ccd314ca41f67724d310d56ce48d87c6aec3cfe4a1275a1295279ec6de6ef1cb48b2

data/README.md

@@ -15,7 +15,7 @@ Make sure to add your project/company to https://github.com/natritmeyer/site_pri
 
 We love it when people want to get involved with our Open Source Project.
 
-We have a brief set of setup docs [HERE](https://github.com/natritmeyer/site_prism/blob/master/development_setup.md)
+We have a brief set of setup docs [HERE](https://github.com/site-prism/site_prism/blob/master/development_setup.md)
 
 ## Supported Rubies / Browsers
 
@@ -26,7 +26,7 @@ such as 2.5 or 2.6, if for any other reason, to get a noticeable speed boost!
 SitePrism should run on all major browsers. The gem's integration tests are ran on Chrome and Firefox.
 
 If you find you cannot integrate nicely with SitePrism, please open an
-[issue request](https://github.com/natritmeyer/site_prism/issues/new)
+[issue request](https://github.com/site-prism/site_prism/issues/new)
 
 ## Synopsis
 
@@ -594,7 +594,6 @@ Or even run some tests ...
 ```ruby
 expect(@friends_page.names.map { |name| name.text }).to eq(['Alice', 'Bob', 'Fred'])
 expect(@friends_page.names.size).to eq(3)
-expect(@friends_page).to have(3).names
 ```
 
 #### Testing for the existence of the element collection

data/lib/site_prism.rb

@@ -5,8 +5,10 @@ require 'addressable/template'
 
 module SitePrism
   autoload :AddressableUrlMatcher, 'site_prism/addressable_url_matcher'
+  autoload :Deprecator, 'site_prism/deprecator'
   autoload :DSL, 'site_prism/dsl'
   autoload :ElementChecker, 'site_prism/element_checker'
+  autoload :RecursionChecker, 'site_prism/recursion_checker'
   autoload :Logger, 'site_prism/logger'
   autoload :Page, 'site_prism/page'
   autoload :Section, 'site_prism/section'

data/lib/site_prism/deprecator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SitePrism
+  class Deprecator
+    class << self
+      def deprecate(old, new = nil)
+        if new
+          warn("#{old} is being deprecated and should no longer be used. Use #{new} instead.")
+        else
+          warn("#{old} is being deprecated and should no longer be used.")
+        end
+
+        warn("#{old} will be removed in SitePrism v4. You have been warned!")
+      end
+
+      def soft_deprecate(old, reason, new = nil)
+        debug("The #{old} method is changing, as is SitePrism, and is now configurable.")
+        debug("REASON: #{reason}.")
+        debug('Moving forwards into SitePrism v4, the default behaviour will change.')
+        debug("We advise you change to using #{new}") if new
+      end
+
+      private
+
+      def warn(msg)
+        SitePrism.logger.warn(msg)
+      end
+
+      def debug(msg)
+        SitePrism.logger.debug(msg)
+      end
+    end
+  end
+end

data/lib/site_prism/dsl.rb

@@ -131,12 +131,34 @@ module SitePrism
         end
       end
 
-      def mapped_items
-        @mapped_items ||= []
+      def mapped_items(legacy: true)
+        if legacy
+          old_mapped_items
+        else
+          new_mapped_items
+        end
       end
 
       private
 
+      def old_mapped_items
+        SitePrism.logger.debug("Calling .mapped_items on a class is changing!
+The structure will soon be changing format. This will allow #all_there? to
+recurse through section / sections going forwards. The old format will remain
+until a v5 has been released (And will be deprecated in v4 of site_prism")
+        @old_mapped_items ||= []
+      end
+
+      def new_mapped_items
+        @new_mapped_items ||= {
+          element: [],
+          elements: [],
+          section: [],
+          sections: [],
+          iframe: [],
+        }
+      end
+
       def build(type, name, *find_args)
         if find_args.empty?
           create_error_method(name)
@@ -148,7 +170,8 @@ module SitePrism
       end
 
       def map_item(type, name)
-        mapped_items << { type => name.to_sym }
+        old_mapped_items << { type => name }
+        new_mapped_items[type] << name.to_sym
       end
 
       def add_helper_methods(name, *find_args)

data/lib/site_prism/element_checker.rb

@@ -13,54 +13,51 @@ module SitePrism
     # @my_page.all_there?
     # => true - If the three items above are all present
     #
-    # Note that #elements_to_check will affect the hash of mapped_items
+    # Note that #elements_to_check will check the hash of mapped_items
     #
-    # When using the recursion parameter, one of three values is valid.
+    # When using the recursion parameter, one of two values is valid.
     #
     # Default: 'none' => Perform no recursion when calling #all_there?
-    # Override: 'one' => Perform one recursive dive into all section
-    # items and call #all_there? on those items too.
-    def all_there?(recursion: 'none')
-      SitePrism.logger.info('Setting for recursion is being ignored for now.')
-
-      if %w[none one].include?(recursion)
-        elements_to_check.all? { |item_name| there?(item_name) }
+    # Override: 'one' => Perform one recursive dive into all section/sections
+    # items and call #all_there? on all of those items too.
+    def all_there?(recursion: :none)
+      if recursion == :none
+        elements_to_check.all? { |name| there?(name) }
+      elsif recursion == :one
+        RecursionChecker.new(self).all_there?
       else
-        SitePrism.logger.error('Invalid recursion setting, Will not run.')
+        SitePrism.logger.debug("Input value '#{recursion}'. Valid values are :none or :one.")
+        SitePrism.logger.error('Invalid recursion setting, Will not run #all_there?.')
       end
     end
 
     def elements_present
-      _mapped_items.select { |item_name| there?(item_name) }
+      _mapped_items.select { |name| there?(name) }
     end
 
     private
 
-    # If the page or section has expected_items set, return expected_items
-    # that are mapped; otherwise just return the list of all mapped_items
+    # If the page or section has expected_items set, return expected_items that are mapped
+    # otherwise just return the list of all mapped_items
     def elements_to_check
       if _expected_items
         SitePrism.logger.debug('Expected Items has been set.')
-        _mapped_items.select { |item_name| _expected_items.include?(item_name) }
+        _mapped_items.select { |name| _expected_items.include?(name) }
       else
         _mapped_items
       end
     end
 
     def _mapped_items
-      mapped_items_list.map(&:values).flatten
-    end
-
-    def mapped_items_list
-      self.class.mapped_items.uniq
+      self.class.mapped_items(legacy: false).values.flatten.uniq
     end
 
     def _expected_items
       self.class.expected_items
     end
 
-    def there?(item_name)
-      send("has_#{item_name}?")
+    def there?(name)
+      send("has_#{name}?")
     end
   end
 end

data/lib/site_prism/recursion_checker.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module SitePrism
+  class RecursionChecker
+    attr_reader :instance
+    private :instance
+
+    def initialize(instance)
+      @instance = instance
+    end
+
+    def all_there?
+      regular_items_all_there = expected_item_map.flatten.all? { |name| there?(name) }
+      return false unless regular_items_all_there
+
+      section_all_there =
+        section_classes_to_check.all?(&:all_there?)
+      return false unless section_all_there
+
+      # Returning this final check here is fine, as the previous two checks must
+      # have returned +true+ in order to hit this part of the method-call
+      sections_classes_to_check.all?(&:all_there?)
+    end
+
+    def expected_item_map
+      [
+        expected(mapped_items, :element),
+        expected(mapped_items, :elements),
+        expected(mapped_items, :section),
+        expected(mapped_items, :sections),
+        expected(mapped_items, :iframe),
+      ]
+    end
+
+    def expected(_map, type)
+      mapped_items[type].select { |name| elements_to_check.include?(name) }
+    end
+
+    def section_classes_to_check
+      expected_item_map[2].map { |name| instance.send(name) }
+    end
+
+    def sections_classes_to_check
+      expected_item_map[3].map { |name| instance.send(name) }.flatten
+    end
+
+    private
+
+    # If the page or section has expected_items set, return expected_items that are mapped
+    # otherwise just return the list of all mapped_items
+    def elements_to_check
+      if _expected_items
+        SitePrism.logger.debug('Expected Items has been set.')
+        _mapped_items.select { |name| _expected_items.include?(name) }
+      else
+        _mapped_items
+      end
+    end
+
+    def _mapped_items
+      mapped_items.values.flatten.uniq
+    end
+
+    def _expected_items
+      instance.class.expected_items
+    end
+
+    def there?(name)
+      instance.send("has_#{name}?")
+    end
+
+    def mapped_items
+      @mapped_items ||= instance.class.mapped_items(legacy: false)
+    end
+  end
+end

data/lib/site_prism/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: '3.2'
+  version: '3.3'
 platform: ruby
 authors:
 - Nat Ritmeyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2019-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -31,42 +31,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: site_prism-all_there
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
+        version: 0.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -180,12 +180,14 @@ files:
 - README.md
 - lib/site_prism.rb
 - lib/site_prism/addressable_url_matcher.rb
+- lib/site_prism/deprecator.rb
 - lib/site_prism/dsl.rb
 - lib/site_prism/element_checker.rb
 - lib/site_prism/error.rb
 - lib/site_prism/loadable.rb
 - lib/site_prism/logger.rb
 - lib/site_prism/page.rb
+- lib/site_prism/recursion_checker.rb
 - lib/site_prism/section.rb
 - lib/site_prism/version.rb
 - lib/site_prism/waiter.rb
@@ -196,7 +198,10 @@ metadata:
   bug_tracker_uri: https://github.com/natritmeyer/site_prism/issues
   changelog_uri: https://github.com/natritmeyer/site_prism/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/natritmeyer/site_prism
-post_install_message: 
+post_install_message: |-
+  site_prism has now moved to a new organisation to facilitate better
+  management of the codebase. The new organisation link is available at www.github.com/site-prism
+  and will house the site_prism gem plus new associated co-dependent gems.
 rdoc_options: []
 require_paths:
 - lib