page_magic 0.10.0 → 0.11.0.alpha

data/.rspec

@@ -0,0 +1 @@
+--require 'spec_helper'

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.11.0.alpha

data/lib/ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  def to_snake_case
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+        gsub(/([a-z\d])([A-Z])/, '\1_\2').
+        tr("-", "_").
+        downcase
+  end
+end

data/lib/page_magic/element.rb

@@ -1,43 +1,28 @@
-require 'watir-webdriver'
 module PageMagic
 
-  class UnsupportedSelectorException < Exception
-
-  end
-
   class Element
+    attr_reader :type, :name, :selector, :browser_element
 
-    class MissingLocatorOrSelector < Exception
-    end
-
-    include AjaxSupport
-
-    attr_reader :type, :name, :selector, :before_hook, :after_hook, :browser_element, :locator
-
-    class << self
-      def default_before_hook
-        @default_before_hook ||= Proc.new {}
-      end
-
-      def default_after_hook
-        @default_after_hook ||= Proc.new {}
-      end
-    end
+    include AjaxSupport, Elements
 
     def initialize name, parent_page_element, type=nil, selector=nil, &block
-      @parent_page_element = parent_page_element
-      if selector
-        @browser_element = parent_page_element.browser_element
+      if selector.is_a?(Hash)
+        @selector = selector
       else
-        @browser_element = parent_page_element
+        @browser_element = selector
       end
 
-      @type = type
-      @name = name.downcase.to_sym
+      @parent_page_element, @type, @name = parent_page_element, type, name.to_s.downcase.to_sym
+      instance_eval &block if block_given?
+    end
+
+    def selector selector=nil
+      return @selector unless selector
       @selector = selector
+    end
 
-      @before_hook, @after_hook = self.class.default_before_hook, self.class.default_after_hook
-      instance_eval &block if block_given?
+    def section?
+      !element_definitions.empty?
     end
 
     def session
@@ -45,50 +30,57 @@ module PageMagic
     end
 
     def before &block
+      return @before_hook unless block
       @before_hook = block
     end
 
     def after &block
+      return @after_hook unless block
       @after_hook = block
     end
 
