page_magic 0.11.0.alpha3 → 0.11.0.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1859255acffb538a691d28d73ce14bcf0725d6f
-  data.tar.gz: 3a64fd4a58dd5aa358bd5dcc15d5cf0108d94754
+  metadata.gz: cd7f970881ca342aebac6a622629e2256c7b3772
+  data.tar.gz: c1a87cb1706b7d2bc40fc521a9cc5af55fea6c40
 SHA512:
-  metadata.gz: 54fc9710a9013f621a4bec82eeec5da843070aba85b1d12e4259da4452b4e23648caf13c010615a4c942f36eb31ff95ffd4d1f215a893060e6c74502c090d818
-  data.tar.gz: 0b8801158b735c37b39101e26c604a4483f01c960c99d6d9ec35a3aa72c980face0b0143bea687da5a5c0a793d20490d9dc0719f9f6725def9fc4dfb70524e69
+  metadata.gz: 00119f1eacd5c3d0001a020fe938b1dfd3fa1340b21800f7a7087ecc43e375d3ffae769c4f3eca2b96404e7c19d605a448e4b35b2f2202bb43e58bfa11ffdf43
+  data.tar.gz: 243f27af8b0adfd0c58a9e254b128d0c60e4da10eff2d1e421435b1d65b22e30324adba474d92499df6bd0b2f008e203389e45510aa0dd24e82c1e0ffce1165f

data/Gemfile

@@ -13,4 +13,6 @@ end
 
 group :development do
   gem "jeweler"
+  gem 'guard'
+  gem 'guard-ctags-bundler'
 end

data/Gemfile.lock

@@ -9,13 +9,17 @@ GEM
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       xpath (~> 2.0)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
     childprocess (0.3.9)
       ffi (~> 1.0, >= 1.0.11)
     cliver (0.2.2)
+    coderay (1.1.0)
     diff-lcs (1.2.4)
     faraday (0.8.9)
       multipart-post (~> 1.2.0)
     ffi (1.9.3)
+    formatador (0.2.5)
     git (1.2.6)
     github_api (0.10.2)
       addressable
@@ -24,6 +28,14 @@ GEM
       multi_json (~> 1.4)
       nokogiri (~> 1.6.0)
       oauth2
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-ctags-bundler (1.0.2)
+      guard (~> 2.0)
     hashie (2.0.5)
     highline (1.6.21)
     jeweler (2.0.1)
@@ -38,6 +50,12 @@ GEM
     json (1.8.1)
     jwt (0.1.11)
       multi_json (>= 1.5)
+    listen (2.7.8)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.6)
+    method_source (0.8.2)
     mime-types (1.25)
     mini_portile (0.5.1)
     multi_json (1.7.3)
