capistrano-shared-file 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae6818f152a7cd866f7f83a61c1bcab73e34146f
-  data.tar.gz: 101df52331a4d973b2ca6f251f349a74c9413df2
+  metadata.gz: 0e1eee643c665843a165fec2114bd677d8f0c024
+  data.tar.gz: 01d534b9072cef9a0f6a653ae38a6c435c56e0a2
 SHA512:
-  metadata.gz: e29bee61fabc330137611a53da11e4ca15e532fc0fe67dcb563c0fa37a00de9dba6fa6ccb3f58837c4fc9f1758e36e0dc0a5823640712bc80aad48cf6a04aacc
-  data.tar.gz: 254d231b4f3dbf6376deace92eb0971ee802cf1c33eafb1521b7e18d78e7c5206ff1ee3993ba0f1596f9678689bdf4d3c8b42d223846a05dc6fb1afcc58880fc
+  metadata.gz: 09696afa985ae72b31d5522eda84551f174da87d5fff8193e1a264d92e225c3519431ab9eeef5b9a9bc1825c22daeb79e955f79ffc694174bbb859e705a185bf
+  data.tar.gz: 5839efabdc0a3605a6cf2d65cad54679a4edf00d4f74436b456d9dee00dd17664909fa512d4af23885cce07b03c3f584dabad9b5fe100ec56bc4eb1fef5df048

data/README.md

@@ -1,5 +1,9 @@
 # capistrano-shared-file
-A Capistrano recipe to upload, download and symlink configuration files like `config/database.yml` or `config/application.yml` to or from your remote servers. Heavily inspired by teohm's [capistrano-shared_file](https://github.com/teohm/capistrano-shared_file) gem.
+A Capistrano recipe to upload, download and symlink configuration files like `config/database.yml` to or from your remote servers.
+
+One of the most common use cases for this gem is when used together with [Figaro](https://github.com/laserlemon/figaro), where the `config/application.yml` file is *git-ignored* but you still want to have a convenient way to push it to your servers on every deploy.
+
+Heavily inspired by teohm's [capistrano-shared_file](https://github.com/teohm/capistrano-shared_file) gem.
 
 ## Install
 
@@ -11,11 +15,50 @@ For Bundler, add this to your `Gemfile`:
 
 ## Usage
 
-Add the following lines to `config/deploy.rb`:
+You can start using it by simply adding the line below at the bottom of your `deploy.rb`:
 
-    set :shared_files, %w(config/database.yml)
     require 'capistrano-shared-file'
 
+Generally you won't need to modify any of the default variables defined in the gem. For a more customized setup, please refer to the next section.
+
+## Variables
+
+The following is the list of capistrano variables that are defined in this gem and that can be customized to fit your specific needs.
+
+### shared_files
+
+Specifies the list of files that you want to symlink to the `current_release` directory. By default:
+
+    set :shared_files, %w(config/database.yml)
+
+For example, when using [Figaro](https://github.com/laserlemon/figaro) you will probably want to add the `application.yml` file to this list.
+
+    set :shared_files, %w(config/database.yml config/application.yml)
+
+### shared_file_dir
+
+Specify the directory in which you want to upload all shared files. By default:
+
+    set :shared_file_dir, 'files'
+
+For example, given the following variables are set in your `deploy.rb`:
+
+    set :deploy_to,       '/home/damselem/my_amazing_project
+    set :shared_file_dir, 'files'
+    set :shared_files,    %w(config/application.yml)
+
+The shared file in the remote will be at:
+
+    /home/damselem/my_amazing_project/shared/files/config/application.yml
+
+### shared_file_backup
+
+Enbales backups of your shared files when uploading and downloading shared files. By default:
+
+    set :shared_file_backup, false
+
+For more details on the implications of setting this variable to `true`, refer to the next **Upload** and **Download** sections.
+
 ## Tasks
 
 ### Upload
@@ -24,21 +67,30 @@ To upload all the files defined in the `shared_files` capistrano variable to a r
 
     bundle exec cap shared_file:upload
 
+With backup (it creates a backup of the remote shared files on your machine before uploading the new versions to the remote machine):
+
+    bundle exec cap shared_file:upload -S shared_file_backup=true
+
 ### Download
 
 To download all the files defined in the `shared_files` capistrano variable from a remote server, you can execute:
 
     bundle exec cap shared_file:download
-    
+
+With backup (it creates a backup of the local shared files on your machine before downloading the new versions from the remote machine):
+
+    bundle exec cap shared_file:download -S shared_file_backup=true
+
 ### Symlink
 
 To symlink the uploaded configuration files to the current release path, you can execute:
 
     bundle exec cap shared_file:symlink
-    
-This task will be executed on every deploy. If you happen to make any changes in the files specified in the `shared_files` capistrano variable, make sure you upload them.
 
-**Note**: You can use it together with `capistrano/ext/multistage` like:
+You normally shouldn't have to execute it manually since it's already executed automatically on every deploy.
+
+## capistrano/ext/multistage
+This gem has been tested to work with `capistrano/ext/multistage`. For example:
 
     bundle exec cap <STAGE> shared_file:upload
     bundle exec cap <STAGE> shared_file:download

data/lib/capistrano/shared_file/tasks.rb

@@ -6,13 +6,18 @@ end
 
 Capistrano::Configuration.instance.load do
 
-  _cset :shared_files,    %w(config/database.yml)
-  _cset :shared_file_dir, 'files'
+  _cset :shared_files,       %w(config/database.yml)
+  _cset :shared_file_dir,    'files'
+  _cset :shared_file_backup, false
 
   def remote_path_to(file)
     File.join(shared_path, shared_file_dir, file)
   end
 
+  def backup_path_to(file)
+    File.join(File.dirname(file), "#{Time.now.strftime('%Y%m%dT%H%M%S')}_#{File.basename(file)}")
+  end
+
   namespace :shared_file do
 
     desc 'Generate remote directories for shared files.'
@@ -27,6 +32,9 @@ Capistrano::Configuration.instance.load do
     desc 'Upload shared files to server'
     task :upload, :except => { :no_release => true } do
       shared_files.each do |file|
+        if shared_file_backup
+          top.download(remote_path_to(file), backup_path_to(file), :via => :scp)
+        end
         top.upload(file, remote_path_to(file), :via => :scp)
       end
     end
@@ -34,6 +42,9 @@ Capistrano::Configuration.instance.load do
     desc 'Download shared files from server.'
     task :download, :except => { :no_release => true } do
       shared_files.each do |file|
+        if shared_file_backup
+          run_locally "cp #{file} #{backup_path_to(file)}"
+        end
         top.download(remote_path_to(file), file, :via => :scp)
       end
     end

data/lib/capistrano/shared_file/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module SharedFile
-    VERSION = '1.0.1'
+    VERSION = '1.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-shared-file
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Daniel Salmeron Amselem
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-04 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano