page_magic 1.0.0.alpha18 → 1.0.0.alpha19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57c321555c03ce3b8a6a43d895ffd657eca3c5ae
-  data.tar.gz: f656f163ed661b0b48ffbc5b2b2d30f5db777beb
+  metadata.gz: 3c6619b6e1c9d8dfc99efdf0c0e7ebe74a47d982
+  data.tar.gz: 1cf1b031cd205134d43abd54d73026f9d41ad864
 SHA512:
-  metadata.gz: 4cd81bb246ed5a267265db1ab31d8861a772c9fa54ac000e0d5dd4ac9340a180a0c047876fe28bd2cbf3a58e29840b342f221c15f1f13564f6486dcc0b1e2806
-  data.tar.gz: 8957aa92ef4ae0dc088fed4d4bf7d13feae4118064b12270add171fe52f0fda423fa8787fcef5b1112b526171bc308676bdc2d9f40c79502da928250b1c8a3a1
+  metadata.gz: be32d07b0103409b817333a632091d1b5b88f3173c1562c39df3dfa2e3d98f26a8e36a95d6ef2f878a7d4240c192d2165452a18d77ac52b0b0c6d27f2bd8451a
+  data.tar.gz: db76720173bdcb1d0fb43fe1721386d0c36e32c76fd354fabde19798cbddc1ba59b376a32942073a6aeb92ee1c3cfd4f948c8711d0ddff63e994d9e6572c5f78

data/Gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'capybara'
-gem 'activesupport'
-gem 'wait'
+gem 'capybara', '~> 2'
+gem 'activesupport', '~> 4'
+gem 'wait', '~> 0'
 
 group :test do
   gem 'watir-webdriver'
@@ -15,10 +15,9 @@ group :test do
 end
 
 group :development do
-  gem 'jeweler'
-  gem 'rubocop', require: 'rubocop/rake_task'
-  gem 'pry-byebug'
-  gem 'yard'
-  gem 'redcarpet'
-  gem 'github-markup'
+  gem 'jeweler', '~> 2.0'
+  gem 'rubocop', '~> 0.34', require: 'rubocop/rake_task'
+  gem 'yard', '~> 0.8'
+  gem 'redcarpet', '~> 3.3'
+  gem 'github-markup', '~> 1.4'
 end

data/Gemfile.lock

@@ -12,8 +12,6 @@ GEM
     astrolabe (1.3.1)
       parser (~> 2.2)
     builder (3.2.2)
-    byebug (5.0.0)
-      columnize (= 0.9.0)
     capybara (2.1.0)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
@@ -26,8 +24,6 @@ GEM
     cliver (0.2.2)
     codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
-    columnize (0.9.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
     faraday (0.8.9)
@@ -57,22 +53,21 @@ GEM
     json (1.8.1)
     jwt (0.1.11)
       multi_json (>= 1.5)
-    method_source (0.8.2)
-    mime-types (1.25)
-    mini_portile (0.5.1)
+    mime-types (2.6.2)
+    mini_portile (0.6.2)
     minitest (5.7.0)
     multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
     oauth2 (0.9.3)
       faraday (>= 0.8, < 0.10)
       jwt (~> 0.1.8)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    parser (2.2.2.6)
+    parser (2.2.3.0)
       ast (>= 1.1, < 3.0)
     poltergeist (1.4.1)
       capybara (~> 2.1.0)
@@ -80,20 +75,13 @@ GEM
       multi_json (~> 1.0)
       websocket-driver (>= 0.2.0)
     powerpack (0.1.1)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.2.0)
-      byebug (~> 5.0)
-      pry (~> 0.10)
     pullreview-coverage (0.0.5)
       certifi
       simplecov (>= 0.7.1, < 1.0.0)
-    rack (1.5.2)
+    rack (1.6.4)
     rack-protection (1.5.0)
       rack
