capybara-box 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eb43822ce3b518d701a86c67a72908953c0c49e699b3b29ba263e3b8b4f17f7
-  data.tar.gz: e35c51b8daa7efc62aa182d2f3280227d59413d674921f9ce9fe0209b7a326a7
+  metadata.gz: 36511931656f10de7c80d90cbe83b522c6ed25f3bfaace63b9c6b60bc5e7410b
+  data.tar.gz: 338ed081d496d5507b551cca46143478171374d31bf22bdbc89a341d481ec908
 SHA512:
-  metadata.gz: d2992956c71d654754f4c1098fe474cc8df6dcac9516926782f9c8a3876bdccabea3d860d59362451ffe17f08c09f8e40495137d6668c405002455cdf81e6e56
-  data.tar.gz: c15d8442bce49d012f6e7f92094619c5afb3d59ae039745a991aeab7b18544778a3715dd5466c90de080fdf1d2f1196d8ab8e5bc1630f814c6b995da7269bc52
+  metadata.gz: 66ae7025a66c1fbbde2f59bd73ba2e421c62e2a61fdce2d759cdb3c8d84492ee96752f616158eb3d6bd02b7ebc7684c64c8d10e359dc23c1281dbe1201d43f53
+  data.tar.gz: d5dbb4ad547f2511c9989f41e87153e20d28e3014c23de4f0081f8c4fcc6851d7a46e1c40fc8a079db61ebd5b92cee9704d2bd7af52fc8a7cb650b40dafda20f

data/CHANGELOG.md

@@ -1,60 +1,90 @@
+## v2.0.0
+
+### Break Change
+
+- The option `log: Boolean` was replaced by `logger: Hash` wher you can configure the `level` and the `output` path.
+
+### Update
+
+- Adds support to Ruby 3;
+
+## v1.2.0
+
+### Update
+
+- Avoids deprecated Selenium `:options`;
+
 ## v1.1.2
 
-- Fixes
-  - Avoid apply blank bin path;
-  - Avoid apply blank version;
+### Bugfix
+
+- Avoid apply blank bin path;
+- Avoid apply blank version;
 
 ## v1.1.1
 
-- Fixes
-  - Removes default args that was avoiding screen render.
+### Bugfix
+
+- Removes default args that was avoiding screen render.
 
 ## v1.1.0
 
-- Fixes
-  - S3 config activation;
+### Bugfix
 
-- Update
-  - Adds more default arguments;
+- S3 config activation;
+
+### Update
+
+- Adds more default arguments;
 
 ## v1.0.1
 
-- Fixes
-  - Registers driver name as symbol;
+### Bugfix
+
+- Registers driver name as symbol;
 
 ## v1.0.0
 
-- Updates
-  - Updated default arguments;
-  - Spec files now is excluded from gem pack;
+### Update
+
+- Updated default arguments;
+- Spec files now is excluded from gem pack;
+
+### Features
 
-- Features
-  - Capybara `load_selenium` is called before startup;
-  - Screenshot S3 feature now is configure only via ENV;
-  - Using new gem `webdrivers`;
+- Capybara `load_selenium` is called before startup;
+- Screenshot S3 feature now is configure only via ENV;
+- Using new gem `webdrivers`;
 
-- Fixes
-  - Fix screenshot upload;
+### Bugfix
+
+- Fix screenshot upload;
 
 ## v0.4.0
 
-- Updates Selenium WebDriver deprecated message;
+### Update
+
+- Selenium WebDriver deprecated message;
 
 ## v0.3.0
 
+### Update
+
 - Drops Rack Session Access internal require;
 - Makes `chromedriver-helper` optional.
 
 ## v0.2.1
 
-- Fixes
-  - `chrome_headless` was being registered with wrong name.
+### Bugfix
+
+- `chrome_headless` was being registered with wrong name.
 
 ## v0.2.0
 
-- Features
-  - Add log feature for Chrome and Chrome Headless.
+### Features
+
+- Add log feature for Chrome and Chrome Headless.
 
 ## v0.1.0
 
-First release.
+- First release.

data/README.md

@@ -1,9 +1,10 @@
 # Capybara Box
 
-[![Build Status](https://travis-ci.org/wbotelhos/capybara-box.svg?branch=master)](https://travis-ci.org/wbotelhos/capybara-box)
-[![Maintainability](https://api.codeclimate.com/v1/badges/1b13dc12b03be63baaed/maintainability)](https://codeclimate.com/github/wbotelhos/capybara-box/maintainability)
+[![CI](https://github.com/wbotelhos/capybara-box/workflows/CI/badge.svg)](https://github.com/wbotelhos/capybara-box/actions)
 [![Gem Version](https://badge.fury.io/rb/capybara-box.svg)](https://badge.fury.io/rb/capybara-box)
-[![Patreon](https://img.shields.io/badge/donate-%3C3-brightgreen.svg)](https://www.patreon.com/wbotelhos)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f312587b4f126bb13e85/maintainability)](https://codeclimate.com/github/wbotelhos/capybara-box/maintainability)
+[![Coverage](https://codecov.io/gh/wbotelhos/capybara-box/branch/main/graph/badge.svg)](https://codecov.io/gh/wbotelhos/capybara-box)
+[![Sponsor](https://img.shields.io/badge/sponsor-%3C3-green)](https://github.com/sponsors/wbotelhos)
 
 Configure Capybara with **Chrome**, **Chrome Headless**, **Firefox** and **Firefox Headless** with *Screenshot* feature without losing your mind.
 
@@ -30,6 +31,10 @@ CapybaraBox::Base.configure
 
 By default, `selenium_chrome` is the driver, but you can use `selenium_chrome_headless` and `selenium_firefox` or `selenium_firefox_headless` too.
 
+```ruby
+CapybaraBox::Base.configure(browser: :selenium_firefox)
+```
+
 ## Version
 
 The version is setted via `webdrivers`. You can specify the version:
@@ -119,21 +124,10 @@ You can override all driver options:
 CapybaraBox.configure(driver_options: { clear_local_storage: true })
 ```
 
-## Log
+## Logger
 
-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:
+Logs are writen as WARN on the `STDOUT` by default. You can change it:
 
 ```ruby
-CapybaraBox.configure(log: true)
-```
-
-```
-[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
+CapybaraBox.configure(logger: { level: :debug, output: 'log/selenium.log' })
 ```

data/lib/capybara-box/base.rb

@@ -26,6 +26,14 @@ module CapybaraBox
       end
     end
 
+    def apply_bin_path(path)
+      if firefox?
+        ::Selenium::WebDriver::Firefox.path = path
+
+        ::Selenium::WebDriver::Firefox.path
+      end
+    end
+
     def apply_preferences
       preferences.each { |key, value| add_preference(key, value) }
     end
@@ -86,14 +94,6 @@ module CapybaraBox
       Capybara.default_max_wait_time = @max_wait_time if @max_wait_time
     end
 
-    def apply_bin_path(path)
-      if firefox?
-        ::Selenium::WebDriver::Firefox::Binary.path = path
-
-        ::Selenium::WebDriver::Firefox::Binary.path
-      end
-    end
-
     def create
       apply_arguments
       apply_preferences
@@ -106,17 +106,18 @@ module CapybaraBox
       register(@browser)
 
       configure_capybara
+      configure_logger(@parameters[:logger]) if logger?
     end
 
     def driver(app)
-      opts           = {}
+      opts                = {}
       opts[:options] = options if chrome_family?
 
       Capybara::Selenium::Driver.load_selenium
 
       opts[:http_client] = http_client if ::CapybaraBox::Helper.true?(ENV['CI'])
 
-      Capybara::Selenium::Driver.new(app, opts.merge(driver_options))
+      Capybara::Selenium::Driver.new(app, **opts.merge(driver_options))
     end
 
     def driver_options
@@ -128,12 +129,6 @@ module CapybaraBox
         clear_session_storage: true,
       }
 
-      if log? && chrome_family?
-        opts[:service] = ::Selenium::WebDriver::Service.chrome(
-          args: { log_path: 'log/capybara-box.log', verbose: true }
-        )
-      end
-
       opts
     end
 
@@ -175,16 +170,20 @@ module CapybaraBox
       Capybara.register_driver(name.to_sym) { |app| driver(app) }
     end
 
-    def self.configure(parameters)
+    def self.configure(parameters = {})
       new(parameters).tap(&:create)
     end
 
     private
 
-    def log?
-      return true if @parameters[:log].nil?
+    # https://www.selenium.dev/documentation/webdriver/troubleshooting/logging/#ruby
+    def configure_logger(options)
+      Selenium::WebDriver.logger.level = options.fetch(:level, :warn)
+      Selenium::WebDriver.logger.output = options.fetch(:output, 'selenium.log')
+    end
 
-      ::CapybaraBox::Helper.true?(@parameters[:log])
+    def logger?
+      @parameters.key?(:logger)
     end
   end
 end

data/lib/capybara-box/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CapybaraBox
-  VERSION = '1.1.2'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-box
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Washington Botelho
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara-screenshot
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +171,7 @@ homepage: https://github.com/wbotelhos/capybara-box
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,8 +186,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: A Tool Box for Capybara.
 test_files: []