site-object 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29b5d367c47596bba00efad173e605df63f4135e
-  data.tar.gz: 70b1d65e5519d8d0d9eda901157d462d3cb28cce
+  metadata.gz: 6ffad1526098cde8900f8949d589b74808119b9f
+  data.tar.gz: 270bc988459c67d8e2aa4b557f3ad147569f0620
 SHA512:
-  metadata.gz: 04f664abd579838d75b3dd451899508e3493684fc4112afb3adb20ca1344a67089d12f94008daf6ce4ac075140ca8800d32e928569e21a93a9811f2b987b2d62
-  data.tar.gz: 0ce857445dbb62b554b26909a72672e2bde06e268d24012e1b58420da06c8971efffe6814c28244fc18356e860e39672747b4440fea4bf3270496d82744245fc
+  metadata.gz: 7f223fe2372d5ee95767ded972117c6873efd2e3f8c74b9e153fa94d9b09bd552b72d2413297139eb467332a07f42704e66ab8d12a22e94c13687f0b481b8af6
+  data.tar.gz: ae1d1cae273f5c1ff2b69ab3661bde87cda118221e27995db3b27dac89fa2ed470b70e37628fff7236b7fdf3996be016e84dc17c0221749f9b0d9fe547e48c4f

data/lib/site-object/exceptions.rb

@@ -1,4 +1,4 @@
-module SiteObjectExceptions
+module SiteObject
   class BrowserLibraryNotSupportedError < RuntimeError
   end
 

data/lib/site-object/page.rb

@@ -81,7 +81,7 @@ module PageObject
     # If the visit method is called on the page a SiteObject::PageNavigationNotAllowedError
     # will be raised.
     def disable_automatic_navigation
-      puts "DEPRECATED. Will be removed in a future release. Use the set_attributes method in place of this one. See documentation for more details."
+      puts "The disable_automatic_navigation method is deprecated and will be removed in a future release. Use the set_attributes method in place of this one in the class definition. See documentation for more details."
       @page_attributes ||= []
       @page_attributes << :navigation_disabled
       @navigation_disabled = true
@@ -264,17 +264,11 @@ module PageObject
     end
 
     def set_url_template(base_url)
-      begin
-        case @page_url.to_s
-        when '' # There's no page URL so just assume the base URL
-          @url_template = Addressable::Template.new(base_url)
-        when /(http:\/\/|https:\/\/)/i
-          @url_template = Addressable::Template.new(@page_url)
-        else
-          @url_template = Addressable::Template.new(Addressable::URI.parse("#{base_url}#{@page_url}"))
-        end
-      rescue Addressable::URI::InvalidURIError => e
-        raise SiteObject::PageInitError, "Unable to initialize #{self.class} because there's no base_url defined for the site and the page object URL that was defined was a URL fragment (#{@page_url})\n\n#{caller.join("\n")}"
+      case @page_url
+      when /(http:\/\/|https:\/\/)/i
+        @url_template = Addressable::Template.new(@page_url)
+      else
+        @url_template = Addressable::Template.new(Addressable::URI.parse("#{base_url}#{@page_url}"))
       end
     end
 
@@ -324,7 +318,7 @@ module PageObject
     # There's no need to ever call this directly. Initializes a page object within the context of a
     # site object. Takes a site object and a hash of configuration arguments. The site object will
     # handle all of this for you.
-    def initialize(site, args={})
+    def initialize(site, args=nil)
       @browser = site.browser
       @page_attributes = self.class.page_attributes
       @page_url = self.class.page_url
@@ -337,13 +331,21 @@ module PageObject
 
       # Try to expand the URL template if the URL has parameters.
       @arguments = {}.with_indifferent_access # Stores the param list that will expand the url_template after examining the arguments used to initialize the page.
-      if @required_arguments.length >  0 && !args
-        raise SiteObject::PageInitError, "No object was 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")}"
-      elsif @required_arguments.length > 0
+      if @required_arguments.present? && !args
+        @required_arguments.each do |arg|
+          if @site.respond_to?(arg)
+            @arguments[arg]= site.send(arg)
+          else
+            raise SiteObject::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")}"
+          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.
-          if args.is_a?(Hash) && !args.empty?
-            if args.with_indifferent_access[arg] #The hash has the required argument.
-              @arguments[arg]= args.with_indifferent_access[arg]
+          if args.is_a?(Hash) && args.present?
+            args = args.with_indifferent_access
+
+            if args[arg] #The hash has the required argument.
+              @arguments[arg]= args[arg]
             elsif @site.respond_to?(arg)
               @arguments[arg]= site.send(arg)
             else
@@ -358,16 +360,15 @@ module PageObject
               raise SiteObject::PageInitError, "#{args.class} was provided, but this object did not respond to :#{arg}, which is necessary to build an URL for the #{self.class.name} page.\n\n#{caller.join("\n")}"
             end
           else
-            # Do nothing here.
+           # No need to do anything here.
           end
         end
