page_magic 1.2.9 → 2.0.0.alpha1

data/lib/page_magic/class_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   # module ClassMethods - contains class level methods for PageObjects
   module ClassMethods
@@ -15,6 +17,7 @@ module PageMagic
     # if one has not been set on the page object class it will return a default block that does nothing
     def on_load(&block)
       return @on_load || DEFAULT_ON_LOAD unless block
+
       @on_load = block
     end
 
@@ -34,7 +37,7 @@ module PageMagic
       session_options = { browser: browser, options: options, url: url }
       session_options[:application] = application if application
 
-      PageMagic.session(session_options).tap do |session|
+      PageMagic.session(**session_options).tap do |session|
         session.visit(self, url: url)
       end
     end

data/lib/page_magic/driver.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module PageMagic
   # class Driver - instances are factories for drivers used by PageMagic
   class Driver
     attr_reader :supported_browsers, :handler
+
     # Creates a driver definition
     # @example
     #  Driver.new do |rack_application, options|

data/lib/page_magic/drivers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'page_magic/driver'
 require 'page_magic/utils/string'
 module PageMagic
@@ -17,7 +19,7 @@ module PageMagic
     # Loads drivers defined in files at the given path
     # @param [String] path where the drivers are located
     def load(path = "#{__dir__}/drivers")
-      Dir["#{path}/*.rb"].each do |driver_file|
+      Dir["#{path}/*.rb"].sort.each do |driver_file|
         require driver_file
         driver_name = File.basename(driver_file)[/(.*)\.rb$/, 1]
         register self.class.const_get(Utils::String.classify(driver_name))

data/lib/page_magic/drivers/poltergeist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 PageMagic::Drivers::Poltergeist = PageMagic::Driver.new(:poltergeist) do |app, options|
   require 'capybara/poltergeist'
   Capybara::Poltergeist::Driver.new(app, options)

data/lib/page_magic/drivers/rack_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 PageMagic::Drivers::RackTest = PageMagic::Driver.new(:rack_test) do |app, options|
-  Capybara::RackTest::Driver.new(app, options)
+  Capybara::RackTest::Driver.new(app, **options)
 end

data/lib/page_magic/drivers/selenium.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 PageMagic::Drivers::Selenium = PageMagic::Driver.new(:chrome, :firefox) do |app, options, browser|
-  require 'watir-webdriver'
-  Capybara::Selenium::Driver.new(app, options.dup.merge(browser: browser))
+  require 'watir'
+  Capybara::Selenium::Driver.new(app, **options.dup.merge(browser: browser))
 end

data/lib/page_magic/element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'page_magic/element/selector_methods'
 require 'page_magic/element/locators'
@@ -8,7 +10,7 @@ module PageMagic
   class Element
     EVENT_TYPES = %i[set select select_option unselect_option click].freeze
     DEFAULT_HOOK = proc {}.freeze
-    EVENT_NOT_SUPPORTED_MSG = '%s event not supported'.freeze
+    EVENT_NOT_SUPPORTED_MSG = '%s event not supported'
 
     include Locators
     include WaitMethods
@@ -44,6 +46,7 @@ module PageMagic
       # @return [Element]
       def parent_element(page_element = nil)
         return @parent_page_element unless page_element
+
         @parent_page_element = page_element
       end
 
@@ -84,9 +87,7 @@ module PageMagic
     # @raise [NotSupportedException] if the wrapped Capybara element does not support the method
     EVENT_TYPES.each do |method|
       define_method method do |*args|
-        unless browser_element.respond_to?(method)
-          raise NotSupportedException, EVENT_NOT_SUPPORTED_MSG % method
-        end
+        raise NotSupportedException, EVENT_NOT_SUPPORTED_MSG % method unless browser_element.respond_to?(method)
 
         browser_element.send(method, *args)
       end
@@ -97,7 +98,8 @@ module PageMagic
     rescue ElementMissingException
       begin
         return browser_element.send(method, *args, &block) if browser_element.respond_to?(method)
-        return parent_element.send(method, *args, &block)
+
+        parent_element.send(method, *args, &block)
       rescue NoMethodError
         super
       end
@@ -137,6 +139,7 @@ module PageMagic
     def wrap_events(raw_element)
       EVENT_TYPES.each do |action_method|
         next unless raw_element.respond_to?(action_method)
