capybara-chrome_dev_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0d10204e92fbd7b34ca84ec1a36c9bd2c258b5d
+  data.tar.gz: a3a5f57d5f82d507d7c8d11ae1830ade58aec9ef
+SHA512:
+  metadata.gz: 05dbdb5a1312649714ac33c3f4ad8581cfa13ab564380113ac57abaed6aecac9ae8af44784d68a1591dffbe5f8fce9e268f26651558dd97187769c4579769bae
+  data.tar.gz: 90ef9227ab6c4a5e8f77feb5f967d7109b82ea0f0147d6a1b67c870c36420ff3b8ac0f5f7041e3b56e3073cea85cfb4f07c34d70713123d3709da6962e8a73fb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capybara-chrome_dev_tools.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Tyler Rick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/License

@@ -0,0 +1,18 @@
+Copyright (c) 2018 Tyler Rick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,45 @@
+# Capybara::ChromeDevTools
+
+Integrates [chrome_remote](https://github.com/cavalle/chrome_remote) (a Chrome DevTools Protocol
+client) with Capybara, letting you access Chrome DevTools via `driver.dev_tools`.
+
+## Installation
+
+Install crmux by running, for example:
+```
+npm install crmux -g
+```
+or
+```
+yarn add crmux
+```
+
+Test that you can run it with:
+```
+npx crmux --help
+```
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara-chrome_dev_tools'
+```
+
+## Usage
+
+Access a ChromeRemote instance with `dev_tools`.
+
+See [chrome_remote](https://github.com/cavalle/chrome_remote) for API documentation.
+
+Example:
+```ruby
+dev_tools.send_cmd "Page.enable"
+```
+
+## See also
+
+To get access to HTTP response status code, response headers, etc. from your tests, check out https://github.com/TylerRick/capybara-chrome_response_headers, which uses this gem.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/capybara-chrome_dev_tools.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capybara/chrome_dev_tools"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara-chrome_dev_tools.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capybara/chrome_dev_tools/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-chrome_dev_tools"
+  spec.version       = Capybara::ChromeDevTools.version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Integrates [chrome_remote](https://github.com/cavalle/chrome_remote) (a Chrome DevTools Protocol
+client) with Capybara, letting you access Chrome DevTools via `driver.dev_tools`.}
+  #spec.description   = %q{}
+  spec.homepage      = "https://github.com/TylerRick/capybara-chrome_dev_tools"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/Changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+  spec.add_dependency "chrome_remote"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/capybara/chrome_dev_tools.rb

@@ -0,0 +1,27 @@
+require "capybara/chrome_dev_tools/version"
+
+module Capybara::ChromeDevTools
+  autoload :DriverExtensions, 'capybara/chrome_dev_tools/driver_extensions'
+  autoload :DSL,              'capybara/chrome_dev_tools/dsl'
+
+  class << self
+    attr_accessor :preferred_port
+  end
+  self.preferred_port = 9222
+end
+
+Capybara::Selenium::Driver.class_eval do
+  prepend Capybara::ChromeDevTools::DriverExtensions
+end
+
+Capybara::Session.class_eval do
+  ##
+  # Returns a client for the browser's dev tools protocol. Not supported by all drivers.
+  def dev_tools
+    driver.dev_tools
+  end
+end
+
+module Capybara::DSL
+  include Capybara::ChromeDevTools::DSL
+end

data/lib/capybara/chrome_dev_tools/driver_extensions.rb

@@ -0,0 +1,76 @@
+require 'chrome_remote'
+
+module Capybara::ChromeDevTools
+  module DriverExtensions
+    attr_accessor :chrome_debugging_port
+    attr_accessor :crmux_listen_port
+
+    def initialize(app, opts)
+      puts "#{self.class}#initialize"
+
+      if opts[:browser] == :chrome
+        start_crmux!(opts)
+      end
+
+      super
+    end
+
+    def find_free_port(port = 0)
+      begin
+        server = TCPServer.new('127.0.0.1', port)
+      rescue Errno::EADDRINUSE
+        if port == 0
+          raise
+        else
+          # Lets you pass a preferred port to try first before falling back to 0
+          port = 0
+          retry
+        end
+      end
+      server.addr[1].tap do |port|
+        server.close
+      end
+    end
+
+    # Starts crmux and adds debuggerAddress to opts that points to crmux listen address.
+    def start_crmux!(opts)
+      self.chrome_debugging_port = find_free_port(Capybara::ChromeDevTools.preferred_port)
+      self.crmux_listen_port     = find_free_port(chrome_debugging_port + 1)
+      opts[:options].args << "--remote-debugging-port=#{chrome_debugging_port}"
+      #opts[:options].add_preference 'debuggerAddress', "127.0.0.1:#{crmux_listen_port}"
+
+      @debug_crmux = true
+      command = "npx crmux #{'-d' if @debug_crmux} \
+                   --port=#{chrome_debugging_port} \
+                   --listen=#{crmux_listen_port}"
+      #puts %(command: #{command})
+      if @debug_crmux
+        spawn_opts = {[:out, :err] => 'log/crmux.log'}
+      else
+        spawn_opts = {}
+      end
+      @crmux_pid = spawn(command, spawn_opts)
+      puts %(Started crmux [pid #{@crmux_pid}], listening at http://localhost:#{crmux_listen_port}, connected to localhost:#{chrome_debugging_port})
+      # You can also get the part later with: page.driver.browser.capabilities["goog:chromeOptions"]["debuggerAddress"]
+      sleep 0.1
+
+      at_exit do
+        puts "Killing crmux process #{@crmux_pid}..."
+        Process.kill 'TERM', @crmux_pid
+      end
+    end
+
+    def browser
+      super.tap do |browser|
+        dev_tools
+      end
+    end
+
+    def dev_tools
+      @dev_tools ||= (
+        #puts "Connecting to #{crmux_listen_port}..."
+        ChromeRemote.client host: 'localhost', port: crmux_listen_port
+      )
+    end
+  end
+end

data/lib/capybara/chrome_dev_tools/dsl.rb

@@ -0,0 +1,9 @@
+module Capybara::ChromeDevTools::DSL
+  [
+    :dev_tools
+  ].each do |method|
+    define_method method do |*args, &block|
+      page.send method, *args, &block
+    end
+  end
+end

data/lib/capybara/chrome_dev_tools/version.rb

@@ -0,0 +1,7 @@
+module Capybara
+  module ChromeDevTools
+    def self.version
+      "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: capybara-chrome_dev_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chrome_remote
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- LICENSE
+- License
+- Rakefile
+- Readme.md
+- bin/console
+- bin/setup
+- capybara-chrome_dev_tools.gemspec
+- lib/capybara/chrome_dev_tools.rb
+- lib/capybara/chrome_dev_tools/driver_extensions.rb
+- lib/capybara/chrome_dev_tools/dsl.rb
+- lib/capybara/chrome_dev_tools/version.rb
+homepage: https://github.com/TylerRick/capybara-chrome_dev_tools
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TylerRick/capybara-chrome_dev_tools
+  source_code_uri: https://github.com/TylerRick/capybara-chrome_dev_tools
+  changelog_uri: https://github.com/TylerRick/capybara-chrome_dev_tools/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.3
+signing_key: 
+specification_version: 4
+summary: Integrates [chrome_remote](https://github.com/cavalle/chrome_remote) (a Chrome
+  DevTools Protocol client) with Capybara, letting you access Chrome DevTools via
+  `driver.dev_tools`.
+test_files: []