capistrano-net_storage 0.5.0 → 1.0.0

data/lib/capistrano/tasks/net_storage.rake

@@ -1,148 +1,58 @@
-unless defined?(Capistrano::NetStorage::TASK_LOADED) # prevent multiple loads
-Capistrano::NetStorage::TASK_LOADED = true
-
+# SEE: https://github.com/capistrano/capistrano/blob/31e142d56f8d894f28404fb225dcdbe7539bda18/lib/capistrano/scm/tasks/git.rake
 namespace :net_storage do
-  # Tasks called by deploy.rake bundled in capistrano core:
-  #  - :check
-  #  - :create_release
-  #  - :set_current_revision
-  desc %(Check all components' statuses)
-  check_dependencies = %w(archiver transport bundler scm directories).map do |t|
-    "net_storage:check:#{t}".to_sym
-  end
-  task check: check_dependencies
+  desc 'Check prerequisites and prepare directories'
+  task :check do
+    Capistrano::NetStorage.transport.check
+    Capistrano::NetStorage.archiver.check
+    Capistrano::NetStorage.scm.check
+    Capistrano::NetStorage.bundler.check
+    Capistrano::NetStorage.cleaner.check
+    Capistrano::NetStorage.config_uploader.check
 
-  desc 'Create and deploy archives via remove storage'
-  task create_release: :'net_storage:check' do
     config = Capistrano::NetStorage.config
-    skip_upload = false
-    if config.archive_on_missing?
-      invoke 'net_storage:transport:find_uploaded'
-      if fetch(:net_storage_uploaded_archive)
-        skip_upload = true
-      end
-    end
-    unless skip_upload
-      invoke 'net_storage:upload_archive'
+    run_locally do
+      execute(:mkdir, '-p',
+        config.local_base_path,
+        config.local_mirror_path,
+        config.local_releases_path,
+        config.local_archives_path,
+      )
     end
-    invoke 'net_storage:pull_deploy'
   end
 
-  desc 'Set the revision to be deployed'
-  task set_current_revision: :'net_storage:scm:update' do
-    Capistrano::NetStorage.scm.set_current_revision
+  task :prepare_mirror_repository do
+    Capistrano::NetStorage.scm.clone
+    Capistrano::NetStorage.scm.update
+    Capistrano::NetStorage.scm.set_current_revision # :current_revision is set here, not in net_storage:set_current_revision
   end
 
-  # Additional tasks for capistrano-net_storage
-
-  desc 'Deploy config files'
-  task :sync_config do
-    config = Capistrano::NetStorage.config
-    Capistrano::NetStorage.scm.sync_config
-    Capistrano::NetStorage.bundler.sync_config unless config.skip_bundle?
-  end
-  after 'net_storage:create_release', 'net_storage:sync_config'
-
-  desc 'Clean up old release directories on local'
-  task :cleanup_local_releases do
-    Capistrano::NetStorage.cleaner.cleanup_local_releases
-  end
-  after 'deploy:cleanup', 'net_storage:cleanup_local_releases'
-
-  desc 'Clean up old archive files on remote storage'
-  task :cleanup_archives_on_remote_storage do
-    transport = Capistrano::NetStorage.transport
-    next unless transport.respond_to?(:cleanup)
-    transport.cleanup
-  end
-  after 'deploy:cleanup', 'net_storage:cleanup_archives_on_remote_storage'
-
-  desc 'Clean up old archive files on remote servers'
-  task :cleanup_archives do
-    Capistrano::NetStorage.cleaner.cleanup_archives
-  end
-  after 'deploy:cleanup', 'net_storage:cleanup_archives'
-
-  desc 'Clean up old archive files on local'
-  task :cleanup_local_archives do
-    Capistrano::NetStorage.cleaner.cleanup_local_archives
-  end
-  after 'deploy:cleanup', 'net_storage:cleanup_local_archives'
-
-  task prepare_archive: %i(net_storage:scm:update net_storage:check:bundler) do
-    config = Capistrano::NetStorage.config
+  desc 'Prepare archive (You can hook your own preparation after this)'
+  task :prepare_archive do
     Capistrano::NetStorage.scm.prepare_archive
-    Capistrano::NetStorage.bundler.install unless config.skip_bundle?
+    Capistrano::NetStorage.bundler.install
   end
 
-  desc 'Create archive to release on local'
-  task create_archive: :'net_storage:prepare_archive' do
-    Capistrano::NetStorage.archiver.archive
-  end
+  desc 'Create and deploy archives via remove storage'
+  task create_release: :'net_storage:prepare_mirror_repository' do
+    config = Capistrano::NetStorage.config
 
-  desc 'Upload archive onto remote storage'
-  task upload_archive: :'net_storage:create_archive' do
-    Capistrano::NetStorage.transport.upload
-  end
+    if !config.reuse_archive? || !Capistrano::NetStorage.transport.archive_exists?
+      invoke 'net_storage:prepare_archive'
+      Capistrano::NetStorage.archiver.archive
+      Capistrano::NetStorage.transport.upload
+    end
 
-  desc 'Deploy via remote storage using uploaded archive'
-  task pull_deploy: :'net_storage:transport:find_uploaded' do
     Capistrano::NetStorage.transport.download
     Capistrano::NetStorage.archiver.extract
-  end
-
-  namespace :check do
-    task :archiver do
-      Capistrano::NetStorage.archiver.check
-    end
-
-    task :transport do
-      Capistrano::NetStorage.transport.check
-    end
-
-    task :bundler do
-      config = Capistrano::NetStorage.config
-      Capistrano::NetStorage.bundler.check unless config.skip_bundle?
-    end
 
-    task :scm do
-      Capistrano::NetStorage.scm.check
-    end
-
-    task :directories do
-      config = Capistrano::NetStorage.config
-      dirs = [
-        config.local_base_path,
-        config.local_mirror_path,
-        config.local_releases_path,
-        config.local_archives_path,
-      ]
-      dirs << config.local_bundle_path unless config.skip_bundle?
-      run_locally do
-        dirs.each { |dir| execute :mkdir, '-p', dir }
-      end
-    end
+    Capistrano::NetStorage.config_uploader.upload_config_files
   end
 
-  namespace :scm do
-    task clone: %i(net_storage:check:scm net_storage:check:directories) do
-      Capistrano::NetStorage.scm.clone
-    end
-
-    task update: :'net_storage:scm:clone' do
-      Capistrano::NetStorage.scm.update
-    end
-
-    task set_current_revision: :'net_storage:scm:update' do
-      Capistrano::NetStorage.scm.set_current_revision
-    end
-  end
-
-  namespace :transport do
-    task find_uploaded: :'net_storage:scm:set_current_revision' do
-      Capistrano::NetStorage.transport.find_uploaded
-    end
+  desc 'Clean up old release directories on local'
+  task :cleanup do
+    Capistrano::NetStorage.cleaner.cleanup_local_releases
+    Capistrano::NetStorage.cleaner.cleanup_local_archives
+    Capistrano::NetStorage.cleaner.cleanup_archives
+    Capistrano::NetStorage.transport.cleanup
   end
 end
-
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-net_storage
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - progrhyme
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-17 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.3
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.3
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -88,10 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -100,21 +98,18 @@ files:
 - capistrano-net_storage.gemspec
 - lib/capistrano-net_storage.rb
 - lib/capistrano/net_storage.rb
-- lib/capistrano/net_storage/all.rb
 - lib/capistrano/net_storage/archiver/base.rb
 - lib/capistrano/net_storage/archiver/tar_gzip.rb
 - lib/capistrano/net_storage/archiver/zip.rb
-- lib/capistrano/net_storage/base.rb
-- lib/capistrano/net_storage/bundler.rb
+- lib/capistrano/net_storage/bundler/default.rb
+- lib/capistrano/net_storage/bundler/null.rb
 - lib/capistrano/net_storage/cleaner.rb
 - lib/capistrano/net_storage/config.rb
-- lib/capistrano/net_storage/coordinator.rb
-- lib/capistrano/net_storage/error.rb
+- lib/capistrano/net_storage/config_uploader.rb
 - lib/capistrano/net_storage/plugin.rb
 - lib/capistrano/net_storage/scm/base.rb
 - lib/capistrano/net_storage/scm/git.rb
 - lib/capistrano/net_storage/transport/base.rb
-- lib/capistrano/net_storage/utils.rb
 - lib/capistrano/net_storage/version.rb
 - lib/capistrano/tasks/net_storage.rake
 homepage: https://github.com/DeNADev/capistrano-net_storage
@@ -129,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +0,0 @@
-### Summary
-
-### Other Information
-
-### Checklist
-
-* [ ] By placing an "x" in the box, I hereby understand, accept and agree to be bound by the terms and conditions of the [Contribution License Agreement](https://dena.github.io/cla/).

data/.travis.yml

@@ -1,13 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-- 2.6.3
-- 2.5.5
-- 2.4.6
-
-before_install: gem install bundler
-install: bundle install
-script: bundle exec rake spec
-notifications:
-  slack:
-    secure: lJCLJetpFwFujt467h250JgTyjF+7qU04Ef6FdwOBZwvjgYmyyZMBhdbL2JOAxrQd6XCWhZy56jCXr4ZdMbMLtzL+wEkQefiOLdpV/556xXK5qmkjLyRWoYOMFEhxSTqjk8hHZVYcLO6IYmwr9CHBWaVGOydADCkR4CYyqmSHtKIbznSs9Y4qrpsf6YC9QiSxoP7d5hayvnVUI8oFvxC8DfPuwrmWoO4WyVTJy2ODg/r/ZNGJCMzW3pvnXGK5oZqgwArlGIV7l3tOX2l24QilkhxhuX7QRCikYoGiIdXqkXdf1S/piaflFGXJ1C2PN5aWEv1/8EYcm7RgPm8I9Pol+7zkpUFUiSj3FDLc/TZZKP7OwPCpXOXZkDTLn0+96H5oWUR+2xwTwETQpW8Qz6ZMiu4EKAiAeU99YgSZOgc3fmonvsQREFwTV1n9AHPFsTHv8f3bzC8gUm3n7PIZX4/vR7Aa+vTVZ1QGW9T7OuWThdCMVVB7L7Q/5pRaE+gFLsN9MQBfbZ5uOOXYHd+yh9rC5qi/wRXPxQ4w1F8R+iKIhF32nUF96jwwCkd7O/LZKlmFRT43App6sfmQIAdPp7Oy/BZZD34u0k5aOciZ59h10+BHmA1E0kphXfbYcbXd53MUCEiYc4HC2xtC5yT+ko+PQ2T37VkkneZIIhjRf+WzXQ=

data/lib/capistrano/net_storage/all.rb

@@ -1,20 +0,0 @@
-require 'capistrano/net_storage/base'
-require 'capistrano/net_storage/error'
-require 'capistrano/net_storage/config'
-require 'capistrano/net_storage/coordinator'
-require 'capistrano/net_storage/utils'
-require 'capistrano/net_storage/bundler'
-require 'capistrano/net_storage/cleaner'
-require 'capistrano/net_storage/archiver/zip'
-require 'capistrano/net_storage/archiver/tar_gzip'
-require 'capistrano/net_storage/scm/git'
-require 'capistrano/net_storage/version'
-
-# See capistrano/net_storage/base.rb
-Capistrano::NetStorage.setup! do
-  config = Capistrano::NetStorage::Config.new
-  {
-    config: config,
-    coordinator: Capistrano::NetStorage::Coordinator.new(config),
-  }
-end

data/lib/capistrano/net_storage/base.rb

@@ -1,18 +0,0 @@
-require 'forwardable'
-
-module Capistrano
-  module NetStorage
-    class << self
-      attr_reader :config, :coordinator
-
-      extend Forwardable
-      def_delegators :coordinator, :archiver, :scm, :cleaner, :bundler, :transport
-    end
-
-    def self.setup!(params = nil)
-      params       ||= yield
-      @config        = params[:config]
-      @coordinator   = params[:coordinator]
-    end
-  end
-end

data/lib/capistrano/net_storage/bundler.rb

@@ -1,70 +0,0 @@
-require 'bundler'
-require 'capistrano/net_storage/utils'
-
-module Capistrano
-  module NetStorage
-    class Bundler
-      include Capistrano::NetStorage::Utils
-
-      def check
-        run_locally do
-          execute :which, 'bundle'
-        end
-      end
-
-      # Do bundle install locally. Installed gems are to be included to the release.
-      def install
-        c = config
-        run_locally do
-          local_release_bundle_path = c.local_release_path.join('vendor', 'bundle')
-          execute :mkdir, '-p', local_release_bundle_path
-          execute :mkdir, '-p', "#{c.local_release_path}/.bundle"
-          # Copy shared gems to release bundle path beforehand to reuse installed previously
-          execute :rsync, '-a', "#{c.local_bundle_path}/", "#{local_release_bundle_path}/"
-
-          within c.local_release_path do
-            ::Bundler.with_clean_env do
-              install_options = %W(
-                --gemfile #{c.local_release_path}/Gemfile --deployment --quiet
-                --path #{local_release_bundle_path} --without development test
-              )
-              execute :bundle, 'install', *install_options
-              execute :bundle, 'clean'
-              # Sync installed gems to shared directory to reuse them next time
-              rsync_options = %W(-a --delete #{local_release_bundle_path}/ #{c.local_bundle_path}/)
-              execute :rsync, *rsync_options
-            end
-          end
-        end
-      end
-
-      # Create +.bundle/config+ at release path on remote servers
-      def sync_config
-        c = config
-
-        on c.servers, in: :groups, limit: c.max_parallels do
-          within release_path do
-            execute :mkdir, '-p', '.bundle'
-          end
-        end
-
-        run_locally do
-          execute :mkdir, '-p', "#{c.local_base_path}/.bundle"
-        end
-        bundle_config_path = "#{c.local_base_path}/.bundle/config"
-        File.open(bundle_config_path, 'w') do |file|
-          file.print(<<-EOS)
----
-BUNDLE_FROZEN: "1"
-BUNDLE_PATH: "#{release_path.join('vendor', 'bundle')}"
-BUNDLE_WITHOUT: "development:test"
-BUNDLE_DISABLE_SHARED_GEMS: "true"
-BUNDLE_BIN: "#{release_path.join('bin')}"
-EOS
-        end
-
-        upload_files([bundle_config_path], release_path.join('.bundle'))
-      end
-    end
-  end
-end

data/lib/capistrano/net_storage/coordinator.rb

@@ -1,38 +0,0 @@
-module Capistrano
-  module NetStorage
-    class Coordinator
-      attr_reader :config
-
-      def initialize(config)
-        @config = config
-      end
-
-      def archiver
-        load_executor(:archiver)
-      end
-
-      def transport
-        load_executor(:transport)
-      end
-
-      def cleaner
-        load_executor(:cleaner)
-      end
-
-      def bundler
-        load_executor(:bundler)
-      end
-
-      def scm
-        load_executor(:scm)
-      end
-
-      private
-
-      def load_executor(type)
-        @executors ||= {}
-        @executors[type] ||= config.executor_class(type).new
-      end
-    end
-  end
-end

data/lib/capistrano/net_storage/error.rb

@@ -1,6 +0,0 @@
-module Capistrano
-  module NetStorage
-    class Error < StandardError
-    end
-  end
-end

data/lib/capistrano/net_storage/utils.rb

@@ -1,62 +0,0 @@
-require 'capistrano/net_storage/base'
-
-module Capistrano
-  module NetStorage
-    # Common utility methods
-    module Utils
-      private
-
-      # @see lib/capistrano/net_storage/base.rb
-      def config
-        Capistrano::NetStorage.config
-      end
-
-      # @param dest_dir [String, Pathname] Destination directory on remote to copy local files into
-      def upload_files(files, dest_dir)
-        c = config
-        hosts = ::Capistrano::Configuration.env.filter(c.servers)
-
-        # FIXME: This is a very workaround to architectural issue. Do not copy.
-        build_rsh_option = -> (host) {
-          build_ssh_command(host)
-        }
-
-        on hosts, in: :groups, limit: c.max_parallels do |host|
-          if c.upload_files_by_rsync?
-            rsh_option = build_rsh_option.call(host)
-            run_locally do
-              execute :rsync, "-az --rsh='#{rsh_option}' #{files.join(' ')} #{host.hostname}:#{dest_dir}"
-            end
-          else
-            files.each do |src|
-              upload! src, dest_dir
-            end
-          end
-        end
-      end
-
-      # Build ssh command with options for rsync
-      def build_ssh_command(host)
-        user_opt    = ''
-        key_opt     = ''
-        port_opt    = ''
-        ssh_options = config.rsync_options
-
-        if user = host.user || ssh_options[:user]
-          user_opt = " -l #{user}"
-        end
-
-        if keys = (host.keys.empty? ? ssh_options[:keys] : host.keys)
-          keys    = keys.is_a?(Array) ? keys : [keys]
-          key_opt = keys.map { |key| " -i #{key}" }.join('')
-        end
-
-        if port = host.port || ssh_options[:port]
-          port_opt = " -p #{port}"
-        end
-
-        "ssh#{user_opt}#{key_opt}#{port_opt}"
-      end
-    end
-  end
-end