+
         apply_hooks(raw_element: raw_element,
                     capybara_method: action_method,
                     before_events: before_events,

data/lib/page_magic/element/locators.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module PageMagic
   # for the benefit of pull review :@
   class Element
     # contains method for finding element definitions
     module Locators
       # message used when raising {ElementMissingException} from methods within this module
-      ELEMENT_NOT_DEFINED_MSG = 'Element not defined: %s'.freeze
+      ELEMENT_NOT_DEFINED_MSG = 'Element not defined: %s'
 
       # find an element definition based on its name
       # @param [Symbol] name name of the element
@@ -13,6 +15,7 @@ module PageMagic
       def element_by_name(name, *args)
         defintion = element_definitions[name]
         raise ElementMissingException, (ELEMENT_NOT_DEFINED_MSG % name) unless defintion
+
         defintion.call(self, *args)
       end
 

data/lib/page_magic/element/query.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module PageMagic
   class Element
     # class Query - executes query on capybara driver
     class Query
       # Message template for execptions raised as a result of calling method_missing
-      ELEMENT_NOT_FOUND_MSG = 'Unable to find %s'.freeze
+      ELEMENT_NOT_FOUND_MSG = 'Unable to find %s'
 
       attr_reader :args, :multiple_results
 
@@ -20,7 +22,14 @@ module PageMagic
             raise Capybara::ElementNotFound if result.empty?
           end
         else
-          capybara_element.find(*args)
+          # TODO - make sure there is a test around this.
+          if args.last.is_a?(Hash)
+            capybara_element.find(*args[0...-1], **args.last)
+          else
+            capybara_element.find(*args)
+          end
+
+
         end
       rescue Capybara::Ambiguous => e
         raise AmbiguousQueryException, e.message

data/lib/page_magic/element/query_builder.rb

@@ -1,4 +1,5 @@
-require 'capybara/query'
+# frozen_string_literal: true
+
 require 'page_magic/element/query'
 module PageMagic
   class Element
@@ -14,6 +15,7 @@ module PageMagic
         def find(type)
           query = constants.find { |constant| constant.to_s.casecmp(type.to_s).zero? }
           return ELEMENT unless query
+
           const_get(query)
         end
       end
@@ -40,8 +42,19 @@ module PageMagic
       end
 
       ELEMENT = QueryBuilder.new
-      TEXT_FIELD = CHECKBOX = SELECT_LIST = RADIO = TEXTAREA = QueryBuilder.new(:field)
+      TEXT_FIELD =
+      CHECKBOX =
+      SELECT_LIST =
+      RADIO =
+      TEXTAREA =
+      FIELD =
+      FILE_FIELD =
+      FILLABLE_FIELD =
+      RADIO_BUTTON =
+      SELECT = QueryBuilder.new(:field)
+
       LINK = QueryBuilder.new(:link)
+      LABEL = QueryBuilder.new(:label)
       BUTTON = QueryBuilder.new(:button)
     end
   end

data/lib/page_magic/element/selector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   class Element
     # class Selector - models the selection criteria understood by Capybara
@@ -10,6 +12,7 @@ module PageMagic
         def find(name)
           selector = constants.find { |constant| constant.to_s.casecmp(name.to_s).zero? }
           raise UnsupportedCriteriaException unless selector
+
           const_get(selector)
         end
       end

data/lib/page_magic/element/selector_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   class Element
     # module SelectorMethods - adds method for getting and setting an element selector
@@ -6,6 +8,7 @@ module PageMagic
       # @param [Hash] selector method for locating the browser element. E.g. text: 'the text'
       def selector(selector = nil)
         return @selector unless selector
+
         @selector = selector
       end
     end

data/lib/page_magic/element_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   # class ElementContext - resolves which element definition to use when accessing the browser.
   class ElementContext

data/lib/page_magic/element_definition_builder.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module PageMagic
   # Builder for creating ElementDefinitions
   class ElementDefinitionBuilder
-    INVALID_SELECTOR_MSG = 'Pass a locator/define one on the class'.freeze
+    INVALID_SELECTOR_MSG = 'Pass a locator/define one on the class'
     attr_reader :definition_class, :options, :selector, :type, :element, :query_builder
 
     def initialize(definition_class:, selector:, type:, options: {}, element: nil)
@@ -34,6 +36,7 @@ module PageMagic
 
     def ==(other)
       return false unless other.is_a?(ElementDefinitionBuilder)
+
       this = [options, selector, type, element, definition_class]
       this == [other.options, other.selector, other.type, other.element, other.definition_class]
     end

data/lib/page_magic/elements.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/inflector'
 require 'page_magic/element_definition_builder'
 module PageMagic
@@ -12,11 +14,44 @@ module PageMagic
       end
     end
 
-    INVALID_METHOD_NAME_MSG = 'a method already exists with this method name'.freeze
-
-    TYPES = %i[text_field button link checkbox select_list radio textarea].collect do |type|
-      [type, :"#{type}s"]
-    end.flatten.freeze
+    INVALID_METHOD_NAME_MSG = 'a method already exists with this method name'
+
+    # css
+    # datalist_input
+    # datalist_option
+    # field
+    # fieldset
+    # file_field
+    # fillable_field
+    # frame
+    # link_or_button
+    # option
+    # radio_button
+    # select
+    # table
+    # table_row
+    # xpath
+    #
+
+    TYPES = %i[field
+    fieldset
+    file_field
+    fillable_field
+    frame
+    link_or_button
+    option
+    radio_button
+    select
+    table
+    table_row
+    text_field
+    button
+    link
+    checkbox
+    select_list
+    radio
+    textarea
+    label].collect{ |type| [type, :"#{type}s"]}.flatten.freeze
 
     class << self
       def extended(clazz)
@@ -63,7 +98,8 @@ module PageMagic
           parent_element(parent_element)
           class_exec(*e_args, &block)
         end
-        ElementDefinitionBuilder.new(options.merge(definition_class: definition_class))
+
+        ElementDefinitionBuilder.new(**options.merge(definition_class: definition_class))
       end
     end
 

data/lib/page_magic/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   class ElementMissingException < RuntimeError
   end
@@ -20,7 +22,7 @@ module PageMagic
   class TimeoutException < RuntimeError
   end
 
-  class UnspportedBrowserException < RuntimeError
+  class UnsupportedBrowserException < RuntimeError
   end
 
   class UnsupportedCriteriaException < RuntimeError

data/lib/page_magic/instance_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   # module InstanceMethods - provides instance level methods for page objects
   module InstanceMethods

data/lib/page_magic/matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/object/to_query'
 module PageMagic
   # models mapping used to relate pages to uris
@@ -10,6 +12,7 @@ module PageMagic
     # @raise [MatcherInvalidException] if at least one component is not specified
     def initialize(path = nil, parameters: nil, fragment: nil)
       raise MatcherInvalidException unless path || parameters || fragment
+
       @path = path
       @parameters = parameters
       @fragment = fragment
@@ -22,7 +25,7 @@ module PageMagic
 
     # @return [String] uri represented by this mapping
     def compute_uri
-      path.to_s.tap do |uri|
+      path.to_s.dup.tap do |uri|
         uri << "?#{parameters.to_query}" if parameters
         uri << "##{fragment}" if fragment
       end
@@ -55,6 +58,7 @@ module PageMagic
     # @return [Boolean]
     def ==(other)
       return false unless other.is_a?(Matcher)
+
       path == other.path && parameters == other.parameters && fragment == other.fragment
     end
 
@@ -64,11 +68,13 @@ module PageMagic
 
     def compare(this, other)
       return presence_comparison(this, other) unless this && other
+
       fuzzy_comparison(this, other)
     end
 
     def compatible?(string, comparitor)
       return true if comparitor.nil?
+
       if fuzzy?(comparitor)
         string =~ comparitor ? true : false
       else
@@ -82,6 +88,7 @@ module PageMagic
 
     def fuzzy?(component)
       return false unless component
+
       if component.is_a?(Hash)
         component.values.any? { |o| fuzzy?(o) }
       else
@@ -108,11 +115,13 @@ module PageMagic
     def presence_comparison(this, other)
       return 0 if this.nil? && other.nil?
       return 1 if this.nil? && other
+
       -1
     end
 
     def query_string_valid?(string)
       return true unless parameters
+
       parameters.none? do |key, value|
         !compatible?(parameters_hash(string)[key.downcase.to_s], value)
       end

data/lib/page_magic/session.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'page_magic/matcher'
 module PageMagic
   # class Session - coordinates access to the browser though page objects.
   class Session
-    URL_MISSING_MSG = 'a path must be mapped or a url supplied'.freeze
-    REGEXP_MAPPING_MSG = 'URL could not be derived because mapping contains Regexps'.freeze
-    INVALID_MAPPING_MSG = 'mapping must be a string or regexp'.freeze
-    UNSUPPORTED_OPERATION_MSG = 'execute_script not supported by driver'.freeze
+    URL_MISSING_MSG = 'a path must be mapped or a url supplied'
+    REGEXP_MAPPING_MSG = 'URL could not be derived because mapping contains Regexps'
+    INVALID_MAPPING_MSG = 'mapping must be a string or regexp'
+    UNSUPPORTED_OPERATION_MSG = 'execute_script not supported by driver'
 
     extend Forwardable
 
@@ -18,7 +20,6 @@ module PageMagic
     def initialize(capybara_session, base_url = nil)
       @raw_session = capybara_session
       @base_url = base_url
-      visit(url: base_url) if base_url
       @transitions = {}
     end
 
@@ -94,6 +95,7 @@ module PageMagic
       target_url = url || begin
         if (mapping = transitions.key(page))
           raise InvalidURLException, REGEXP_MAPPING_MSG unless mapping.can_compute_uri?
+
           url(base_url, mapping.compute_uri)
         end
       end