-    rack-test (0.6.2)
+    rack-test (0.6.3)
       rack (>= 1.0)
     rainbow (2.0.0)
     rake (10.2.2)
@@ -113,7 +101,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
-    rubocop (0.34.0)
+    rubocop (0.34.2)
       astrolabe (~> 1.3)
       parser (>= 2.2.2.5, < 3.0)
       powerpack (~> 0.1)
@@ -135,7 +123,6 @@ GEM
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
-    slop (3.6.0)
     thread_safe (0.3.5)
     tilt (1.4.1)
     tzinfo (1.2.2)
@@ -153,19 +140,18 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
-  capybara
+  activesupport (~> 4)
+  capybara (~> 2)
   codeclimate-test-reporter
-  github-markup
-  jeweler
+  github-markup (~> 1.4)
+  jeweler (~> 2.0)
   poltergeist
-  pry-byebug
   pullreview-coverage
-  redcarpet
+  redcarpet (~> 3.3)
   rspec
-  rubocop
+  rubocop (~> 0.34)
   simplecov
   sinatra
-  wait
+  wait (~> 0)
   watir-webdriver
-  yard
+  yard (~> 0.8)

data/README.md

@@ -1,4 +1,4 @@
-[![Code Climate](https://codeclimate.com/github/Ladtech/page_magic/badges/gpa.svg)](https://codeclimate.com/github/Ladtech/page_magic) [![Test Coverage](https://codeclimate.com/github/Ladtech/page_magic/badges/coverage.svg)](https://codeclimate.com/github/Ladtech/page_magic/coverage) [![PullReview stats](https://www.pullreview.com/github/Ladtech/page_magic/badges/master.svg?)](https://www.pullreview.com/github/Ladtech/page_magic/reviews/master)
+[![Circle CI](https://circleci.com/gh/Ladtech/page_magic.svg?style=shield&circle-token=49c8f6869c1e0dc6f3b368e6e22a11fcea3aab8a)](https://circleci.com/gh/Ladtech/page_magic) [![Code Climate](https://codeclimate.com/github/Ladtech/page_magic/badges/gpa.svg)](https://codeclimate.com/github/Ladtech/page_magic) [![Test Coverage](https://codeclimate.com/github/Ladtech/page_magic/badges/coverage.svg)](https://codeclimate.com/github/Ladtech/page_magic/coverage) [![PullReview stats](https://www.pullreview.com/github/Ladtech/page_magic/badges/master.svg?)](https://www.pullreview.com/github/Ladtech/page_magic/reviews/master)
 #PageMagic
 PageMagic is an API for testing web applications. 
 
@@ -12,7 +12,7 @@ Wouldn't it be great if there was a framework that could:
 
 Well PageMagic might just be the answer!
 
-Give it a try and let us know what you think! It's there will undoubtedly be things that can be improved and issues that we are not aware of so your feedback/pull requests are greatly appreciated!
+Give it a try and let us know what you think! There will undoubtedly be things that can be improved and issues that we are not aware of so your feedback/pull requests are greatly appreciated!
 
 # Installation
 `gem install page_magic --pre`
@@ -101,8 +101,20 @@ class MessageView
   include PageMagic
 end
 ```
+### Hooks
+PageMagic lets you define an on_load hook for your pages. This lets you right any custom wait logic you might need 
+before letting execution continue.
+```ruby
+class LoginPage
+  # ... code defining elements as shown above
+  
+  on_load do
+    # wait code here
+  end
+end
+```
 
-## Helper methods
+### Helper methods
 Using elements that are defined on a page is great, but if you are enacting a procedure through interacting with a few of them then your code could end up with some pretty repetitive code. In this case you can define helper methods instead. 
 
 In the above [example](#an example) we used a helper called `login`.
@@ -157,15 +169,15 @@ Here we have defined the 'message' element using a block that takes subject argu
 session.message(subject: 'test message')
 ```
 ## Interaction hooks
-Frequently, you are going to have to work with pages that make heavy use of ajax. This means that just because you've clicked something, it doesn't mean that the action is finished. For these occasions PageMagic provides `before` and `after` hooks that you use to perform custom actions and wait for things to happen. In the case of our web based mail client, we could imagine that when deleting the email, a fancy spinner is displayed whilst the application sends an ajax request to have the message deleted. In this case we wouldn't want to proceed until this has disappeared.
+Frequently, you are going to have to work with pages that make heavy use of ajax. This means that just because you've clicked something, it doesn't mean that the action is finished. For these occasions PageMagic provides `before_events` and `after_events` hooks that you use to perform custom actions and wait for things to happen. In the case of our web based mail client, we could imagine that when deleting the email, a fancy spinner is displayed whilst the application sends an ajax request to have the message deleted. In this case we wouldn't want to proceed until this has disappeared.
 
 ```ruby
 class MessagePage
   include PageMagic
   ## code defining other elements, such as subject and body
   
-  link(:delete, id: 'delete-message') do
-    after do
+  link(:delete id: 'delete-message') do
+    after_events do
       wait_until{fancy_animation_has_disappeared?}
     end
   end

data/Rakefile

@@ -18,4 +18,4 @@ end
 
 Jeweler::RubygemsDotOrgTasks.new
 
-task default: :spec
+task default: [:spec, 'rubocop:auto_correct']

data/VERSION

@@ -1 +1 @@
-1.0.0.alpha18
+1.0.0.alpha19

data/circle.yml

@@ -1,3 +1,3 @@
 test:
   override:
-    - bundle exec rake spec
+    - bundle exec rake

data/lib/page_magic/class_methods.rb

@@ -0,0 +1,20 @@
+module PageMagic
+  # module ClassMethods - contains class level methods for PageObjects
+  module ClassMethods
+    DEFAULT_ON_LOAD = proc {}
+
+    # getter setter for storing the page url
+    # @param [String] url the url of the page
+    def url(url = nil)
+      @url = url if url
+      @url
+    end
+
+    # sets block to run when page has loaded
+    # if one has not been set on the page object class it will return a default block that does nothing
+    def on_load(&block)
+      return @on_load || DEFAULT_ON_LOAD unless block
+      @on_load = block
+    end
+  end
+end

data/lib/page_magic/driver.rb

@@ -2,15 +2,36 @@ module PageMagic
   # class Driver - instances are factories for drivers used by PageMagic
   class Driver
     attr_reader :supported_browsers, :handler
+    # Creates a driver definition
+    # @example
+    #  Driver.new do |rack_application, options|
+    #    require 'capybara/driver_class'
+    #    Capybara::Driver::Class.new(app, options)
+    #  end
+    # @yield[rack_application, options, browser_name]
+    # @yieldparam [Object] rack_application rack compatible application
+    # @yieldparam [Hash] options hash containing driver specific options
+    # @yieldparam [Symbol] browser_name the name of the required browser name
+    # @param [*Symbol] supported_browsers list of browsers names. These are the names that
+    #  you will refer to them by when creating a session
+    # @yieldreturn [Object] Capybara compliant driver
     def initialize(*supported_browsers, &block)
       @handler = block
       @supported_browsers = supported_browsers
     end
 
+    # Determines if the given browser name is supported by this driver definition
+    # @param [Symbol] browser name of browser
+    # @return [Boolean] true if definition supports the given driver name
     def support?(browser)
       supported_browsers.include?(browser)
     end
 
+    # Build a new driver instance based on this definition
+    # @param [Object] app - rack compatible application
+    # @param [Symbol] browser name of required browser
+    # @param [Hash] options driver specific options
+    # @return [Object] Capybara compliant driver instance
     def build(app, browser:, options:{})
       handler.call(app, options, browser)
     end

data/lib/page_magic/drivers.rb

@@ -7,10 +7,14 @@ module PageMagic
       @all ||= []
     end
 
+    # Make a driver available for selection when creating calling {PageMagic.session}
+    # @param [Driver] driver driver definition
     def register(driver)
       all << driver
     end
 
+    # Find a driver definition based on its registered name
+    # @param [Symbol] browser registered name of the required browser
     def find(browser)
       all.find { |driver| driver.support?(browser) }
     end
@@ -27,6 +31,9 @@ module PageMagic
       end
     end
 
+    # returns true if this driver instance is equal to the supplied object
+    # @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
     end

data/lib/page_magic/element/selector_methods.rb

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

data/lib/page_magic/element.rb

@@ -8,13 +8,13 @@ module PageMagic
     EVENT_TYPES = [:set, :select, :select_option, :unselect_option, :click]
     DEFAULT_HOOK = proc {}.freeze
 
-    attr_reader :type, :name, :parent_page_element, :browser_element
+    attr_reader :type, :name, :parent_page_element
 
     include Elements, MethodObserver, SelectorMethods
     extend Elements, SelectorMethods
 
-    def initialize(name, parent_page_element, type: :element, selector: {}, browser_element: nil, &block)
-      @browser_element = browser_element
+    def initialize(name, parent_page_element, type: :element, selector: {}, prefetched_browser_element: nil, &block)
+      @browser_element = prefetched_browser_element
       @selector = selector
 
       @before_hook = DEFAULT_HOOK
@@ -26,29 +26,51 @@ module PageMagic
       expand(&block) if block
     end
 
+    # expand the element definition by evaluating the given block in the scope of this object
+    # @param [*Object] args list of arguments to be supplied to the given block
     def expand(*args, &block)
       instance_exec(*args, &block)
       self
     end
 
+    # @return [Boolean] returns true if this element contains helper methods or sub element definitions
     def section?
       !element_definitions.empty? || singleton_methods_added?
     end
 
+    # @return [Object] returns the overall of the parent page element. this will ultimately be the {Session} wrapping
+    #  Capybara session
     def session
       @parent_page_element.session
     end
 
-    def before(&block)
+    # Get/Sets the block of code to be run before an event is triggered on an element. See {EVENT_TYPES} for the list of
+    # events that this block will be triggered for. The block is run in the scope of the element object
+    def before_events(&block)
       return @before_hook unless block
       @before_hook = block
     end
 
-    def after(&block)
+    # Get/Sets the block of code to be run after an event is triggered on an element. See {EVENT_TYPES} for the list of
+    # events that this block will be triggered for. The block is run in the scope of the element object
+    def after_events(&block)
       return @after_hook unless block
       @after_hook = block
     end
 
+    # @return [Object] the Capybara browser element that this element definition is tied to.
+    def browser_element
+      return @browser_element if @browser_element
+
+      fail UndefinedSelectorException, 'Pass a locator/define one on the class' if selector.empty?
+
+      query = Query.find(type).build(query_selector, query_options)
+
+      @browser_element = parent_browser_element.find(*query).tap do |raw_element|
+        wrap_events(raw_element)
+      end
+    end
+
     def method_missing(method, *args, &block)
       ElementContext.new(self).send(method, args.first, &block)
     rescue ElementMissingException
@@ -64,22 +86,10 @@ module PageMagic
       super || element_context.respond_to?(*args) || browser_element.respond_to?(*args)
     end
 
-    def browser_element(*_args)
-      return @browser_element if @browser_element
-
-      fail UndefinedSelectorException, 'Pass a locator/define one on the class' if selector.empty?
-
-      query = Query.find(type).build(query_selector, query_options)
-
-      @browser_element = parent_browser_element.find(*query).tap do |raw_element|
-        wrap_events(raw_element)
-      end
-    end
-
     def ==(other)
       return false unless other.is_a?(Element)
-      this = [type, name, selector, before, after]
-      this == [other.type, other.name, other.selector, other.before, other.after]
+      this = [type, name, selector, before_events, after_events]
+      this == [other.type, other.name, other.selector, other.before_events, other.after_events]
     end
 
     private
@@ -101,8 +111,8 @@ module PageMagic
         next unless raw_element.respond_to?(action_method)
         apply_hooks(raw_element: raw_element,
                     capybara_method: action_method,
-                    before_hook: before,
-                    after_hook: after)
+                    before_hook: before_events,
+                    after_hook: after_events)
       end
     end
 

data/lib/page_magic/elements.rb

@@ -2,18 +2,29 @@ require 'active_support/inflector'
 module PageMagic
   # module Elements - contains methods that add element definitions to the objects it is mixed in to
   module Elements
+    # hooks for objects that inherit classes that include the Elements module
+    module InheritanceHooks
+      # Copies parent element definitions on to subclass
+      # @param [Class] clazz - inheritting class
+      def inherited(clazz)
+        clazz.element_definitions.merge!(element_definitions)
+      end
+    end
+
     INVALID_METHOD_NAME_MSG = 'a method already exists with this method name'
     TYPES = [:text_field, :button, :link, :checkbox, :select_list, :radios, :textarea]
 
     class << self
       def included(clazz)
-        def clazz.inherited(clazz)
-          clazz.element_definitions.merge!(element_definitions)
-        end
+        clazz.extend(InheritanceHooks)
       end
       alias_method :extended, :included
     end
 
+    # Get all {Element} definitions
+    # @param [Object] browser_element capybara browser element from which the definitions can be sourced
+    # @param [*Object] args argument to be passed to block used to expand the {Element} definitions
+    # @return [Array] list of {Element} defintions
     def elements(browser_element, *args)
       element_definitions.values.collect { |definition| definition.call(browser_element, *args) }
     end
@@ -54,7 +65,7 @@ module PageMagic
       name = compute_name(args, section_class)
 
       options = { type: __callee__ }
-      selector ? options[:selector] = selector : options[:browser_element] = args.delete_at(0)
+      selector ? options[:selector] = selector : options[:prefetched_browser_element] = args.delete_at(0)
 
       add_element_definition(name) do |parent_browser_element, *e_args|
         section_class.new(name, parent_browser_element, options).expand(*e_args, &block)
@@ -63,6 +74,8 @@ module PageMagic
 
     TYPES.each { |type| alias_method type, :element }
 
+    # @return [Hash] element definition names mapped to blocks that can be used to create unique instances of
+    #  and {Element} definitions
     def element_definitions
       @element_definitions ||= {}
     end

data/lib/page_magic/instance_methods.rb

@@ -12,23 +12,31 @@ module PageMagic
       @browser_element = browser
     end
 
+    # @return the current page title
     def title
       browser.title
     end
 
+    # check for the presense of specific text on the page
+    # @param [String] string the string to check for
+    # @return [Boolean]
     def text_on_page?(string)
       text.downcase.include?(string.downcase)
     end
 
+    # Visit this page based on the class level registered url
     def visit
       browser.visit self.class.url
-      self
+      execute_on_load
     end
 
+    # @return the page text
     def text
       browser.text
     end
 
+    # proxy to the defined page element definitions
+    # @return [Object] the result of accessing the requested page element through its definition
     def method_missing(method, *args)
       element_context.send(method, *args)
     end
@@ -37,10 +45,20 @@ module PageMagic
       super || element_context.respond_to?(*args)
     end
 
+    # @return [Array] class level defined element definitions
     def element_definitions
       self.class.element_definitions
     end
 
+    # executes block stored using {ClassMethods#on_load} against self
+    # @return [Element] self
+    def execute_on_load
+      instance_eval(&self.class.on_load)
+      self
+    end
+
+    private
+
     def element_context
       ElementContext.new(self)
     end

data/lib/page_magic/session.rb

@@ -4,6 +4,7 @@ module PageMagic
   class Session
     URL_MISSING_MSG = 'a path must be mapped or a url supplied'
     REGEXP_MAPPING_MSG = 'URL could not be derived because mapping is a Regexp'
+    INVALID_MAPPING_MSG = 'mapping must be a string or regexp'
 
     attr_reader :raw_session, :transitions
 
@@ -58,7 +59,7 @@ module PageMagic
       else
         fail InvalidURLException, URL_MISSING_MSG
       end
-      @current_page = page.new(self) if page
+      @current_page = page.new(self).execute_on_load if page
       self
     end
 
@@ -104,18 +105,16 @@ module PageMagic
 
     def find_mapped_page(path)
       mapping = transitions.keys.find do |key|
-        string_matches?(path, key)
+        matches?(path, key)
       end
       transitions[mapping]
     end
 
-    def string_matches?(string, matcher)
+    def matches?(string, matcher)
       if matcher.is_a?(Regexp)
         string =~ matcher
-      elsif matcher.is_a?(String)
-        string == matcher
       else
-        false
+        string == matcher
       end
     end
   end

data/lib/page_magic.rb

@@ -4,6 +4,7 @@ require 'page_magic/exceptions'
 require 'page_magic/session'
 require 'page_magic/instance_methods'
 require 'page_magic/elements'
+require 'page_magic/class_methods'
 require 'page_magic/element_context'
 require 'page_magic/element'
 require 'page_magic/drivers'
@@ -28,13 +29,8 @@ module PageMagic
 
     def included(clazz)
       clazz.class_eval do
-        def self.url(url = nil)
-          @url = url if url
-          @url
-        end
-
         include(InstanceMethods)
-        extend(Elements)
+        extend(Elements, ClassMethods)
       end
     end
   end

data/spec/element_spec.rb

@@ -39,7 +39,10 @@ module PageMagic
 
     describe '#respond_to?' do
       subject do
-        described_class.new(:name, Object.new, type: :element, browser_element: double(element_method: '')) do
+        described_class.new(:name,
+                            Object.new,
+                            type: :element,
+                            prefetched_browser_element: double(element_method: '')) do
           element :sub_element, css: '.sub-element'
         end
       end
@@ -59,6 +62,9 @@ module PageMagic
     describe '#browser_element' do
       let!(:browser) { double('browser') }
 
+      it 'calls the on_load hook' do
+      end
+
       context 'options supplied to selector' do
         it 'passes them on to the cappybara finder method' do
           options = { count: 1 }
@@ -112,7 +118,7 @@ module PageMagic
       end
 
       it 'should return a prefetched value' do
-        element = described_class.new(:help, page, type: :link, browser_element: :prefetched_object)
+        element = described_class.new(:help, page, type: :link, prefetched_browser_element: :prefetched_object)
         expect(element.browser_element).to eq(:prefetched_object)
       end
 
@@ -185,7 +191,7 @@ module PageMagic
     describe 'hooks' do
       subject do
         described_class.new(:my_button, page, type: :button, selector: { id: 'my_button' }) do
-          before do
+          before_events do
             call_in_before_hook
           end
         end
@@ -201,7 +207,7 @@ module PageMagic
       context 'method called in before hook' do
         subject do
           described_class.new(:my_button, page, type: :button, selector: { id: 'my_button' }) do
-            after do
+            after_events do
               call_in_after_hook
             end
           end

data/spec/page_magic/class_methods_spec.rb

@@ -0,0 +1,29 @@
+module PageMagic
+  describe ClassMethods do
+    subject do
+      Object.new.tap { |o| o.extend(described_class) }
+    end
+    describe '#url' do
+      it 'get/sets a value' do
+        subject.url(:url)
+        expect(subject.url).to eq(:url)
+      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
+      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
+      end
+    end
+  end
+end

data/spec/page_magic/elements_spec.rb

@@ -120,7 +120,10 @@ module PageMagic
       describe 'location' do
         context 'a prefetched object' do
           it 'should add a section' do
-            expected_section = Element.new(:page_section, parent_page_element, type: :element, browser_element: :object)
+            expected_section = Element.new(:page_section,
+                                           parent_page_element,
+                                           type: :element,
+                                           prefetched_browser_element: :object)
             page_elements.element :page_section, :object
             expect(expected_section).to eq(page_elements.elements(parent_page_element).first)
           end
@@ -130,7 +133,7 @@ module PageMagic
       describe 'session handle' do
         it 'should be on instances created from a class' do
           browser_element = double(:browser_element, find: :browser_element)
-          parent = double('parent', session: :current_session, browser_element: browser_element)
+          parent = double('parent', session: :current_session, prefetched_browser_element: browser_element)
           page_elements.element :page_section, selector
 
           section = page_elements.element_definitions[:page_section].call(parent)
@@ -141,7 +144,7 @@ module PageMagic
         it 'should be on instances created dynamically using the section method' do
           browser_element = double('browser_element')
           allow(browser_element).to receive(:find)
-          parent = double('parent', session: :current_session, browser_element: browser_element)
+          parent = double('parent', session: :current_session, prefetched_browser_element: browser_element)
 
           page_elements.element :page_section, css: :selector do
           end

data/spec/page_magic/instance_methods_spec.rb

@@ -1,13 +1,33 @@
 module PageMagic
   describe InstanceMethods do
     include_context :webapp_fixture
-    subject do
-      clazz = Class.new do
+
+    let(:page_class) do
+      Class.new do
         include PageMagic
         url '/page1'
         link(:next_page, text: 'next page')
       end
-      clazz.new.tap(&:visit)
+    end
+
+    subject do
+      page_class.new.tap(&:visit)
+    end
+
+    describe 'execute_on_load' do
+      it 'runs the on_load_hook in the context of self' do
+        instance = subject
+        page_class.on_load do
+          extend RSpec::Matchers
+          expect(self).to be(instance)
+        end
+
+        subject.execute_on_load
+      end
+
+      it 'returns self' do
+        expect(subject.execute_on_load).to be(subject)
+      end
     end
 
     context '#respond_to?' do
@@ -20,10 +40,15 @@ module PageMagic
       end
     end
 
-    describe 'visit' do
+    describe '#visit' do
       it 'goes to the class define url' do
         expect(subject.session.current_path).to eq('/page1')
       end
+
+      it 'runs the on load handler' do
+        expect(subject).to receive(:execute_on_load).and_call_original
+        subject.visit
+      end
     end
 
     describe 'session' do

data/spec/page_magic/session_spec.rb

@@ -77,34 +77,54 @@ 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)
+      end
+    end
+
     describe '#visit' do
       let(:session) do
         allow(browser).to receive(:visit)
         PageMagic::Session.new(browser, url)
       end
 
-      it 'sets the current page' do
-        session.define_page_mappings '/page' => page
-        session.visit(page)
-        expect(session.current_page).to be_a(page)
-      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
+        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
+        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
+
+        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
-      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
+        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
 

data/spec/spec_helper.rb

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

metadata

@@ -1,141 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: page_magic
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha18
+  version: 1.0.0.alpha19
 platform: ruby
 authors:
 - Leon Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: wait
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.34'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  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'
+        version: '0.34'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: Framework for modeling and interacting with webpages which wraps capybara
 email: info@lad-tech.com
 executables: []
@@ -158,6 +144,7 @@ files:
 - VERSION
 - circle.yml
 - lib/page_magic.rb
+- lib/page_magic/class_methods.rb
 - lib/page_magic/driver.rb
 - lib/page_magic/drivers.rb
 - lib/page_magic/drivers/poltergeist.rb
@@ -176,6 +163,7 @@ files:
 - page_magic.gemspec
 - 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