page_magic 1.0.0.alpha21 → 1.0.0

data/spec/page_magic/session_spec.rb

@@ -12,18 +12,6 @@ module PageMagic
     let(:url) { 'http://url.com' }
     let(:browser) { double('browser', current_url: url, visit: nil, current_path: :current_path) }
 
-    describe '#current_url' do
-      it "returns the browser's current url" do
-        expect(subject.current_url).to eq(browser.current_url)
-      end
-    end
-
-    describe '#current_path' do
-      it "returns the browser's current path" do
-        expect(subject.current_path).to eq(browser.current_path)
-      end
-    end
-
     describe '#current_page' do
       let(:another_page_class) do
         Class.new do
@@ -52,6 +40,18 @@ module PageMagic
       end
     end
 
+    describe '#current_path' do
+      it "returns the browser's current path" do
+        expect(subject.current_path).to eq(browser.current_path)
+      end
+    end
+
+    describe '#current_url' do
+      it "returns the browser's current url" do
+        expect(subject.current_url).to eq(browser.current_url)
+      end
+    end
+
     describe '#find_mapped_page' do
       subject do
         described_class.new(nil).tap do |session|
@@ -77,63 +77,42 @@ module PageMagic
       end
     end
 
-    describe '#wait' do
-      it 'passes the supplied block to the wait api' do
-        block = proc { :executed }
-        allow_any_instance_of(Wait).to receive(:until).and_call_original
-        expect(subject.wait_until(&block)).to eq(:executed)
+    describe '#execute_script' do
+      it 'calls the execute script method on the capybara session' do
+        expect(browser).to receive(:execute_script).with(:script).and_return(:result)
+        expect(subject.execute_script(:script)).to be(:result)
       end
     end
 
-    describe '#visit' do
-      let(:session) do
-        allow(browser).to receive(:visit)
-        PageMagic::Session.new(browser, url)
-      end
-
-      context 'page supplied' do
-        it 'sets the current page' do
-          session.define_page_mappings '/page' => page
-          session.visit(page)
-          expect(session.current_page).to be_a(page)
-        end
-
-        it 'uses the current url and the path in the page mappings' do
-          session.define_page_mappings '/page' => page
-          expect(browser).to receive(:visit).with("#{browser.current_url}/page")
-          session.visit(page)
-        end
-
-        context 'no mappings found' do
-          it 'raises an error' do
-            expect { session.visit(page) }.to raise_exception InvalidURLException, described_class::URL_MISSING_MSG
+    describe '#method_missing' do
+      it 'should delegate to current page' do
+        page.class_eval do
+          def my_method
+            :called
           end
         end
 
-        context 'mapping is a regular expression' do
-          it 'raises an error' do
-            session.define_page_mappings(/mapping/ => page)
-            expect { session.visit(page) }.to raise_exception InvalidURLException, described_class::REGEXP_MAPPING_MSG
-          end
-        end
+        session = PageMagic::Session.new(browser).visit(page, url: url)
+        expect(session.my_method).to be(:called)
+      end
+    end
 
-        it 'calls the onload hook' do
-          on_load_hook_called = false
-          page.on_load do
-            on_load_hook_called = true
-          end
-          session.define_page_mappings('/page' => page)
-          session.visit(page)
-          expect(on_load_hook_called).to eq(true)
+    context '#respond_to?' do
+      subject do
+        PageMagic::Session.new(browser).tap do |s|
+          allow(s).to receive(:current_page).and_return(page.new)
         end
       end
+      it 'checks self' do
+        expect(subject.respond_to?(:current_url)).to eq(true)
+      end
 
-      context 'url supplied' do
-        it 'visits that url' do
-          expected_url = 'http://url.com/page'
-          expect(browser).to receive(:visit).with(expected_url)
-          session.visit(url: expected_url)
+      it 'checks the current page' do
+        page.class_eval do
+          def my_method
+          end
         end
