capistrano-bundler 1.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 780794935cf4421e6c6ca628207e7fa7fca0f42c8f856727b4ca26acc410246a
+  data.tar.gz: d7bf7372a9def4a6d90525f2e09292908b0a1390303e1688ec69024e02ad832c
+SHA512:
+  metadata.gz: 03262ebc4a0d68aa83cc12cc42a620ac76c0872753d5625b37e854551b7776f4d1da575f9bec8407b7496c37b43ac73128fb4ed4ecf2220a4714ebfefe5dc09b
+  data.tar.gz: 675812f770b249ce6e3c010796713b422d6f9bf9866dd2b1c7bb7af7fb9931cdde5720aa98cedd40b5efceccb2e06d8c68c0278797f61ad7ddfc42caeef0a88a

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v '~> 1.14' --conservative
+before_script: bundle exec danger

data/CHANGELOG.md

@@ -0,0 +1,89 @@
+# [Unreleased][] (master)
+
+* Your contribution here!
+
+# [1.6.0][] (2 Jul 2019)
+
+* Added `bundle_check_before_install` option to allow bypassing the `bundle install test` in the `bundler:install` task.
+
+# [1.5.0][] (23 Dec 2018)
+
+Changes to default behavior
+
+* Set `bundle_jobs` default to `4` @Tensho
+
+Breaking changes
+
+* None
+
+# [1.4.0][] (21 Oct 2018)
+
+Breaking changes
+
+* None
+
+Added
+
+* When "bundle install" is skipped due to a Gemfile's dependencies are being satisfied, print a message to the log instead of silently skipping
+
+# [1.3.0][] (22 Sep 2017)
+
+Breaking changes
+
+* None
+
+Added
+
+* Set all variables in `load:defaults` task so they are recognised as valid Capistrano settings when using `doctor:variables` and ensure defaults for `bundle_env_variables` and `bundle_clean_options` are set once in the same place as the other defaults.
+
+# [1.2.0][] (1 Oct 2016)
+
+Breaking changes
+
+* None
+
+Added
+
+* A `bundle clean` task.  There are no default hooks for it.
+* Use `bundle check` to check if we can skip `bundle install`
+* Run `bundle:install` on rollback (`deploy:reverted`)
+* You can now `require "capistrano/bundler/tasks"` to load the tasks only without the hooks
+
+# 1.1.4 (22 Jan 2015)
+
+* Don’t generate binstubs by default (#61)
+
+# 1.1.3 (4 Aug 2014)
+
+* Honor `:no_release` flag by using `release_roles` in Capistrano 3.1
+* capistrano-bundler now requires Capistrano 3.1 or higher (~> 3.1)
+* Added `:bundle_jobs` option for specifying number of parallel jobs
+
+# 1.1.2 (8 Feb 2014)
+
+* Added `bundle_env_variables` option for specifying environment variables that should be set when running `bundle`.
+* The `bundle_dir` option is now named `bundle_path`
+* Use `bundle install` instead of `bundle`
+* All options are now optional and can be excluded from the final bundle command by setting them to `nil`
+* Bundler looks for a `Gemfile` by default, so there is no need to specify it.
+
+# 1.1.1
+
+* ruby is not prefixed with `bundle exec` anymore by default
+* prefix rails with `bundle exec` by default
+
+# 1.1.0
+
+* Switching to new command map (https://github.com/capistrano/sshkit/pull/45)
+  Thanks to new command map, now this integration adds `bundle exec` to global executables (gem, ruby, rake). The list of executable can be tweaked by `bundle_bins`.
+
+# 1.0.0
+
+Initial release
+
+[Unreleased]: https://github.com/capistrano/bundler/compare/v1.6.0...HEAD
+[1.6.0]: https://github.com/capistrano/bundler/compare/v1.5.0...v1.6.0
+[1.5.0]: https://github.com/capistrano/bundler/compare/v1.4.0...v1.5.0
+[1.4.0]: https://github.com/capistrano/bundler/compare/v1.3.0...v1.4.0
+[1.3.0]: https://github.com/capistrano/bundler/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/capistrano/bundler/compare/v1.1.4...v1.2.0

data/Dangerfile

@@ -0,0 +1 @@
+danger.import_dangerfile(github: "capistrano/danger")

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-bundler.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Capistrano, your one stop deployment shop.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+# Capistrano::Bundler
+
+Bundler specific tasks for Capistrano v3:
+
+```sh
+$ cap production bundler:install
+```
+
+It also prefixes certain binaries to use `bundle exec`.
+
+## Installation
+
+Add these lines to your application's Gemfile **[Recommended]**:
+
+```ruby
+gem 'capistrano', '~> 3.6'
+gem 'capistrano-bundler', '~> 1.6'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install capistrano-bundler
+```
+
+## Usage
+
+Require in `Capfile` to use the default task:
+
+```ruby
+require 'capistrano/bundler'
+```
+
+The task will run before `deploy:updated` as part of Capistrano's default deploy, or can be run in isolation with `cap production bundler:install`.
+
+In order for Bundler to work efficiently on the server, its project configuration directory (`<release_path>/.bundle/`) should be persistent across releases.
+You need to add it to the `linked_dirs` Capistrano variable:
+
+Capistrano **3.5**+:
+
+```ruby
+# config/deploy.rb
+
+append :linked_dirs, '.bundle'
+```
+
+Capistrano < 3.5:
+
+```ruby
+# config/deploy.rb
+
+set :linked_dirs, fetch(:linked_dirs, []) << '.bundle'
+```
+
+It will still work fine with non-persistent configuration directory, but then it will have to re-resolve all gems on each deploy.
+
+By default, the plugin adds `bundle exec` prefix to common executables listed in `bundle_bins` option. This currently applies for `gem`, `rake` and `rails`.
+
+You can add any custom executable to this list:
+
+```ruby
+set :bundle_bins, fetch(:bundle_bins, []).push('my_new_binary')
+```
+
+Configurable options:
+
+```ruby
+set :bundle_roles, :all                                         # this is default
+set :bundle_servers, -> { release_roles(fetch(:bundle_roles)) } # this is default
+set :bundle_binstubs, -> { shared_path.join('bin') }            # default: nil
+set :bundle_gemfile, -> { release_path.join('MyGemfile') }      # default: nil
+set :bundle_path, -> { shared_path.join('bundle') }             # this is default. set it to nil for skipping the --path flag.
+set :bundle_without, %w{development test}.join(' ')             # this is default
+set :bundle_flags, '--deployment --quiet'                       # this is default
+set :bundle_env_variables, {}                                   # this is default
+set :bundle_clean_options, ""                                   # this is default. Use "--dry-run" if you just want to know what gems would be deleted, without actually deleting them
+set :bundle_check_before_install, true                          # default: true. Set this to false to bypass running `bundle check` before executing `bundle install`
+```
+
+You can parallelize the installation of gems with bundler's jobs feature.
+Choose a number less or equal than the number of cores your server.
+
+```ruby
+set :bundle_jobs, 8 # default: 4, only available for Bundler >= 1.4
+```
+
+To generate binstubs on each deploy, set `:bundle_binstubs` path:
+
+```ruby
+set :bundle_binstubs, -> { shared_path.join('bin') }
+```
+
+In the result this would execute the following bundle command on all servers
+(actual paths depend on the real deploy directory):
+
+```sh
+$ bundle install \
+  --binstubs /my_app/shared/bin \
+  --gemfile /my_app/releases/20130623094732/MyGemfile \
+  --path /my_app/shared/bundle \
+  --without development test \
+  --deployment --quiet
+```
+
+If any option is set to `nil` it will be excluded from the final bundle command.
+
+If you want to clean up gems after a successful deploy, add `after 'deploy:published', 'bundler:clean'` to config/deploy.rb.
+
+Downsides to cleaning:
+
+* If a rollback requires rebuilding a Gem with a large compiled binary component, such as Nokogiri, the rollback will take a while.
+* In rare cases, if a gem that was used in the previously deployed version was yanked, rollback would entirely fail.
+
+### Environment Variables
+
+The `bundle_env_variables` option can be used to specify any environment variables you want present when running the `bundle` command:
+
+```ruby
+# This translates to NOKOGIRI_USE_SYSTEM_LIBRARIES=1 when executed
+set :bundle_env_variables, { nokogiri_use_system_libraries: 1 }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+# Do nothing by default
+task :default

data/capistrano-bundler.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-bundler'
+  spec.version       = '1.6.0'
+  spec.authors       = ['Tom Clements', 'Lee Hambley', 'Kir Shatrov']
+  spec.email         = ['seenmyfate@gmail.com', 'lee.hambley@gmail.com', 'shatrov@me.com']
+  spec.description   = %q{Bundler support for Capistrano 3.x}
+  spec.summary       = %q{Bundler support for Capistrano 3.x}
+  spec.homepage      = 'https://github.com/capistrano/bundler'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '~> 3.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'danger'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano/bundler.rb

@@ -0,0 +1,2 @@
+require_relative 'bundler/tasks'
+require_relative 'bundler/hooks'

data/lib/capistrano/bundler/hooks.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/hooks.cap', __FILE__)

data/lib/capistrano/bundler/tasks.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/bundler.cap', __FILE__)

data/lib/capistrano/tasks/bundler.cap

@@ -0,0 +1,90 @@
+namespace :bundler do
+  desc <<-DESC
+        Install the current Bundler environment. By default, gems will be \
+        installed to the shared/bundle path. Gems in the development and \
+        test group will not be installed. The install command is executed \
+        with the --deployment and --quiet flags.
+
+        By default, bundler will not be run on servers with no_release: true.
+
+        You can override any of these defaults by setting the variables shown below.
+
+          set :bundle_roles, :all
+
+          set :bundle_servers, -> { release_roles(fetch(:bundle_roles)) }
+          set :bundle_binstubs, -> { shared_path.join('bin') }
+          set :bundle_gemfile, -> { release_path.join('Gemfile') }
+          set :bundle_path, -> { shared_path.join('bundle') }
+          set :bundle_without, %w{development test}.join(' ')
+          set :bundle_flags, '--deployment --quiet'
+          set :bundle_jobs, nil
+          set :bundle_env_variables, {}
+          set :bundle_clean_options, ""
+    DESC
+  task :install do
+    on fetch(:bundle_servers) do
+      within release_path do
+        with fetch(:bundle_env_variables) do
+          options = []
+          options << "--gemfile #{fetch(:bundle_gemfile)}" if fetch(:bundle_gemfile)
+          options << "--path #{fetch(:bundle_path)}" if fetch(:bundle_path)
+
+          if fetch(:bundle_check_before_install) && test(:bundle, :check, *options)
+            info "The Gemfile's dependencies are satisfied, skipping installation"
+          else
+            options << "--binstubs #{fetch(:bundle_binstubs)}" if fetch(:bundle_binstubs)
+            options << "--jobs #{fetch(:bundle_jobs)}" if fetch(:bundle_jobs)
+            options << "--without #{fetch(:bundle_without)}" if fetch(:bundle_without)
+            options << "#{fetch(:bundle_flags)}" if fetch(:bundle_flags)
+            execute :bundle, :install, *options
+          end
+        end
+      end
+    end
+  end
+
+  desc <<-DESC
+        Maps all binaries to use `bundle exec` by default.
+        Add your own binaries to the array with the command shown below.
+
+          set :bundle_bins, fetch(:bundle_bins) + %w(my_new_binary)
+    DESC
+  task :map_bins do
+    fetch(:bundle_bins).each do |command|
+      SSHKit.config.command_map.prefix[command.to_sym].push("bundle exec")
+    end
+  end
+
+  desc "Remove unused gems installed by bundler"
+  task :clean do
+    on fetch(:bundle_servers) do
+      within release_path do
+        with fetch(:bundle_env_variables) do
+          execute :bundle, :clean, fetch(:bundle_clean_options)
+        end
+      end
+    end
+  end
+end
+
+Capistrano::DSL.stages.each do |stage|
+  after stage, 'bundler:map_bins'
+end
+
+namespace :load do
+  task :defaults do
+    set :bundle_bins, %w{gem rake rails}
+
+    set :bundle_roles, :all
+    set :bundle_servers, -> { release_roles(fetch(:bundle_roles)) }
+    set :bundle_binstubs, nil
+    set :bundle_gemfile, nil
+    set :bundle_path, -> { shared_path.join('bundle') }
+    set :bundle_without, %w{development test}.join(' ')
+    set :bundle_flags, '--deployment --quiet'
+    set :bundle_jobs, 4
+    set :bundle_env_variables, {}
+    set :bundle_clean_options, ""
+    set :bundle_check_before_install, true
+  end
+end

data/lib/capistrano/tasks/hooks.cap

@@ -0,0 +1,2 @@
+before 'deploy:updated', 'bundler:install'
+before 'deploy:reverted', 'bundler:install'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-bundler
+version: !ruby/object:Gem::Version
+  version: 1.6.0
+platform: ruby
+authors:
+- Tom Clements
+- Lee Hambley
+- Kir Shatrov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: danger
+  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: rake
+  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'
+description: Bundler support for Capistrano 3.x
+email:
+- seenmyfate@gmail.com
+- lee.hambley@gmail.com
+- shatrov@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Dangerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-bundler.gemspec
+- lib/capistrano-bundler.rb
+- lib/capistrano/bundler.rb
+- lib/capistrano/bundler/hooks.rb
+- lib/capistrano/bundler/tasks.rb
+- lib/capistrano/tasks/bundler.cap
+- lib/capistrano/tasks/hooks.cap
+homepage: https://github.com/capistrano/bundler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Bundler support for Capistrano 3.x
+test_files: []