chicken_soup 0.1.0 → 0.2.0

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
 .bundle
+.yardoc
 Gemfile.lock
 pkg/*
+todo.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2@chicken_soup

data/chicken_soup.gemspec

@@ -28,8 +28,10 @@ Gem::Specification.new do |s|
   s.require_paths         = ["lib"]
   #= Manifest =#
 
-  s.add_dependency('capistrano',            '~> 2.5.19')
+  s.add_dependency('capistrano',            '~> 2.6.0')
   s.add_dependency('mail',                  '~> 2.2.15')
 
   s.add_development_dependency('bundler',   '~> 1.0.10')
+  s.add_development_dependency('rspec',     '~> 2.6.0')
+  s.add_development_dependency('yard',      '~> 0.7.1')
 end

data/lib/chicken_soup/capabilities.rb

@@ -1,16 +1,31 @@
 ######################################################################
-#                         CAPABILITIES SETUP                         #
+#                         CAPABILITIES SETUP
+#
+# Beginning here, the deployment will utilize the :capabilities array
+# which should have been set in the deploy.rb file.  If :capabilites
+# was not set, then nothing else is loaded.
+#
+# If it was set, we first load all of the default values for each
+# capability's environment variables.
+#
+# Next, we verify that each capability has what it needs to proceed
+# through the rest of the deployment.  If not, the deployment will
+# abort.
+#
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
   require 'chicken_soup/capabilities/defaults'
   require "chicken_soup/capabilities/checks"
+  require "chicken_soup/capabilities/tasks"
 
-  desc "[internal] This task is only here because `require` cannot be used within a `namespace`"
-  task :load_capabilities do
-    require "chicken_soup/capabilities/#{deployment_type}"
+  ['defaults', 'checks', 'tasks'].each do |method|
+    desc "[internal] This task is only here because `require` cannot be used within a `namespace`"
+    task "load_capability_#{method}".to_sym do
+      require_if_exists "chicken_soup/capabilities/#{deployment_type}/#{deployment_type}-#{method}"
 
-    fetch(:capabilities).each do |capability|
-      require "chicken_soup/capabilities/#{capability}"
+      fetch(:capabilities).each do |capability|
+        require_if_exists "chicken_soup/capabilities/#{capability}/#{capability}-#{method}"
+      end
     end
   end
 end

data/lib/chicken_soup/capabilities/apache/apache-checks.rb

@@ -0,0 +1,19 @@
+######################################################################
+#                            APACHE CHECKS                           #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary Apache capabilities variables have been set up.
+      DESC
+      task :apache do
+        required_variables = [
+          :web_server_control_script
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/apache/apache-defaults.rb

@@ -0,0 +1,30 @@
+######################################################################
+#                          APACHE DEFAULTS                           #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :defaults do
+      desc "[internal] Sets intelligent defaults for Apache deployments."
+      task :apache do
+        find_web_server_control_script
+
+        if web_server_control_script =~ /apache2/
+          set :apache_enable_script,    "a2ensite"
+          set :apache_disable_script,   "a2dissite"
+        end
+      end
+    end
+  end
+end
+
+def find_web_server_control_script
+  if remote_file_exists?("/usr/sbin/apachectl")
+    set :web_server_control_script,   "/usr/sbin/apachectl"
+  elsif remote_file_exists?("/usr/sbin/apache2")
+    set :web_server_control_script,   "/usr/sbin/apache2"
+  elsif remote_file_exists?("/usr/sbin/httpd")
+    set :web_server_control_script,   "/usr/sbin/httpd"
+  end
+
+  abort "Couldn't figure out how to control your installation of Apache" unless exists?(:web_server_control_script)
+end

data/lib/chicken_soup/capabilities/apache/apache-tasks.rb

@@ -0,0 +1,85 @@
+######################################################################
+#                            APACHE TASKS                            #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  require   'chicken_soup/capabilities/shared/web_server-tasks'
+
+  namespace :website do
+    desc "Creates the site configuration for the files."
+    task :create do
+      abort "Sorry, auto-installing sites is not supported on your version of Apache." unless exists?(:apache_disable_script)
+
+      virtual_host_config = <<-VHOST
+        <VirtualHost #{web_server_ip}:443>
+          ServerName #{deploy_site_name}
+          DocumentRoot #{deploy_to}/current/public
+
+          SSLEngine on
+          SSLCertificateFile       /etc/ssl/certs/#{domain}.crt
+          SSLCertificateKeyFile    /etc/ssl/certs/#{domain}.key
+
+          RailsEnv #{rails_env}
+          RackEnv #{rails_env}
+
+          <Directory "#{deploy_to}/current/public">
+            Options FollowSymLinks -MultiViews
+            AllowOverride all
+            Order allow,deny
+            Allow from all
+          </Directory>
+
+          RewriteEngine On
+
+          ErrorDocument 503 /system/maintenance.html
+          RewriteCond %{DOCUMENT_ROOT}/system/maintenance.html -f
+          RewriteCond %{SCRIPT_FILENAME} !maintenance.html
+          RewriteCond %{REQUEST_URI} !^/images/
+          RewriteCond %{REQUEST_URI} !^/robots.txt
+          RewriteCond %{REQUEST_URI} !^/sitemap
+          RewriteRule ^.*$ - [redirect=503,last]
+
+          ErrorLog /var/log/apache2/#{application}-errors.log
+
+          LogLevel warn
+
+          CustomLog /var/log/apache2/#{application}-access.log combined
+          ServerSignature On
+        </VirtualHost>
+
+        <VirtualHost #{web_server_ip}:80>
+          ServerName #{deploy_site_name}
+
+          Redirect   permanent / https://#{deploy_site_name}
+        </VirtualHost>
+      VHOST
+
+      put virtual_host_config, "#{user_home}/#{deploy_site_name}"
+      run "#{sudo} mv #{user_home}/#{deploy_site_name} /etc/apache2/sites-available"
+      web_server.reload
+    end
+
+    desc "Completely removes the site configuration from the server (but leaves the files.)"
+    task :remove do
+      abort "Sorry, auto-removing sites is not supported on your version of Apache." unless exists?(:apache_disable_script)
+
+      run "#{sudo} rm /etc/apache2/sites-available/#{deploy_site_name}"
+      web_server.reload
+    end
+
+    desc "Enable Site"
+    task :enable do
+      abort "Sorry, auto-enabling sites is not supported on your version of Apache." unless exists?(:apache_enable_script)
+
+      run "#{sudo} #{apache_enable_script} #{deploy_site_name}"
+      web_server.reload
+    end
+
+    desc "Disable Site"
+    task :disable do
+      abort "Sorry, auto-disabling sites is not supported on your version of Apache." unless exists?(:apache_disable_script)
+
+      run "#{sudo} #{apache_disable_script} #{deploy_site_name}"
+      web_server.reload
+    end
+  end
+end

data/lib/chicken_soup/capabilities/bundler/bundler-checks.rb

@@ -0,0 +1,19 @@
+######################################################################
+#                           BUNDLER CHECKS                           #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary Bundler capabilities variables have been set up.
+      DESC
+      task :bundler do
+        required_variables = [
+          :gem_packager_version
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/bundler/bundler-defaults.rb

@@ -0,0 +1,14 @@
+######################################################################
+#                          BUNDLER DEFAULTS                          #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :defaults do
+      desc "[internal] Sets intelligent defaults for Bundler deployments."
+      task :bundler do
+        _cset :gem_packager_version,  `gem list bundler`.match(/\((.*)\)/)[1]
+        set   :rake,                  "RAILS_ENV=#{rails_env} bundle exec rake"
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/bundler/bundler-tasks.rb

@@ -0,0 +1,35 @@
+######################################################################
+#                           BUNDLER TASKS                            #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  before    'gems:install',       'bundler:install'
+
+  run_task  'bundler:install',    :as => manager_username
+
+  namespace :gems do
+    desc "Install Bundled Gems"
+    task :install do
+      run "cd #{latest_release} && bundle install --gemfile #{latest_release}/Gemfile --path #{shared_path}/bundle --deployment --quiet --without development test"
+    end
+
+    desc "Update Bundled Gems"
+    task :update do
+      abort "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+
+      run "cd #{latest_release} && bundle update"
+    end
+  end
+
+  namespace :bundler do
+    desc "Install Bundler"
+    task :install do
+      bundler_install_command = "gem install bundler --version #{gem_packager_version} --no-ri --no-rdoc && gem cleanup bundler"
+
+      if fetch(:capabilities).include? :rvm
+        run_with_rvm "#{ruby_version}@global", bundler_install_command
+      else
+        run bundler_install_command
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/checks.rb

@@ -2,7 +2,7 @@
 #                         CAPABILITIES CHECK                         #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  after 'environment:check', 'capabilities:check'
+  before  'capabilities:check',     'load_capability_checks'
 
   namespace :capabilities do
     namespace :check do

data/lib/chicken_soup/capabilities/defaults.rb

@@ -1,19 +1,36 @@
 ######################################################################
-#                     DEFAULT CAPABILITIES SETUP                     #
+#                     DEFAULT CAPABILITIES SETUP
+#
+# The 'capabilities:defaults' task hooks itself into the deployment
+# stream by attaching an after hook to 'environment:defaults'.
+#
+# Prior to execution, all of the capabilities which were specified in
+# the deploy.rb file are loaded and then each capability has its
+# 'defaults' task called.
+#
+# All capability's defaults tasks are in the format:
+#   capabilities:defaults:<capability_name>
+#
+# Defaults tasks are there simply to set standard conventional
+# standards on each capability.  In almost all cases, they can
+# be overridden.
+#
+# Defaults are also optional.  If a capability doesn't require any
+# environment variables to be set, it can simply omit a defaults task.
+#
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  after   'environment:defaults',       'capabilities:defaults'
-  before  'capabilities:defaults',      'load_capabilities'
+  before  'capabilities:defaults',      'load_capability_defaults'
 
   namespace :capabilities do
     namespace :defaults do
       desc <<-DESC
-        [internal] Installs the entire capabilities for the given deployment type.
+        [internal] Installs all capabilities for the given deployment type.
 
         Most of these values can be overridden in each application's deploy.rb file.
       DESC
       task :default do
-        defaults.send(deployment_type.to_s)
+        capabilities.defaults.send(deployment_type.to_s)
 
         if exists?(:capabilities)
           fetch(:capabilities).each do |capability|

data/lib/chicken_soup/capabilities/{git.rb → git/git-defaults.rb}

@@ -1,16 +1,3 @@
-######################################################################
-#                              GIT TASKS                             #
-######################################################################
-Capistrano::Configuration.instance(:must_exist).load do
-  namespace :vc do
-    desc <<-DESC
-    DESC
-    task :log do
-      set :vc_log, `git log #{previous_revision}..#{current_revision} --pretty=format:%ai:::%an:::%s`
-    end
-  end
-end
-
 ######################################################################
 #                             GIT DEFAULTS                           #
 ######################################################################
@@ -27,6 +14,8 @@ Capistrano::Configuration.instance(:must_exist).load do
         set(:branch)                      { `git branch`.match(/\* (\S+)\s/m)[1] || raise("Couldn't determine current branch") }
         set(:remote)                      { `git remote`.match(/(\S+)\s/m)[1] || raise("Couldn't determine default remote repository") }
         ssh_options[:forward_agent]       = true
+
+        set :vc_log,                      `git log #{previous_revision}..#{current_revision} --pretty=format:%ai:::%an:::%s`
       end
     end
   end

data/lib/chicken_soup/capabilities/heroku/heroku-checks.rb

@@ -0,0 +1,22 @@
+######################################################################
+#                           HEROKU CHECKS                            #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary Heroku environment variables have been set up.
+      DESC
+      task :heroku do
+        required_variables = [
+          :deploy_site_name,
+          :user,
+          :heroku_credentials_path,
+          :heroku_credentials_file
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/heroku/heroku-defaults.rb

@@ -0,0 +1,16 @@
+######################################################################
+#                           HEROKU DEFAULTS                          #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :defaults do
+      desc "[internal] Sets intelligent defaults for Heroku deployments"
+      task :heroku do
+        _cset :heroku_credentials_path,   "#{ENV["HOME"]}/.heroku"
+        _cset :heroku_credentials_file,   "#{heroku_credentials_path}/credentials"
+
+        _cset(:password)                  {Capistrano::CLI.password_prompt("Encrypted Heroku Password: ")}
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/{heroku.rb → heroku/heroku-tasks.rb}

@@ -33,14 +33,14 @@ Capistrano::Configuration.instance(:must_exist).load do
         Installs a new domain for the application on the Heroku server.
       DESC
       task :install do
-        `heroku domains:add #{deploy_name}`
+        `heroku domains:add #{deploy_site_name}`
       end
 
       desc <<-DESC
         Removes the domain for the application from the Heroku server.
       DESC
       task :remove do
-        `heroku domains:remove #{deploy_name}`
+        `heroku domains:remove #{deploy_site_name}`
       end
 
       namespace :addon do
@@ -110,7 +110,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       that are valid for a Heroku deployment.
     DESC
     task :raise_error do
-      raise "Deploying the #{rails_env} environment to Heroku.  This command is invalid."
+      abort "Deploying the #{rails_env} environment to Heroku.  This command is invalid."
     end
   end
 
@@ -220,7 +220,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     desc "Reset database and seed fresh"
     task :reset_and_seed do
-      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      abort "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
       db.backup
       `heroku pg:reset`
       `heroku rake db:seed`
@@ -228,7 +228,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     desc "Seed database"
     task :seed do
-      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      abort "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
       db.backup
       `heroku rake db:seed`
     end
@@ -244,43 +244,3 @@ Capistrano::Configuration.instance(:must_exist).load do
     `heroku invoke #{ENV['COMMAND']}`
   end
 end
-
-######################################################################
-#                           HEROKU CHECKS                            #
-######################################################################
-Capistrano::Configuration.instance(:must_exist).load do
-  namespace :capabilities do
-    namespace :check do
-      desc <<-DESC
-        [internal] Checks to see if all necessary Heroku environment variables have been set up.
-      DESC
-      task :heroku do
-        required_variables = [
-          :deploy_name,
-          :user,
-          :heroku_credentials_path,
-          :heroku_credentials_file
-        ]
-
-        verify_variables(required_variables)
-      end
-    end
-  end
-end
-
-######################################################################
-#                           HEROKU DEFAULTS                          #
-######################################################################
-Capistrano::Configuration.instance(:must_exist).load do
-  namespace :capabilities do
-    namespace :defaults do
-      desc "[internal] Sets intelligent defaults for Heroku deployments"
-      task :heroku do
-        _cset :heroku_credentials_path,   "#{ENV["HOME"]}/.heroku"
-        _cset :heroku_credentials_file,   "#{heroku_credentials_path}/credentials"
-
-        _cset(:password)                  {Capistrano::CLI.password_prompt("Encrypted Heroku Password: ")}
-      end
-    end
-  end
-end