bundler-download 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f64d8149b156977c05751eaecef7826a3ee378ebdb5d529f0875597b11d4a5d9
-  data.tar.gz: 41bb7ad2e11cd1bcd47f0557c0d512ae5312a6193f2a518cfb7de7e1c0f7639d
+  metadata.gz: 81182c9e860fd1087e7d5b278eb75f7e6acc13c82051e2b606e606e76b18f101
+  data.tar.gz: bdcfd5aff08ff0317c28eecf9afc683c23194d42450e03d36a1aa30aa08b31d0
 SHA512:
-  metadata.gz: 1c8ff5f7452e4c1e4e0a2a118ce0e899f0334a0695a0ffa31c9f6458d12e7ca46c119af843dade3c27812f65cec7c1fa3b4ef31ae4dcfbb3553acec471329c22
-  data.tar.gz: a8f98b7bd09a75514558b09a22f5a9026c72214d7eefcb408c8e267feca121a828fa2651ef82c67cba4e9f203cc0bedfd8334f8222c0f1ec296bdee2cc6389c2
+  metadata.gz: 16ebcc18c32c5575242c21981e1cff66b8936e3c827f69e11780527cb87bbfdb6e27928cd70463c79bc8171f4cfe91303b0969db36a1665cf599c5182aa7e839
+  data.tar.gz: b0ff1aa52182581bf77c089862f4daaf55cc4d98da7cc34b97ddb6f4cb303afdd857663e3b97fbef075e852995eb5ed587ee2ee545c21624b4393404bf683ec9

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.3.0
+
+- Setup Bundler default group only when using as an API to avoid loading :development/:test group gems into a production app 
+- Announce that download files are missing for `bundler download show` when a Downloadfile exists but downloads have not been made
+- Document options (e.g. --keep-existing and --all-operating-systems) in `bundle download help`
+
 ## 1.2.0
 
 - Get rid of httparty

data/README.md

@@ -1,7 +1,7 @@
-# bundler-download - Bundler Plugin
+# bundler-download - Bundler Plugin - v1.3.0
 [![Gem Version](https://badge.fury.io/rb/bundler-download.svg)](http://badge.fury.io/rb/bundler-download)
 
-Bundler plugin for auto-downloading extra gem files (e.g. large file downloads) specified in [`Downloadfile`](#downloadfile) after `bundle install`.
+Bundler plugin for auto-downloading extra gem files (e.g. large file downloads) specified in [`Downloadfile`](#downloadfile) after `bundle install`
 
 ## Background
 
@@ -24,7 +24,7 @@ If a Ruby Gem needs to depend on one of those gems, it can declare as a standard
 Add [bundler-download](https://rubygems.org/gems/bundler-download) as a standard .gemspec dependency:
 
 ```ruby
-s.add_dependency('bundler-download', [">= 1.1.0"])
+s.add_dependency('bundler-download', ["~> 1.3"])
 ```
 
 Afterwards, ensure there is a [`Downloadfile`](#downloadfile) at the root directory of the gem, including in .gemspec `files`:
@@ -68,6 +68,8 @@ The keyword `download` declares a file to download and takes the following argum
 
 ## App Bundler Plugin Instructions
 
+In plugin mode, all gems declared in Gemfile are inspected for presence of Downloadfile regardless of what group they belong to.
+
 An app can depend on a gem that has a `Downloadfile` by adding the `bundler-download` plugin first (or manually installing via `bundle plugin install bundler-download`) and then including the gem in `Gemfile` like it normally would:
 
 ```
@@ -100,7 +102,7 @@ Using tty-cursor 0.7.1
 Using tty-screen 0.8.1
 Using unicode-display_width 1.7.0
 Using tty-progressbar 0.17.0
-Using bundler-download 1.1.0
+Using bundler-download 1.3.0
 Using facets 3.1.0
 Using glimmer 1.0.0
 bundle-download plugin gem-after-install-all hook:
@@ -163,16 +165,19 @@ bundle download help
 Prints:
 
 ```
-== bundler-download - Bundler Plugin - v1.1.0 ==
-Commands/Subcommands:
-  bundle download help   # Provide help by printing usage instructions
-  bundle download usage  # (alias for help)
-  bundle download start  # Start download
-  bundle download        # (alias for start)
-  bundle download clear  # Clear downloads by deleting them under all gems
-  bundle download clean  # (alias for clear)
-  bundle download list   # List downloads by printing Downloadfile content for all gems
-  bundle download show   # Show downloaded files for all gems
+== bundler-download - Bundler Plugin - v1.3.0 ==
+
+Commands/Subcommands/Options:
+  bundle download help                     # Provide help by printing usage instructions
+  bundle download usage                    # (alias for help)
+  bundle download start                    # Start downloads for current operating system
+  bundle download                          # (alias for start)
+  bundle download --all-operating-systems  # Download files for all operating systems
+  bundle download --keep-existing          # Do not redownload already downloaded files
+  bundle download clear                    # Clear downloads by deleting them under all gems
+  bundle download clean                    # (alias for clear)
+  bundle download list                     # List downloads by printing Downloadfile content for all gems
+  bundle download show                     # Show downloaded files for all gems
 ```
 
 ##### clear (alias: clean)
@@ -226,6 +231,8 @@ Showing downloaded files for /Users/User/.rvm/gems/ruby-2.7.1@bundler-download/g
 
 ### API
 
+In API mode, only gems belonging to the default group in Gemfile are inspected for presence of Downloadfile by default. An app may change that though by loading other Bundler groups (e.g. `Bundler.setup(:default, :developemnt)`)
+
 Apps may choose to integrate with the [bundler-download](https://rubygems.org/gems/bundler-download) gem directly to trigger downloads instead of relying on the plugin.
 This can be useful when wanting to trigger downloads only on first use while staying transparent should the gem features not be used.
 
@@ -236,6 +243,13 @@ require 'bundler-download'
 Bundler::Download.new.exec('download', [])
 ```
 
+You can also use the `--keep-existing` option to avoid redownload if files were there already:
+
+```ruby
+require 'bundler-download'
+Bundler::Download.new.exec('download', ['--keep-existing'])
+```
+
 ## Contributing to bundler-download
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/bundler-download.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: bundler-download 1.2.0 ruby lib
+# stub: bundler-download 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "bundler-download".freeze
-  s.version = "1.2.0"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["AndyMaleh".freeze]
-  s.date = "2020-09-25"
+  s.date = "2020-09-27"
   s.description = "bundler-download is a Bundler plugin for auto-downloading gem-specified extra files (e.g. large file downloads) on `bundle install` from a `Downloadfile`".freeze
   s.email = "andy.am@gmail.com".freeze
   s.executables = ["bundler-download".freeze]

data/lib/bundler-download.rb

@@ -20,7 +20,11 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'bundler'
-require 'bundler/setup'
+if ENV['BUNDLER_DOWNLOAD_PLUGIN'].to_s.downcase == 'true'
+  require 'bundler/setup'
+else
+  Bundler.setup(:default)
+end
 require 'download'
 require 'fileutils'
 require 'os'

data/lib/bundler-download/ext/download.rb

@@ -52,7 +52,7 @@ module Download
     
     def start(hash={})
       set_multi(hash)
-      return puts("Download '#{file_path}' already exists! (run `bundle download` to redownload)") if options.keys.include?('--keep_existing') && File.exist?(file_path)
+      return puts("Download already exists: '#{file_path}' (run `bundle download` to redownload)") if options.keys.include?('--keep_existing') && File.exist?(file_path)
       
       uri, head_response = final_uri_and_head_response
       content_length = head_response["content-length"]

data/lib/bundler/download.rb

@@ -38,6 +38,8 @@ module Bundler
             keep_existing: args.include?('--keep-existing'),
             all_operating_systems: args.include?('--all-operating-systems'),
           )
+          puts "== bundler-download - Bundler Plugin - v#{File.read(File.expand_path('../../../VERSION', __FILE__)).strip} =="
+          puts
           bundler_downloadfile.send(subcommand)
         end
         true

data/lib/bundler/downloadfile.rb

@@ -24,16 +24,17 @@ module Bundler
     attr_reader :file, :file_content, :gem_path, :keep_existing
     
     HELP = <<~MULTI_LINE_STRING
-      == bundler-download - Bundler Plugin - v#{File.read(File.expand_path('../../../VERSION', __FILE__)).strip} ==
-      Commands/Subcommands:
-        bundle download help   # Provide help by printing usage instructions
-        bundle download usage  # (alias for help)
-        bundle download start  # Start download
-        bundle download        # (alias for start)
-        bundle download clear  # Clear downloads by deleting them under all gems
-        bundle download clean  # (alias for clear)
-        bundle download list   # List downloads by printing Downloadfile content for all gems
-        bundle download show   # Show downloaded files for all gems
+      Commands/Subcommands/Options:
+        bundle download help                     # Provide help by printing usage instructions
+        bundle download usage                    # (alias for help)
+        bundle download start                    # Start downloads for current operating system
+        bundle download                          # (alias for start)
+        bundle download --all-operating-systems  # Download files for all operating systems
+        bundle download --keep-existing          # Do not redownload already downloaded files
+        bundle download clear                    # Clear downloads by deleting them under all gems
+        bundle download clean                    # (alias for clear)
+        bundle download list                     # List downloads by printing Downloadfile content for all gems
+        bundle download show                     # Show downloaded files for all gems
     MULTI_LINE_STRING
 
     SUPPORTED_OPERATING_SYSTEMS = %w[mac windows linux]    
@@ -90,10 +91,28 @@ module Bundler
     
     def show
       puts "Showing downloaded files for #{file}"
+      puts '- - -'
+      missing_downloads = false
+      missing_downloads_for_current_platform_os = false
       @downloads.each do |download|
-        file = download.file_path
-        puts "#{File.size(file)} #{file}" if File.exist?(file)
+        download_file_entry = download.file_path
+        if File.exist?(download_file_entry)
+          puts "Downloaded: #{File.size(download_file_entry)} #{download_file_entry}"
+        else
+          missing_downloads = true
+          missing_downloads_for_current_platform_os = true if download.os == PLATFORM_OS
+          puts "Not downloaded: #{download_file_entry}"
+        end
       end
+      message = ''
+      if missing_downloads_for_current_platform_os      
+        message += "Downloads are missing for the current operating system (#{PLATFORM_OS}). \nRun `bundle download` to download missing files for current operating system (#{PLATFORM_OS}).\n"
+      else
+        message += "All downloads are present for current operating system (#{PLATFORM_OS})."
+        message += " Optionally, run `bundle download --all-operating-systems` to download files for all operating systems.\n" if missing_downloads
+      end
+      puts message
+      puts
     end
   end
 end

data/plugins.rb

@@ -1 +1,3 @@
+ENV['BUNDLER_DOWNLOAD_PLUGIN'] = 'true'
+
 require 'bundler-download'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundler-download
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler