insite 0.0.2 → 0.0.5

data/lib/insite/errors.rb

@@ -6,10 +6,12 @@ module Insite
     class Insite::Errors::BrowserNotOpenError             < StandardError; end
     class Insite::Errors::BrowserNotValidError            < StandardError; end
     class Insite::Errors::BrowserResponseError            < StandardError; end
+    class Insite::Errors::ComponentReferenceError         < StandardError; end
     class Insite::Errors::PageConfigError                 < StandardError; end
     class Insite::Errors::PageInitError                   < StandardError; end
     class Insite::Errors::PageNavigationError             < StandardError; end
     class Insite::Errors::PageNavigationNotAllowedError   < StandardError; end
+    class Insite::Errors::ComponentSelectorError          < StandardError; end
     class Insite::Errors::SiteInitError                   < StandardError; end
     class Insite::Errors::WrongPageError                  < StandardError; end
   end

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

@@ -0,0 +1,13 @@
+class AngularMaterialComponent < MaterialAngularIO::Component
+  attr_reader :ngcontent, :nghost
+
+  def ngcontent
+    @ngcontent ||=
+    attributes.keys.find { |k| k.match(/^_ngcontent-.*/) }
+  end
+
+  def nghost
+    @nghost ||=
+    attributes.keys.find { |k| k.match(/^_nghost-.*/) }
+  end
+end

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

@@ -0,0 +1,5 @@
+require_relative 'angular_material_component'
+
+class ExampleViewer < MaterialAngularIO::Component
+  select_by tag_name: 'example-viewer'
+end

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

@@ -0,0 +1,29 @@
+require_relative 'angular_material_component'
+
+class MatChip < MaterialAngularIO::Component
+  select_by tag_name: 'mat-chip'
+
+  def disabled?
+    element(class: 'mat-chip-disabled').exist?
+  end
+
+  def label
+    nokogiri.xpath('//text()')[0]
+  end
+
+  def remove
+    element(class: 'mat-chip-remove').click
+  end
+
+  def removable?
+    element(class: 'mat-chip-remove').exist?
+  end
+
+  def selected?
+    aria_selected == 'true'
+  end
+
+  def selectable?
+    element(class: 'mat-chip-select').exist?
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative 'angular_material_component'
+require 'pry'
+class MatChipList < AngularMaterialComponent
+  select_by tag_name: 'mat-chip-list'
+
+  def add(value)
+    mat_input(ngcontent => true).set(value + "\n")
+  end
+
+  def clear_input(value)
+    mat_input(ngcontent => true).clear
+  end
+
+  def remove(value)
+    mat_input(ngcontent => true).mat_icon.click
+  end
+
+  def set_input(value)
+    mat_input(ngcontent => true).set(value)
+  end
+end

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

@@ -0,0 +1,5 @@
+require_relative 'angular_material_component'
+
+class MatFormField < MaterialAngularIO::Component
+  select_by tag_name: 'mat-form-field'
+end

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

@@ -0,0 +1,5 @@
+require_relative 'angular_material_component'
+
+class MatIcon < MaterialAngularIO::Component
+  select_by tag_name: 'mat-icon'
+end

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

@@ -0,0 +1,5 @@
+require_relative 'angular_material_component'
+
+class MatInput < MaterialAngularIO::Component
+  select_by tag_name: 'input', class: 'mat-input-element'
+end

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

@@ -0,0 +1,3 @@
+class MatOption < MaterialAngularIO::Component
+  select_by tag_name: 'mat-option'
+end

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

@@ -0,0 +1,15 @@
+class MatSelect < MaterialAngularIO::Component
+  select_by tag_name: 'mat-select'
+
+  def options(*args)
+    mat_options(parse_args(args).merge!(css: "[#{ngcontent}='']"))
+  end
+
+  def option(*args)
+    mat_option(parse_args(args).merge!(css: "[#{ngcontent}='']"))
+  end
+
+  def select(*values)
+    values.each { |val| option(text: process_value(val)) }.click
+  end
+end

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

@@ -0,0 +1,13 @@
+class MatSelectContent < MaterialAngularIO::Component
+  select_by class: 'mat-select-content'
+
+  # def select(**values)
+  #   values.each do |v|
+  #     if tmp = options.find { |opt| opt.text =~ /#{v}/i}
+  #       tmp.click
+  #     else
+  #       raise ArgumentError, ""
+  #     end
+  #   end
+  # end
+end

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

@@ -0,0 +1,3 @@
+# For testing behavior when no selector is defined.
+class NoSelector < MaterialAngularIO::Component
+end

data/lib/insite/examples/material_angular_io/pages.rb

@@ -0,0 +1,20 @@
+require_relative 'site'
+
+# Auto-generates some of material.angular.io pages
+%w(autocomplete checkbox datepicker form-field input radio
+  select slider slide-toggle menu sidenav toolbar card divider
+  expansion grid-list list stepper tabs tree button button-toggle
+  badge chips icon progress-spinner progress-bar bottom-sheet
+  dialog snackbar tooltip paginator sort table
+).each do |component|
+  %w(overview api examples).each do |category|
+    klass = Class.new(MaterialAngularIO::Page) do
+      set_url "/components/#{component}/#{category}"
+    end
+
+    Object.const_set(
+      "#{component.gsub('-', '_')}_#{category}_page".camelcase,
+      klass
+    )
+  end
+end

data/lib/insite/examples/material_angular_io/site.rb

@@ -0,0 +1,5 @@
+class MaterialAngularIO
+  include Insite
+
+  set_custom_tags "app-component-nav", "app-component-sidenav"
+end

data/lib/insite/examples/material_angular_io/utils.rb

@@ -0,0 +1,6 @@
+def new_angular_material_session
+  s = MaterialAngularIO.new 'https://material.angular.io'
+  s.open
+  s.chips_overview_page
+  s
+end

data/lib/insite/examples/material_angular_io/watir_mods.rb

@@ -0,0 +1,54 @@
+# https://github.com/watir/watir/pull/737
+# TODO: Already merged to master, can remove after next release.
+module Watir
+  module Locators
+    class Element
+      class SelectorBuilder
+        class XPath
+          # @todo Get rid of building
+          def lhs_for(_building, key)
+            case key
+            when :text, 'text'
+              'normalize-space()'
+            when String
+              "@#{key}"
+            when :href
+              # TODO: change this behaviour?
+              'normalize-space(@href)'
+            when :type
+              # type attributes can be upper case - downcase them
+              # https://github.com/watir/watir/issues/72
+              XpathSupport.downcase('@type')
+            else
+              "@#{key.to_s.tr("_", "-")}"
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# https://github.com/watir/watir/blob/0943e7e6a88f58ad6bea0e33a9853e6f5676f31c/lib/watir/element_collection.rb
+# TODO: Already merged to master, can remove after next release.
+module Watir
+  class ElementCollection
+    def to_a
+      hash = {}
+      @to_a ||=
+          elements.map.with_index do |e, idx|
+            element = element_class.new(@query_scope, @selector.merge(element: e, index: idx))
+            if [Watir::HTMLElement, Watir::Input].include? element.class
+              tag_name = element.tag_name.to_sym
+              hash[tag_name] ||= 0
+              hash[tag_name] += 1
+              Watir.element_class_for(tag_name).new(@query_scope, @selector.merge(element: e,
+                                                                                   tag_name: tag_name,
+                                                                                   index: hash[tag_name] - 1))
+            else
+              element
+            end
+          end
+    end
+  end
+end

data/lib/insite/examples/material_angular_io_site.rb

@@ -0,0 +1,54 @@
+# Require support files.
+%w(watir_mods site pages utils).each do |f|
+  require "insite/examples/material_angular_io/#{f}"
+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|
+  require "insite/examples/material_angular_io/components/#{c}"
+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
+# the /chips/overview page, adding some additional stuff that is used
+# in some of the automated tests.
+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
+
+  elements :mat_examples_collection, tag_name: 'example-viewer'
+  elements :modified_mat_examples_collection, tag_name: 'example-viewer' do
+    def test_method
+      'output'
+    end
+  end
+
+  elements :examples_collection, tag_name: 'example-viewer'
+  elements :modified_examples_collection, tag_name: 'example-viewer' do
+    def test_method
+      'output'
+    end
+  end
+
+  mat_chip :chip, tag_name: 'mat-chip'
+  element :modified_chip, tag_name: 'mat-chip' do
+    def test_method
+      text
+    end
+  end
+
+  element :chip_element, tag_name: 'mat-chip'
+  element :modified_chip_element, tag_name: 'mat-chip' do
+    def test_method
+      text
+    end
+  end
+
+  mat_chip_list :basic_chips, index: 0
+  mat_chip_list :chips_with_input, index: 1
+  mat_chip_list :chips_autocomplete, index: 2
+end

data/lib/insite/insite.rb

@@ -10,19 +10,44 @@ module Insite
   attr_reader :base_url, :unique_methods, :browser_type
   attr_accessor :pages, :browser, :arguments, :most_recent_page
 
+  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))
+    else
+      Watir.tag_to_class.key(klass) ||
+      Watir.tag_to_class.key(CLASS_MAP.key(klass))
+    end
+  end
+
+  def self.tag_to_class(tag)
+    CLASS_MAP[Watir.tag_to_class[tag]] || Insite::HTMLElement
+  end
+
   # Automatically sets up a Page class when Insite is included. Probably overkill
   # but it protects against the case where two different sites are used at the
   # same time: Each site will use its own page objects only.
   def self.included(base)
     mod = Module.new
-    base.const_set('WidgetMethods', mod)
+    base.const_set('ComponentMethods', mod)
 
     klass = Class.new(DefinedPage)
     base.const_set('Page', klass)
-    base::send(:extend, WidgetMethods)
+    base::send(:extend, ComponentMethods)
 
     klass = Class.new(UndefinedPage)
     base.const_set('UndefinedPage', klass)
+
+    class << base
+      attr_reader :custom_tags
+      @custom_tags = []
+    end
+
+    base.define_singleton_method(:set_custom_tags) do |*tags|
+      @custom_tags ||= []
+      tags.sort.each { |t| @custom_tags << t.to_s.downcase.dasherize }
+    end
   end
 
   # Returns true if there's an open browser (that's also responding.) False if not.
@@ -36,7 +61,7 @@ module Insite
 
   # Closes the site object's browser/driver.
   def close
-    @browser.close
+    @browser.close if browser?
   end
 
   def describe
@@ -74,6 +99,23 @@ 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 }
+
+      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:
@@ -94,12 +136,25 @@ EOF
   #  site.bar
   #  => 1
   # TODO: Sort args.
-  def initialize(base_url, **hsh)
+  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? }
 
+    # Build generic components for custom tags, which are defined
+    # using Site.custom_tags.
+    if self.class.custom_tags
+      self.class.custom_tags.each do |tag|
+        # TODO: Ditch string interpolation.
+        self.class.class_eval %Q{
+          class #{tag.underscore.camelize} < Component
+            select_by tag_name: "#{tag}"
+          end
+        }
+      end
+    end
+
     # Set up accessor methods for each page and page checking methods..
     @pages.each do |current_page|
       unless current_page.page_template?
@@ -144,6 +199,23 @@ EOF
     "@most_recent_page=#{@most_recent_page}>"
   end
 
+  def find_non_standard_tags
+    @browser.elements(xpath: non_standard_tag_xpath).map do |e|
+      e.html.match(/<(\S+?(?=[\s,>]))/)[1]
+    end.uniq.sort
+  end
+
+  def html_tags
+    %i(html title head body) + Insite::METHOD_MAP.values.flatten.each do |mth|
+      elem = @browser.send(mth)
+      elem.respond_to?(:selector) ? elem.selector.values.first.to_s : nil
+    end.sort
+  end
+
+  def non_standard_tag_xpath
+    "//*[#{html_tags.map { |sym| "not(local-name(.) = '#{sym}')" }.join(" and ") }]"
+  end
+
   # In cases where Insite doesn't recognize a method call it will try to do the following:
   # - Delegate the method call to the most recently accessed page, which is stored in
   #   Insite#most_recent_page.
@@ -153,19 +225,23 @@ EOF
   #
   # If delegation doesn't work then a NoMethodError will be raised with some details about
   # what was attempted.
-  def method_missing(sym, *args, &block)
+  def method_missing(mth, *args, &block)
     original_page = @most_recent_page
-    if original_page.respond_to?(sym)
-      original_page.public_send(sym, *args, &block)
+    if original_page.respond_to?(mth)
+      original_page.public_send(mth, *args, &block)
     else
       new_page = page
-      if new_page.respond_to?(sym)
-        page.public_send(sym, *args, &block)
+      if new_page.respond_to?(mth)
+        page.public_send(mth, *args, &block)
+      elsif !new_page.defined?
+        raise NoMethodError, "Could not apply #{mth}. The current page could not be " \
+        "recognized. Current URL #{@browser.url}"
       else
+        # TODO: Make it clearer where the method got called.
         raise(
           NoMethodError,
-          "Unable to apply #{sym}. The site object doesn't support it and the" \
-          "currently displayed page doesn't support it either.\n" \
+          "Unable to apply method call :#{mth}. The site object doesn't support it. " \
+          "The currently displayed page (#{new_page}) doesn't support it either.\n" \
           "Page:\t\t#{new_page.class}\n" \
           "Current URL:\t#{@browser.url}\n\n",
           caller
@@ -276,6 +352,15 @@ EOF
     end
   end
 
+  def respond_to_missing?(mth, include_priv = false)
+    # TODO: Page context changes.
+    @most_recent_page.respond_to?(mth, include_priv) || super
+  end
+
+  def target
+    @browser
+  end
+
   def text
     @browser.text
   end