capistrano-rails 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dcd91a978e99c58547d28d3049fec73695c4f518
+  data.tar.gz: f6e20bd2b13cdc0f55e39b1bcf2fdad3d16cc4b5
+SHA512:
+  metadata.gz: 8be01bc08a5084597616374ce6497038c69ebba06a42832b2b64edb56130720e1c2f7ed3106274befa02706f67630b94a9c2efb6ff082523fc1d87a2cc7bfe3a
+  data.tar.gz: 53d8decbff18ca1d824a8032b9118ff687c2403a1733b02b7d138fc17eaa0aabe5933c6096c67a66f05ad9a464d3b9beb0b34965039f757465bc3465a6313f75

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

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,85 @@
+# [master][]
+
+* Your contribution here!
+
+# [1.3.0][] (Jun 9 2017)
+
+* rails_assets_groups config option to set RAILS_GROUPS (https://github.com/capistrano/rails/pull/135)
+
+# [1.2.3][] (Mar 4 2017)
+
+* [#200](https://github.com/capistrano/rails/pull/200): Don't link public/assets if public is already linked - [@mattbrictson](https://github.com/mattbrictson)
+
+# [1.2.2][] (Jan 10 2017)
+
+* Restored compatibility with older versions of Rake (< 11.0.0), introduced in previous change. (@toupeira)
+
+# [1.2.1][] (Dec 23 2016)
+
+* Diff db directory recursively
+* Avoid warning while running migrations on multiple servers (#189)
+
+# [1.2.0][] (Oct 25 2016)
+
+* Diff entire db directory when determining if migrations are needed
+
+# 1.1.8 (Sep 13 2016)
+
+* Handle arrays passed into `normalize_asset_timestamps` correctly (#184)
+
+# 1.1.7 (Jun 10 2016)
+
+* call `Array#uniq` in `deploy:set_linked_dirs` task to remove duplicated :linked_dirs
+* Add `migration_servers` configuration (#168)
+
+# 1.1.6 (Jan 19 2016)
+
+* Add `rake assets:clobber` task from Rails (#149)
+* Make `assets:clean` capable with zsh (#150)
+* Split `deploy:migrate` to allow for finer hook-control (#148)
+* Fix for parsing ls output in detect_manifest_path (#133)
+
+# 1.1.5 (Oct 15 2015)
+
+* Disable `deploy:cleanup_assets` by default due to undesirable behavior in Rails 3. Use `set :keep_assets, 2` to explicitly enable this feature for Rails 4.
+
+# 1.1.4 (Oct 10 2015)
+
+* Fixing bug with normalize_assets typo #138
+* Cleanup assets after:updated (#136)
+* Fixed linked_dirs containing default value of assets_prefix (#125)
+
+# 1.1.3 (Apr 18 2015)
+
+* Fixed no_release behaviour (https://github.com/capistrano/rails/pull/95)
+* Allow assets manifest backup with folder "manifests" (https://github.com/capistrano/rails/pull/92)
+* Handle Sprocket 3 manifest filename
+
+# 1.1.2 (Sep 1 2014)
+
+* rails_env is set before deploy (https://github.com/capistrano/rails/pull/66)
+* with `conditionally_migrate` option enabled you can skip `db:migrate` if there were no new migrations (https://github.com/capistrano/rails/pull/71)
+* Allow early overriding of assets_* parameters (https://github.com/capistrano/rails/pull/73)
+
+# 1.1.1
+
+* New `asset_roles` options: https://github.com/capistrano/rails/pull/30
+* normalized task spelling: 'deploy:normalise_assets' is now 'deploy:normalize_assets'
+* depend on capistrano 3.1 to support multiple role arguments
+
+# 1.1.0
+
+* set rails_env even if capistrano-rails was required partly
+* depend on capistrano-bundler
+* require bundler with capistrano-rails/all
+
+# 1.0.0
+
+Initial release
+
+[master]: https://github.com/capistrano/rails/compare/v1.3.0...HEAD
+[1.3.0]: https://github.com/capistrano/rails/compare/v1.2.2...v1.3.0
+[1.2.3]: https://github.com/capistrano/rails/compare/v1.2.2...v1.2.3
+[1.2.2]: https://github.com/capistrano/rails/compare/v1.2.1...v1.2.2
+[1.2.1]: https://github.com/capistrano/rails/compare/v1.2.0...v1.2.1
+[1.2.0]: https://github.com/capistrano/rails/compare/v1.1.8...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-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tom Clements
+
+MIT License
+
+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,116 @@
+# Capistrano::Rails
+
+Rails specific tasks for Capistrano v3:
+
+  - `cap deploy:migrate`
+  - `cap deploy:compile_assets`
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'capistrano', '~> 3.6'
+  gem 'capistrano-rails', '~> 1.3'
+end
+```
+
+Run the following command to install the gems:
+
+```
+bundle install
+```
+
+Then run the generator to create a basic set of configuration files:
+
+```
+bundle exec cap install
+```
+
+## Usage
+
+Require everything (`bundler`, `rails/assets` and `rails/migrations`):
+
+```ruby
+# Capfile
+require 'capistrano/rails'
+```
+
+Or require just what you need manually:
+
+```ruby
+# Capfile
+require 'capistrano/bundler' # Rails needs Bundler, right?
+require 'capistrano/rails/assets'
+require 'capistrano/rails/migrations'
+```
+
+Please note that any `require`s should be placed in `Capfile`, not in `config/deploy.rb`.
+
+You can tweak some Rails-specific options in `config/deploy.rb`:
+
+```ruby
+# If the environment differs from the stage name
+set :rails_env, 'staging'
+
+# Defaults to :db role
+set :migration_role, :db
+
+# Defaults to the primary :db server
+set :migration_servers, -> { primary(fetch(:migration_role)) }
+
+# Defaults to false
+# Skip migration if files in db/migrate were not modified
+set :conditionally_migrate, true
+
+# Defaults to [:web]
+set :assets_roles, [:web, :app]
+
+# Defaults to 'assets'
+# This should match config.assets.prefix in your rails config/application.rb
+set :assets_prefix, 'prepackaged-assets'
+
+# RAILS_GROUPS env value for the assets:precompile task. Default to nil.
+set :rails_assets_groups, :assets
+
+# If you need to touch public/images, public/javascripts, and public/stylesheets on each deploy
+set :normalize_asset_timestamps, %w{public/images public/javascripts public/stylesheets}
+
+# Defaults to nil (no asset cleanup is performed)
+# If you use Rails 4+ and you'd like to clean up old assets after each deploy,
+# set this to the number of versions to keep
+set :keep_assets, 2
+```
+
+### Symlinks
+
+You'll probably want to symlink Rails shared files and directories like `log`, `tmp` and `public/uploads`.
+Make sure you enable it by setting `linked_dirs` and `linked_files` options:
+
+```ruby
+# deploy.rb
+set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', 'public/system', 'public/uploads')
+set :linked_files, fetch(:linked_files, []).push('config/database.yml', 'config/secrets.yml')
+```
+
+### Recommendations
+
+While migrations looks like a concern of the database layer, Rails migrations
+are strictly related to the framework. Therefore, it's recommended to set the
+role to `:app` instead of `:db` like:
+
+```ruby
+set :migration_role, :app
+```
+
+The advantage is you won't need to deploy your application to your database
+server, and overall a better separation of concerns.
+
+## 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-rails.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-rails"
+  gem.version       = '1.3.0'
+  gem.authors       = ["Tom Clements", "Lee Hambley", "Kir Shatrov"]
+  gem.email         = ["seenmyfate@gmail.com", "lee.hambley@gmail.com", "shatrov@me.com"]
+  gem.description   = %q{Rails specific Capistrano tasks}
+  gem.summary       = %q{Rails specific Capistrano tasks}
+  gem.homepage      = "https://github.com/capistrano/rails"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '~> 3.1'
+  gem.add_dependency 'capistrano-bundler', '~> 1.1'
+
+  gem.add_development_dependency 'danger'
+end

data/lib/capistrano/rails.rb

@@ -0,0 +1,3 @@
+require 'capistrano/bundler'
+require 'capistrano/rails/assets'
+require 'capistrano/rails/migrations'

data/lib/capistrano/rails/assets.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/assets.rake", __FILE__)

data/lib/capistrano/rails/migrations.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/migrations.rake", __FILE__)

data/lib/capistrano/tasks/assets.rake

@@ -0,0 +1,138 @@
+load File.expand_path("../set_rails_env.rake", __FILE__)
+
+module Capistrano
+  class FileNotFound < StandardError
+  end
+end
+
+namespace :deploy do
+  desc 'Normalize asset timestamps'
+  task :normalize_assets => [:set_rails_env] do
+    on release_roles(fetch(:assets_roles)) do
+      assets = Array(fetch(:normalize_asset_timestamps, []))
+      if assets.any?
+        within release_path do
+          execute :find, "#{assets.join(' ')} -exec touch -t #{asset_timestamp} {} ';'; true"
+        end
+      end
+    end
+  end
+
+  desc 'Compile assets'
+  task :compile_assets => [:set_rails_env] do
+    invoke 'deploy:assets:precompile'
+    invoke 'deploy:assets:backup_manifest'
+  end
+
+  desc 'Cleanup expired assets'
+  task :cleanup_assets => [:set_rails_env] do
+    next unless fetch(:keep_assets)
+    on release_roles(fetch(:assets_roles)) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :rake, "'assets:clean[#{fetch(:keep_assets)}]'"
+        end
+      end
+    end
+  end
+
+  desc 'Clobber assets'
+  task :clobber_assets => [:set_rails_env] do
+    on release_roles(fetch(:assets_roles)) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :rake, "assets:clobber"
+        end
+      end
+    end
+  end
+
+  desc 'Rollback assets'
+  task :rollback_assets => [:set_rails_env] do
+    begin
+      invoke 'deploy:assets:restore_manifest'
+    rescue Capistrano::FileNotFound
+      invoke 'deploy:compile_assets'
+    end
+  end
+
+  after 'deploy:updated', 'deploy:compile_assets'
+  after 'deploy:updated', 'deploy:cleanup_assets'
+  after 'deploy:updated', 'deploy:normalize_assets'
+  after 'deploy:reverted', 'deploy:rollback_assets'
+
+  namespace :assets do
+    task :precompile do
+      on release_roles(fetch(:assets_roles)) do
+        within release_path do
+          with rails_env: fetch(:rails_env), rails_groups: fetch(:rails_assets_groups) do
+            execute :rake, "assets:precompile"
+          end
+        end
+      end
+    end
+
+    task :backup_manifest do
+      on release_roles(fetch(:assets_roles)) do
+        within release_path do
+          backup_path = release_path.join('assets_manifest_backup')
+
+          execute :mkdir, '-p', backup_path
+          execute :cp,
+            detect_manifest_path,
+            backup_path
+        end
+      end
+    end
+
+    task :restore_manifest do
+      on release_roles(fetch(:assets_roles)) do
+        within release_path do
+          target = detect_manifest_path
+          source = release_path.join('assets_manifest_backup', File.basename(target))
+          if test "[[ -f #{source} && -f #{target} ]]"
+            execute :cp, source, target
+          else
+            msg = 'Rails assets manifest file (or backup file) not found.'
+            warn msg
+            fail Capistrano::FileNotFound, msg
+          end
+        end
+      end
+    end
+
+    def detect_manifest_path
+      %w(
+        .sprockets-manifest*
+        manifest*.*
+      ).each do |pattern|
+        candidate = release_path.join('public', fetch(:assets_prefix), pattern)
+        return capture(:ls, candidate).strip.gsub(/(\r|\n)/,' ') if test(:ls, candidate)
+      end
+      msg = 'Rails assets manifest file not found.'
+      warn msg
+      fail Capistrano::FileNotFound, msg
+    end
+  end
+end
+
+# we can't set linked_dirs in load:defaults,
+# as assets_prefix will always have a default value
+namespace :deploy do
+  task :set_linked_dirs do
+    linked_dirs = fetch(:linked_dirs, [])
+    unless linked_dirs.include?('public')
+      linked_dirs << "public/#{fetch(:assets_prefix)}"
+      set :linked_dirs, linked_dirs.uniq
+    end
+  end
+end
+
+after 'deploy:set_rails_env', 'deploy:set_linked_dirs'
+
+namespace :load do
+  task :defaults do
+    set :assets_roles, fetch(:assets_roles, [:web])
+    set :assets_prefix, fetch(:assets_prefix, 'assets')
+  end
+end

data/lib/capistrano/tasks/migrations.rake

@@ -0,0 +1,40 @@
+load File.expand_path("../set_rails_env.rake", __FILE__)
+
+namespace :deploy do
+
+  desc 'Runs rake db:migrate if migrations are set'
+  task :migrate => [:set_rails_env] do
+    on fetch(:migration_servers) do
+      conditionally_migrate = fetch(:conditionally_migrate)
+      info '[deploy:migrate] Checking changes in db' if conditionally_migrate
+      if conditionally_migrate && test(:diff, "-qr #{release_path}/db #{current_path}/db")
+        info '[deploy:migrate] Skip `deploy:migrate` (nothing changed in db)'
+      else
+        info '[deploy:migrate] Run `rake db:migrate`'
+        # NOTE: We access instance variable since the accessor was only added recently. Once capistrano-rails depends on rake 11+, we can revert the following line
+        invoke :'deploy:migrating' unless Rake::Task[:'deploy:migrating'].instance_variable_get(:@already_invoked)
+      end
+    end
+  end
+
+  desc 'Runs rake db:migrate'
+  task migrating: [:set_rails_env] do
+    on fetch(:migration_servers) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :rake, 'db:migrate'
+        end
+      end
+    end
+  end
+
+  after 'deploy:updated', 'deploy:migrate'
+end
+
+namespace :load do
+  task :defaults do
+    set :conditionally_migrate, fetch(:conditionally_migrate, false)
+    set :migration_role, fetch(:migration_role, :db)
+    set :migration_servers, -> { primary(fetch(:migration_role)) }
+  end
+end

data/lib/capistrano/tasks/set_rails_env.rake

@@ -0,0 +1,9 @@
+namespace :deploy do
+  task :set_rails_env do
+    set :rails_env, (fetch(:rails_env) || fetch(:stage))
+  end
+end
+
+Capistrano::DSL.stages.each do |stage|
+  after stage, 'deploy:set_rails_env'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-rails
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Tom Clements
+- Lee Hambley
+- Kir Shatrov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-09 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: capistrano-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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'
+description: Rails specific Capistrano tasks
+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.txt
+- README.md
+- Rakefile
+- capistrano-rails.gemspec
+- lib/capistrano-rails.rb
+- lib/capistrano/rails.rb
+- lib/capistrano/rails/assets.rb
+- lib/capistrano/rails/migrations.rb
+- lib/capistrano/tasks/assets.rake
+- lib/capistrano/tasks/migrations.rake
+- lib/capistrano/tasks/set_rails_env.rake
+homepage: https://github.com/capistrano/rails
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Rails specific Capistrano tasks
+test_files: []