capistrano-shared_file 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Huiming Teo (teohm) 
+
+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.rdoc

@@ -0,0 +1,26 @@
+= capistrano-shared_file
+
+Capistrano recipe to symlink shared files e.g. config/database.yml 
+stored in shared path to release path.
+
+To use the recipe, add the following lines to config/deploy.rb: 
+  
+    #set :shared_files, %w(config/database.yml) # optional, as it's the default value
+    require 'capistrano/shared_file'
+
+
+== Contributing to capistrano-shared_file
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 teohm. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "capistrano-shared_file"
+  gem.homepage = "http://github.com/teohm/capistrano-shared_file"
+  gem.license = "MIT"
+  gem.summary = %Q{Capistrano recipe to symlink shared files e.g. config/database.yml}
+  gem.description = %Q{
+    To use the recipe, add the following lines to config/deploy.rb: 
+  
+    #set :shared_files, %w(config/database.yml) # optional, as it's the default value
+    require 'capistrano/shared_file'
+  }
+  gem.email = "teohuiming@gmail.com"
+  gem.authors = ["teohm"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :version
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "capistrano-shared_file #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/capistrano-shared_file.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "capistrano-shared_file"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["teohm"]
+  s.date = "2012-05-11"
+  s.description = "\n    To use the recipe, add the following lines to config/deploy.rb: \n  \n    #set :shared_files, %w(config/database.yml) # optional, as it's the default value\n    require 'capistrano/shared_file'\n  "
+  s.email = "teohuiming@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "capistrano-shared_file.gemspec",
+    "lib/capistrano/shared_file.rb"
+  ]
+  s.homepage = "http://github.com/teohm/capistrano-shared_file"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Capistrano recipe to symlink shared files e.g. config/database.yml"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

data/lib/capistrano/shared_file.rb

@@ -0,0 +1,104 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+    abort "capistrano/shared_files requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+
+  # ================================================================
+  # This variable defines files to be symlinked from shared path.
+  #
+  # File 'config/database.yml' is added by default, to cover 80%
+  # of the use cases. Please OVERWRITE this to fit your needs.
+  # ================================================================
+  _cset :shared_files, %w(config/database.yml)
+
+  # ================================================================
+  # These variables define where to store the shared files.
+  # Make sure you understand the implication when you modify them.
+  # ================================================================
+  _cset :shared_file_dir, "files"
+  _cset(:shared_file_path) { File.join(shared_path, shared_file_dir) }
+
+
+  # ================================================================
+  # Cap tasks are added under namespace deploy:shared_file:*
+  # Usually you do not need to call them directly, as they are 
+  # triggered during deploy:setup and deploy.
+  # ================================================================
+  namespace :deploy do
+    namespace :shared_file do
+
+      desc <<-DESC
+        Generate shared file dirs under shared/files dir.
+        
+        For example, given:
+          set :shared_files, %w(config/database.yml db/seeds.yml)
+
+        The following directories will be generated:
+          shared/files/config/
+          shared/files/db/
+      DESC
+      task :setup, :except => { :no_release => true } do 
+        if exists?(:shared_files)
+          dirs = shared_files.map {|f| File.join(shared_file_path, File.dirname(f)) }
+          run "#{try_sudo} mkdir -p #{dirs.join(' ')}"
+          run "#{try_sudo} chmod g+w #{dirs.join(' ')}" if fetch(:group_writable, true)
+        end
+      end
+      after "deploy:setup", "deploy:shared_file:setup"
+
+
+      desc <<-DESC
+        Print a reminder to upload shared files \
+        along with scp samples.
+      DESC
+      task :print_reminder do
+        if exists?(:shared_files)
+          servers = find_servers(:no_release => false)
+          puts <<-INFO
+*************************
+*  UPLOAD SHARED FILES  *
+
+ Remember to upload these files:
+   #{ shared_files.join('\n  ') }
+
+ To '#{shared_file_path}' in server(s):
+   #{servers.join('\n  ')}
+
+ SCP Samples:
+          INFO
+
+          servers.each do |server|
+            shared_files.each do |file_path|
+              puts "    scp #{file_path} #{server}:#{File.join(shared_file_path, file_path)}\n"
+            end
+          end
+
+          puts <<-INFO
+
+*************************
+          INFO
+        end
+      end
+      after "deploy:setup", "deploy:shared_file:print_reminder"
+
+
+      desc <<-DESC
+        Symlink shared files to release path.
+
+        WARNING: It DOES NOT warn you when shared files not exist.  \
+        So symlink will be created even when a shared file does not \
+        exist.
+      DESC
+      task :create_symlink, :except => { :no_release => true } do
+        (shared_files || []).each do |path|
+          run "ln -nfs #{shared_file_path}/#{path} #{release_path}/#{path}"
+        end
+      end
+      after "deploy:finalize_update", "deploy:shared_file:create_symlink"
+
+    end # namespace shared_file
+  end # namespace deploy
+
+end
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-shared_file
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- teohm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: ! "\n    To use the recipe, add the following lines to config/deploy.rb:
+  \n  \n    #set :shared_files, %w(config/database.yml) # optional, as it's the default
+  value\n    require 'capistrano/shared_file'\n  "
+email: teohuiming@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- capistrano-shared_file.gemspec
+- lib/capistrano/shared_file.rb
+homepage: http://github.com/teohm/capistrano-shared_file
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -955439828747405408
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Capistrano recipe to symlink shared files e.g. config/database.yml
+test_files: []