page_magic 1.2.6 → 2.0.0.alpha1

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Bundler.require :test, :development
 
 RuboCop::RakeTask.new
@@ -12,11 +14,19 @@ Jeweler::Tasks.new do |gem|
   gem.license = 'ruby'
   gem.summary = 'Framework for modeling and interacting with webpages'
   gem.description = 'Framework for modeling and interacting with webpages which wraps capybara'
-  gem.email = 'info@lad-tech.com'
+  gem.email = 'info@lvl-up.uk'
   gem.authors = ['Leon Davis']
   gem.required_ruby_version = '>= 2.1'
 end
 
 Jeweler::RubygemsDotOrgTasks.new
 
-task default: [:spec, 'rubocop:auto_correct']
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_test.rb'
+  t.warning = true
+  t.verbose = true
+end
+
+task default: [:spec, :test, 'rubocop:auto_correct']

data/VERSION

@@ -1 +1 @@
-1.2.6
+2.0.0.alpha1

data/circle.yml

@@ -1,6 +1,8 @@
 machine:
   ruby:
-    version: '2.1'
+    version: '2.2'
 test:
   override:
-    - bundle exec rake
+    - bundle exec rake
+  post:
+    - CODECLIMATE_REPO_TOKEN=$CODECLIMATE_REPO_TOKEN bundle exec codeclimate-test-reporter

data/lib/active_support/core_ext/object/to_query.rb

@@ -0,0 +1,84 @@
+require 'cgi'
+
+class Object
+  # Alias of <tt>to_s</tt>.
+  def to_param
+    to_s
+  end
+
+  # Converts an object into a string suitable for use as a URL query string,
+  # using the given <tt>key</tt> as the param name.
+  def to_query(key)
+    "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+  end
+end
+
+class NilClass
+  # Returns +self+.
+  def to_param
+    self
+  end
+end
+
+class TrueClass
+  # Returns +self+.
+  def to_param
+    self
+  end
+end
+
+class FalseClass
+  # Returns +self+.
+  def to_param
+    self
+  end
+end
+
+class Array
+  # Calls <tt>to_param</tt> on all its elements and joins the result with
+  # slashes. This is used by <tt>url_for</tt> in Action Pack.
+  def to_param
+    collect(&:to_param).join '/'
+  end
+
+  # Converts an array into a string suitable for use as a URL query string,
+  # using the given +key+ as the param name.
+  #
+  #   ['Rails', 'coding'].to_query('hobbies') # => "hobbies%5B%5D=Rails&hobbies%5B%5D=coding"
+  def to_query(key)
+    prefix = "#{key}[]"
+
+    if empty?
+      nil.to_query(prefix)
+    else
+      collect { |value| value.to_query(prefix) }.join '&'
+    end
+  end
+end
+
+class Hash
+  # Returns a string representation of the receiver suitable for use as a URL
+  # query string:
+  #
+  #   {name: 'David', nationality: 'Danish'}.to_query
+  #   # => "name=David&nationality=Danish"
+  #
+  # An optional namespace can be passed to enclose key names:
+  #
+  #   {name: 'David', nationality: 'Danish'}.to_query('user')
+  #   # => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"
+  #
+  # The string pairs "key=value" that conform the query string
+  # are sorted lexicographically in ascending order.
+  #
+  # This method is also aliased as +to_param+.
+  def to_query(namespace = nil)
+    collect do |key, value|
+      unless (value.is_a?(Hash) || value.is_a?(Array)) && value.empty?
+        value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+      end
+    end.compact.sort! * '&'
+  end
+
+  alias to_param to_query
+end

data/lib/page_magic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.dirname(__FILE__).to_s)
 require 'capybara'
 require 'page_magic/exceptions'
@@ -31,7 +33,8 @@ module PageMagic
     def included(clazz)
       clazz.class_eval do
         include(InstanceMethods)
-        extend(Elements, ClassMethods)
+        extend ClassMethods
+        extend Elements
       end
     end
 
@@ -48,10 +51,10 @@ module PageMagic
     # @param [Symbol] browser name of browser
     # @param [String] url url to start the session on
     # @param [Hash] options browser driver specific options
-    # @return [Session] configured sessoin
-    def session(application: nil, browser: :rack_test, url:, options: {})
+    # @return [Session] configured session
+    def session(url: nil, application: nil, browser: :rack_test, options: {})
       driver = drivers.find(browser)
-      raise UnspportedBrowserException unless driver
+      raise UnsupportedBrowserException unless driver
 
       Capybara.register_driver browser do |app|
         driver.build(app, browser: browser, options: options)

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,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'page_magic/driver'
+require 'page_magic/utils/string'
 module PageMagic
   # class Drivers - creates an object that can be used to hold driver definitions
   # These PageMagic gets the user's chosen driver from this object.
@@ -16,12 +19,10 @@ module PageMagic
     # Loads drivers defined in files at the given path
     # @param [String] path where the drivers are located
     def load(path = "#{__dir__}/drivers")
-      require 'active_support/inflector'
-
-      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(driver_name.classify)
+        register self.class.const_get(Utils::String.classify(driver_name))
       end
     end
 
@@ -35,7 +36,7 @@ module PageMagic
     # @param [Object] other subject of equality check
     # @return [Boolean] true if the object is a match
     def ==(other)
-      other.is_a?(Drivers) && all == other.all
+      other.respond_to?(:all) && all == other.all
     end
   end
 end

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,17 +1,25 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'page_magic/element/selector_methods'
 require 'page_magic/element/locators'
 require 'page_magic/element/selector'
-require 'page_magic/element/query'
+require 'page_magic/element/query_builder'
 module PageMagic
   # class Element - represents an element in a html page.
   class Element
-    EVENT_TYPES = [:set, :select, :select_option, :unselect_option, :click].freeze
+    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 SelectorMethods, Watchers, SessionMethods, WaitMethods, Locators
-    extend Elements, SelectorMethods, Forwardable
+    include Locators
+    include WaitMethods
+    include SessionMethods
+    include Watchers
+    include SelectorMethods
+    extend Forwardable
+    extend SelectorMethods
+    extend Elements
 
     attr_reader :type, :name, :parent_element, :browser_element, :before_events, :after_events
 
@@ -24,7 +32,7 @@ module PageMagic
       # @!method before_events
       # If a block is passed in, it adds it to be run before an event is triggered on an element.
       # @see .after_events
-      %i(after_events before_events).each do |method|
+      %i[after_events before_events].each do |method|
         define_method method do |&block|
           instance_variable_name = "@#{method}".to_sym
           instance_variable_value = instance_variable_get(instance_variable_name) || [DEFAULT_HOOK]
@@ -38,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
 
@@ -78,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
@@ -91,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
@@ -131,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,45 +1,45 @@
-require 'capybara/query'
+# frozen_string_literal: true
+
 module PageMagic
   class Element
-    # class Query - models overall queries for Capybara, queries can include:
-    #  - requirements on element type
-    #  - selection criteria, modeled through the Selector class
-    #  - options
+    # class Query - executes query on capybara driver
     class Query
-      class << self
-        # Find a query using it's name
-        # @param [Symbol] type the name of the required query in snakecase format
-        # @return [Query] returns the predefined query with the given name
-        def find(type)
-          query = constants.find { |constant| constant.to_s.casecmp(type.to_s).zero? }
-          return ELEMENT unless query
-          const_get(query)
-        end
-      end
+      # Message template for execptions raised as a result of calling method_missing
+      ELEMENT_NOT_FOUND_MSG = 'Unable to find %s'
+
+      attr_reader :args, :multiple_results
 
-      attr_reader :type
+      alias multiple_results? multiple_results
 
-      # @param type -
-      def initialize(type = nil)
-        @type = type
+      def initialize(args, multiple_results: false)
+        @args = args
+        @multiple_results = multiple_results
       end
 
-      # Build query parameters for Capybara's find method
-      # @param [Hash] locator the location method e.g. text: 'button text'
-      # @param [Hash] options additional options to be provided to Capybara. e.g. count: 3
-      # @return [Array] list of compatible capybara query parameters.
-      def build(locator, options = {})
-        [].tap do |array|
-          selector = Selector.find(locator.keys.first)
-          array << selector.build(type, locator.values.first)
-          array << options unless options.empty?
-        end.flatten
+      def execute(capybara_element)
+        if multiple_results
+          capybara_element.all(*args).to_a.tap do |result|
+            raise Capybara::ElementNotFound if result.empty?
+          end
+        else
+          # 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
+      rescue Capybara::ElementNotFound => e
+        raise ElementMissingException, e.message
       end
 
-      ELEMENT = Query.new
-      TEXT_FIELD = CHECKBOX = SELECT_LIST = RADIOS = TEXTAREA = Query.new(:field)
-      LINK = Query.new(:link)
-      BUTTON = Query.new(:button)
+      def ==(other)
+        other.respond_to?(:args) && args == other.args
+      end
     end
   end
 end

data/lib/page_magic/element/query_builder.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'page_magic/element/query'
+module PageMagic
+  class Element
+    # class QueryBuilder - builds query to be executed on capybara driver, queries can include:
+    #  - requirements on element type
+    #  - selection criteria, modeled through the Selector class
+    #  - options
+    class QueryBuilder
+      class << self
+        # Find a query using it's name
+        # @param [Symbol] type the name of the required query in snakecase format
+        # @return [QueryBuilder] returns the predefined query with the given name
+        def find(type)
+          query = constants.find { |constant| constant.to_s.casecmp(type.to_s).zero? }
+          return ELEMENT unless query
+
+          const_get(query)
+        end
+      end
+
+      attr_reader :type
+
+      # @param type -
+      def initialize(type = nil)
+        @type = type
+      end
+
+      # Build query parameters for Capybara's find method
+      # @param [Hash] locator the location method e.g. text: 'button text'
+      # @param [Hash] capybara_options additional options to be provided to Capybara. e.g. count: 3
+      # @return [Array] list of compatible capybara query parameters.
+      def build(locator, capybara_options = {}, multiple_results: false)
+        args = [].tap do |array|
+          selector = Selector.find(locator.keys.first)
+          array << selector.build(type, locator.values.first)
+          array << capybara_options unless capybara_options.empty?
+        end.flatten
+
+        Query.new(args, multiple_results: multiple_results)
+      end
+
+      ELEMENT = QueryBuilder.new
+      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
+end