page_magic 0.8.8

data/.ruby-gemset

@@ -0,0 +1 @@
+page_magic

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - '1.9.3'
+  - '2.0.0'
+

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem "watir-webdriver"
+gem 'capybara'
+gem 'wait'
+
+group :test do
+  gem 'sinatra'
+  gem "rspec", require: 'rspec/core/rake_task'
+  gem "simplecov", require: false
+end
+
+group :development do
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,74 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    capybara (2.1.0)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    diff-lcs (1.2.4)
+    ffi (1.8.1)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    mime-types (1.25)
+    mini_portile (0.5.1)
+    multi_json (1.7.3)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    rack (1.5.2)
+    rack-protection (1.5.0)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.6)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.32.1)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sinatra (1.4.3)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    tilt (1.4.1)
+    wait (0.5.1)
+    watir-webdriver (0.6.4)
+      selenium-webdriver (>= 2.18.0)
+    websocket (1.0.7)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  jeweler (~> 1.8.4)
+  rspec
+  simplecov
+  sinatra
+  wait
+  watir-webdriver

data/README.md

@@ -0,0 +1 @@
+[![Build Status](https://travis-ci.org/Ladtech/page_magic.png)](https://travis-ci.org/Ladtech/page_magic)

data/Rakefile

@@ -0,0 +1,20 @@
+Bundler.require :test,:development
+
+RSpec::Core::RakeTask.new(:spec) do
+  ENV['coverage'] = "true"
+end
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "page_magic"
+  gem.homepage = "https://github.com/ladtech/page_magic"
+  gem.license = "ruby"
+  gem.summary = "Framework for modeling and interacting with webpages"
+  gem.description = "Framework for modeling and interacting with webpages which wraps capybara"
+  gem.email = "info@lad-tech.com"
+  gem.authors = ["Leon Davis"]
+  gem.add_dependency "watir-webdriver"
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.8.8

data/lib/page_magic/ajax_support.rb

@@ -0,0 +1,21 @@
+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

data/lib/page_magic/browser.rb

@@ -0,0 +1,16 @@
+module PageMagic
+  module Browser
+    class << self
+      attr_reader :browser
+      attr_accessor :session
+
+      def use browser
+        @browser = browser
+      end
+    end
+
+    def browser
+      Browser.session ||= PageMagic.session(Browser.browser || :chrome)
+    end
+  end
+end

data/lib/page_magic/element_context.rb

@@ -0,0 +1,81 @@
+module PageMagic
+
+  class ElementMissingException < Exception
+
+  end
+
+  class ElementContext
+
+    attr_reader :caller, :page_element
+
+    def initialize page_element, browser, caller, *args
+      @page_element = page_element
+      @browser = browser
+      @caller = caller
+    end
+
+    def method_missing method, *args
+      return @caller.send(method, *args) if @executing_hooks
+      return @page_element.send(method, *args) if @page_element.methods.include?(method)
+
+
+      element_locator_factory =  @page_element.element_definitions[method]
+
+      action = nil
+      unless element_locator_factory
+        action = resolve_action(method)
+        element_locator_factory = @page_element.element_definitions[method.to_s.gsub("#{action}_", '').to_sym]
+      end
+
+      raise ElementMissingException, "Could not find: #{method}" unless element_locator_factory
+
+      if args.empty?
+        element_locator = element_locator_factory.call(@page_element, nil)
+      else
+        element_locator = element_locator_factory.call(@page_element, *args)
+      end
+
+      result = element_locator.locate
+
+      return element_locator if element_locator.class.is_a? PageSection
+
+      [: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,
+        )
+      end
+
+      action ? result.send(action) : result
+    end
+
+    def resolve_action(field)
+      {/^click_/ => :click}.each do |prefix, action|
+        return action if field.to_s =~ prefix
+      end
+    end
+
+    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]
+      end
+    end
+
+
+    def call_hook &block
+      @executing_hooks = true
+      result = self.instance_exec @browser, &block
+      @executing_hooks = false
+      result
+    end
+
+  end
+end

data/lib/page_magic/page_element.rb

@@ -0,0 +1,99 @@
+require 'watir-webdriver'
+module PageMagic
+
+  class UnsupportedSelectorException < Exception
+
+  end
+
+  class PageElement
+
+    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
+      def default_before_hook
+        @default_before_hook ||= Proc.new {}
+      end
+
+      def default_after_hook
+        @default_after_hook ||= Proc.new {}
+      end
+    end
+
+    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
+      else
+        @browser_element = parent_page_element
+      end
+
+      @type = type
+      @name = name.downcase.to_sym
+      @selector = selector
+
+      @before_hook, @after_hook = self.class.default_before_hook, self.class.default_after_hook
+      instance_eval &block if block_given?
+    end
+
+    def session
+      @parent_page_element.session
+    end
+
+    def before &block
+      @before_hook = block
+    end
+
+    def after &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
+
+        end
+      else
+        @browser_element
+      end
+    end
+
+
+    def == page_element
+      page_element.is_a?(PageElement) &&
+          @type == page_element.type &&
+          @name == page_element.name &&
+          @selector == page_element.selector
+      @before_hook == page_element.before_hook &&
+          @after_hook == page_element.after_hook
+    end
+  end
+end

data/lib/page_magic/page_elements.rb

@@ -0,0 +1,91 @@
+module PageMagic
+  module PageElements
+    class InvalidElementNameException < Exception
+    end
+
+    class InvalidMethodNameException < Exception
+    end
+
+    def self.extended clazz
+      clazz.class_eval do
+        attr_reader :browser_element
+
+        def elements browser_element, *args
+          self.class.elements browser_element, *args
+        end
+
+        def element_definitions
+          self.class.element_definitions
+        end
+
+      end
+    end
+
+    def method_added method
+      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
+
+    ELEMENT_TYPES = [:element, :text_field, :button, :link, :checkbox, :select_list, :radios, :textarea]
+    ELEMENT_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)
+            else
+              PageElement.new(name, selector, field, nil, &block)
+          end
+
+        end
+      end
+    end
+
+    def section *args, &block
+      case args.first
+        when Symbol
+          name, selector = args
+
+          add_element_definition(name) do |parent_browser_element, *args_for_section|
+            page_section = Class.new do
+              extend PageMagic::PageSection
+            end
+
+            page_section.parent_browser_element = parent_browser_element.browser_element
+            page_section.selector selector if selector
+
+            page_section.class_exec *args_for_section, &block
+            page_section.new(parent_browser_element, name, selector)
+          end
+        else
+          section_class, name, selector = args
+          add_element_definition(name) do |parent_browser_element|
+            section_class.new(parent_browser_element, name, selector)
+          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 }
+
+      element_definitions[name] = block
+    end
+
+    def element_definitions
+      @element_definitions ||= {}
+    end
+  end
+end

data/lib/page_magic/page_magic.rb

@@ -0,0 +1,70 @@
+module PageMagic
+  attr_reader :browser, :session
+
+  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
+    @browser_element = @browser
+    navigate if options[:navigate_to_page]
+    block.call @browser if block
+  end
+
+  def title
+    @browser.title
+  end
+
+  def refresh
+    @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
+
+  def method_missing method, *args
+    ElementContext.new(self, @browser, self).send(method, *args)
+  end
+end
+
+
+
+

data/lib/page_magic/page_section.rb

@@ -0,0 +1,101 @@
+module PageMagic
+  module PageSection
+
+    module Location
+      def locate_in browser_element, selector
+        method, selector = selector.to_a.flatten
+        case method
+                             when :id
+                               browser_element.find("##{selector}")
+                             when :css
+                               browser_element.find(:css, selector)
+                             else
+                               raise UnsupportedSelectorException
+                           end
+      end
+    end
+    class UndefinedSelectorException < Exception
+
+    end
+
+    class << self
+      def extended clazz
+        clazz.extend(PageElements)
+        clazz.class_eval do
+          attr_reader :name, :selector
+          class << self
+            def selector selector=nil
+              return @selector unless selector
+
+              if @parent_browser_element
+                @browser_element = locate_in @parent_browser_element, selector
+              end
+
+              @selector = selector
+            end
+
+            attr_accessor :parent_browser_element, :browser_element
+          end
+
+          include Location
+          extend Location
+
+          def initialize parent_page_element, name=nil, selector=self.class.selector
+
+            @selector = selector
+            @parent_page_element = parent_page_element
+
+            @selector = selector ? selector : self.class.selector
+
+            raise UndefinedSelectorException, "Pass a selector to the constructor/define one the class" unless @selector
+            @browser_element = locate_in(@parent_page_element.browser_element, @selector)
+            if name
+              @name = name
+            else
+              @name = underscore(self.class.name).to_sym
+            end
+
+          end
+
+
+          def session
+            @parent_page_element.session
+          end
+
+          # TODO test this
+          def locate *args
+            @browser_element
+          end
+
+          #TODO - consolidate this
+          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
+
+            end
+          end
+
+          private
+
+          def underscore string
+            string.gsub(/::/, '/').
+                gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+                gsub(/([a-z\d])([A-Z])/, '\1_\2').
+                tr("-", "_").
+                downcase
+          end
+
+
+        end
+      end
+    end
+
+
+  end
+end

data/lib/page_magic/session.rb

@@ -0,0 +1,28 @@
+module PageMagic
+  class Session
+    attr_reader :browser
+    attr_accessor :current_page
+
+    include WaitUntil
+
+    def initialize browser
+      @browser = browser
+    end
+
+    def visit page
+      @browser.visit page.url
+      @current_page = page.new self
+      self
+    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 }
+    end
+
+    def method_missing name, *args, &block
+      @current_page.send(name, *args, &block)
+    end
+  end
+end

data/lib/page_magic/wait.rb

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