-    def locate *args
-      if @selector && @selector.is_a?(Hash)
-        method, selector = @selector.to_a.flatten
-        case method
-          when :id
-            @browser_element.find("##{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
-
+    def method_missing method, *args
+      begin
+        ElementContext.new(self, @browser_element, self, *args).send(method, args.first)
+      rescue ElementMissingException
+        begin
+          @browser_element.send(method, *args)
+        rescue
+          super
         end
-      else
-        @browser_element
       end
     end
 
-
-    def == page_element
-      page_element.is_a?(Element) &&
-          @type == page_element.type &&
-          @name == page_element.name &&
-          @selector == page_element.selector
-      @before_hook == page_element.before_hook &&
-          @after_hook == page_element.after_hook
+    def browser_element *args
+      return @browser_element if @browser_element
+      raise UndefinedSelectorException, "Pass a selector/define one on the class" unless @selector
+      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
+      end
+      @browser_element
     end
   end
 end

data/lib/page_magic/element_context.rb

@@ -35,15 +35,15 @@ module PageMagic
         element_locator = element_locator_factory.call(@page_element, *args)
       end
 
-      result = element_locator.locate
+      result = element_locator.browser_element
 
-      return element_locator if element_locator.class.is_a? Section
+      return element_locator if element_locator.section? && action.nil?
 
       [:set, :select_option, :unselect_option, :click].each do |action_method|
         apply_hooks(page_element: result,
                     capybara_method: action_method,
-                    before_hook: element_locator.before_hook,
-                    after_hook: element_locator.after_hook,
+                    before_hook: element_locator.before,
+                    after_hook: element_locator.after,
         )
       end
 

data/lib/page_magic/elements.rb

@@ -1,3 +1,4 @@
+require 'ext/string'
 module PageMagic
   module Elements
     class InvalidElementNameException < Exception
@@ -24,67 +25,45 @@ module PageMagic
       raise InvalidMethodNameException, "method name matches element name" if element_definitions[method]
     end
 
-
     def elements(browser_element, *args)
       element_definitions.values.collect { |definition| definition.call(browser_element, *args) }
     end
 
-    def elements?
-      !element_definitions.empty?
-    end
+    TYPES = [:element, :text_field, :button, :link, :checkbox, :select_list, :radios, :textarea, :section]
+    TYPES.each do |type|
+      define_method type do |*args, &block|
 
-    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
-              Element.new(name, browser_element, field, selector, &block)
-            else
-              Element.new(name, selector, field, nil, &block)
-          end
-
-        end
-      end
-    end
-
-    def section *args, &block
-      case args.first
-        when Symbol
+        first_arg = args.first
+        if first_arg.is_a?(Symbol)
           name, selector = args
 
-          add_element_definition(name) do |parent_browser_element, *args_for_section|
-            page_section = Class.new do
-              extend PageMagic::Section
-            end
-
-            page_section.parent_browser_element = parent_browser_element.browser_element
+          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
+          end
 
-            case selector
-              when Hash
-                page_section.selector selector
-              else
-                page_section.browser_element = selector
-            end
+        elsif first_arg < PageMagic::Element
+          section_class, name, selector = args
 
-            block = block || Proc.new{}
-            page_section.class_exec *args_for_section, &block
-            page_section.new(parent_browser_element, name, selector)
+          unless selector
+            selector = name
+            name = section_class.name.to_snake_case
           end
-        else
-          section_class, name, selector = args
+
           add_element_definition(name) do |parent_browser_element|
-            section_class.new(parent_browser_element, name, selector)
+            section_class.new(name, parent_browser_element, :section, selector)
           end
-      end
-
 
+        end
+      end
     end
 
     def add_element_definition name, &block
       raise InvalidElementNameException, "duplicate page element defined" if element_definitions[name]
-      raise InvalidElementNameException, "a method already exists with this method name" if instance_methods.find { |method| method == name }
+
+      methods = respond_to?(:instance_methods) ? instance_methods : methods()
+      raise InvalidElementNameException, "a method already exists with this method name" if methods.find { |method| method == name }
 
       element_definitions[name] = block
     end

data/lib/page_magic/exceptions.rb

@@ -0,0 +1,10 @@
+module PageMagic
+  class UnsupportedSelectorException < Exception
+
+  end
+  class UndefinedSelectorException < Exception
+  end
+
+  class MissingLocatorOrSelector < Exception
+  end
+end

data/lib/page_magic/page_magic.rb

@@ -3,13 +3,11 @@ module PageMagic
 
   include AjaxSupport
 
-  def initialize session=Capybara.current_session, options={}, &block
-    if session.is_a? Capybara::Session
-      @browser = session
-    else
-      @browser = session.browser
-      @session = session
-    end
+  def initialize session=Session.new(Capybara.current_session), options={}, &block
+
+    @browser = session.raw_session
+    @session = session
+
     @browser_element = @browser
     navigate if options[:navigate_to_page]
     block.call @browser if block
@@ -23,39 +21,15 @@ module PageMagic
     @browser.refresh
   end
 
-  def current_path
-    @browser.current_path
-  end
-
   def text_on_page? text
     text().downcase.include?(text.downcase)
   end
 
-  def window_exists? title
-    raise "implement me"
-  end
-
-  def accept_popup
-    raise "implement me"
-  end
-
-  def alert_present?
-    raise "implement me"
-  end
-
-  def text_in_popup? text
-    raise "implement me"
-  end
-
   def visit
     @browser.visit self.class.url
     self
   end
 
-  def click element
-    self.send(element.downcase.gsub(" ", "_").to_sym)
-  end
-
   def text
     @browser.text
   end

data/lib/page_magic/session.rb

@@ -1,27 +1,30 @@
 require 'wait'
 module PageMagic
   class Session
-    attr_reader :browser
-    attr_accessor :current_page
+    attr_accessor :current_page, :raw_session
 
     def initialize browser
-      @browser = browser
+      @raw_session = browser
     end
 
     def visit page
-      @browser.visit page.url
+      @raw_session.visit page.url
       @current_page = page.new self
       self
     end
 
+    def current_path
+      @raw_session.current_path
+    end
+
     def current_url
-      @browser.current_url
+      @raw_session.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 { raw_session.current_url == page_class.url }
     end
 
     def wait_until &block
@@ -32,5 +35,6 @@ module PageMagic
     def method_missing name, *args, &block
       @current_page.send(name, *args, &block)
     end
+
   end
 end

data/lib/page_magic.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift("#{File.dirname(__FILE__)}")
 require 'capybara'
+require 'page_magic/exceptions'
 require 'page_magic/browser'
 require 'page_magic/session'
 require 'page_magic/ajax_support'
@@ -7,7 +8,6 @@ require 'page_magic/elements'
 require 'page_magic/element_context'
 require 'page_magic/element'
 require 'page_magic/page_magic'
-require 'page_magic/section'
 
 module PageMagic
   class << self

data/page_magic.gemspec

@@ -5,17 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = "page_magic"
-  s.version = "0.10.0"
+  s.version = "0.11.0.alpha"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leon Davis"]
-  s.date = "2013-12-16"
+  s.date = "2014-03-05"
   s.description = "Framework for modeling and interacting with webpages which wraps capybara"
   s.email = "info@lad-tech.com"
   s.extra_rdoc_files = [
     "README.md"
   ]
   s.files = [
+    ".rspec",
     ".ruby-gemset",
     ".ruby-version",
     ".travis.yml",
@@ -24,24 +25,28 @@ Gem::Specification.new do |s|
     "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",
     "lib/page_magic/elements.rb",
+    "lib/page_magic/exceptions.rb",
     "lib/page_magic/page_magic.rb",
-    "lib/page_magic/section.rb",
     "lib/page_magic/session.rb",
     "page_magic.gemspec",
     "spec/browser_spec.rb",
     "spec/element_context_spec.rb",
     "spec/element_spec.rb",
-    "spec/elements_spec.rb",
     "spec/helpers/capybara.rb",
     "spec/member_methods_spec.rb",
-    "spec/page_magic_spec.rb",
-    "spec/section_spec.rb",
+    "spec/page_magic/elements/elements_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"
   ]

data/spec/element_context_spec.rb

@@ -22,7 +22,7 @@ describe 'Element Context' do
   end
 
   let!(:session) do
-    double('session', browser: double('browser'))
+    double('session', raw_session: double('browser'))
   end
 
   describe 'resolving field definitions' do
@@ -70,7 +70,7 @@ describe 'Element Context' do
       page.visit
 
       PageMagic::ElementContext.new(page, page.browser, self).click_next
-      page.current_path.should == '/page2'
+      page.session.current_path.should == '/page2'
       page.text.should == 'page 2 content'
     end
   end
@@ -82,16 +82,38 @@ describe 'Element Context' do
       elements_page.class_eval do
         section :form do
           selector css: '.form'
+          link :form_link, text: 'in a form'
         end
       end
 
       page = elements_page.new
       page.visit
 
-      PageMagic::ElementContext.new(page, page.browser, self).form('a', 'b')
+      PageMagic::ElementContext.new(page, page.browser, self).form
+    end
+
+    it 'they are clickable too' do
+      elements_page.class_eval do
+        section :section do
+          selector id: 'form_link'
+        end
+      end
+
+      page = elements_page.new
+      page.visit
+
+
+      PageMagic::ElementContext.new(page, page.browser, self).click_section
+      page.session.current_path.should == '/page2'
+    end
+
+    it 'should delegate to page element if method not found' do
+      #TODO call page method, look for subelement, delagate to capybara object
     end
   end
 
+
+
   describe 'hooks' do
 
     it 'should execute a before and after action that gives access to the browser' do