insite 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16f1ba3790818bbea311d4b4ae7dfafa48ce7e054e157797817ac6554efac22a
-  data.tar.gz: fcb7131304d81c5556913a24f085eb1f7df2c62d8f0bdb97a410f15bd9c7bb03
+  metadata.gz: 5149a50ee698c0eeec91cb7127d89a2eb175f09d50967bc40fefa78137cee823
+  data.tar.gz: 4644600b968f6f8846a1a3f5c1e9fc02c89afd7d88c81f9e0f45bd873e5d7858
 SHA512:
-  metadata.gz: ac5b61ba8ccde92a29dd8450fa6a8a079e201eec5571ab4fa5f0413d5f2de5f15b70d5624ee0f87cddd96a1dcaadf9f3393330f147ee93bdb3a8fb3ff48036b5
-  data.tar.gz: 86d7e500ec84c9061f5a1d8a7078b945fe1a8fcd714d8e3f5f7ec2bc68a96247b877fcb88c2d4506e77c74e6cfafa0b071d882b1a048b974d3e642fb6f9249ec
+  metadata.gz: a40f146bd90b92f28939eb81917d33fb7d61ec82a3f943a5c2012a4aba12eb4bc273f0305435a68d3759ce87a5a5cba721a2d5b024a991f8f3ede5e23540988a
+  data.tar.gz: 269097cb25d93d68a441510daf7642660577aab7f63571ee8b1055af4922c4607ffd3c32e7724b84b12fa9ed70994552fceaf19bf1ec47fe101f75af1fa4e819

data/lib/insite/page/defined_page.rb

@@ -1,8 +1,9 @@
 # TODO: Title matcher?
 # TODO: Add page query methods.
+require 'pry'
 module Insite
   class DefinedPage
-    attr_reader :arguments, :browser, :has_fragment, :page_attributes, :page_elements, :page_features, :page_url, :query_arguments, :required_arguments, :site, :url_template, :url_matcher, :component_elements
+    attr_reader :arguments, :browser, :has_fragment, :page_attributes, :page_elements, :page_features, :page_url, :required_arguments, :site, :url_template, :url_matcher, :component_elements
 
     include Insite::CommonMethods
     extend  Insite::ComponentMethods
@@ -12,7 +13,7 @@ module Insite
     alias_method :update_page, :update_object
 
     class << self
-      attr_reader :has_fragment, :page_attributes, :page_elements, :page_features, :page_url, :url_matcher, :url_hash, :url_template
+      attr_reader :arguments, :has_fragment, :page_attributes, :page_elements, :page_features, :page_url, :required_arguments, :url_matcher, :url_hash, :url_template
       attr_accessor :component_elements
 
       # Allows you to set special page attributes that affect page behavior. The two page
@@ -68,15 +69,6 @@ module Insite
         @page_attributes.include? :page_template
       end
 
-      # Returns an array of symbols representing the required arguments for the page's page URL.
-      def required_arguments
-        @arguments ||= @url_template.keys.map { |k| k.to_sym }
-      end
-
-      def query_arguments
-        required_arguments.find { |x| @url_template.pattern =~ /\?.*#{x}=*/ }
-      end
-
       # Used to define the full or relative URL to the page. Typically, you will *almost* *always* want to use
       # this method when defining a page object (but see notes below.) The URL can be defined in a number
       # of different ways. Here are some examples using Google News:
@@ -190,6 +182,13 @@ module Insite
         end
 
         @has_fragment = @url_template.pattern =~ /#/
+
+        @arguments ||= @url_template.keys.map(&:to_sym)
+
+        @required_arguments ||= @url_template.pattern
+          .scan(/\{(#{self.arguments.join('|')})/)
+          .flatten
+          .map(&:to_sym)
       end
 
       # Optional. Allows you to specify a fallback mechanism for checking to see if the correct page is
@@ -251,10 +250,10 @@ module Insite
       @page_elements      = self.class.page_elements
       # TODO: Clean this up
       @page_features      = self.class.instance_variable_get(:@page_features)
+      @all_arguments      = self.class.arguments
       @required_arguments = self.class.required_arguments
       @url_matcher        = self.class.url_matcher
       @url_template       = self.class.url_template
-      @query_arguments    = self.class.query_arguments
       @has_fragment       = self.class.has_fragment
 
       # Try to expand the URL template if the URL has parameters. Stores the
@@ -266,7 +265,7 @@ module Insite
       match = @url_template.match(@browser.url)
 
       # Raise if args are provided and the page doesn't take any args.
-      if (@required_arguments - [:scheme]).empty? && args
+      if (@all_arguments - [:scheme]).empty? && args
         raise(
           Insite::Errors::PageInitError,
           "#{args.class} was provided as a #{self.class.name} initialization argument, " \
@@ -274,28 +273,30 @@ module Insite
         )
       end
 
-      if @required_arguments.present? && !args
-        @required_arguments.each do |arg|
+      if @all_arguments.present? && !args
+        @all_arguments.each do |arg|
           if match && match.keys.include?(arg.to_s)
             @arguments[arg] = match[arg.to_s]
           elsif @site.arguments[arg]
             @arguments[arg] = @site.arguments[arg]
           elsif @site.respond_to?(arg) && @site.public_send(arg)
             @arguments[arg] = @site.public_send(arg)
+          elsif !@required_arguments.include?(arg)
+            @arguments[arg] = nil
           else
             raise(
               Insite::Errors::PageInitError,
-              "No arguments provided when attempting to initialize #{self.class.name}. " \
-              "This page object requires the following arguments for initialization: "\
-              ":#{@required_arguments.join(', :')}.\n\n#{caller.join("\n")}"
+              "An error occurred when attempting to build a URL for the #{self.class} page.\n" \
+              "URL template:\t#{@url_template.pattern}\n" \
+              "URL arguments:\t#{@arguments}\n" \
+              "Required args:\t#{@required_arguments.join(', :')}.\n" \
+              "Generated URL:\t#{@url_template.expand(@arguments)}\n"
             )
           end
         end
-      elsif @required_arguments.present?
-        @required_arguments.each do |arg| # Try to extract each URL argument from the hash or object provided, OR from the site object.
+      elsif @all_arguments.present?
+        @all_arguments.each do |arg| # Try to extract each URL argument from the hash or object provided, OR from the site object.
           if args.is_a?(Hash) && args.present?
-            # args = args.with_indifferent_access
-
             if @arguments[arg] #The hash has the required argument.
               @arguments[arg]= args[arg]
             elsif match && match.keys.include?(arg.to_s)
@@ -304,41 +305,41 @@ module Insite
               @arguments[arg] = site.public_send(arg)
             elsif @site.arguments[arg]
               @arguments[arg] = @site.arguments[arg]
+            elsif !@required_arguments.include?(arg)
+              @arguments[arg] = nil
             else
               raise(
                 Insite::Errors::PageInitError,
-                "A required page argument is missing. #{args.class} was provided, " \
-                "but this object did not respond to :#{arg}, which is necessary to " \
-                "build a URL for the #{self.class.name} page.\n\n#{caller.join("\n")}"
+                "An error occurred when attempting to build a URL for the #{self.class} page.\n" \
+                "URL template:\t#{@url_template.pattern}\n" \
+                "URL arguments:\t#{@arguments}\n" \
+                "Required args:\t#{@required_arguments.join(', :')}.\n" \
+                "Generated URL:\t#{@url_template.expand(@arguments)}\n"
               )
             end
           elsif args # Some non-hash object was provided.
             if args.respond_to?(arg) #The hash has the required argument.
-              # @arguments[arg]= args.public_send(arg)
               @arguments[arg]= args.public_send(arg)
             elsif @site.respond_to?(arg)
               @arguments[arg]= site.public_send(arg)
             elsif @site.arguments[arg]
               @arguments[arg] = @site.arguments[arg]
+            elsif !@required_arguments.include?(arg)
+              @arguments[arg] = nil
             else
               raise(
                 Insite::Errors::PageInitError,
-                "A required page argument is missing. #{args.class} was provided, but " \
-                "this object did not respond to :#{arg}, which is necessary to build " \
-                "a URL for the #{self.class.name} page.\n\n#{caller.join("\n")}"
+                "An error occurred when attempting to build a URL for the #{self.class} page.\n" \
+                "URL template:\t#{@url_template.pattern}\n" \
+                "URL arguments:\t#{@arguments}\n" \
+                "Required args:\t#{@required_arguments.join(', :')}.\n" \
+                "Generated URL:\t#{@url_template.expand(@arguments)}\n"
               )
             end
           else
             # Do nothing here yet.
           end
         end
-      # If there are no required arguments then nothing should be provided.
-      # elsif (@required_arguments - [:scheme]).empty? && args
-      #   raise(
-      #     Insite::Errors::PageInitError,
-      #     "#{args.class} was provided as a #{self.class.name} initialization argument, " \
-      #     "but the page URL doesn't require any arguments.\n\n#{caller.join("\n")}"
-      #   )
       else
         # Do nothing here yet.
       end
@@ -390,9 +391,7 @@ module Insite
       @page_attributes.include? :navigation_disabled
     end
 
-    def on_page?
-      url = @browser.url
-
+    def on_page?(url = @browser.url)
       if @url_matcher
         if @url_matcher =~ url
           return true

data/lib/insite/page/undefined_page.rb

@@ -1,6 +1,6 @@
 module Insite
   class UndefinedPage
-    attr_reader :arguments, :browser, :has_fragment, :page_attributes, :page_elements, :page_features, :page_url, :query_arguments, :required_arguments, :site, :url_template, :url_matcher
+    attr_reader :arguments, :browser, :has_fragment, :page_attributes, :page_elements, :page_features, :page_url, :required_arguments, :site, :url_template, :url_matcher
 
     include Insite::CommonMethods
     extend  Insite::ComponentMethods

data/lib/insite/version.rb

@@ -1,3 +1,3 @@
 module Insite
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - John Fitisoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2018-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport