insite 0.0.6 → 0.0.7

data/lib/insite/examples/material_angular_io/components/overwritten_selector.rb

@@ -0,0 +1,3 @@
+class OverwrittenSelector < MatChip
+  select_by! class: "overwritten"
+end

data/lib/insite/examples/material_angular_io/components/pluralized_name_test.rb

@@ -0,0 +1,2 @@
+class Pluralizes < MaterialAngularIO::Component
+end

data/lib/insite/examples/material_angular_io_site.rb

@@ -5,10 +5,19 @@ end
 
 # Require hand-crafted artisanal components.
 %w(example_viewer mat_chip_list mat_chip mat_icon mat_form_field
-   mat_input mat_option mat_select_content mat_select no_selector).each do |c|
+   mat_input mat_option mat_select_content mat_select no_selector
+   overwritten_selector pluralized_name_test).each do |c|
   require "insite/examples/material_angular_io/components/#{c}"
 end
 
+class OneVarTemplatePage < MaterialAngularIO::Page
+  set_url "/components/chips/overview/{var1}"
+end
+
+class TwoVarTemplatePage < MaterialAngularIO::Page
+  set_url "/components/chips/overview/{var1}/{var2}"
+end
+
 # Most of the pages for material.angular.io are auto-generated because
 # their URLs match a pattern. But some custom page definitions are included
 # below. This first overwrites the auto-generated page definition for
@@ -17,9 +26,10 @@ end
 class ChipsOverviewPage < MaterialAngularIO::Page
   set_url "/components/chips/overview"
 
-  no_selector :test_no_selector
   no_selector :test_no_selector_with_args, tag_name: :div, index: 3
 
+  overwritten_selector :overwritten_selector
+
   elements :mat_examples_collection, tag_name: 'example-viewer'
   elements :modified_mat_examples_collection, tag_name: 'example-viewer' do
     def test_method

data/lib/insite/insite.rb

@@ -1,4 +1,5 @@
 require 'timeout'
+require_relative 'methods/common_methods'
 
 # Usage:
 #  require 'insite'
@@ -7,17 +8,20 @@ require 'timeout'
 #    include Insite
 #  end
 module Insite
-  attr_reader :base_url, :unique_methods, :browser_type
+  attr_reader :base_url, :unique_methods, :browser_type, :site
   attr_accessor :pages, :browser, :arguments, :most_recent_page
 
+  include CommonMethods
+
   def self.class_to_tag(klass)
     if klass.respond_to?(:collection) && klass.collection?
-      Watir.tag_to_class.key(klass) ||
-      Watir.tag_to_class.key(CLASS_MAP.key(klass)) ||
-      Watir.tag_to_class.key(CLASS_MAP.key(klass.collection_member_class))
+      (
+        Watir.tag_to_class.key(klass) ||
+        Watir.tag_to_class.key(CLASS_MAP.key(klass)) ||
+        Watir.tag_to_class.key(CLASS_MAP.key(klass.collection_member_class))
+      )
     else
-      Watir.tag_to_class.key(klass) ||
-      Watir.tag_to_class.key(CLASS_MAP.key(klass))
+      Watir.tag_to_class.key(klass) || Watir.tag_to_class.key(CLASS_MAP.key(klass))
     end
   end
 
@@ -64,31 +68,6 @@ module Insite
     @browser.close if browser?
   end
 
-  def describe
-puts <<-EOF
-Wrapper class for all pages defined for the site.
-Site:\t#{self.class} (#{__FILE__})
-Base URL:\t#{@base_url}
-Browser:\t#{@browser}
-Current Page:\t#{page.class}
-
-Page Accessor Methods (Use '?' with name to check for presence.)
------------------------------------------------------------------
-#{
-  tmp = []
-  max = pages.map(&:to_s).max { |x| x.length }
-  if max.length > 40
-    pages.map(&:to_s).sort.map(&:underscore).join("\n")
-  else
-    pages.map(&:to_s).sort.map(&:underscore).each_slice(2) do |arr|
-      tmp << arr[0].to_s.ljust(40) + arr[1].to_s.ljust(40)
-    end
-    tmp.join("\n")
-  end
-}
-EOF
-  end
-
   # Returns a Selenium driver object.
   def driver
     @browser.driver
@@ -99,23 +78,24 @@ EOF
     browser?
   end
 
-  def generate_tag_classes
-    tags = []
-    cli = Highline.new
-
-    loop do
-      tags = (tags + find_non_standard_tags).uniq.sort
-      cli.choose do |menu|
-        menu.prompt "Found #{tags.length} non-standard tags. Choose one of the following options:"
-        menu.choice(:list_tags) { puts tags.join(",\n") + "\n" }
-        menu.choice(:continue)  {}
-        menu.choice(:write_to_console) do
-        end
-        menu.choice(:exist_without_writing) { break }
+  # def generate_tag_classes
+  #   tags = []
+  #   cli = Highline.new
+  #
+  #   loop do
+  #     tags = (tags + find_non_standard_tags).uniq.sort
+  #     cli.choose do |menu|
+  #       menu.prompt "Found #{tags.length} non-standard tags. Choose one of the following options:"
+  #       menu.choice(:list_tags) { puts tags.join(",\n") + "\n" }
+  #       menu.choice(:continue)  {}
+  #       menu.choice(:write_to_console) do
+  #       end
+  #       menu.choice(:exist_without_writing) { break }
+  #
+  #     end
+  #   end
+  # end
 
-      end
-    end
-  end
   # Creates a site object, which will have accessor methods for all pages that
   # you have defined for the site. This object takes a hash argument. There is
   # only one required value (the base_url for the site.) Example:
@@ -137,13 +117,18 @@ EOF
   #  => 1
   # TODO: Sort args.
   def initialize(base_url = nil, hsh={})
-    @arguments       = hsh.with_indifferent_access
-    @base_url        = base_url
-    @browser_type    = (@arguments[:browser] ? @arguments[:browser].to_sym : nil)
-    @pages           = self.class::DefinedPage.descendants.reject { |p| p.page_template? }
+    @site = self
+    @arguments    = hsh.with_indifferent_access
+    @base_url     = base_url
+    @browser_type = (@arguments[:browser] ? @arguments[:browser].to_sym : nil)
+
+    # Cull templates from array of pages that gets returned (since templates
+    # should never be used directly.)
+    @pages = self.class::DefinedPage.descendants.reject do |pg|
+      pg.page_template?
+    end
 
-    # Build generic components for custom tags, which are defined
-    # using Site.custom_tags.
+    # Builds generic components for custom tags.
     if self.class.custom_tags
       self.class.custom_tags.each do |tag|
         # TODO: Ditch string interpolation.
@@ -182,6 +167,14 @@ EOF
       end
     end
 
+    # Sort templates by variable count: Templates with more vars will be
+    # prioritized. This will partially eliminate the potential for a match on
+    # the wrong template when there are two or more templates that match the
+    # URL.
+    @pages = @pages.sort do |pg1, pg2|
+      pg1.url_template.variables.length <=> pg2.url_template.variables.length
+    end
+
     visited = Set.new
     tmp = @pages.map {|p| p.instance_methods }.flatten
     tmp.each do |element|
@@ -205,6 +198,10 @@ EOF
     end.uniq.sort
   end
 
+  def html
+    @browser.html
+  end
+
   def html_tags
     %i(html title head body) + Insite::METHOD_MAP.values.flatten.each do |mth|
       elem = @browser.send(mth)
@@ -227,10 +224,12 @@ EOF
   # what was attempted.
   def method_missing(mth, *args, &block)
     original_page = @most_recent_page
+
     if original_page.respond_to?(mth)
       original_page.public_send(mth, *args, &block)
     else
       new_page = page
+
       if new_page.respond_to?(mth)
         page.public_send(mth, *args, &block)
       elsif !new_page.defined?
@@ -322,15 +321,54 @@ EOF
   # URL in the browser.
   #
   # If a matching page can't be found then Insite will return an "undefined page"
-  # object. See the Un class for more details.
+  # object. See the UndefinedPage class for more details.
   def page
+    # 1.)
+    # Before anything else, look to see if it's the most recent page:
     return @most_recent_page if @most_recent_page && @most_recent_page.on_page?
+    process_browser
     url = @browser.url
+
     found_page = nil
+    # 2.)
+    # Ensure that static templates are always prioritized when attempting to
+    # match, which will prevent the wrong template from getting matched in this
+    # scenario:
+    #  - "/accounts/{account_code}"
+    #  - "/accounts/new"
+    #
+    # Start by working through the array from FRONT to BACK, since any static
+    # templates will be at the front of the array. Stop when we start to see
+    # templates whth vars (These will get handled in the next statement.)
     @pages.each do |pg|
+      break if pg.url_template.variables.length > 0
+
+      if pg.url_matcher && pg.url_matcher =~ url
+        found_page = pg
+      elsif pg.url_template.match(url)
+        found_page = pg
+      else
+        next
+      end
+
+      break if found_page
+    end
+
+    # 3.) Now we've reached the templates that include one or more variables.
+    # For these, we want to try to match on the templates with more variables.
+    # This prevents an invalid match in the following situation and removes the
+    # need to provide a URL matcher to override the URL template:
+    # - "/accounts/{account_code}/edit"
+    # - "/accounts/{account_code}"
+    # Now work through all the array from BACK to FRONT, stopping when we reach
+    # the point where we see templates without a var (since those were already
+    # handled above.)
+    @pages.reverse.each do |pg|
+      break if pg.url_template.variables.length == 0
+
       if pg.url_matcher && pg.url_matcher =~ url
         found_page = pg
-      elsif !pg.url_matcher && pg.url_template.match(url)
+      elsif pg.url_template.match(url)
         found_page = pg
       else
         next

data/lib/insite/methods/common_methods.rb

@@ -12,10 +12,6 @@ module Insite
     end
     alias nokogiri document
 
-    # Returns a string representation of the page.
-    def inspect
-      "#<#{self.class.name}:#{object_id} @url=#{@browser.url}>"
-    end
 
     private
     def process_browser
@@ -29,8 +25,6 @@ module Insite
               "Browser check failed. The browser is no longer present.\n\n"
             )
           end
