page_magic 1.0.0.alpha17 → 1.0.0.alpha18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6aee6a0833a50dbf849f13b2c7a4c3668feef1d
-  data.tar.gz: b4d0aecfbba7509a3ffb9e2bf08b38cb30f4cb64
+  metadata.gz: 57c321555c03ce3b8a6a43d895ffd657eca3c5ae
+  data.tar.gz: f656f163ed661b0b48ffbc5b2b2d30f5db777beb
 SHA512:
-  metadata.gz: 4437e58a2107ffcec212ee3778450b73f5384bc46581c78b53c8f28e2c69d3a5c42731c1a8356ff1c42e2ccdb7ba5b4af0c68c6de62477e34349729b9fbc13fd
-  data.tar.gz: 27e427b3fa2bc153836c545b24ef9ea3cf14e360eba3acc3f7fb932ff2c694a6262746735d60eb4752749f0c9cb335bf55c8ff82d4a4ea0f0fe0517f91e5df2d
+  metadata.gz: 4cd81bb246ed5a267265db1ab31d8861a772c9fa54ac000e0d5dd4ac9340a180a0c047876fe28bd2cbf3a58e29840b342f221c15f1f13564f6486dcc0b1e2806
+  data.tar.gz: 8957aa92ef4ae0dc088fed4d4bf7d13feae4118064b12270add171fe52f0fda423fa8787fcef5b1112b526171bc308676bdc2d9f40c79502da928250b1c8a3a1

data/.codeclimate.yml

@@ -0,0 +1,4 @@
+languages:
+   Ruby: true
+exclude_paths:
+- "spec/*"

data/.pullreview.yml

@@ -0,0 +1,14 @@
+---
+languages:
+ - ruby
+rules:
+  test_infection:
+    except:
+      - 'lib/page_magic/exceptions*'
+  missing_class_documentation:
+    except:
+      - 'lib/page_magic/element/query.rb'
+      - 'lib/page_magic/element/selector.rb'
+      - 'lib/page_magic/element/method_observer.rb'
+      - 'lib/page_magic/element.rb'
+      - 'lib/page_magic/session.rb'

data/.rubocop.yml

@@ -1,6 +1,3 @@
-Documentation:
-  Enabled: false
-
 Metrics/LineLength:
   Max: 120
 

data/.simplecov

@@ -1,3 +1,8 @@
+require 'pullreview/coverage'
+require "codeclimate-test-reporter"
+
+SimpleCov.formatters  = [SimpleCov::Formatter::HTMLFormatter,PullReview::Coverage::Formatter,CodeClimate::TestReporter::Formatter]
+
 SimpleCov.start do
   add_filter '/spec/'
 end

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+lib
+--markup-provider=redcarpet
+--markup=markdown
+--readme README.md

data/Gemfile

@@ -10,9 +10,15 @@ group :test do
   gem 'rspec', require: 'rspec/core/rake_task'
   gem 'simplecov', require: false
   gem 'poltergeist'
+  gem 'codeclimate-test-reporter', group: :test, require: nil
+  gem 'pullreview-coverage', require: false
 end
 
 group :development do
   gem 'jeweler'
   gem 'rubocop', require: 'rubocop/rake_task'
+  gem 'pry-byebug'
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'github-markup'
 end

data/Gemfile.lock

@@ -12,20 +12,29 @@ 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)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       xpath (~> 2.0)
+    certifi (2015.08.10)
     childprocess (0.3.9)
       ffi (~> 1.0, >= 1.0.11)
     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)
       multipart-post (~> 1.2.0)
     ffi (1.9.3)
     git (1.2.6)
+    github-markup (1.4.0)
     github_api (0.10.2)
       addressable
       faraday (~> 0.8.7)
@@ -48,10 +57,11 @@ 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)
     minitest (5.7.0)
-    multi_json (1.7.3)
+    multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
     nokogiri (1.6.0)
@@ -70,6 +80,16 @@ 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-protection (1.5.0)
       rack
@@ -79,6 +99,7 @@ GEM
     rake (10.2.2)
     rdoc (4.1.1)
       json (~> 1.4)
+    redcarpet (3.3.3)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
@@ -105,14 +126,16 @@ GEM
       multi_json (~> 1.0)
       rubyzip (< 1.0.0)
       websocket (~> 1.0.4)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     sinatra (1.4.3)
       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)
@@ -124,6 +147,7 @@ GEM
     websocket-driver (0.3.0)
     xpath (2.0.0)
       nokogiri (~> 1.3)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
@@ -131,11 +155,17 @@ PLATFORMS
 DEPENDENCIES
   activesupport
   capybara
+  codeclimate-test-reporter
+  github-markup
   jeweler
   poltergeist
+  pry-byebug
+  pullreview-coverage
+  redcarpet
   rspec
   rubocop
   simplecov
   sinatra
   wait
   watir-webdriver
+  yard

data/README.md

@@ -1,3 +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)
 #PageMagic
 PageMagic is an API for testing web applications. 
 
@@ -33,7 +34,7 @@ What we really want to write is something like
 ```ruby
 test_subject = send_test_mail('test@21st-century-mail.com')
 #Visit your site using a PageMagic session we prepared earlier
-session.visit(LoginPage, url: 'https://21st-century-mail.com')
+session.visit(LoginPage)
 
 #Login using some handy helper method on our page object
 session.login('username', 'password')
@@ -51,7 +52,7 @@ fail "message is still there!" if session.message(subject: test_subject).exists?
 ## 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)
+session = PageMagic.session(browser: :chrome, url: 'https://21st-century-mail.com')
 ```
 Out of the box, PageMagic knows how to work with:
 - Chrome and Firefox
@@ -196,7 +197,7 @@ end
 PageMagic.drivers.register Webkit
 
 #3. Use registered driver
-session = PageMagic.session(browser: webkit)
+session = PageMagic.session(browser: webkit, url: 'https://21st-century-mail.com')
 ```
 ##What else can you do with PageMagic?
 PageMagic has lots of other useful features. I'm writing up the documentation so check back here soon!

data/VERSION

@@ -1 +1 @@
-1.0.0.alpha17
+1.0.0.alpha18

data/circle.yml

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

data/lib/page_magic/driver.rb

@@ -1,4 +1,5 @@
 module PageMagic
+  # class Driver - instances are factories for drivers used by PageMagic
   class Driver
     attr_reader :supported_browsers, :handler
     def initialize(*supported_browsers, &block)

data/lib/page_magic/drivers/poltergeist.rb

@@ -1,8 +1,4 @@
-module PageMagic
-  class Drivers
-    Poltergeist = Driver.new(:poltergeist) do |app, options|
-      require 'capybara/poltergeist'
-      Capybara::Poltergeist::Driver.new(app, options)
-    end
-  end
+PageMagic::Drivers::Poltergeist = PageMagic::Driver.new(:poltergeist) do |app, options|
+  require 'capybara/poltergeist'
+  Capybara::Poltergeist::Driver.new(app, options)
 end

data/lib/page_magic/drivers/rack_test.rb

@@ -1,7 +1,3 @@
-module PageMagic
-  class Drivers
-    RackTest = Driver.new(:rack_test) do |app, options|
-      Capybara::RackTest::Driver.new(app, options)
-    end
-  end
+PageMagic::Drivers::RackTest = PageMagic::Driver.new(:rack_test) do |app, options|
+  Capybara::RackTest::Driver.new(app, options)
 end

data/lib/page_magic/drivers/selenium.rb

@@ -1,8 +1,4 @@
-module PageMagic
-  class Drivers
-    Selenium = Driver.new(:chrome, :firefox) do |app, options, browser|
-      require 'watir-webdriver'
-      Capybara::Selenium::Driver.new(app, options.dup.merge(browser: browser))
-    end
-  end
+PageMagic::Drivers::Selenium = PageMagic::Driver.new(:chrome, :firefox) do |app, options, browser|
+  require 'watir-webdriver'
+  Capybara::Selenium::Driver.new(app, options.dup.merge(browser: browser))
 end

data/lib/page_magic/drivers.rb

@@ -1,5 +1,7 @@
 require 'page_magic/driver'
 module PageMagic
+  # class Drivers - creates an object that can be used to hold driver definitions
+  # These PageMagic gets the user's chosen driver from this object.
   class Drivers
     def all
       @all ||= []
@@ -13,6 +15,8 @@ module PageMagic
       all.find { |driver| driver.support?(browser) }
     end
 
+    # Loads drivers defined in files at the given path
+    # @param [String] path where the drivers are located
     def load(path = "#{__dir__}/drivers")
       require 'active_support/inflector'
 

data/lib/page_magic/element/method_observer.rb

@@ -1,10 +1,17 @@
 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

data/lib/page_magic/element/query.rb

@@ -4,9 +4,11 @@ module PageMagic
     #  - requirements on element type
     #  - selection criteria, modeled through the Selector class
     #  - options
-
     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.downcase == type.to_s.downcase }
           return ELEMENT unless query
@@ -21,6 +23,10 @@ module PageMagic
         @type = type
       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)

data/lib/page_magic/element/selector.rb

@@ -3,6 +3,10 @@ module PageMagic
     # class Selector - models the selection criteria understood by Capybara
     class Selector
       class << self
+        # Find a Selecor using it's name
+        # @param [Symbol] name the name of the required Selector in snakecase format. See class constants for available
+        #  selectors
+        # @return [Selector] returns the predefined selector with the given name
         def find(name)
           selector = constants.find { |constant| constant.to_s.downcase == name.to_s.downcase }
           fail UnsupportedCriteriaException unless selector
@@ -10,6 +14,9 @@ module PageMagic
         end
       end
 
+      # Build selector query parameters for Capybara's find method
+      # @param [Symbol] element_type the type of browser element being found. e.g :link
+      # @param [Hash] locator the selection method and its parameter. E.g. text: 'click me'
       def build(element_type, locator)
         [].tap do |array|
           array << element_type if supports_type

data/lib/page_magic/element/selector_methods.rb

@@ -1,5 +1,6 @@
 module PageMagic
   class Element
+    # module SelectorMethods - adds method for getting and setting an element selector
     module SelectorMethods
       def selector(selector = nil)
         return @selector unless selector

data/lib/page_magic/element.rb

@@ -3,19 +3,15 @@ require 'page_magic/element/selector_methods'
 require 'page_magic/element/selector'
 require 'page_magic/element/query'
 module PageMagic
+  # class Element - represents an element in a html page.
   class Element
     EVENT_TYPES = [:set, :select, :select_option, :unselect_option, :click]
     DEFAULT_HOOK = proc {}.freeze
+
     attr_reader :type, :name, :parent_page_element, :browser_element
 
     include Elements, MethodObserver, SelectorMethods
-    extend SelectorMethods
-
-    class << self
-      def inherited(clazz)
-        clazz.extend(Elements)
-      end
-    end
+    extend Elements, SelectorMethods
 
     def initialize(name, parent_page_element, type: :element, selector: {}, browser_element: nil, &block)
       @browser_element = browser_element
@@ -26,6 +22,7 @@ module PageMagic
       @parent_page_element = parent_page_element
       @type = type
       @name = name.to_s.downcase.to_sym
+      @element_definitions = self.class.element_definitions.dup
       expand(&block) if block
     end
 
@@ -53,7 +50,7 @@ module PageMagic
     end
 
     def method_missing(method, *args, &block)
-      ElementContext.new(self, browser_element, self, *args).send(method, args.first, &block)
+      ElementContext.new(self).send(method, args.first, &block)
     rescue ElementMissingException
       begin
         return browser_element.send(method, *args, &block) if browser_element.respond_to?(method)
@@ -74,7 +71,7 @@ module PageMagic
 
       query = Query.find(type).build(query_selector, query_options)
 
-      @browser_element = parent_browser_element.send(:find, *query).tap do |raw_element|
+      @browser_element = parent_browser_element.find(*query).tap do |raw_element|
         wrap_events(raw_element)
       end
     end
@@ -95,8 +92,8 @@ module PageMagic
       selector.dup.delete_if { |key, _value| key == selector.keys.first }
     end
 
-    def element_context(*args)
-      ElementContext.new(self, @browser_element, self, *args)
+    def element_context
+      ElementContext.new(self)
     end
 
     def wrap_events(raw_element)

data/lib/page_magic/element_context.rb

@@ -1,17 +1,13 @@
 module PageMagic
-  class ElementMissingException < Exception
-  end
-
+  # class ElementContext - resolves which element definition to use when accessing the browser.
   class ElementContext
-    EVENT_TYPES = [:set, :select, :select_option, :unselect_option, :click]
-
-    attr_reader :caller, :page_element
+    attr_reader :page_element
 
-    def initialize(page_element, caller, *_args)
+    def initialize(page_element)
       @page_element = page_element
-      @caller = caller
     end
 
+    # acts as proxy to element defintions defined on @page_element
     def method_missing(method, *args, &block)
       return page_element.send(method, *args, &block) if page_element.methods.include?(method)
 

data/lib/page_magic/elements.rb

@@ -1,28 +1,51 @@
 require 'active_support/inflector'
 module PageMagic
+  # module Elements - contains methods that add element definitions to the objects it is mixed in to
   module Elements
     INVALID_METHOD_NAME_MSG = 'a method already exists with this method name'
+    TYPES = [:text_field, :button, :link, :checkbox, :select_list, :radios, :textarea]
 
-    module InstanceOnlyMethods
-      def element_definitions
-        self.class.element_definitions
-      end
-    end
-
-    def self.extended(clazz)
-      clazz.class_eval do
-        include InstanceOnlyMethods
+    class << self
+      def included(clazz)
+        def clazz.inherited(clazz)
+          clazz.element_definitions.merge!(element_definitions)
+        end
       end
-    end
-
-    def method_added(method)
-      fail InvalidMethodNameException, 'method name matches element name' if element_definitions[method]
+      alias_method :extended, :included
     end
 
     def elements(browser_element, *args)
       element_definitions.values.collect { |definition| definition.call(browser_element, *args) }
     end
 
+    # Creates an element defintion.
+    # Element defintions contain specifications for locating them and other sub elements.
+    # if a block is specified then it will be executed against the element defintion.
+    # This method is aliased to each of the names specified in {TYPES TYPES}
+    # @example
+    #   element :widget, id: 'widget' do
+    #     link :next, text: 'next'
+    #   end
+    # @overload element(name, selector, &block)
+    #  @param [Symbol] name the name of the element.
+    #  @param [Hash] selector a key value pair defining the method for locating this element
+    #  @option selector [String] :text text contained within the element
+    #  @option selector [String] :css css selector
+    #  @option selector [String] :id the id of the element
+    #  @option selector [String] :name the value of the name attribute belonging to the element
+    #  @option selector [String] :label value of the label tied to the require field
+    # @overload element(element_class, &block)
+    #  @param [ElementClass] element_class a custom class of element that inherits {Element}.
+    #   the name of the element is derived from the class name. the Class name coverted to snakecase.
+    #   The selector must be defined on the class itself.
+    # @overload element(name, element_class, &block)
+    #  @param [Symbol] name the name of the element.
+    #  @param [ElementClass] element_class a custom class of element that inherits {Element}.
+    #   The selector must be defined on the class itself.
+    # @overload element(name, element_class, selector, &block)
+    #  @param [Symbol] name the name of the element.
+    #  @param [ElementClass] element_class a custom class of element that inherits {Element}.
+    #  @param [Hash] selector a key value pair defining the method for locating this element. See above for details
     def element(*args, &block)
       block ||= proc {}
 
@@ -38,10 +61,14 @@ module PageMagic
       end
     end
 
-    TYPES = [:text_field, :button, :link, :checkbox, :select_list, :radios, :textarea]
-
     TYPES.each { |type| alias_method type, :element }
 
+    def element_definitions
+      @element_definitions ||= {}
+    end
+
+    private
+
     def add_element_definition(name, &block)
       fail InvalidElementNameException, 'duplicate page element defined' if element_definitions[name]
 
@@ -51,12 +78,10 @@ module PageMagic
       element_definitions[name] = block
     end
 
-    def element_definitions
-      @element_definitions ||= {}
+    def method_added(method)
+      fail InvalidMethodNameException, 'method name matches element name' if element_definitions[method]
     end
 
-    private
-
     def remove_argument(args, clazz)
       argument = args.find { |arg| arg.is_a?(clazz) }
       args.delete(argument)

data/lib/page_magic/exceptions.rb

@@ -1,10 +1,8 @@
 module PageMagic
   class UnsupportedSelectorException < Exception
   end
-  class UndefinedSelectorException < Exception
-  end
 
-  class MissingLocatorOrSelector < Exception
+  class UndefinedSelectorException < Exception
   end
 
   class InvalidElementNameException < Exception
@@ -15,4 +13,13 @@ module PageMagic
 
   class UnsupportedCriteriaException < Exception
   end
+
+  class ElementMissingException < Exception
+  end
+
+  class InvalidURLException < Exception
+  end
+
+  class UnspportedBrowserException < Exception
+  end
 end

data/lib/page_magic/instance_methods.rb

@@ -0,0 +1,48 @@
+module PageMagic
+  # module InstanceMethods - provides instance level methods for page objects
+  module InstanceMethods
+    attr_reader :browser, :session, :browser_element
+
+    # Creates a new instance
+    # @param [Session] session session that provides gateway to the browser throw the users chosen browser
+    def initialize(session = Session.new(Capybara.current_session))
+      @browser = session.raw_session
+      @session = session
+
+      @browser_element = browser
+    end
+
+    def title
+      browser.title
+    end
+
+    def text_on_page?(string)
+      text.downcase.include?(string.downcase)
+    end
+
+    def visit
+      browser.visit self.class.url
+      self
+    end
+
+    def text
+      browser.text
+    end
+
+    def method_missing(method, *args)
+      element_context.send(method, *args)
+    end
+
+    def respond_to?(*args)
+      super || element_context.respond_to?(*args)
+    end
+
+    def element_definitions
+      self.class.element_definitions
+    end
+
+    def element_context
+      ElementContext.new(self)
+    end
+  end
+end

data/lib/page_magic/session.rb

@@ -1,30 +1,54 @@
 require 'wait'
 module PageMagic
-  class InvalidURLException < Exception
-  end
-
+  # class Session - coordinates access to the browser though page objects.
   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'
 
     attr_reader :raw_session, :transitions
 
-    def initialize(browser, url = nil)
-      @raw_session = browser
-      raw_session.visit(url) if url
+    # Create a new session instance
+    # @param [Object] capybara_session an instance of a capybara session
+    # @param [String] url url to start the session at.
+    def initialize(capybara_session, url = nil)
+      @raw_session = capybara_session
+      visit(url: url) if url
       @transitions = {}
     end
 
+    # Map paths to Page classes. The session will auto load page objects from these mapping when
+    # the {Session#current_path}
+    # is matched.
+    # @example
+    #   self.define_page_mappings '/' => HomePage, %r{/messages/d+}
+    # @param [Hash] transitions - paths mapped to page classes
+    # @option transitions [String] path as literal
+    # @option transitions [Regexp] path as a regexp for dynamic matching.
     def define_page_mappings(transitions)
       @transitions = transitions
     end
 
+    # @return [Object] returns page object representing the currently loaded page on the browser. If no mapping
+    # is found then nil returned
     def current_page
       mapping = find_mapped_page(current_path)
       @current_page = mapping.new(self) if mapping
       @current_page
     end
 
+    # Direct the browser to the given page or url. {Session#current_page} will be set be an instance of the given/mapped
+    # page class
+    # @overload visit(page: page_object)
+    #  @param [Object] page page class. The required url will be generated using the session's base url and the mapped
+    #   path
+    # @overload visit(url: url)
+    #  @param [String] url url to be visited.
+    # @overload visit(page: page_class, url: url)
+    #  @param [String] url url to be visited.
+    #  @param [Object] page the supplied page class will be instantiated to be used against the given url.
+    # @raise [InvalidURLException] if a page is supplied and there isn't a mapped path for it
+    # @raise [InvalidURLException] if neither a page or url are supplied
+    # @raise [InvalidURLException] if the mapped path for a page is a Regexp
     def visit(page = nil, url: nil)
       if url
         raw_session.visit(url)
@@ -38,33 +62,46 @@ module PageMagic
       self
     end
 
-    def url(base_url, path)
-      path = path.sub(%r{^/}, '')
-      base_url = base_url.sub(%r{/$}, '')
-      "#{base_url}/#{path}"
-    end
-
+    # @return [String] path in the browser
     def current_path
       raw_session.current_path
     end
 
+    # @return [String] full url in the browser
     def current_url
       raw_session.current_url
     end
 
+    # Wait until a the supplied block returns true
+    # @example
+    #   wait_until do
+    #     (rand % 2) == 0
+    #   end
     def wait_until(&block)
       @wait ||= Wait.new
       @wait.until(&block)
     end
 
+    # proxies unknown method calls to the currently loaded page object
+    # @return [Object] returned object from the page object method call
     def method_missing(name, *args, &block)
       current_page.send(name, *args, &block)
     end
 
+    # @param args see {::Object#respond_to?}
+    # @return [Boolean] true if self or the current page object responds to the give method name
     def respond_to?(*args)
       super || current_page.respond_to?(*args)
     end
 
+    private
+
+    def url(base_url, path)
+      path = path.sub(%r{^/}, '')
+      base_url = base_url.sub(%r{/$}, '')
+      "#{base_url}/#{path}"
+    end
+
     def find_mapped_page(path)
       mapping = transitions.keys.find do |key|
         string_matches?(path, key)
@@ -72,8 +109,6 @@ module PageMagic
       transitions[mapping]
     end
 
-    private
-
     def string_matches?(string, matcher)
       if matcher.is_a?(Regexp)
         string =~ matcher

data/lib/page_magic.rb

@@ -2,26 +2,14 @@ $LOAD_PATH.unshift("#{File.dirname(__FILE__)}")
 require 'capybara'
 require 'page_magic/exceptions'
 require 'page_magic/session'
+require 'page_magic/instance_methods'
 require 'page_magic/elements'
 require 'page_magic/element_context'
 require 'page_magic/element'
-require 'page_magic/page_magic'
 require 'page_magic/drivers'
 
+# module PageMagic - PageMagic is an api for modelling pages in a website.
 module PageMagic
-  class UnspportedBrowserException < Exception; end
-
-  module ClassMethods
-    def url(url = nil)
-      @url = url if url
-      @url
-    end
-
-    def inherited(clazz)
-      clazz.element_definitions.merge!(element_definitions)
-    end
-  end
-
   class << self
     def drivers
       @drivers ||= Drivers.new.tap(&:load)
@@ -39,7 +27,15 @@ module PageMagic
     end
 
     def included(clazz)
-      clazz.extend(Elements, ClassMethods)
+      clazz.class_eval do
+        def self.url(url = nil)
+          @url = url if url
+          @url
+        end
+
+        include(InstanceMethods)
+        extend(Elements)
+      end
     end
   end
 end

data/spec/page_magic/drivers/poltergeist_spec.rb

@@ -1,11 +1,9 @@
 require 'page_magic/drivers/poltergeist'
 module PageMagic
-  class Drivers
-    describe Poltergeist do
-      it "is capybara's poltergeist driver" do
-        driver = described_class.build(:app, browser: :poltergeist, options: {})
-        expect(driver).to be_a(Capybara::Poltergeist::Driver)
-      end
+  describe Drivers::Poltergeist do
+    it "is capybara's poltergeist driver" do
+      driver = described_class.build(:app, browser: :poltergeist, options: {})
+      expect(driver).to be_a(Capybara::Poltergeist::Driver)
     end
   end
 end

data/spec/page_magic/drivers/selenium_spec.rb

@@ -1,18 +1,16 @@
 require 'page_magic/drivers/selenium'
 module PageMagic
-  class Drivers
-    describe Selenium do
-      subject do
-        described_class.build(:app, browser: :selenium, options: {})
-      end
+  describe Drivers::Selenium do
+    subject do
+      described_class.build(:app, browser: :selenium, options: {})
+    end
 
-      it 'is selenium' do
-        expect(subject).to be_a(Capybara::Selenium::Driver)
-      end
+    it 'is selenium' do
+      expect(subject).to be_a(Capybara::Selenium::Driver)
+    end
 
-      it 'sets the browser option' do
-        expect(subject.options[:browser]).to be(:selenium)
-      end
+    it 'sets the browser option' do
+      expect(subject.options[:browser]).to be(:selenium)
     end
   end
 end

data/spec/page_magic/drivers_spec.rb

@@ -1,5 +1,4 @@
 require 'page_magic/drivers'
-
 module PageMagic
   describe Drivers do
     subject { described_class.new }

data/spec/page_magic/element_context_spec.rb

@@ -21,13 +21,13 @@ module PageMagic
 
       context 'neither a method or page element are defined' do
         it 'raises an error' do
-          expect { described_class.new(page, page.browser, self).missing_thing }.to raise_error ElementMissingException
+          expect { described_class.new(page).missing_thing }.to raise_error ElementMissingException
         end
       end
 
       context 'method is a element defintion' do
         it 'returns the sub page element' do
-          element = described_class.new(page, page.browser, self).a_link
+          element = described_class.new(page).a_link
           # TODO: - returns the capybara object. maybe we should think about wrapping this.
           expect(element.text).to eq('a link')
         end
@@ -39,7 +39,7 @@ module PageMagic
             end
           end
 
-          described_class.new(page, page.browser, self).a_link
+          described_class.new(page).a_link
         end
       end
 
@@ -51,14 +51,14 @@ module PageMagic
             end
           end
 
-          expect(described_class.new(page, :browser, self).page_method).to eq(:called)
+          expect(described_class.new(page).page_method).to eq(:called)
         end
       end
     end
 
     describe '#respond_to?' do
       subject do
-        described_class.new(elements_page.new(session), session, self)
+        described_class.new(elements_page.new(session))
       end
       it 'checks against the names of the elements passed in' do
         expect(subject.respond_to?(:a_link)).to eq(true)

data/spec/page_magic/instance_methods_spec.rb

@@ -0,0 +1,63 @@
+module PageMagic
+  describe InstanceMethods do
+    include_context :webapp_fixture
+    subject do
+      clazz = Class.new do
+        include PageMagic
+        url '/page1'
+        link(:next_page, text: 'next page')
+      end
+      clazz.new.tap(&:visit)
+    end
+
+    context '#respond_to?' do
+      it 'checks self' do
+        expect(subject.respond_to?(:visit)).to eq(true)
+      end
+
+      it 'checks the current page' do
+        expect(subject.respond_to?(:next_page)).to eq(true)
+      end
+    end
+
+    describe 'visit' do
+      it 'goes to the class define url' do
+        expect(subject.session.current_path).to eq('/page1')
+      end
+    end
+
+    describe 'session' do
+      it 'gives access to the page magic object wrapping the user session' do
+        expect(subject.session.raw_session).to be(Capybara.current_session)
+      end
+    end
+
+    describe 'text_on_page?' do
+      it 'returns true if the text is present' do
+        expect(subject.text_on_page?('next page')).to eq(true)
+      end
+
+      it 'returns false if the text is not present' do
+        expect(subject.text_on_page?('not on page')).to eq(false)
+      end
+    end
+
+    describe 'title' do
+      it 'returns the title' do
+        expect(subject.title).to eq('page1')
+      end
+    end
+
+    describe 'text' do
+      it 'returns the text on the page' do
+        expect(subject.text).to eq('next page')
+      end
+    end
+
+    describe 'method_missing' do
+      it 'gives access to the elements defined on your page classes' do
+        expect(subject.next_page.tag_name).to eq('a')
+      end
+    end
+  end
+end

data/spec/page_magic/session_spec.rb

@@ -61,18 +61,18 @@ module PageMagic
 
       context 'mapping is string' do
         it 'returns the page class' do
-          expect(subject.find_mapped_page('/page')).to be(:mapped_page_using_string)
+          expect(subject.instance_eval { find_mapped_page('/page') }).to be(:mapped_page_using_string)
         end
       end
       context 'mapping is regex' do
         it 'returns the page class' do
-          expect(subject.find_mapped_page('/page2')).to be(:mapped_page_using_regex)
+          expect(subject.instance_eval { find_mapped_page('/page2') }).to be(:mapped_page_using_regex)
         end
       end
 
       context 'mapping is not found' do
         it 'returns nil' do
-          expect(subject.find_mapped_page('/fake_page')).to be(nil)
+          expect(subject.instance_eval { find_mapped_page('/fake_page') }).to be(nil)
         end
       end
     end
@@ -129,13 +129,13 @@ module PageMagic
 
         context 'path has / at the beginning' do
           it 'produces compound url' do
-            expect(subject.url(base_url, path)).to eq(expected_url)
+            expect(subject.send(:url, base_url, path)).to eq(expected_url)
           end
         end
 
         context 'path does not have / at the beginning' do
           it 'produces compound url' do
-            expect(subject.url(base_url, "/#{path}")).to eq(expected_url)
+            expect(subject.send(:url, base_url, "/#{path}")).to eq(expected_url)
           end
         end
       end
@@ -143,13 +143,13 @@ module PageMagic
       context 'current_url does not have a / on the end' do
         context 'path has / at the beginning' do
           it 'produces compound url' do
-            expect(subject.url(base_url, "/#{path}")).to eq(expected_url)
+            expect(subject.send(:url, base_url, "/#{path}")).to eq(expected_url)
           end
         end
 
         context 'path does not have / at the beginning' do
           it 'produces compound url' do
-            expect(subject.url(base_url, path)).to eq(expected_url)
+            expect(subject.send(:url, base_url, path)).to eq(expected_url)
           end
         end
       end

data/spec/spec_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_magic
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha17
+  version: 1.0.0.alpha18
 platform: ruby
 authors:
 - Leon Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -80,6 +80,62 @@ dependencies:
     - - ">="
       - !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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  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'
 description: Framework for modeling and interacting with webpages which wraps capybara
 email: info@lad-tech.com
 executables: []
@@ -87,16 +143,20 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".codeclimate.yml"
+- ".pullreview.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".simplecov"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - VERSION
+- circle.yml
 - lib/page_magic.rb
 - lib/page_magic/driver.rb
 - lib/page_magic/drivers.rb
@@ -111,7 +171,7 @@ files:
 - lib/page_magic/element_context.rb
 - lib/page_magic/elements.rb
 - lib/page_magic/exceptions.rb
-- lib/page_magic/page_magic.rb
+- lib/page_magic/instance_methods.rb
 - lib/page_magic/session.rb
 - page_magic.gemspec
 - spec/element_spec.rb
@@ -125,7 +185,7 @@ files:
 - spec/page_magic/element/selector_spec.rb
 - spec/page_magic/element_context_spec.rb
 - spec/page_magic/elements_spec.rb
-- spec/page_magic/page_magic_spec.rb
+- spec/page_magic/instance_methods_spec.rb
 - spec/page_magic/session_spec.rb
 - spec/page_magic_spec.rb
 - spec/spec_helper.rb

data/lib/page_magic/page_magic.rb

@@ -1,40 +0,0 @@
-module PageMagic
-  attr_reader :browser, :session, :browser_element
-
-  def initialize(session = Session.new(Capybara.current_session), &block)
-    @browser = session.raw_session
-    @session = session
-
-    @browser_element = browser
-    block.call browser if block
-  end
-
-  def title
-    browser.title
-  end
-
-  def text_on_page?(string)
-    text.downcase.include?(string.downcase)
-  end
-
-  def visit
-    browser.visit self.class.url
-    self
-  end
-
-  def text
-    browser.text
-  end
-
-  def method_missing(method, *args)
-    element_context.send(method, *args)
-  end
-
-  def respond_to?(*args)
-    super || element_context.respond_to?(*args)
-  end
-
-  def element_context
-    ElementContext.new(self, self)
-  end
-end

data/spec/page_magic/page_magic_spec.rb

@@ -1,62 +0,0 @@
-describe PageMagic do
-  include_context :webapp_fixture
-  subject do
-    described_class = described_class()
-    page_class = Class.new do
-      include described_class
-      url '/page1'
-      link(:next_page, text: 'next page')
-    end
-    page_class.new.tap(&:visit)
-  end
-
-  context '#respond_to?' do
-    it 'checks self' do
-      expect(subject.respond_to?(:visit)).to eq(true)
-    end
-
-    it 'checks the current page' do
-      expect(subject.respond_to?(:next_page)).to eq(true)
-    end
-  end
-
-  describe 'visit' do
-    it 'goes to the class define url' do
-      expect(subject.session.current_path).to eq('/page1')
-    end
-  end
-
-  describe 'session' do
-    it 'gives access to the page magic object wrapping the user session' do
-      expect(subject.session.raw_session).to be(Capybara.current_session)
-    end
-  end
-
-  describe 'text_on_page?' do
-    it 'returns true if the text is present' do
-      expect(subject.text_on_page?('next page')).to eq(true)
-    end
-
-    it 'returns false if the text is not present' do
-      expect(subject.text_on_page?('not on page')). to eq(false)
-    end
-  end
-
-  describe 'title' do
-    it 'returns the title' do
-      expect(subject.title).to eq('page1')
-    end
-  end
-
-  describe 'text' do
-    it 'returns the text on the page' do
-      expect(subject.text).to eq('next page')
-    end
-  end
-
-  describe 'method_missing' do
-    it 'gives access to the elements defined on your page classes' do
-      expect(subject.next_page.tag_name).to eq('a')
-    end
-  end
-end