pincers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9be2262d6757498e82ec195e8e8e5109226df675
+  data.tar.gz: 73e0e4943ec46e3dcbd35a043dda468bbb1e75f2
+SHA512:
+  metadata.gz: a7fcc330eb821333f73e1d9f4989084e5d7a0d161703542725ab606a244ac10305f69430bb3522e1c7cc5d8a1746a8bb974f4d9585170aa27b59822980c9afd5
+  data.tar.gz: 917e6139161b82a3a817b9fb6deb3d31295e60658e138d9004efcb8712f27f41e691c963fedc200c8de22d12c4d398ef5a0e4f2f1176c9523a68b0605b21ab53

data/lib/pincers.rb

@@ -0,0 +1,20 @@
+require "forwardable"
+require "pincers/version"
+require "pincers/errors"
+require "pincers/factory"
+require "pincers/support/configuration"
+
+module Pincers
+  extend Factory
+
+  @@config = Support::Configuration.new
+
+  def self.config
+    @@config
+  end
+
+  def self.configure
+    yield @@config
+  end
+
+end

data/lib/pincers/backend/base.rb

@@ -0,0 +1,87 @@
+module Pincers::Backend
+
+  class Base
+
+    attr_reader :document
+
+    def initialize(_document)
+      @document = _document
+    end
+
+    def document_root
+      ensure_implementation :document_root
+    end
+
+    def document_url
+      ensure_implementation :document_url
+    end
+
+    def document_title
+      ensure_implementation :document_title
+    end
+
+    def document_source
+      ensure_implementation :document_source
+    end
+
+    def fetch_cookies
+      ensure_implementation :fetch_cookies
+    end
+
+    def navigate_to(_url)
+      ensure_implementation :navigate_to
+    end
+
+    def navigate_forward(_steps)
+      ensure_implementation :navigate_forward
+    end
+
+    def navigate_back(_steps)
+      ensure_implementation :navigate_back
+    end
+
+    def refresh_document
+      ensure_implementation :refresh_document
+    end
+
+    def search_by_css(_element, _selector)
+      ensure_implementation :search_by_css
+    end
+
+    def search_by_xpath(_element, _selector)
+      ensure_implementation :search_by_xpath
+    end
+
+    def extract_element_text(_element)
+      ensure_implementation :extract_element_text
+    end
+
+    def extract_element_html(_element)
+      ensure_implementation :extract_element_html
+    end
+
+    def extract_element_attribute(_element, _name)
+      ensure_implementation :extract_element_attribute
+    end
+
+    def clear_input(_element)
+      ensure_implementation :clear_input
+    end
+
+    def fill_input(_element, _value)
+      ensure_implementation :fill_input
+    end
+
+    def load_frame_element(_element)
+      ensure_implementation :load_frame_element
+    end
+
+  private
+
+    def ensure_implementation(_name)
+      raise MissingFeatureError.new _name
+    end
+
+  end
+
+end

data/lib/pincers/backend/nokogiri.rb

@@ -0,0 +1,29 @@
+require 'pincers/backend/base'
+
+module Pincers::Backend
+
+  class Nokogiri < Base
+
+    def search_by_css(_element, _selector)
+      _element.css _selector
+    end
+
+    def search_by_xpath(_element, _selector)
+      _element.xpath _selector
+    end
+
+    def extract_element_text(_element)
+      # _element.text
+    end
+
+    def extract_element_html(_element)
+      # _element['outerHTML']
+    end
+
+    def extract_element_attribute(_element, _name)
+      # _element[_name]
+    end
+
+  end
+
+end

data/lib/pincers/backend/webdriver.rb

@@ -0,0 +1,108 @@
+require 'pincers/backend/base'
+
+module Pincers::Backend
+
+  class Webdriver < Base
+
+    attr_reader :driver
+
+    def initialize(_driver)
+      super _driver
+      @driver = _driver
+    end
+
+    def document_root
+      [@driver]
+    end
+
+    def document_url
+      @driver.current_url
+    end
+
+    def document_title
+      @driver.title
+    end
+
+    def document_source
+      @driver.page_source
+    end
+
+    def fetch_cookies
+      @driver.manage.all_cookies
+    end
+
+    def navigate_to(_url)
+      @driver.get _url
+    end
+
+    def navigate_forward(_steps)
+      _steps.times { @driver.navigate.forward }
+    end
+
+    def navigate_back(_steps)
+      _steps.times { @driver.navigate.back }
+    end
+
+    def refresh_document
+      @driver.navigate.refresh
+    end
+
+    def search_by_css(_element, _selector)
+      _element.find_elements css: _selector
+    end
+
+    def search_by_xpath(_element, _selector)
+      _element.find_elements xpath: _selector
+    end
+
+    def extract_element_text(_element)
+
+      _element.text
+    end
+
+    def extract_element_html(_element)
+      if _element == @driver then @driver.page_source else _element.attribute('outerHTML') end
+    end
+
+    def extract_element_attribute(_element, _name)
+      _element[_name]
+    end
+
+    def clear_input(_element)
+      _element.clear
+    end
+
+    def fill_input(_element, _value)
+      _element.send_keys _value
+    end
+
+    def load_frame_element(_element)
+      driver.switch_to.frame _element
+      self
+    end
+
+    # wait contitions
+
+    def check_present(_elements)
+      _elements.length > 0
+    end
+
+    def check_not_present(_elements)
+      _elements.length == 0
+    end
+
+    def check_visible(_elements)
+      check_present(_elements) and _elements.first.displayed?
+    end
+
+    def check_enabled(_elements)
+      check_visible(_elements) and _elements.first.enabled?
+    end
+
+    def check_not_visible(_elements)
+      not _elements.any? { |e| e.displayed? }
+    end
+
+  end
+
+end

data/lib/pincers/core/root_context.rb

@@ -0,0 +1,72 @@
+require 'pincers/support/cookie_jar'
+require 'pincers/core/search_context'
+
+module Pincers::Core
+  class RootContext < SearchContext
+
+    attr_reader :config
+
+    def initialize(_backend, _config={})
+      super _backend.document_root, nil
+      @backend = _backend
+      @config = Pincers.config.values.merge _config
+    end
+
+    def root
+      self
+    end
+
+    def backend
+      @backend
+    end
+
+    def url
+      wrap_errors { backend.document_url }
+    end
+
+    def uri
+      URI.parse url
+    end
+
+    def title
+      wrap_errors { backend.document_title }
+    end
+
+    def source
+      wrap_errors { backend.document_source }
+    end
+
+    def cookies
+      @cookies ||= CookieJar.new backend
+    end
+
+    def goto(_url)
+      wrap_errors { backend.navigate_to _url }
+      self
+    end
+
+    def forward(_steps=1)
+      wrap_errors { backend.navigate_forward _steps }
+      self
+    end
+
+    def back(_steps=1)
+      wrap_errors { backend.navigate_back _steps }
+      self
+    end
+
+    def refresh
+      wrap_errors { backend.refresh_document _steps }
+      self
+    end
+
+    def default_timeout
+      @config[:wait_timeout]
+    end
+
+    def default_interval
+      @config[:wait_interval]
+    end
+
+  end
+end

data/lib/pincers/core/search_context.rb

@@ -0,0 +1,184 @@
+module Pincers::Core
+  class SearchContext
+    include Enumerable
+    extend Forwardable
+
+    attr_accessor :parent, :elements
+
+    def_delegators :elements, :length, :count, :empty?
+
+    def initialize(_elements, _parent)
+      @elements = _elements
+      @parent = _parent
+    end
+
+    def root
+      parent.root
+    end
+
+    def backend
+      root.backend
+    end
+
+    def document
+      backend.document
+    end
+
+    def element
+      elements.first
+    end
+
+    def element!
+      raise Pincers::EmptySetError.new self if empty?
+      element
+    end
+
+    def each
+      elements.each { |el| yield wrap_elements [el] }
+    end
+
+    def [](*args)
+      if args[0].is_a? String or args[0].is_a? Symbol
+        wrap_errors do
+          backend.extract_element_attribute element!, args[0]
+        end
+      else
+        wrap_elements Array(elements.send(:[],*args))
+      end
+    end
+
+    def first
+      if elements.first.nil? then nil else wrap_elements [elements.first] end
+    end
+
+    def last
+      if elements.last.nil? then nil else wrap_elements [elements.last] end
+    end
+
+    def css(_selector, _options={})
+      search_with_options _options do
+        explode_elements { |e| backend.search_by_css e, _selector }
+      end
+    end
+
+    def xpath(_selector, _options={})
+      search_with_options _options do
+        explode_elements { |e| backend.search_by_xpath e, _selector }
+      end
+    end
+
+    def text
+      wrap_errors do
+        backend.extract_element_text element!
+      end
+    end
+
+    def classes
+      wrap_errors do
+        class_attr = backend.extract_element_attribute element!, 'class'
+        (class_attr || '').split(' ')
+      end
+    end
+
+    def to_html
+      wrap_errors do
+        elements.map { |e| backend.extract_element_html e }.join
+      end
+    end
+
+    # Input related
+
+    def set(_value)
+      wrap_errors do
+        backend.clear_input element!
+        backend.fill_input element!
+      end
+    end
+
+    def select(_value)
+      # TODO.
+    end
+
+    # context related
+
+    def enter
+      wrap_errors do
+        RootContext.new backend.load_frame_element(element!), root.config
+      end
+    end
+
+    # Any methods missing are forwarded to the main element (first)
+
+    def method_missing(_method, *_args, &_block)
+      wrap_errors do
+        m = /^(.*)_all$/.match _method.to_s
+        if m then
+          return [] if empty?
+          elements.map { |e| e.send(m[1], *_args, &_block) }
+        else
+          element!.send(_method, *_args, &_block)
+        end
+      end
+    end
+
+    def respond_to?(_method, _include_all=false)
+      return true if super
+      m = /^.*_all$/.match _method.to_s
+      if m then
+        return true if empty?
+        elements.first.respond_to? m[1], _include_all
+      else
+        return true if empty?
+        elements.first.respond_to? _method, _include_all
+      end
+    end
+
+  private
+
+    def wrap_errors
+      begin
+        yield
+      rescue Pincers::Error
+        raise
+      rescue Exception => exc
+        raise Pincers::BackendError.new self, exc
+      end
+    end
+
+    def wrap_elements(_elements)
+      SearchContext.new _elements, self
+    end
+
+    def search_with_options(_options, &_block)
+      wrap_errors do
+        wait_for = _options.delete(:wait)
+        return wrap_elements _block.call unless wait_for
+        wrap_elements poll_until(wait_for, _options, &_block)
+      end
+    end
+
+    def explode_elements
+      elements.inject([]) do |r, element|
+        r + yield(element)
+      end
+    end
+
+    def poll_until(_condition, _options, &_search)
+      check_method = "check_#{_condition}"
+      raise Pincers::MissingFeatureError.new check_method unless backend.respond_to? check_method
+
+      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
+        sleep interval
+      end
+
+      raise Pincers::ConditionTimeoutError.new self, _condition
+    end
+
+  end
+end

