selenium_download_helper 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85e717fb652e52a196fe55a4cc971559ea40ca19520697224a61954314a2ccd6
-  data.tar.gz: 751c36041230552bc4c8e0a0ef461319be336a561fd91d5530c4054c2afed474
+  metadata.gz: 5467dad132759192c6e70376b7c2f7cf5432acdaa1c7448026c28eb64251b7e9
+  data.tar.gz: 5380c0df4b66f7643fc118f7e69be0384651e1c98fc934189967a8317ca61439
 SHA512:
-  metadata.gz: 0ee99f51e617dd311131a3fb5a23d1d05418aaeea6739ac99570c722a9d1de8f850b5dae188f2425bf459300c0a641a384dc184f0cf3a00962e6a804ccc6d8a4
-  data.tar.gz: 47f6086b1363285424b4951c88ee1995b971c511f7fa942706271aa53bc66e8499cae5bf231f848b4d17d78d2acaf9f3d7be80268bb17ab3878d0c60a1987239
+  metadata.gz: d50cafa8b05cb778c76f7d3d727cb8a42bb3bceb6e234f6450001e5d9e8389a41574e34c5e8bf01232d80f26befa595e96d6b99dd52d61b62c7fc4cf6de11d43
+  data.tar.gz: c76971e08269761e80b6a33b5dc51787328a6678c83f79906405992121d655c7e3846c01756ac8ff73d5528031aece3cb9b9b4471e78208a9dfeb4b94250e1f8

data/Gemfile.lock

@@ -1,91 +1,87 @@
 PATH
   remote: .
   specs:
-    selenium_download_helper (1.0.0)
+    selenium_download_helper (1.2.0)
       rails (>= 7.0)
       selenium-webdriver
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    actioncable (7.2.1)
+      actionpack (= 7.2.1)
+      activesupport (= 7.2.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
       zeitwerk (~> 2.6)
-    actionmailbox (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activejob (= 7.1.3.4)
-      activerecord (= 7.1.3.4)
-      activestorage (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      actionview (= 7.1.3.4)
-      activejob (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
+    actionmailbox (7.2.1)
+      actionpack (= 7.2.1)
+      activejob (= 7.2.1)
+      activerecord (= 7.2.1)
+      activestorage (= 7.2.1)
+      activesupport (= 7.2.1)
+      mail (>= 2.8.0)
+    actionmailer (7.2.1)
+      actionpack (= 7.2.1)
+      actionview (= 7.2.1)
+      activejob (= 7.2.1)
+      activesupport (= 7.2.1)
+      mail (>= 2.8.0)
       rails-dom-testing (~> 2.2)
-    actionpack (7.1.3.4)
-      actionview (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    actionpack (7.2.1)
+      actionview (= 7.2.1)
+      activesupport (= 7.2.1)
       nokogiri (>= 1.8.5)
       racc
-      rack (>= 2.2.4)
+      rack (>= 2.2.4, < 3.2)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actiontext (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activerecord (= 7.1.3.4)
-      activestorage (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+      useragent (~> 0.16)
+    actiontext (7.2.1)
+      actionpack (= 7.2.1)
+      activerecord (= 7.2.1)
+      activestorage (= 7.2.1)
+      activesupport (= 7.2.1)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.1.3.4)
-      activesupport (= 7.1.3.4)
+    actionview (7.2.1)
+      activesupport (= 7.2.1)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activejob (7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activejob (7.2.1)
+      activesupport (= 7.2.1)
       globalid (>= 0.3.6)
-    activemodel (7.1.3.4)
-      activesupport (= 7.1.3.4)
-    activerecord (7.1.3.4)
-      activemodel (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activemodel (7.2.1)
+      activesupport (= 7.2.1)
+    activerecord (7.2.1)
+      activemodel (= 7.2.1)
+      activesupport (= 7.2.1)
       timeout (>= 0.4.0)
-    activestorage (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activejob (= 7.1.3.4)
-      activerecord (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activestorage (7.2.1)
+      actionpack (= 7.2.1)
+      activejob (= 7.2.1)
+      activerecord (= 7.2.1)
+      activesupport (= 7.2.1)
       marcel (~> 1.0)
-    activesupport (7.1.3.4)
+    activesupport (7.2.1)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     base64 (0.2.0)
     bigdecimal (3.1.8)
     builder (3.3.0)
-    concurrent-ruby (1.3.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.4)
@@ -112,8 +108,7 @@ GEM
     marcel (1.0.4)
     mini_mime (1.1.5)
     mini_portile2 (2.8.7)
-    minitest (5.24.1)
-    mutex_m (0.2.0)
+    minitest (5.25.1)
     net-imap (0.4.14)
       date
       net-protocol
@@ -124,16 +119,12 @@ GEM
     net-smtp (0.5.0)
       net-protocol
     nio4r (2.7.3)
-    nokogiri (1.16.6)
-      mini_portile2 (~> 2.8.2)
-      racc (~> 1.4)
-    nokogiri (1.16.6-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.16.6-x86_64-darwin)
+    nokogiri (1.14.3)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     psych (5.1.2)
       stringio
-    racc (1.8.0)
+    racc (1.8.1)
     rack (3.1.7)
     rack-session (2.0.0)
       rack (>= 3.0.0)
@@ -142,20 +133,20 @@ GEM
     rackup (2.1.0)
       rack (>= 3)
       webrick (~> 1.8)
-    rails (7.1.3.4)
-      actioncable (= 7.1.3.4)
-      actionmailbox (= 7.1.3.4)
-      actionmailer (= 7.1.3.4)
-      actionpack (= 7.1.3.4)
-      actiontext (= 7.1.3.4)
-      actionview (= 7.1.3.4)
-      activejob (= 7.1.3.4)
-      activemodel (= 7.1.3.4)
-      activerecord (= 7.1.3.4)
-      activestorage (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    rails (7.2.1)
+      actioncable (= 7.2.1)
+      actionmailbox (= 7.2.1)
+      actionmailer (= 7.2.1)
+      actionpack (= 7.2.1)
+      actiontext (= 7.2.1)
+      actionview (= 7.2.1)
+      activejob (= 7.2.1)
+      activemodel (= 7.2.1)
+      activerecord (= 7.2.1)
+      activestorage (= 7.2.1)
+      activesupport (= 7.2.1)
       bundler (>= 1.15.0)
-      railties (= 7.1.3.4)
+      railties (= 7.2.1)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -163,10 +154,10 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
-      irb
+    railties (7.2.1)
+      actionpack (= 7.2.1)
+      activesupport (= 7.2.1)
+      irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
@@ -176,7 +167,7 @@ GEM
       psych (>= 4.0.0)
     reline (0.5.9)
       io-console (~> 0.5)
-    rexml (3.3.2)
+    rexml (3.3.6)
       strscan
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -192,6 +183,7 @@ GEM
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
     rubyzip (2.3.2)
+    securerandom (0.3.1)
     selenium-webdriver (4.23.0)
       base64 (~> 0.2)
       logger (~> 1.4)
@@ -204,12 +196,13 @@ GEM
     timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    useragent (0.16.10)
     webrick (1.8.1)
     websocket (1.2.11)
     websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.16)
+    zeitwerk (2.6.17)
 
 PLATFORMS
   arm64-darwin-22

data/lib/selenium_download_helper/errors.rb

@@ -0,0 +1,12 @@
+module SeleniumDownloadHelper
+  class TimeoutError < StandardError
+    def initialize(error, download_path)
+      @download_path = download_path
+      super("#{error.message}\nDownloaded files:\n#{downloaded_files.join("\n")}")
+    end
+
+    def downloaded_files
+      Dir[File.join(@download_path, '*')]
+    end
+  end
+end

data/lib/selenium_download_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SeleniumDownloadHelper
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/lib/selenium_download_helper.rb

@@ -5,22 +5,28 @@ require 'fileutils'
 require 'selenium-webdriver'
 require 'active_support/concern'
 require_relative 'selenium_download_helper/version'
+require_relative 'selenium_download_helper/errors'
 
 module SeleniumDownloadHelper
   extend ActiveSupport::Concern
 
+  TEMPORARY_DOWNLOAD_FILENAME_PATTERN = /(\.crdownload|\/downloads.html)$/
+
+
   included do
     after(:all) do
       FileUtils.rm_rf(base_download_dir)
     end
   end
 
-  def wait_for_downloaded(timeout: 10, interval: 0.2, all: false, &block)
+  def wait_for_downloaded(timeout: 10, interval: 0.2, all: false, filename: nil, &block)
     download_path= mkdownloaddir
     page.driver.browser.download_path = download_path
     yield
-    Selenium::WebDriver::Wait.new(timeout: timeout, interval: interval).until { downloaded?(download_path) }
-    downloaded_files(download_path).then { |files| all ? files : files.first }
+    Selenium::WebDriver::Wait.new(timeout: timeout, interval: interval).until { downloaded?(download_path, filename:) }
+    downloaded_files(download_path, filename:).then { |files| all ? files : files.first }
+  rescue Selenium::WebDriver::Error::TimeoutError => e
+    raise TimeoutError.new(e, download_path)
   end
 
   private
@@ -34,12 +40,14 @@ module SeleniumDownloadHelper
       Dir.mktmpdir('selenium_download_helper__', base_download_dir)
     end
 
-    def downloaded_files(download_path)
-      Dir[File.join(download_path, '*')].map { |filepath| Pathname.new(filepath) }
+    def downloaded_files(download_path, filename: nil)
+      Dir[File.join(download_path, '*')]
+        .map { |filepath| Pathname.new(filepath) }
+        .select { |file| filename.nil? || filename === file.basename.to_s }
     end
 
-    def downloaded?(download_path)
-      files = downloaded_files(download_path)
-      files.map(&:to_s).grep(/\.crdownload$/).none? && files.any?
+    def downloaded?(download_path, filename: nil)
+      files = downloaded_files(download_path, filename:)
+      files.map(&:to_s).grep(TEMPORARY_DOWNLOAD_FILENAME_PATTERN).none? && files.any?
     end
 end

data/selenium_download_helper.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "https://github.com/SonicGarden/selenium_download_helper/blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/SonicGarden/selenium_download_helper/releases"
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selenium_download_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - aki77
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,6 +58,7 @@ files:
 - bin/console
 - bin/setup
 - lib/selenium_download_helper.rb
+- lib/selenium_download_helper/errors.rb
 - lib/selenium_download_helper/version.rb
 - selenium_download_helper.gemspec
 homepage: https://github.com/SonicGarden/selenium_download_helper
@@ -66,7 +67,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/SonicGarden/selenium_download_helper
   source_code_uri: https://github.com/SonicGarden/selenium_download_helper
-  changelog_uri: https://github.com/SonicGarden/selenium_download_helper/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/SonicGarden/selenium_download_helper/releases
 post_install_message:
 rdoc_options: []
 require_paths: