apparition 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 350a10ffb794579fb942f37a1739bf104b0230bd831945cbc22a20e2273927fd
-  data.tar.gz: e0bbdc5f79d03fcdedabd5db29ff990ee57801087d9c33ef98e85f9de833be8d
+  metadata.gz: fbed62503718fca5fe4664a248445c8b222073b352e2afd1422eeb85cf7bbf40
+  data.tar.gz: 508d1a1883ccc043b26a617ce84bbfb30ed1a72eee407965b10a50a12e2a3a6d
 SHA512:
-  metadata.gz: 313247fbbaccd8197d36ccd68adede1a33c944f46a5b30dce143606d4cc00bc61a3aab99ba35820dc6e2e3cbb7c09432084f221a36fee2f355fbd7d59639bb6f
-  data.tar.gz: 73f91c766ab2bc02f2a58b07c95cce2a01bc71dff6ca8f6eb3374b36b5a8efbc73c95d26f48766e00d3fbd7f49003765b293af8725028afa64d798f2c5ebddb2
+  metadata.gz: 90fccfe118998a00935b4ff9c6637747a73ea917927e15db3bc29b6a02aa9ecd763bde7d8f65043b377e33c7357ff8fbe38f8064970e7e79de5aeac37bb6bcf2
+  data.tar.gz: 3e2220019a00bd43c8125c7ab6d75f6fb7b8b4430e57e28fe22dea73012b2b8c61fea655e1a455cb1dfa49d55cafadbf09ffc80621f1e43745c0791add88a5e1

data/README.md

@@ -82,6 +82,29 @@ same as for `save_screenshot`.
 Sometimes its desirable to click a very specific area of the screen. You can accomplish this with
 `page.driver.click(x, y)`, where x and y are the screen coordinates.
 
