capistrano-scm-local_git_upload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a183d852f5deb9279bb479403d129b5fa3c5d496a35717d002a9886d2f9dc721
+  data.tar.gz: cf3064d8ab73d3ebe516f7e4ac9df4b313e33512e71675be092d7ff3b7979cd7
+SHA512:
+  metadata.gz: d4c971ab1addca8f49adb79168b1682781791d2a5d61cca319fcd54756a940df0d96768af4136d08596083b63574c1460540348acc98f72e942f6a4fea915de1
+  data.tar.gz: f17b3448bc0fef5821706d1b109335bd5481e9a99bc76baa73d9fa1a0306cd85b08ceab776a5d6a42744bde74ebb61bbd9e2a1f05bc744c6f41c47642d00cac4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TODO: Write your name
+
+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,55 @@
+# Capistrano::Scm::LocalGitUpload
+
+Capistrano SCM Plugin for local git clone and upload.
+
+This plugin firstly clones the git repository to the local host
+and thereafter uploads files on the local host to the remote servers.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'capistrano-scm-local_git_upload'
+```
+And execute:
+```bash
+$ bundle install
+```
+
+Add to Capfile:
+```ruby
+require "capistrano/scm/local_git_upload"
+install_plugin Capistrano::SCM::LocalGitUpload
+```
+
+## Usage
+
+The git repository is cloned
+to `work_path` (default: `work`) on the local host
+before `deploy:started`.
+
+Then,
+files under `upload_path` (default: `upload`) on the local host
+are uploaded to `release_path` on the remote servers
+after `deploy:new_release_path`.
+
+Therefore, you need to prepare `upload_path` using `work_path` files
+until `deploy:new_release_path`.
+
+This is a simple copy example from `work/public` to `upload/public`.
+```ruby
+namespace :sample_app do
+  task :copy_to_upload do
+    run_locally do
+      execute :cp, '-pr', work_path.join('public'), upload_path
+    end
+  end
+  before 'deploy:new_release_path', 'sample_app:copy_to_upload'
+end
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/capistrano/scm/local_git_upload/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Scm
+    module LocalGitUpload
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/capistrano/scm/local_git_upload.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'capistrano/scm/plugin'
+require 'capistrano/scm/git'
+
+module Capistrano
+  module DSL
+    # DSL extension for LocalGitUpload
+    module LocalGitUpload
+      def work_path
+        Pathname.new fetch(:work_path)
+      end
+
+      def upload_path
+        Pathname.new fetch(:upload_path)
+      end
+    end
+  end
+end
+extend Capistrano::DSL::LocalGitUpload    # rubocop:disable Style/MixinUsage
+include Capistrano::DSL::LocalGitUpload   # rubocop:disable Style/MixinUsage
+
+module Capistrano
+  class SCM
+    # Capistrano SCM plugin for local git clone followed by upload
+    class LocalGitUpload < ::Capistrano::SCM::Plugin
+      def initialize
+        super
+        @git_plugin = Capistrano::SCM::Git.new
+      end
+
+      def set_defaults
+        @git_plugin.set_defaults
+        set_if_empty :local_top, Dir.getwd
+        set_if_empty :repo_path, local_path('repo')
+        set_if_empty :work_path, local_path('work')
+        set_if_empty :upload_path, local_path('upload')
+      end
+
+      def define_tasks
+        eval_rakefile File.expand_path('tasks/git_local.rake', __dir__)
+        eval_rakefile File.expand_path('tasks/upload.rake', __dir__)
+      end
+
+      def register_hooks
+        before 'deploy:check', 'upload:check_directory'
+        before 'deploy:started', 'git_local:create_work'
+        after 'deploy:new_release_path', 'upload:create_release'
+        before 'deploy:set_current_revision', 'git_local:set_current_revision'
+        after 'deploy:finishing', 'git_local:remove_directory'
+        after 'deploy:finishing', 'upload:remove_directory'
+      end
+
+      private
+
+      def local_path(path)
+        Pathname.new(fetch(:local_top)).join(path).to_s
+      end
+    end
+  end
+end

data/lib/capistrano/scm/tasks/git_local.rake

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+git_plugin = @git_plugin
+
+namespace :git_local do
+  desc 'Clone the repo to the local cache'
+  task :clone do
+    run_locally do
+      execute :mkdir, '-p', repo_path
+      if git_plugin.repo_mirror_exists?
+        info t(:mirror_exists, at: repo_path)
+      else
+        with fetch(:git_environmental_variables) do
+          git_plugin.clone_repo
+        end
+      end
+    end
+  end
+
+  desc 'Update the local repo mirror to reflect the origin state'
+  task update: :clone do
+    run_locally do
+      within repo_path do
+        with fetch(:git_environmental_variables) do
+          git_plugin.update_mirror
+          git_plugin.verify_commit if fetch(:git_verify_commit)
+        end
+      end
+    end
+  end
+
+  desc 'Copy repo to the working directory'
+  task create_work: :update do
+    run_locally do
+      with fetch(:git_environmental_variables) do
+        set :release_path, work_path
+        within repo_path do
+          execute :mkdir, '-p', release_path
+          git_plugin.archive_to_release_path
+        end
+      end
+    end
+  end
+
+  desc 'Determine the revision that will be deployed'
+  task :set_current_revision do
+    run_locally do
+      within repo_path do
+        with fetch(:git_environmental_variables) do
+          set :current_revision, git_plugin.fetch_revision
+        end
+      end
+    end
+  end
+
+  desc 'Remove the working directory'
+  task :remove_directory do
+    run_locally do
+      execute :rm, '-rf', work_path
+    end
+  end
+end

data/lib/capistrano/scm/tasks/upload.rake

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+namespace :upload do
+  desc 'Check the local upload directory'
+  task :check_directory do
+    run_locally do
+      execute :mkdir, '-p', upload_path
+    end
+  end
+
+  desc 'Upload the local upload directory recursively'
+  task :create_release do
+    on release_roles :all do
+      upload! upload_path.to_s, release_path, recursive: true
+    end
+  end
+
+  desc 'Remove the local upload directory'
+  task :remove_directory do
+    run_locally do
+      execute :rm, '-rf', upload_path
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-scm-local_git_upload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SHIMAYOSHI, Takao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-16 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'
+description: Capistrano SCM plugin for local git clone and upload.
+email:
+- simayosi@cc.kyushu-u.ac.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/capistrano/scm/local_git_upload.rb
+- lib/capistrano/scm/local_git_upload/version.rb
+- lib/capistrano/scm/tasks/git_local.rake
+- lib/capistrano/scm/tasks/upload.rake
+homepage: https://github.com/simayosi/capistrano-scm-local_git_upload
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/simayosi/capistrano-scm-local_git_upload
+  source_code_uri: https://github.com/simayosi/capistrano-scm-local_git_upload
+  documentation_uri: https://github.com/simayosi/capistrano-scm-local_git_upload
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Capistrano::SCM::LocalGitUpload
+test_files: []