-        rescue(Insite::Errors::BrowserNotOpenError) => e
-          raise e
         rescue => e
           raise(
             Insite::Errors::BrowserResponseError,
@@ -57,6 +51,46 @@ module Insite
 
     end
     public
+    # private
+    # def process_browser
+    #   if @site.browser.is_a?(Watir::Browser)
+    #     begin
+    #       if @site.browser.exists?
+    #         return @site.browser
+    #       else
+    #         raise(
+    #           Insite::Errors::BrowserClosedError,
+    #           "Browser check failed. The browser is no longer present.\n\n"
+    #         )
+    #       end
+    #     rescue(Insite::Errors::BrowserNotOpenError) => e
+    #       raise e
+    #     rescue => e
+    #       raise(
+    #         Insite::Errors::BrowserResponseError,
+    #         <<~eos
+    #         Browser check failed. The browser returned an #{e.class} (#{e}) when it was queried.
+    #         Backtrace for the error:
+    #         #{e.backtrace.join("\n")}
+    #
+    #         eos
+    #       )
+    #     end
+    #   elsif @site.browser.nil?
+    #     raise(
+    #       Insite::Errors::BrowserNotOpenError,
+    #       "A browser has not been defined for the site. Try using Site#open to " \
+    #       "start a browser.\n\n"
+    #     )
+    #   else
+    #     raise(
+    #       Insite::Errors::BrowserNotValidError,
+    #       "Expected: Watir::Browser. Actual: #{@site.browser.class}.\n\n"
+    #     )
+    #   end
+    #
+    # end
+    # public
 
     def update_object(hash_args = {})
       rescues = [

data/lib/insite/page/defined_page.rb

@@ -12,27 +12,9 @@ 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_template
+      attr_reader :has_fragment, :page_attributes, :page_elements, :page_features, :page_url, :url_matcher, :url_hash, :url_template
       attr_accessor :component_elements
 
-      def describe
-    puts <<-EOF
-    Page Class:\t#{name} (#{__FILE__})
-    URL Template:\t#{@url_template.pattern}"
-    URL Matcher:\t#{@url_matcher || 'Not specified.'}
-
-    Contains user-defined logic for a single page.
-
-    Page Elements:\n#{@page_elements.sort.map { |x| "  #{x} #{x.class.to_s.methodize}\n" }.join }
-
-    Components:\n#{@component_elements.sort.map { |x| "  #{x} #{x.class.to_s.methodize}\n" }.join }
-
-    Features:\n#{@component_elements.sort.map { |x| "  #{x} #{x.class.to_s.methodize}\n" }.join }
-
-    EOF
-
-      end
-
       # Allows you to set special page attributes that affect page behavior. The two page
       # attributes currently supported are :navigation_disabled and :page_template:
       #
@@ -220,39 +202,20 @@ module Insite
         regexp ? @url_matcher = regexp : nil
       end
 
-      # Used to import page features for use within the page. Example:
-      #
-      #  class ConfigPage < MySite::Page
-      #    use_features :footer, :sidebar
-      #  end
-      #
-      # Then, once the page object has been initialized:
+      # def component_method(method_name, component_symbol, component_method, target_element)
+      #   @component_methods ||= []
+      #   @component_methods << method_name.to_sym unless @component_methods.include?(method_name.to_sym)
       #
-      #  site.config_page.footer.about.click
-      #
-      # Use the PageFeature class to define page features.
-      def use_features(*args)
-        if @page_features
-          @page_feature += args
-        else
-          @page_features = args
-        end
-      end
-
-      def component_method(method_name, component_symbol, component_method, target_element)
-        @component_methods ||= []
-        @component_methods << method_name.to_sym unless @component_methods.include?(method_name.to_sym)
-
-        define_method(method_name) do |*args, &block|
-          self.class.const_get(component_symbol.to_s.camelize)
-          .new(@site, @site.send(target_element))
-          .send(component_method, *args, &block)
-        end
-      end
+      #   define_method(method_name) do |*args, &block|
+      #     self.class.const_get(component_symbol.to_s.camelize)
+      #     .new(@site, @site.send(target_element))
+      #     .send(component_method, *args, &block)
+      #   end
+      # end
     end # Self.
 
-    def describe
-      self.class.describe
+    def browser?
+      @site.browser?
     end
 
     def defined?
@@ -263,6 +226,10 @@ module Insite
       @browser.driver
     end
 
+    def driver?
+      browser?
+    end
+
     def html
       @browser.html
     end
@@ -499,7 +466,6 @@ module Insite
       end
 
       @site.most_recent_page = self
-      self
     end
   end
 end

data/lib/insite/page/undefined_page.rb

@@ -12,27 +12,6 @@ module Insite
       false
     end
 
-    def describe
-  puts <<-EOF
-  Page Class:\t#{name} (#{__FILE__})
-  URL Template:\tNA
-  URL Matcher:\tNA
-
-  Page class for any page that hasn't been defined (or that Insite doesn't recognize.)
-
-  Note: If there is a page class that is defined for this page that isn't getting
-  loaded, try the following:
-   - Review the pages URL template for problems. A URL template is *not* an interpolated
-     string -- it just looks like one. See the documentation for more details.
-   - If the URL template seems to be designed correctly for loading the page, but the
-     page's URL changes after the load, you will need to look at adding a URL matcher,
-     which overrides the URL template for purposes of checking whether the page object
-     is matching the currently displayed page after it has been loaded.
-
-  Page Elements:\tNA
-  EOF
-    end
-
     def driver
       @browser.driver
     end
@@ -50,13 +29,13 @@ module Insite
     # TODO: Do the same cache check that's done for a defined page and reapply the
     # method if the cache is updated and the new page DOES respond to the method.
     def method_missing(mth, *args, &block)
-      raise NoMethodError, "Could not apply #{mth}. The current page could not be " \
-      "recognized. Current URL #{@browser.url}"
+      raise NoMethodError, "Could not apply #{mth}. The current page couldn't " \
+      "be recognized. Current URL #{@browser.url}"
     end
 
     # Returns a Nokogiri object for the page HTML.
     def nokogiri
-      @site.nokogiri
+      Nokogiri::HTML(html)
     end
 
     # Similar to the method that you can call on a page object you've defined (but always