+        expect(subject.respond_to?(:my_method)).to eq(true)
       end
     end
 
@@ -175,35 +154,55 @@ module PageMagic
       end
     end
 
-    context '#method_missing' do
-      it 'should delegate to current page' do
-        page.class_eval do
-          def my_method
-            :called
+    describe '#visit' do
+      let(:session) do
+        allow(browser).to receive(:visit)
+        PageMagic::Session.new(browser, url)
+      end
+
+      context 'page supplied' do
+        it 'sets the current page' do
+          session.define_page_mappings '/page' => page
+          session.visit(page)
+          expect(session.current_page).to be_a(page)
+        end
+
+        it 'uses the current url and the path in the page mappings' do
+          session.define_page_mappings '/page' => page
+          expect(browser).to receive(:visit).with("#{browser.current_url}/page")
+          session.visit(page)
+        end
+
+        context 'no mappings found' do
+          it 'raises an error' do
+            expect { session.visit(page) }.to raise_exception InvalidURLException, described_class::URL_MISSING_MSG
           end
         end
 
-        session = PageMagic::Session.new(browser).visit(page, url: url)
-        expect(session.my_method).to be(:called)
-      end
-    end
+        context 'mapping is a regular expression' do
+          it 'raises an error' do
+            session.define_page_mappings(/mapping/ => page)
+            expect { session.visit(page) }.to raise_exception InvalidURLException, described_class::REGEXP_MAPPING_MSG
+          end
+        end
 
-    context '#respond_to?' do
-      subject do
-        PageMagic::Session.new(browser).tap do |s|
-          allow(s).to receive(:current_page).and_return(page.new)
+        it 'calls the onload hook' do
+          on_load_hook_called = false
+          page.on_load do
+            on_load_hook_called = true
+          end
+          session.define_page_mappings('/page' => page)
+          session.visit(page)
+          expect(on_load_hook_called).to eq(true)
         end
       end
-      it 'checks self' do
-        expect(subject.respond_to?(:current_url)).to eq(true)
-      end
 
-      it 'checks the current page' do
-        page.class_eval do
-          def my_method
-          end
+      context 'url supplied' do
+        it 'visits that url' do
+          expected_url = 'http://url.com/page'
+          expect(browser).to receive(:visit).with(expected_url)
+          session.visit(url: expected_url)
         end
-        expect(subject.respond_to?(:my_method)).to eq(true)
       end
     end
   end

data/spec/page_magic/wait_methods_spec.rb

@@ -0,0 +1,41 @@
+module PageMagic
+  describe WaitMethods do
+    subject do
+      Object.new.tap do |o|
+        o.extend(described_class)
+      end
+    end
+
+    let(:default_options) { { timeout_after: 0.1, retry_every: 0.05 } }
+
+    it 'waits until the prescribed thing has happened' do
+      expect { subject.wait_until(default_options) { true } }.to_not raise_exception
+    end
+
+    it 'should keep trying for a specified period' do
+      start_time = Time.now
+
+      expect { subject.wait_until(default_options) { false } }.to raise_exception TimeoutException
+
+      expect(Time.now - default_options[:timeout_after]).to be > start_time
+    end
+
+    context 'timeout_after specified' do
+      it 'throws an exception if when the prescribed action does not happen in time' do
+        expect { subject.wait_until(default_options) { false } }.to raise_error TimeoutException
+      end
+    end
+
+    context 'retry time specified' do
+      it 'retries at the given interval' do
+        count = 0
+        expect do
+          subject.wait_until(timeout_after: default_options[:timeout_after] * 2, retry_every: 0.1) do
+            count += 1
+          end
+        end.to raise_exception TimeoutException
+        expect(count).to eq(2)
+      end
+    end
+  end
+end

data/spec/page_magic/watchers_spec.rb

