page_magic 2.0.0.alpha1 → 2.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_magic
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha1
+  version: 2.0.0
 platform: ruby
 authors:
 - Leon Davis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-debug-ide
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +161,11 @@ files:
 - lib/active_support/core_ext/object/to_query.rb
 - lib/page_magic.rb
 - lib/page_magic/class_methods.rb
+- lib/page_magic/comparator.rb
+- lib/page_magic/comparator/fuzzy.rb
+- lib/page_magic/comparator/literal.rb
+- lib/page_magic/comparator/null.rb
+- lib/page_magic/comparator/parameter_map.rb
 - lib/page_magic/driver.rb
 - lib/page_magic/drivers.rb
 - lib/page_magic/drivers/poltergeist.rb
@@ -154,54 +173,68 @@ files:
 - lib/page_magic/drivers/selenium.rb
 - lib/page_magic/element.rb
 - lib/page_magic/element/locators.rb
+- lib/page_magic/element/not_found.rb
 - lib/page_magic/element/query.rb
-- lib/page_magic/element/query_builder.rb
+- lib/page_magic/element/query/multiple_results.rb
+- lib/page_magic/element/query/prefetched_result.rb
+- lib/page_magic/element/query/single_result.rb
 - lib/page_magic/element/selector.rb
-- lib/page_magic/element/selector_methods.rb
+- lib/page_magic/element/selector/methods.rb
+- lib/page_magic/element/selector/model.rb
 - lib/page_magic/element_context.rb
 - lib/page_magic/element_definition_builder.rb
 - lib/page_magic/elements.rb
+- lib/page_magic/elements/config.rb
+- lib/page_magic/elements/inheritance_hooks.rb
+- lib/page_magic/elements/types.rb
 - lib/page_magic/exceptions.rb
 - lib/page_magic/instance_methods.rb
-- lib/page_magic/matcher.rb
+- lib/page_magic/mapping.rb
 - lib/page_magic/session.rb
 - lib/page_magic/session_methods.rb
+- lib/page_magic/transitions.rb
 - lib/page_magic/utils/string.rb
+- lib/page_magic/utils/url.rb
 - lib/page_magic/wait_methods.rb
 - lib/page_magic/watcher.rb
 - lib/page_magic/watchers.rb
 - page_magic.gemspec
-- spec/element_spec.rb
 - spec/lib/active_support/core_ext/object/to_query_test.rb
 - spec/page_magic/class_methods_spec.rb
+- spec/page_magic/comparator/fuzzy_spec.rb
+- spec/page_magic/comparator/literal_spec.rb
+- spec/page_magic/comparator/null_spec.rb
+- spec/page_magic/comparator/parameter_map_spec.rb
 - spec/page_magic/driver_spec.rb
 - spec/page_magic/drivers/poltergeist_spec.rb
 - spec/page_magic/drivers/rack_test_spec.rb
 - spec/page_magic/drivers/selenium_spec.rb
 - spec/page_magic/drivers_spec.rb
 - spec/page_magic/element/locators_spec.rb
-- spec/page_magic/element/query_builder_spec.rb
+- spec/page_magic/element/not_found_spec.rb
+- spec/page_magic/element/query/multiple_results_spec.rb
+- spec/page_magic/element/query/single_result_spec.rb
 - spec/page_magic/element/query_spec.rb
 - spec/page_magic/element/selector_spec.rb
 - spec/page_magic/element_context_spec.rb
 - spec/page_magic/element_definition_builder_spec.rb
+- spec/page_magic/element_spec.rb
+- spec/page_magic/elements/config_spec.rb
 - spec/page_magic/elements_spec.rb
 - spec/page_magic/instance_methods_spec.rb
-- spec/page_magic/matcher_spec.rb
+- spec/page_magic/mapping_spec.rb
 - spec/page_magic/session_methods_spec.rb
 - spec/page_magic/session_spec.rb
+- spec/page_magic/transitions_spec.rb
 - spec/page_magic/utils/string_spec.rb
+- spec/page_magic/utils/url_spec.rb
 - spec/page_magic/wait_methods_spec.rb
+- spec/page_magic/watcher_spec.rb
 - spec/page_magic/watchers_spec.rb
 - spec/page_magic_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_contexts.rb
-- spec/support/shared_contexts/files_context.rb
-- spec/support/shared_contexts/nested_elements_html_context.rb
-- spec/support/shared_contexts/rack_application_context.rb
-- spec/support/shared_contexts/webapp_fixture_context.rb
 - spec/support/shared_examples.rb
-- spec/watcher_spec.rb
 homepage: https://github.com/ladtech/page_magic
 licenses:
 - ruby
@@ -217,9 +250,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key:

data/lib/page_magic/element/query_builder.rb

@@ -1,61 +0,0 @@
-# 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

data/lib/page_magic/element/selector_methods.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module PageMagic
-  class Element
-    # module SelectorMethods - adds method for getting and setting an element selector
-    module SelectorMethods
-      # Gets/Sets a selector
-      # @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
-  end
-end

data/lib/page_magic/matcher.rb

@@ -1,130 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/object/to_query'
-module PageMagic
-  # models mapping used to relate pages to uris
-  class Matcher
-    attr_reader :path, :parameters, :fragment
-
-    # @param [Object] path String or Regular expression to match with
-    # @param [Hash] parameters mapping of parameter name to literal or regex to match with
-    # @param [Object] fragment String or Regular expression to match with
-    # @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
-    end
-
-    # @return [Boolean] true if no component contains a Regexp
-    def can_compute_uri?
-      !fuzzy?(fragment) && !fuzzy?(path) && !fuzzy?(parameters)
-    end
-
-    # @return [String] uri represented by this mapping
-    def compute_uri
-      path.to_s.dup.tap do |uri|
-        uri << "?#{parameters.to_query}" if parameters
-        uri << "##{fragment}" if fragment
-      end
-    end
-
-    # @return [Fixnum] hash for instance
-    def hash
-      [path, parameters, fragment].hash
-    end
-
-    # @param [String] uri
-    # @return [Boolean] returns true if the uri is matched against this matcher
-    def match?(uri)
-      uri = URI(uri)
-      path_valid?(uri.path) && query_string_valid?(uri.query) && fragment_valid?(uri.fragment)
-    end
-
-    # compare this matcher against another
-    # @param [Matcher] other
-    # @return [Fixnum] -1 = smaller, 0 = equal to, 1 = greater than
-    def <=>(other)
-      results = %i[path parameters fragment].collect do |component|
-        compare(send(component), other.send(component))
-      end
-      results.find { |result| !result.zero? } || 0
-    end
-
-    # check equality
-    # @param [Matcher] other
-    # @return [Boolean]
-    def ==(other)
-      return false unless other.is_a?(Matcher)
-
-      path == other.path && parameters == other.parameters && fragment == other.fragment
-    end
-
-    alias eql? ==
-
-    private
-
-    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
-        string == comparitor
-      end
-    end
-
-    def fragment_valid?(string)
-      compatible?(string, fragment)
-    end
-
-    def fuzzy?(component)
-      return false unless component
-
-      if component.is_a?(Hash)
-        component.values.any? { |o| fuzzy?(o) }
-      else
-        component.is_a?(Regexp)
-      end
-    end
-
-    def fuzzy_comparison(this, other)
-      if fuzzy?(this)
-        fuzzy?(other) ? 0 : 1
-      else
-        fuzzy?(other) ? -1 : 0
-      end
-    end
-
-    def parameters_hash(string)
-      CGI.parse(string.to_s.downcase).collect { |key, value| [key.downcase, value.first] }.to_h
-    end
-
-    def path_valid?(string)
-      compatible?(string, path)
-    end
-
-    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
-    end
-  end
-end

data/spec/element_spec.rb

@@ -1,251 +0,0 @@
-# frozen_string_literal: true
-
-# rubocop:disable Metrics/ModuleLength
-module PageMagic
-  describe Element do
-    include_context :webapp_fixture
-
-    let(:page_class) do
-      Class.new do
-        include PageMagic
-        url '/elements'
-      end
-    end
-
-    let(:session) { page_class.visit(application: rack_app) }
-
-    let(:page) { session.current_page }
-
-    let(:described_class) do
-      Class.new(Element).tap { |clazz| clazz.parent_element(page) }
-    end
-
-    subject do
-      described_class.new(:page_element)
-    end
-
-    it_behaves_like 'session accessor'
-    it_behaves_like 'element watcher'
-    it_behaves_like 'waiter'
-    it_behaves_like 'element locator'
-
-    describe '.after_events' do
-      subject do
-        Class.new(described_class)
-      end
-
-      context 'hook set' do
-        it 'returns that hook' do
-          hook = proc {}
-          subject.after_events(&hook)
-          expect(subject.after_events).to eq([described_class::DEFAULT_HOOK, hook])
-        end
-      end
-      context 'hook not registered' do
-        it 'returns the default hook' do
-          expect(subject.after_events).to eq([described_class::DEFAULT_HOOK])
-        end
-      end
-    end
-
-    describe '.before_events' do
-      subject do
-        Class.new(described_class)
-      end
-
-      context 'hook set' do
-        it 'returns that hook' do
-          hook = proc {}
-          subject.before_events(&hook)
-          expect(subject.before_events).to eq([described_class::DEFAULT_HOOK, hook])
-        end
-      end
-      context 'hook not registered' do
-        it 'returns the default hook' do
-          expect(subject.before_events).to eq([described_class::DEFAULT_HOOK])
-        end
-      end
-    end
-
-    describe '.inherited' do
-      it 'copies before hooks' do
-        before_hook = proc {}
-        described_class.before_events(&before_hook)
-        sub_class = Class.new(described_class)
-        expect(sub_class.before_events).to include(before_hook)
-      end
-
-      it 'copies after hooks' do
-        after_hook = proc {}
-        described_class.after_events(&after_hook)
-        sub_class = Class.new(described_class)
-        expect(sub_class.after_events).to include(after_hook)
-      end
-
-      it 'lets sub classes defined their own elements' do
-        custom_element = Class.new(described_class) do
-          text_field :form_field, id: 'field_id'
-
-          def self.name
-            'Form'
-          end
-        end
-
-        page_class.class_eval do
-          element custom_element, css: '.form'
-        end
-
-        expect(page.form.form_field).to be_visible
-      end
-    end
-
-    describe '.watch' do
-      let(:described_class) { Class.new(Element) }
-      it 'adds a before hook with the watcher in it' do
-        described_class.watch(:object_id)
-        instance = described_class.new(:element)
-
-        watcher_block = instance.before_events.last
-        instance.instance_exec(&watcher_block)
-        expect(instance.watchers.first.last).to eq(instance.object_id)
-      end
-    end
-
-    describe 'EVENT_TYPES' do
-      context 'methods created' do
-        it 'creates methods for each of the event types' do
-          missing = described_class::EVENT_TYPES.find_all { |event| !subject.respond_to?(event) }
-          expect(missing).to be_empty
-        end
-
-        context 'method called' do
-          let(:browser_element) { instance_double(Capybara::Node::Element) }
-          subject do
-            described_class.new(browser_element)
-          end
-          it 'calls the browser_element passing on all args' do
-            expect(browser_element).to receive(:select).with(:args)
-            subject.select :args
-          end
-        end
-
-        context 'Capybara element does not respond to the method' do
-          it 'raises an error' do
-            expected_message = (described_class::EVENT_NOT_SUPPORTED_MSG % 'click')
-            expect { subject.click }.to raise_error(NotSupportedException, expected_message)
-          end
-        end
-      end
-    end
-
-    describe 'hooks' do
-      subject do
-        Class.new(described_class) do
-          before_events do
-            call_in_before_events
-          end
-        end.new(double('button', click: true))
-      end
-      context 'method called in before_events' do
-        it 'calls methods on the page element' do
-          expect(subject).to receive(:call_in_before_events)
-          subject.click
-        end
-      end
-
-      context 'method called in after_events' do
-        subject do
-          Class.new(described_class) do
-            after_events do
-              call_in_after_events
-            end
-          end.new(double('button', click: true))
-        end
-
-        it 'calls methods on the page element' do
-          expect(subject).to receive(:call_in_after_events)
-          subject.click
-        end
-      end
-    end
-
-    describe '#initialize' do
-      it 'sets the parent element' do
-        instance = described_class.new(:element)
-        expect(instance.parent_element).to eq(page)
-      end
-
-      context 'inherited items' do
-        let(:described_class) do
-          Class.new(Element)
-        end
-
-        it 'copies the event hooks from the class' do
-          before_hook = proc {}
-          after_hook = proc {}
-          described_class.before_events(&before_hook)
-          described_class.after_events(&after_hook)
-
-          instance = described_class.new(:element)
-
-          expect(instance.before_events).to include(before_hook)
-          expect(instance.after_events).to include(after_hook)
-        end
-      end
-    end
-
-    describe '#method_missing' do
-      before do
-        page_class.class_eval do
-          element :form_by_css, css: '.form' do
-            def parent_method
-              :parent_method_called
-            end
-            link(:link_in_form, text: 'link in a form')
-          end
-        end
-      end
-
-      it 'can delegate to capybara' do
-        expect(page.form_by_css).to be_visible
-      end
-
-      context 'no element definition and not a capybara method' do
-        it 'calls method on parent element' do
-          expect(page.form_by_css.link_in_form.parent_method).to eq(:parent_method_called)
-        end
-
-        context 'method not found on parent' do
-          it 'throws and exception' do
-            expect { page.form_by_css.link_in_a_form.bobbins }.to raise_exception ElementMissingException
-          end
-        end
-      end
-    end
-
-    describe '#respond_to?' do
-      subject do
-        Class.new(described_class) do
-          element :sub_element, css: '.sub-element'
-        end.new(double(element_method: ''))
-      end
-      it 'checks for methods on self' do
-        expect(subject.respond_to?(:session)).to eq(true)
-      end
-
-      it 'checks against registered elements' do
-        expect(subject.respond_to?(:sub_element)).to eq(true)
-      end
-
-      it 'checks for the method of the browser_element' do
-        expect(subject.respond_to?(:element_method)).to eq(true)
-      end
-    end
-
-    describe '#session' do
-      it 'should have a handle to the session' do
-        expect(subject.session).to eq(page.session)
-      end
-    end
-  end
-end