pincers 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b243194fe1a23f2a16a34c0e7007de2d9f4eecfc
-  data.tar.gz: b442f0a02e79c6fc600d1b50cff6187ffc0bc3d4
+  metadata.gz: a19d33e62f9611053e680e501b3bab925c4279fa
+  data.tar.gz: 2266ae44ad8606cc8dd7097c91d2d9ae64a8d80f
 SHA512:
-  metadata.gz: 9814b3a3c6139e62e53fea8b0448173196e2fd657656b9cfb49aa7856fd12e0d312842de844284e481821d223af838abf25f547107f7c90db921e10ee5969554
-  data.tar.gz: d91861c7c3ab3b717acfc703f758de7ea09dd1a89d6394b5c80932c069b4710a3d17b0b16dbc8004378ed4ce1d6985a77b4d631f9b5f1055515de171738bb95c
+  metadata.gz: 7764b044ebdfd024d894273fb511573644be4074415acc24fb46b5fc9f577d7dd5d95cc8cdbb90fbd6ac90de203c4852c4b590f837c64a58cd882c39a8a2f5d6
+  data.tar.gz: 3b35f1c8568797d90d2cb90a87b81997158b76428a3b62a550fa723b2770af8ee05d370d7de1ac4732f4b9feaca2eb4fd73502555d404a2c560f751ed39a82ad

data/lib/pincers/chenso/backend.rb

@@ -0,0 +1,162 @@
+require 'pincers/nokogiri/backend'
+require 'pincers/chenso/browsing_manager'
+require 'pincers/chenso/html_page_request'
+require 'pincers/chenso/html_form_request'
+require 'pincers/core/helpers/form'
+
+module Pincers::Chenso
+  class Backend < Pincers::Nokogiri::Backend
+
+    attr_reader :client, :browser
+
+    def initialize(_http_client)
+      super nil
+      @client = _http_client
+      @browser = BrowsingManager.new @client
+    end
+
+    def document
+      browser.document
+    end
+
+    def document_url
+      browser.current_url
+    end
+
+    def navigate_to(_url)
+      browser.push new_page_request _url
+    end
+
+    def navigate_forward(_steps)
+      browser.forward _steps
+    end
+
+    def navigate_back(_steps)
+      browser.back _steps
+    end
+
+    def refresh_document
+      browser.refresh
+    end
+
+    def set_element_text(_element, _value)
+      case classify _element
+      when :input_text, :input_email, :input_number, :textarea
+        # TODO: validations?
+        set_att _element, :value, _value
+      end
+    end
+
+    def click_on_element(_element, _modifiers)
+      case classify _element
+      when :a
+        navigate_link _element
+      when :option
+        select_option _element
+      when :input_checkbox
+        toggle_checkbox _element
+      when :input_radio
+        set_radio_button _element
+      when :input_submit, :button_submit, :button
+        submit_parent_form _element
+      end
+    end
+
+    def submit_form(_element)
+      form = new_form _element
+      load_in_target form_as_request(form), form.target
+    end
+
+    def as_http_client
+      @client.fork(false)
+    end
+
+    def switch_to_frame(_element)
+      if _element[:src] && !browser.switch_frame(_element[:src])
+        browser.load_frame(_element[:src], new_page_request(_element[:src]))
+      end
+    end
+
+    def switch_to_top_frame
+      browser.switch_top_frame
+    end
+
+  private
+
+    alias :get_att :extract_element_attribute
+    alias :set_att :set_element_attribute
+
+    def toggle_att(_element, _name)
+      set_att(_element, _name, !get_att(_element, _name))
+    end
+
+    def navigate_link(_element)
+      if get_att(_element, :href)
+        load_in_target new_page_request(get_att(_element, :href)), get_att(_element, :target)
+      end
+    end
+
+    def select_option(_element)
+      select_element = _element.at_xpath('ancestor::select')
+      unless get_att(select_element, :multiple)
+        select_element.xpath('.//option[@selected]').each { |o| set_att(o, :selected, false) }
+        set_att _element, :selected, true
+      else
+        toggle_att _element, :selected
+      end
+    end
+
+    def toggle_checkbox(_element)
+      toggle_att _element, :checked
+    end
+
+    def set_radio_button(_element)
+      form = _element.at_xpath('ancestor::form')
+      if form
+        siblings = form.xpath(".//input[@type='radio' and @name='#{get_att(_element, :name)}']")
+        siblings.each { |r| set_att(r, :checked, false) }
+      end
+      set_att _element, :checked, true
+    end
+
+    def submit_parent_form(_element)
+      form_element = _element.at_xpath('ancestor::form')
+      if form_element
+        form = new_form form_element, _element
+        load_in_target form_as_request(form), form.target
+      end
+    end
+
+    def load_in_target(_request, _target)
+      case _target
+      when nil, '_self'
+        browser.push _request
+      when '_top'
+        browser.switch_top_frame
+        browser.push _request
+      when '_parent'
+        browser.switch_parent_frame
+        browser.push _request
+      when '_blank'
+        # Should be: browser.load_window _request
+        browser.switch_top_frame
+        browser.push _request
+      else
+        frame = document.at_xpath("//iframe[@name='#{_target}']")
+        switch_to_frame frame
+      end
+    end
+
+    def new_page_request(_url)
+      HtmlPageRequest.new _url
+    end
+
+    def form_as_request(_form)
+      HtmlFormRequest.new _form
+    end
+
+    def new_form(_element, _trigger=nil)
+      Pincers::Core::Helpers::Form.new self, _element, _trigger
+    end
+  end
+end

data/lib/pincers/chenso/browsing_context.rb

@@ -0,0 +1,76 @@
+module Pincers::Chenso
+
+  class BrowsingContext
+
+    attr_reader :document
+
+    def initialize(_http_client)
+      @client = _http_client
+      @history = []
+      @pointer = -1
+      @childs = {}
+      @document = nil
+    end
+
+    def get_child(_id)
+      @childs[_id]
+    end
+
+    def load_child(_id)
+      @childs[_id] = self.class.new @client
+    end
+
+    def current_url
+      @client.uri.to_s
+    end
+
+    def refresh
+      if @pointer >= 0
+        navigate @history[@pointer]
+      else nil end
+    end
+
+    def push(_request)
+      @history.slice!(@pointer+1..-1)
+      @history.push _request
+      @pointer += 1
+      navigate _request
+    end
+
+    def back(_times=1)
+      # not sure about this: for now, back will stop at the first request
+      if @pointer < 0
+        nil
+      elsif _times >= @pointer
+        change_pointer 0
+      else
+        change_pointer @pointer - _times
+      end
+    end
+
+    def forward(_times=1)
+      max_pointer = @history.length - 1
+      if _times >= max_pointer - @pointer
+        change_pointer max_pointer
+      else
+        change_pointer @pointer + _times
+      end
+    end
+
+  private
+
+    def change_pointer(_new_pointer)
+      if _new_pointer != @pointer
+        @pointer = _new_pointer
+        navigate @history[@pointer]
+      else nil end
+    end
+
+    def navigate(_request)
+      @document = _request.execute @client
+      @childs.clear
+      @document
+    end
+
+  end
+end

data/lib/pincers/chenso/browsing_manager.rb

@@ -0,0 +1,67 @@
+require 'pincers/chenso/browsing_context'
+
+module Pincers::Chenso
+  class BrowsingManager
+    extend Forwardable
+
+    def_delegators :context, :document, :current_url, :push, :forward, :back, :refresh
+
+    def initialize(_client)
+      @client = _client
+      @index = 0
+      @windows = [
+        [build_root_context]
+      ]
+    end
+
+    def switch_window(_index)
+      @index = _index
+      switch_top_frame
+    end
+
+    def switch_frame(_id)
+      new_context = context.get_child _id
+      return false if new_context.nil?
+      window << new_context
+      return true
+    end
+
+    def switch_top_frame
+      window.slice!(1..-1) if window.length > 1
+    end
+
+    def switch_parent_frame
+      window.pop if window.length > 1
+    end
+
+    def load_frame(_id, _request)
+      child_context = context.load_child _id
+      child_context.push _request
+      window << child_context
+    end
+
+    def load_window(_request)
+      context = build_root_context
+      context.push _request
+      windows << [context]
+      @index = windows.length - 1
+    end
+
+  private
+
+    attr_reader :windows
+
+    def window
+      @windows[@index]
+    end
+
+    def context
+      window.last
+    end
+
+    def build_root_context
+      BrowsingContext.new @client
+    end
+
+  end
+end

data/lib/pincers/chenso/factory.rb

@@ -0,0 +1,27 @@
+require 'pincers/core/base_factory'
+require 'pincers/chenso/backend'
+require 'pincers/http/client'
+
+module Pincers::Chenso
+  class Factory < Pincers::Core::BaseFactory
+
+    def load_backend(_options)
+      _options[:headers] = default_headers.merge! _options.fetch(:headers, {})
+      client = Pincers::Http::Client.build_from_options _options
+      Pincers::Chenso::Backend.new client
+    end
+
+  private
+
+    def default_headers
+      {
+        'User-Agent' => user_agent
+      }
+    end
+
+    def user_agent
+      "Pincers/#{Pincers::VERSION}"
+    end
+
+  end
+end

data/lib/pincers/chenso/html_form_request.rb

@@ -0,0 +1,7 @@
+module Pincers::Chenso
+  class HtmlFormRequest < HtmlPageRequest
+    def initialize(_form)
+      super _form.action, _form.method, _form.inputs, _form.encoding
+    end
+  end
+end

data/lib/pincers/chenso/html_page_request.rb

@@ -0,0 +1,27 @@
+module Pincers::Chenso
+  class HtmlPageRequest
+
+    DEFAULT_HEADERS = {
+      'Accept' => 'text/html,application/xhtml+xml,application/xml',
+      'Cache-Control' => 'no-cache'
+    }
+
+    def initialize(_url, _method=:get, _data=nil, _encoding=nil)
+      @url = _url
+      @method = _method
+      @data = _data
+      @encoding = _encoding
+    end
+
+    def execute(_client)
+      @uri = _client.absolute_uri_for @url if @uri.nil?
+
+      _client.send(@method, @uri) do |request|
+        request.headers.merge DEFAULT_HEADERS
+        request.set_form_data(@data, @encoding) unless @data.nil?
+      end
+
+      ::Nokogiri::HTML _client.content
+    end
+  end
+end

data/lib/pincers/{backend/base.rb → core/base_backend.rb}

@@ -1,17 +1,15 @@
-module Pincers::Backend
+module Pincers::Core
 
-  class Base
-
-    attr_reader :document
-
-    def initialize(_document)
-      @document = _document
-    end
+  class BaseBackend
 
     def javascript_enabled?
       false
     end
 
+    def document
+      ensure_implementation :document
+    end
+
     def document_root
       ensure_implementation :document_root
     end
@@ -56,6 +54,10 @@ module Pincers::Backend
       ensure_implementation :search_by_xpath
     end
 
+    def elements_equal(_element_a, _element_b)
+      _element_a == _element_b
+    end
+
     def extract_element_tag(_element)
       ensure_implementation :extract_element_tag
     end
@@ -108,6 +110,10 @@ module Pincers::Backend
       ensure_implementation :drag_and_drop
     end
 
+    def submit_form(_element)
+      ensure_implementation :submit_form
+    end
+
     def switch_to_frame(_element)
       ensure_implementation :switch_to_frame
     end
@@ -120,6 +126,10 @@ module Pincers::Backend
       ensure_implementation :switch_to_parent_frame
     end
 
+    def as_http_client
+      ensure_implementation :as_http_client
+    end
+
     def fetch_resource
       ensure_implementation :fetch_resource
     end

data/lib/pincers/{factories/base.rb → core/base_factory.rb}

@@ -1,6 +1,6 @@
-module Pincers::Factories
+module Pincers::Core
 
-  class Base
+  class BaseFactory
 
     def self.new_context(_options)
       self.new(_options).new_context