page_magic 1.0.0.alpha4 → 1.0.0.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a6a5a8192c367103828b5dd1a471cd38f8d2440
-  data.tar.gz: 93107e43e4697a659d38e6d41875c52698e6caf9
+  metadata.gz: b33162c06d10048ac36843da5cd88309ad7184dc
+  data.tar.gz: 8c92249eb7b1c575dc1465b7fa4d8c35bd8bb06b
 SHA512:
-  metadata.gz: 8fb9a1fc03dca9d10af4b854d0f968de74b57269bcfd2d6bf8e6f8db452e336173096e678a4619f8c55be8fc2234016369ff6cd66209a7e023590e5d16d4e8af
-  data.tar.gz: 676d99b55ed4baa40dc576a6277393f54e9d77225f9f8f73a3680d7a290a5d44fd89c515144e94d5d559643ab386adcf099ad64a135cdc4ab6482eefd2576b72
+  metadata.gz: 58ec1e9df6f5a7194e5a4a3af215ead0bb42b49df4fe0485f91e4556b4aa49f4b0e2aa0a576999faca425c89cce75a2bf1f8147be6561ec7f131982a4710d79a
+  data.tar.gz: 97d1f7e0db82b33d7b066738b484dc3b6d7c83d75a7462429aaa6eb5a03e37b139aaf357ea671a2717df23109e0332d2b8d3c2508bb3a43a41d8b34567a467e4

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Documentation:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - 'pkg/**/*'
+    - 'vendor/**/*'
+    - 'coverage/**/*'
+    - '.idea/**/*'

data/Gemfile

@@ -1,19 +1,18 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gem 'capybara'
 gem 'activesupport'
 gem 'wait'
 
 group :test do
-  gem "watir-webdriver"
+  gem 'watir-webdriver'
   gem 'sinatra'
-  gem "rspec", require: 'rspec/core/rake_task'
-  gem "simplecov", require: false
+  gem 'rspec', require: 'rspec/core/rake_task'
+  gem 'simplecov', require: false
   gem 'poltergeist'
 end
 
 group :development do
-  gem "jeweler"
-  gem 'guard'
-  gem 'guard-ctags-bundler'
-end
+  gem 'jeweler'
+  gem 'rubocop', require: 'rubocop/rake_task'
+end

data/Gemfile.lock

@@ -8,6 +8,9 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.3.6)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
     builder (3.2.2)
     capybara (2.1.0)
       mime-types (>= 1.16)
@@ -15,17 +18,13 @@ 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
@@ -34,14 +33,6 @@ 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)
     i18n (0.7.0)
@@ -57,12 +48,6 @@ 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)
     minitest (5.7.0)
@@ -77,24 +62,21 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
     poltergeist (1.4.1)
       capybara (~> 2.1.0)
       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)
+    powerpack (0.1.1)
     rack (1.5.2)
     rack-protection (1.5.0)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
+    rainbow (2.0.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)
@@ -105,6 +87,13 @@ GEM
     rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.4)
+    rubocop (0.34.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
     rubyzip (0.9.9)
     selenium-webdriver (2.35.1)
       childprocess (>= 0.2.5)
@@ -119,11 +108,8 @@ GEM
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
-    slop (3.5.0)
-    thor (0.19.1)
     thread_safe (0.3.5)
     tilt (1.4.1)
-    timers (1.1.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     wait (0.5.1)
@@ -140,11 +126,10 @@ PLATFORMS
 DEPENDENCIES
   activesupport
   capybara
-  guard
-  guard-ctags-bundler
   jeweler
   poltergeist
   rspec
+  rubocop
   simplecov
   sinatra
   wait

data/Rakefile

@@ -1,19 +1,21 @@
-Bundler.require :test,:development
+Bundler.require :test, :development
+
+RuboCop::RakeTask.new
 
 RSpec::Core::RakeTask.new(:spec) do
-  ENV['coverage'] = "true"
+  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.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']
 end
 
 Jeweler::RubygemsDotOrgTasks.new
 
-task :default => :spec
+task default: :spec

data/VERSION

@@ -1 +1 @@
-1.0.0.alpha4
+1.0.0.alpha5

data/lib/ext/string.rb

@@ -1,9 +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
+    gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('-', '_')
+      .downcase
   end
-end
+end

data/lib/page_magic/driver.rb

@@ -6,7 +6,7 @@ module PageMagic
       @supported_browsers = supported_browsers
     end
 
-    def support? browser
+    def support?(browser)
       supported_browsers.include?(browser)
     end
 
@@ -16,4 +16,4 @@ module PageMagic
       driver_clazz.new(app, options)
     end
   end
-end
+end

data/lib/page_magic/drivers/poltergeist.rb

@@ -5,5 +5,4 @@ module PageMagic
       Capybara::Poltergeist::Driver
     end
   end
-
-end
+end

data/lib/page_magic/drivers/rack_test.rb

@@ -4,4 +4,4 @@ module PageMagic
       Capybara::RackTest::Driver
     end
   end
-end
+end

data/lib/page_magic/drivers/selenium.rb

@@ -1,8 +1,8 @@
 module PageMagic
   class Drivers
-    Selenium = Driver.new(:chrome, :firefox)  do
+    Selenium = Driver.new(:chrome, :firefox) do
       require 'watir-webdriver'
       Capybara::Selenium::Driver
     end
   end
-end
+end

data/lib/page_magic/drivers.rb

@@ -2,19 +2,18 @@ require 'page_magic/driver'
 module PageMagic
   class Drivers
     def all
-      @all ||=[]
+      @all ||= []
     end
 
     def register(driver)
       all << driver
     end
 
-
-    def find browser
-      all.find{|driver|driver.support?(browser)}
+    def find(browser)
+      all.find { |driver| driver.support?(browser) }
     end
 
-    def load path="#{__dir__}/drivers"
+    def load(path = "#{__dir__}/drivers")
       require 'active_support/inflector'
 
       Dir["#{path}/*.rb"].each do |driver_file|
@@ -24,7 +23,7 @@ module PageMagic
       end
     end
 
-    def == other
+    def ==(other)
       other.is_a?(Drivers) && other.all == other.all
     end
   end

data/lib/page_magic/element.rb

@@ -1,7 +1,6 @@
 module PageMagic
-
   module MethodObserver
-    def singleton_method_added arg
+    def singleton_method_added(arg)
       @singleton_methods_added = true unless arg == :singleton_method_added
     end
 
@@ -16,34 +15,36 @@ module PageMagic
     include Elements
 
     class << self
-      def inherited clazz
+      def inherited(clazz)
         clazz.extend(Elements)
 
-        def clazz.selector selector=nil
+        def clazz.selector(selector = nil)
           return @selector unless selector
           @selector = selector
         end
       end
     end
 
-    def initialize name, parent_page_element, options, &block
-      options = {type: :element, selector: {}, browser_element: nil}.merge(options)
+    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
+      @parent_page_element = parent_page_element
+      @type = options[:type]
+      @name = name.to_s.downcase.to_sym
 
       extend MethodObserver
       expand &block if block
     end
 
-    def expand *args, &block
+    def expand(*args, &block)
       instance_exec *args, &block
     end
 
-    def selector selector=nil
+    def selector(selector = nil)
       return @selector unless selector
       @selector = selector
     end
@@ -56,62 +57,62 @@ module PageMagic
       @parent_page_element.session
     end
 
-    def before &block
+    def before(&block)
       return @before_hook unless block
       @before_hook = block
     end
 
-    def after &block
+    def after(&block)
       return @after_hook unless block
       @after_hook = block
     end
 
-    def method_missing method, *args
+    def method_missing(method, *args)
+      element_context(args).send(method, args.first)
+    rescue ElementMissingException
       begin
-        ElementContext.new(self, @browser_element, self, *args).send(method, args.first)
-      rescue ElementMissingException
-        begin
-          @browser_element.send(method, *args)
-        rescue
-          super
-        end
+        @browser_element.send(method, *args)
+      rescue
+        super
       end
     end
 
-    def browser_element *args
+    def respond_to?(*args)
+      super || element_context.respond_to?(*args) || @browser_element.respond_to?(*args)
+    end
+
+    def browser_element(*_args)
       return @browser_element if @browser_element
-      raise UndefinedSelectorException, "Pass a selector/define one on the class" if @selector.empty?
+      fail UndefinedSelectorException, 'Pass a selector/define one on the class' if @selector.empty?
       if @selector
         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
-
+                                                     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
+                                                         fail UnsupportedSelectorException
+                                                       end
 
+                                                     else
+                                                       fail UnsupportedSelectorException
+                                                     end
 
         finder_args = [selector_type, selector_arg].compact
         finder_args << options unless options.empty?
@@ -119,5 +120,11 @@ module PageMagic
       end
       @browser_element
     end
+
+    private
+
+    def element_context(*args)
+      ElementContext.new(self, @browser_element, self, *args)
+    end
   end
 end

data/lib/page_magic/element_context.rb

@@ -1,26 +1,23 @@
 module PageMagic
-
   class ElementMissingException < Exception
-
   end
 
   class ElementContext
-
     attr_reader :caller, :page_element
 
-    def initialize page_element, browser, caller, *args
+    def initialize(page_element, browser, caller, *_args)
       @page_element = page_element
       @browser = browser
       @caller = caller
     end
 
-    def method_missing method, *args
+    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]
+      element_locator_factory = @page_element.element_definitions[method]
 
-      raise ElementMissingException, "Could not find: #{method}" unless element_locator_factory
+      fail ElementMissingException, "Could not find: #{method}" unless element_locator_factory
 
       if args.empty?
         element_locator = element_locator_factory.call(@page_element, nil)
@@ -32,16 +29,21 @@ module PageMagic
         apply_hooks(page_element: element_locator.browser_element,
                     capybara_method: action_method,
                     before_hook: element_locator.before,
-                    after_hook: element_locator.after,
-        )
+                    after_hook: element_locator.after
+                   )
       end
 
       element_locator.section? ? element_locator : element_locator.browser_element
     end
 
+    def respond_to?(*args)
+      @page_element.element_definitions.keys.include?(args.first)
+    end
+
     def apply_hooks(options)
       _self = self
-      page_element, capybara_method = options[:page_element], options[:capybara_method]
+      page_element = options[:page_element]
+      capybara_method = options[:capybara_method]
       if page_element.respond_to?(capybara_method)
         original_method = page_element.method(capybara_method)
 
@@ -53,13 +55,11 @@ module PageMagic
       end
     end
 
-
-    def call_hook &block
+    def call_hook(&block)
       @executing_hooks = true
-      result = self.instance_exec @browser, &block
+      result = instance_exec @browser, &block
       @executing_hooks = false
       result
     end
-
   end
 end

data/lib/page_magic/elements.rb

@@ -8,7 +8,7 @@ module PageMagic
     class InvalidMethodNameException < Exception
     end
 
-    def self.extended clazz
+    def self.extended(clazz)
       clazz.class_eval do
         unless instance_methods.include?(:browser_element)
           attr_reader :browser_element
@@ -20,8 +20,8 @@ module PageMagic
       end
     end
 
-    def method_added method
-      raise InvalidMethodNameException, "method name matches element name" if element_definitions[method]
+    def method_added(method)
+      fail InvalidMethodNameException, 'method name matches element name' if element_definitions[method]
     end
 
     def elements(browser_element, *args)
@@ -31,11 +31,10 @@ module PageMagic
     TYPES = [:element, :text_field, :button, :link, :checkbox, :select_list, :radios, :textarea, :section]
     TYPES.each do |type|
       define_method type do |*args, &block|
-
         first_arg = args.first
         if first_arg.is_a?(Symbol)
           name, object = args
-          options = {type: type}
+          options = { type: type }
           if object.is_a?(Hash)
             options[:selector] = object
           else
@@ -44,7 +43,7 @@ module PageMagic
 
           add_element_definition(name) do |*args_for_block|
             page_section = PageMagic::Element.new name, args_for_block.delete_at(0), options
-            page_section.expand *args_for_block, &(block || Proc.new {})
+            page_section.expand *args_for_block, &(block || proc {})
             page_section
           end
 
@@ -64,11 +63,11 @@ module PageMagic
       end
     end
 
-    def add_element_definition name, &block
-      raise InvalidElementNameException, "duplicate page element defined" if element_definitions[name]
+    def add_element_definition(name, &block)
+      fail InvalidElementNameException, 'duplicate page element defined' if element_definitions[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 }
+      fail InvalidElementNameException, 'a method already exists with this method name' if methods.find { |method| method == name }
 
       element_definitions[name] = block
     end
@@ -77,4 +76,4 @@ module PageMagic
       @element_definitions ||= {}
     end
   end
-end
+end

data/lib/page_magic/exceptions.rb

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

data/lib/page_magic/page_magic.rb

@@ -1,8 +1,7 @@
 module PageMagic
   attr_reader :browser, :session
 
-  def initialize session=Session.new(Capybara.current_session), options={}, &block
-
+  def initialize(session = Session.new(Capybara.current_session), options = {}, &block)
     @browser = session.raw_session
     @session = session
 
@@ -15,8 +14,8 @@ module PageMagic
     @browser.title
   end
 
-  def text_on_page? text
-    text().downcase.include?(text.downcase)
+  def text_on_page?(text)
+    text.downcase.include?(text.downcase)
   end
 
   def visit
@@ -28,11 +27,15 @@ module PageMagic
     @browser.text
   end
 
-  def method_missing method, *args
-    ElementContext.new(self, @browser, self).send(method, *args)
+  def method_missing(method, *args)
+    element_context.send(method, *args)
   end
-end
-
-
 
+  def respond_to?(*args)
+    super || element_context.respond_to?(*args)
+  end
 
+  def element_context
+    ElementContext.new(self, @browser, self)
+  end
+end