page_magic 1.2.6 → 2.0.0.alpha1

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.9 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "page_magic"
-  s.version = "1.2.6"
+  s.version = "1.2.9"
 
   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-10-03"
   s.description = "Framework for modeling and interacting with webpages which wraps capybara"
   s.email = "info@lad-tech.com"
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "circle.yml",
+    "lib/active_support/core_ext/object/to_query.rb",
     "lib/page_magic.rb",
     "lib/page_magic/class_methods.rb",
     "lib/page_magic/driver.rb",
@@ -40,6 +41,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",
@@ -50,11 +52,13 @@ Gem::Specification.new do |s|
     "lib/page_magic/matcher.rb",
     "lib/page_magic/session.rb",
     "lib/page_magic/session_methods.rb",
+    "lib/page_magic/utils/string.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/driver_spec.rb",
     "spec/page_magic/drivers/poltergeist_spec.rb",
@@ -62,6 +66,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",
@@ -71,6 +76,7 @@ Gem::Specification.new do |s|
     "spec/page_magic/matcher_spec.rb",
     "spec/page_magic/session_methods_spec.rb",
     "spec/page_magic/session_spec.rb",
+    "spec/page_magic/utils/string_spec.rb",
     "spec/page_magic/wait_methods_spec.rb",
     "spec/page_magic/watchers_spec.rb",
     "spec/page_magic_spec.rb",
@@ -86,37 +92,37 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/ladtech/page_magic"
   s.licenses = ["ruby"]
   s.required_ruby_version = Gem::Requirement.new(">= 2.1")
-  s.rubygems_version = "2.4.8"
+  s.rubygems_version = "2.4.6"
   s.summary = "Framework for modeling and interacting with webpages"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport-inflector>, [">= 0"])
       s.add_runtime_dependency(%q<capybara>, [">= 2.5"])
-      s.add_runtime_dependency(%q<activesupport>, ["~> 4"])
+      s.add_development_dependency(%q<github-markup>, ["~> 1.4"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_development_dependency(%q<redcarpet>, ["~> 3.3"])
       s.add_development_dependency(%q<rubocop>, ["~> 0.34"])
       s.add_development_dependency(%q<yard>, ["~> 0.8"])
-      s.add_development_dependency(%q<redcarpet>, ["~> 3.3"])
-      s.add_development_dependency(%q<github-markup>, ["~> 1.4"])
     else
+      s.add_dependency(%q<activesupport-inflector>, [">= 0"])
       s.add_dependency(%q<capybara>, [">= 2.5"])
-      s.add_dependency(%q<activesupport>, ["~> 4"])
+      s.add_dependency(%q<github-markup>, ["~> 1.4"])
       s.add_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_dependency(%q<redcarpet>, ["~> 3.3"])
       s.add_dependency(%q<rubocop>, ["~> 0.34"])
       s.add_dependency(%q<yard>, ["~> 0.8"])
-      s.add_dependency(%q<redcarpet>, ["~> 3.3"])
-      s.add_dependency(%q<github-markup>, ["~> 1.4"])
     end
   else
+    s.add_dependency(%q<activesupport-inflector>, [">= 0"])
     s.add_dependency(%q<capybara>, [">= 2.5"])
-    s.add_dependency(%q<activesupport>, ["~> 4"])
+    s.add_dependency(%q<github-markup>, ["~> 1.4"])
     s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    s.add_dependency(%q<redcarpet>, ["~> 3.3"])
     s.add_dependency(%q<rubocop>, ["~> 0.34"])
     s.add_dependency(%q<yard>, ["~> 0.8"])
-    s.add_dependency(%q<redcarpet>, ["~> 3.3"])
-    s.add_dependency(%q<github-markup>, ["~> 1.4"])
   end
 end
 

data/spec/element_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:disable Metrics/ModuleLength
 module PageMagic
   describe Element do

data/spec/lib/active_support/core_ext/object/to_query_test.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'minitest'
+Minitest.autorun
+require 'active_support/core_ext/object/to_query'
+
+class ToQueryTest < ::Minitest::Test
+  def test_simple_conversion
+    assert_query_equal 'a=10', a: 10
+  end
+
+  def test_cgi_escaping
+    assert_query_equal 'a%3Ab=c+d', 'a:b' => 'c d'
+  end
+
+  def test_nil_parameter_value
+    empty = Object.new
+    def empty.to_param
+      nil
+    end
+    assert_query_equal 'a=', 'a' => empty
+  end
+
+  def test_nested_conversion
+    assert_query_equal 'person%5Blogin%5D=seckar&person%5Bname%5D=Nicholas',
+                       person: Hash[:login, 'seckar', :name, 'Nicholas']
+  end
+
+  def test_multiple_nested
+    assert_query_equal 'account%5Bperson%5D%5Bid%5D=20&person%5Bid%5D=10',
+                       Hash[:account, { person: { id: 20 } }, :person, { id: 10 }]
+  end
+
+  def test_array_values
+    assert_query_equal 'person%5Bid%5D%5B%5D=10&person%5Bid%5D%5B%5D=20',
+                       person: { id: [10, 20] }
+  end
+
+  def test_array_values_are_not_sorted
+    assert_query_equal 'person%5Bid%5D%5B%5D=20&person%5Bid%5D%5B%5D=10',
+                       person: { id: [20, 10] }
+  end
+
+  def test_empty_array
+    assert_equal 'person%5B%5D=', [].to_query('person')
+  end
+
+  def test_nested_empty_hash
+    assert_equal '',
+                 {}.to_query
+    assert_query_equal 'a=1&b%5Bc%5D=3',
+                       a: 1, b: { c: 3, d: {} }
+    assert_query_equal '',
+                       a: { b: { c: {} } }
+    assert_query_equal 'b%5Bc%5D=false&b%5Be%5D=&b%5Bf%5D=&p=12',
+                       p: 12, b: { c: false, e: nil, f: '' }
+    assert_query_equal 'b%5Bc%5D=3&b%5Bf%5D=',
+                       b: { c: 3, k: {}, f: '' }
+    assert_query_equal 'b=3',
+                       a: [], b: 3
+  end
+
+  def test_hash_with_namespace
+    hash = { name: 'Nakshay', nationality: 'Indian' }
+    assert_equal 'user%5Bname%5D=Nakshay&user%5Bnationality%5D=Indian', hash.to_query('user')
+  end
+
+  def test_hash_sorted_lexicographically
+    hash = { type: 'human', name: 'Nakshay' }
+    assert_equal 'name=Nakshay&type=human', hash.to_query
+  end
+
+  private
+
+  def assert_query_equal(expected, actual)
+    assert_equal expected.split('&'), actual.to_query.split('&')
+  end
+end

data/spec/page_magic/class_methods_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   describe ClassMethods do
     subject do

data/spec/page_magic/driver_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'page_magic/driver'
 
 module PageMagic

data/spec/page_magic/drivers/poltergeist_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'page_magic/drivers/poltergeist'
 module PageMagic
   describe Drivers::Poltergeist do

data/spec/page_magic/drivers/rack_test_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'page_magic/drivers/rack_test'
 module PageMagic
   class Drivers

data/spec/page_magic/drivers/selenium_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'page_magic/drivers/selenium'
 module PageMagic
   describe Drivers::Selenium do

data/spec/page_magic/drivers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'page_magic/drivers'
 module PageMagic
   describe Drivers do

data/spec/page_magic/element/locators_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PageMagic
   class Element
     describe Locators do

data/spec/page_magic/element/query_builder_spec.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+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).and eq(FILE_FIELD).and eq(FILLABLE_FIELD).and eq(RADIO_BUTTON)
+        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,59 @@
+# frozen_string_literal: true
+
 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
-
-      describe '.find' do
-        it 'finds the constant with the given name' do
-          expect(Query.find(:button)).to be(described_class::BUTTON)
-        end
+      include_context :webapp_fixture
 
-        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 visible 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