@@ -56,12 +74,19 @@ GEM
       cliver (~> 0.2.1)
       multi_json (~> 1.0)
       websocket-driver (>= 0.2.0)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rack (1.5.2)
     rack-protection (1.5.0)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (10.2.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
     rdoc (4.1.1)
       json (~> 1.4)
     rspec (2.14.1)
@@ -86,7 +111,10 @@ GEM
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
+    slop (3.5.0)
+    thor (0.19.1)
     tilt (1.4.1)
+    timers (1.1.0)
     wait (0.5.1)
     watir-webdriver (0.6.4)
       selenium-webdriver (>= 2.18.0)
@@ -100,6 +128,8 @@ PLATFORMS
 
 DEPENDENCIES
   capybara
+  guard
+  guard-ctags-bundler
   jeweler
   poltergeist
   rspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'ctags-bundler', :src_path => [".", "app", "lib", "spec/support"], :stdlib => true do
+  watch(/^(app|lib|spec\/support)\/.*\.rb$/)
+  watch(/^*.rb$/)
+  watch('Gemfile.lock')
+end

data/README.md

@@ -1 +1,7 @@
 [![Build Status](https://travis-ci.org/Ladtech/page_magic.png)](https://travis-ci.org/Ladtech/page_magic)
+#PageMagic 
+PageMagic is an API for testing web applications. 
+
+It has a simple but powerful DSL which makes modelling and interacting with your pages easy.
+
+More docs coming soon.

data/VERSION

@@ -1 +1 @@
-0.11.0.alpha3
+0.11.0.alpha5

data/lib/page_magic/element.rb

@@ -1,13 +1,24 @@
 module PageMagic
 
+  module MethodObserver
+    def singleton_method_added arg
+      @singleton_methods_added = true unless arg == :singleton_method_added
+    end
+
+    def singleton_methods_added?
+      @singleton_methods_added == true
+    end
+  end
+
   class Element
     attr_reader :type, :name, :selector, :browser_element
 
-    include AjaxSupport, Elements
+    include Elements
 
     class << self
       def inherited clazz
-        clazz.extend(Elements, AjaxSupport)
+        clazz.extend(Elements)
+
         def clazz.selector selector=nil
           return @selector unless selector
           @selector = selector
@@ -15,17 +26,21 @@ module PageMagic
       end
     end
 
-    def initialize name, parent_page_element, type=nil, selector, &block
-      if selector.is_a?(Hash)
-        @selector = selector
-      else
-        @browser_element = selector
-      end
+    def initialize name, parent_page_element, options, &block
+      options = {type: :element, selector: {}, browser_element: nil}.merge(options)
+      @browser_element = options[:browser_element]
+      @selector = options[:selector]
+
+      @before_hook = proc {}
+      @after_hook = proc {}
+      @parent_page_element, @type, @name = parent_page_element, options[:type], name.to_s.downcase.to_sym
 
-      @before_hook = proc{}
-      @after_hook = proc{}
-      @parent_page_element, @type, @name = parent_page_element, type, name.to_s.downcase.to_sym
-      instance_eval &block if block_given?
+      extend MethodObserver
+      expand &block if block
+    end
+
+    def expand *args, &block
+      instance_exec *args, &block
     end
 
     def selector selector=nil
@@ -34,7 +49,7 @@ module PageMagic
     end
 
     def section?
-      !element_definitions.empty?
+      !element_definitions.empty? || singleton_methods_added?
     end
 
     def session
@@ -65,34 +80,44 @@ module PageMagic
 
     def browser_element *args
       return @browser_element if @browser_element
-      raise UndefinedSelectorException, "Pass a selector/define one on the class" unless @selector
+      raise UndefinedSelectorException, "Pass a selector/define one on the class" if @selector.empty?
       if @selector
-        method, selector = @selector.to_a.flatten
-        browser_element = @parent_page_element.browser_element
-        @browser_element = case method
-                             when :id
-                               browser_element.find("##{selector}")
-                             when :xpath
-                               browser_element.find(:xpath, selector)
-                             when :name
-                               browser_element.find("*[name='#{selector}']")
-                             when :label
-                               browser_element.find_field(selector)
-                             when :text
-                               if @type == :link
-                                 browser_element.find_link(selector)
-                               elsif @type == :button
-                                 browser_element.find_button(selector)
-                               else
-                                 raise UnsupportedSelectorException
-                               end
-                             when :css
-                               browser_element.find(:css, selector)
-                             else
-                               raise UnsupportedSelectorException
-                           end
+        selector_copy = @selector.dup
+        method = selector.keys.first
+        selector = selector_copy.delete(method)
+        options = selector_copy
+
+
+        finder_method, selector_type, selector_arg = case method
+                                                       when :id
+                                                         [:find, "##{selector}"]
+                                                       when :xpath
+                                                         [:find, :xpath, selector]
+                                                       when :name
+                                                         [:find, "*[name='#{selector}']"]
+                                                       when :css
+                                                         [:find, :css, selector]
+                                                       when :label
+                                                         [:find_field, selector]
+                                                       when :text
+                                                         if @type == :link
+                                                           [:find_link, selector]
+                                                         elsif @type == :button
+                                                           [:find_button, selector]
+                                                         else
+                                                           raise UnsupportedSelectorException
+                                                         end
+
+                                                       else
+                                                         raise UnsupportedSelectorException
+                                                     end
+
+
+        finder_args = [selector_type, selector_arg].compact
+        finder_args << options unless options.empty?
+        @browser_element = @parent_page_element.browser_element.send(finder_method, *finder_args)
       end
       @browser_element
     end
   end
-end
+end

data/lib/page_magic/element_context.rb

@@ -59,13 +59,14 @@ module PageMagic
     def apply_hooks(options)
       _self = self
       page_element, capybara_method = options[:page_element], options[:capybara_method]
-
-      original_method = page_element.method(capybara_method)
-
-      page_element.define_singleton_method capybara_method do |*arguments, &block|
-        _self.call_hook &options[:before_hook]
-        original_method.call *arguments, &block
-        _self.call_hook &options[:after_hook]
+      if page_element.respond_to?(capybara_method)
+        original_method = page_element.method(capybara_method)
+
+        page_element.define_singleton_method capybara_method do |*arguments, &block|
+          _self.call_hook &options[:before_hook]
+          original_method.call *arguments, &block
+          _self.call_hook &options[:after_hook]
+        end
       end
     end
 

data/lib/page_magic/elements.rb

@@ -33,11 +33,17 @@ module PageMagic
 
         first_arg = args.first
         if first_arg.is_a?(Symbol)
-          name, selector = args
+          name, object = args
+          options = {type: type}
+          if object.is_a?(Hash)
+            options[:selector] = object
+          else
+            options[:browser_element] = object
+          end
 
           add_element_definition(name) do |*args_for_block|
-            page_section = PageMagic::Element.new name, args_for_block.delete_at(0), type, selector
-            page_section.instance_exec *args_for_block, &(block || Proc.new {})
+            page_section = PageMagic::Element.new name, args_for_block.delete_at(0), options
+            page_section.expand *args_for_block, &(block || Proc.new {})
             page_section
           end
 
@@ -50,7 +56,7 @@ module PageMagic
           end
 
           add_element_definition(name) do |parent_browser_element|
-            section_class.new(name, parent_browser_element, :section, selector|| section_class.selector)
+            section_class.new(name, parent_browser_element, type: :section, selector: (selector || section_class.selector))
           end
 
         end

data/lib/page_magic/page_magic.rb

@@ -1,8 +1,6 @@
 module PageMagic
   attr_reader :browser, :session
 
-  include AjaxSupport
-
   def initialize session=Session.new(Capybara.current_session), options={}, &block
 
     @browser = session.raw_session

data/lib/page_magic.rb

@@ -3,7 +3,6 @@ require 'capybara'
 require 'page_magic/exceptions'
 require 'page_magic/browser'
 require 'page_magic/session'
-require 'page_magic/ajax_support'
 require 'page_magic/elements'
 require 'page_magic/element_context'
 require 'page_magic/element'

data/spec/element_spec.rb

@@ -46,11 +46,11 @@ describe 'Page elements' do
 
   describe 'browser_element' do
     it 'should raise an error if a selector has not been specified' do
-      expect { PageMagic::Element.new(:name, Object.new, :type).browser_element }.to raise_error(PageMagic::UndefinedSelectorException)
+      expect { PageMagic::Element.new(:name, Object.new, type: :element).browser_element }.to raise_error(PageMagic::UndefinedSelectorException)
     end
   end
 
-  describe 'location' do
+  describe '#browser_element' do
     let!(:browser) { double('browser') }
     let!(:page) do
       page_class = Class.new do
@@ -59,58 +59,102 @@ describe 'Page elements' do
       page_class.new
     end
 
+    context 'options supplied to selector' do
+      it 'passes them on to the cappybara finder method' do
+        options = {key: :value}
+        xpath_selector = '//input'
+        expect(Capybara.current_session).to receive(:find).with(:xpath, xpath_selector, options)
+        PageMagic::Element.new(:my_input, page, type: :text_field, selector: {xpath: xpath_selector}.merge(options)).browser_element
+      end
+    end
+
     it 'should find by xpath' do
-      element = PageMagic::Element.new(:my_input, page, :text_field, xpath: '//input').browser_element
+      element = PageMagic::Element.new(:my_input, page, type: :text_field, selector: {xpath: '//input'}).browser_element
       element.value == 'filled in'
     end
 
     it 'should locate an element using its id' do
-      element = PageMagic::Element.new(:my_input, page, :text_field, id: 'field_id').browser_element
+      element = PageMagic::Element.new(:my_input, page, type: :text_field, selector: {id: 'field_id'}).browser_element
       element.value.should == 'filled in'
     end
 
     it 'should locate an element using its name' do
-      element = PageMagic::Element.new(:my_input, page, :text_field, name: 'field_name').browser_element
+      element = PageMagic::Element.new(:my_input, page, type: :text_field, selector: {name: 'field_name'}).browser_element
       element.value.should == 'filled in'
     end
 
 
     it 'should locate an element using its label' do
-      element = PageMagic::Element.new(:my_link, page, :link, label: 'enter text').browser_element
+      element = PageMagic::Element.new(:my_link, page, type: :link, selector: {label: 'enter text'}).browser_element
       element[:id].should == 'field_id'
     end
 
     it 'should raise an exception when finding another element using its text' do
-      expect { PageMagic::Element.new(:my_link, page, :text_field, text: 'my link').browser_element }.to raise_error(PageMagic::UnsupportedSelectorException)
+      expect { PageMagic::Element.new(:my_link, page, type: :text_field, selector: {text: 'my link'}).browser_element }.to raise_error(PageMagic::UnsupportedSelectorException)
     end
 
     it 'should locate an element using css' do
-      element = PageMagic::Element.new(:my_link, page, :link, css: "input[name='field_name']").browser_element
+      element = PageMagic::Element.new(:my_link, page, type: :link, selector: {css: "input[name='field_name']"}).browser_element
       element[:id].should == 'field_id'
     end
 
 
     it 'should return a prefetched value' do
-      PageMagic::Element.new(:help, page, :link, :prefetched_object).browser_element.should == :prefetched_object
+      PageMagic::Element.new(:help, page, type: :link, browser_element: :prefetched_object).browser_element.should == :prefetched_object
     end
 
     it 'should raise errors for unsupported selectors' do
-      expect { PageMagic::Element.new(:my_link, page, :link, unsupported: "").browser_element }.to raise_error(PageMagic::UnsupportedSelectorException)
+      expect { PageMagic::Element.new(:my_link, page, type: :link, selector: {unsupported: ""}).browser_element }.to raise_error(PageMagic::UnsupportedSelectorException)
     end
 
     context 'text selector' do
       it 'should locate a link' do
-        element = PageMagic::Element.new(:my_link, page, :link, text: 'my link').browser_element
+        element = PageMagic::Element.new(:my_link, page, type: :link, selector: {text: 'my link'}).browser_element
         element[:id].should == 'my_link'
       end
 
       it 'should locate a button' do
-        element = PageMagic::Element.new(:my_button, page, :button, text: 'my button').browser_element
+        element = PageMagic::Element.new(:my_button, page, type: :button, selector: {text: 'my button'}).browser_element
         element[:id].should == 'my_button'
       end
     end
   end
 
+  describe '#section?' do
+    context 'element definitions exist' do
+      subject do
+        PageMagic::Element.new(:my_link, :page, type: :link, selector: {text: 'my link'}) do
+          element :thing, text: 'text'
+        end
+      end
+      it 'returns true' do
+        expect(subject.section?).to eq(true)
+      end
+    end
+
+    context 'method defined' do
+      subject do
+        PageMagic::Element.new(:my_link, :page, type: :link, selector: {text: 'my link'}) do
+          def custom_method
+          end
+        end
+      end
+
+      it 'returns true' do
+        expect(subject.section?).to eq(true)
+      end
+    end
+
+    context 'neither method or elements defined' do
+      subject do
+        PageMagic::Element.new(:my_link, :page, type: :link, selector: {text: 'my link'})
+      end
+      it 'returns false' do
+        expect(subject.section?).to eq(false)
+      end
+    end
+  end
+
   describe 'session' do
     it 'should have a handle to the session' do
       page_class = Class.new do
@@ -118,7 +162,7 @@ describe 'Page elements' do
       end
       page = page_class.new
 
-      PageMagic::Element.new(:help, page, :link, :selector).session.should == page.session
+      PageMagic::Element.new(:help, page, type: :link, selector: :selector).session.should == page.session
     end
   end
 

data/spec/{element_context_spec.rb → page_magic/element_context_spec.rb}

@@ -113,6 +113,11 @@ describe PageMagic::ElementContext do
 
   describe 'hooks' do
 
+
+    #it 'only applies them if browser element supports event' do
+    #  page = elements_page.new
+    #end
+
     it 'should execute a before and after action that gives access to the browser' do
 
       page = elements_page.new

data/spec/page_magic/elements_spec.rb

@@ -2,7 +2,7 @@ describe PageMagic::Elements do
 
 
   let(:page_elements) do
-    page_element = Class.new do
+    Class.new do
       extend(PageMagic::Elements)
     end
   end
@@ -17,7 +17,7 @@ describe PageMagic::Elements do
 
     context 'using a selector' do
       it 'should add an element' do
-        expected_element = PageMagic::Element.new(:name, parent_page_element, :text_field, selector)
+        expected_element = PageMagic::Element.new(:name, parent_page_element, type: :text_field, selector: selector)
         page_elements.text_field :name, selector
         page_elements.element_definitions[:name].call(parent_page_element).should == expected_element
       end
@@ -40,7 +40,7 @@ describe PageMagic::Elements do
 
       context 'using a predefined class' do
         it 'should add a section' do
-          expected_section = section_class.new(:page_section, parent_page_element, :section, selector)
+          expected_section = section_class.new(:page_section, parent_page_element, type: :section, selector: selector)
 
           page_elements.section section_class, :page_section, selector
           page_elements.elements(parent_page_element).first.should == expected_section
@@ -118,7 +118,7 @@ describe PageMagic::Elements do
       describe 'location' do
         context 'a prefetched object' do
           it 'should add a section' do
-            expected_section = section_class.new(:page_section, parent_page_element, :section, :object)
+            expected_section = section_class.new(:page_section, parent_page_element, type: :section, browser_element: :object)
             page_elements.section :page_section, :object
             expected_section.should == page_elements.elements(parent_page_element).first
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_magic
 version: !ruby/object:Gem::Version
-  version: 0.11.0.alpha3
+  version: 0.11.0.alpha5
 platform: ruby
 authors:
 - Leon Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-05 00:00:00.000000000 Z
+date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -52,6 +52,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-ctags-bundler
+  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: []
@@ -65,12 +93,12 @@ files:
 - .travis.yml
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - README.md
 - Rakefile
 - VERSION
 - lib/ext/string.rb
 - 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
@@ -79,18 +107,18 @@ files:
 - lib/page_magic/page_magic.rb
 - lib/page_magic/session.rb
 - page_magic.gemspec
-- spec/browser_spec.rb
-- spec/element_context_spec.rb
 - spec/element_spec.rb
 - spec/helpers/capybara.rb
 - spec/member_methods_spec.rb
+- spec/page_magic/browser_spec.rb
+- spec/page_magic/element_context_spec.rb
 - spec/page_magic/elements_spec.rb
+- spec/page_magic/session_spec.rb
 - spec/page_magic/usage/defining_page_elements_spec.rb
 - spec/page_magic/usage/defining_pages_spec.rb
 - spec/page_magic/usage/include_page_magic_spec.rb
 - spec/page_magic/usage/interacting_with_pages_spec.rb
 - spec/page_magic/usage/starting_a_session_spec.rb
-- spec/session_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ladtech/page_magic
 licenses:
@@ -112,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Framework for modeling and interacting with webpages

data/lib/page_magic/ajax_support.rb

@@ -1,21 +0,0 @@
-module PageMagic
-  module AjaxSupport
-    def on_element_with_trigger css_selector, event, browser, &block
-      set_variable_on_event(browser, css_selector, event)
-      yield
-      wait_until(:timeout_after => 20.seconds, :retry_every => 1.second) do
-        event_triggered(browser, event)
-      end
-    end
-
-    def event_triggered(browser, variable)
-      browser.execute_script("return #{variable}_triggered")
-    end
-
-    def set_variable_on_event(browser, element, event)
-      variable_name="#{event}_triggered"
-      browser.execute_script("#{variable_name}=false")
-      browser.execute_script("$('#{element}').on('#{event}', function(){#{variable_name}=true})")
-    end
-  end
-end