selenium_chrome_helper 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f69e817cd92bb8e8b77889af1ecb48b5648d34bdfbda30f1dcf59d4fad442ec9
-  data.tar.gz: 1831693aeb8fb90debbf25a8103a1294b92dcbd4f8645288774f1bdecb4fb37c
+  metadata.gz: f8a3dc606169a2ead1a95947305d962a396049f2b9efccfbde7159acf34a7c3e
+  data.tar.gz: 9f9e3a441cd650e01dceb5d47bbdaa7e3e8360d4f2fc109532ffe5ab580e35ad
 SHA512:
-  metadata.gz: c381a54d1165b9636c8d52a0cd0cbc07189164ffaa00a2618e0bd3e3b86eaeca900a19fd16c5543bb7875a210a878ef0bca2a151d5dbcbf14c8d1a50bfe97bb1
-  data.tar.gz: 4fcba792fe8aa8f39d6342c99e8ae5745482523914dd4b50999b52a19906c0345b2993e7a6d741ca33c5abdf462d90aa88c74c4afa94649f952e903ed11aaaa8
+  metadata.gz: 7d7f88532fa87a1914bb543c5cbf4d54d739700ed7e25d2b0bbf3df5984a6851d2486b319c109adc1e0be4c17b05e8e0ccd7a2254ebff3c4a00fdc4ffa1f2211
+  data.tar.gz: c15546c7264ddb8abe4bc278b73a54ed1db0717a31b14580b0638d43f4df862dda5fd0869e6ef75f80a79821d30b0fcb1a95e2fb0152b09edcf16dfdd10f4c76

data/lib/selenium_chrome_helper/railtie.rb

@@ -10,30 +10,21 @@ module SeleniumChromeHelper
   # This Railtie configures Capybara to use a specific version of Google Chrome for testing.
   # It registers two drivers: one for headless testing and one for non-headless testing.
   class Railtie < Rails::Railtie
-    initializer 'selenium_chrome_helper.configure_capybara' do
-      platform = determine_platform
-      base_path = Rails.root.join('.chrome-for-testing', CHROME_VERSION)
-      chrome_path = determine_chrome_path(base_path, platform)
-      driver_path = base_path.join("chromedriver-#{platform}", 'chromedriver').to_s
-
-      Capybara.register_driver :chrome_for_testing do |app|
-        Selenium::WebDriver::Chrome::Service.driver_path = driver_path
-
-        options = configure_browser_options(chrome_path)
-        Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
-      end
-
-      Capybara.register_driver :chrome_for_testing_gui do |app|
-        Selenium::WebDriver::Chrome::Service.driver_path = driver_path
+    rake_tasks do
+      load File.expand_path('../tasks/install.rake', __dir__)
+    end
 
-        options = configure_browser_options(chrome_path, headless: false)
-        Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
-      end
+    initializer 'selenium_chrome_helper.configure_capybara' do
+      SeleniumChromeHelper::Railtie.register_driver(:chrome_for_testing, headless: true)
+      SeleniumChromeHelper::Railtie.register_driver(:chrome_for_testing_gui, headless: false)
     end
 
-    private
+    def self.base_path
+      custom = ENV['CHROME_FOR_TESTING_PATH']
+      Pathname.new(custom || Rails.root.join('.chrome-for-testing', CHROME_VERSION))
+    end
 
-    def determine_platform
+    def self.platform
       case RUBY_PLATFORM
       when /darwin/
         `uname -m`.strip == 'arm64' ? 'mac-arm64' : 'mac-x64'
@@ -44,16 +35,26 @@ module SeleniumChromeHelper
       end
     end
 
-    def determine_chrome_path(base_path, platform)
-      if platform.start_with?('mac')
-        base_path.join("chrome-#{platform}", 'Google Chrome for Testing.app', 'Contents',
-                       'MacOS', 'Google Chrome for Testing').to_s
-      else
-        base_path.join("chrome-#{platform}", 'chrome').to_s
-      end
+    def self.chrome_path
+      path = if platform.start_with?('mac')
+               base_path.join("chrome-#{platform}", 'Google Chrome for Testing.app', 'Contents',
+                              'MacOS', 'Google Chrome for Testing')
+             else
+               base_path.join("chrome-#{platform}", 'chrome')
+             end
+      warn "⚠️ Chrome binary not found at #{path}. Did you run `rake chrome:install`?" unless File.exist?(path)
+
+      path.to_s
+    end
+
+    def self.driver_path
+      path = base_path.join("chromedriver-#{platform}", 'chromedriver')
+      warn "⚠️ Chromedriver not found at #{path}. Did you run `rake chrome:install`?" unless File.exist?(path)
+
+      path.to_s
     end
 
-    def configure_browser_options(chrome_path, headless: true)
+    def self.configure_browser_options(headless: true)
       options = Selenium::WebDriver::Chrome::Options.new
       options.binary = chrome_path
       options.add_argument('--headless=new') if headless
@@ -62,5 +63,13 @@ module SeleniumChromeHelper
       options.add_argument('--window-size=1400,1400')
       options
     end
+
+    def self.register_driver(name, headless:)
+      Capybara.register_driver name do |app|
+        Selenium::WebDriver::Chrome::Service.driver_path = driver_path
+        options = configure_browser_options(headless: headless)
+        Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
+      end
+    end
   end
 end

data/lib/selenium_chrome_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SeleniumChromeHelper
-  VERSION = '0.1.1'
+  VERSION = '0.1.4'
 end

data/lib/selenium_chrome_helper.rb

@@ -1,6 +1,4 @@
-require "selenium_chrome_helper/version"
+# frozen_string_literal: true
 
-# Auto-load rake tasks when included in a Rails app or via `require`
-if defined?(Rake)
-  load File.expand_path("tasks/install.rake", __dir__)
-end
+require 'selenium_chrome_helper/version'
+require 'selenium_chrome_helper/railtie' if defined?(Rails::Railtie)

data/lib/tasks/install.rake

@@ -3,7 +3,7 @@
 require 'fileutils'
 require 'open-uri'
 require 'json'
-require 'zip' unless defined?(Zip)
+require 'zip'
 
 # rubocop:disable Metrics/BlockLength, Security/Open
 namespace :chrome do
@@ -11,7 +11,7 @@ namespace :chrome do
   task :install, [:version] do |_, args|
     version = args[:version] || '134.0.6998.165'
     api_url = 'https://googlechromelabs.github.io/chrome-for-testing/known-good-versions-with-downloads.json'
-    install_base = File.expand_path("chrome-for-testing/\#{version}", Dir.pwd)
+    install_base = File.expand_path(".chrome-for-testing/#{version}", Dir.pwd)
 
     platform = case RUBY_PLATFORM
                when /darwin/
@@ -19,35 +19,35 @@ namespace :chrome do
                when /linux/
                  'linux64'
                else
-                 raise "Unsupported platform: \#{RUBY_PLATFORM}"
+                 raise "Unsupported platform: #{RUBY_PLATFORM}"
                end
 
-    puts "➡️  Platform: \#{platform}"
-    puts "📡 Fetching metadata for Chrome version \#{version}..."
+    puts "➡️  Platform: #{platform}"
+    puts "📡 Fetching metadata for Chrome version #{version}..."
 
     json = URI.open(api_url).read
     data = JSON.parse(json)
 
     version_info = data['versions'].find { |v| v['version'] == version }
 
-    abort "❌ Version \#{version} not found in known-good list." unless version_info
+    abort "❌ Version #{version} not found in known-good list." unless version_info
 
     chrome_url = version_info.dig('downloads', 'chrome')&.find { |d| d['platform'] == platform }&.dig('url')
     driver_url = version_info.dig('downloads', 'chromedriver')&.find { |d| d['platform'] == platform }&.dig('url')
 
     unless chrome_url && driver_url
-      abort "❌ No matching downloads found for platform \#{platform} and version \#{version}"
+      abort "❌ No matching downloads found for platform #{platform} and version #{version}"
     end
 
-    puts "⬇️  Chrome URL: \#{chrome_url}"
-    puts "⬇️  Chromedriver URL: \#{driver_url}"
+    puts "⬇️  Chrome URL: #{chrome_url}"
+    puts "⬇️  Chromedriver URL: #{driver_url}"
 
     FileUtils.mkdir_p(install_base)
 
     download_and_unzip(chrome_url, File.join(install_base, 'chrome.zip'), install_base)
     download_and_unzip(driver_url, File.join(install_base, 'chromedriver.zip'), install_base)
 
-    puts "✅ Chrome and Chromedriver installed to \#{install_base}"
+    puts "✅ Chrome and Chromedriver installed to #{install_base}"
   end
 
   def download_and_unzip(url, zip_path, extract_to)
@@ -66,6 +66,8 @@ namespace :chrome do
   def unzip(zip_path, extract_to)
     Zip::File.open(zip_path) do |zip_file|
       zip_file.each do |entry|
+        next if entry.symlink? # silently skip symlinks
+
         entry_path = File.join(extract_to, entry.name)
         FileUtils.mkdir_p(File.dirname(entry_path))
         zip_file.extract(entry, entry_path) unless File.exist?(entry_path)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium_chrome_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Gonzalo Robaina
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: zip
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: Adds a rake task (`chrome:install`) to easily fetch a pinned version
   of Chrome and Chromedriver locally or in CI.
 email: