capistrano-precompile-chooser 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d855d31f6a7e049a5d25c9db936bb4da6174c294790c7b534dbf4273436f8a3
+  data.tar.gz: 638620eca7b11bbfbf47a3caa164d1f7e70934f2e63e1b7253153c6fdbdecfa0
+SHA512:
+  metadata.gz: 772370091f9a5ee1d7c0ffb656900673b557a3370cc30af9bbd977e3cf1e9602f9c09afe812517d79cd420fc43ab1ccfd066ff44a2901531241ac64c0501fca7
+  data.tar.gz: 0d3cbe1349b8024eaf349ff2e234c0df1ebf459429bf26934817deae05492f5665e640df654f9f61eca0472b362c40238136b819cc68674e2fd4a2024378afb5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+CHANGELOG
+---------
+
+- **0.9.0** - August 19, 2020
+  - Gem Initial Release

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2020 Weston Ganger
+
+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,98 @@
+# Capistrano Precompile Chooser
+
+<a href="https://badge.fury.io/rb/capistrano-precompile-chooser" target="_blank"><img height="21" style='border:0px;height:21px;' border='0' src="https://badge.fury.io/rb/capistrano-precompile-chooser.svg" alt="Gem Version"></a>
+<a href='https://travis-ci.org/westonganger/capistrano-precompile-chooser' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://travis-ci.org/westonganger/capistrano-precompile-chooser.svg?branch=master' border='0' alt='Build Status'></a>
+<a href='https://rubygems.org/gems/capistrano-precompile-chooser' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://ruby-gem-downloads-badge.herokuapp.com/capistrano-precompile-chooser?label=rubygems&type=total&total_label=downloads&color=brightgreen' border='0' alt='RubyGems Downloads' /></a>
+<a href='https://ko-fi.com/A5071NK' target='_blank'><img height='22' style='border:0px;height:22px;' src='https://az743702.vo.msecnd.net/cdn/kofi1.png?v=a' border='0' alt='Buy Me a Coffee'></a>
+
+Capistrano plugin to precompile your Rails assets locally, remotely, or not at all provided with a very convenient default terminal prompt.
+
+By Default, on every deploy this plugin will prompt you on whether you want to precompile your assets locally, remotely, or not at all. Alternatively you can set some variable for fully automated deploys.
+
+```
+$ cap production deploy
+
+How do you want to compile assets? (local/remote/skip)
+skip
+```
+
+## Precompile Modes
+
+- `local` - Local Precompilation Mode (Improves Memory/Load Spikes on Server during Deploys)
+- `remote` - Remote Precompilation Mode (Rails Default)
+- `skip` - No Precompilation (Speeds up deployments with unchanged assets)
+
+## Installation
+
+```ruby
+# Gemfile
+
+group :development do
+  gem "capistrano-precompile-chooser"
+end
+```
+
+```ruby
+# Capfile
+
+# require 'capistrano/rails' ### Comment Out or Remove this line
+require 'capistrano/precompile_chooser'
+```
+
+If you want to be able to safely use the `skip` option you must add `public/assets` to your capistrano `:shared_dirs` variable
+
+```ruby
+# config/deploy.rb
+
+set :linked_dirs, %w{ <other-dirs> public/assets }
+```
+
+## Usage
+
+Now when running a deployment:
+
+```
+$ cap production deploy
+
+How do you want to compile assets? (local/remote/skip)
+skip
+```
+
+You can also use the `$PRECOMPILE` environment variable
+
+```bash
+$ PRECOMPILE_MODE="local" cap production deploy
+```
+
+You can also set the capistrano `:precompile` variable for fully automated deploys
+
+```ruby
+# config/deploy.rb
+
+set :precompile_mode, "local"
+```
+
+## Configuration Options, 
+```ruby
+set :assets_dir,   "public/assets"
+set :packs_dir,    "public/packs"
+set :rsync_cmd,    "rsync -av --delete"
+set :assets_role,  "web"
+```
+
+## Task Ordering, and Task Details
+
+<a href="https://github.com/westonganger/capistrano-precompile-chooser/blob/master/lib/capistrano/precompile_chooser.rb">See Source</a>
+
+# TODO
+
+- Add Tests
+- Optional Precompilation Based on Diff - **PR WANTED**
+
+# Credits
+
+Created & Maintained by [Weston Ganger](https://westonganger.com) - [@westonganger](https://github.com/westonganger)
+
+For any consulting or contract work please contact me via my company website: [Solid Foundation Web Development](https://solidfoundationwebdev.com)
+
+[![Solid Foundation Web Development Logo](https://solidfoundationwebdev.com/logo-sm.png)](https://solidfoundationwebdev.com)

data/Rakefile

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/lib/capistrano/precompile_chooser/version')
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+
+task :console do
+  require 'capistrano'
+  require 'capistrano/precompile_chooser'
+
+  require 'irb'
+  binding.irb
+end

data/lib/capistrano/precompile_chooser.rb

@@ -0,0 +1,22 @@
+val = nil
+
+opts = ['local','remote','skip']
+
+until val && opts.include?(val)
+  puts
+  puts "How do you want to compile assets? (#{opts.join('/')})"
+  val = STDIN.gets.strip.downcase
+end
+
+puts
+
+case val
+when "local"
+  #import 'config/deploy/local_precompile.cap'
+  #import File.expand_path("../tasks/local_precompile.cap")
+  load File.expand_path("../tasks/local_precompile.cap")
+when "remote"
+  require 'capistrano/rails/assets' ### Disable for local precompile
+else
+  # Do nothing
+end

data/lib/capistrano/precompile_chooser/local_precompile.cap

@@ -0,0 +1,49 @@
+set :assets_dir,       "public/assets"
+set :packs_dir,        "public/packs"
+set :rsync_cmd,        "rsync -av --delete"
+set :assets_role,      "web"
+
+namespace :deploy do
+  namespace :assets do
+    desc "Remove all local precompiled assets"
+    task :cleanup do
+      run_locally do
+        execute "rm", "-rf", fetch(:assets_dir)
+        execute "rm", "-rf", fetch(:packs_dir)
+      end
+    end
+
+    desc "Actually precompile the assets locally"
+    task :prepare do
+      run_locally do
+        execute "RAILS_ENV=#{fetch(:rails_env)} bundle exec rake assets:clean"
+        execute "RAILS_ENV=#{fetch(:rails_env)} bundle exec rake assets:precompile"
+      end
+    end
+
+    desc "Performs rsync to app servers"
+    task :rsync do
+      on roles(fetch(:assets_role)), in: :parallel do |server|
+        run_locally do
+          remote_shell = %(-e "ssh -p #{server.port}") if server.port
+
+          commands = []
+          commands << "#{fetch(:rsync_cmd)} #{remote_shell} ./#{fetch(:assets_dir)}/ #{server.user}@#{server.hostname}:#{release_path}/#{fetch(:assets_dir)}/" if Dir.exists?(fetch(:assets_dir))
+          commands << "#{fetch(:rsync_cmd)} #{remote_shell} ./#{fetch(:packs_dir)}/ #{server.user}@#{server.hostname}:#{release_path}/#{fetch(:packs_dir)}/" if Dir.exists?(fetch(:packs_dir))
+
+          commands.each do |command| 
+            if dry_run?
+              SSHKit.config.output.info command
+            else
+              execute command
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+after "bundler:install", "deploy:assets:prepare"
+after "deploy:assets:prepare", "deploy:assets:rsync"
+after "deploy:assets:rsync", "deploy:assets:cleanup"

data/lib/capistrano/precompile_chooser/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module PrecompileChooser
+    VERSION = "0.9.0"
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+# TODO
+
+describe Capistrano::PrecompileChooser, "configuration" do
+  before do
+    @configuration = Capistrano::Configuration.new
+    @configuration.load do
+      def rails_env; 'production'; end
+      def rake; 'rake'; end
+      def asset_env; "RAILS_GROUPS=assets"; end
+    end
+    Capistrano::PrecompileChooser.load_into(@configuration)
+  end
+
+  it "defines precompile_env" do
+    expect(@configuration.fetch(:precompile_env)).to eq('production')
+  end
+
+  it "defines precompile_cmd" do
+    cmd = 'RAILS_ENV=production RAILS_GROUPS=assets rake assets:precompile'
+    expect(@configuration.fetch(:precompile_cmd)).to eq(cmd)
+  end
+
+  it "defines cleanexpired_cmd" do
+    cmd = 'RAILS_ENV=production RAILS_GROUPS=assets rake assets:clean_expired'
+    expect(@configuration.fetch(:cleanexpired_cmd)).to eq(cmd)
+  end
+
+  it "defines assets_dir" do
+    expect(@configuration.fetch(:assets_dir)).to eq('public/assets')
+  end
+
+  it "defines rsync_cmd" do
+    expect(@configuration.fetch(:rsync_cmd)).to eq('rsync -av --delete')
+  end
+
+  it "performs deploy:assets:prepare before deploy:assets:precompile" do
+    expect(@configuration).to callback('deploy:assets:prepare').
+      before('deploy:assets:precompile')
+  end
+
+  it "performs deploy:assets:remove before deploy:assets:precompile" do
+    expect(@configuration).to callback('deploy:assets:remove').
+                                  before('deploy:assets:symlink')
+  end
+
+  it "performs deploy:assets:cleanup after deploy:assets:precompile" do
+    expect(@configuration).to callback('deploy:assets:cleanup').
+      after('deploy:assets:precompile')
+  end
+
+  it "performs deploy:assets:remove_manifest before deploy:assets:symlink" do
+    expect(@configuration).to callback('deploy:assets:remove_manifest').
+                                  before('deploy:assets:symlink')
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,68 @@
+# TODO
+
+describe Capistrano::PrecompileChooser, "integration" do
+  before do
+    @configuration = Capistrano::Configuration.new
+    @configuration.load do
+      def rails_env; 'production'; end
+      def rake; 'rake'; end
+      def asset_env; "RAILS_GROUPS=assets"; end
+    end
+    Capistrano::PrecompileChooser.load_into(@configuration)
+  end
+
+  describe 'cleanup task' do
+    it 'removes the asset files from public/assets' do
+      expect(@configuration).to receive(:run_locally).
+        with('rm -rf public/assets')
+
+      @configuration.find_and_execute_task('deploy:assets:cleanup')
+    end
+  end
+
+  describe 'prepare task' do
+    it 'invokes the precompile command' do
+      expect(@configuration).to receive(:run_locally).
+        with('RAILS_ENV=production RAILS_GROUPS=assets rake assets:precompile').once
+
+      @configuration.find_and_execute_task('deploy:assets:prepare')
+    end
+  end
+
+  describe 'remove manifest task' do
+    it 'invokes the precompile command' do
+      allow(@configuration).to receive(:shared_path).and_return('/tmp/shared')
+      allow(@configuration).to receive(:shared_assets_prefix).and_return('assets')
+
+      expect(@configuration).to receive(:run).
+        with('rm -f /tmp/shared/assets/manifest*').once
+
+      @configuration.find_and_execute_task('deploy:assets:remove_manifest')
+    end
+  end
+
+  describe 'precompile task' do
+    let(:servers) { %w(10.0.1.1 10.0.1.2) }
+
+    before do
+      allow(@configuration).to receive(:run_locally).
+        with("ls public/assets/manifest*").and_return("public/assets/manifest.yml").once
+      allow(@configuration).to receive(:run_locally).
+        with('RAILS_ENV=production RAILS_GROUPS=assets rake assets:precompile').once
+      allow(@configuration).to receive(:run_locally).
+        with('rm -rf public/assets').once
+
+
+      allow(@configuration).to receive(:user).and_return('root')
+      allow(@configuration).to receive(:assets_role).and_return('app')
+      allow(@configuration).to receive(:find_servers).and_return(servers)
+      allow(@configuration).to receive(:release_path).and_return('/tmp')
+    end
+
+    it 'rsyncs the local asset files to the server' do
+      expect(@configuration).to receive(:run_locally).with(/rsync -av/).exactly(4).times
+
+      @configuration.find_and_execute_task('deploy:assets:precompile')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'capistrano-spec'
+require "capistrano/precompile_chooser"
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) do |c|
+    c.syntax = [:should, :expect]
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-precompile-chooser
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Weston Ganger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-20 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: 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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec
+  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: capistrano-spec
+  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: Capistrano plugin to precompile your Rails assets locally, remotely,
+  or not at all provided with a very convenient default terminal prompt.
+email: weston@westonganger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/capistrano/precompile_chooser.rb
+- lib/capistrano/precompile_chooser/local_precompile.cap
+- lib/capistrano/precompile_chooser/version.rb
+- lib/capistrano_precompile_chooser.rb
+- spec/configuration_spec.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/westonganger/capistrano-precompile-chooser
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Capistrano plugin to precompile your Rails assets locally, remotely, or not
+  at all provided with a very convenient default terminal prompt.
+test_files:
+- spec/integration_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb