railsmachine 1.0.1 → 1.0.3

data/COPYING

@@ -1,4 +1,4 @@
-Copyright (c) 2006 Bradley Taylor, bradley@railsmachine.com
+Copyright (c) 2008 Bradley Taylor, bradley@railsmachine.com
 
 		  GNU LESSER GENERAL PUBLIC LICENSE
 		       Version 2.1, February 1999

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006 Bradley Taylor, bradley@railsmachine.com
+Copyright (c) 2008 Bradley Taylor, bradley@railsmachine.com
 
 		  GNU LESSER GENERAL PUBLIC LICENSE
 		       Version 2.1, February 1999

data/README

@@ -1,23 +1,83 @@
-== Railsmachine
+Five Minute Rails Application Deployment
 
-A set of capistrano recipes for simplifying the deployment of Rails applications.
+Ready to deploy your Rails application to Rails Machine? Follow these steps and you’ll have it running in no time! Free to utilize Rails Machine’s Ask Us Anything Support and contact us with any questions you have along the way.
 
-The deployment process looks like this:
+Update Gems
 
-cd <app_directory>
-capify .
-railsmachine --apply-to . --name <app_name> --domain <yourdomain.com>
-cap repos:setup
-cd ../<app_name>_machine
-cap servers:setup deploy:cold
+Install the latest version of the railsmachine gem:
 
-The railsmachine gem has opinions about where the 
-various parts of your application should go:
+    $ sudo gem install railsmachine
+  
+Install Phusion Passenger and Ruby Enterprise Edition
 
-/etc/httpd/conf/apps/   - Apache configurations
-/etc/mongrel_cluster/   - Mongrel cluster configurations
-/var/www/apps/          - Rails applications
+If you do not have Phusion Passenger and Ruby Enterprise Edition installed on your Rails Machine yet you can run this installer on your server.
 
-You will need a 'deploy' account on the system with write access to the above directories.
-You also need a 'deploy' account in your mysql database with all privileges and grant option.
+    $ wget http://assets.railsmachine.com/wiki/centos_passenger_install.sh
+    $ sh centos_passenger_install.sh
+  
+Setup Capistrano
 
+Capify your application:
+
+     $ capify .
+  
+Configure Capistrano for Rails Machine
+
+The following step customizes your config/deploy.rb with two bits of information you provide:
+
+--name: a simple name for your application. no spaces, please.
+example: my-cool-app
+--domain: the primary domain name for your application. please omit the ‘www’ – we automaticaly alias www.whateveryouprovide.com as needed.
+example: my-cool-app.com
+     $ railsmachine --apply-to . --name my-cool-app --domain my-cool-app.com 
+  
+Please note that the domain name provided will need to be correctly pointed at your Rails Machine account. If you don’t have a DNS provider, we’ve been more than happy with DNS Made Easy.
+
+Update Database Config
+
+Update your applications config/database.yml’s section with your desired MySQL datbase name, username, and password. The database and user will be created for you in a forthcoming step.
+
+Application Setup
+
+Rails Machine defaults to using mongrel + mod_proxy_balancer to run your Rails Application. If you’d like to switch to Phusion Passenger, edit the line in your application’s config/deploy.rb that begins set :app_server to reflect your choice. For example:
+
+     set :app_server, :passenger
+  
+Run the following Capistrano task to setup your MySQL databases and configure your application servers (mongrel/passenger):
+
+     $ cap servers:setup
+  
+Source Control
+
+If you’re already using Source Control…
+
+...edit the lines in your application’s config/deploy.rb that begin set :repository and set :repository. For example:
+
+    set :scm, :git
+    set :repository, "git@github.com:yourname/my-cool-app.git" 
+  
+If you’re not yet using Source Control…
+
+...you can easily setup a Git/Subversion repository on your Rails Machine. Subversion is the default, edit the line in your application’s config/deploy.rb that begins set :scm if you’d like to change it to git. For example:
+
+     set :scm, :git
+  
+Next, run the following task to import your application into a Git/SVN repository on your Rails Machine:
+
+     $ cap repos:setup
+  
+Initial Deploy
+
+That’s it! You’re ready to use Capistrano to deploy your app for the first time:
+
+     $ cap deploy:cold
+  
+Once that’s done, open your application in a web browser and test it out!
+
+To perform a subsequent deploy with Capistrano:
+
+     $ cap deploy
+  
+or, if you need to run migrations as well:
+
+     $ cap deploy:migrations

data/Rakefile

@@ -15,22 +15,24 @@ setup_rdoc ['README', 'LICENSE', 'COPYING', 'lib/**/*.rb', 'doc/**/*.rdoc']
 desc "Does a full compile, test run"
 task :default => [:test, :package]
 
-version="1.0.1"
+version="1.0.3"
 name="railsmachine"
 
 setup_gem(name, version) do |spec|
   spec.summary = "The Rails Machine task library"
   spec.description = spec.summary
-  spec.author="Bradley Taylor, Rob Lingle"
-  spec.add_dependency('capistrano', '>= 2.0.0')
+  spec.author="Rails Machine"
+  spec.add_dependency('capistrano', '>= 2.1.0')
   spec.has_rdoc = false
   spec.files += Dir.glob("bin/*")
   spec.files += Dir.glob("resources/**/*")
   spec.default_executable = "railsmachine"
   spec.executables = ["railsmachine"]
+  spec.email = "support@railsmachine.com"
+  spec.homepage = "http://railsmachine.com/"
+  spec.rubyforge_project = "railsmachine"
 end
 
-
 task :install => [:test, :package] do
   sh %{sudo gem install pkg/#{name}-#{version}.gem}
 end

data/lib/railsmachine/generators/railsmachine/USAGE

@@ -1,5 +1,5 @@
 NAME
-     railsmachine - creates configuration and SwitchTower tasks for server configuration.
+     railsmachine - creates configuration and capistrano tasks for server configuration.
 
 SYNOPSIS
      railsmachine [Application name]

data/lib/railsmachine/generators/railsmachine/templates/deploy.rb

@@ -27,10 +27,6 @@ set :user, "deploy"
 set :runner, user
 set :admin_runner, user
 
-
-# URL of your source repository.
-set :repository, "svn+ssh://#{user}@#{domain}#{deploy_to}/repos/trunk"
-
 # Rails environment. Used by application setup tasks and migrate tasks.
 set :rails_env, "production"
 
@@ -52,38 +48,52 @@ role :app, domain
 role :db,  domain, :primary => true
 role :scm, domain
 
+
 # =============================================================================
-# APACHE OPTIONS
+# APPLICATION SERVER OPTIONS
+# ============================================================================= 
+# set :app_server, :mongrel  # :mongrel or :passenger
+
+# =============================================================================
+# WEB SERVER OPTIONS
 # =============================================================================
+# set :httpd, "apache"   # apache 
 # set :apache_server_name, domain
 # set :apache_server_aliases, %w{alias1 alias2}
-# set :apache_default_vhost, true # force use of apache_default_vhost_config
+# set :apache_default_vhost, true # force use of  apache_default_vhost_config
 # set :apache_default_vhost_conf, "/etc/httpd/conf/default.conf"
 # set :apache_conf, "/etc/httpd/conf/apps/#{application}.conf"
-# set :apache_ctl, "/etc/init.d/httpd"
 # set :apache_proxy_port, 8000
 # set :apache_proxy_servers, 2
 # set :apache_proxy_address, "127.0.0.1"
 # set :apache_ssl_enabled, false
 # set :apache_ssl_ip, "127.0.0.1"
 # set :apache_ssl_forward_all, false
+# set :apache_ctl, "/etc/init.d/httpd"
+
+
 
 # =============================================================================
 # MONGREL OPTIONS
 # =============================================================================
-# set :mongrel_servers, apache_proxy_servers
-# set :mongrel_port, apache_proxy_port
-# set :mongrel_address, apache_proxy_address
+# set :mongrel_servers,  apache_proxy_servers
+# set :mongrel_port,  apache_proxy_port
+# set :mongrel_address,  apache_proxy_address
 # set :mongrel_environment, "production"
 # set :mongrel_pid_file, "/var/run/mongrel_cluster/#{application}.pid"
 # set :mongrel_conf, "/etc/mongrel_cluster/#{application}.conf"
 # set :mongrel_user, user
 # set :mongrel_group, group
 
+# =============================================================================
+# DATABASE OPTIONS
+# =============================================================================
+# set :database, "mysql"   # mysql or postgresql
+
 # =============================================================================
 # SCM OPTIONS
 # =============================================================================
-#set :scm,"subversion"
+# set :scm, :subversion    # :subversion or :git
 
 # =============================================================================
 # SSH OPTIONS

data/lib/railsmachine/recipes.rb

@@ -1,14 +1,46 @@
-require 'railsmachine/recipes/svn'
-require 'railsmachine/recipes/mysql'
-require 'railsmachine/recipes/pgsql'
-require 'railsmachine/recipes/apache'
-require 'railsmachine/recipes/mongrel'
-
 Capistrano::Configuration.instance(:must_exist).load do
-  
+
   default_run_options[:pty] = true
   set :keep_releases, 3
   set :app_symlinks, nil
+  set :scm, :subversion
+  set :httpd, :apache
+  set :app_server, :mongrel
+  set :db_adapter, :mysql
+  set :rails_env, "production"
+
+  load    'config/deploy'
+  
+  set :repository do
+    scm = fetch(:scm)
+    repos_base = "#{user}@#{domain}#{deploy_to}"
+    if scm.to_s == 'subversion'
+      "svn+ssh://#{repos_base}/repos/trunk"
+    elsif scm.to_s == 'git'
+      "ssh://#{repos_base}/repos/#{application}.git"
+    end
+  end
+
+  
+  task :validate_required_variables do
+    validate_option(:scm, :in => [:subversion, :git])
+    validate_option(:app_server, :in => [:mongrel, :passenger])
+    validate_option(:httpd, :in => [:apache])
+    validate_option(:db_adapter, :in => [:mysql, :postgresql, :sqlite3])  
+  end
+
+  before :require_recipes, :validate_required_variables
+  
+  require "railsmachine/recipes/app/deploy"
+  require "railsmachine/recipes/app/mongrel"
+  require "railsmachine/recipes/app/passenger"
+  
+  # defer requires until variables have been set
+  task :require_recipes do
+    require "railsmachine/recipes/scm/#{scm}"
+    require "railsmachine/recipes/web/#{httpd}"
+    require "railsmachine/recipes/db/#{db_adapter}"
+  end
   
   namespace :servers do
   
@@ -17,6 +49,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     Used to configure your deployment environment in one command.
     DESC
     task :setup  do
+      sudo  "chown -R #{user}:#{user} #{deploy_to.gsub(application,'')}"
       deploy.setup
     begin
       db.setup
@@ -27,7 +60,9 @@ Capistrano::Configuration.instance(:must_exist).load do
       web.setup
     end
   
-    desc "A macro task that restarts the application and web servers"
+    desc <<-DESC
+    A macro task that restarts the application and web servers
+    DESC
     task :restart do
       app.restart
       web.restart
@@ -37,45 +72,65 @@ Capistrano::Configuration.instance(:must_exist).load do
   
   namespace :app do
   
-    desc 'Setup mongrel'
+    desc <<-DESC
+    Setup #{app_server}
+    DESC
     task :setup, :roles => :app  do
-      set :mongrel_environment, rails_env
-      set :mongrel_port, apache_proxy_port
-      set :mongrel_servers, apache_proxy_servers
-      set :mongrel_user, user unless mongrel_user
-      set :mongrel_group, mongrel_user unless mongrel_group
-      set_mongrel_conf
-      mongrel.cluster.configure
+      case app_server.to_s
+       when "mongrel"
+        setup_mongrel
+       when "passenger"
+        # do nothing
+      end
     end
     
-    desc "Restart application server."
+    desc <<-DESC
+    Restart application server.
+    DESC
     task :restart, :roles => :app  do
-      set_mongrel_conf
-      mongrel.cluster.restart
+      application_servlet.restart
     end
     
-    desc "Start application server."
+    desc <<-DESC
+    Start application server.
+    DESC
     task :start, :roles => :app  do
-      set_mongrel_conf
-      mongrel.cluster.start
+      application_servlet.start
     end
     
-    desc "Stop application server."
+    desc <<-DESC
+    Stop application server.
+    DESC
     task :stop, :roles => :app  do
-      set_mongrel_conf
-      mongrel.cluster.stop
+      application_servlet.stop
+    end
+    
+    desc <<-DESC
+    Switch your application to run on mongrel or passenger.
+    DESC
+    task :switch do
+      case app_server.to_s
+       when "mongrel"
+         switch_to_mongrel
+       when "passenger"
+         switch_to_passenger
+      end
     end
   
     namespace :symlinks do
   
-      desc "Setup application symlinks in the public"
+      desc <<-DESC
+      Setup application symlinks in the public
+      DESC
       task :setup, :roles => [:app, :web] do
         if app_symlinks
           app_symlinks.each { |link| run "mkdir -p #{shared_path}/public/#{link}" }
         end
       end
 
-      desc "Link public directories to shared location."
+      desc <<-DESC
+      Link public directories to shared location.
+      DESC
       task :update, :roles => [:app, :web] do
         if app_symlinks
           app_symlinks.each { |link| run "ln -nfs #{shared_path}/public/#{link} #{current_path}/public/#{link}" }
@@ -88,74 +143,107 @@ Capistrano::Configuration.instance(:must_exist).load do
   
   namespace :web do
     
-    desc "Setup web server."
+    desc <<-DESC
+    Setup web server.
+    DESC
     task :setup, :roles => :web  do
-      set :apache_server_name, domain unless apache_server_name
+      set :apache_server_name, domain unless  apache_server_name
       apache.configure
     end
     
-    desc "Restart web server."
+    desc <<-DESC
+    Restart web server.
+    DESC
     task :restart, :roles => :web  do
       apache.restart
     end
     
-    desc "Reload web server configuration."
+    desc <<-DESC
+    Reload web server configuration.
+    DESC
     task :reload, :roles => :web  do
       apache.reload
     end
     
-    desc "Start web server."
+    desc <<-DESC
+    Start web server.
+    DESC
     task :start, :roles => :web  do
       apache.start
     end
     
-    desc "Stop web server."
+    desc <<-DESC
+    Stop web server.
+    DESC
     task :stop, :roles => :web  do
       apache.stop
     end  
   
   end
   
-  namespace :db do
-  
-    desc "Setup database server."
-    task :setup, :roles => :db, :only => { :primary => true } do
-      db_config = YAML.load_file('config/database.yml')
-      db_type = db_config[rails_env]["adapter"]
-      case db_config[rails_env]["adapter"]
-        when "mysql"
-          mysql.setup
-        when "postgresql"
-          postgresql.setup
-        else 
-          puts "Only MySQL or Postgres can be configured by db:setup."
-      end
-    end
-  
-  end
-  
   namespace :repos do
-    
-    desc "Setup source control repository."
+    desc <<-DESC
+    Setup source control repository.
+    DESC
     task :setup, :roles => :scm  do
-    begin  
-      svn.setup
+    begin
+      sudo  "chown -R #{user}:#{user} #{deploy_to.gsub(application,'')}"
+      localrepo.setup
     rescue
-      puts "svn:setup failed!"
+      puts "repos:setup failed!"
+    end
+      localrepo.import
     end
-      svn.import
-    end  
   
   end
   
-  
+  on      :start, :require_recipes
   before  'deploy:update_code', 'app:symlinks:setup'
   after   'deploy:symlink', 'app:symlinks:update'
   after   'deploy:cold', 'web:reload'
   after   :deploy,'deploy:cleanup'
   
-  def set_mongrel_conf
-    set :mongrel_conf, "/etc/mongrel_cluster/#{application}.conf" unless mongrel_conf
-  end 
+  def setup_mongrel
+    set_mongrel_conf
+    set :mongrel_environment, rails_env
+    set :mongrel_port,  apache_proxy_port
+    set :mongrel_servers,  apache_proxy_servers
+    set :mongrel_user, user unless mongrel_user
+    set :mongrel_group, mongrel_user unless mongrel_group
+    mongrel.cluster.configure
+  end
+
+  def switch_to_mongrel
+    app.setup 
+    app.start 
+    web.setup
+    web.restart
+  end
+  
+  def switch_to_passenger
+    web.setup 
+    mongrel.cluster.remove 
+    web.restart
+  end
+  
+  def validate_option(key, options = {})
+    if !(options[:in].map{|o| o.to_s } + ['']).include?(self[key].to_s)
+      raise(ArgumentError, error_msg("Invalid value '#{self[key]}' for option '#{key}' must be one of the following: '#{options[:in].join(', ')}'"))
+    end
+  end
+
+  def application_servlet
+    case app_server.to_s
+      when 'mongrel' 
+        mongrel.cluster
+      when 'passenger' 
+        passenger
+    end 
+  end
+
+  def error_msg(msg)
+    banner = ''; msg.length.times { banner << "+" }
+    return "\n\n#{banner}\n#{msg}\n#{banner}\n\n"
+  end
   
 end