data/lib/pincers/errors.rb

@@ -0,0 +1,60 @@
+module Pincers
+
+  class Error < StandardError; end
+
+  class ConfigurationError < Error; end
+
+  class MissingFeatureError < Error
+
+    attr_reader :feature
+
+    def initialize(_feature)
+      @feature = _feature
+      super "This backend does not provide '#{_feature}'"
+    end
+
+  end
+
+  class ContextError < Error
+
+    attr_reader :context
+
+    def initialize(_context, _msg)
+      super _msg
+      @context = _context
+    end
+
+  end
+
+  class EmptySetError < ContextError
+
+    def initialize(_context)
+      super _context, "This set is empty"
+    end
+
+  end
+
+  class ConditionTimeoutError < ContextError
+
+    def initialize(_context, _condition)
+      super _context, "Timed out waiting element to be #{_condition}"
+    end
+
+  end
+
+  class BackendError < ContextError
+
+    attr_reader :document
+    attr_reader :original
+
+    def initialize(_context, _exc)
+      super _context, "Backend error: #{_exc.message}"
+      @document = _context.document
+      @original = _exc
+    end
+
+    # IDEA: join backtraces?
+
+  end
+
+end

data/lib/pincers/factory.rb

@@ -0,0 +1,33 @@
+require 'pincers/core/root_context'
+
+module Pincers
+  module Factory
+
+    def for_webdriver(_driver, _options={})
+      require 'pincers/backend/webdriver'
+
+      unless _driver.is_a? Selenium::WebDriver::Driver
+        _driver = Selenium::WebDriver::Driver.for _driver, _options
+      end
+
+      context Backend::Webdriver.new _driver
+    end
+
+    def for_nokogiri(_document, _options={})
+      require 'pincers/backend/nokogiri'
+
+      unless _document.is_a? ::Nokogiri::HTML::Document
+        _document = ::Nokogiri::HTML _document, _options[:url], _options[:encoding], _options[:flags]
+      end
+
+      context Backend::Nokogiri.new _document
+    end
+
+  private
+
+    def context(_backend)
+      Core::RootContext.new _backend
+    end
+
+  end
+end

data/lib/pincers/support/configuration.rb

@@ -0,0 +1,35 @@
+module Pincers::Support
+  class Configuration
+
+    class Option < Struct.new(:name, :type, :text); end
+
+    FIELDS = [
+      [:wait_timeout, 10.0],
+      [:wait_interval, 0.2]
+    ];
+
+    FIELDS.each do |field|
+      define_method "#{field[0]}=" do |val|
+        @values[field[0]] = val
+      end
+
+      define_method "#{field[0]}" do
+        @values[field[0]]
+      end
+    end
+
+    attr_reader :values
+
+    def initialize
+      reset
+    end
+
+    def set(_options)
+      @values.merge! _options
+    end
+
+    def reset
+      @values = Hash[FIELDS]
+    end
+  end
+end

data/lib/pincers/support/cookie_jar.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+
+module Pincers::Support
+  class CookieJar
+    include Enumerable
+
+    def initialize(_backend)
+      @backend = _backend
+    end
+
+    def each
+      @backend.fetch_cookies.each { |c| yield OpenStruct.new c }
+    end
+
+  end
+end

data/lib/pincers/version.rb

@@ -0,0 +1,3 @@
+module Pincers
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: pincers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ignacio Baixas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.45'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ignacio@platan.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pincers/backend/base.rb
+- lib/pincers/backend/nokogiri.rb
+- lib/pincers/backend/webdriver.rb
+- lib/pincers/core/root_context.rb
+- lib/pincers/core/search_context.rb
+- lib/pincers/errors.rb
+- lib/pincers/factory.rb
+- lib/pincers/support/configuration.rb
+- lib/pincers/support/cookie_jar.rb
+- lib/pincers/version.rb
+- lib/pincers.rb
+homepage: https://github.com/platanus/pincers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Web automation framework with multiple backend support
+test_files: []
+has_rdoc: