capistrano-syncfiles 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14f3dd6c418570a81f704b80c94b67ae9d2657db
+  data.tar.gz: b52c8d0ba32469a41d38300f8350e92f7c9c026a
+SHA512:
+  metadata.gz: f5b4ae710b0e4483ad71c7fa9dde612d7b92529d98c5f82db5b246b7c48f3717d7c3262f5bf4c93f773a53a83d2856325c578a159131668242e1e30a197372fa
+  data.tar.gz: b6051c8550ea65b4ae978197a3b0a46e97abe54503ecb3c2dcb1bceaa63a5b5bd38a7f08b2b5ecf733efa567e8bc58d7a0ee88af0b4516889b5dfa0552d1a765

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 creative-workflow
+
+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,52 @@
+# capistrano-syncfiles
+
+This gem provides up and down file syncing with rsync or tar. This could be usefull if you are in a shared hosting environment.
+
+## Installation
+First make sure you install the capistrano-syncfiles by adding it to your `Gemfile`:
+
+    gem "capistrano-syncfiles"
+
+Add to Capfile
+
+    require 'capistrano/syncfiles'
+
+## Configuration (deploy.rb)
+Configure your files and folders like these:
+```
+set :syncfiles, {
+  'wordpress/wp-content/uploads' => {                     # local path
+      remote: 'wordpress/wp-content/uploads',             # remote path
+      exclude: ['fvm', 'ithemes-security', 'wc-logs']     # excluded files
+  }
+}
+
+set :syncfiles_roles, :all  # roles to run on, default: :all
+
+set :syncfiles_temp_file    # applies only to tar strategy, default: "/tmp/transfere-#{local_path.hash}.tar.gz"
+
+set :syncfiles_tar_verbose  # applies only to tar strategy, default: true
+```
+
+## Usage
+The following tasks will be added
+```
+cap syncfiles:rsync:down
+cap syncfiles:rsync:up
+cap syncfiles:tar:down
+cap syncfiles:tar:up    
+```
+
+You can invoke this tasks(Rake) as you do normally: https://github.com/ruby/rake
+
+Capistrano tasks: http://capistranorb.com/documentation/getting-started/flow/
+
+### License
+The MIT License (MIT)
+
+### Changelog
+
+0.1.0
+-----
+
+- Initial release

data/capistrano-syncfiles.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "capistrano-syncfiles"
+  s.version     = "0.1.0"
+  s.licenses    = ["MIT"]
+  s.authors     = ["Tom Hanoldt"]
+  s.email       = ["tom@creative-workflow.berlin"]
+  s.homepage    = "https://github.com/creative-workflow/capistrano-syncfiles"
+  s.summary     = %q{This gem provides up and down file syncing with rsync or tar. This could be usefull if you are in a shared hosting environment.}
+  s.description = %q{This gem provides up and down file syncing with rsync or tar. This could be usefull if you are in a shared hosting environment.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_dependency "capistrano", "~> 3.0"
+end

data/lib/capistrano/syncfiles.rb

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

data/lib/capistrano/tasks/syncfiles.rake

@@ -0,0 +1,6 @@
+namespace :syncfiles do
+  tasks = Dir[File.expand_path("syncfiles/*.rake", File.dirname(__FILE__))]
+  tasks.each do |task|
+    load task
+  end
+end

data/lib/capistrano/tasks/syncfiles/rsync.rake

@@ -0,0 +1,44 @@
+namespace :rsync do
+  def build_server_string(role)
+    user = role.user + "@" if !role.user.nil?
+    "#{user}#{role.hostname}"
+  end
+
+  desc "Synchronise local and remote wp content folders via rsync"
+  task :up do
+    files = fetch(:syncfiles)
+    files.each do |local_path, config|
+      remote_path  = config[:remote]
+      exclude_dir  = Array(config[:exclude])
+      exclude_args = exclude_dir.map { |dir| "--exclude '#{dir}'"}
+      sync_roles   = fetch(:syncfiles_roles, :all)
+
+      on release_roles sync_roles do |role|
+        server = build_server_string(role)
+
+        cmd  = ["rsync -avzO #{local_path}/ #{server}:#{release_path}/#{remote_path}", *exclude_args]
+        puts cmd.join(' ')
+        system cmd.join(' ')
+      end
+    end
+  end
+
+  desc "Synchronise local and remote wp content folders via rsync"
+  task :down do
+    files = fetch(:syncfiles)
+    files.each do |local_path, config|
+      remote_path  = config[:remote]
+      exclude_dir  = Array(config[:exclude])
+      exclude_args = exclude_dir.map { |dir| "--exclude '#{dir}'"}
+      sync_roles   = fetch(:syncfiles_roles, :all)
+
+      on release_roles sync_roles do |role|
+        server = build_server_string(role)
+
+        cmd  = ["rsync -avzO #{server}:#{release_path}/#{remote_path}/ #{local_path}", *exclude_args]
+        puts cmd.join(' ')
+        system cmd.join(' ')
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/syncfiles/tar.rake

@@ -0,0 +1,54 @@
+namespace :tar do
+  desc "Synchronise local and remote wp content folders via rsync"
+  task :up do
+    files = fetch(:syncfiles)
+    files.each do |local_path, config|
+      archive_name  = "transfere-#{local_path.hash}.tar.gz"
+      tar_verbose   = fetch(:syncfiles_tar_verbose, true) ? "v" : ""
+      exclude_dir   = Array(config[:exclude])
+      exclude_args  = exclude_dir.map { |dir| "--exclude '#{dir}'"}
+
+      cmd = ["tar -c#{tar_verbose}zf #{archive_name} -C #{local_path} .", *exclude_args]
+      puts cmd.join(' ')
+      system cmd.join(' ')
+
+      tmp_file    = fetch(:syncfiles_temp_file, "/tmp/#{archive_name}")
+      remote_path = config[:remote]
+      sync_roles  = fetch(:syncfiles_roles, :all)
+
+      on release_roles sync_roles do
+        upload!(archive_name, tmp_file)
+        execute :tar, "-xzf", tmp_file, "-C", "#{release_path}/#{remote_path}"
+        execute :rm, tmp_file
+      end
+      system "rm -f #{archive_name}"
+    end
+  end
+
+  desc "Synchronise local and remote wp content folders via rsync"
+  task :down do
+    files = fetch(:syncfiles)
+    files.each do |local_path, config|
+      remote_path  = config[:remote]
+      archive_name = "transfere-#{remote_path.hash}.tar.gz"
+      tmp_file     = fetch(:syncfiles_temp_file, "/tmp/#{archive_name}")
+      tar_verbose  = fetch(:syncfiles_tar_verbose, true) ? "v" : ""
+      exclude_dir  = Array(config[:exclude])
+      exclude_args = exclude_dir.map { |dir| "--exclude '#{dir}'"}
+      sync_roles   = fetch(:syncfiles_roles, :all)
+
+      on primary sync_roles do
+        execute :tar, "-c#{tar_verbose}zf", tmp_file, "-C", "#{release_path}/#{remote_path} .", *exclude_args
+
+        download!(tmp_file, archive_name)
+        execute :rm, tmp_file
+      end
+
+      cmd = "tar -xz#{tar_verbose}f #{archive_name} -C #{local_path}"
+      puts cmd
+      system cmd
+
+      system "rm -f #{archive_name}"
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-syncfiles
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Hanoldt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem provides up and down file syncing with rsync or tar. This could
+  be usefull if you are in a shared hosting environment.
+email:
+- tom@creative-workflow.berlin
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-syncfiles.gemspec
+- lib/capistrano/syncfiles.rb
+- lib/capistrano/tasks/syncfiles.rake
+- lib/capistrano/tasks/syncfiles/rsync.rake
+- lib/capistrano/tasks/syncfiles/tar.rake
+homepage: https://github.com/creative-workflow/capistrano-syncfiles
+licenses:
+- MIT
+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: This gem provides up and down file syncing with rsync or tar. This could
+  be usefull if you are in a shared hosting environment.
+test_files: []