capistrano-linked-files 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 869df53defa75a669478fd9d3f52cfd7454190d1
+  data.tar.gz: 8fb45854a55ca7f9038a1d93d146d3be72b54d81
+SHA512:
+  metadata.gz: d40ae7b29972288aa25617964938d338495f99befebf9e7bb99c7083757f48696cf5d7c4248a148b0742d73575e99ee4fb3500b5a5f0b368649bf49a0a7bea2c
+  data.tar.gz: 994cbd4afefaef1032ff9b8d1d6cc30f612c008a43eeed3159f45215bc29d013a1c974a473ee647f2e01b715bc3ec90d1ac877373d98da5bbe25c9ce3a18de0b

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano3-pushover.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Runar Skaare Tveiten
+
+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,61 @@
+# capistrano-linked-files
+
+This gem provides Capistrano reciepes to upload your linked files and directories. It's quite useful for files such as `config/database.yml` and `config/secrets.yml`, which are usually ignored (at least they should be) from version control systems.
+
+Linked files and directories are placed in the `shared` directory on your remote servers and kept between deployments. After a new deployment, a symlink is created from the `shared` directory to the `current` directory.
+
+Inspiration was found in damselem's [capistrano-shared-files](https://github.com/damselem/capistrano-shared-file), but capistrano-linked-files uses the "built in" Capistrano configuration variables `linked_files` and `linked_dirs` instead of custom ones. This way it's not necessary to specify your linked files twice.
+
+## Installation
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem 'capistrano-linked-files'
+```
+
+Or install it to your system:
+
+```
+$ gem install capistrano-linked-files
+```
+
+## Usage
+
+Add the gem to your `Capfile`:
+
+```ruby
+require 'capistrano/linked_files'
+```
+
+In `deploy.rb`, list the files and directories you'd like to keep between deployments:
+
+```ruby
+set :linked_files, %w(config/database.yml config/secrets.yml)
+set :linked_dirs, %w(bin log tmp)
+```
+
+Then run the task:
+
+```
+$ bundle exec cap <STAGE> linked_files:upload
+```
+
+To automatically upload linked files and directories after a new deployment, add the following to your `deploy.rb`:
+
+```ruby
+before :finishing, 'linked_files:upload'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The capistrano-linked-files plugin is free software released under the MIT License.
+See [LICENSE](https://github.com/runar/capistrano-linked-files/blob/master/LICENSE) for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/capistrano-linked-files.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'capistrano-linked-files'
+  s.version       = '0.1.0'
+  s.summary       = 'Upload linked files and directories.'
+  s.description   = 'Adds tasks to upload your linked files and directories. '
+
+  s.authors       = ['Runar Skaare Tveiten']
+  s.email         = ['runar@tveiten.io']
+  s.homepage      = 'https://github.com/runar/capistrano-linked-files'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ['lib']
+
+  s.add_dependency 'capistrano', '~> 3.1'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+end

data/lib/capistrano/linked_files.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/linked_files.rake', __FILE__)

data/lib/capistrano/tasks/linked_files.rake

@@ -0,0 +1,58 @@
+def backup_path_for(file)
+  File.join(File.dirname(file), "#{Time.now.strftime('%Y%m%d%H%M%S')}_#{File.basename(file)}")
+end
+
+namespace :linked_files do
+
+  desc 'Upload linked files and directories'
+  task :upload do
+    invoke 'linked_files:upload:files'
+    invoke 'linked_files:upload:dirs'
+  end
+
+  namespace :upload do
+
+    task :files do
+      on roles :web do
+        fetch(:linked_files).each do |file|
+          upload! file, "#{shared_path}/#{file}"
+        end
+      end
+    end
+
+    task :dirs do
+      on roles :web do
+        fetch(:linked_dirs).each do |dir|
+          upload! dir, "#{shared_path}/", recursive: true
+        end
+      end
+    end
+
+  end
+
+  namespace :backup do
+
+    desc 'Download a backup of remote linked files'
+    task :files do
+      on roles :web do
+        fetch(:linked_files).each do |file|
+          download! "#{shared_path}/#{file}", backup_path_for(file)
+        end
+      end
+    end
+
+    desc 'Download a backup of remote linked directories'
+    task :dirs do
+      on roles :web do
+        fetch(:linked_dirs).each do |dir|
+          download! "#{shared_path}/#{dir}", "backups_#{dir}", recursive: true
+          # info "#{shared_path}/#{dir} #{backup_path_for(dir)}"
+        end
+      end
+    end
+
+  end
+
+  before 'linked_files:upload', 'deploy:check:make_linked_dirs'
+
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-linked-files
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Runar Skaare Tveiten
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Adds tasks to upload your linked files and directories. '
+email:
+- runar@tveiten.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-linked-files.gemspec
+- lib/capistrano-linked-files.rb
+- lib/capistrano/linked_files.rb
+- lib/capistrano/tasks/linked_files.rake
+homepage: https://github.com/runar/capistrano-linked-files
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Upload linked files and directories.
+test_files: []