ferrum 0.10.2 → 0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2256dbc8ed2c2fca2e3209c13e29009c69b4c2ccf328e8a73ade73ed69c89f0
-  data.tar.gz: 8d5604f8d4f8120b699ec3e341c37f77f25e90a794d3206660ecc0465b22e7b1
+  metadata.gz: c953c12b582e6d81031c8daa598f25d4f8b2dba8e6d736f227b2e8c461a83d41
+  data.tar.gz: 229fe35bc81a133eff2628e1b3e0e0d31d733da2b277e0dbe70c9699e80e2a15
 SHA512:
-  metadata.gz: 7aa18fd5a01f387c27ade8ecdf6aa30df8118f4e90badddc242ed979e5be49c890036049f284555a937ccc79699bcbc954d62c077f45ff0770d9eeeec255a6ea
-  data.tar.gz: 25c4cc92e59a297a344cf85301a21c3f9e634f25ea685eb6c9d2f4ea1896fcba2898dc5f4cfcc8f3af358001a0e451034bb79bf24981e16a17a51cdd3f07d6a3
+  metadata.gz: 1f48e9fac5bfbcf9959d855b1b7c7259f97d845e812f3fce6fa59dc6a3e6b5147cced16167c2a3603e964978a9d3b1e4e5b4f2c7b5b686454acaa47d1aadf6d3
+  data.tar.gz: aa9f267ea80365e636e8b047bc87e6d5fe6761814cbd1b59b3d14bc3350ccdd9e2199718ba57c774abdf5bc089ef000cdbd55d03d7dbd6158cee4c975ee9d9e0

data/README.md

