apparition 0.1.0 → 0.6.0

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

@@ -47,10 +47,12 @@ module Capybara::Apparition
     end
 
     def loading(id)
+      puts "Setting loading to #{id}" if ENV['DEBUG']
       self.loader_id = id
     end
 
     def reloading!
+      puts 'Reloading' if ENV['DEBUG']
       self.loader_id = @prev_loader_id
     end
 
@@ -64,6 +66,7 @@ module Capybara::Apparition
 
     def loaded!
       @prev_loader_id = loader_id
+      puts "Setting loaded - was #{loader_id}" if ENV['DEBUG']
       self.loader_id = nil
     end
 

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

@@ -7,7 +7,7 @@ module Capybara::Apparition
     def initialize(id)
       @frames = {}
       @frames_mutex = Mutex.new
-      add(id)
+      add(id).loading(-1)
       @main_id = @current_id = id
     end
 
@@ -43,6 +43,7 @@ module Capybara::Apparition
         @frames[id]
       end
     end
+    alias :[] :get
 
     def delete(id)
       @frames_mutex.synchronize do

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

@@ -66,16 +66,30 @@ module Capybara::Apparition
 
   private
 
+    def insert_emoji(str)
+      @page.command('Input.insertText', text: str)
+    end
+
     def type_with_modifiers(keys, delay:)
       old_pressed_keys, @pressed_keys = @pressed_keys, {}
 
       Array(keys).each do |sequence|
         case sequence
-        when Array then type_with_modifiers(sequence, delay: delay)
-        when String then sequence.each_char do |char|
-          press char
-          sleep delay
-        end
+        when Array
+          type_with_modifiers(sequence, delay: delay)
+        when String
+          clusters = sequence.grapheme_clusters.chunk { |gc| gc.match?(/\p{Emoji Presentation}/) }
+          clusters.each do |emoji, chars|
+            if emoji
+              insert_emoji(chars.join)
+              sleep delay
+            else
+              chars.each do |char|
+                press char
+                sleep delay
+              end
+            end
+          end
         else
           press sequence
           sleep delay
@@ -89,7 +103,7 @@ module Capybara::Apparition
     end
 
     def release_pressed_keys
-      @pressed_keys.values.each { |desc| up(desc) }
+      @pressed_keys.each_value { |desc| up(desc) }
     end
 
     def key_description(key)
@@ -102,8 +116,15 @@ module Capybara::Apparition
         location: 0
       )
 
+      if key.to_sym == :return
+        warn '[DEPRECATION]: Key symbol :return is deprecated in favor of :enter'
+        key = :enter
+      end
+
       definition = KEY_DEFINITIONS[key.to_sym]
-      raise KeyError, "Unknown key: #{key}" if definition.nil?
+      raise KeyError, "Unknown key: #{key}" if definition.nil? && !key.is_a?(String)
+
+      definition ||= { text: key }
 
       definition = OpenStruct.new definition
 
@@ -321,6 +342,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

@@ -6,15 +6,17 @@ module Capybara::Apparition
       @page = page
       @keyboard = keyboard
       @current_pos = { x: 0, y: 0 }
+      @current_buttons = BUTTONS[:none]
     end
 
-    def click_at(x:, y:, button: 'left', count: 1, modifiers: [])
+    def click_at(x:, y:, button: 'left', count: 1, delay: 0, modifiers: [])
       move_to x: x, y: y
       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)
+          sleep(delay || 0)
+          up(**mouse_params)
         end
       end
       self
@@ -28,13 +30,15 @@ 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
 
     def up(button: 'left', **options)
       options = @current_pos.merge(button: button).merge(options)
-      mouse_event('mouseReleased', options)
+      @current_buttons &= ~BUTTONS[button.to_sym]
+      mouse_event('mouseReleased', **options)
       self
     end
 
@@ -43,11 +47,21 @@ module Capybara::Apparition
     def mouse_event(type, x:, y:, button: 'none', count: 1)
       @page.command('Input.dispatchMouseEvent',
                     type: type,
-                    button: button,
+                    button: button.to_s,
+                    buttons: @current_buttons,
                     x: x,
                     y: y,
                     modifiers: @keyboard.modifiers,
                     clickCount: count)
     end
+
+    BUTTONS = {
+      left: 1,
+      right: 2,
+      middle: 4,
+      back: 8,
+      forward: 16,
+      none: 0
+    }.freeze
   end
 end

data/lib/capybara/apparition/utility.rb

@@ -4,7 +4,7 @@ module Capybara
   module Apparition
     class << self
       def windows?
-        RbConfig::CONFIG['host_os'] =~ /mingw|mswin|cygwin/
+        RbConfig::CONFIG['host_os'].match?(/mingw|mswin|cygwin/)
       end
 
       def mri?

data/lib/capybara/apparition/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Apparition
-    VERSION = '0.1.0'
+    VERSION = '0.6.0'
   end
 end

metadata

@@ -1,36 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: apparition
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Thomas Walpole
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2020-06-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: backports
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -40,7 +26,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -184,6 +170,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-performance
+  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: rubocop-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: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -228,19 +256,21 @@ files:
 - lib/capybara/apparition/browser/cookie.rb
 - lib/capybara/apparition/browser/frame.rb
 - lib/capybara/apparition/browser/header.rb
+- lib/capybara/apparition/browser/launcher.rb
+- lib/capybara/apparition/browser/launcher/local.rb
+- lib/capybara/apparition/browser/launcher/remote.rb
 - lib/capybara/apparition/browser/modal.rb
+- lib/capybara/apparition/browser/page_manager.rb
 - lib/capybara/apparition/browser/render.rb
 - lib/capybara/apparition/browser/window.rb
+- lib/capybara/apparition/configuration.rb
 - lib/capybara/apparition/console.rb
 - lib/capybara/apparition/cookie.rb
 - lib/capybara/apparition/cookie_jar.rb
 - lib/capybara/apparition/dev_tools_protocol/remote_object.rb
 - lib/capybara/apparition/dev_tools_protocol/session.rb
-- lib/capybara/apparition/dev_tools_protocol/target.rb
-- lib/capybara/apparition/dev_tools_protocol/target_manager.rb
 - lib/capybara/apparition/driver.rb
 - lib/capybara/apparition/driver/chrome_client.rb
-- lib/capybara/apparition/driver/launcher.rb
 - lib/capybara/apparition/driver/response.rb
 - lib/capybara/apparition/driver/web_socket_client.rb
 - lib/capybara/apparition/errors.rb
@@ -270,14 +300,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Chrome driver using CDP for Capybara

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

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require 'capybara/apparition/dev_tools_protocol/session'
-
-module Capybara::Apparition
-  module DevToolsProtocol
-    class Target
-      def initialize(browser, info)
-        @browser = browser
-        @info = info.dup
-        @page = nil
-      end
-
-      def info
-        @info.dup.freeze
-      end
-
-      def update(new_info)
-        @info ||= {}
-        @info.merge!(new_info)
-        info
-      end
-
-      def id
-        @info['targetId']
-      end
-
-      def context_id
-        @info['browserContextId']
-      end
-
-      def title
-        @info['title']
-      end
-
-      def url
-        @info['url']
-      end
-
-      def page
-        @page ||= begin
-          if info['type'] == 'page'
-            Page.create(@browser, create_session, id,
-                        ignore_https_errors: @browser.ignore_https_errors,
-                        js_errors: @browser.js_errors).inherit(@info.delete('inherit'))
-          else
-            nil
-          end
-        end
-      end
-
-      def close
-        @browser.command('Target.closeTarget', targetId: id)
-      end
-
-    private
-
-      def create_session
-        session_id = @browser.command('Target.attachToTarget', targetId: id)['sessionId']
-        Session.new(@browser, @browser.client, id, session_id)
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'capybara/apparition/dev_tools_protocol/target'
-
-module Capybara::Apparition
-  module DevToolsProtocol
-    class TargetManager
-      def initialize(browser)
-        @browser = browser
-        @targets = {}
-      end
-
-      def get(id)
-        @targets[id]
-      end
-
-      def of_type(type)
-        @targets.select { |_id, target| target.info['type'] == type }
-      end
-
-      def add(id, target)
-        raise ArgumentError, 'Target already exists' if @targets.key?(id)
-
-        @targets[id] = if target.is_a? DevToolsProtocol::Target
-          target
-        else
-          DevToolsProtocol::Target.new(@browser, target)
-        end
-      end
-
-      def delete(id)
-        @targets.delete(id)
-      end
-
-      def pages
-        @targets.values.select { |target| target.info['type'] == 'page' }.map(&:page)
-      end
-
-      def target?(id)
-        @targets.key?(id)
-      end
-
-      def window_handles
-        @targets.values.select { |target| target.info['type'] == 'page' }.map(&:id).compact
-      end
-    end
-  end
-end

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

@@ -1,217 +0,0 @@
-# frozen_string_literal: true
-
-module Capybara::Apparition
-  class Browser
-    class Launcher
-      KILL_TIMEOUT = 2
-
-      def self.start(*args)
-        new(*args).tap(&:start)
-      end
-
-      def self.process_killer(pid)
-        proc do
-          begin
-            if Capybara::Apparition.windows?
-              ::Process.kill('KILL', pid)
-            else
-              ::Process.kill('TERM', pid)
-              timer = Capybara::Helpers.timer(expire_in: KILL_TIMEOUT)
-              while ::Process.wait(pid, ::Process::WNOHANG).nil?
-                sleep 0.05
-                next unless timer.expired?
-
-                ::Process.kill('KILL', pid)
-                ::Process.wait(pid)
-                break
-              end
-            end
-          rescue Errno::ESRCH, Errno::ECHILD # rubocop:disable Lint/HandleExceptions
-          end
-        end
-      end
-
-      def initialize(headless:, **options)
-        @path = ENV['BROWSER_PATH']
-        @options = DEFAULT_OPTIONS.merge(options[:browser_options] || {})
-        if headless
-          @options.merge!(HEADLESS_OPTIONS)
-          @options['disable-gpu'] = nil if Capybara::Apparition.windows?
-        end
-        @options['user-data-dir'] = Dir.mktmpdir
-      end
-
-      def start
-        @output = Queue.new
-        @read_io, @write_io = IO.pipe
-
-        @out_thread = Thread.new do
-          while !@read_io.eof? && (data = @read_io.readpartial(512))
-            @output << data
-          end
-        end
-
-        process_options = { in: File::NULL }
-        process_options[:pgroup] = true unless Capybara::Apparition.windows?
-        process_options[:out] = process_options[:err] = @write_io if Capybara::Apparition.mri?
-
-        redirect_stdout do
-          cmd = [path] + @options.map { |k, v| v.nil? ? "--#{k}" : "--#{k}=#{v}" }
-          @pid = ::Process.spawn(*cmd, process_options)
-          ObjectSpace.define_finalizer(self, self.class.process_killer(@pid))
-        end
-      end
-
-      def stop
-        return unless @pid
-
-        kill
-        ObjectSpace.undefine_finalizer(self)
-      end
-
-      def restart
-        stop
-        start
-      end
-
-      def host
-        @host ||= ws_url.host
-      end
-
-      def port
-        @port ||= ws_url.port
-      end
-
-      def ws_url
-        @ws_url ||= begin
-          regexp = %r{DevTools listening on (ws://.*)}
-          url = nil
-          loop do
-            break if (url = @output.pop.scan(regexp)[0])
-          end
-          @out_thread.kill
-          close_io
-          Addressable::URI.parse(url[0])
-        end
-      end
-
-    private
-
-      def redirect_stdout
-        if Capybara::Apparition.mri?
-          yield
-        else
-          begin
-            prev = STDOUT.dup
-            $stdout = @write_io
-            STDOUT.reopen(@write_io)
-            yield
-          ensure
-            STDOUT.reopen(prev)
-            $stdout = STDOUT
-            prev.close
-          end
-        end
-      end
-
-      def kill
-        self.class.process_killer(@pid).call
-        @pid = nil
-      end
-
-      def close_io
-        [@write_io, @read_io].each do |io|
-          begin
-            io.close unless io.closed?
-          rescue IOError
-            raise unless RUBY_ENGINE == 'jruby'
-          end
-        end
-      end
-
-      def path
-        host_os = RbConfig::CONFIG['host_os']
-        @path ||= case RbConfig::CONFIG['host_os']
-        when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-          windows_path
-        when /darwin|mac os/
-          macosx_path
-        when /linux|solaris|bsd/
-          find_first_binary('google-chrome', 'chrome') || '/usr/bin/chrome'
-        else
-          raise ArgumentError, "unknown os: #{host_os.inspect}"
-        end
-
-        raise ArgumentError, 'Unable to find Chrome executeable' unless File.file?(@path.to_s) && File.executable?(@path.to_s)
-
-        @path
-      end
-
-      def windows_path
-        raise ArgumentError, 'Not yet Implemented'
-      end
-
-      def macosx_path
-        path = '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'
-        path = File.expand_path("~#{path}") unless File.exist?(path)
-        path = find_first_binary('Google Chrome') unless File.exist?(path)
-        path
-      end
-
-      def find_first_binary(*binaries)
-        paths = ENV['PATH'].split(File::PATH_SEPARATOR)
-
-        binaries.each do |binary|
-          paths.each do |path|
-            full_path = File.join(path, binary)
-            exe = Dir.glob(full_path).find { |f| File.executable?(f) }
-            return exe if exe
-          end
-        end
-      end
-
-      # Chromium command line options
-      # https://peter.sh/experiments/chromium-command-line-switches/
-      DEFAULT_BOOLEAN_OPTIONS = %w[
-        disable-background-networking
-        disable-background-timer-throttling
-        disable-breakpad
-        disable-client-side-phishing-detection
-        disable-default-apps
-        disable-dev-shm-usage
-        disable-extensions
-        disable-features=site-per-process
-        disable-hang-monitor
-        disable-infobars
-        disable-popup-blocking
-        disable-prompt-on-repost
-        disable-sync
-        disable-translate
-        metrics-recording-only
-        no-first-run
-        safebrowsing-disable-auto-update
-        enable-automation
-        password-store=basic
-        use-mock-keychain
-        keep-alive-for-test
-      ].freeze
-      # 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
-      # disable-web-security
-      DEFAULT_VALUE_OPTIONS = {
-        'window-size' => '1024,768',
-        'homepage' => 'about:blank',
-        'remote-debugging-address' => '127.0.0.1'
-      }.freeze
-      DEFAULT_OPTIONS = DEFAULT_BOOLEAN_OPTIONS.each_with_object({}) { |opt, hsh| hsh[opt] = nil }
-                                               .merge(DEFAULT_VALUE_OPTIONS)
-                                               .freeze
-      HEADLESS_OPTIONS = {
-        'headless' => nil,
-        'hide-scrollbars' => nil,
-        'mute-audio' => nil
-      }.freeze
-    end
-  end
-end