page_magic 1.2.7 → 2.0.0

data/lib/page_magic/watchers.rb

@@ -1,32 +1,37 @@
-require 'page_magic/watcher'
+# frozen_string_literal: true
+
+require_relative '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
     def changed?(name)
       watched_element = watcher(name)
-      watched_element.last != watched_element.check(self).last
+      watched_element.observed_value != watched_element.check.observed_value
     end
 
     # register a new watcher
-    # @param [Object] name of the watcher/element
-    # @param [Symbol] method - the method on the watched element to check
-    # @yieldreturn [Object] the value that should be checked
-    # @example
-    #  watch(:price, :text)
-    # @example
-    #  watch(:something) do
+    # @overload watch(:price, context: object, method: :text)
+    #  @param [Symbol] name of the watcher/element
+    #  @param [Object] context the object that is being watched - defaults to self
+    #  @param [Symbol] method - the method on the watched element to check
+    # @overload watch(:text)
+    #  @param [Symbol] method - the method on the watched element to check
+    # @overload watch(:text, &blk)
+    #  @param [Symbol] name of the watcher/element
+    #  @yieldreturn [Object] the value that should be checked
+    #  @example
+    #   watch(:something) do
     #   # more complicated code to get value
-    # 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)
+    #   end
+    def watch(name, context: self, method: nil, &blk)
+      watcher = blk ? Watcher.new(name, context: context, &blk) : watch_method(name, context: context, method: method)
       watchers.delete_if { |w| w.name == name }
-      watchers << watched_element.check(self)
+      watchers << watcher.check
     end
 
     # retrieve a watcher given its name
@@ -40,5 +45,16 @@ module PageMagic
     def watchers
       @watchers ||= []
     end
+
+    private
+
+    def watch_method(name, context:, method:)
+      subject = method || name
+      raise ElementMissingException, (ELEMENT_MISSING_MSG % subject) unless context.respond_to?(subject)
+
+      Watcher.new(name, context: context) do
+        public_send(subject)
+      end
+    end
   end
 end

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.7 ruby lib
+# stub: page_magic 1.2.9 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "page_magic"
-  s.version = "1.2.7"
+  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 = "2017-02-17"
+  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",
@@ -51,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",
@@ -73,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",
@@ -88,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/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,63 +1,92 @@
-module PageMagic
-  describe ClassMethods do
-    subject do
+# frozen_string_literal: true
+
+RSpec.describe PageMagic::ClassMethods do
+  describe '#load' do
+    subject(:page_class) do
       Class.new.tap do |clazz|
         clazz.extend(described_class)
-        clazz.include(InstanceMethods)
+        clazz.include(PageMagic::InstanceMethods)
       end
     end
 
-    describe '#load' do
-      let(:page_title) { 'page title' }
-      let(:page_source) do
-        <<-HTML
+    let(:page_title) { 'page title' }
+    let(:page_source) do
+      <<-HTML
           <html>
             <head><title>#{page_title}</title></head>
           </html>
-        HTML
-      end
+      HTML
+    end
 
-      it 'returns an instance using that source' do
-        expect(subject.load(page_source).title).to eq(page_title)
+    it 'returns an instance using that source' do
+      expect(page_class.load(page_source).title).to eq(page_title)
+    end
+  end
+
+  describe 'on_load' do
+    subject(:page_class) do
+      Class.new.tap do |clazz|
+        clazz.extend(described_class)
       end
     end
 
-    describe 'on_load' do
-      context 'block not set' do
-        it 'returns a default block' do
-          expect(subject.on_load).to be(described_class::DEFAULT_ON_LOAD)
-        end
+    context 'when a block is not set' do
+      it 'returns a default block' do
+        expect(page_class.on_load).to be(described_class::DEFAULT_ON_LOAD)
       end
+    end
 
-      context 'block set' do
-        it 'returns that block' do
-          expected_block = proc {}
-          subject.on_load(&expected_block)
-          expect(subject.on_load).to be(expected_block)
-        end
+    context 'when a block is set' do
+      it 'returns that block' do
+        expected_block = proc {}
+        page_class.on_load(&expected_block)
+        expect(page_class.on_load).to be(expected_block)
       end
     end
+  end
 
-    describe '#url' do
-      it 'get/sets a value' do
-        subject.url(:url)
-        expect(subject.url).to eq(:url)
+  describe '#url' do
+    subject(:page_class) do
+      Class.new.tap do |clazz|
+        clazz.extend(described_class)
       end
     end
 
-    describe '#visit' do
-      include_context :webapp_fixture
-      it 'passes all options to create an active session on the registered url' do
-        subject.url '/page1'
-        expect(PageMagic).to receive(:session).with(application: rack_app,
-                                                    options: {},
-                                                    browser: :rack_test,
-                                                    url: subject.url).and_call_original
+    it 'get/sets a value' do
+      page_class.url(:url)
+      expect(page_class.url).to eq(:url)
+    end
+  end
 
-        session = subject.visit(application: rack_app, options: {}, browser: :rack_test)
+  describe '#visit' do
+    subject(:page_class) do
+      Class.new.tap do |clazz|
+        clazz.extend(described_class)
+        clazz.include(PageMagic::InstanceMethods)
+        clazz.url ''
+      end
+    end
 
-        expect(session.title).to eq('page1')
+    let(:rack_app) do
+      Class.new do
+        def self.call(_env)
+          [200, {}, ['<html><head><title>page1</title></head></html>']]
+        end
       end
     end
+
+    it 'passes all options to create an active session on the registered url' do
+      allow(PageMagic).to receive(:session).and_call_original
+
+      page_class.visit(application: rack_app, options: {}, browser: :rack_test)
+
+      expected_option = { application: rack_app, options: {}, browser: :rack_test, url: page_class.url }
+      expect(PageMagic).to have_received(:session).with(expected_option)
+    end
+
+    it 'returns a session' do
+      session = page_class.visit(application: rack_app, options: {}, browser: :rack_test)
+      expect(session).to be_kind_of(PageMagic::Session)
+    end
   end
 end

data/spec/page_magic/comparator/fuzzy_spec.rb

@@ -0,0 +1,44 @@
+RSpec.describe PageMagic::Comparator::Fuzzy do
+  describe '#fuzzy?' do
+    context 'when one value is fuzzy' do
+      it 'returns true' do
+        map = described_class.new(//)
+        expect(map).to be_fuzzy
+      end
+    end
+  end
+
+  describe 'match?' do
+    context 'when comparator contains the parameter' do
+      it 'returns true' do
+        expect(described_class.new(/f*o/)).to be_match('foo')
+      end
+    end
+
+    context 'when comparator does not contains the parameter' do
+      it 'returns false' do
+        expect(described_class.new(/f*o/)).not_to be_match('bar')
+      end
+    end
+  end
+
+  describe '#<=>' do
+    context 'when other is `Null`' do
+      it 'is lesser' do
+        expect(described_class.new(//) <=> PageMagic::Comparator::Null.new).to be(-1)
+      end
+    end
+
+    context 'when other is `Fuzzy`' do
+      it 'is equal' do
+        expect(described_class.new(//) <=> described_class.new(//)).to be 0
+      end
+    end
+
+    context 'when other is `Literal`' do
+      it 'is greater' do
+        expect(described_class.new(//) <=> PageMagic::Comparator::Literal.new('/')).to be 1
+      end
+    end
+  end
+end

data/spec/page_magic/comparator/literal_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe PageMagic::Comparator::Literal do
+  describe 'match?' do
+    context 'when parameter is the same' do
+      it 'returns true' do
+        expect(described_class.new('/')).to be_match('/')
+      end
+    end
+
+    context 'when it parameter is not the same' do
+      it 'returns false' do
+        expect(described_class.new('/')).not_to be_match('foo')
+      end
+    end
+  end
+
+  describe '#fuzzy?' do
+    it 'returns false' do
+      expect(described_class.new('value')).not_to be_fuzzy
+    end
+  end
+
+  describe '#<=>' do
+    context 'when other is `Null`' do
+      it 'is greater' do
+        expect(described_class.new('/') <=> PageMagic::Comparator::Null.new).to be 1
+      end
+    end
+
+    context 'when other is `Fuzzy`' do
+      it 'is greater' do
+        expect(described_class.new('/') <=> PageMagic::Comparator::Fuzzy.new(//)).to be 1
+      end
+    end
+
+    context 'when other is `Literal`' do
+      it 'is equal' do
+        expect(described_class.new('/') <=> described_class.new('/')).to be 0
+      end
+    end
+  end
+end