@@ -49,6 +49,8 @@ Web design by [Evrone](https://evrone.com/), what else
 * [Frames](https://github.com/rubycdp/ferrum#frames)
 * [Frame](https://github.com/rubycdp/ferrum#frame)
 * [Dialog](https://github.com/rubycdp/ferrum#dialog)
+* [Animation](https://github.com/rubycdp/ferrum#animation)
+* [Node](https://github.com/rubycdp/ferrum#node)
 * [Thread safety](https://github.com/rubycdp/ferrum#thread-safety)
 * [Development](https://github.com/rubycdp/ferrum#development)
 * [Contributing](https://github.com/rubycdp/ferrum#contributing)
@@ -234,6 +236,25 @@ browser.go_to("https://github.com/")
 browser.stop
 ```
 
+#### position = \*\*options
+
+Set the position for the browser window
+
+* options `Hash`
+  * :left `Integer`
+  * :top `Integer`
+
+```ruby
+browser.position = { left: 10, top: 20 }
+```
+
+#### position : `Array<Integer>`
+
+Get the position for the browser window
+
+```ruby
+browser.position # => [10, 20]
+```
 
 ## Finders
 
@@ -740,6 +761,20 @@ simple value.
 browser.execute(%(1 + 1)) # => true
 ```
 
+#### evaluate_on_new_document(expression)
+
+Evaluate JavaScript to modify things before a page load
+
+* expression `String` should be valid JavaScript
+
+```ruby
+browser.evaluate_on_new_document <<~JS
+  Object.defineProperty(navigator, "languages", {
+    get: function() { return ["tlh"]; }
+  });
+JS
+```
+
 #### add_script_tag(\*\*options) : `Boolean`
 
 * options `Hash`
@@ -946,6 +981,55 @@ browser.go_to("https://google.com")
 ```
 
 
+## Animation
+
+You can slow down or speed up CSS animations.
+
+#### playback_rate : `Integer`
+
+Returns playback rate for CSS animations, defaults to `1`.
+
+
+#### playback_rate = value
+
+Sets playback rate of CSS animations
+
+  * value `Integer`
+
+```ruby
+browser = Ferrum::Browser.new
+browser.playback_rate = 2000
+browser.go_to("https://google.com")
+browser.playback_rate # => 2000
+```
+
+
+## Node
+
+#### node? : `Boolean`
+#### frame_id
+#### frame
+#### focus
+#### focusable?
+#### moving? : `Boolean`
+#### wait_for_stop_moving
+#### blur
+#### type
+#### click
+#### hover
+#### select_file
+#### at_xpath
+#### at_css
+#### xpath
+#### css
+#### text
+#### inner_text
+#### value
+#### property
+#### attribute
+#### evaluate
+
+
 ## Thread safety ##
 
 Ferrum is fully thread-safe. You can create one browser or a few as you wish and

data/lib/ferrum.rb

@@ -57,7 +57,7 @@ module Ferrum
     end
   end
 
-  class NodeIsMovingError < Error
+  class NodeMovingError < Error
     def initialize(node, prev, current)
       @node, @prev, @current = node, prev, current
       super(message)
@@ -70,6 +70,12 @@ module Ferrum
     end
   end
 
+  class CoordinatesNotFoundError < Error
+    def initialize(message = "Could not compute content quads")
+      super
+    end
+  end
+
   class BrowserError < Error
     attr_reader :response
 

data/lib/ferrum/browser.rb

@@ -26,7 +26,8 @@ module Ferrum
                 frames frame_by main_frame
                 evaluate evaluate_on evaluate_async execute evaluate_func
                 add_script_tag add_style_tag bypass_csp
-                on goto] => :page
+                on goto position position=
+                playback_rate playback_rate=] => :page
     delegate %i[default_user_agent] => :process
 
     attr_reader :client, :process, :contexts, :logger, :js_errors, :pending_connection_errors,
@@ -77,6 +78,10 @@ module Ferrum
       end
     end
 
+    def evaluate_on_new_document(expression)
+      extensions << expression
+    end
+
     def timeout
       @timeout || DEFAULT_TIMEOUT
     end

data/lib/ferrum/browser/client.rb

@@ -90,6 +90,8 @@ module Ferrum
           raise NoExecutionContextError.new(error)
         when "No target with given id found"
           raise NoSuchPageError
+        when /Could not compute content quads/
+          raise CoordinatesNotFoundError
         else
           raise BrowserError.new(error)
         end

data/lib/ferrum/browser/options/chrome.rb

@@ -36,6 +36,7 @@ module Ferrum
           "metrics-recording-only" => nil,
           "safebrowsing-disable-auto-update" => nil,
           "password-store" => "basic",
+          "no-startup-window" => nil,
           # Note: --no-sandbox is not needed if you properly setup a user in the container.
           # https://github.com/ebidel/lighthouse-ci/blob/master/builder/Dockerfile#L35-L40
           # "no-sandbox" => nil,

data/lib/ferrum/context.rb

@@ -10,7 +10,7 @@ module Ferrum
 
     def initialize(browser, contexts, id)
       @browser, @contexts, @id = browser, contexts, id
-      @targets = Concurrent::Hash.new
+      @targets = Concurrent::Map.new
       @pendings = Concurrent::MVar.new
     end
 
@@ -47,14 +47,14 @@ module Ferrum
                        url: "about:blank")
       target = @pendings.take(@browser.timeout)
       raise NoSuchTargetError unless target.is_a?(Target)
-      @targets[target.id] = target
+      @targets.put_if_absent(target.id, target)
       target
     end
 
     def add_target(params)
       target = Target.new(@browser, params)
       if target.window?
-        @targets[target.id] = target
+        @targets.put_if_absent(target.id, target)
       else
         @pendings.put(target, @browser.timeout)
       end
@@ -72,6 +72,10 @@ module Ferrum
       @contexts.dispose(@id)
     end
 
+    def has_target?(target_id)
+      !!@targets[target_id]
+    end
+
     def inspect
       %(#<#{self.class} @id=#{@id.inspect} @targets=#{@targets.inspect} @default_target=#{@default_target.inspect}>)
     end

data/lib/ferrum/contexts.rb

@@ -7,7 +7,7 @@ module Ferrum
     attr_reader :contexts
 
     def initialize(browser)
-      @contexts = Concurrent::Hash.new
+      @contexts = Concurrent::Map.new
       @browser = browser
       subscribe
       discover
@@ -18,7 +18,9 @@ module Ferrum
     end
 
     def find_by(target_id:)
-      @contexts.find { |_, c| c.targets.keys.include?(target_id) }&.last
+      context = nil
+      @contexts.each_value { |c| context = c if c.has_target?(target_id) }
+      context
     end
 
     def create

data/lib/ferrum/node.rb

@@ -2,8 +2,8 @@
 
 module Ferrum
   class Node
-    MOVING_WAIT = ENV.fetch("FERRUM_NODE_MOVING_WAIT", 0.01).to_f
-    MOVING_ATTEMPTS = ENV.fetch("FERRUM_NODE_MOVING_ATTEMPTS", 50).to_i
+    MOVING_WAIT_DELAY = ENV.fetch("FERRUM_NODE_MOVING_WAIT", 0.01).to_f
+    MOVING_WAIT_ATTEMPTS = ENV.fetch("FERRUM_NODE_MOVING_ATTEMPTS", 50).to_i
 
     attr_reader :page, :target_id, :node_id, :description, :tag_name
 
@@ -30,6 +30,26 @@ module Ferrum
       tap { page.command("DOM.focus", slowmoable: true, nodeId: node_id) }
     end
 
+    def focusable?
+      focus
+      true
+    rescue BrowserError => e
+      e.message == "Element is not focusable" ? false : raise
+    end
+
+    def wait_for_stop_moving(delay: MOVING_WAIT_DELAY, attempts: MOVING_WAIT_ATTEMPTS)
+      Ferrum.with_attempts(errors: NodeMovingError, max: attempts, wait: 0) do
+        previous, current = get_content_quads_with(delay: delay)
+        raise NodeMovingError.new(self, previous, current) if previous != current
+        current
+      end
+    end
+
+    def moving?(delay: MOVING_WAIT_DELAY)
+      previous, current = get_content_quads_with(delay: delay)
+      previous == current
+    end
+
     def blur
       tap { evaluate("this.blur()") }
     end
@@ -124,44 +144,36 @@ module Ferrum
     end
 
     def find_position(x: nil, y: nil, position: :top)
-      prev = get_content_quads
-
-      # FIXME: Case when a few quads returned
-      points = Ferrum.with_attempts(errors: NodeIsMovingError, max: MOVING_ATTEMPTS, wait: 0) do
-        sleep(MOVING_WAIT)
-        current = get_content_quads
-
-        if current != prev
-          error = NodeIsMovingError.new(self, prev, current)
-          prev = current
-          raise(error)
-        end
-
-        current
-      end.map { |q| to_points(q) }.first
-
+      points = wait_for_stop_moving.map { |q| to_points(q) }.first
       get_position(points, x, y, position)
-    rescue Ferrum::BrowserError => e
-      return raise unless e.message&.include?("Could not compute content quads")
-
-      find_position_via_js
+    rescue CoordinatesNotFoundError
+      x, y = get_bounding_rect_coordinates
+      raise if x == 0 && y == 0
+      [x, y]
     end
 
     private
 
-    def find_position_via_js
-      [
-        evaluate("this.getBoundingClientRect().left + window.pageXOffset + (this.offsetWidth / 2)"), # x
-        evaluate("this.getBoundingClientRect().top + window.pageYOffset + (this.offsetHeight / 2)") # y
-      ]
+    def get_bounding_rect_coordinates
+      evaluate <<~JS
+        [this.getBoundingClientRect().left + window.pageXOffset + (this.offsetWidth / 2),
+         this.getBoundingClientRect().top + window.pageYOffset + (this.offsetHeight / 2)]
+      JS
     end
 
     def get_content_quads
       quads = page.command("DOM.getContentQuads", nodeId: node_id)["quads"]
-      raise "Node is either not visible or not an HTMLElement" if quads.size == 0
+      raise CoordinatesNotFoundError, "Node is either not visible or not an HTMLElement" if quads.size == 0
       quads
     end
 
+    def get_content_quads_with(delay: MOVING_WAIT_DELAY)
+      previous = get_content_quads
+      sleep(delay)
+      current = get_content_quads
+      [previous, current]
+    end
+
     def get_position(points, offset_x, offset_y, position)
       x = y = nil
 

data/lib/ferrum/page.rb

@@ -9,6 +9,7 @@ require "ferrum/dialog"
 require "ferrum/network"
 require "ferrum/page/frames"
 require "ferrum/page/screenshot"
+require "ferrum/page/animation"
 require "ferrum/browser/client"
 
 module Ferrum
@@ -35,7 +36,7 @@ module Ferrum
                 execution_id evaluate evaluate_on evaluate_async execute evaluate_func
                 add_script_tag add_style_tag] => :main_frame
 
-    include Frames, Screenshot
+    include Frames, Screenshot, Animation
 
     attr_accessor :referrer
     attr_reader :target_id, :browser,
@@ -108,6 +109,14 @@ module Ferrum
                                                     fitWindow: false)
     end
 
+    def position
+      @browser.command("Browser.getWindowBounds", windowId: window_id).fetch("bounds").values_at("left", "top")
+    end
+
+    def position=(left:, top:)
+      @browser.command("Browser.setWindowBounds", windowId: window_id, bounds: { left: left, top: top })
+    end
+
     def refresh
       command("Page.reload", wait: timeout, slowmoable: true)
     end

data/lib/ferrum/page/animation.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ferrum
+  class Page
+    module Animation
+      def playback_rate
+        command("Animation.getPlaybackRate")["playbackRate"]
+      end
+
+
+      def playback_rate=(value)
+        command("Animation.setPlaybackRate", playbackRate: value)
+      end
+    end
+  end
+end

data/lib/ferrum/page/screenshot.rb

@@ -12,7 +12,7 @@ module Ferrum
         scale: 1.0
       }.freeze
 
-      PAPEP_FORMATS = {
+      PAPER_FORMATS = {
         letter:   { width:  8.50, height: 11.00 },
         legal:    { width:  8.50, height: 14.00 },
         tabloid:  { width: 11.00, height: 17.00 },
@@ -114,7 +114,7 @@ module Ferrum
             raise ArgumentError, "Specify :format or :paper_width, :paper_height"
           end
 
-          dimension = PAPEP_FORMATS.fetch(format)
+          dimension = PAPER_FORMATS.fetch(format)
           options.merge!(paper_width: dimension[:width],
                          paper_height: dimension[:height])
         end

data/lib/ferrum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ferrum
-  VERSION = "0.10.2"
+  VERSION = "0.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: '0.11'
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -210,6 +210,7 @@ files:
 - lib/ferrum/network/response.rb
 - lib/ferrum/node.rb
 - lib/ferrum/page.rb
+- lib/ferrum/page/animation.rb
 - lib/ferrum/page/frames.rb
 - lib/ferrum/page/screenshot.rb
 - lib/ferrum/rbga.rb
@@ -218,7 +219,12 @@ files:
 homepage: https://github.com/route/ferrum
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://ferrum.rubycdp.com/
+  bug_tracker_uri: https://github.com/rubycdp/ferrum/issues
+  documentation_uri: https://github.com/rubycdp/ferrum/blob/master/README.md
+  changelog_uri: https://github.com/rubycdp/ferrum/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/rubycdp/ferrum
 post_install_message: 
 rdoc_options: []
 require_paths: