page_magic 0.8.9 → 0.9.4

data/VERSION

@@ -1 +1 @@
-0.8.9
+0.9.4

data/lib/page_magic/browser.rb

@@ -1,16 +1,18 @@
 module PageMagic
   module Browser
     class << self
-      attr_reader :browser
-      attr_accessor :session
+      def session
+        @session ||= PageMagic.session(default)
+      end
 
-      def use browser
-        @browser = browser
+      def default default=nil
+        return (@default || :firefox) unless default
+        @default = default
       end
     end
 
     def browser
-      Browser.session ||= PageMagic.session(Browser.browser || :chrome)
+      Browser.session
     end
   end
 end

data/lib/page_magic/{page_element.rb → element.rb}

@@ -5,18 +5,13 @@ module PageMagic
 
   end
 
-  class PageElement
+  class Element
 
     class MissingLocatorOrSelector < Exception
     end
 
-    include PageElements
     include AjaxSupport
 
-    module ::Watir
-      SelectList = Select
-    end
-
     attr_reader :type, :name, :selector, :before_hook, :after_hook, :browser_element, :locator
 
     class << self
@@ -88,7 +83,7 @@ module PageMagic
 
 
     def == page_element
-      page_element.is_a?(PageElement) &&
+      page_element.is_a?(Element) &&
           @type == page_element.type &&
           @name == page_element.name &&
           @selector == page_element.selector

data/lib/page_magic/element_context.rb

@@ -37,7 +37,7 @@ module PageMagic
 
       result = element_locator.locate
 
