pincers 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94c141298bd94fe5be1c1facece4c4c3b3833601
-  data.tar.gz: e747e9e4e8eb54e8703fb2763ae718ccc9cdddf2
+  metadata.gz: 58cb503232b2361b44d079c62928c24950e128a8
+  data.tar.gz: ea7d053337c7ca2d00d57bb0a87fa8a5c6f18134
 SHA512:
-  metadata.gz: 01cc35baece47af8cbdfbbc0a1633287d1205c9bd81a1f6b69b07854c21662ead2b72acbedf477ae3e8ddb4779bf05b9dadd4c4898720d073531913a1245cfb4
-  data.tar.gz: b216663dab188b2ea1f37b6e635c7fe290a63900cf8282f402e2a53a9eabb19bcbcdb4a570dcde348de7c57f909dd51b7dc9fa1acad1a4ccae52be7131227e47
+  metadata.gz: fafc923902254504e1fc18f42db4c088f7bbc8e587db1643e4400d18140845b9c9db86291cfed87b7aabae59d882b98a035f822ce8061fd00f3740e57d1ed2fb
+  data.tar.gz: 386cc875106ecd99a7ec55a454177b92954439fd1a00e5be4b861bce5387b68078fea9207fba98e84b4c675867e45160bbc676a006ad37d7cc9d2505c9ce46d8

data/lib/pincers/backend/base.rb

@@ -44,6 +44,10 @@ module Pincers::Backend
       ensure_implementation :refresh_document
     end
 
+    def close_document
+      ensure_implementation :close_document
+    end
+
     def search_by_css(_element, _selector, _limit)
       ensure_implementation :search_by_css
     end

data/lib/pincers/backend/nokogiri.rb

@@ -13,6 +13,10 @@ module Pincers::Backend
       document.title
     end
 
+    def close_document
+      # no closing needed
+    end
+
     def search_by_css(_element, _selector, _limit)
       # nokogiri does not do any query level optimization when searching just one node
       _element.css _selector

data/lib/pincers/backend/webdriver.rb

@@ -5,11 +5,10 @@ module Pincers::Backend
 
   class Webdriver < Base
 
-    attr_reader :driver
+    alias :driver :document
 
     def initialize(_driver)
       super _driver
-      @driver = _driver
     end
 
     def javascript_enabled?
@@ -17,35 +16,39 @@ module Pincers::Backend
     end
 
     def document_root
-      [@driver]
+      [driver]
     end
 
     def document_url
-      @driver.current_url
+      driver.current_url
     end
 
     def document_title
-      @driver.title
+      driver.title
     end
 
     def fetch_cookies
-      @driver.manage.all_cookies
+      driver.manage.all_cookies
     end
 
     def navigate_to(_url)
-      @driver.get _url
+      driver.get _url
     end
 
     def navigate_forward(_steps)
-      _steps.times { @driver.navigate.forward }
+      _steps.times { driver.navigate.forward }
     end
 
     def navigate_back(_steps)
-      _steps.times { @driver.navigate.back }
+      _steps.times { driver.navigate.back }
     end
 
     def refresh_document
-      @driver.navigate.refresh
+      driver.navigate.refresh
+    end
+
+    def close_document
+      driver.quit rescue nil
     end
 
     def search_by_css(_element, _selector, _limit)
@@ -67,7 +70,7 @@ module Pincers::Backend
     end
 
     def extract_element_html(_element)
-      return @driver.page_source if _element == @driver
+      return driver.page_source if _element == driver
       _element.attribute 'outerHTML'
     end
 
@@ -122,11 +125,11 @@ module Pincers::Backend
     end
 
     def switch_to_frame(_element)
-      @driver.switch_to.frame _element
+      driver.switch_to.frame _element
     end
 
     def switch_to_top_frame
-      @driver.switch_to.default_content
+      driver.switch_to.default_content
     end
 
     def check_visible(_elements)
@@ -156,7 +159,7 @@ module Pincers::Backend
     end
 
     def actions
-      @driver.action
+      driver.action
     end
 
     def click_with_modifiers(_element, _modifiers)
@@ -168,13 +171,13 @@ module Pincers::Backend
     end
 
     def assert_has_input_devices_for(_name)
-      unless @driver.kind_of? Selenium::WebDriver::DriverExtensions::HasInputDevices
+      unless driver.kind_of? Selenium::WebDriver::DriverExtensions::HasInputDevices
         raise MissingFeatureError, _name
       end
     end
 
     def ensure_element(_element)
-      return @driver.find_element tag_name: 'html' if _element == @driver
+      return driver.find_element tag_name: 'html' if _element == driver
       _element
     end
 

data/lib/pincers/core/root_context.rb

@@ -20,6 +20,10 @@ module Pincers::Core
       true
     end
 
+    def document
+      @backend.document
+    end
+
     def backend
       @backend
     end
@@ -72,6 +76,11 @@ module Pincers::Core
       self
     end
 
+    def close
+      wrap_errors { backend.close_document }
+      self
+    end
+
     def default_timeout
       @config[:wait_timeout]
     end

data/lib/pincers/core/search_context.rb

@@ -38,10 +38,6 @@ module Pincers::Core
       root.backend
     end
 
-    def document
-      backend.document
-    end
-
     def elements
       reload_elements :all
       @elements
@@ -53,7 +49,7 @@ module Pincers::Core
     end
 
     def element!
-      wait?(:present) unless frozen? or advanced_mode?
+      wait(:present) unless frozen? or advanced_mode?
       raise Pincers::EmptySetError.new self if empty?
       element
     end
@@ -184,7 +180,7 @@ module Pincers::Core
       end
     end
 
-    def wait(_condition, _options)
+    def wait(_condition, _options={})
       raise Pincers::ConditionTimeoutError.new self, _condition unless wait?(_condition, _options)
       return self
     end
@@ -210,14 +206,13 @@ module Pincers::Core
       rescue Pincers::Error
         raise
       rescue Exception => exc
-        raise Pincers::BackendError.new self, exc
+        raise Pincers::BackendError.new(self, exc)
       end
     end
 
     def perform_action
       wrap_errors do
-        wait?(:actionable) unless advanced_mode?
-        raise Pincers::EmptySetError.new self if empty?
+        wait(:actionable) unless advanced_mode?
         yield elements.first
       end
       self

data/lib/pincers/errors.rb

@@ -56,7 +56,7 @@ module Pincers
     attr_reader :original
 
     def initialize(_context, _exc)
-      super _context, "Backend error: #{_exc.message}"
+      super _context, "#{_exc.class.to_s}: #{_exc.message}"
       @document = _context.document
       @original = _exc
     end

data/lib/pincers/factories/base.rb

@@ -0,0 +1,36 @@
+require 'pincers/core/root_context'
+
+module Pincers::Factories
+
+  class Base
+
+    def self.new_context(_options)
+      self.new(_options).new_context
+    end
+
+    def initialize(_options)
+      @context_options = extract_context_options _options
+      @backend_options = _options
+    end
+
+    def new_context
+      backend = load_backend @backend_options
+      ::Pincers::Core::RootContext.new backend, @context_options
+    end
+
+    def load_backend(_options)
+      raise NotImplementedError
+    end
+
+  private
+
+    def extract_context_options(_options)
+      [:wait_interval, :wait_timeout, :advanced_mode].inject({}) do |opt, key|
+        opt[key] = _options.delete key if _options.key? key
+        opt
+      end
+    end
+
+  end
+
+end

data/lib/pincers/factories/nokogiri.rb

@@ -0,0 +1,18 @@
+require 'pincers/factories/base'
+require 'pincers/backend/nokogiri'
+
+module Pincers::Factories
+  class Nokogiri < Base
+
+    def load_backend(_options)
+      document = _options.delete(:document)
+
+      unless document.is_a? ::Nokogiri::HTML::Document
+        document = ::Nokogiri::HTML document, _options[:url], _options[:encoding], _options[:flags]
+      end
+
+      ::Pincers::Backend::Nokogiri.new document
+    end
+
+  end
+end

data/lib/pincers/factories/webdriver.rb

@@ -0,0 +1,96 @@
+require 'pincers/factories/base'
+require 'pincers/backend/webdriver'
+
+module Pincers::Factories
+  class Webdriver < Base
+
+    DEFAULT_SETUP = {
+      page_timeout: 60000
+    }
+
+    def load_backend(_options)
+      driver = _options.delete(:driver)
+
+      unless driver.is_a? Selenium::WebDriver::Driver
+        driver = create_driver driver, _options
+      else
+        setup_driver driver, _options
+      end
+
+      ::Pincers::Backend::Webdriver.new driver
+    end
+
+  private
+
+    def create_driver(_name, _user={})
+      setup_options = extract_setup_options _user
+      build_options = recommended_settings_for _name
+      build_options = apply_custom_options build_options, _user
+
+      driver = Selenium::WebDriver::Driver.for _name, build_options
+      setup_fresh_driver driver, setup_options
+      driver
+    end
+
+    def setup_fresh_driver(_driver, _options)
+      _driver.manage.window.resize_to 1280, 1024 # ensure desktop form factor
+      setup_driver _driver, DEFAULT_SETUP.merge(_options)
+    end
+
+    def setup_driver(_driver, _options)
+      _driver.manage.timeouts.implicit_wait = _options[:implicit_timeout] if _options.key? :implicit_timeout
+      _driver.manage.timeouts.page_load = _options[:page_timeout] if _options.key? :page_timeout
+      _driver.manage.timeouts.script_timeout = _options[:script_timeout] if _options.key? :script_timeout
+    end
+
+    def recommended_settings_for(_name)
+      case _name
+      when :phantomjs
+        {
+          desired_capabilities: phantomjs_capabilities
+        }
+      when :chrome
+        {
+          detach: false, # ensure browser is shut down on exit
+          desired_capabilities: chrome_capabilities
+        }
+      when :firefox
+        {
+          desired_capabilities: firefox_capabitilies
+        }
+      else {} end
+    end
+
+    def apply_custom_options(_options, _user)
+      if _user.key? :proxy
+        proxy = _user.delete(:proxy)
+        proxy = Selenium::WebDriver::Proxy.new http: proxy, ssl: proxy if proxy.is_a? String
+        _options.desired_capabilities.proxy = proxy
+      end
+
+      _options.merge _user
+    end
+
+    def extract_setup_options(_user)
+      [:implicit_timeout, :page_timeout, :script_timeout].inject({}) do |opt, key|
+        opt[key] = _user.delete key if _user.key? key
+        opt
+      end
+    end
+
+    def phantomjs_capabilities
+      Selenium::WebDriver::Remote::Capabilities.phantomjs({
+        'phantomjs.cli.args' => ['--ssl-protocol=any', '--web-security=false', '--ignore-ssl-errors=true', '--load-images=false']
+      })
+    end
+
+    def chrome_capabilities
+      Selenium::WebDriver::Remote::Capabilities.chrome
+    end
+
+    def firefox_capabitilies
+      Selenium::WebDriver::Remote::Capabilities.firefox
+    end
+
+  end
+end

data/lib/pincers/factory.rb

@@ -1,32 +1,33 @@
-require 'pincers/core/root_context'
-
 module Pincers
   module Factory
 
-    def for_webdriver(_driver, _options={})
-      require 'pincers/backend/webdriver'
+    def for_webdriver(_driver=nil, _options={}, &_block)
+      require 'pincers/factories/webdriver'
 
-      unless _driver.is_a? Selenium::WebDriver::Driver
-        _driver = Selenium::WebDriver::Driver.for _driver, _options
+      if _driver.is_a? Hash
+        _options = _driver
+        _driver = nil
       end
 
-      context Backend::Webdriver.new _driver
-    end
+      _options[:driver] = _driver || config.webdriver_bridge
 
-    def for_nokogiri(_document, _options={})
-      require 'pincers/backend/nokogiri'
+      context = Factories::Webdriver.new_context _options
 
-      unless _document.is_a? ::Nokogiri::HTML::Document
-        _document = ::Nokogiri::HTML _document, _options[:url], _options[:encoding], _options[:flags]
-      end
-
-      context Backend::Nokogiri.new _document
+      if _block
+        begin
+          yield context
+        ensure
+          context.close
+        end
+      else context end
     end
 
-  private
+    def for_nokogiri(_document, _options={})
+      require 'pincers/factories/nokogiri'
+
+      _options[:document] = _document
 
-    def context(_backend)
-      Core::RootContext.new _backend
+      Factories::Nokogiri.new_context _options
     end
 
   end

data/lib/pincers/support/configuration.rb

@@ -6,7 +6,11 @@ module Pincers::Support
     FIELDS = [
       [:wait_timeout, 10.0],
       [:wait_interval, 0.2],
-      [:advanced_mode, false]
+      [:advanced_mode, false],
+
+      # webdriver defaults
+      [:webdriver_bridge, :firefox],
+      [:webdriver_options, {}]
     ];
 
     FIELDS.each do |field|

data/lib/pincers/version.rb

@@ -1,3 +1,3 @@
 module Pincers
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pincers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ignacio Baixas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -222,6 +222,9 @@ files:
 - lib/pincers/extension/actions.rb
 - lib/pincers/extension/labs.rb
 - lib/pincers/extension/queries.rb
+- lib/pincers/factories/base.rb
+- lib/pincers/factories/nokogiri.rb
+- lib/pincers/factories/webdriver.rb
 - lib/pincers/factory.rb
 - lib/pincers/support/configuration.rb
 - lib/pincers/support/cookie_jar.rb