capistrano-precompile-chooser 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d855d31f6a7e049a5d25c9db936bb4da6174c294790c7b534dbf4273436f8a3
-  data.tar.gz: 638620eca7b11bbfbf47a3caa164d1f7e70934f2e63e1b7253153c6fdbdecfa0
+  metadata.gz: be1933acbb7586aa59fe92a8ffe27dc748ccb800113ff45a236d299e9be246aa
+  data.tar.gz: 4f659770779050b4cafefd3e4cd63549d3d64f27f24b673363ee57de5c966f8e
 SHA512:
-  metadata.gz: 772370091f9a5ee1d7c0ffb656900673b557a3370cc30af9bbd977e3cf1e9602f9c09afe812517d79cd420fc43ab1ccfd066ff44a2901531241ac64c0501fca7
-  data.tar.gz: 0d3cbe1349b8024eaf349ff2e234c0df1ebf459429bf26934817deae05492f5665e640df654f9f61eca0472b362c40238136b819cc68674e2fd4a2024378afb5
+  metadata.gz: 18016eb1d4d5cd04b476b722118cef5dc14793ccf7e76035fa9d5ae0890e13b9c8a6d260c30ecf9dc3871d2fb85f655baabfda62463ca1d85ce3c578e5a3a4e8
+  data.tar.gz: c58aafd79591034e3a17f545c763b8c28450ffe81ca2ce66024a13dce6b993c330ef2619c5948f537ba417a1d5e18ad2a3d507c8e3c3e15e31df99875a0e8476

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 CHANGELOG
 ---------
 
+- Unreleased
+  * Nothing yet
+
+- **0.9.0** - August 19, 2020
+  * Refractor plugin into `Capistrano::Plugin` format
+
 - **0.9.0** - August 19, 2020
-  - Gem Initial Release
+  * Gem Initial Release

data/README.md

@@ -64,31 +64,25 @@ You can also use the `$PRECOMPILE` environment variable
 $ PRECOMPILE_MODE="local" cap production deploy
 ```
 
-You can also set the capistrano `:precompile` variable for fully automated deploys
+Or for fully automated deploys
 
 ```ruby
-# config/deploy.rb
+# Capfile
 
-set :precompile_mode, "local"
+ENV['PRECOMPILE_MODE'] = 'local'
+require 'capistrano/precompile_chooser'
 ```
 
 ## Configuration Options, 
+
 ```ruby
+### For Local Precompile Only
 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)

data/Rakefile

@@ -6,8 +6,9 @@ RSpec::Core::RakeTask.new(:spec)
 
 task test: :spec
 
+task default: :spec
+
 task :console do
-  require 'capistrano'
   require 'capistrano/precompile_chooser'
 
   require 'irb'

data/lib/capistrano/precompile_chooser.rb

@@ -1,22 +1,74 @@
-val = nil
+require "capistrano/plugin"
+require "capistrano/precompile_chooser/version"
 
-opts = ['local','remote','skip']
+module Capistrano
+  class PrecompileChooser < Capistrano::Plugin
 
-until val && opts.include?(val)
-  puts
-  puts "How do you want to compile assets? (#{opts.join('/')})"
-  val = STDIN.gets.strip.downcase
-end
+    # ### Currently using `namespace :load` in rake file instead
+    # def set_defaults
+    #   case precompile_mode
+    #   when "local"
+    #     # set_if_empty :foo, :bar
+    #   when "remote"
+    #     # Do nothing
+    #   else
+    #     # Do nothing
+    #   end
+    # end
+
+    def define_tasks
+      case precompile_mode
+      when "local"
+        eval_rakefile File.expand_path("../precompile_chooser/local_precompile.rake", __FILE__)
+      when "remote"
+        require 'capistrano/rails/assets' ### Disable for local precompile
+      else
+        # Do nothing
+      end
+    end
+
+    def register_hooks
+      case precompile_mode
+      when "local"
+        after "bundler:install", "deploy:assets:local_precompile:prepare"
+        after "deploy:assets:local_precompile:prepare", "deploy:assets:local_precompile:rsync"
+        after "deploy:assets:local_precompile:rsync", "deploy:assets:local_precompile:cleanup"
+      else
+        # Do nothing
+      end
+    end
+
+    def precompile_mode
+      @precompile_mode ||= begin
+        if ENV['PRECOMPILE_MODE']
+          if !valid_mode?(ENV['PRECOMPILE_MODE'])
+            raise "Invalid Precompile Mode"
+          end
+        else
+          val = nil
+
+          until valid_mode?(val)
+            puts
+            puts "How do you want to compile assets? (#{PRECOMPILE_MODES.join('/')})"
+            val = STDIN.gets.strip.downcase
+          end
+
+          puts
+        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
+        val
+      end
+    end
+
+    private
+
+    def valid_mode?(mode)
+      mode && PRECOMPILE_MODES.include?(mode)
+    end
+
+    PRECOMPILE_MODES = ['local','remote','skip'].freeze
+
+  end
 end
+
+install_plugin Capistrano::PrecompileChooser

data/lib/capistrano/precompile_chooser/local_precompile.rake

@@ -0,0 +1,53 @@
+namespace :load do
+  task :defaults do
+    set_if_empty :assets_dir,  "public/assets"
+    set_if_empty :packs_dir,   "public/packs"
+    set_if_empty :rsync_cmd,   "rsync -av --delete"
+    set_if_empty :assets_role, "web"
+  end
+end
+
+namespace :deploy do
+  namespace :assets do
+    namespace :local_precompile 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
+end

data/lib/capistrano/precompile_chooser/version.rb

@@ -1,5 +1,7 @@
+require "capistrano/plugin"
+
 module Capistrano
-  module PrecompileChooser
-    VERSION = "0.9.0"
+  class PrecompileChooser < Capistrano::Plugin
+    VERSION = "0.9.1"
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,13 @@
+require 'rake'
 require 'rspec'
-require 'capistrano-spec'
+require "capistrano/all"
 require "capistrano/precompile_chooser"
+require 'capistrano-spec'
 
 RSpec.configure do |config|
+  config.include Capistrano::Spec::Matchers
+  config.include Capistrano::Spec::Helpers
+
   config.expect_with(:rspec) do |c|
     c.syntax = [:should, :expect]
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-precompile-chooser
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Weston Ganger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -92,11 +92,9 @@ files:
 - README.md
 - Rakefile
 - lib/capistrano/precompile_chooser.rb
-- lib/capistrano/precompile_chooser/local_precompile.cap
+- lib/capistrano/precompile_chooser/local_precompile.rake
 - 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: []
@@ -122,6 +120,4 @@ 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

data/lib/capistrano/precompile_chooser/local_precompile.cap

@@ -1,49 +0,0 @@
-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/spec/configuration_spec.rb

@@ -1,57 +0,0 @@
-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

@@ -1,68 +0,0 @@
-# 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