capybara-box 0.4.0 → 1.0.0

data/lib/capybara-box/helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CapybaraBox
+  module Helper
+    module_function
+
+    def true?(value)
+      ['true', true].include?(value)
+    end
+  end
+end

data/lib/capybara-box/screenshot.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module CapybaraBox
+  module Screenshot
+    module_function
+
+    def configure(options, browser_name)
+      return unless ::CapybaraBox::Helper.true?(options[:enabled])
+
+      require 'capybara-screenshot/rspec'
+
+      Capybara::Screenshot.append_timestamp                                  = false
+      Capybara::Screenshot.prune_strategy                                    = :keep_last_run
+      Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples = false
+
+      Capybara::Screenshot.register_filename_prefix_formatter(:rspec) do |example|
+        example.full_description.downcase.gsub('#', '--').tr ' ', '-'
+      end
+
+      if options[:s3]
+        bucket_name = ENV['CAPYBARA_BOX__S3_BUCKET_NAME']
+        region      = ENV['CAPYBARA_BOX__S3_REGION']
+
+        Capybara::Screenshot.s3_configuration = {
+          bucket_name: bucket_name,
+          bucket_host: "#{bucket_name}.#{region}.amazonaws.com",
+
+          s3_client_credentials: {
+            access_key_id: ENV['CAPYBARA_BOX__S3_ACCESS_KEY_ID'],
+            region: region,
+            secret_access_key: ENV['CAPYBARA_BOX__S3_SECRET_ACCESS_KEY']
+          },
+        }
+      end
+
+      Capybara::Screenshot.register_driver(browser_name) do |driver, path|
+        driver.browser.save_screenshot(path)
+      end
+    end
+  end
+end

data/lib/capybara-box/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-box
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Washington Botelho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara-screenshot
@@ -53,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: chromedriver-helper
+  name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -140,40 +140,19 @@ description: A Tool Box for Capybara.
 email: wbotelhos@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 files:
 - CHANGELOG.md
 - LICENSE
 - README.md
 - lib/capybara-box.rb
 - lib/capybara-box/base.rb
+- lib/capybara-box/helper.rb
+- lib/capybara-box/screenshot.rb
 - lib/capybara-box/version.rb
-- spec/lib/capybara_box/base/add_argument_spec.rb
-- spec/lib/capybara_box/base/add_preference_spec.rb
-- spec/lib/capybara_box/base/apply_arguments_spec.rb
-- spec/lib/capybara_box/base/apply_bin_path_spec.rb
-- spec/lib/capybara_box/base/apply_preferences_spec.rb
-- spec/lib/capybara_box/base/apply_version_spec.rb
-- spec/lib/capybara_box/base/arguments_spec.rb
-- spec/lib/capybara_box/base/chrome_family_spec.rb
-- spec/lib/capybara_box/base/chrome_headless_spec.rb
-- spec/lib/capybara_box/base/chrome_spec.rb
-- spec/lib/capybara_box/base/configure_screenshot_spec.rb
-- spec/lib/capybara_box/base/configure_spec.rb
-- spec/lib/capybara_box/base/create_spec.rb
-- spec/lib/capybara_box/base/driver_options_spec.rb
-- spec/lib/capybara_box/base/driver_spec.rb
-- 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
-- spec/lib/capybara_box/base/self_configure_spec.rb
-- spec/lib/capybara_box/base/version_spec.rb
-- spec/rails_helper.rb
-- spec/support/common.rb
 homepage: https://github.com/wbotelhos/capybara-box
 licenses:
 - MIT
@@ -197,30 +176,4 @@ rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A Tool Box for Capybara.
-test_files:
-- spec/support/common.rb
-- spec/lib/capybara_box/base/http_client_spec.rb
-- spec/lib/capybara_box/base/apply_preferences_spec.rb
-- spec/lib/capybara_box/base/firefox_spec.rb
-- spec/lib/capybara_box/base/apply_arguments_spec.rb
-- spec/lib/capybara_box/base/driver_spec.rb
-- spec/lib/capybara_box/base/self_configure_spec.rb
-- spec/lib/capybara_box/base/add_argument_spec.rb
-- spec/lib/capybara_box/base/apply_bin_path_spec.rb
-- spec/lib/capybara_box/base/version_spec.rb
-- spec/lib/capybara_box/base/options_spec.rb
-- spec/lib/capybara_box/base/register_spec.rb
-- spec/lib/capybara_box/base/log_spec.rb
-- spec/lib/capybara_box/base/add_preference_spec.rb
-- spec/lib/capybara_box/base/create_spec.rb
-- spec/lib/capybara_box/base/chrome_headless_spec.rb
-- spec/lib/capybara_box/base/chrome_family_spec.rb
-- spec/lib/capybara_box/base/apply_version_spec.rb
-- spec/lib/capybara_box/base/chrome_spec.rb
-- spec/lib/capybara_box/base/arguments_spec.rb
-- spec/lib/capybara_box/base/http_client_options_spec.rb
-- spec/lib/capybara_box/base/driver_options_spec.rb
-- spec/lib/capybara_box/base/configure_screenshot_spec.rb
-- spec/lib/capybara_box/base/preferences_spec.rb
-- spec/lib/capybara_box/base/configure_spec.rb
-- spec/rails_helper.rb
+test_files: []

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

@@ -1,35 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe CapybaraBox::Base, '.add_argument' do
-  subject { described_class.new parameters }
-
-  context 'when is chrome' do
-    let!(:parameters) { { browser: :chrome } }
-
-    it 'adds the argument' do
-      subject.add_argument '--argument'
-
-      expect(subject.options.args).to eq Set['--argument']
-    end
-  end
-
-  context 'when is chrome headless' do
-    let!(:parameters) { { browser: :chrome_headless } }
-
-    it 'adds the argument' do
-      subject.add_argument '--argument'
-
-      expect(subject.options.args).to eq Set['--argument']
-    end
-  end
-
-  context 'when is firefox' do
-    let!(:parameters) { { browser: :firefox } }
-
-    it 'does not applies options' do
-      subject.add_argument '--argument'
-
-      expect(subject.options).to be_nil
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe CapybaraBox::Base, '.add_preference' do
-  subject { described_class.new parameters }
-
-  context 'when is chrome' do
-    let!(:parameters) { { browser: :chrome } }
-
-    it 'adds the argument' do
-      subject.add_preference :key, :value
-
-      expect(subject.options.prefs).to eq(key: :value)
-    end
-  end
-
-  context 'when is chrome headless' do
-    let!(:parameters) { { browser: :chrome_headless } }
-
-    it 'adds the argument' do
-      subject.add_preference :key, :value
-
-      expect(subject.options.prefs).to eq(key: :value)
-    end
-  end
-
-  context 'when is firefox' do
-    let!(:parameters) { { browser: :firefox } }
-
-    it 'does not applies options' do
-      subject.add_preference :key, :value
-
-      expect(subject.options).to be_nil
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe CapybaraBox::Base, '.apply_arguments' do
-  subject { described_class.new parameters }
-
-  before do
-    allow(subject).to receive(:arguments) { Set['--argument'] }
-  end
-
-  context 'when is not chrome' do
-    let!(:parameters) { { browser: :chrome } }
-
-    it 'applies' do
-      expect(subject.options.args).to eq Set.new
-
-      subject.apply_arguments
-
-      expect(subject.options.args).to eq Set['--argument']
-    end
-  end
-
-  context 'when is chrome headless' do
-    let!(:parameters) { { browser: :chrome_headless } }
-
-    it 'applies' do
-      expect(subject.options.args).to eq Set.new
-
-      subject.apply_arguments
-
-      expect(subject.options.args).to eq Set['--argument', '--headless']
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe CapybaraBox::Base, '.apply_bin_path' do
-  subject { described_class.new parameters }
-
-  before :all do
-    File.open('/tmp/bin', 'w') { |file| file.write 'echo "capybara-box/bin"' }
-    FileUtils.chmod 0755, '/tmp/bin'
-  end
-
-  context 'when is chrome' do
-    let!(:parameters) { { browser: :chrome } }
-
-    it 'does not apply' do
-      expect(subject.apply_bin_path('/tmp/bin')).to be_nil
-    end
-  end
-
-  context 'when is chrome headless' do
-    let!(:parameters) { { browser: :chrome_headless } }
-
-    it 'does not apply' do
-      expect(subject.apply_bin_path('/tmp/bin')).to be_nil
-    end
-  end
-
-  context 'when is firefox' do
-    let!(:parameters) { { browser: :firefox } }
-
-    it 'does not applies options' do
-      expect(subject.apply_bin_path('/tmp/bin')).to eq '/tmp/bin'
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe CapybaraBox::Base, '.apply_preferences' do
-  subject { described_class.new parameters }
-
-  before do
-    allow(subject).to receive(:preferences) { { key: :value } }
-  end
-
-  context 'when is chrome' do
-    let!(:parameters) { { browser: :chrome } }
-
-    it 'applies' do
-      expect(subject.options.prefs).to eq({})
-
-      subject.apply_preferences
-
-      expect(subject.options.prefs).to eq(key: :value)
-    end
-  end
-
-  context 'when is chrome headless' do
-    let!(:parameters) { { browser: :chrome_headless } }
-
-    it 'applies' do
-      expect(subject.options.prefs).to eq({})
-
-      subject.apply_preferences
-
-      expect(subject.options.prefs).to eq(key: :value)
-    end
-  end
-
-  context 'when is firefox' do
-    let!(:parameters) { { browser: :firefox } }
-
-    it 'does not applies options' do
-      subject.apply_preferences
-
-      expect(subject.options).to be_nil
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-require 'rails_helper'
-
-require 'chromedriver/helper'
-
-RSpec.describe CapybaraBox::Base, '.apply_version' do
-  subject { described_class.new parameters }
-
-  context 'when browser is chrome' do
-    let!(:parameters) { { browser: :chrome } }
-
-    it 'is used' do
-      subject.apply_version '2.31'
-
-      expect(subject.version).to eq '2.31'
-    end
-  end
-
-  context 'when browser is chrome headless' do
-    let!(:parameters) { { browser: :chrome_headless } }
-
-    it 'is used' do
-      subject.apply_version '2.31'
-
-      expect(subject.version).to eq '2.31'
-    end
-  end
-
-  context 'when browser is firefox' do
-    let!(:parameters) { { browser: :firefox } }
-
-    it 'does not applies options' do
-      subject.apply_preferences
-
-      expect(subject.options).to be_nil
-    end
-  end
-end

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

@@ -1,72 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe CapybaraBox::Base, '.arguments' do
-  subject { described_class.new parameters }
-
-  let!(:chrome_family_arguments) do
-    %w[
-      --disable-default-apps
-      --disable-extensions
-      --disable-infobars
-      --disable-notifications
-      --disable-password-generation
-      --disable-password-manager-reauthentication
-      --disable-password-separated-signin-flow
-      --disable-popup-blocking
-      --disable-save-password-bubble
-      --disable-translate
-      --incognito
-      --mute-audio
-      --no-default-browser-check
-      --start-fullscreen
-    ]
-  end
-
-  context 'when is chrome' do
-    let!(:parameters) { { browser: :chrome } }
-
-    it 'receives the right arguments' do
-      expect(subject.arguments).to eq chrome_family_arguments
-    end
-
-    context 'when arguments is given' do
-      let!(:parameters) { { arguments: ['--custom'], browser: :firefox } }
-
-      it 'is used' do
-        expect(subject.arguments).to eq ['--custom']
-      end
-    end
-  end
-
-  context 'when is chrome headless' do
-    let!(:parameters) { { browser: :chrome_headless } }
-
-    it 'receives the right arguments' do
-      expect(subject.arguments).to eq chrome_family_arguments
-    end
-
-    context 'when arguments is given' do
-      let!(:parameters) { { arguments: ['--custom'], browser: :chrome_headless } }
-
-      it 'is used' do
-        expect(subject.arguments).to eq ['--custom']
-      end
-    end
-  end
-
-  context 'when is firefox' do
-    let!(:parameters) { { browser: :firefox } }
-
-    it 'receives the right arguments' do
-      expect(subject.arguments).to eq []
-    end
-
-    context 'when arguments is given' do
-      let!(:parameters) { { arguments: ['--custom'], browser: :firefox } }
-
-      it 'is used' do
-        expect(subject.arguments).to eq ['--custom']
-      end
-    end
-  end
-end