page_magic 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f5e27b2a270ba1333f9ae3b00500892ca2db6ea
-  data.tar.gz: adb6f8c204b92c581ae8d05198899f1fe54decb9
+  metadata.gz: 3958a4d16d7ed2f76f9b58dd90e88c0e30a29dfb
+  data.tar.gz: 55f5d9af299438f3630ac2208a3c7e38eb02b735
 SHA512:
-  metadata.gz: 220f194ecca9dc7ddcb6f912d0ea45caf922dc2704011e4fc5d897382d8af1d0a2a9725db585767d23a9913ad0f387e258dc0d9b73545290a25bb181b9e82578
-  data.tar.gz: aeefe035655fc201c01d4539026be9162fea73fe7e173314ce0fe7389529d089507af383299727307598b1e0c406a576a55f160f38f5128df201dde38f2fa167
+  metadata.gz: dca1340ab4d09dd01f8b86614c33dd8e079ddc58d7897ebdb1a1d8dd44b750aa2aea85a7ec49935a8a79cb6f2533a7db3791cee1aa0226a806c513fb48148762
+  data.tar.gz: 415b1f023d0902de1a9933a426de9a5604a43765c09dd1a3af6e01fa29f876930f9c79dc23509441c8bdf1cad0ed0493a78202da56574816faa1e2549c7887a9

data/Gemfile

@@ -11,6 +11,7 @@ group :test do
   gem 'poltergeist'
   gem 'codeclimate-test-reporter', group: :test, require: nil
   gem 'pullreview-coverage', require: false
+  gem 'reek'
   gem 'arbre'
 end
 

data/Gemfile.lock

@@ -11,6 +11,10 @@ GEM
     arbre (1.1.1)
       activesupport (>= 3.0.0)
     ast (2.3.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
     builder (3.2.2)
     capybara (2.7.1)
       addressable
@@ -19,30 +23,36 @@ GEM
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       xpath (~> 2.0)
-    certifi (2016.02.28)
+    certifi (2016.08.02)
     childprocess (0.5.9)
       ffi (~> 1.0, >= 1.0.11)
     cliver (0.3.2)
+    codeclimate-engine-rb (0.3.1)
+      virtus (~> 1.0)
     codeclimate-test-reporter (0.6.0)
       simplecov (>= 0.7.1, < 1.0.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    equalizer (0.0.11)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     ffi (1.9.14)
     git (1.3.0)
     github-markup (1.4.0)
-    github_api (0.14.4)
+    github_api (0.14.5)
       addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
       hashie (>= 3.4)
-      oauth2 (~> 1.0.0)
+      oauth2 (~> 1.0)
     hashie (3.4.4)
     highline (1.7.8)
     i18n (0.7.0)
+    ice_nine (0.11.2)
     jeweler (2.1.1)
       builder
       bundler (>= 1.0)
@@ -66,12 +76,12 @@ GEM
     nokogiri (1.6.8)
       mini_portile2 (~> 2.1.0)
       pkg-config (~> 1.1.7)
-    oauth2 (1.0.0)
+    oauth2 (1.2.0)
       faraday (>= 0.8, < 0.10)
       jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
+      rack (>= 1.2, < 3)
     parser (2.3.1.2)
       ast (~> 2.2)
     pkg-config (1.1.7)
@@ -93,11 +103,15 @@ GEM
     rdoc (4.2.2)
       json (~> 1.4)
     redcarpet (3.3.4)
+    reek (4.2.3)
+      codeclimate-engine-rb (~> 0.3.1)
+      parser (~> 2.3.1, >= 2.3.1.2)
+      rainbow (~> 2.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.1)
+    rspec-core (3.5.2)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -133,7 +147,12 @@ GEM
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     unicode-display_width (1.1.0)
-    watir-webdriver (0.9.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    watir-webdriver (0.9.3)
       selenium-webdriver (>= 2.46.2)
     websocket (1.2.3)
     websocket-driver (0.6.4)
@@ -156,6 +175,7 @@ DEPENDENCIES
   poltergeist
   pullreview-coverage
   redcarpet (~> 3.3)
+  reek
   rspec
   rubocop (~> 0.34)
   simplecov

data/README.md

@@ -26,8 +26,9 @@ we are not aware of so your feedback/pull requests are greatly appreciated!
 - [Quick Start](#quick-start)
 - [Defining Pages](#defining-pages)
   - [Elements](#elements)
+    - [Singlular Results](#singular-results)
+    - [Multiple Results](#multiple-results)
     - [Interacting with elements](#interacting-with-elements)
-      -  [Multple Results](#multiple-results)
     - [Sub elements](#sub-elements)
     - [Custom elements](#custom-elements)
   - [Hooks](#hooks)
@@ -95,7 +96,12 @@ class Github
 end
 ```
 ## Elements
-Defining elements is easy. The following example defines a text field called 'search_field' that can be found using its name which is 'q'
+Defining elements is easy. Just give the:
+- element_type
+- id to refer to it by
+- selector to find it in the page
+
+The following example defines a text field called 'search_field' that can be found using its name which is 'q'
 
 ```ruby
 class Github
@@ -105,27 +111,53 @@ class Github
 end
 ```
 
-### Interacting with elements
-Elements are defined with an id which is the name of the method you will use to reference it. In the above example, 
-the text field was defined with the ide `:search_field`.
+Element types supported by PageMagic are:
+- text_field
+- button
+- link
+- checkbox
+- select_list
+- radio
+- textarea
 
-After visiting a page you are will get a `Session` object. Elements can be accessed through the session itself.
+PageMagic is very powerful and provides a number of different ways to define a page element so for more details please look at the [API](http://www.rubydoc.info/gems/page_magic/PageMagic%2FElements:element)
 
-```ruby
-page.search_field.set 'page_magic'
-```
+### Singular Results
+The element types written above are the method names you need to use in order to define elements of those types on your pages.
 
-#### Multiple Results
-Where an element has been scoped to return multple results, these will be returned in an array. 
+Using them as they are written above will tell PageMagic to expect to find only one element using the selector you supply. Finding more than one result will cause PageMagic to raise an `AmbiguousQueryException` 
+
+### Multiple Results
+Applying an 's' to the end of the element definition method name will tell PageMagic that more than one result can be returned using the given selector.
+
+results are returned in an `Array`.
 ```ruby
 class ResultsPage
   include PageMagic
-  element :results, css: '.repo-list-item'
+  elements :results, css: '.repo-list-item'
 end
 
 page.results #=> Array<Element> 
 ```
 
+
+### Interacting with elements
+```ruby
+class Github
+  include PageMagic
+  
+  text_field :search_field, name: 'q'
+end
+```
+Elements are defined with an id which is the name of the method you will use to reference it. In the above example, 
+the text field was defined with the id `:search_field`.
+
+After visiting a page you are will get a `Session` object. Elements can be accessed through the session itself.
+
+```ruby
+page.search_field.set 'page_magic'
+```
+
 ### Sub Elements
 If your pages are complex you can use PageMagic to compose pages, their elements and subelements to as many levels as 
 you need to.
@@ -251,13 +283,13 @@ end
 In the above example the selector looks for an element that has a link containing text that includes that organisation.
 The example uses a named parameter and is invoked as follows.
 ```ruby
-page.results(organisation: 'Ladtech')
+page.results(organisation: 'lvlup')
 ```
 
 # Starting a session
 To start a PageMagic session simply decide what browser you want to use and pass it to PageMagic's `.session` method
 ```ruby
-session = PageMagic.session(browser: :chrome, url: 'https://www.github.com)
+session = PageMagic.session(browser: :chrome, url: 'https://www.github.com')
 ```
 
 Your session won't do much besides navigating to the given url until you have [mapped pages](#page-mapping) to it, so 

data/VERSION

@@ -1 +1 @@
-1.2.6
+1.2.7

data/lib/page_magic/drivers.rb

@@ -35,7 +35,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/element/query.rb

@@ -1,45 +1,36 @@
-require 'capybara/query'
 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'.freeze
+
+      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
+          capybara_element.find(*args)
+        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,48 @@
+require 'capybara/query'
+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 = QueryBuilder.new(:field)
+      LINK = QueryBuilder.new(:link)
+      BUTTON = QueryBuilder.new(:button)
+    end
+  end
+end

data/lib/page_magic/element.rb

@@ -2,7 +2,7 @@ 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

data/lib/page_magic/element_context.rb

@@ -1,9 +1,6 @@
 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 +21,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 +31,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

@@ -2,7 +2,7 @@ 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
+    attr_reader :definition_class, :options, :selector, :type, :element, :query_builder
 
     def initialize(definition_class:, selector:, type:, options: {}, element: nil)
       unless element
@@ -13,13 +13,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

data/lib/page_magic/elements.rb

@@ -14,7 +14,9 @@ module PageMagic
 
     INVALID_METHOD_NAME_MSG = 'a method already exists with this method name'.freeze
 
-    TYPES = [:text_field, :button, :link, :checkbox, :select_list, :radios, :textarea].freeze
+    TYPES = [:text_field, :button, :link, :checkbox, :select_list, :radio, :textarea].collect do |type|
+      [type, :"#{type}s"]
+    end.flatten.freeze
 
     class << self
       def extended(clazz)
@@ -52,8 +54,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|
@@ -75,13 +77,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

@@ -2,38 +2,7 @@ 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

data/page_magic.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: page_magic 1.2.6 ruby lib
+# stub: page_magic 1.2.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "page_magic"
-  s.version = "1.2.6"
+  s.version = "1.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Leon Davis"]
-  s.date = "2016-07-28"
+  s.date = "2017-02-17"
   s.description = "Framework for modeling and interacting with webpages which wraps capybara"
   s.email = "info@lad-tech.com"
   s.extra_rdoc_files = [
@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
     "lib/page_magic/element.rb",
     "lib/page_magic/element/locators.rb",
     "lib/page_magic/element/query.rb",
+    "lib/page_magic/element/query_builder.rb",
     "lib/page_magic/element/selector.rb",
     "lib/page_magic/element/selector_methods.rb",
     "lib/page_magic/element_context.rb",
@@ -62,6 +63,7 @@ Gem::Specification.new do |s|
     "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/query_spec.rb",
     "spec/page_magic/element/selector_spec.rb",
     "spec/page_magic/element_context_spec.rb",

data/spec/page_magic/element/query_builder_spec.rb

@@ -0,0 +1,108 @@
+module PageMagic
+  class Element
+    describe QueryBuilder do
+      it 'has a predefined query for each element type' do
+        missing = PageMagic::Elements::TYPES.dup.delete_if { |type| type.to_s.end_with?('s') }.find_all do |type|
+          described_class.constants.include?(type)
+        end
+        expect(missing).to be_empty
+      end
+
+      describe '.find' do
+        it 'finds the constant with the given name' do
+          expect(described_class.find(:button)).to be(described_class::BUTTON)
+        end
+
+        context 'constant not found' do
+          it 'returns a default' do
+            expect(described_class.find(:billy)).to be(described_class::ELEMENT)
+          end
+        end
+      end
+
+      describe '#build' do
+        let(:selector) { Selector.new }
+        before do
+          expect(Selector).to receive(:find).with(:css).and_return(selector)
+        end
+        let(:locator) { { css: '.css' } }
+
+        it 'builds a query using the correct selector' do
+          expected = Query.new(locator.values)
+          expect(subject.build(locator)).to eq(expected)
+        end
+
+        it 'adds options to the result' do
+          expected = Query.new(locator.values.concat([:options]))
+          expect(subject.build(locator, :options)).to eq(expected)
+        end
+
+        context 'selector support element type' do
+          subject do
+            described_class.new(:field)
+          end
+
+          it 'passes element type through to the selector' do
+            expect(selector).to receive(:build).with(:field, '.css').and_call_original
+            subject.build(locator)
+          end
+        end
+      end
+    end
+
+    class QueryBuilder
+      describe BUTTON do
+        it 'has an element type' do
+          expect(described_class.type).to eq(:button)
+        end
+      end
+
+      describe ELEMENT do
+        it ' does not has an element type' do
+          expect(described_class.type).to be_nil
+        end
+      end
+
+      describe LINK do
+        it 'has an element type' do
+          expect(described_class.type).to eq(:link)
+        end
+      end
+
+      describe TEXT_FIELD do
+        it 'has an element type' do
+          expect(described_class.type).to eq(:field)
+        end
+
+        it 'the same as all form field types' do
+          expect(described_class).to eq(CHECKBOX).and eq(SELECT_LIST).and eq(RADIO).and eq(TEXTAREA)
+        end
+      end
+    end
+
+    context 'integration' do
+      include_context :webapp_fixture
+      let(:capybara_session) { Capybara::Session.new(:rack_test, rack_app).tap { |s| s.visit('/elements') } }
+
+      it 'finds fields' do
+        query = QueryBuilder.find(:text_field).build(name: 'field_name')
+        expect(query.execute(capybara_session).tag_name).to eq('input')
+      end
+
+      it 'finds buttons' do
+        query = QueryBuilder.find(:button).build(text: 'a button')
+        expect(query.execute(capybara_session).tag_name).to eq('button')
+      end
+
+      it 'finds links' do
+        query = QueryBuilder.find(:link).build(text: 'a link')
+        expect(query.execute(capybara_session).tag_name).to eq('a')
+      end
+
+      it 'finds elements' do
+        query = QueryBuilder.find(:element).build(name: 'field_name')
+        expect(query.execute(capybara_session).tag_name).to eq('input')
+      end
+    end
+  end
+end

data/spec/page_magic/element/query_spec.rb

@@ -1,101 +1,57 @@
 module PageMagic
   class Element
     describe Query do
-      it 'has a predefined query for each element type' do
-        missing = PageMagic::Elements::TYPES.find_all do |type|
-          !described_class.constants.include?(type.upcase.to_sym)
-        end
-        expect(missing).to be_empty
-      end
+      include_context :webapp_fixture
 
-      describe '.find' do
-        it 'finds the constant with the given name' do
-          expect(Query.find(:button)).to be(described_class::BUTTON)
-        end
-
-        context 'constant not found' do
-          it 'returns a default' do
-            expect(Query.find(:billy)).to be(described_class::ELEMENT)
-          end
+      let(:page) do
+        elements_page = Class.new do
+          include PageMagic
+          url '/elements'
         end
+        elements_page.visit(application: rack_app).current_page
       end
 
-      describe '#build' do
-        let(:selector) { Selector.new }
-        before do
-          expect(Selector).to receive(:find).with(:css).and_return(selector)
-        end
-        let(:locator) { { css: '.css' } }
-
-        it 'uses the locator to find the correct selector builder' do
-          expect(subject.build(locator)).to eq(locator.values)
-        end
-
-        it 'adds options to the result' do
-          expect(subject.build(locator, :options)).to eq(locator.values.concat([:options]))
-        end
-
-        context 'selector support element type' do
+      describe '#execute' do
+        context 'no results found' do
           subject do
-            described_class.new(:field)
+            QueryBuilder.find(:link).build(css: 'wrong')
           end
 
-          it 'passes element type through to the selector' do
-            expect(selector).to receive(:build).with(:field, '.css').and_call_original
-            subject.build(locator)
+          it 'raises an error' do
+            expected_message = 'Unable to find css "wrong"'
+            expect { subject.execute(page.browser) }.to raise_exception(ElementMissingException, expected_message)
           end
         end
-      end
-    end
 
-    class Query
-      describe BUTTON do
-        it 'has an element type' do
-          expect(described_class.type).to eq(:button)
-        end
-      end
+        context 'to many results returned' do
+          subject do
+            QueryBuilder.find(:link).build(css: 'a')
+          end
 
-      describe ELEMENT do
-        it ' does not has an element type' do
-          expect(described_class.type).to be_nil
+          it 'raises an error' do
+            expected_message = 'Ambiguous match, found 2 elements matching css "a"'
+            expect { subject.execute(page.browser) }.to raise_error AmbiguousQueryException, expected_message
+          end
         end
-      end
 
-      describe LINK do
-        it 'has an element type' do
-          expect(described_class.type).to eq(:link)
-        end
-      end
+        context 'multiple results found' do
+          subject do
+            QueryBuilder.find(:link).build({ css: 'a' }, {}, multiple_results: true)
+          end
 
-      describe TEXT_FIELD do
-        it 'has an element type' do
-          expect(described_class.type).to eq(:field)
+          it 'returns an array' do
+            result = subject.execute(page.browser)
+            expect(result).to be_a(Array)
+            expect(result.size).to eq(2)
+          end
         end
 
-        it 'the same as all form field types' do
-          expect(described_class).to eq(CHECKBOX).and eq(SELECT_LIST).and eq(RADIOS).and eq(TEXTAREA)
+        it 'returns the result of the capybara query' do
+          query = QueryBuilder.find(:link).build(id: 'form_link')
+          result = query.execute(page.browser)
+          expect(result.text).to eq('link in a form')
         end
       end
     end
-
-    context 'integration' do
-      include_context :webapp_fixture
-      let(:capybara_session) { Capybara::Session.new(:rack_test, rack_app).tap { |s| s.visit('/elements') } }
-      it 'finds fields' do
-        expect(capybara_session.all(*Query.find(:text_field).build(name: 'field_name')).size).to eq(1)
-      end
-
-      it 'finds buttons' do
-        expect(capybara_session.all(*Query.find(:button).build(text: 'a button')).size).to eq(1)
-      end
-
-      it 'finds links' do
-        expect(capybara_session.all(*Query.find(:link).build(text: 'a link')).size).to eq(1)
-      end
-
-      it 'finds elements' do
-        expect(capybara_session.all(*Query.find(:element).build(name: 'field_name')).size).to eq(1)
-      end
-    end
   end
 end

data/spec/page_magic/element/selector_spec.rb

@@ -128,23 +128,28 @@ module PageMagic
       let(:capybara_session) { Capybara::Session.new(:rack_test, rack_app).tap { |s| s.visit('/elements') } }
 
       it 'finds elements by name' do
-        expect(capybara_session.all(*Query.find(:text_field).build(name: 'field_name')).size).to eq(1)
+        query = QueryBuilder.find(:text_field).build(name: 'field_name')
+        expect(query.execute(capybara_session)[:name]).to eq('field_name')
       end
 
       it 'finds elements by xpath' do
-        expect(capybara_session.all(*Query.find(:element).build(xpath: '//div/input')).size).to eq(1)
+        query = QueryBuilder.find(:element).build(xpath: '//div/label/input')
+        expect(query.execute(capybara_session)[:name]).to eq('field_name')
       end
 
       it 'finds elements by id' do
-        expect(capybara_session.all(*Query.find(:text_field).build(id: 'field_id')).size).to eq(1)
+        query = QueryBuilder.find(:text_field).build(id: 'field_id')
+        expect(query.execute(capybara_session)[:name]).to eq('field_name')
       end
 
       it 'finds elements by label' do
-        expect(capybara_session.all(*Query.find(:text_field).build(label: 'enter text')).size).to eq(1)
+        query = QueryBuilder.find(:text_field).build(label: 'enter text')
+        expect(query.execute(capybara_session)[:name]).to eq('field_name')
       end
 
       it 'finds elements by text' do
-        expect(capybara_session.all(*Query.find(:link).build(text: 'a link')).size).to eq(1)
+        query = QueryBuilder.find(:link).build(text: 'a link')
+        expect(query.execute(capybara_session).text).to eq('a link')
       end
     end
   end

data/spec/page_magic/element_context_spec.rb

@@ -31,7 +31,7 @@ module PageMagic
         end
 
         it 'passes arguments through to the element definition' do
-          elements_page.link :pass_through, css: 'a' do |args|
+          elements_page.links :pass_through, css: 'a' do |args|
             args[:passed_through] = true
           end
           args = {}
@@ -51,19 +51,12 @@ module PageMagic
 
         context 'more than one match found in the browser' do
           it 'returns an array of element definitions' do
-            elements_page.link :links, css: 'a'
+            elements_page.links :links, css: 'a'
             links = described_class.new(page).links
             expect(links.find_all { |e| e.class == Element }.size).to eq(2)
             expect(links.collect(&:text)).to eq(['a link', 'link in a form'])
           end
         end
-        context 'no results found' do
-          it 'raises an error' do
-            elements_page.link :missing, css: 'wrong'
-            expected_message = described_class::ELEMENT_NOT_FOUND_MSG % 'css "wrong"'
-            expect { described_class.new(page).missing }.to raise_exception(ElementMissingException, expected_message)
-          end
-        end
       end
 
       context 'method found on page_element' do

data/spec/page_magic/element_definition_builder_spec.rb

@@ -69,7 +69,7 @@ module PageMagic
                                       element: Object.new,
                                       options: options)
 
-        expect(builder.build_query).to eq([:xpath, '//xpath', options])
+        expect(builder.build_query).to eq(Element::Query.new([:xpath, '//xpath', options]))
       end
     end
   end

data/spec/page_magic/elements_spec.rb

@@ -22,7 +22,7 @@ module PageMagic
         expected_definition = ElementDefinitionBuilder.new(definition_class: Element,
                                                            type: :text_field,
                                                            selector: child_selector,
-                                                           options: {})
+                                                           options: { multiple_results: false })
         subject.text_field :alias, child_selector
         expect(instance.element_by_name(:alias)).to eq(expected_definition)
       end

data/spec/support/shared_contexts/webapp_fixture_context.rb

@@ -21,7 +21,7 @@ shared_context :webapp_fixture do
             <label>enter text
               <input id='field_id' name='field_name' class='input_class' type='text' value='filled in'/>
             </label>
-            <input id='form_button' type='submit' value='a button'/>
+            <button id='form_button' type='submit' value='a button'/>
           </form>
 
         ELEMENTS

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_magic
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Leon Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-28 00:00:00.000000000 Z
+date: 2017-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -137,6 +137,7 @@ files:
 - lib/page_magic/element.rb
 - lib/page_magic/element/locators.rb
 - lib/page_magic/element/query.rb
+- lib/page_magic/element/query_builder.rb
 - lib/page_magic/element/selector.rb
 - lib/page_magic/element/selector_methods.rb
 - lib/page_magic/element_context.rb
@@ -159,6 +160,7 @@ files:
 - 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/query_spec.rb
 - spec/page_magic/element/selector_spec.rb
 - spec/page_magic/element_context_spec.rb