page_magic 1.2.6 → 2.0.0.alpha1

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,9 +1,8 @@
+# frozen_string_literal: true
+
 module PageMagic
   # class ElementContext - resolves which element definition to use when accessing the browser.
   class ElementContext
-    # Message template for execptions raised as a result of calling method_missing
-    ELEMENT_NOT_FOUND_MSG = 'Unable to find %s'.freeze
-
     attr_reader :page_element
 
     def initialize(page_element)
@@ -24,8 +23,7 @@ module PageMagic
       prefecteched_element = builder.element
       return builder.build(prefecteched_element) if prefecteched_element
 
-      elements = find(builder)
-      elements.size == 1 ? elements.first : elements
+      find(builder)
     end
 
     def respond_to?(*args)
@@ -35,15 +33,14 @@ module PageMagic
     private
 
     def find(builder)
-      query_args = builder.build_query
-      result = page_element.browser_element.all(*query_args)
+      query = builder.build_query
+      result = query.execute(page_element.browser_element)
 
-      if result.empty?
-        query = Capybara::Query.new(*query_args)
-        raise ElementMissingException, ELEMENT_NOT_FOUND_MSG % query.description
+      if query.multiple_results?
+        result.collect { |e| builder.build(e) }
+      else
+        builder.build(result)
       end
-
-      result.to_a.collect { |e| builder.build(e) }
     end
   end
 end

data/lib/page_magic/element_definition_builder.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module PageMagic
   # Builder for creating ElementDefinitions
   class ElementDefinitionBuilder
-    INVALID_SELECTOR_MSG = 'Pass a locator/define one on the class'.freeze
-    attr_reader :definition_class, :options, :selector, :type, :element
+    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)
       unless element
@@ -13,13 +15,16 @@ module PageMagic
       @definition_class = definition_class
       @selector = selector
       @type = type
-      @options = options
+      @query_builder = Element::QueryBuilder.find(type)
+
+      @options = { multiple_results: false }.merge(options)
       @element = element
     end
 
     # @return [Capybara::Query] query to find this element in the browser
     def build_query
-      Element::Query.find(type).build(selector, options)
+      multiple_results = options.delete(:multiple_results)
+      query_builder.build(selector, options, multiple_results: multiple_results)
     end
 
     # Create new instance of the ElementDefinition modeled by this builder
@@ -31,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,9 +14,44 @@ module PageMagic
       end
     end
 
-    INVALID_METHOD_NAME_MSG = 'a method already exists with this method name'.freeze
-
-    TYPES = [:text_field, :button, :link, :checkbox, :select_list, :radios, :textarea].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)
@@ -52,8 +89,8 @@ module PageMagic
     #  @param [Hash] selector a key value pair defining the method for locating this element. See above for details
     def element(*args, &block)
       block ||= proc {}
-      options = compute_options(args.dup)
-      options[:type] = __callee__
+      options = compute_options(args.dup, __callee__)
+
       section_class = options.delete(:section_class)
 
       add_element_definition(options.delete(:name)) do |parent_element, *e_args|
@@ -61,10 +98,12 @@ 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
 
+    alias elements element
     TYPES.each { |type| alias_method type, :element }
 
     # @return [Hash] element definition names mapped to blocks that can be used to create unique instances of
@@ -75,13 +114,17 @@ module PageMagic
 
     private
 
-    def compute_options(args)
+    def compute_options(args, type)
       section_class = remove_argument(args, Class) || Element
+
       { name: compute_name(args, section_class),
+        type: type,
         selector: compute_selector(args, section_class),
         options: compute_argument(args, Hash),
         element: args.delete_at(0),
-        section_class: section_class }
+        section_class: section_class }.tap do |hash|
+        hash[:options][:multiple_results] = type.to_s.end_with?('s')
+      end
     end
 
     def add_element_definition(name, &block)

data/lib/page_magic/exceptions.rb

@@ -1,39 +1,10 @@
+# frozen_string_literal: true
+
 module PageMagic
   class ElementMissingException < RuntimeError
   end
 
-  class InvalidElementNameException < RuntimeError
-  end
-
-  class InvalidMethodNameException < RuntimeError
-  end
-
-  class InvalidURLException < RuntimeError
-  end
-
-  class MatcherInvalidException < RuntimeError
-  end
-
-  class TimeoutException < RuntimeError
-  end
-
-  class UnspportedBrowserException < RuntimeError
-  end
-
-  class UnsupportedCriteriaException < RuntimeError
-  end
-
-  class UnsupportedSelectorException < RuntimeError
-  end
-
-  class UndefinedSelectorException < RuntimeError
-  end
-
-  class NotSupportedException < RuntimeError
-  end
-end
-module PageMagic
-  class ElementMissingException < RuntimeError
+  class AmbiguousQueryException < RuntimeError
   end
 
   class InvalidElementNameException < RuntimeError
@@ -51,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,9 +1,14 @@
+# frozen_string_literal: true
+
 module PageMagic
   # module InstanceMethods - provides instance level methods for page objects
   module InstanceMethods
     attr_reader :browser, :session, :browser_element
 
-    include Watchers, SessionMethods, WaitMethods, Element::Locators
+    include Element::Locators
+    include WaitMethods
+    include SessionMethods
+    include Watchers
 
     # Creates a new instance
     # @param [Session] session session that provides gateway to the browser throw the users chosen browser

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
@@ -44,7 +47,7 @@ module PageMagic
     # @param [Matcher] other
     # @return [Fixnum] -1 = smaller, 0 = equal to, 1 = greater than
     def <=>(other)
-      results = [:path, :parameters, :fragment].collect do |component|
+      results = %i[path parameters fragment].collect do |component|
         compare(send(component), other.send(component))
       end
       results.find { |result| !result.zero? } || 0
@@ -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,12 +115,14 @@ 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.any? do |key, value|
+
+      parameters.none? do |key, value|
         !compatible?(parameters_hash(string)[key.downcase.to_s], value)
       end
     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

data/lib/page_magic/session_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 module PageMagic
   # module SessionMethods - contains methods for interacting with the {Session}

data/lib/page_magic/utils/string.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PageMagic
+  module Utils
+    # module String - contains methods for manipulating strings
+    module String
+      class << self
+        def classify(string_or_symbol)
+          string_or_symbol.to_s.split('_').collect(&:capitalize).reduce(:+)
+        end
+      end
+    end
+  end
+end

data/lib/page_magic/wait_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   # module WaitMethods - contains methods for waiting
   module WaitMethods
@@ -10,6 +12,7 @@ module PageMagic
       start_time = Time.now
       until Time.now > start_time + timeout_after
         return true if yield == true
+
         sleep retry_every
       end
       raise TimeoutException, 'Action took to long'

data/lib/page_magic/watcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   # class WatchedElementDefinition - Contains the specification the for checking if an subject has changed
   class Watcher

data/lib/page_magic/watchers.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'page_magic/watcher'
 
 module PageMagic
   # module Watchers - contains methods for adding watchers and checking them
   module Watchers
-    ELEMENT_MISSING_MSG = 'Unable to defined watcher: Element or method with the name %s can not be found'.freeze
+    ELEMENT_MISSING_MSG = 'Unable to defined watcher: Element or method with the name %s can not be found'
 
     # @param [Symbol] name - the name of the watcher
     # @return [Boolean] true if a change is detected
@@ -24,6 +26,7 @@ module PageMagic
     # end
     def watch(name, method = nil, &block)
       raise ElementMissingException, (ELEMENT_MISSING_MSG % name) unless block || respond_to?(name)
+
       watched_element = block ? Watcher.new(name, &block) : Watcher.new(name, method)
       watchers.delete_if { |w| w.name == name }
       watchers << watched_element.check(self)