+### Remote debugging (not yet implemented) ###
+
+If you use the `:inspector => true` option (see below), remote debugging
+will be enabled.
+
+When this option is enabled, you can insert `page.driver.debug` into
+your tests to pause the test and launch a browser which gives you the
+WebKit inspector to view your test run with.
+
+You can register this debugger driver with a different name and set it
+as the current javascript driver. By example, in your helper file:
+
+```ruby
+Capybara.register_driver :apparition_debug do |app|
+  Capybara::Apparition::Driver.new(app, :inspector => true)
+end
+# Capybara.javascript_driver = :apparition
+Capybara.javascript_driver = :apparition_debug
+```
+
+[Read more
+here](https://www.jonathanleighton.com/articles/2012/poltergeist-0-6-0/)
+
 ### Manipulating request headers ###
 
 You can manipulate HTTP request headers with these methods:

data/lib/capybara/apparition/browser.rb

@@ -152,7 +152,7 @@ module Capybara::Apparition
       current_page.command('Network.clearBrowserCache')
     end
 
-    def command(name, params = {})
+    def command(name, **params)
       result = client.send_cmd(name, params).result
       log result
 

data/lib/capybara/apparition/browser/cookie.rb

@@ -19,7 +19,7 @@ module Capybara::Apparition
       def set_cookie(cookie)
         cookie[:expires] = cookie[:expires].to_i if cookie[:expires]
 
-        current_page.command('Network.setCookie', cookie)
+        current_page.command('Network.setCookie', **cookie)
       end
 
       def remove_cookie(name)

data/lib/capybara/apparition/browser/page_manager.rb

@@ -67,7 +67,13 @@ module Capybara::Apparition
         end
 
         sessions.each do |(target_id, session)|
-          new_page = Page.create(@browser, session, target_id, opener.browser_context_id, page_options).inherit(opener)
+          new_page = Page.create(
+            @browser,
+            session,
+            target_id,
+            opener.browser_context_id,
+            **page_options
+          ).inherit(opener)
           @pages[target_id] = new_page
         end
       end

data/lib/capybara/apparition/dev_tools_protocol/session.rb

@@ -22,7 +22,7 @@ module Capybara::Apparition
       end
 
       def async_command(name, **params)
-        send_cmd(name, params).discard_result
+        send_cmd(name, **params).discard_result
       end
 
       def async_commands(*names)

data/lib/capybara/apparition/driver.rb

@@ -216,7 +216,7 @@ module Capybara::Apparition
     end
 
     def add_header(name, value, options = {})
-      browser.add_header({ name => value }, { permanent: true }.merge(options))
+      browser.add_header({ name => value }, **{ permanent: true }.merge(options))
     end
     alias_method :header, :add_header
 
@@ -295,7 +295,7 @@ module Capybara::Apparition
         begin
           input = read.read_nonblock(80) # clear out the read buffer
           puts unless input&.end_with?("\n")
-        rescue EOFError, IO::WaitReadable # rubocop:disable Lint/HandleExceptions
+        rescue EOFError, IO::WaitReadable # rubocop:disable Lint/SuppressedException
           # Ignore problems reading from STDIN.
         end
       end

data/lib/capybara/apparition/driver/chrome_client.rb

@@ -208,7 +208,7 @@ module Capybara::Apparition
         puts "Calling handler for #{event_name}" if ENV['DEBUG'] == 'V'
         # TODO: Update this to use transform_keys when we dump Ruby 2.4
         # handler.call(event['params'].transform_keys(&method(:snake_sym)))
-        handler.call(event['params'].each_with_object({}) { |(k, v), hash| hash[snake_sym(k)] = v })
+        handler.call(**event['params'].each_with_object({}) { |(k, v), hash| hash[snake_sym(k)] = v })
       end
     end
 
@@ -226,7 +226,7 @@ module Capybara::Apparition
       @listener = Thread.new do
         begin
           listen
-        rescue EOFError # rubocop:disable Lint/HandleExceptions
+        rescue EOFError # rubocop:disable Lint/SuppressedException
         end
       end
       # @listener.abort_on_exception = true

data/lib/capybara/apparition/driver/launcher.rb

@@ -7,8 +7,8 @@ module Capybara::Apparition
     class Launcher
       KILL_TIMEOUT = 5
 
-      def self.start(*args)
-        new(*args).tap(&:start)
+      def self.start(*args, **options)
+        new(*args, **options).tap(&:start)
       end
 
       def self.process_killer(pid)
@@ -29,7 +29,7 @@ module Capybara::Apparition
                 break
               end
             end
-          rescue Errno::ESRCH, Errno::ECHILD # rubocop:disable Lint/HandleExceptions
+          rescue Errno::ESRCH, Errno::ECHILD # rubocop:disable Lint/SuppressedException
           end
         end
       end

data/lib/capybara/apparition/node.rb

@@ -132,8 +132,10 @@ module Capybara::Apparition
           set_datetime_local(value)
         when 'color'
           set_color(value)
+        when 'range'
+          set_range(value)
         else
-          set_text(value.to_s, { delay: 0 }.merge(options))
+          set_text(value.to_s, **{ delay: 0 }.merge(options))
         end
       elsif tag_name == 'textarea'
         set_text(value.to_s)
@@ -172,12 +174,12 @@ module Capybara::Apparition
       pos = visible_center(allow_scroll: false)
       return true if pos.nil?
 
-      hit_node = @page.element_from_point(pos)
+      hit_node = @page.element_from_point(**pos)
       return true if hit_node.nil?
 
       begin
         return evaluate_on('el => !this.contains(el)', objectId: hit_node['objectId'])
-      rescue WrongWorld # rubocop:disable Lint/HandleExceptions
+      rescue WrongWorld # rubocop:disable Lint/SuppressedException
       end
 
       true
@@ -196,22 +198,22 @@ module Capybara::Apparition
     end
 
     def click(keys = [], button: 'left', count: 1, **options)
-      pos = element_click_pos(options)
+      pos = element_click_pos(**options)
       raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['click']) if pos.nil?
 
