apparition 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b51cb57f961f9825c56ce38377bbf4fd5477a5cdad6d75a2dac1aab827b81561
-  data.tar.gz: 29e9b0c81cdcd3be2820a8d9a2719708750d3099f56a6c403c474a77bb254bce
+  metadata.gz: 3a8ccd4ce950f7c17f8ab0ac0c5ddcbbc13a336f428011d66f4b3cb028ced150
+  data.tar.gz: c524d1e955e3e4e958d0bd64350190eec6f53c7f612a6bd1b41867c05ab11427
 SHA512:
-  metadata.gz: 95be5f025a29554e4909b5e4500d2694f580b20ee92b9cf555c7fcf2a9bc1962871d95c81730d9800a55d8cc38f99656713f88cd10f0f7bd8e880083819c0edc
-  data.tar.gz: 34c0d53702b1b0be001cd65ebf0bfcb17ab6d3e86505851a23bbe39bd9bd80d4c0cb6d3d95a990804bd3ee123090ebce155892ddadd2ab4484782219ad0535b3
+  metadata.gz: 1d772071df2776e86a611a07b718eb3c411cf9048e466d66515920261f6aa8b6705ddd1559d3fa8c8728fe3510a58b37b82986d698ad17f5add7f7399a9d4fc8
+  data.tar.gz: bdd2bdfba3591b9a798cc820ff4dd8ce7d90af853f79c716828e3bbb2a51810c0e2f4705c16181b9284533569bd4f050fa94d95f1b62d3c5fc2880d29d817a72

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/twalpole/apparition.svg)](http://travis-ci.org/twalpole/apparition)
 
-Apparition is a driver for [Capybara](https://github.com/jnicklas/capybara). It allows you to
+Apparition is a driver for [Capybara](https://github.com/teamcapybara/capybara). It allows you to
 run your Capybara tests in the Chrome browser via CDP (no selenium or chromedriver needed) in a headless or
 headed configuration. It started as a fork of Poltergeist and attempts to maintain as much compatibility
 with the Poltergeist API as possible.  Implementing the `capybara-webkit` specific driver methods has also begun.
@@ -27,7 +27,7 @@ gem 'apparition'
 or
 
 ``` ruby
-gem apparition', github: 'twalpole/apparition'
+gem 'apparition', github: 'twalpole/apparition'
 ```
 
 to your Gemfile and run `bundle install`.
@@ -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:
@@ -156,8 +179,9 @@ end
 `options` is a hash of options. The following options are supported:
 
 *   `:headless` (Boolean) - When false, run the browser visibly
+*   `:remote` (Boolean) - When true, connect to remote browser instead of starting locally (see [below](#Remote Chrome Driver))
 *   `:debug` (Boolean) - When true, debug output is logged to `STDERR`.
-*   `:logger` (Object responding to `puts`) - When present, debug output is written to this object
+*   `:logger` (Ruby logger object or any object responding to `puts`) - When present, debug output is written to this object
 *   `:browser_logger` (`IO` object) - This is where your `console.log` statements will show up. Default: `STDOUT`
 *   `:timeout` (Numeric) - The number of seconds we'll wait for a response
     when communicating with Chrome. Default is 30.
@@ -175,6 +199,18 @@ end
 *   `:browser_options` (Hash) - Extra command line options to pass to Chrome when starting
 *   `:skip_image_loading` (Boolean) - Don't load images
 
+### Remote Chrome Driver ###
+Apparition can connect to already running instance of chrome. 
+Remote mode is useful when running tests in CI and chrome is available as separate docker container.
+
+In order to use remote browser - set up apparition in the following way:
+```ruby
+Capybara.register_driver :apparition do |app|
+  browser_options = { 'remote-debugging-address' => '127.0.0.1', 'remote-debugging-port' => 9999 }
+  Capybara::Apparition::Driver.new(app, remote: true, browser_options: browser_options)
+end
+```
+
 ### URL Blacklisting & Whitelisting ###
 Apparition supports URL blacklisting, which allows you
 to prevent scripts from running on designated domains:
@@ -205,7 +241,7 @@ test to allow sufficient time for the page to settle.
 
 If you have these types of problems, read through the [Capybara
 documentation on asynchronous
-JavaScript](https://github.com/jnicklas/capybara#asynchronous-javascript-ajax-and-friends)
+JavaScript](https://github.com/teamcapybara/capybara#asynchronous-javascript-ajax-and-friends)
 which explains the tools that Capybara provides for dealing with this.
 
 ### Filing a bug ###

data/lib/capybara/apparition.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'backports/2.4.0/enumerable/sum'
-require 'backports/2.4.0/string/match'
 require 'capybara'
 
 module Capybara

data/lib/capybara/apparition/browser.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
 require 'capybara/apparition/errors'
-require 'capybara/apparition/dev_tools_protocol/target_manager'
 require 'capybara/apparition/page'
 require 'capybara/apparition/console'
+require 'capybara/apparition/dev_tools_protocol/session'
 require 'capybara/apparition/browser/header'
 require 'capybara/apparition/browser/window'
 require 'capybara/apparition/browser/render'
 require 'capybara/apparition/browser/cookie'
 require 'capybara/apparition/browser/modal'
+require 'capybara/apparition/browser/page_manager'
 require 'capybara/apparition/browser/frame'
 require 'capybara/apparition/browser/auth'
 require 'json'
@@ -17,6 +18,7 @@ require 'time'
 module Capybara::Apparition
   class Browser
     attr_reader :client, :paper_size, :zoom_factor, :console, :proxy_auth
+
     extend Forwardable
 
     delegate %i[visit current_url status_code
@@ -30,7 +32,7 @@ module Capybara::Apparition
     def initialize(client, logger = nil)
       @client = client
       @current_page_handle = nil
-      @targets = Capybara::Apparition::DevToolsProtocol::TargetManager.new(self)
+      @pages = PageManager.new(self)
       @context_id = nil
       @js_errors = true
       @ignore_https_errors = false
@@ -41,15 +43,12 @@ module Capybara::Apparition
       initialize_handlers
 
       command('Target.setDiscoverTargets', discover: true)
-      while @current_page_handle.nil?
-        puts 'waiting for target...'
-        sleep 0.1
-      end
-      @context_id = current_target.context_id
+      yield self if block_given?
+      reset
     end
 
     def restart
-      puts 'handle client restart'
+      # puts 'handle client restart'
       # client.restart
 
       self.debug = @debug if defined?(@debug)
@@ -81,34 +80,43 @@ module Capybara::Apparition
     include Auth
 
     def reset
-      current_page_targets = @targets.of_type('page').values
-
       new_context_id = command('Target.createBrowserContext')['browserContextId']
       new_target_response = client.send_cmd('Target.createTarget', url: 'about:blank', browserContextId: new_context_id)
 
-      current_page_targets.each do |target|
-        begin
-          client.send_cmd('Target.disposeBrowserContext', browserContextId: target.context_id).discard_result
-        rescue WrongWorld
-          puts 'Unknown browserContextId'
-        end
-        @targets.delete(target.id)
-      end
+      @pages.reset
 
       new_target_id = new_target_response['targetId']
 
+      session_id = command('Target.attachToTarget', targetId: new_target_id)['sessionId']
+      session = Capybara::Apparition::DevToolsProtocol::Session.new(self, client, session_id)
+
+      @pages.create(new_target_id, session, new_context_id,
+                    ignore_https_errors: ignore_https_errors,
+                    js_errors: js_errors, extensions: @extensions,
+                    url_blacklist: @url_blacklist,
+                    url_whitelist: @url_whitelist).send(:main_frame).loaded!
+
       timer = Capybara::Helpers.timer(expire_in: 10)
-      until @targets.get(new_target_id)&.page&.usable?
+      until @pages[new_target_id].usable?
         if timer.expired?
           puts 'Timedout waiting for reset'
-          raise TimeoutError.new('reset')
+          raise TimeoutError, 'reset'
         end
         sleep 0.01
       end
+      console.clear
       @current_page_handle = new_target_id
       true
     end
 
+    def refresh_pages(opener:)
+      @pages.refresh(opener: opener,
+                     ignore_https_errors: ignore_https_errors,
+                     js_errors: js_errors,
+                     url_blacklist: @url_blacklist,
+                     url_whitelist: @url_whitelist)
+    end
+
     def resize(width, height, screen: nil)
       current_page.set_viewport width: width, height: height, screen: screen
     end
@@ -127,20 +135,16 @@ module Capybara::Apparition
     def extensions=(filenames)
       @extensions = filenames
       Array(filenames).each do |name|
-        begin
-          current_page.command('Page.addScriptToEvaluateOnNewDocument', source: File.read(name))
-        rescue Errno::ENOENT
-          raise ::Capybara::Apparition::BrowserError.new('name' => "Unable to load extension: #{name}", 'args' => nil)
-        end
+        current_page(allow_nil: true)&.add_extension(name)
       end
     end
 
     def url_whitelist=(whitelist)
-      current_page&.url_whitelist = whitelist
+      @url_whitelist = @pages.whitelist = whitelist
     end
 
     def url_blacklist=(blacklist)
-      current_page&.url_blacklist = blacklist
+      @url_blacklist = @pages.blacklist = blacklist
     end
 
     attr_writer :debug
@@ -149,7 +153,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
 
@@ -166,8 +170,14 @@ module Capybara::Apparition
       raise
     end
 
-    def current_page
-      current_target.page
+    def current_page(allow_nil: false)
+      @pages[@current_page_handle] || begin
+        puts "No current page: #{@current_page_handle} : #{caller}" if ENV['DEBUG']
+        @current_page_handle = nil
+        raise NoSuchWindowError unless allow_nil
+
+        @current_page_handle
+      end
     end
 
     def console_messages(type = nil)
@@ -176,115 +186,47 @@ module Capybara::Apparition
 
   private
 
-    def current_target
-      @targets.get(@current_page_handle) || begin
-        puts "No current page: #{@current_page_handle}"
-        puts caller
-        @current_page_handle = nil
-        raise NoSuchWindowError
-      end
-    end
-
     def log(message)
-      @logger&.puts message if ENV['DEBUG']
-    end
-
-    # KEY_ALIASES = {
-    #   command: :Meta,
-    #   equals: :Equal,
-    #   control: :Control,
-    #   ctrl: :Control,
-    #   multiply: 'numpad*',
-    #   add: 'numpad+',
-    #   divide: 'numpad/',
-    #   subtract: 'numpad-',
-    #   decimal: 'numpad.',
-    #   left: 'ArrowLeft',
-    #   right: 'ArrowRight',
-    #   down: 'ArrowDown',
-    #   up: 'ArrowUp'
-    # }.freeze
-    #
-    # def normalize_keys(keys)
-    #   keys.map do |key_desc|
-    #     case key_desc
-    #     when Array
-    #       # [:Shift, "s"] => { modifier: "shift", keys: "S" }
-    #       # [:Shift, "string"] => { modifier: "shift", keys: "STRING" }
-    #       # [:Ctrl, :Left] => { modifier: "ctrl", key: 'Left' }
-    #       # [:Ctrl, :Shift, :Left] => { modifier: "ctrl,shift", key: 'Left' }
-    #       # [:Ctrl, :Left, :Left] => { modifier: "ctrl", key: [:Left, :Left] }
-    #       keys_chunks = key_desc.chunk do |k|
-    #         k.is_a?(Symbol) && %w[shift ctrl control alt meta command].include?(k.to_s.downcase)
-    #       end
-    #       modifiers = modifiers_from_chunks(keys_chunks)
-    #       letters = normalize_keys(_keys.next[1].map { |k| k.is_a?(String) ? k.upcase : k })
-    #       { modifier: modifiers, keys: letters }
-    #     when Symbol
-    #       symbol_to_desc(key_desc)
-    #     when String
-    #       key_desc # Plain string, nothing to do
-    #     end
-    #   end
-    # end
-    #
-    # def modifiers_from_chunks(chunks)
-    #   if chunks.peek[0]
-    #     chunks.next[1].map do |k|
-    #       k = k.to_s.downcase
-    #       k = 'control' if k == 'ctrl'
-    #       k = 'meta' if k == 'command'
-    #       k
-    #     end.join(',')
-    #   else
-    #     ''
-    #   end
-    # end
-    #
-    # def symbol_to_desc(symbol)
-    #   if symbol == :space
-    #     res = ' '
-    #   else
-    #     key = KEY_ALIASES.fetch(symbol.downcase, symbol)
-    #     if (match = key.to_s.match(/numpad(.)/))
-    #       res = { keys: match[1], modifier: 'keypad' }
-    #     elsif !/^[A-Z]/.match?(key)
-    #       key = key.to_s.split('_').map(&:capitalize).join
-    #     end
-    #   end
-    #   res || { key: key }
-    # end
+      return unless @logger && ENV['DEBUG']
 
-    def initialize_handlers
-      @client.on 'Target.targetCreated' do |info|
-        puts "Target Created Info: #{info}" if ENV['DEBUG']
-        target_info = info['targetInfo']
-        if !@targets.target?(target_info['targetId'])
-          # @targets.add(target_info['targetId'], DevToolsProtocol::Target.new(self, target_info))
-          @targets.add(target_info['targetId'], target_info)
-          puts "**** Target Added #{info}" if ENV['DEBUG']
-        elsif ENV['DEBUG']
-          puts "Target already existed #{info}"
-        end
-        @current_page_handle ||= target_info['targetId'] if target_info['type'] == 'page'
+      if @logger.respond_to?(:puts)
+        @logger.puts(message)
+      else
+        @logger.debug(message)
       end
+    end
 
-      @client.on 'Target.targetDestroyed' do |info|
-        puts "**** Target Destroyed Info: #{info}" if ENV['DEBUG']
-        @targets.delete(info['targetId'])
+    def initialize_handlers
+      # @client.on 'Target.targetCreated' do |info|
+      #   byebug
+      #   puts "Target Created Info: #{info}" if ENV['DEBUG']
+      #   target_info = info['targetInfo']
+      #   if !@pages.key?(target_info['targetId'])
+      #     @pages.add(target_info['targetId'], target_info)
+      #     puts "**** Target Added #{info}" if ENV['DEBUG']
+      #   elsif ENV['DEBUG']
+      #     puts "Target already existed #{info}"
+      #   end
+      #   @current_page_handle ||= target_info['targetId'] if target_info['type'] == 'page'
+      # end
+
+      @client.on 'Target.targetDestroyed' do |target_id:, **info|
+        puts "**** Target Destroyed Info: #{target_id} - #{info}" if ENV['DEBUG']
+        @pages.delete(target_id)
       end
 
-      @client.on 'Target.targetInfoChanged' do |info|
-        puts "**** Target Info Changed: #{info}" if ENV['DEBUG']
-        target_info = info['targetInfo']
-        target = @targets.get(target_info['targetId'])
-        if target
-          target.update(target_info)
-        else
-          puts '****No target for the info change- creating****' if ENV['DEBUG']
-          @targets.add(target_info['targetId'], target_info)
-        end
-      end
+      # @client.on 'Target.targetInfoChanged' do |info|
+      #   byebug
+      #   puts "**** Target Info Changed: #{info}" if ENV['DEBUG']
+      #   target_info = info['targetInfo']
+      #   page = @pages[target_info['targetId']]
+      #   if page
+      #     page.update(target_info)
+      #   else
+      #     puts '****No target for the info change- creating****' if ENV['DEBUG']
+      #     @pages.add(target_info['targetId'], target_info)
+      #   end
+      # end
     end
   end
 end

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

@@ -6,18 +6,9 @@ module Capybara::Apparition
   class Browser
     module Cookie
       def cookies
-        CookieJar.new(
-          # current_page.command('Network.getCookies')['cookies'].map { |c| Cookie.new(c) }
-          self
-        )
-      end
-
-      def all_cookies
-        CookieJar.new(
-          # current_page.command('Network.getAllCookies')['cookies'].map { |c| Cookie.new(c) }
-          self
-        )
+        CookieJar.new(self)
       end
+      alias :all_cookies :cookies
 
       def get_raw_cookies
         current_page.command('Network.getAllCookies')['cookies'].map do |c|
@@ -26,12 +17,9 @@ module Capybara::Apparition
       end
 
       def set_cookie(cookie)
-        if cookie[:expires]
-          # cookie[:expires] = cookie[:expires].to_i * 1000
-          cookie[:expires] = cookie[:expires].to_i
-        end
+        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/header.rb

@@ -8,7 +8,7 @@ module Capybara::Apparition
       end
 
       def headers=(headers)
-        @targets.pages.each do |page|
+        @pages.each do |page|
           page.perm_headers = headers.dup
           page.temp_headers = {}
           page.temp_no_redirect_headers = {}
@@ -23,7 +23,7 @@ module Capybara::Apparition
 
       def add_header(header, permanent: true, **_options)
         if permanent == true
-          @targets.pages.each do |page|
+          @pages.each do |page|
             page.perm_headers.merge! header
             page.update_headers
           end