deployable 0.0.1 → 0.0.2

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc/*
+.yardoc/*

data/.yardopts

@@ -0,0 +1 @@
+lib/deployable/**/*.rb - README.md CHANGELOG.md LICENSE lib/deployable/*.rb

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.0.2 (January 24th, 2012)
+
+* Added license
+* Improved documentation
+* Added a default recipe using a database
+* New and improved initrd script (list/info commands)
+* Add capistrano as a gem dependency
+* Removed support for Bundler 0.7.x
+
+
+## 0.0.1 (January 22nd, 2012)
+
+Initial public release of Deployable gem.

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Digitpaint
+
+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,42 @@
+Deployable: A collection of handy capistrano tasks and recipes
+==============================================================
+
+**Homepage**:  [http://github.com/digitpaint/deployable](http://github.com/digitpaint/deployable)   
+**Git**:       [git@github.com:digitpaint/deployable.git](git@github.com:digitpaint/deployable.git)   
+**Author**:    Digitpaint  
+**License**:   [MIT license](http://www.opensource.org/licenses/MIT)
+
+Synopsis
+--------
+
+After years of copying our deploy script from one application to another it was time to consolidate all these variants into one authoritive source for all our deploy (and capistrano) related tasks. This library contains commonly used capistrano tasks, a couple of default recipes and example configurations.
+
+Usage
+-----
+
+1. Add the `deployable` gem to your gemfile:
+
+        group :development do
+          gem "deployable"
+        end
+
+2. Config your deploy script (see the `examples/config` directory for some inspiration)
+
+
+Source
+------
+ 
+deployable's git repo is available on GitHub, which can be browsed at:
+ 
+    http://github.com/digitpaint/deployable
+   
+and cloned from:
+   
+    git://github.com/digitpaint/deployable.git
+
+
+Copyright
+---------
+
+Deployable © 2012 by [Digitpaint](mailto:info@digitpaint.nl). Licensed under the MIT
+license. Please see the {file:LICENSE} for more information.

data/deployable.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.version     = Deployable::VERSION
   s.authors     = ["Digitpaint", "Flurin Egger"]
   s.email       = ["info@digitpaint.nl", "flurin@digitpaint.nl"]
-  s.homepage    = ""
-  s.summary     = %q{A collection of handy capistrano deploy recipes}
-  s.description = s.summary
+  s.homepage    = "https://github.com/DigitPaint/Deployable"
+  s.summary     = %q{A collection of handy capistrano tasks and recipes}
+  s.description = %q{This library contains commonly used capistrano tasks, a couple of default recipes and example configurations.}
 
   s.rubyforge_project = "deployable"
 
@@ -20,5 +20,10 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency "capistrano", "~> 2.9.0"
+  s.add_runtime_dependency "capistrano-ext", "~> 1.2.1"
+  
+  # This may be deleted in future versions. Needed because in older
+  # rubies you get Abort Trap 6 errors in gem 
+  s.add_runtime_dependency "highline", "1.5.2"
 end

data/examples/config/deploy/production.rb

@@ -0,0 +1,35 @@
+# Servers
+role :app, "APPSERVER", :primary => true  
+role :db, "DBSERVER", :primary => true  
+
+# RVM configuration
+set :rvm_ruby_string, "RUBYVERSION@#{application}-#{stage}"
+set :rvm_type, :user
+
+# Deploy location / code
+set :deploy_to, "DEPLOYLOCATION/#{application}/#{stage}"
+set :branch, "master"
+
+# Passenger config
+set :passenger_standalone, {
+  :passenger => {
+    :port => 10001
+  }
+} 
+
+# Database config
+set :database_config, {
+  :adapter => "mysql",
+  :username => "", 
+  :host => "",
+  :development => "", 
+  :test => "",
+  :production => ""
+}
+
+# Bundle configuration (is optional)
+set :bundle_config, {
+  :build => {
+    :mysql => "--with-mysql-config='/usr/bin/mysql_config'"
+  }
+}

data/examples/config/deploy.rb

@@ -0,0 +1,24 @@
+# ======================================
+# = Base deploy script for application =
+# ======================================
+# Run with: bundle exec cap STAGE deploy
+# ======================================
+
+$:.unshift(File.expand_path('./lib', ENV['rvm_path']))
+
+# ======================================
+
+set :stages, %w(production)
+set :application, "APPLICATION NAME"
+set :repository,  "git@reposerver:#{application}.git"
+set :scm, "git"
+
+set :deploy_via, :remote_cache
+set :git_enable_submodules, 1
+
+set :user, "admin"
+set :use_sudo, false
+
+# ======================================
+
+require 'deployable/recipes/default_with_database'

data/examples/scripts/initd.rb

@@ -40,46 +40,46 @@ APPLICATIONS_PATH = USER_HOME_PATH + "/applications/"
 # Main start routine.
 def run!
   command = ARGV.first
-  available_commands = %w{start stop list}
+  available_commands = %w{start stop list info}
   raise "Use one of #{available_commands.join("|")} as first argument" unless available_commands.include?(command)
 
   applications = Dir.glob("#{APPLICATIONS_PATH}*/*").inject({}){|mem, dir| parts = dir.split("/"); mem[parts[-2]] ||= []; mem[parts[-2]] << parts[-1]; mem}
 
+
   if command == "list"
-    str = "All applications for #{USER}"
-    puts str
-    puts "=" * str.size
-    
-    applications.each do |application, stages|
-      puts "#{application} (#{APPLICATIONS_PATH}/#{application})"
-      stages.each do |stage|
-        puts "    - #{stage}"
-      end
+    head = "| " + "Application".ljust(60) + " | " + "Stage".ljust(20) + " | " + "Port".ljust(6) + " | "  + "RVM".ljust(80) + " |"
+    puts "-"  * head.size
+    puts head
+    puts "-"  * head.size    
+  end
+
+  if application = ARGV[1]
+    unless applications.has_key?(application)
+      raise "Can't find application #{application}"
     end
-  else
-    if application = ARGV[1]
-      unless applications.has_key?(application)
-        raise "Can't find application #{application}"
-      end
 
-      if stage = ARGV[2]
-        unless applications[application].include?(stage)
-          raise "Stage #{stage} not found for application #{application}"
-        end
-        Application.new(application,stage).start_or_stop!(command)
-      else
-        applications[application].each do |stage|
-          Application.new(application,stage).start_or_stop!(command)
-        end
+    if stage = ARGV[2]
+      unless applications[application].include?(stage)
+        raise "Stage #{stage} not found for application #{application}"
       end
+      Application.new(application,stage).run!(command)
     else
-      applications.each do |application, stages|
-        stages.each do |stage|
-          Application.new(application,stage).start_or_stop!(command)
-        end
+      applications[application].each do |stage|
+        Application.new(application,stage).run!(command)
       end
     end
+  else
+    applications.sort.each do |application, stages|
+      stages.each do |stage|
+        Application.new(application,stage).run!(command)
+      end
+    end
+  end
+  
+  if command == "list"
+    puts "-" * head.size
   end
+
   true
 end
 
@@ -92,22 +92,40 @@ class Application
   def initialize(application_name,stage)
     @path = Pathname.new("#{APPLICATIONS_PATH}#{application_name}/#{stage}")
     @name = application_name
-    @stage = start_or_stop
+    @stage = stage
     
     # Sanity check!
     raise "No server.yml found in '#{@path}'" unless File.exist?(@path +"server.yml")
     
     # Load config
-    @config = YAML.load(File.read((@path +"server.yml").to_s))
+    @config = YAML.load(File.read((@path +"server.yml").to_s))    
   end
   
-  def start_or_stop!(command)
+  def run!(command)
     case command
     when "start" then self.start!
     when "stop"  then self.stop!
+    when "info" then self.info!
+    when "list" then self.list!
     end    
   end
   
+  def info!
+    fw = 6
+    say "#{self.name} - #{self.stage}"
+    say "  " + "Path".ljust(fw) + ": " + self.path.to_s
+    say "  " + "RVM".ljust(fw) + ": " + self.config["rvm"]["rvm_ruby_string"]
+    say "  " + "Port".ljust(fw) + ": " + self.config["passenger"]["port"]
+  end
+  
+  def list!
+    say "| " + field(self.name, 60) + " | " + field(self.stage, 20) + " | " + field(self.config["passenger"]["port"],6) + " | "  + field(self.config["rvm"]["rvm_ruby_string"], 80) + " |"
+  end
+  
+  def field(txt, len)
+    txt.to_s.ljust(len)[0,len]
+  end
+  
   def start!
     say "Start #{USER} #{self.name} #{self.stage}"
     
@@ -121,7 +139,7 @@ class Application
     run_callback(:start, :before)
     
     # Start the server
-    puts rvm_execute(self.config, "passenger start #{self.path + "current"} --user #{user} --port #{server_config['passenger']['port']} --environment production -d --pid-file #{self.path + "passenger.pid"}")
+    puts rvm_execute(self.config, "passenger start #{self.path + "current"} --user #{USER} --port #{self.config['passenger']['port']} --environment production -d --pid-file #{self.path + "passenger.pid"}")
     
     # Run the after start callback
     run_callback(:start, :after)    
@@ -146,7 +164,7 @@ class Application
   
   protected
   
-  def callback(key, time)
+  def run_callback(key, time)
     return unless self.config.has_key?("callbacks")
     
     callbacks = self.config["callbacks"]
@@ -182,9 +200,9 @@ begin
   if run!
     puts "Done!"
   else
-    puts "Usage: passenger-standalone {start|stop|list} [application] [stage]"
+    puts "Usage: passenger-standalone {start|stop|info} [application] [stage]"
   end
 rescue StandardError => e
   puts "ERROR: #{e.message}"
-  puts "Usage: passenger-standalone {start|stop|list} [application] [stage]"
+  puts "Usage: passenger-standalone {start|stop|info} [application] [stage]"
 end

data/lib/deployable/bundle.rb

@@ -0,0 +1,45 @@
+# = Bundler 1.0.x related tasks
+# 
+# == Usage
+# For some dependencies you need extra config parameters. Bundler supports these by setting "bundle config ...."
+# Our config takes care of this serverside. All you need to do are
+#
+# Set: "after 'deploy:finalize_update', 'bundle:config'" (you may want to run this after your RVM setup though)
+#
+# Set the config like this:
+#
+# set :bundle_config, {
+#   :build => {
+#     :mysql => "--with-mysql-config='/usr/bin/mysql_config'"
+#   }
+# }
+# 
+# == Caution!
+# Warning: Do not load these with bundler below 1.0.x
+# 
+Capistrano::Configuration.instance(true).load do
+  namespace :bundle do
+    desc "Setup bundler config on server"
+    task :config do
+      if conf = fetch(:bundle_config)
+        conf.each do |k1,h|
+          h.each do |k2,v|
+            bundle_cmd     = fetch(:bundle_cmd, "bundle")
+            bundle_dir     = fetch(:bundle_dir, File.join(fetch(:shared_path), 'bundle'))          
+          
+            current_release = fetch(:current_release)
+            if current_release.to_s.empty?
+              raise ::Capistrano::CommandError.new("Cannot detect current release path - make sure you have deployed at least once.")
+            end
+                    
+            args = ["#{k1}.#{k2} #{v}"]
+            args << "--path #{bundle_dir}" unless bundle_dir.to_s.empty?
+          
+            run "cd #{current_release} && #{bundle_cmd} config #{args.join(" ")}"
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/deployable/config_files.rb

@@ -0,0 +1,97 @@
+# = Config files
+#
+# Allows you to upload stage dependent config files with multiple strategies
+#
+# == Usage
+#
+# All you have to do is set the variable :config_files with the following structure:
+#
+#   set :config_files, {
+#     "test.rb"  => "#{current_release}/test.rb",
+#     "local.rb" => {
+#       :location  => "#{current_release}/config/local.rb",
+#       :strategy => :put
+#     },
+#     "skyline_configuration.rb" => {
+#       :location => "#{current_release}/config/initializers/skyline_configuration.rb",
+#       :strategy => :copy
+#     }
+#   }   
+# 
+# Every key of the hash above is a filename of a file that resides in <tt>:stage_dir/:stage</tt> (default=config/deploy/:stage)
+# The filename kan either be filename.xyz or filename.xyz.erb. If both a regular and an .erb variant are present, only the
+# .erb variant is processed. And you guessed right: the .erb variant is processed by ERB before putting.
+#
+# The value of the hash can either be a string or another hash. The config_file configuration hash has the folowing keys
+#
+# [:location]   The location the file will be stored on the server after deployment (final location)
+# [:strategy]   The strategy defines how the file will be stored on the server. The default strategy is :put, see below for more info
+# 
+# The most simple usage is just "filename.xyz" => "location.xyz" this will assume the default strategy of :put.
+#
+# === Strategies
+#
+# [:put]   The file will be processed (in case of ERB) and uploaded during every deploy
+# [:copy]  The file will be processed and uploaded once during setup and after that it'll be copied to the final location on each deploy
+# 
+Capistrano::Configuration.instance(true).load do
+  
+  namespace :config_files do
+    desc "Setup config files with strategy :copy"
+    task :setup do
+      normalize_configs.each do |filename, options|
+        next unless options[:strategy] == :copy
+        put render_config_file(filename), "#{deploy_to}/#{filename}"
+      end
+    end
+    
+    desc "Set all config files for current stage"
+    task :install do      
+      normalize_configs.each do |filename, options|
+        case options[:strategy]
+        when :put
+          put render_config_file(filename), options[:location]
+        when :copy
+          run "cp #{deploy_to}/#{filename} #{options[:location]}"
+        end
+      end
+    end
+    
+    # Normalize config files so we can do {"filename.rb" => "location"} instead
+    # of the full syntax. The default strategy is :put
+    def normalize_configs
+      if configs = fetch(:config_files, {})
+        configs.inject({}) do |mem, (filename, options)|
+          if !options.kind_of?(Hash)
+            options = {:location => options, :strategy => :put}
+          end
+          mem[filename] = {}
+          options.each do |k,v|
+            mem[filename][k] = interpolate(v)
+          end
+          mem
+        end
+      end      
+    end
+    
+    def interpolate(var)
+      if var.respond_to?(:call)
+        var.call
+      else
+        var
+      end
+    end
+    
+    def render_config_file(file)
+      location = Pathname.new(fetch(:stage_dir, "config/deploy")) + stage.to_s
+      if File.exist?(location + "#{file}.erb")
+        view = ERB.new(File.read(location + "#{file}.erb"))
+        view.result(binding)
+      elsif File.exist?(location + file)
+        File.read(location + file)
+      else
+        raise ::Capistrano::CommandError.new("Cannot detect current config file in #{location}.")
+      end
+    end
+  end
+end

data/lib/deployable/recipes/default_with_database.rb

@@ -0,0 +1,47 @@
+# This is our default deployment script with database support and assumes the following
+#
+# - Capistrano Multistage
+# - RVM
+# - Passenger
+# - Passenger Standalone
+# - Bundler
+#
+# - Database config
+
+Capistrano::Configuration.instance(true).load do
+  # Load multistage
+  require 'capistrano/ext/multistage'
+
+  # Load RVM
+  require 'rvm/capistrano'
+
+  # Overwrite the start/stop/restart tasks
+  require 'deployable/passenger'
+
+  # Add RVM specific tools
+  require "deployable/rvm"
+  before "deploy:setup", "rvm:create_gemset"
+  after "deploy:finalize_update", "rvm:set_rvmrc", "rvm:trust_rvmrc"
+
+  # Enable bundling
+  require 'bundler/capistrano'
+  require "deployable/bundle"
+  after "rvm:trust_rvmrc", "bundle:config"
+
+  # Handle database config
+  require "deployable/database"
+  after "deploy:setup", "database:setup"
+  after "deploy:update_code", "database:copy_config_to_release"
+
+  # Passenger standalone setup
+  require "deployable/passenger_standalone"
+  after "deploy:setup", "passenger_standalone:setup"
+
+  # Config files support
+  require "deployable/config_files"
+  after "deploy:setup", "config_files:setup"
+  after "deploy:update_code", "config_files:install"
+
+  # Cleanup
+  after "deploy", "deploy:cleanup"
+end

data/lib/deployable/version.rb

@@ -1,3 +1,3 @@
 module Deployable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/deployable.rb

@@ -1,4 +1,5 @@
 require "deployable/version"
+require 'pathname'
 
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "This extension requires Capistrano 2"

metadata

@@ -1,62 +1,136 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: deployable
-version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
-authors:
+authors: 
 - Digitpaint
 - Flurin Egger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-22 00:00:00.000000000Z
-dependencies: []
-description: A collection of handy capistrano deploy recipes
-email:
+
+date: 2012-01-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 2
+        - 9
+        - 0
+        version: 2.9.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: capistrano-ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :runtime
+  version_requirements: *id003
+description: This library contains commonly used capistrano tasks, a couple of default recipes and example configurations.
+email: 
 - info@digitpaint.nl
 - flurin@digitpaint.nl
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- .yardopts
+- CHANGELOG.md
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - deployable.gemspec
 - examples/config/deploy.rb
-- examples/config/deploy/acceptance.rb
 - examples/config/deploy/production.rb
 - examples/scripts/initd.rb
 - lib/deployable.rb
-- lib/deployable/bundler-0.7.rb
+- lib/deployable/bundle.rb
+- lib/deployable/config_files.rb
 - lib/deployable/database.rb
 - lib/deployable/passenger.rb
 - lib/deployable/passenger_standalone.rb
+- lib/deployable/recipes/default_with_database.rb
 - lib/deployable/rvm.rb
 - lib/deployable/version.rb
-homepage: ''
+has_rdoc: true
+homepage: https://github.com/DigitPaint/Deployable
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: deployable
-rubygems_version: 1.8.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A collection of handy capistrano deploy recipes
+summary: A collection of handy capistrano tasks and recipes
 test_files: []
+

data/lib/deployable/bundler-0.7.rb

@@ -1,23 +0,0 @@
-# = Bundler 0.7.x related tasks
-# 
-# Warning: Do not load 0.7.x AND 1.0.x tasks at the same time!
-Capistrano::Configuration.instance(true).load do
-  namespace :bundler do
-    desc "Setup bundler dirs in shared"
-    task :setup, :roles => [:app] do
-      run "mkdir -p #{deploy_to}/shared/bundler_gems/gems #{deploy_to}/shared/bundler_gems/specifications"
-    end
-  
-    desc "Bundle gems in release_path/vendor/bundler_gems (symlinked to shared)"
-    task :bundle, :roles => [:app] do
-      run "cd #{release_path}/vendor/bundler_gems; ln -fs #{deploy_to}/shared/bundler_gems/gems"
-      run "cd #{release_path}/vendor/bundler_gems; ln -fs #{deploy_to}/shared/bundler_gems/specifications"
-      run "cd #{release_path}; gem bundle --cached"
-    end
-    
-    desc "Install bundler"
-    task :install, :roles => [:app] do
-      run "gem install bundler --version=0.7.2"
-    end    
-  end
-end