capistrano-fanfare 0.0.18 → 0.0.19

data/README.md

@@ -1,8 +1,12 @@
-# Capistrano::Fanfare [![Build Status](https://secure.travis-ci.org/fnichol/capistrano-fanfare.png)](http://travis-ci.org/fnichol/capistrano-fanfare) [![Dependency Status](https://gemnasium.com/fnichol/capistrano-fanfare.png)](https://gemnasium.com/fnichol/capistrano-fanfare)
+# <a name="title"></a> Capistrano::Fanfare [![Build Status](https://secure.travis-ci.org/fnichol/capistrano-fanfare.png)](http://travis-ci.org/fnichol/capistrano-fanfare) [![Dependency Status](https://gemnasium.com/fnichol/capistrano-fanfare.png)](https://gemnasium.com/fnichol/capistrano-fanfare)
 
-TODO: Write a gem description
+**Notice:** This README is under active development.
 
-## Installation
+## <a name="features"></a> Features
+
+Coming soon...
+
+## <a name="installation"></a> Installation
 
 Add this line to your application's Gemfile:
 
@@ -12,13 +16,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install capistrano-fanfare
-
-## Usage
-
-TODO: Write usage instructions here
+## <a name="usage"></a> Usage
 
 Create a `Capfile` that looks like:
 
@@ -43,7 +41,7 @@ Create a `Capfile` that looks like:
     fanfare_recipe 'campfire'
     fanfare_recipe 'airbrake'
 