-      elsif @required_arguments.length == 0 && args # If there are no required arguments.
-        unless args.is_a?(Hash) && args.empty?     # Do this unless args is an empty hash.
-          raise SiteObject::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")}"
-        end
+      elsif @required_arguments.empty? && args # If there are no required arguments then nothing should be provided.
+        raise SiteObject::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.
       end
+
       @url = @url_template.expand(@arguments).to_s
       @page_features ||= []
       @page_features.each do |arg|
@@ -388,11 +389,7 @@ module PageObject
       @site.most_recent_page = self
       unless on_page?
         if navigation_disabled?
-          if page = @site.page
-            raise SiteObject::PageNavigationNotAllowedError, "The #{self.class.name} page could not be accessed. Navigation is intentionally disabled for this page and the browser was displaying the #{@site.page.class.name} page when you tried to access it.\n\nPAGE URL:\n------------\n#{@site.browser.url}\n\n#{caller.join("\n")}"
-          else
-            raise SiteObject::PageNavigationNotAllowedError, "The #{self.class.name} page could not be accessed. Navigation is intentionally disabled for this page and the page that the browser was displaying could not be recognized.\n\nPAGE URL:\n------------\n#{@site.browser.url}\n\nPAGE TEXT:\n------------\n#{@site.browser.text}\n\n#{caller.join("\n")}"
-          end
+          raise SiteObject::PageNavigationNotAllowedError, "Navigation is intentionally disabled for the #{self.class.name} page. You can only call the accessor method for this page when it's already being displayed in the browser.\n\nCurrent URL:\n------------\n#{@site.browser.url}\n\n#{caller.join("\n")}"
         end
         visit
       end
@@ -427,9 +424,21 @@ module PageObject
     # you can use the alternate method to specify how to match the page.
     def on_page?
       if @url_template.pattern =~ /#/ # It has a URL fragment. Don't mess with the browser URL.
-        url = @browser.url
+        if @browser.is_a? Watir::Browser
+          url = @browser.url
+        elsif @browser.is_a? Selenium::WebDriver::Driver
+          url = @browser.current_url
+        else
+          raise SiteObject::BrowserLibraryNotSupportedError, "Unsupported browser library: #{@browser.class}"
+        end
       else # There's no fragment in the URL template, strip the fragment out of the URL so that template matching works better.
-        url = @browser.url.split('#')[0]
+        if @browser.is_a? Watir::Browser
+          url = @browser.url.split('#')[0]
+        elsif @browser.is_a? Selenium::WebDriver::Driver
+          url = @browser.current_url.split('#')[0]
+        else
+          raise SiteObject::BrowserLibraryNotSupportedError, "Unsupported browser library: #{@browser.class}"
+        end
       end
 
       if @url_matcher && @url_matcher =~ url

data/lib/site-object/site.rb

@@ -7,8 +7,6 @@ module SiteObject
   attr_reader :base_url, :unique_methods
   attr_accessor :pages, :browser, :arguments, :most_recent_page
 
-  include SiteObjectExceptions
-
   # Sets up a Page class when the SiteObject module is included in the class you're using to model
   # your site.
   def self.included(base)
@@ -91,7 +89,7 @@ module SiteObject
         end
 
         self.class.class_eval do
-          define_method(current_page.to_s.underscore) do |args={}, block=nil|
+          define_method(current_page.to_s.underscore) do |args=nil, block=nil|
             current_page.new(self, args)
           end
 
@@ -164,7 +162,13 @@ module SiteObject
   #  site.on_page? AccountSummaryPage
   #  =>true
   def on_page?(page_arg)
-    url = @browser.url
+    if @browser.is_a? Watir::Browser
+      url = @browser.url
+    elsif @browser.is_a? Selenium::WebDriver::Driver
+      url = @browser.current_url
+    else
+      raise SiteObject::BrowserLibraryNotSupportedError, "Unsupported browser library: #{@browser.class}"
+    end
 
     if page_arg.url_matcher && page_arg.url_matcher =~ url
       return true
@@ -197,13 +201,19 @@ module SiteObject
   def page
     return @most_recent_page if @most_recent_page && @most_recent_page.on_page?
 
-    url = @browser.url
-    found_page = nil
+    if @browser.is_a? Watir::Browser
+      url = @browser.url
+    elsif @browser.is_a? Selenium::WebDriver::Driver
+      url = @browser.current_url
+    else
+      raise SiteObject::BrowserLibraryNotSupportedError, "Unsupported browser library: #{@browser.class}"
+    end
 
+    found_page = nil
     @pages.each do |p|
-      if p.url_template.match url
+      if p.url_matcher && p.url_matcher =~ url
         found_page = p
-      elsif p.url_matcher && p.url_matcher =~ url
+      elsif p.url_template.match url
         found_page = p
       end
 

data/lib/site-object/version.rb

@@ -1,3 +1,3 @@
 module SiteObject
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site-object
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - John Fitisoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2015-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport