capistrano-config 0.0.1

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 capistrano-config.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yamashita Yuu
+
+MIT License
+
+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,58 @@
+# capistrano-config
+
+a capistrano recipe to manage configurations files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-config
+
+## Usage
+
+This recipes will try to update application config during Capistrano `deploy` tasks.
+
+To enable this recipe, add following in your `config/deploy.rb`.
+The template of `config/config.yml` will be read from either `./config/templates/config/config.yml` or `./config/templates/config/config.yml.erb` by default.
+
+    # in "config/deploy.rb"
+    require 'capistrano-config'
+    set(:config_files, %w(config/config.yml))
+
+Following options are available to manage your configuration files.
+
+ * `:config_update_remotely` - specify whether update config files on remote machines or not. `true` by default.
+ * `:config_update_locally` - specify whether update config files on local machines or not. `false` by default.
+ * `:config_path` - specify configuration base directory on remote machines. use `release_path` by default.
+ * `:config_path_local` - specify configuration base directory on local machine. use `.` by default.
+ * `:config_template_path` - specify configuration template directory on local machine. use `./config/templates` by default.
+ * `:config_files` - specify list of configuration files in relative path. empty by default.
+ * `:config_readable_files` - list of files which should be readable. empty by default.
+ * `:config_writable_files` - list of files which should be writable. empty by default.
+ * `:config_executable_files` - list of files which should be executable. empty by default.
+ * `:config_remove_files` - list of files which should be removed. empty by default.
+
+## 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 new Pull Request
+
+## Author
+
+- YAMASHITA Yuu (https://github.com/yyuu)
+- Geisha Tokyo Entertainment Inc. (http://www.geishatokyo.com/)
+
+## License
+
+MIT

data/Rakefile

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

data/capistrano-config.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-config/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-config"
+  gem.version       = Capistrano::Config::VERSION
+  gem.authors       = ["Yamashita Yuu"]
+  gem.email         = ["yamashita@geishatokyo.com"]
+  gem.description   = %q{a capistrano recipe to manage configurations files.}
+  gem.summary       = %q{a capistrano recipe to manage configurations files.}
+  gem.homepage      = "https://github.com/yyuu/capistrano-config"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("capistrano")
+end

data/lib/capistrano-config/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Config
+    VERSION = "0.0.1"
+  end
+end

data/lib/capistrano-config.rb

@@ -0,0 +1,113 @@
+require "capistrano-config/version"
+require 'erb'
+require 'tempfile'
+
+module Capistrano
+  module ConfigRecipe
+    def self.extended(configuration)
+      configuration.load {
+        namespace(:config) {
+          _cset(:config_path) { release_path }
+          _cset(:config_path_local) { File.expand_path('.') }
+          _cset(:config_template_path) { File.join(File.expand_path('.'), 'config', 'templates') }
+          _cset(:config_files, [])
+          _cset(:config_source_files) {
+            config_files.map { |file| File.join(config_template_path, file) }
+          }
+          _cset(:config_temporary_files) {
+            config_files.map { |file|
+              f = Tempfile.new('config'); t = f.path
+              f.close(true) # remote tempfile immediately
+              t
+            }
+          }
+          _cset(:config_readable_mode, "ug+r")
+          _cset(:config_readable_files, [])
+          _cset(:config_writable_mode, "ug+rw")
+          _cset(:config_writable_files, [])
+          _cset(:config_executable_mode, "ug+rx")
+          _cset(:config_executable_files, [])
+          _cset(:config_remove_files, [])
+
+          desc("Update applicatin config.")
+          task(:update, :roles => :app, :except => { :no_release => true }) {
+            transaction {
+              update_locally if fetch(:config_update_locally, false)
+              update_remotely if fetch(:config_update_remotely, true)
+            }
+          }
+          after 'deploy:finalize_update', 'config:update'
+
+          def _read_config(config)
+            if File.file?(config)
+              File.read(config)
+            elsif File.file?("#{config}.erb")
+              ERB.new(File.read("#{config}.erb")).result(binding)
+            else
+              abort("config: no such template found: #{config} or #{config}.erb")
+            end
+          end
+
+          def _do_update(src_tmp_tgt, options={})
+            options = {
+              :readable_files => [], :writable_files => [], :executable_files => [],
+              :remove_files => [],
+            }.merge(options)
+            dirs = src_tmp_tgt.map { |src, tmp, tgt| File.dirname(tgt) }.uniq
+            execute = []
+            execute << "mkdir -p #{dirs.join(' ')}" unless dirs.empty?
+            src_tmp_tgt.map { |src, tmp, tgt|
+              execute << "( diff -u #{tgt} #{tmp} || #{sudo} mv -f #{tmp} #{tgt} )"
+            }
+            execute << "#{sudo} chmod #{config_readable_mode} #{options[:readable_files].join(' ')}" unless options[:readable_files].empty?
+            execute << "#{sudo} chmod #{config_writable_mode} #{options[:writable_files].join(' ')}" unless options[:writable_files].empty?
+            execute << "#{sudo} chmod #{config_executable_mode} #{options[:executable_files].join(' ')}" unless options[:executable_files].empty?
+            execute << "#{sudo} rm -f #{options[:remove_files].join(' ')}" unless options[:remove_files].empty?
+
+            execute.join(' && ')
+          end
+
+          task(:update_locally, :roles => :app, :except => { :no_release => true }) {
+            begin
+              target_files = config_files.map { |f| File.join(config_path_local, f) }
+              src_tmp_tgt = config_source_files.zip(config_temporary_files, target_files)
+              src_tmp_tgt.each { |src, tmp, tgt|
+                File.open(tmp, 'wb') { |fp| fp.write(_read_config(src)) } unless dry_run
+              }
+              run_locally(_do_update(src_tmp_tgt,
+                :readable_files => config_readable_files.map { |f| File.join(config_path_local, f) },
+                :writable_files => config_writable_files.map { |f| File.join(config_path_local, f) },
+                :executable_files => config_executable_files.map { |f| File.join(config_path_local, f) },
+                :remove_files => config_remove_files.map { |f| File.join(config_path_local, f) }))
+            ensure
+              run_locally("rm -f #{config_temporary_files.join(' ')}") unless config_temporary_files.empty?
+            end
+          }
+
+          task(:update_remotely, :roles => :app, :except => { :no_release => true }) {
+            begin
+              target_files = config_files.map { |f| File.join(config_path, f) }
+              src_tmp_tgt = config_source_files.zip(config_temporary_files, target_files)
+              src_tmp_tgt.each { |src, tmp, tgt|
+                put(_read_config(src), tmp)
+              }
+              run(_do_update(src_tmp_tgt,
+                :readable_files => config_readable_files.map { |f| File.join(config_path, f) },
+                :writable_files => config_writable_files.map { |f| File.join(config_path, f) },
+                :executable_files => config_executable_files.map { |f| File.join(config_path, f) },
+                :remove_files => config_remove_files.map { |f| File.join(config_path, f) }))
+            ensure
+              run("rm -f #{config_temporary_files.join(' ')}") unless config_temporary_files.empty?
+            end
+          }
+        }
+      }
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Configuration.instance.extend(Capistrano::ConfigRecipe)
+end
+
+# vim:set ft=ruby :

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yamashita Yuu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: a capistrano recipe to manage configurations files.
+email:
+- yamashita@geishatokyo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-config.gemspec
+- lib/capistrano-config.rb
+- lib/capistrano-config/version.rb
+homepage: https://github.com/yyuu/capistrano-config
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: a capistrano recipe to manage configurations files.
+test_files: []