-    Dir['vendor/gems/*/recipes/*.rb','vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+    Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
 
     load 'config/deploy'
 
@@ -79,10 +77,164 @@ There are several optional recipes that need additional gems in your Gemfile:
       gem 'capistrano-campfire'
     end
 
-## Contributing
+## <a name="recipes"></a> Recipes
+
+**Foundational**
+
+* [git_style](#recipes-git-style):
+  GitHub-style deployments, fully compatible with third party recipes.
+* [foreman](#recipes-foreman):
+  Forget Unicorns, Resque workers, and God. Think processes.
+* [bundler](#recipes-bundler):
+  Binstub `PATH`-aware deployments with custom shebangs and more.
+
+**Core**
+
+* [defaults](#recipes-defatuls):
+  Common baseline defaults and an augmented `deploy:cold`.
+* [multistage](#recipes-multistage):
+  Deploy to multiple environments like `"staging"` and `"production"`.
+* [assets](#recipes-assets):
+  Rails asset pipeline support: done!
+* [database_yaml](#recipes-database-yaml):
+  No more database password baked in your code, leave that up to the server.
+* [db_seed](#recipes-db-seed):
+  Seeding your Rails database, autowired into `deploy:cold`.
+
+**Gravy**
+
+* [ssh](#recipes-ssh):
+  Connect to your infrastructure nodes without thinking.
+* [console](#recipes-console):
+  Rails 2/3, Sinatra, and Rack consoles, running in one command.
+* [colors](#recipes-colors):
+  Deploys, but prettier.
+* [campfire](#recipes-campfire):
+  Notify your team of deployment and maintenace events.
+* [airbrake](#recipes-airbrake):
+  Track your deployments in Airbrake/Hoptoad/Errbit
+* [info](#recipes-info):
+  Deployment configuration information, available at a glance.
+
+### <a name="recipes-foundational"></a> Foundational
+
+#### <a name="recipes-git-style"></a> git_style
+
+> GitHub-style deployments, fully compatible with third party recipes.
+
+A Git style deployment strategy based on GitHub's
+[Deployment Script Spring Cleaning][github_spring] blog post.
+
+#### <a name="recipes-foreman"></a> foreman
+
+> Forget Unicorns, Resque workers, and God. Think processes.
+
+#### <a name="recipes-bundler"></a> bundler
+
+> Binstub `PATH`-aware deployments with custom shebangs and more.
+
+Uses the delivered [Bundler][cap_bundler] implementation with support for
+shebangs, binstubs `PATH` inclusion, and a generated `bin/bundle` binstub
+script file.
+
+### <a name="recipes-core"></a> Core
+
+#### <a name="recipes-defaults"></a> defaults
+
+> Common baseline defaults and an augmented `deploy:cold`.
+
+#### <a name="recipes-multistage"></a> multistage
+
+> Deploy to multiple environments like `"staging"` and `"production"`.
 
-1. Fork it
+Uses the delivered [Capistrano multistage][cap_multistage] implementation with
+a few additional helpers.
+
+#### <a name="recipes-asssets"></a> assets
+
+> Rails asset pipeline support: done!
+
+#### <a name="recipes-db-seed"></a> db_seed
+
+> Tracking deployments in Airbrake
+
+#### <a name="recipes-database-yaml"></a> database_yaml
+
+> No more database password baked in your code, leave that up to the server.
+
+### <a name="recipes-gravy"></a> Gravy
+
+#### <a name="recipes-ssh"></a> ssh
+
+> Connect to your infrastructure nodes without thinking.
+
+#### <a name="recipes-console"></a> console
+
+> Rails 2/3, Sinatra, and Rack consoles, running in one command.
+
+#### <a name="recipes-colors"></a> colors
+
+> Deploys, but prettier.
+
+> Rails console, ready for input in one command.
+
+#### <a name="recipes-campfire"></a> campfire
+
+> Notify your team of deployment and maintenace events.
+
+#### <a name="recipes-airbrake"></a> airbrake
+
+> Track your deployments in Airbrake/Hoptoad/Errbit
+
+#### <a name="recipes-info"></a> info
+
+> Deployment configuration, available at a glance.
+
+## <a name="development"></a> Development
+
+* Source hosted at [GitHub][repo]
+* Report issues/questions/feature requests on [GitHub Issues][issues]
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## <a name="authors"></a> Authors
+
+Created and maintained by [Fletcher Nichol][fnichol] (<fnichol@nichol.ca>)
+
+## <a name="license"></a> License
+
+MIT (see [LICENSE][license])
+
+[defaults_src]:       https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/defaults.rb
+[multistage_src]:     https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/multistage.rb
+[git_style_src]:      https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/git_style.rb
+[bundler_src]:        https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/bundler.rb
+[assets_src]:         https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/assets.rb
+[db_seed_src]:        https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/db_seed.rb
+[foreman_src]:        https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/foreman.rb
+[database_yaml_src]:  https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/database_yaml.rb
+[info_src]:           https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/info.rb
+[colors_src]:         https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/colors.rb
+[ssh_src]:            https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/ssh.rb
+[console_src]:        https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/console.rb
+[campfire_src]:       https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/campfire.rb
+[airbrake_src]:       https://github.com/fnichol/capistrano-fanfare/blob/master/lib/capistrano/fanfare/airbrake.rb
+
+[cap_assets]:     https://github.com/capistrano/capistrano/blob/master/lib/capistrano/recipes/deploy/assets.rb
+[cap_bundler]:    https://github.com/carlhuda/bundler/blob/master/lib/bundler/capistrano.rb
+[cap_multistage]: https://github.com/capistrano/capistrano/blob/master/lib/capistrano/ext/multistage.rb
+[github_spring]:  https://github.com/blog/470-deployment-script-spring-cleaning
+[license]:        https://github.com/fnichol/capistrano-fanfare/blob/master/LICENSE
+
+[fnichol]:      https://github.com/fnichol
+[repo]:         https://github.com/fnichol/capistrano-fanfare
+[issues]:       https://github.com/fnichol/capistrano-fanfare/issues
+[contributors]: https://github.com/fnichol/capistrano-fanfare/contributors

data/lib/capistrano/fanfare/bundler.rb

@@ -45,8 +45,6 @@ module Capistrano::Fanfare::Bundler
 
       require 'bundler/capistrano'
 
-      set(:rake) { "rake" }
-
       # =========================================================================
       # These are the tasks that are available to help with deploying web apps.
       # You can have cap give you a summary of them with `cap -T'.

data/lib/capistrano/fanfare/defaults.rb

@@ -9,13 +9,21 @@ module Capistrano::Fanfare::Defaults
       set(:branch)      { ENV['BRANCH'] ? ENV['BRANCH'] : "master" }
       set(:deploy_to)   { "/srv/#{application}_#{deploy_env}" }
       set :ssh_options, { :forward_agent => true }
-      set :os_types,    [:darwin, :linux, :sunos]
+      set :os_types,    [:darwin, :linux, :sunos, :mswin]
       set(:os_type)     { capture("uname -s").chomp.downcase.to_sym }
 
       set :shared_children, %w{public/system log tmp/pids tmp/sockets tmp/sessions}
 
       default_run_options[:pty] = true
 
+      on :load do
+        if exists?(:foreman_cmd)        # foreman recipe has been loaded
+          set :rake, "#{fetch(:foreman_cmd)} run rake"
+        elsif exists?(:bundle_shebang)  # bundler recipe has been loaded
+          set :rake, "rake"
+        end
+      end
+
       ##
       # Determines deployment environment or run mode to help database naming,
       # deploy directories, etc.

data/lib/capistrano/fanfare/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Fanfare
-    VERSION = "0.0.18"
+    VERSION = "0.0.19"
   end
 end

data/spec/bundler_spec.rb

@@ -52,10 +52,6 @@ load Gem.bin_path('bundler', 'bundle')
       BINSTUB
     end
 
-    it "sets :rake to 'rake'" do
-      @config.fetch(:rake).must_equal "rake"
-    end
-
     describe ":bundle_flags" do
       after do
         ENV.delete('QUIET')

data/spec/defaults_spec.rb

@@ -2,6 +2,8 @@ require 'minitest/autorun'
 require 'minitest/capistrano'
 require 'capistrano/fanfare'
 require 'capistrano/fanfare/defaults'
+require 'capistrano/fanfare/bundler'
+require 'capistrano/fanfare/foreman'
 
 describe Capistrano::Fanfare::Defaults do
   before do
@@ -111,7 +113,7 @@ describe Capistrano::Fanfare::Defaults do
   end
 
   it "sets :os_types to a list of OSes" do
-    @config.fetch(:os_types).must_equal [:darwin, :linux, :sunos]
+    @config.fetch(:os_types).must_equal [:darwin, :linux, :sunos, :mswin]
   end
 
   describe ":os_type" do
@@ -139,6 +141,30 @@ describe Capistrano::Fanfare::Defaults do
       must_equal %w{public/system log tmp/pids tmp/sockets tmp/sessions}
   end
 
+  it "sets :rake to 'rake' if bundler recipe is loaded" do
+    Capistrano::Fanfare::Bundler.load_into(@config)
+    @config.trigger(:load)
+
+    @config.fetch(:rake).must_equal "rake"
+  end
+
+  it "sets :rake to 'foreman run rake' if foreman recipe is loaded" do
+    Capistrano::Fanfare::Foreman.load_into(@config)
+    @config.set :foreman_cmd, "da/foreman"
+    @config.trigger(:load)
+
+    @config.fetch(:rake).must_equal "da/foreman run rake"
+  end
+
+  it "sets :rake to 'foreman run rake' if foreman and bundler recipes are loaded" do
+    Capistrano::Fanfare::Foreman.load_into(@config)
+    Capistrano::Fanfare::Bundler.load_into(@config)
+    @config.set :foreman_cmd, "fman"
+    @config.trigger(:load)
+
+    @config.fetch(:rake).must_equal "fman run rake"
+  end
+
   describe "for :deploy namespace" do
     describe "task :cold" do
       before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-fanfare
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-25 00:00:00.000000000 Z
+date: 2012-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &2165100220 !ruby/object:Gem::Requirement
+  requirement: &70314802799240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.11.1
   type: :runtime
   prerelease: false
-  version_requirements: *2165100220
+  version_requirements: *70314802799240
 - !ruby/object:Gem::Dependency
   name: capistrano_colors
-  requirement: &2165099620 !ruby/object:Gem::Requirement
+  requirement: &70314802798680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2165099620
+  version_requirements: *70314802798680
 - !ruby/object:Gem::Dependency
   name: sushi
-  requirement: &2165098740 !ruby/object:Gem::Requirement
+  requirement: &70314802798100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2165098740
+  version_requirements: *70314802798100
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2165098240 !ruby/object:Gem::Requirement
+  requirement: &70314802797500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.11.2
   type: :development
   prerelease: false
-  version_requirements: *2165098240
+  version_requirements: *70314802797500
 - !ruby/object:Gem::Dependency
   name: minitest-capistrano
-  requirement: &2165097720 !ruby/object:Gem::Requirement
+  requirement: &70314802797000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.0'
   type: :development
   prerelease: false
-  version_requirements: *2165097720
+  version_requirements: *70314802797000
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &2165097100 !ruby/object:Gem::Requirement
+  requirement: &70314802796240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *2165097100
+  version_requirements: *70314802796240
 description: Capistrano recipes (with full test suite) for fanfare application deployment
   framework
 email:
@@ -146,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2698498875532362211
+      hash: 3042953069069299639
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -155,10 +155,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2698498875532362211
+      hash: 3042953069069299639
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Capistrano recipes (with full test suite) for fanfare application deployment