insite 0.0.2 → 0.0.5

data/lib/insite/methods/common_methods.rb

@@ -1,23 +1,16 @@
 # TODO: A lot of this should be handled via delegation.
 module Insite
   module CommonMethods
-    # Returns a Watir::Browser object.
-    def browser
-      @browser
-    end
-
-    # Returns a Selenium::WebDriver::Driver object.
-    def driver
-      @browser.driver
-    end
-
-    # Don't override the default if it's already there.
-    unless defined? :html
-      # Returns current HTML for the object.
-      def html
-        @browser.html
+    # Returns a Nokogiri document for the object ONLY. So no need to specify a
+    # relative path.
+    def document(xpath = nil)
+      if xpath
+        Nokogiri::HTML(html).xpath(xpath)
+      else
+        Nokogiri::HTML(html)
       end
     end
+    alias nokogiri document
 
     # Returns a string representation of the page.
     def inspect
@@ -79,11 +72,11 @@ module Insite
           if @page_elements.include?(k)
             elem = public_send(k)
 
-            if [Watir::Alert, Watir::FileField, Watir::TextField, Watir::TextArea].include? elem.class
+            if [Insite::Alert, Insite::FileField, Insite::TextField, Insite::TextArea].include? elem.class
               elem.set v
-            elsif [Watir::Select].include? elem.class
+            elsif [Insite::Select].include? elem.class
               elem.select v
-            elsif [Watir::Anchor, Watir::Button].include? elem.class
+            elsif [Insite::Anchor, Insite::Button].include? elem.class
               case v
               when Symbol
                 elem.public_send v
@@ -94,7 +87,7 @@ module Insite
               else
                 raise ArgumentError, "Unsupported argument for #{elem.class}: '#{v}'"
               end
-            elsif elem.is_a?(Watir::Radio)
+            elsif elem.is_a?(Insite::Radio)
               case v
               when Symbol
                 elem.public_send v
@@ -110,7 +103,7 @@ module Insite
               else
                 raise ArgumentError, "Unsupported argument for #{elem.class}: '#{v}'"
               end
-            elsif elem.is_a?(Watir::CheckBox)
+            elsif elem.is_a?(Insite::CheckBox)
               case v
               when Symbol
                 elem.public_send v
@@ -130,17 +123,6 @@ module Insite
               else
                 raise ArgumentError, "Unsupported argument for #{elem.class}: '#{v}'"
               end
-            elsif elem.is_a?(Watir::RadioCollection)
-              # TODO: Remove, not appropriate as a general use case.
-              rb = elem.to_a.find do |r|
-                r.text =~ /#{Regexp.escape(v)}/i || r.parent.text =~ /#{Regexp.escape(v)}/i
-              end
-
-              if rb
-                rb.click
-              else
-                raise "No matching radio button could be detected for '#{val}' for #{elem}."
-              end
             else
               case v
               when Symbol
@@ -153,7 +135,7 @@ module Insite
                 raise ArgumentError, "Unsupported argument for #{elem.class}: '#{v}'"
               end
             end
-          elsif @widget_elements.include?(k)
+          elsif @component_elements.include?(k)
             w = public_send(k)
 
             begin
@@ -206,11 +188,18 @@ module Insite
       hash_args
     end
 
-    # Returns a Nokogiri document for the object ONLY. So no need to specify a
-    # relative path.
-    def nokogiri
-      Nokogiri::HTML(html)
+    # Duplicates Watir DOM element argument parsing for element methods.
+    private
+    def parse_args(args)
+      case args.length
+      when 2
+        return { args[0] => args[1] }
+      when 1
+        obj = args.first
+      when 0
+        return {}
+      end
     end
-    alias document nokogiri
+    public
   end
 end

data/lib/insite/methods/dom_methods.rb

@@ -1,60 +1,87 @@
 module Insite
   module DOMMethods
-    DOM_METHODS.each do |mth|
-      define_method(mth) do |name=nil, *args, &block|
-        if block
-          element_container(name, mth, *args, &block)
-        else
-          el(name) { |b| b.send(mth, parse_args(args.flatten)) }
-        end
-      end
-    end
+    Insite::METHOD_MAP.each do |k, v|
+      # Create class-level methods for defining
+      # DOM elements (1:1 match for Watir browser DOM methods.)
+      v.each do |mth|
+        # Class-level method to define page elements in a page class.
+        define_method(mth) do |name=nil, *args, &block|
+          @page_elements ||= [name.to_sym]
+          c = Insite::METHOD_MAP.find { |k, v| Insite::METHOD_MAP[k].include?(mth) }
+          c = c.first.to_s.demodulize
+          base_class = "Insite::#{c}".constantize
 
-   # TODO: (More context when this happens.)
-   # ArgumentError: wrong number of arguments (given 1, expected 0)
-   # from /Users/john/.rbenv/versions/2.3.5/lib/ruby/gems/2.3.0/gems/insite-0.5.1/lib/insite/methods/dom_methods.rb:17:in `block in el'
-    def el(name, &block)
-      @page_elements ||= []
-      @page_elements << name.to_sym
-
-      define_method(name) do
-        begin
-          elem = block.call(@browser)
-          begin
-            elem.dup.scroll.to
-          rescue => e
-          end
-        rescue(Watir::Exception::UnknownObjectException) => e
-          tmp = page
+          if block
+            new_class_name = "#{c}For#{name.to_s.camelcase}"
+            unless self.class.const_defined? new_class_name
+              klass = Class.new(base_class) do
+                @predefined_selector = parse_args(args)
+                class_eval(&block) if block
+              end
+              const_set(new_class_name, klass)
+            end
 
-          if tmp == @most_recent_page
-            raise e
+            define_method(name) do
+              if @site && @browser
+                klass.new(@site, parse_args(args))
+              end
+            end
           else
-            @most_recent_page = tmp
-            elem = block.call(@browser)
-            begin
-              elem.dup.scroll.to
-            rescue => e
+            define_method(name) do
+              if @site && @browser
+                base_class.new(@site, parse_args(args))
+              end
             end
           end
         end
-        elem
       end
-    end
 
-    # Duplicates Watir DOM element argument parsing for element methods.
-    private
-    def parse_args(args)
-      case args.length
-      when 2
-        return { args[0] => args[1] }
-      when 1
-        obj = args.first
-      return obj if obj.kind_of? Hash
-      when 0
-        return {}
+      # # TODO: (More context when this happens.)
+      # # ArgumentError: wrong number of arguments (given 1, expected 0)
+      # # from /Users/john/.rbenv/versions/2.3.5/lib/ruby/gems/2.3.0/gems/insite-0.5.1/lib/insite/methods/dom_methods.rb:17:in `block in el'
+      # def el(name, &block)
+      #   @page_elements ||= []
+      #   @page_elements << name.to_sym
+      #
+      #   define_method(name) do
+      #     begin
+      #       elem = block.call(@browser)
+      #       begin
+      #         elem.dup.scroll.to
+      #       rescue => e
+      #       end
+      #     rescue(Watir::Exception::UnknownObjectException) => e
+      #       tmp = page
+      #
+      #       if tmp == @most_recent_page
+      #         raise e
+      #       else
+      #         @most_recent_page = tmp
+      #         elem = block.call(@browser)
+      #         begin
+      #           elem.dup.scroll.to
+      #         rescue => e
+      #         end
+      #       end
+      #     end
+      #     elem
+      #   end
+      # end
+
+      # Duplicates Watir DOM element argument parsing for element methods.
+      private
+      def parse_args(args)
+        case args.length
+        when 2
+          return { args[0] => args[1] }
+        when 1
+          obj = args.first
+        return obj if obj.kind_of? Hash
+        when 0
+          return {}
+        end
       end
+      public
     end
-    public
   end
 end

data/lib/insite/page/defined_page.rb

@@ -1,18 +1,19 @@
-# TODO: Title matcher
+# TODO: Title matcher?
 # TODO: Add page query methods.
 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, :widget_elements
+    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
 
     include Insite::CommonMethods
+    extend  Insite::ComponentMethods
+    include Insite::ComponentInstanceMethods
+    extend  Insite::DOMMethods
+
     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_accessor :widget_elements
-
-      include Insite::DOMMethods
-      include Insite::WidgetMethods
+      attr_accessor :component_elements
 
       def describe
     puts <<-EOF
@@ -24,45 +25,14 @@ module Insite
 
     Page Elements:\n#{@page_elements.sort.map { |x| "  #{x} #{x.class.to_s.methodize}\n" }.join }
 
-    Widgets:\n#{@widget_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#{@widget_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
 
-      private
-      def element_container(name, type, *args, &block)
-        tmpklass = Class.new(ElementContainer) do
-          self.class_eval(&block) if block_given?
-        end
-        cname = name.to_s.camelcase + 'Container'
-        const_set(cname, tmpklass) unless const_defined? cname
-
-        @page_elements ||= []
-        @page_elements << name.to_sym
-
-        define_method(name) do
-          self.class.const_get(cname).send(:new, @site, @browser.send(type, *args))
-        end
-      end
-      public
-
-      # Creates a section within the page. TODO: section is a DOM element, rename this.
-      def feature(fname, klass = Insite::Feature, &block)
-        tmpklass = Class.new(klass) do
-          self.class_eval(&block) if block_given?
-        end
-
-        const_set(fname.to_s.camelcase, tmpklass) unless const_defined? fname.to_s.camelcase
-        @page_features ||= []
-        @page_features << fname.to_s.underscore.to_sym
-        define_method(fname.to_s.underscore) do
-          tmpklass.new(page = self)
-        end
-      end
-
       # Allows you to set special page attributes that affect page behavior. The two page
       # attributes currently supported are :navigation_disabled and :page_template:
       #
@@ -216,16 +186,25 @@ module Insite
       # The set_url method is not mandatory. when defining a page. If you don't use set_url in the page
       # definition then the page will defined the base_url as the page's URL.
       def set_url(url)
-        url ? @page_url = url : nil
+        url ? @page_url = url.gsub(/(?<!:)\/\/+/, '/') : nil
       end
 
       def set_url_template(base_url)
         case @page_url
+        when nil, ''
+          @url_template = Addressable::Template.new(base_url)
         when /(http:\/\/|https:\/\/)/i
-          @url_template = Addressable::Template.new(@page_url)
+          @url_template = Addressable::Template.new(
+            @page_url.gsub(/(?<!:)\/\/+/, '/')
+          )
         else
-          @url_template = Addressable::Template.new(Addressable::URI.parse("#{base_url}#{@page_url}"))
+          @url_template = Addressable::Template.new(
+            Addressable::URI.parse(
+              "#{base_url}#{@page_url}".gsub(/(?<!:)\/\/+/, '/')
+            )
+          )
         end
+
         @has_fragment = @url_template.pattern =~ /#/
       end
 
@@ -260,14 +239,14 @@ module Insite
         end
       end
 
-      def widget_method(method_name, widget_symbol, widget_method, target_element)
-        @widget_methods ||= []
-        @widget_methods << method_name.to_sym unless @widget_methods.include?(method_name.to_sym)
+      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(widget_symbol.to_s.camelize)
+          self.class.const_get(component_symbol.to_s.camelize)
           .new(@site, @site.send(target_element))
-          .send(widget_method, *args, &block)
+          .send(component_method, *args, &block)
         end
       end
     end # Self.
@@ -280,6 +259,14 @@ module Insite
       true
     end
 
+    def driver
+      @browser.driver
+    end
+
+    def html
+      @browser.html
+    end
+
     # Initializes a new page object. There's no need to ever call this method directly.
     # Your site class (the one that includes the Insite module) will handle this for
     # you
@@ -287,7 +274,7 @@ module Insite
       @site               = site
       @browser            = process_browser
 
-      @widget_elements    = self.class.widget_elements ||= []
+      @component_elements = self.class.component_elements ||= []
       @browser            = @site.browser
       @page_attributes    = self.class.page_attributes
       @page_url           = self.class.page_url
@@ -328,7 +315,7 @@ module Insite
 
             if args[arg] #The hash has the required argument.
               @arguments[arg]= args[arg]
-            elsif match.keys.include?(arg.to_s)
+            elsif match && match.keys.include?(arg.to_s)
               @arguments[arg] = match[arg.to_s]
             elsif @site.respond_to?(arg)
               @arguments[arg] = site.public_send(arg)
@@ -506,7 +493,7 @@ module Insite
           raise(
             Insite::Errors::WrongPageError,
             "Navigation check failed after attempting to access the #{self.class.name} page. " \
-            "Current URL #{@browser.url} did not match #{@url_template.pattern}"
+            "Current URL #{@browser.url} did not match #{@url_template.expand(@arguments)}"
           )
         end
       end

data/lib/insite/page/undefined_page.rb

@@ -3,6 +3,9 @@ module Insite
     attr_reader :arguments, :browser, :has_fragment, :page_attributes, :page_elements, :page_features, :page_url, :query_arguments, :required_arguments, :site, :url_template, :url_matcher
 
     include Insite::CommonMethods
+    extend  Insite::ComponentMethods
+    include Insite::ComponentInstanceMethods
+    # TODO: DOM methods.
 
     # Always returns false.
     def defined?
@@ -30,6 +33,14 @@ module Insite
   EOF
     end
 
+    def driver
+      @browser.driver
+    end
+
+    def html
+      @browser.html
+    end
+
     def initialize(site)
       @site    = site
       @browser = process_browser
@@ -59,7 +70,7 @@ module Insite
     def page_elements
       []
     end
-    alias_method :widget_elements, :page_elements
+    alias_method :component_elements, :page_elements
 
     # Returns the current URL.
     def url

data/lib/insite/version.rb

@@ -1,3 +1,3 @@
 module Insite
-  VERSION = '0.0.2'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insite
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - John Fitisoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,56 +16,70 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.5
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 6.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 6.11.0
 - !ruby/object:Gem::Dependency
   name: watir-scroll
   requirement: !ruby/object:Gem::Requirement
@@ -86,89 +100,110 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.21
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.21
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Page object library.
+        version: 3.7.0
+description: Page object library with support for component-based web frameworks
 email: jfitisoff@yahoo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/insite.rb
+- lib/insite/component/component.rb
+- lib/insite/component/component_collection.rb
+- lib/insite/component/component_instance_methods.rb
+- lib/insite/component/component_methods.rb
 - lib/insite/constants.rb
-- lib/insite/element_container/element_container.rb
+- lib/insite/element/element.rb
+- lib/insite/element/element_collection.rb
+- lib/insite/element/generated/class_map.rb
+- lib/insite/element/generated/element_classes.rb
+- lib/insite/element/generated/element_instance_methods.rb
 - lib/insite/errors.rb
-- lib/insite/feature/feature.rb
+- lib/insite/examples/material_angular_io/components/angular_material_component.rb
+- lib/insite/examples/material_angular_io/components/example_viewer.rb
+- lib/insite/examples/material_angular_io/components/mat_chip.rb
+- lib/insite/examples/material_angular_io/components/mat_chip_list.rb
+- lib/insite/examples/material_angular_io/components/mat_form_field.rb
+- lib/insite/examples/material_angular_io/components/mat_icon.rb
+- lib/insite/examples/material_angular_io/components/mat_input.rb
+- lib/insite/examples/material_angular_io/components/mat_option.rb
+- lib/insite/examples/material_angular_io/components/mat_select.rb
+- lib/insite/examples/material_angular_io/components/mat_select_content.rb
+- lib/insite/examples/material_angular_io/components/no_selector.rb
+- lib/insite/examples/material_angular_io/pages.rb
+- lib/insite/examples/material_angular_io/site.rb
+- lib/insite/examples/material_angular_io/utils.rb
+- lib/insite/examples/material_angular_io/watir_mods.rb
+- lib/insite/examples/material_angular_io_site.rb
 - lib/insite/insite.rb
 - lib/insite/methods/common_methods.rb
 - lib/insite/methods/dom_methods.rb
 - lib/insite/page/defined_page.rb
 - lib/insite/page/undefined_page.rb
 - lib/insite/version.rb
-- lib/insite/widget/widget.rb
-- lib/insite/widget/widget_methods.rb
 homepage: https://github.com/jfitisoff/insite
 licenses:
 - MIT
@@ -181,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -192,7 +227,12 @@ rubyforge_project:
 rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
-summary: Wraps page objects up into a site object, which provides some introspection
-  and navigation capabilities that page objects don't provide. Works with Watir and
-  Selenium.
+summary: Insite is a page object library that's geared towards writing reusable code
+  for component-based web applications. It allows you to write reusable test components
+  that model your application components. These components are interchangable with
+  regular DOM objects. Insite uses a "Site Object Model." You create a site object
+  class and define pages and components for the site. You then use the site object
+  as the interface to your application instead of declaring individual pages each
+  time that the site context changes. Think of the site object as a browser for page
+  objects.
 test_files: []