pincers 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 630d90affa2488ca53b79f63643a3257618dfb9f
-  data.tar.gz: 1b8cf519322c4e69c0f2219a51a1d8e587aecd70
+  metadata.gz: 88daefd24fb535d60be1252cb33ca632d6466c0f
+  data.tar.gz: abe5bde9ae30c13d6a424268e85606b383179d42
 SHA512:
-  metadata.gz: 29398e9d922ad46cab2754b9b249fd5b13588a80d0f8c3ad94208d57df72bf478b6e782da2ba9b9c18bd0f584db66f3f04ae7a10320adb91ca85eadc8b001a16
-  data.tar.gz: 8008abec35682cf438e7bd7a65a9cdaa3fad368167fb0051fd73b045edfa8ffe8c2f586807d684e33c291b950eb52d1ba6730a5decc66e7488d9aa4911e4f944
+  metadata.gz: 2726362f0e0d4dd95bf87c50f795f557ef670007b80990c22f1425a955d23d93796623433b50e0344075fd96260ddfbfbe88988edea541c19caf863894744985
+  data.tar.gz: 7d66fd52f27ceb87085d643cb8f0df8aeda19747e23cf69b9bb2811b610c5283aa87d9bfa6cd9f45017303ef6e9b477c56da57a6aeb7e10e4fec5098822605d9

data/lib/pincers/backend/base.rb

@@ -8,6 +8,10 @@ module Pincers::Backend
       @document = _document
     end
 
+    def javascript_enabled?
+      false
+    end
+
     def document_root
       ensure_implementation :document_root
     end
@@ -40,11 +44,11 @@ module Pincers::Backend
       ensure_implementation :refresh_document
     end
 
-    def search_by_css(_element, _selector)
+    def search_by_css(_element, _selector, _limit)
       ensure_implementation :search_by_css
     end
 
-    def search_by_xpath(_element, _selector)
+    def search_by_xpath(_element, _selector, _limit)
       ensure_implementation :search_by_xpath
     end
 
@@ -68,14 +72,34 @@ module Pincers::Backend
       ensure_implementation :clear_input
     end
 
+    def element_is_actionable?(_element)
+      return true
+    end
+
     def set_element_text(_element, _value)
       ensure_implementation :set_element_text
     end
 
-    def click_on_element(_element)
+    def click_on_element(_element, _modifiers)
       ensure_implementation :click_on_element
     end
 
+    def right_click_on_element(_element)
+      ensure_implementation :right_click_on_element
+    end
+
+    def double_click_on_element(_element)
+      ensure_implementation :double_click_on_element
+    end
+
+    def hover_over_element(_element)
+      ensure_implementation :hover_over_element
+    end
+
+    def drag_and_drop(_element, _into)
+      ensure_implementation :drag_and_drop
+    end
+
     def switch_to_frame(_element)
       ensure_implementation :switch_to_frame
     end

data/lib/pincers/backend/nokogiri.rb

@@ -12,11 +12,13 @@ module Pincers::Backend
       document.title
     end
 
-    def search_by_css(_element, _selector)
+    def search_by_css(_element, _selector, _limit)
+      # nokogiri does not do any query level optimization when searching just one node
       _element.css _selector
     end
 
-    def search_by_xpath(_element, _selector)
+    def search_by_xpath(_element, _selector, _limit)
+      # nokogiri does not do any query level optimization when searching just one node
       _element.xpath _selector
     end
 

data/lib/pincers/backend/webdriver.rb

@@ -11,6 +11,10 @@ module Pincers::Backend
       @driver = _driver
     end
 
+    def javascript_enabled?
+      true
+    end
+
     def document_root
       [@driver]
     end
@@ -43,12 +47,12 @@ module Pincers::Backend
       @driver.navigate.refresh
     end
 
-    def search_by_css(_element, _selector)
-      _element.find_elements css: _selector
+    def search_by_css(_element, _selector, _limit)
+      search _element, { css: _selector }, _limit
     end
 
-    def search_by_xpath(_element, _selector)
-      _element.find_elements xpath: _selector
+    def search_by_xpath(_element, _selector, _limit)
+      search _element, { xpath: _selector }, _limit
     end
 
     def extract_element_tag(_element)
@@ -71,37 +75,61 @@ module Pincers::Backend
       _element[_name]
     end
 
+    def element_is_actionable?(_element)
+      # this is the base requisite in webdriver for actionable elements:
+      # non displayed items will always error on action
+      _element.displayed?
+    end
+
     def set_element_text(_element, _value)
-      _element = ensure_element _element
+      _element = ensure_ready_for_input _element
       _element.clear
       _element.send_keys _value
     end
 
-    def click_on_element(_element)
-      _element = ensure_element _element
-      _element.click
+    def click_on_element(_element, _modifiers)
+      _element = ensure_ready_for_input _element
+      if _modifiers.length == 0
+        _element.click
+      else
+        click_with_modifiers(_element, _modifiers)
+      end
     end
 
-    def switch_to_frame(_element)
-      @driver.switch_to.frame _element
+    def right_click_on_element(_element)
+      assert_has_input_devices_for :right_click_on_element
+      _element = ensure_ready_for_input _element
+      actions.context_click(_element).perform
     end
 
-    def switch_to_top_frame
-      @driver.switch_to.default_content
+    def double_click_on_element(_element)
+      assert_has_input_devices_for :double_click_on_element
+      _element = ensure_ready_for_input _element
+      actions.double_click(_element).perform
     end
 
-    # wait contitions
+    def hover_over_element(_element)
+      assert_has_input_devices_for :hover_over_element
+      _element = ensure_ready_for_input _element
+      actions.move_to(_element).perform
+    end
 
-    def check_present(_elements)
-      _elements.length > 0
+    def drag_and_drop(_element, _on)
+      assert_has_input_devices_for :drag_and_drop
+      _element = ensure_input_element _element
+      actions.drag_and_drop(_element, _on).perform
     end
 
-    def check_not_present(_elements)
-      _elements.length == 0
+    def switch_to_frame(_element)
+      @driver.switch_to.frame _element
+    end
+
+    def switch_to_top_frame
+      @driver.switch_to.default_content
     end
 
     def check_visible(_elements)
-      check_present(_elements) and _elements.first.displayed?
+      _elements.first.displayed?
     end
 
     def check_enabled(_elements)
@@ -114,11 +142,47 @@ module Pincers::Backend
 
   private
 
+    def search(_element, _query, _limit)
+      if _limit == 1
+        begin
+          [_element.find_element(_query)]
+        rescue Selenium::WebDriver::Error::NoSuchElementError
+          []
+        end
+      else
+        _element.find_elements _query
+      end
+    end
+
+    def actions
+      @driver.action
+    end
+
+    def click_with_modifiers(_element, _modifiers)
+      assert_has_input_devices_for :click_with_modifiers
+      _modifiers.each { |m| actions.key_down m }
+      actions.click _element
+      _modifiers.each { |m| actions.key_up m }
+      actions.perform
+    end
+
+    def assert_has_input_devices_for(_name)
+      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
       _element
     end
 
+    def ensure_ready_for_input(_element)
+      _element = ensure_element _element
+      Selenium::WebDriver::Wait.new.until { _element.displayed? }
+      _element
+    end
+
   end
 
 end

data/lib/pincers/core/root_context.rb

@@ -7,7 +7,7 @@ module Pincers::Core
     attr_reader :config
 
     def initialize(_backend, _config={})
-      super _backend.document_root, nil
+      super _backend.document_root, nil, nil
       @backend = _backend
       @config = Pincers.config.values.merge _config
     end
@@ -76,8 +76,17 @@ module Pincers::Core
       @config[:wait_interval]
     end
 
+    def advanced_mode?
+      @config[:advanced_mode]
+    end
+
   private
 
+    def wrap_siblings(_elements)
+      # root node siblings behave like childs
+      SearchContext.new _elements, self, nil
+    end
+
     def goto_url(_url)
       _url = "http://#{_url}" unless /^(https?|file|ftp):\/\// === _url
       backend.navigate_to _url

data/lib/pincers/core/search_context.rb

@@ -1,5 +1,6 @@
 require 'pincers/extension/queries'
 require 'pincers/extension/actions'
+require 'pincers/support/query'
 
 module Pincers::Core
   class SearchContext
@@ -8,13 +9,19 @@ module Pincers::Core
     include Pincers::Extension::Queries
     include Pincers::Extension::Actions
 
-    attr_accessor :parent, :elements
+    attr_reader :parent, :query
 
     def_delegators :elements, :length, :count, :empty?
 
-    def initialize(_elements, _parent)
+    def initialize(_elements, _parent, _query)
       @elements = _elements
+      @scope = if @elements.nil? then nil else :all end
       @parent = _parent
+      @query = _query
+    end
+
+    def frozen?
+      !backend.javascript_enabled? || @query.nil?
     end
 
     def root
@@ -29,17 +36,31 @@ module Pincers::Core
       backend.document
     end
 
+    def elements
+      reload_elements :all
+      @elements
+    end
+
     def element
-      elements.first
+      reload_elements :single
+      @elements.first
     end
 
     def element!
+      wait?(:present) unless frozen? or advanced_mode?
       raise Pincers::EmptySetError.new self if empty?
       element
     end
 
+    def reload
+      raise Pincers::FrozenSetError.new self if frozen?
+      parent.reload if parent_needs_reload?
+      wrap_errors { reload_elements }
+      self
+    end
+
     def each
-      elements.each { |el| yield wrap_elements [el] }
+      elements.each { |el| yield wrap_siblings [el] }
     end
 
     def [](*args)
@@ -48,31 +69,33 @@ module Pincers::Core
           backend.extract_element_attribute element!, args[0]
         end
       else
-        wrap_elements Array(elements.send(:[],*args))
+        wrap_siblings Array(elements.send(:[],*args))
       end
     end
 
     def first
-      if elements.first.nil? then nil else wrap_elements [elements.first] end
+      if element.nil? then nil else wrap_siblings [element] end
     end
 
     def first!
-      first or raise Pincers::EmptySetError.new(self)
+      wrap_siblings [element!]
     end
 
     def last
-      if elements.last.nil? then nil else wrap_elements [elements.last] end
+      if elements.last.nil? then nil else wrap_siblings [elements.last] end
     end
 
     def css(_selector, _options={})
-      search_with_options _options do
-        explode_elements { |e| backend.search_by_css e, _selector }
+      wrap_errors do
+        query = Pincers::Support::Query.new backend, :css, _selector, _options[:limit]
+        wrap_childs query
       end
     end
 
     def xpath(_selector, _options={})
-      search_with_options _options do
-        explode_elements { |e| backend.search_by_xpath e, _selector }
+      wrap_errors do
+        query = Pincers::Support::Query.new backend, :xpath, _selector, _options[:limit]
+        wrap_childs query
       end
     end
 
@@ -84,7 +107,7 @@ module Pincers::Core
 
     def text
       wrap_errors do
-        backend.extract_element_text element!
+        elements.map { |e| backend.extract_element_text e }.join
       end
     end
 
@@ -94,18 +117,38 @@ module Pincers::Core
       end
     end
 
-    # Input related
+    # input related
 
     def set_text(_value)
-      wrap_errors do
-        backend.set_element_text element!, _value
-      end
+      perform_action { |el| backend.set_element_text el, _value }
+    end
+
+    def click(*_modifiers)
+      perform_action { |el| backend.click_on_element el, _modifiers }
+    end
+
+    def right_click
+      perform_action { |el| backend.right_click_on_element el }
     end
 
-    def click
+    def double_click
+      perform_action { |el| backend.double_click_on_element el }
+    end
+
+    def hover
+      perform_action { |el| backend.hover_over_element el }
+    end
+
+    def drag_to(_element)
       wrap_errors do
-        backend.click_on_element element!
+        if advanced_mode?
+          wait_actionable
+          _element.wait_actionable
+        end
+
+        backend.drag_and_drop element!, _element.element!
       end
+      self
     end
 
     # context related
@@ -114,8 +157,43 @@ module Pincers::Core
       root.goto frame: self
     end
 
+    # waiting
+
+    def wait?(_condition, _options={}, &_block)
+      poll_until(_condition, _options) do
+        case _condition
+        when :present
+          ensure_present
+        when :actionable
+          ensure_present and ensure_actionable
+        else
+          check_method = "check_#{_condition}"
+          raise Pincers::MissingFeatureError.new check_method unless backend.respond_to? check_method
+          ensure_present and check_method.call(elements)
+        end
+      end
+    end
+
+    def wait(_condition, _options)
+      raise Pincers::ConditionTimeoutError.new self, _condition unless wait?(_condition, _options)
+      return self
+    end
+
   private
 
+    def advanced_mode?
+      root.advanced_mode?
+    end
+
+    def ensure_present
+      reload if element.nil?
+      not element.nil?
+    end
+
+    def ensure_actionable
+      backend.element_is_actionable? element
+    end
+
     def wrap_errors
       begin
         yield
@@ -126,39 +204,57 @@ module Pincers::Core
       end
     end
 
-    def wrap_elements(_elements)
-      SearchContext.new _elements, self
-    end
-
-    def search_with_options(_options, &_block)
+    def perform_action
       wrap_errors do
-        wait_for = _options.delete(:wait)
-        return wrap_elements _block.call unless wait_for
-        wrap_elements poll_until(wait_for, _options, &_block)
+        wait?(:actionable) unless advanced_mode?
+        raise Pincers::EmptySetError.new self if empty?
+        yield elements.first
       end
+      self
     end
 
-    def explode_elements
-      elements.inject([]) do |r, element|
-        r + yield(element)
-      end
+    def wrap_siblings(_elements)
+      SearchContext.new _elements, parent, nil
+    end
+
+    def wrap_childs(_query)
+      child_elements = if advanced_mode? then _query.execute(elements) else nil end
+      SearchContext.new child_elements, self, _query
+    end
+
+    def parent_needs_reload?
+      !parent.frozen? && parent.elements.count == 0
     end
 
-    def poll_until(_condition, _options, &_search)
-      check_method = "check_#{_condition}"
-      raise Pincers::MissingFeatureError.new check_method unless backend.respond_to? check_method
+    def reload_elements(_scope=nil)
+      case _scope
+      when :all
+        return if @scope == :all
+        @scope = :all
+      when :single
+        return unless @scope.nil?
+        @scope = :single
+      end
+
+      if @scope == :single
+        @elements = @query.execute parent.elements, 1 # force single record
+      else
+        @elements = @query.execute parent.elements
+        @scope = :all if @scope.nil?
+      end
+    end
 
+    def poll_until(_description, _options={})
       timeout = _options.fetch :timeout, root.default_timeout
       interval = _options.fetch :interval, root.default_interval
       end_time = Time.now + timeout
 
-      until Time.now > end_time
-        new_elements = _search.call
-        return new_elements if backend.send check_method, new_elements
+      while Time.now <= end_time
+        return true if !!yield
         sleep interval
       end
 
-      raise Pincers::ConditionTimeoutError.new self, _condition
+      return false
     end
 
   end

data/lib/pincers/errors.rb

@@ -26,6 +26,14 @@ module Pincers
 
   end
 
+  class FrozenSetError < ContextError
+
+    def initialize(_context)
+      super _context, "The set is frozen and cant be modified"
+    end
+
+  end
+
   class EmptySetError < ContextError
 
     def initialize(_context)

data/lib/pincers/support/configuration.rb

@@ -5,7 +5,8 @@ module Pincers::Support
 
     FIELDS = [
       [:wait_timeout, 10.0],
-      [:wait_interval, 0.2]
+      [:wait_interval, 0.2],
+      [:advanced_mode, false]
     ];
 
     FIELDS.each do |field|

data/lib/pincers/support/query.rb

@@ -0,0 +1,31 @@
+module Pincers::Support
+  class Query
+
+    attr_reader :lang, :query, :limit
+
+    def initialize(_backend, _lang, _query, _limit)
+      @backend = _backend
+      @lang = _lang
+      @query = _query
+      @limit = _limit
+    end
+
+    def execute(_elements, _force_limit=nil)
+      fun = case @lang
+      when :xpath then :search_by_xpath
+      else :search_by_css end
+
+      explode_elements _elements, fun, _force_limit || @limit
+    end
+
+    def explode_elements(_elements, _fun, _limit)
+      _elements.inject([]) do |r, element|
+        limit = _limit.nil? ? nil : _limit - r.count
+        r = r + @backend.send(_fun, element, @query, limit)
+        break r if !_limit.nil? && r.length >= _limit
+        next r
+      end
+    end
+
+  end
+end

data/lib/pincers/version.rb

@@ -1,3 +1,3 @@
 module Pincers
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pincers
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ignacio Baixas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -224,6 +224,7 @@ files:
 - lib/pincers/factory.rb
 - lib/pincers/support/configuration.rb
 - lib/pincers/support/cookie_jar.rb
+- lib/pincers/support/query.rb
 - lib/pincers/version.rb
 - lib/pincers.rb
 homepage: https://github.com/platanus/pincers