inploy 1.5.0 → 1.6.0

data/README.textile

@@ -1,100 +1,163 @@
 h2. ABOUT:
 
-Inploy is a Rails plugin to deploy applications in a easier way. You can use Inploy from a remote machine or from the local machine, too. It's integrated with Git, Rake and intended to do most of the common work, so you don't need to.
+Inploy was a born as an option to setup and deploy Rails applications in an easier and smarter way. 
 
-Actually, Inploy has four rake tasks:
+It executes common tasks like migrate the database, install gems, package the assets, clean the cache, notified Hoptoad, restart the server, etc. automatically. This means you will not have a big deploy script calld 'recipe' like with other tools, only a simple deploy script with a few lines.
+
+It uses Git to version the deploys and to pull only the modifications in each one. This means you will not have a lot of folders in the server (only one) with duplicated code and that ech deploy will be very fast.
+
+It is very flexible, meaning you can create templates specifing how specific tasks must behave. As today, there are templates for Locaweb and for Rails 3.
+
+It works by default with Passenger, but you can specified another servers like Mongrel, Thin and Unicorn.
+
+You can execute Inploy from a remote machine or from the server machine, meaning anynone can go to the deployment path and with only one command update the code and execute all the tasks.
+
+As Inploy is very flexible, now you can also use it to execute an installation shell script in a server from an URL.
+
+h2. INSTALLATION:
+
+As a plugin:
+
+<pre><code>script/plugin install git://github.com/dcrec1/inploy.git</code></pre>
+
+As a gem:
+
+<pre><code>sudo gem install inploy</code></pre>
+
+Please remember that when used as a gem, Inploy should be available in the deploy servers.
+
+h2. USAGE
+
+When using Inploy with Rake, there are five tasks:
+
+* inploy:remote:install from=url
+
+- connects to a list of servers and executes the script from url
 
 * inploy:remote:setup
 
 - connects to a list of servers
 - clones a git repository
-- runs inploy:local:setup
+- executes rake inploy:local:setup
 
-* inploy:remote:update (_alias: inploy:up_)
+* inploy:remote:update or inploy:up
 
 - connects to a list of servers
-- runs inploy:local:update
+- executes inploy:local:update
+
+* inploy:remote:install
+
+- connects to a list of servers
+- reads the content of url specified by from=url without downloading the file and executes it
 
 * inploy:local:setup
 
-- copies config/*.sample files to config/*
-- creates directory tmp/pids
+- creates directories db and tmp/pids
+- copies config/*.sample and config/*.example files to config/*
+- creates the database
 - executes init.sh file case it exists
+- inits and updates the git submodules
 - installs gems
-- migrates the database for the production environment
-- cleans the cache in public/cache
-- cleans cached assets in public/assets if jammit is installed 
+- migrates the database
+- updates the crontab from Whenever if being used
+- cleans the cache, default tmp/cache
+- cleans cached assets in public/assets if Jammit is installed 
 - parses less files if more:parse tasks exists
 - package the assets if asset:packager:build_all task exists
-- touch tmp/restart.txt
+- notifies Hoptoad about the deploy, specifing the revision, repository and environment
+- notifies NewRelic RPM about the deploy
+- restarts the server
 
 * inploy:local:update
 
 - pulls the repository
+- inits and updates the git submodules
+- copies config/*.sample and config/*.example files to config/*
 - installs gems
-- migrates the database for the production environment
-- cleans the cache directories (default public/cache)
+- migrates the database
+- updates the crontab from Whenever if being used
+- cleans the cache, default tmp/cache
+- cleans cached assets in public/assets if Jammit is installed 
 - parses less files if more:parse tasks exists
 - package the assets if asset:packager:build_all task exists
-- touch tmp/restart.txt
+- notifies Hoptoad about the deploy, specifing the revision, repository and environment
+- notifies NewRelic RPM about the deploy
+- restarts the server
 
-h2. SKIP STEPS
+If you don't want to execute Rake, there are a few shortcuts:
 
-You can skip some steps when running a task, just add "skip_steps" into your rake command line or add "skip_steps" to your deploy.rb to always skip those steps (see "CONFIGURATION" for details).
+inploy = inploy update = rake inploy:remote:update
+inploy install from=url = rake inploy:remote:install from=url
 
-Currently the steps available to skip are:
+When using inploy as a command, it looks first for config/deploy.rb and then for deploy.rb .
 
-- install_gems: skip rake gems:install
-- migrate_database: skip rake db:migrate
-- clear_cache: skip removing cache directories
+h2. CONFIGURATION
 
-* Usage (params are comma separated):
+Create a config/deploy.rb file and configure it something like this:
 
-<pre><code>rake inploy:remote:update skip_steps=install_gems,migrate_database</code></pre>
+<pre><code>
+application = "signal"
+repository = 'git://github.com/dcrec1/signal.git'
+hosts = ['hooters', 'geni']
 
-h2. INSTALLATION:
+# OPTIONALS
 
-As a plugin:
+before_restarting_server do
+  rake "important:task"
+  run "important_command"
+end
+
+path = '/opt'                                # default /var/local/apps
+user = 'dcrec1'                              # default deploy
+ssh_opts = '-A'                              # default empty
+branch = 'production'                        # default master
+sudo = true                                  # default false
+cache_dirs = ['public/cache', 'tmp/cache']   # default ['public/cache']
+skip_steps = ['install_gems', 'clear_cache'] # default []
+</code></pre>
 
-<pre><code>script/plugin install git://github.com/dcrec1/inploy.git</code></pre>
+h2. SKIP STEPS
 
-As a gem:
+You can skip some steps when running a Rake task, just add "skip_steps" into your rake command line or add "skip_steps" to your deploy.rb to always skip those steps.
 
-<pre><code>sudo gem install inploy</code></pre>
+Currently the steps available to skip are:
 
-Please remember that when used as a gem, Inploy should be available in the deploy servers.
+- install_gems: skip rake gems:install
+- migrate_database: skip rake db:migrate
+- clear_cache: skip removing cache directories
 
-h2. CONFIGURATION
+* Usage (params are comma separated):
 
-Create a config/deploy.rb file and configure it something like this:
+<pre><code>rake inploy:remote:update skip_steps=install_gems,migrate_database</code></pre>
 
-<pre><code>
-deploy.application = "signal"
-deploy.repository = 'git://github.com/dcrec1/signal.git'
-deploy.user = 'dcrec1'
-deploy.hosts = ['hooters', 'geni']
-deploy.path = '/opt'
+h2. HOOKS
 
-# OPTIONALS
+Currently the only hook is called before restarting the server. If you need another hook, please fork the project and implemented it or created an issue, it's very easy.
 
-deploy.ssh_opts = '-A'                            # default empty
-deploy.branch = 'production'                      # default master
-deploy.sudo = true                                # default false
-deploy.cache_dirs = ['public/cache', 'tmp/cache'] # default ['public/cache']
+h2. CONTRIBUTORS:
 
-# Use this if you want to skip some steps on update and setup
-# Available options: install_gems, migrate_database, clear_cache
-# This feature is also available on command line
-# eg. rake inploy:update:remote skip_steps=install_gems
+Inploy is brought to you by:
+
+ * Diego Carrion
+ * Douglas Campos
+ * Kristopher Murata
+ * Vitor Pellegrino
+ * Josh Owens
+ * Felipe
+ * trooster
+ * Josef Pospíšil
+ * BrunoGrasselli
+ * Andy Shen
+ * alekenji
+ * Erik Dahlstrand
+ * Carlos Brando
 
-deploy.skip_steps = ['install_gems', 'clear_cache'] #default none
-</code></pre>
 
 h2. LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009
+Copyright (c) 2010
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/gempackagetask'
 require 'spec/rake/spectask'
 
 GEM = "inploy"
-GEM_VERSION = "1.5.0"
+GEM_VERSION = "1.6.0"
 SUMMARY = "Rails deployment made easy"
 AUTHOR = "Diego Carrion"
 EMAIL = "dc.rec1@gmail.com"
@@ -16,8 +16,8 @@ spec = Gem::Specification.new do |s|
   s.version = GEM_VERSION
   s.platform = Gem::Platform::RUBY
   s.summary = SUMMARY
-  s.require_paths = ['lib']
-  s.files = FileList['lib/**/*', '[A-Z]*'].to_a
+  s.files = FileList['lib/**/*','bin/*', '[A-Z]*'].to_a
+  s.executables << "inploy"
 
   s.author = AUTHOR
   s.email = EMAIL

data/bin/inploy

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'inploy'
+require 'inploy/cli'
+
+Inploy::CLI.execute ARGV

data/lib/inploy/cli.rb

@@ -0,0 +1,15 @@
+module Inploy
+  class CLI
+    def self.execute(params)
+      deploy = Deploy.new
+      case params.size
+      when 0
+        deploy.remote_update
+      when 1
+        deploy.send "remote_#{params.first}"
+      when 2
+        deploy.remote_install :from => params.last.sub("from=", "")
+      end
+    end
+  end
+end

data/lib/inploy/deploy.rb

@@ -2,15 +2,18 @@ module Inploy
   class Deploy
     include Helper
     include DSL
+
     attr_accessor :repository, :user, :application, :hosts, :path, :ssh_opts, :branch, :environment,
-                  :port, :skip_steps, :cache_dirs
+                  :port, :skip_steps, :cache_dirs, :sudo
 
     def initialize
       self.server = :passenger
-      self.cache_dirs ||= ['public/cache']
+      @cache_dirs = %w(public/cache)
       @branch = 'master'
       @environment = 'production'
-      @sudo = ''
+      @user = "deploy"
+      @path = "/var/local/apps"
+      configure
     end
 
     def template=(template)
@@ -21,8 +24,14 @@ module Inploy
       load_module "servers/#{server}"
     end
 
-    def sudo=(value)
-      @sudo = value.equal?(true) ? 'sudo ' : ''
+    def configure
+      if file = configuration_file
+        deploy = self
+        eval file.read
+        local_variables.each do |variable| 
+          send "#{variable}=", eval(variable) rescue nil 
+        end
+      end
     end
     
     def remote_install(opts)

data/lib/inploy/dsl.rb

@@ -29,13 +29,17 @@ module Inploy
       run "ruby #{file} #{opts[:params]}" if File.exists?(file)
     end
 
+    def sudo_if_should
+      @sudo ? 'sudo ' : ''
+    end
+
     def run(command, disable_sudo = false)
       log command
 
       if disable_sudo
         Kernel.system command
       else
-        Kernel.system "#{@sudo}#{command}"
+        Kernel.system "#{sudo_if_should}#{command}"
       end
     end
 

data/lib/inploy/helper.rb

@@ -1,5 +1,9 @@
 module Inploy
   module Helper
+    def configuration_file
+      File.open("config/deploy.rb") rescue File.open("deploy.rb") rescue nil
+    end
+
     def skip_step?(step)
       skip_steps and skip_steps.include?(step)
     end

data/lib/inploy/templates/locaweb.rb

@@ -1,6 +1,10 @@
 module Inploy
   module Templates
     module Locaweb
+      def self.extended(base)
+        base.path = nil
+      end
+
       def remote_setup
         run "rm -Rf #{tmp_path} && git clone . #{tmp_path} && tar czf - #{tmp_path} | ssh #{user}@#{host} 'tar xzfv - -C ~/ && mv ~#{tmp_path} #{path}/ && cd #{application_path} && rake inploy:local:setup'"
       end

data/lib/inploy/templates/rails3.rb

@@ -1,7 +1,6 @@
 module Inploy
   module Templates
     module Rails3
-
       def remote_setup
         if branch.eql? "master"
           checkout = ""

data/lib/tasks/inploy.rake

@@ -1,15 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 require 'inploy'
 
-def deploy
-  @deploy ||= Inploy::Deploy.new
-end
-
-begin
-  require "config/deploy.rb"
-rescue Exception
-end
-
+deploy = Inploy::Deploy.new
 
 deploy.environment = ENV['environment'] || deploy.environment
 deploy.skip_steps = ENV['skip_steps'].split(',') unless ENV['skip_steps'].nil?

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 5
+  - 6
   - 0
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors: 
 - Diego Carrion
@@ -14,19 +14,20 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-15 00:00:00 -03:00
+date: 2010-04-17 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
 description: 
 email: dc.rec1@gmail.com
-executables: []
-
+executables: 
+- inploy
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
+- lib/inploy/cli.rb
 - lib/inploy/deploy.rb
 - lib/inploy/dsl.rb
 - lib/inploy/helper.rb
@@ -38,6 +39,7 @@ files:
 - lib/inploy/templates/rails3.rb
 - lib/inploy.rb
 - lib/tasks/inploy.rake
+- bin/inploy
 - Rakefile
 - README.textile
 has_rdoc: true