capybara-box 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3c837ec541010303e4e84c3e919583b4a4f72c5
-  data.tar.gz: dffeb421a4aaeaa05878c54074dcc2c362044c8c
+  metadata.gz: b4bdaec6c2c1490b88c611085694f8236508305a
+  data.tar.gz: 9d57739d0736541aa752b0654473ea72ac9aa083
 SHA512:
-  metadata.gz: c436a08f788a378584be91ecd5e7103ed978983ab1a284ccf9c583124258509d309f85f943a68849121e37bf07054d0159766c49b42f07bd3d75d5fdec3b77a7
-  data.tar.gz: 804393024ebd9c80e67e54574b049f6dcca5a5368c8688dc1085102200d5869d937565ec13b297fddc0859866d5561989cc8b81b661d373c8cbaa80bd84ced29
+  metadata.gz: 1b627d07d8a80b9e5de260068e1b095d0c18272b7b8acbec9c4c38ab39e56f3aa9c8c79fb0e812d65b367a996532ad50387e5cd76130583130cc6b598690ad9b
+  data.tar.gz: 18e0e3b30f9f7462338fbd62f3af8a839cb4f3092bfdebf389c144cd4f28ad595d4c0e511d9788cf52c76b37040375ba5e995ff633e0d6bad8b9a24bb8d5dd1e

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.2.0
+
+- features
+  - Add log feature for Chrome and Chrome Headless.
+
 ## v0.1.0
 
 First release.

data/README.md

@@ -9,7 +9,7 @@ Configure Capybara with **Chrome**, **Headless Chrome** or **Firefox** with *Scr
 
 Add the following code on your Gemfile and run bundle install:
 
-```
+```ruby
 group :test do
   gem 'capybara-box', require: false
 end
@@ -19,7 +19,7 @@ end
 
 Just require the lib **after** Capybara require and you done:
 
-```
+```ruby
 require 'capybara/rails'
 require 'capybara-box'
 
@@ -28,11 +28,21 @@ CapybaraBox::Base.configure
 
 By default, `chrome` is de driver, but you can use `chrome`, `chrome_headless` or `firefox`.
 
+## Version
+
+If you do not want install the Chrome Driver on your CI, you can specify the version here and it will be installed automatically for you.
+
+```ruby
+CapybaraBox::Base.configure version: '2.32'
+```
+
+* This works just for Chrome, for now
+
 ## Screenshot
 
 You can enable screenshot on failure and send it to S3.
 
-```
+```ruby
 CapybaraBox.configure(
   screenshot: {
     s3: {
@@ -46,7 +56,7 @@ CapybaraBox.configure(
 
 If you want enable it only on CI, use the `enabled` option:
 
-```
+```ruby
 CapybaraBox.configure(
   enabled: ENV['CI'],
 
@@ -58,26 +68,26 @@ CapybaraBox.configure(
 
 By default, Rack Session manipulation comes as battery, just use it.
 
-```
+```ruby
 page.set_rack_session key: 'value'
 ```
 
-```
+```ruby
 page.get_rack_session :key
 # 'value'
 ```
 
 You can disable this feature using the `session` option:
 
-```
-CapybaraBox.configure browser: :chrome, session: false
+```ruby
+CapybaraBox.configure session: false
 ```
 
 ## Add Argument
 
 By default some Switches are enabled for a better performance, you can add yours too:
 
-```
+```ruby
 capybara_box = CapybaraBox.configure
 capybara_box.add_argument '--incognito'
 ```
@@ -86,7 +96,7 @@ capybara_box.add_argument '--incognito'
 
 If you prefere, is possible override all of them:
 
-```
+```ruby
 CapybaraBox.configure arguments: ['--incognito']
 ```
 
@@ -96,7 +106,7 @@ Click [here](https://peter.sh/experiments/chromium-command-line-switches) to see
 
 By default some Preferences are enabled for a better performance, you can add yours too:
 
-```
+```ruby
 capybara_box = CapybaraBox.configure
 capybara_box.add_preference :credentials_enable_service, false
 ```
@@ -105,7 +115,7 @@ capybara_box.add_preference :credentials_enable_service, false
 
 If you prefere, is possible override all of them:
 
-```
+```ruby
 CapybaraBox.configure preferences: { credentials_enable_service: false }
 ```
 
@@ -117,10 +127,42 @@ By default some timeout configs are enabled only on CI env for a better performa
 It has this restrition because with timeout enabled, debugger cannot evaluate the variables values.
 You can override all of them too:
 
-```
+```ruby
 CapybaraBox.configure http_client_options: { read_timeout: 60 }
 ```
 
+## Driver Options
+
+You can override all driver options:
+
+```ruby
+CapybaraBox.configure driver_options: { clear_local_storage: true }
+```
+
+## Log
+
+Log is writen at `log/capybara-box.log` as default.
+
+You can see each command executed. Time spent between them and debug some hanging command. :tada:
+
+```
+[15.479][INFO]: RESPONSE Navigate
+[15.482][INFO]: COMMAND ExecuteScript {
+   "args": [  ],
+   "script": "return $(\".gridy\").data(\"ready\")"
+}
+[15.483][INFO]: Waiting for pending navigations...
+[15.545][INFO]: Done waiting for pending navigations. Status: ok
+```
+
+To disable log on CI, for example, use the `log` options:
+
+```ruby
+CapybaraBox.configure log: ENV['CI'].nil?
+```
+
+* It works only for **chrome** and **chrome_headless**.
+
 ## Love it!
 
 Via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=capybara-box) or [Gratipay](https://gratipay.com/~wbotelhos). Thanks! (:

data/lib/capybara-box/base.rb

@@ -135,11 +135,17 @@ module CapybaraBox
     def driver_options
       return @parameters[:driver_options] if @parameters[:driver_options]
 
-      {
+      opts = {
         browser:               browser,
         clear_local_storage:   true,
         clear_session_storage: true
       }
+
+      if log?
+        opts[:driver_opts] = { log_path: 'log/capybara-box.log' } if chrome_family?
+      end
+
+      opts
     end
 
     def firefox?
@@ -200,6 +206,12 @@ module CapybaraBox
 
     private
 
+    def log?
+      return true if @parameters[:log].nil?
+
+      true? @parameters[:log]
+    end
+
     def true?(value)
       ['true', true].include? value
     end

data/lib/capybara-box/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CapybaraBox
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/lib/capybara_box/base/driver_options_spec.rb

@@ -3,21 +3,65 @@ require 'rails_helper'
 RSpec.describe CapybaraBox::Base, '.register' do
   subject { described_class.new parameters }
 
-  let!(:parameters) { { browser: :browser } }
-
-  it 'returns the driver options' do
-    expect(subject.driver_options).to eq(
-      browser:               :browser,
-      clear_local_storage:   true,
-      clear_session_storage: true
-    )
+  context 'when is chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    it 'uses the default driver options' do
+      expect(subject.driver_options).to eq(
+        browser:               :chrome,
+        clear_local_storage:   true,
+        clear_session_storage: true,
+        driver_opts:           { log_path: 'log/capybara-box.log' }
+      )
+    end
+
+    context 'when :driver_options is given' do
+      before { parameters[:driver_options] = { key: :value } }
+
+      it 'is used' do
+        expect(subject.driver_options).to eq(key: :value)
+      end
+    end
   end
 
-  context 'when :driver_options is given' do
-    let!(:parameters) { { driver_options: { key: :value }, browser: :browser } }
+  context 'when is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    it 'uses the default driver options' do
+      expect(subject.driver_options).to eq(
+        browser:               :chrome_headless,
+        clear_local_storage:   true,
+        clear_session_storage: true,
+        driver_opts:           { log_path: 'log/capybara-box.log' }
+      )
+    end
+
+    context 'when :driver_options is given' do
+      before { parameters[:driver_options] = { key: :value } }
+
+      it 'is used' do
+        expect(subject.driver_options).to eq(key: :value)
+      end
+    end
+  end
+
+  context 'when is firefox' do
+    let!(:parameters) { { browser: :firefox } }
+
+    it 'uses the default driver options' do
+      expect(subject.driver_options).to eq(
+        browser:               :firefox,
+        clear_local_storage:   true,
+        clear_session_storage: true
+      )
+    end
+
+    context 'when :driver_options is given' do
+      before { parameters[:driver_options] = { key: :value } }
 
-    it 'is used' do
-      expect(subject.driver_options).to eq(key: :value)
+      it 'is used' do
+        expect(subject.driver_options).to eq(key: :value)
+      end
     end
   end
 end

data/spec/lib/capybara_box/base/log_spec.rb

@@ -0,0 +1,43 @@
+require 'rails_helper'
+
+RSpec.shared_context 'log_disabled' do
+  context 'when is chrome' do
+    before { parameters[:browser] = :chrome }
+
+    it 'does not includes log config' do
+      expect(subject.driver_options[:driver_opts]).to be_nil
+    end
+  end
+
+  context 'when is chrome headless' do
+    before { parameters[:browser] = :chrome_headless }
+
+    it 'does not includes log config' do
+      expect(subject.driver_options[:driver_opts]).to be_nil
+    end
+  end
+
+  context 'when is firefox' do
+    before { parameters[:browser] = :firefox }
+
+    it 'does not includes log config' do
+      expect(subject.driver_options[:driver_opts]).to be_nil
+    end
+  end
+end
+
+RSpec.describe CapybaraBox::Base, '.log' do
+  subject { described_class.new parameters }
+
+  context 'when log is false' do
+    let!(:parameters) { { log: false } }
+
+    it_behaves_like 'log_disabled'
+  end
+
+  context 'when log is "false"' do
+    let!(:parameters) { { log: 'false' } }
+
+    it_behaves_like 'log_disabled'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-box
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Washington Botelho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-30 00:00:00.000000000 Z
+date: 2017-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara-screenshot
@@ -167,6 +167,7 @@ files:
 - spec/lib/capybara_box/base/firefox_spec.rb
 - spec/lib/capybara_box/base/http_client_options_spec.rb
 - spec/lib/capybara_box/base/http_client_spec.rb
+- spec/lib/capybara_box/base/log_spec.rb
 - spec/lib/capybara_box/base/options_spec.rb
 - spec/lib/capybara_box/base/preferences_spec.rb
 - spec/lib/capybara_box/base/register_spec.rb
@@ -218,6 +219,7 @@ test_files:
 - spec/lib/capybara_box/base/firefox_spec.rb
 - spec/lib/capybara_box/base/http_client_options_spec.rb
 - spec/lib/capybara_box/base/http_client_spec.rb
+- spec/lib/capybara_box/base/log_spec.rb
 - spec/lib/capybara_box/base/options_spec.rb
 - spec/lib/capybara_box/base/preferences_spec.rb
 - spec/lib/capybara_box/base/register_spec.rb