-      test = mouse_event_test(pos)
+      test = mouse_event_test(**pos)
       raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['click']) if test.nil?
 
       unless options[:x] && options[:y]
         raise ::Capybara::Apparition::MouseEventFailed.new(self, 'args' => ['click', test.selector, pos]) unless test.success
       end
 
-      @page.mouse.click_at pos.merge(button: button, count: count, modifiers: keys)
+      @page.mouse.click_at(**pos.merge(button: button, count: count, modifiers: keys))
       if ENV['DEBUG']
         begin
-          new_pos = element_click_pos(options)
+          new_pos = element_click_pos(**options)
           puts "Element moved from #{pos} to #{new_pos}" unless pos == new_pos
-        rescue WrongWorld # rubocop:disable Lint/HandleExceptions
+        rescue WrongWorld # rubocop:disable Lint/SuppressedException
         end
       end
       # Wait a short time to see if click triggers page load
@@ -231,7 +233,7 @@ module Capybara::Apparition
       pos = visible_center
       raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['hover']) if pos.nil?
 
-      @page.mouse.move_to(pos)
+      @page.mouse.move_to(**pos)
     end
 
     EVENTS = {
@@ -534,6 +536,10 @@ module Capybara::Apparition
       update_value_js(value.to_s)
     end
 
+    def set_range(value)
+      update_value_js(value.to_s)
+    end
+
     def update_value_js(value)
       evaluate_on(<<~JS, value: value)
         value => {
@@ -759,7 +765,7 @@ module Capybara::Apparition
     # if an area element, check visibility of relevant image
     VISIBLE_JS = <<~JS
       function(){
-        el = this;
+        let el = this;
         if (el.tagName == 'AREA'){
           const map_name = document.evaluate('./ancestor::map/@name', el, null, XPathResult.STRING_TYPE, null).stringValue;
           el = document.querySelector(`img[usemap='#${map_name}']`);

data/lib/capybara/apparition/node/drag.rb

@@ -2,26 +2,30 @@
 
 module Capybara::Apparition
   module Drag
-    def drag_to(other, delay: 0.1, html5: nil)
+    def drag_to(other, delay: 0.1, html5: nil, drop_modifiers: [])
+      drop_modifiers = Array(drop_modifiers)
+
       driver.execute_script MOUSEDOWN_TRACKER
       scroll_if_needed
       m = @page.mouse
-      m.move_to(visible_center)
+      m.move_to(**visible_center)
       sleep delay
       m.down
       html5 = !driver.evaluate_script(LEGACY_DRAG_CHECK, self) if html5.nil?
       if html5
-        driver.execute_script HTML5_DRAG_DROP_SCRIPT, self, other, delay
-        m.up(other.visible_center)
+        driver.execute_script HTML5_DRAG_DROP_SCRIPT, self, other, delay, drop_modifiers
+        m.up(**other.visible_center)
       else
-        begin
-          other.scroll_if_needed
-          sleep delay
-          m.move_to(other.visible_center)
-          sleep delay
-        ensure
-          m.up
-          sleep delay
+        @page.keyboard.with_keys(drop_modifiers) do
+          begin
+            other.scroll_if_needed
+            sleep delay
+            m.move_to(**other.visible_center)
+            sleep delay
+          ensure
+            m.up
+            sleep delay
+          end
         end
       end
     end
@@ -31,11 +35,11 @@ module Capybara::Apparition
       raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['hover']) if pos.nil?
 
       other_pos = { x: pos[:x] + x, y: pos[:y] + y }
-      raise ::Capybara::Apparition::MouseEventFailed.new(self, 'args' => ['drag', test['selector'], pos]) unless mouse_event_test?(pos)
+      raise ::Capybara::Apparition::MouseEventFailed.new(self, 'args' => ['drag', test['selector'], pos]) unless mouse_event_test?(**pos)
 
-      @page.mouse.move_to(pos).down
+      @page.mouse.move_to(**pos).down
       sleep delay
-      @page.mouse.move_to(other_pos)
+      @page.mouse.move_to(**other_pos)
       sleep delay
       @page.mouse.up
     end
@@ -125,9 +129,15 @@ module Capybara::Apparition
     JS
 
     HTML5_DRAG_DROP_SCRIPT = <<~JS
-      var source = arguments[0];
-      var target = arguments[1];
-      var step_delay = arguments[2] * 1000;
+      let source = arguments[0];
+      const target = arguments[1];
+      const step_delay = arguments[2] * 1000;
+      const drop_modifiers = arguments[3];
+      const key_aliases = {
+        'cmd': 'meta',
+        'command': 'meta',
+        'control': 'ctrl',
+      };
 
       function rectCenter(rect){
         return new DOMPoint(
@@ -181,6 +191,9 @@ module Capybara::Apparition
           let targetRect = target.getBoundingClientRect(),
           sourceCenter = rectCenter(source.getBoundingClientRect());
 
+          drop_modifiers.map(key => key_aliases[key] || key)
+                        .forEach(key => opts[key + 'Key'] = true);
+
           // fire 2 dragover events to simulate dragging with a direction
           let entryPoint = pointOnRect(sourceCenter, targetRect);
           let dragOverOpts = Object.assign({clientX: entryPoint.x, clientY: entryPoint.y}, opts);
@@ -196,26 +209,27 @@ module Capybara::Apparition
           dragOverOpts = Object.assign({clientX: targetCenter.x, clientY: targetCenter.y}, opts);
           dragOverEvent = new DragEvent('dragover', dragOverOpts);
           target.dispatchEvent(dragOverEvent);
-          setTimeout(resolve, step_delay, dragOverEvent.defaultPrevented);
+          setTimeout(resolve, step_delay, { drop: dragOverEvent.defaultPrevented, opts: dragOverOpts});
         })
       }
 
-      function dragLeave(drop) {
+      function dragLeave({ drop, opts: dragOverOpts }) {
         return new Promise( resolve => {
-          var dragLeaveEvent = new DragEvent('dragleave', opts);
+          var dragLeaveOptions = { ...opts, ...dragOverOpts };
+          var dragLeaveEvent = new DragEvent('dragleave', dragLeaveOptions);
           target.dispatchEvent(dragLeaveEvent);
           if (drop) {
-            var dropEvent = new DragEvent('drop', opts);
+            var dropEvent = new DragEvent('drop', dragLeaveOptions);
             target.dispatchEvent(dropEvent);
           }
-          var dragEndEvent = new DragEvent('dragend', opts);
+          var dragEndEvent = new DragEvent('dragend', dragLeaveOptions);
           source.dispatchEvent(dragEndEvent);
           setTimeout(resolve, step_delay);
         })
       }
 
-      var dt = new DataTransfer();
-      var opts = { cancelable: true, bubbles: true, dataTransfer: dt };
+      const dt = new DataTransfer();
+      const opts = { cancelable: true, bubbles: true, dataTransfer: dt };
 
       while (source && !source.draggable) {
         source = source.parentElement;

data/lib/capybara/apparition/page.rb

@@ -22,7 +22,7 @@ module Capybara::Apparition
       # Provides a lot of info - but huge overhead
       # session.command 'Page.setLifecycleEventsEnabled', enabled: true
 
-      page = Page.new(browser, session, id, browser_context_id, options)
+      page = Page.new(browser, session, id, browser_context_id, **options)
 
       session.async_commands 'Network.enable', 'Runtime.enable', 'Security.enable', 'DOM.enable'
       session.async_command 'Security.setIgnoreCertificateErrors', ignore: !!ignore_https_errors
@@ -150,7 +150,7 @@ module Capybara::Apparition
           params[:paperWidth] = @browser.paper_size[:width].to_f
           params[:paperHeight] = @browser.paper_size[:height].to_f
         end
-        command('Page.printToPDF', params)
+        command('Page.printToPDF', **params)
       else
         clip_options = if options[:selector]
           pos = evaluate("document.querySelector('#{options.delete(:selector)}').getBoundingClientRect().toJSON();")
@@ -165,7 +165,7 @@ module Capybara::Apparition
           JS
         end
         options[:clip] = { x: 0, y: 0, scale: scale }.merge(clip_options)
-        command('Page.captureScreenshot', options)
+        command('Page.captureScreenshot', **options)
       end['data']
     end
 
@@ -284,7 +284,7 @@ module Capybara::Apparition
       @status_code = 0
       navigate_opts = { url: url, transitionType: 'reload' }
       navigate_opts[:referrer] = extra_headers['Referer'] if extra_headers['Referer']
-      response = command('Page.navigate', navigate_opts)
+      response = command('Page.navigate', **navigate_opts)
       raise StatusFailError, 'args' => [url, response['errorText']] if response['errorText']
 
       main_frame.loading(response['loaderId'])
@@ -335,7 +335,7 @@ module Capybara::Apparition
       }
       metrics[:screenWidth], metrics[:screenHeight] = *screen if screen
 
-      command('Emulation.setDeviceMetricsOverride', metrics)
+      command('Emulation.setDeviceMetricsOverride', **metrics)
     end
 
     def fullscreen
@@ -366,7 +366,7 @@ module Capybara::Apparition
     end
 
     def async_command(name, **params)
-      @browser.command_for_session(@session.session_id, name, params).discard_result
+      @browser.command_for_session(@session.session_id, name, **params).discard_result
     end
 
     def extra_headers
@@ -386,7 +386,7 @@ module Capybara::Apparition
       if page
         self.url_whitelist = page.url_whitelist.dup
         self.url_blacklist = page.url_blacklist.dup
-        set_viewport(page.viewport_size) if page.viewport_size
+        set_viewport(**page.viewport_size) if page.viewport_size
       end
       self
     end

data/lib/capybara/apparition/page/keyboard.rb

@@ -330,6 +330,7 @@ module Capybara::Apparition
       'z': { 'keyCode': 90, 'code': 'KeyZ', 'shiftKey': 'Z', 'key': 'z' },
       'meta': { 'keyCode': 91, 'key': 'Meta', 'code': 'MetaLeft' },
       'command': { 'keyCode': 91, 'key': 'Meta', 'code': 'MetaLeft' },
+      'cmd': { 'keyCode': 91, 'key': 'Meta', 'code': 'MetaLeft' },
       '*': { 'keyCode': 106, 'key': '*', 'code': 'NumpadMultiply', 'location': 3 },
       '+': { 'keyCode': 107, 'key': '+', 'code': 'NumpadAdd', 'location': 3 },
       '-': { 'keyCode': 109, 'key': '-', 'code': 'NumpadSubtract', 'location': 3 },

data/lib/capybara/apparition/page/mouse.rb

@@ -14,8 +14,8 @@ module Capybara::Apparition
       count.times do |num|
         @keyboard.with_keys(modifiers) do
           mouse_params = { x: x, y: y, button: button, count: num + 1 }
-          down mouse_params
-          up mouse_params
+          down(**mouse_params)
+          up(**mouse_params)
         end
       end
       self
@@ -29,7 +29,7 @@ module Capybara::Apparition
 
     def down(button: 'left', **options)
       options = @current_pos.merge(button: button).merge(options)
-      mouse_event('mousePressed', options)
+      mouse_event('mousePressed', **options)
       @current_buttons |= BUTTONS[button.to_sym]
       self
     end
@@ -37,7 +37,7 @@ module Capybara::Apparition
     def up(button: 'left', **options)
       options = @current_pos.merge(button: button).merge(options)
       @current_buttons &= ~BUTTONS[button.to_sym]
-      mouse_event('mouseReleased', options)
+      mouse_event('mouseReleased', **options)
       self
     end
 

data/lib/capybara/apparition/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Apparition
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apparition
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Thomas Walpole
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -291,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Chrome driver using CDP for Capybara