-      return element_locator if element_locator.class.is_a? PageSection
+      return element_locator if element_locator.class.is_a? Section
 
       [:set, :select_option, :unselect_option, :click].each do |action_method|
         apply_hooks(page_element: result,

data/lib/page_magic/{page_elements.rb → elements.rb}

@@ -1,5 +1,5 @@
 module PageMagic
-  module PageElements
+  module Elements
     class InvalidElementNameException < Exception
     end
 
@@ -17,7 +17,6 @@ module PageMagic
         def element_definitions
           self.class.element_definitions
         end
-
       end
     end
 
@@ -26,7 +25,6 @@ module PageMagic
     end
 
 
-
     def elements(browser_element, *args)
       element_definitions.values.collect { |definition| definition.call(browser_element, *args) }
     end
@@ -35,16 +33,16 @@ module PageMagic
       !element_definitions.empty?
     end
 
-    ELEMENT_TYPES = [:element, :text_field, :button, :link, :checkbox, :select_list, :radios, :textarea]
-    ELEMENT_TYPES.each do |field|
+    TYPES = [:element, :text_field, :button, :link, :checkbox, :select_list, :radios, :textarea]
+    TYPES.each do |field|
       define_method field do |*args, &block|
         name, selector = args
         add_element_definition(name) do |browser_element|
           case selector
             when Hash, NilClass
-              PageElement.new(name, browser_element, field, selector, &block)
+              Element.new(name, browser_element, field, selector, &block)
             else
-              PageElement.new(name, selector, field, nil, &block)
+              Element.new(name, selector, field, nil, &block)
           end
 
         end
@@ -58,7 +56,7 @@ module PageMagic
 
           add_element_definition(name) do |parent_browser_element, *args_for_section|
             page_section = Class.new do
-              extend PageMagic::PageSection
+              extend PageMagic::Section
             end
 
             page_section.parent_browser_element = parent_browser_element.browser_element

data/lib/page_magic/{page_section.rb → section.rb}

@@ -1,5 +1,5 @@
 module PageMagic
-  module PageSection
+  module Section
 
     module Location
       def locate_in browser_element, selector
@@ -20,7 +20,7 @@ module PageMagic
 
     class << self
       def extended clazz
-        clazz.extend(PageElements)
+        clazz.extend(Elements)
         clazz.class_eval do
           attr_reader :name, :selector
           class << self

data/lib/page_magic/session.rb

@@ -1,10 +1,9 @@
+require 'wait'
 module PageMagic
   class Session
     attr_reader :browser
     attr_accessor :current_page
 
-    include WaitUntil
-
     def initialize browser
       @browser = browser
     end
@@ -15,10 +14,19 @@ module PageMagic
       self
     end
 
+    def current_url
+      @browser.current_url
+    end
+
     def move_to page_class
       page_class = eval(page_class) if page_class.is_a?(String)
       @current_page = page_class.new self
-      wait.until { browser.current_url == page_class.url }
+      wait_until { browser.current_url == page_class.url }
+    end
+
+    def wait_until &block
+      @wait ||= Wait.new
+      @wait.until &block
     end
 
     def method_missing name, *args, &block

data/lib/page_magic.rb

@@ -1,15 +1,13 @@
 $LOAD_PATH.unshift("#{File.dirname(__FILE__)}")
 require 'capybara'
-require 'wait'
-require 'page_magic/wait'
 require 'page_magic/browser'
 require 'page_magic/session'
 require 'page_magic/ajax_support'
-require 'page_magic/page_elements'
+require 'page_magic/elements'
 require 'page_magic/element_context'
-require 'page_magic/page_element'
+require 'page_magic/element'
 require 'page_magic/page_magic'
-require 'page_magic/page_section'
+require 'page_magic/section'
 
 module PageMagic
   class << self
@@ -45,29 +43,25 @@ module PageMagic
     end
 
     def included clazz
-      clazz.extend ClassMethods, PageElements
+      clazz.extend Elements
       pages << clazz if clazz.is_a? Class
 
-      def clazz.url url=nil
-        @url = url if url
-        @url
+      class << clazz
+        def url url=nil
+          @url = url if url
+          @url
+        end
+
+        def inherited clazz
+          clazz.element_definitions.merge!(element_definitions)
+          PageMagic.pages << clazz
+        end
       end
+
     end
 
     def pages
       @pages||=[]
     end
   end
-
-  module ClassMethods
-    def included clazz
-      clazz.instance_eval { include PageMagic }
-      clazz.element_definitions.merge!(element_definitions)
-    end
-
-    def method_missing method_name, *args
-      raise "You can only instantiate child pages" if method_name == :new
-      super
-    end
-  end
 end

data/page_magic.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "page_magic"
-  s.version = "0.8.9"
+  s.version = "0.9.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leon Davis"]
-  s.date = "2013-11-13"
+  s.date = "2013-11-17"
   s.description = "Framework for modeling and interacting with webpages which wraps capybara"
   s.email = "info@lad-tech.com"
   s.extra_rdoc_files = [
@@ -27,30 +27,28 @@ Gem::Specification.new do |s|
     "lib/page_magic.rb",
     "lib/page_magic/ajax_support.rb",
     "lib/page_magic/browser.rb",
+    "lib/page_magic/element.rb",
     "lib/page_magic/element_context.rb",
-    "lib/page_magic/page_element.rb",
-    "lib/page_magic/page_elements.rb",
+    "lib/page_magic/elements.rb",
     "lib/page_magic/page_magic.rb",
-    "lib/page_magic/page_section.rb",
+    "lib/page_magic/section.rb",
     "lib/page_magic/session.rb",
-    "lib/page_magic/wait.rb",
     "page_magic.gemspec",
     "spec/browser_spec.rb",
     "spec/element_context_spec.rb",
-    "spec/helpers.rb",
+    "spec/element_spec.rb",
+    "spec/elements_spec.rb",
     "spec/helpers/capybara.rb",
     "spec/member_methods_spec.rb",
-    "spec/page_element_spec.rb",
-    "spec/page_elements_spec.rb",
     "spec/page_magic_spec.rb",
-    "spec/page_section_spec.rb",
+    "spec/section_spec.rb",
     "spec/session_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "https://github.com/ladtech/page_magic"
   s.licenses = ["ruby"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.25"
   s.summary = "Framework for modeling and interacting with webpages"
 
   if s.respond_to? :specification_version then

data/spec/browser_spec.rb

@@ -4,29 +4,33 @@ describe PageMagic::Browser do
   let(:app) { Object.new }
 
   before do
-    PageMagic::Browser.session = nil
+    PageMagic::Browser.instance_variable_set(:@session, nil)
     app.extend PageMagic::Browser
   end
 
-  describe 'page' do
-    it 'should return the existing session' do
-      session = double(:session)
-      PageMagic::Browser.session = session
+  describe 'default' do
+    it 'should be firefox' do
+      PageMagic::Browser.default.should == :firefox
+    end
+  end
 
-      app.browser.should == session
+  describe 'browser' do
+    it 'should return the existing session' do
+      session_instance = app.browser
+      app.browser.should == session_instance
     end
 
     it 'should create a session if not already set' do
       new_session = double(:new_session)
 
-      PageMagic.should_receive(:session).with(:chrome).and_return new_session
+      PageMagic.should_receive(:session).with(:firefox).and_return new_session
       app.browser.should == new_session
     end
 
     it 'should use custom browser' do
-      PageMagic::Browser.use :firefox
+      PageMagic.should_receive(:session).with(:custom_browser)
 
-      PageMagic.should_receive(:session).with(:firefox)
+      PageMagic::Browser.default :custom_browser
       app.browser
     end
   end

data/spec/{page_element_spec.rb → element_spec.rb}

@@ -29,51 +29,51 @@ describe 'Page elements' do
     end
 
     it 'should locate an element using its id' do
-      element = PageMagic::PageElement.new(:my_input,page, :text_field, id:'field_id').locate
+      element = PageMagic::Element.new(:my_input,page, :text_field, id:'field_id').locate
       element.value == 'filled in'
     end
 
     it 'should locate an element using its name' do
-      element = PageMagic::PageElement.new(:my_input,page, :text_field, name:'field_name').locate
+      element = PageMagic::Element.new(:my_input,page, :text_field, name:'field_name').locate
       element.value == 'filled in'
     end
 
     it 'should locate a link using its text' do
-      element = PageMagic::PageElement.new(:my_link,page, :link, text: 'my link').locate
+      element = PageMagic::Element.new(:my_link,page, :link, text: 'my link').locate
       element[:id].should == 'my_link'
     end
 
     it 'should locate an element using its label' do
-      element = PageMagic::PageElement.new(:my_link,page, :link, label: 'enter text').locate
+      element = PageMagic::Element.new(:my_link,page, :link, label: 'enter text').locate
       element[:id].should == 'field_id'
     end
 
     it 'should raise an exception when finding another element using its text' do
-      expect{PageMagic::PageElement.new(:my_link,page, :text_field, text: 'my link').locate}.to raise_error(PageMagic::UnsupportedSelectorException)
+      expect{PageMagic::Element.new(:my_link,page, :text_field, text: 'my link').locate}.to raise_error(PageMagic::UnsupportedSelectorException)
     end
 
     it 'should locate an element using css' do
-      element = PageMagic::PageElement.new(:my_link,page, :link, css: "input[name='field_name']").locate
+      element = PageMagic::Element.new(:my_link,page, :link, css: "input[name='field_name']").locate
       element[:id].should == 'field_id'
     end
 
     it 'should raise errors for unsupported selectors' do
-      expect{PageMagic::PageElement.new(:my_link,page, :link, unsupported:"").locate}.to raise_error(PageMagic::UnsupportedSelectorException)
+      expect{PageMagic::Element.new(:my_link,page, :link, unsupported:"").locate}.to raise_error(PageMagic::UnsupportedSelectorException)
     end
 
 
 
     it 'should return the browser element if a selector was not specified' do
-      PageMagic::PageElement.new(:help, browser, :link, nil).locate.should == browser
+      PageMagic::Element.new(:help, browser, :link, nil).locate.should == browser
     end
 
     #TODO - Bug here, parent element reference is not available
     it 'should return a prefetched value' do
-      PageMagic::PageElement.new(:help, "prefetched text", :link ).locate.should == "prefetched text"
+      PageMagic::Element.new(:help, "prefetched text", :link ).locate.should == "prefetched text"
     end
 
     it 'should have a handle to the session' do
-      PageMagic::PageElement.new(:help, page, :link, :selector ).session.should == page.session
+      PageMagic::Element.new(:help, page, :link, :selector ).session.should == page.session
     end
   end
 

data/spec/{page_elements_spec.rb → elements_spec.rb}

@@ -1,12 +1,12 @@
 require 'spec_helper'
 require 'page_magic'
 
-describe PageMagic::PageElements do
+describe PageMagic::Elements do
 
 
   let(:page_elements) do
     page_element = Class.new do
-      extend(PageMagic::PageElements)
+      extend(PageMagic::Elements)
     end
   end
 
@@ -22,7 +22,7 @@ describe PageMagic::PageElements do
     context 'using a selector' do
       it 'should add an element' do
         page_elements.text_field :name, selector
-        page_elements.element_definitions[:name].call(parent_page_element).should == PageMagic::PageElement.new(:name, parent_page_element, :text_field, selector)
+        page_elements.element_definitions[:name].call(parent_page_element).should == PageMagic::Element.new(:name, parent_page_element, :text_field, selector)
       end
 
       it 'should return your a copy of the core definition' do
@@ -47,10 +47,10 @@ describe PageMagic::PageElements do
 
     let!(:section_class) do
       Class.new do
-        extend PageMagic::PageSection
+        extend PageMagic::Section
 
         def == object
-          object.class.is_a?(PageMagic::PageSection) &&
+          object.class.is_a?(PageMagic::Section) &&
               object.name == self.name
         end
       end
@@ -132,7 +132,7 @@ describe PageMagic::PageElements do
         page_elements.section :page_section, nil do
         end
 
-        expect { page_elements.elements(parent_page_element, arg) }.to raise_error(PageMagic::PageSection::UndefinedSelectorException)
+        expect { page_elements.elements(parent_page_element, arg) }.to raise_error(PageMagic::Section::UndefinedSelectorException)
       end
 
 
@@ -167,7 +167,7 @@ describe PageMagic::PageElements do
           def hello;
           end
         end
-      end.to raise_error(PageMagic::PageElements::InvalidMethodNameException)
+      end.to raise_error(PageMagic::Elements::InvalidMethodNameException)
     end
 
     it 'should not allow element names that match method names' do
@@ -178,7 +178,7 @@ describe PageMagic::PageElements do
 
           link(:hello, text: 'world')
         end
-      end.to raise_error(PageMagic::PageElements::InvalidElementNameException)
+      end.to raise_error(PageMagic::Elements::InvalidElementNameException)
     end
 
     it 'should not allow duplicate element names' do
@@ -187,7 +187,7 @@ describe PageMagic::PageElements do
           link(:hello, text: 'world')
           link(:hello, text: 'world')
         end
-      end.to raise_error(PageMagic::PageElements::InvalidElementNameException)
+      end.to raise_error(PageMagic::Elements::InvalidElementNameException)
     end
 
     it 'should not evaluate the elements when applying naming checks' do

data/spec/member_methods_spec.rb

@@ -5,7 +5,7 @@ describe 'member methods' do
   
   let(:page_object_class) do
     Class.new do
-      extend PageMagic::PageElements
+      extend PageMagic::Elements
     end
   end
 
@@ -17,7 +17,7 @@ describe 'member methods' do
 
 
   describe 'the element types that you can define' do
-    PageMagic::PageElements::ELEMENT_TYPES.each do |element_type|
+    PageMagic::Elements::TYPES.each do |element_type|
 
       it "can have a #{element_type}" do
         parent_page_element = double('parent_page_object', browser_element: double('browser_element'))
@@ -26,7 +26,7 @@ describe 'member methods' do
         page_object_class.send(element_type, friendly_name,{})
 
 
-        expected_element = PageMagic::PageElement.new(friendly_name,parent_page_element, element_type, {})
+        expected_element = PageMagic::Element.new(friendly_name,parent_page_element, element_type, {})
         page_object_class.element_definitions[friendly_name].call(parent_page_element) == expected_element
       end
     end

data/spec/page_magic_spec.rb

@@ -90,42 +90,30 @@ describe 'page magic' do
     end
 
 
-    describe 'parent pages' do
-      before :all do
-        module ParentPage
+    describe 'inheritance' do
+      let(:parent_page)  do
+        Class.new do
           include PageMagic
           link(:next, :text => "next page")
         end
+      end
 
-        class ChildPage
-          include ParentPage
-          url '/page1'
-        end
+      let(:child_page) do
+        Class.new(parent_page)
       end
 
       context 'children' do
-        it 'override parents url' do
-          ChildPage.url.should == '/page1'
-        end
-
-        it 'inherit elements' do
-          child_page = ChildPage.new
-          child_page.visit
+        it 'should inherit elements defined on the parent class' do
           child_page.element_definitions.should include(:next)
         end
 
         it 'are added to PageMagic.pages list' do
-          PageMagic.pages.find_all { |page| page == ChildPage }.size.should == 1
-        end
-      end
-
-      context 'parent' do
-        it 'is not registered as Page' do
-          PageMagic.pages.should_not include(ParentPage)
+          PageMagic.pages.should include(child_page)
         end
 
-        it 'cannot be instantiated' do
-          expect { ParentPage.new }.to raise_error("You can only instantiate child pages")
+        it 'should pass on element definitions to their children' do
+          grand_child_class = Class.new(child_page)
+          grand_child_class.element_definitions.should include(:next)
         end
       end
     end
@@ -152,7 +140,7 @@ describe 'page magic' do
 
 
     it 'can have fields' do
-      @page.element_definitions[:next].call(@page).should == PageMagic::PageElement.new(:next, @page, :button, :text => "next")
+      @page.element_definitions[:next].call(@page).should == PageMagic::Element.new(:next, @page, :button, :text => "next")
     end
 
     it 'should copy fields on to element' do

data/spec/{page_section_spec.rb → section_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe PageMagic::PageSection do
+describe PageMagic::Section do
 
   include_context :webapp
 
@@ -29,7 +29,7 @@ describe PageMagic::PageSection do
   context 'class level' do
     let(:section) do
       Class.new do
-        extend PageMagic::PageSection
+        extend PageMagic::Section
       end
     end
 
@@ -69,7 +69,7 @@ describe PageMagic::PageSection do
 
     let(:page_section_class) do
       page_section_class = Class.new do
-        extend PageMagic::PageSection
+        extend PageMagic::Section
       end
       page_section_class.stub(:name).and_return('PageSection')
       page_section_class
@@ -87,7 +87,7 @@ describe PageMagic::PageSection do
       end
 
       it 'should raise an error if a class selector is not defined and one is not given to the constructor' do
-        expect { page_section_class.new(parent_page_element) }.to raise_error(PageMagic::PageSection::UndefinedSelectorException)
+        expect { page_section_class.new(parent_page_element) }.to raise_error(PageMagic::Section::UndefinedSelectorException)
       end
     end
 

data/spec/session_spec.rb

@@ -20,7 +20,7 @@ describe PageMagic::Session do
     end
   end
 
-  let(:browser) { double('browser') }
+  let(:browser) { double('browser', current_url: 'url') }
 
   it 'should visit the given url' do
     browser.should_receive(:visit).with(page.url)
@@ -28,6 +28,11 @@ describe PageMagic::Session do
     session.current_page.should be_a(page)
   end
 
+  it 'should return the current url' do
+    session = PageMagic::Session.new(browser)
+    session.current_url.should == 'url'
+  end
+
   context 'method_missing' do
     it 'should delegate to current page' do
       browser.stub(:visit)

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 Bundler.require
 $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
 require 'page_magic'
-require 'helpers'
+require 'helpers/capybara'
 
 RSpec.configure do
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_magic
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 0.9.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2013-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &10020580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10020580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: wait
-  requirement: &10019480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10019480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &10018320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *10018320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
-  requirement: &10033700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10033700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Framework for modeling and interacting with webpages which wraps capybara
 email: info@lad-tech.com
 executables: []
@@ -73,23 +93,21 @@ files:
 - lib/page_magic.rb
 - lib/page_magic/ajax_support.rb
 - lib/page_magic/browser.rb
+- lib/page_magic/element.rb
 - lib/page_magic/element_context.rb
-- lib/page_magic/page_element.rb
-- lib/page_magic/page_elements.rb
+- lib/page_magic/elements.rb
 - lib/page_magic/page_magic.rb
-- lib/page_magic/page_section.rb
+- lib/page_magic/section.rb
 - lib/page_magic/session.rb
-- lib/page_magic/wait.rb
 - page_magic.gemspec
 - spec/browser_spec.rb
 - spec/element_context_spec.rb
-- spec/helpers.rb
+- spec/element_spec.rb
+- spec/elements_spec.rb
 - spec/helpers/capybara.rb
 - spec/member_methods_spec.rb
-- spec/page_element_spec.rb
-- spec/page_elements_spec.rb
 - spec/page_magic_spec.rb
-- spec/page_section_spec.rb
+- spec/section_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ladtech/page_magic
@@ -107,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1067897609518748407
+      hash: 183880895719648639
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -116,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Framework for modeling and interacting with webpages

data/lib/page_magic/wait.rb

@@ -1,7 +0,0 @@
-module PageMagic
-  module WaitUntil
-    def wait
-      @wait ||= Wait.new
-    end
-  end
-end

data/spec/helpers.rb

@@ -1 +0,0 @@
-require 'helpers/capybara'