@@ -0,0 +1,74 @@
+module PageMagic
+  describe Watchers do
+    let(:element) { OpenStruct.new(text: :current_value) }
+
+    subject do
+      Object.new.tap do |o|
+        o.extend(described_class)
+        allow(o).to receive(:my_watcher).and_return(element)
+      end
+    end
+
+    describe '#changed?' do
+      before do
+        subject.watch(:my_watcher, :text)
+      end
+
+      context 'watched element has changed' do
+        it 'returns true' do
+          element.text = :new_value
+          expect(subject.changed?(:my_watcher)).to eq(true)
+        end
+      end
+
+      context 'watched element has not changed' do
+        it 'returns false' do
+          expect(subject.changed?(:my_watcher)).to eq(false)
+        end
+      end
+    end
+
+    describe '#watch' do
+      it 'stores the initial value of the watched element' do
+        subject.watch(:my_watcher, :text)
+        expect(subject.watcher(:my_watcher).last).to eq(:current_value)
+      end
+
+      context 'element name/ method name supplied' do
+        it 'stores the watch instruction' do
+          subject.watch(:object_id)
+          expect(subject.watcher(:object_id)).to eq(Watcher.new(:object_id))
+        end
+      end
+
+      context 'element name and attribute supplied' do
+        it 'stores the watch instruction' do
+          subject.watch(:my_watcher, :text)
+          expect(subject.watcher(:my_watcher)).to eq(Watcher.new(:my_watcher, :text))
+        end
+      end
+
+      context 'block supplied' do
+        it 'stores the watch instruction' do
+          block = proc {}
+          subject.watch(:my_watcher, &block)
+          expect(subject.watcher(:my_watcher)).to eq(Watcher.new(:my_watcher, &block))
+        end
+      end
+
+      context 'watcher defined on element that does not exist' do
+        it 'raises an error' do
+          expected_message = described_class::ELEMENT_MISSING_MSG % :missing
+          expect { subject.watch(:missing, :text) }.to raise_exception(ElementMissingException, expected_message)
+        end
+      end
+    end
+
+    describe '#watcher' do
+      it 'returns the watcher with the given name' do
+        subject.watch(:my_watcher, :text)
+        expect(subject.watcher(:my_watcher)).to eq(Watcher.new(:my_watcher, :text))
+      end
+    end
+  end
+end

data/spec/page_magic_spec.rb

@@ -5,6 +5,14 @@ describe PageMagic do
     Class.new { include PageMagic }
   end
 
+  describe '.drivers' do
+    it 'returns loaded drivers' do
+      expected_drivers = described_class::Drivers.new.tap(&:load)
+
+      expect(described_class.drivers).to eq(expected_drivers)
+    end
+  end
+
   describe '.included' do
     it 'gives a method for defining the url' do
       subject.url :url
@@ -40,15 +48,7 @@ describe PageMagic do
     end
   end
 
-  describe '::drivers' do
-    it 'returns loaded drivers' do
-      expected_drivers = described_class::Drivers.new.tap(&:load)
-
-      expect(described_class.drivers).to eq(expected_drivers)
-    end
-  end
-
-  describe '::session' do
+  describe '.session' do
     let(:url) { 'http://url.com/' }
     let(:application) { rack_application.new }
 

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 Bundler.require
 $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
 require 'support/shared_contexts'
+require 'support/shared_examples'
 
 require 'simplecov' if ENV['coverage']
 

data/spec/support/shared_contexts/nested_elements_html_context.rb

@@ -0,0 +1,16 @@
+shared_context :nested_elements_html do
+  require 'sinatra/base'
+
+  let(:nested_elements_html) do
+    <<-HTML
+      <div id="parent">
+        <div id="child">
+        </div>
+      </div>
+    HTML
+  end
+
+  let(:nested_elements_node) do
+    Capybara::Node::Simple.new(nested_elements_html)
+  end
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,25 @@
+module PageMagic
+  shared_examples 'session accessor' do
+    it 'includes session methods' do
+      expect(described_class.included_modules).to include(SessionMethods)
+    end
+  end
+
+  shared_examples 'element watcher' do
+    it 'includes watchers' do
+      expect(described_class.included_modules).to include(Watchers)
+    end
+  end
+
+  shared_examples 'waiter' do
+    it 'includes waiters' do
+      expect(described_class.included_modules).to include(WaitMethods)
+    end
+  end
+
+  shared_examples 'element locator' do
+    it 'includes Locators' do
+      expect(described_class.included_modules).to include(Element::Locators)
+    end
+  end
+end

data/spec/watcher_spec.rb

@@ -0,0 +1,49 @@
+module PageMagic
+  describe Watcher do
+    describe '#initialize' do
+      context 'check has not been called yet' do
+        subject do
+          described_class.new(:custom_watcher)
+        end
+        it 'it sets last to nil' do
+          expect(subject.last).to be_nil
+        end
+      end
+    end
+
+    describe '#check' do
+      context 'method supplied to constructor' do
+        subject do
+          described_class.new(:object_id)
+        end
+
+        it 'assigns last to be the result of calling the method' do
+          subject.check(self)
+          expect(subject.last).to eq(object_id)
+        end
+      end
+      context 'name and attribute supplied to constructor' do
+        subject do
+          described_class.new(:my_button, :text)
+        end
+
+        it 'assigns last to the value of attribute definined in the constructor' do
+          browser_element = double(text: :hello)
+          page_element = double(my_button: browser_element)
+          expect(subject.check(page_element).last).to eq(:hello)
+        end
+      end
+
+      context 'block supplied to constructor' do
+        subject do
+          described_class.new(:custom_watcher) do
+            :result
+          end
+        end
+        it 'assigns last to the resut of the block' do
+          expect(subject.check.last).to eq(:result)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: page_magic
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha21
+  version: 1.0.0
 platform: ruby
 authors:
 - Leon Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -149,35 +149,47 @@ files:
 - lib/page_magic/drivers/rack_test.rb
 - lib/page_magic/drivers/selenium.rb
 - lib/page_magic/element.rb
-- lib/page_magic/element/method_observer.rb
+- lib/page_magic/element/locators.rb
 - lib/page_magic/element/query.rb
 - lib/page_magic/element/selector.rb
 - lib/page_magic/element/selector_methods.rb
 - lib/page_magic/element_context.rb
+- lib/page_magic/element_definition_builder.rb
 - lib/page_magic/elements.rb
 - lib/page_magic/exceptions.rb
 - lib/page_magic/instance_methods.rb
 - lib/page_magic/session.rb
+- lib/page_magic/session_methods.rb
+- lib/page_magic/wait_methods.rb
+- lib/page_magic/watcher.rb
+- lib/page_magic/watchers.rb
 - spec/element_spec.rb
-- spec/member_methods_spec.rb
 - spec/page_magic/class_methods_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_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/elements_spec.rb
 - spec/page_magic/instance_methods_spec.rb
+- spec/page_magic/session_methods_spec.rb
 - spec/page_magic/session_spec.rb
+- spec/page_magic/wait_methods_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_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
@@ -193,9 +205,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: []
 rubyforge_project: 
 rubygems_version: 2.2.2

data/lib/page_magic/element/method_observer.rb

@@ -1,20 +0,0 @@
-module PageMagic
-  class Element
-    # module MethodObserver - adds methods to check if a methods have been added.
-    module MethodObserver
-      # Hook called by ruby when a singleton method is added.
-      #
-      # @param [String] arg name of the method added
-      def singleton_method_added(arg)
-        @singleton_methods_added = true unless arg == :singleton_method_added
-      end
-
-      # returns true if a singleton method has been added
-      #
-      # @return [Boolean]
-      def singleton_methods_added?
-        @singleton_methods_added == true
-      end
-    end
-  end
-end

data/spec/member_methods_spec.rb

@@ -1,2 +0,0 @@
-describe 'member methods' do
-end