capistrano-relevance 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-relevance.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Relevance
+
+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,152 @@
+# Capistrano::Relevance
+
+A collection of commonly-used (default) Capistrano recipes for Rails projects at [Relevance](http://thinkrelevance.com).
+
+
+## Installation
+
+Add these lines to the Gemfile in your Rails application:
+
+```ruby
+group :deployment do
+  gem 'capistrano', :git => 'git://github.com/capistrano/capistrano', :ref => 'b31e2f5'
+  gem 'capistrano-relevance'
+end
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+**Note**: You will notice that we rely on a specific revision of Capistrano in the `Gemfile` above. (Weird, right?)
+At the time of this writing, Capistrano 2.13.4 is the latest *released* version;
+however, 2.13.4 hardcoded the SCM to `:subversion`, which caused a problem for `capistrano-relevance`.
+[Pull request 223](https://github.com/capistrano/capistrano/pull/233) addresses this issue.
+`b31e2f5` is the last commit from that pull request, so `capistrano-relevance` needs to depend on that commit until a new version of Capistrano is released (e.g., 2.13.4.1 or 2.13.5).
+
+
+## Usage
+
+After installing `capistrano-relevance` as described above, you are ready to set up your Capistrano deployment. First, you need to `capify` your app:
+
+    bundle exec capify .
+
+From here, there are two ways that you can use `capistrano-relevance`:
+
+1. Use the [default set of recipes](https://github.com/relevance/capistrano-relevance/blob/master/lib/capistrano/relevance/all.rb), or
+2. Use a customized set of recipes.
+
+We'll first walk through the process for using the default set of recipes.
+From there, it's easy for you pick and choose a different set of recipes.
+
+
+### Using the default set of recipes
+
+#### Configuring deploy.rb
+
+To use the `capistrano-relevance` recipes, you will edit your `config/deploy.rb` file to require the `capistrano-relevance` recipes.
+You will also define a few additional required settings.
+
+Here is an example file that is ready for use with `capistrano-relevance`:
+
+```ruby
+require 'bundler/capistrano'
+require 'capistrano/relevance/all'
+
+set :application, "your_app_name"
+set :repository,  "git://github.com/username/your_app_name"
+
+role :web, "your_app_name.example.com"
+role :app, "your_app_name.example.com"
+role :db,  "your_app_name.example.com", :primary => true
+```
+
+#### Noteworthy Assumptions
+
+By default, `capistrano-relevance` [expects](https://github.com/relevance/capistrano-relevance/blob/master/lib/capistrano/relevance/common.rb) to deploy as the following user in the following location:
+
+```ruby
+set :user, 'deploy'
+set(:deploy_to) { "/var/www/apps/#{application}" }
+```
+
+If your server uses a different user, or deploys in a different location, you can override these settings. For example:
+
+```ruby
+require 'bundler/capistrano'
+require 'capistrano/relevance/all'
+
+set :user, 'apptastic'
+set(:deploy_to) { "/home/apptastic/apps/#{application}" }
+
+# other settings here ...
+```
+
+#### Deploying
+
+Now you're ready to start deploying your app to your server.
+You need to create the directory structure that Capistrano expects and place your database configuration on the server.
+Best practices (TM) discourage you from checking in any database credentials into your Git repo.
+Instead, you can create a `database.yml` file on your target server.
+
+```sh
+bundle exec cap deploy:setup
+
+ssh deploy@your_app_name.example.com
+
+# Create the the directory where you will store your shared configuration.
+# If you are using a custom :deploy_to value, you should customize this command accordingly.
+mkdir /var/www/apps/[YOUR-APP-NAME]/shared/config
+
+# Add production settings for your database
+vim /var/www/apps/[YOUR-APP-NAME]/shared/config/database.yml
+
+# We're done messing around on the server; let's get outta here
+exit
+```
+
+Now it's time to deploy your Rails app to the server.
+Since this is the first time you've deployed this app to the server, you'll need to run a special Capistrano command that does slightly more work than a bare deploy.
+
+```sh
+bundle exec cap deploy:cold
+```
+
+Congratulations! You should be able to visit `your_app_name.example.com` using your favorite browser and see the application up and running.
+
+For subsequent deploys, you can simply run:
+
+```sh
+bundle exec cap deploy
+```
+
+## Use a customized set of recipes
+
+When you require `capistrano/relevance/all` in your `deploy.rb` file, it includes the [default set of recipes](https://github.com/relevance/capistrano-relevance/blob/master/lib/capistrano/relevance/all.rb).
+If you need something other than the default set of recipes, you can include a customized set of recipes for your app.
+To do so, edit your `deploy.rb` file, and replace this line ...
+
+```ruby
+require 'capistrano/relevance/all'
+```
+
+... with the specific set of recipes you want to use in your app.
+
+For example, imagine that you're using Unicorn instead of Passenger. You might want to include all recipes *except* the Passenger recipe.
+
+```ruby
+require 'capistrano/relevance/common'
+require 'capistrano/relevance/migrate_after_update_code'
+require 'capistrano/relevance/symlink_configs'
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-relevance.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/relevance/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-relevance"
+  gem.version       = Capistrano::Relevance::VERSION
+  gem.authors       = ["Yoko Harada and Jason Rudolph"]
+  gem.email         = ["opensource@thinkrelevance.com"]
+  gem.description   = %q{A collection of default Capistrano recipes commonly used on Relevance projects}
+  gem.summary       = %q{Relevance recipes for Capistrano}
+  gem.homepage      = "https://github.com/relevance/capistrano-relevance"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  # You actually need an unreleased version of Capistrano (2.13.4.1? or 2.13.5?). See README.
+  gem.add_runtime_dependency "capistrano", "~> 2.13.4"
+end

data/lib/capistrano/relevance.rb

@@ -0,0 +1 @@
+require "capistrano/relevance/version"

data/lib/capistrano/relevance/all.rb

@@ -0,0 +1,4 @@
+require 'capistrano/relevance/common'
+require 'capistrano/relevance/migrate_after_update_code'
+require 'capistrano/relevance/passenger'
+require 'capistrano/relevance/symlink_configs'

data/lib/capistrano/relevance/base.rb

@@ -0,0 +1,3 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano requires Capistrano 2"
+end

data/lib/capistrano/relevance/common.rb

@@ -0,0 +1,12 @@
+require 'capistrano/relevance/base'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set :user, 'deploy'
+  set :use_sudo, false
+
+  set :scm, :git
+  set :deploy_via, :copy
+  set(:deploy_to) { "/var/www/apps/#{application}" }
+
+  default_run_options[:pty] = true # needed for Git password prompts
+end

data/lib/capistrano/relevance/migrate_after_update_code.rb

@@ -0,0 +1,5 @@
+require 'capistrano/relevance/base'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  after 'deploy:update_code', 'deploy:migrate'
+end

data/lib/capistrano/relevance/passenger.rb

@@ -0,0 +1,11 @@
+require 'capistrano/relevance/base'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    task :start do ; end
+    task :stop do ; end
+    task :restart, :roles => :app, :except => {:no_release => true} do
+      run "#{try_sudo} touch #{File.join(current_path, 'tmp', 'restart.txt')}"
+    end
+  end
+end

data/lib/capistrano/relevance/symlink_configs.rb

@@ -0,0 +1,16 @@
+require 'capistrano/relevance/base'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  # TODO As part of 'deploy:setup', automatically create "#{shared_path}/config"
+  # TODO As part of before 'deploy:symlink_configs', copy database.example.yml if database.yml does not exist
+
+  after 'deploy:finalize_update', 'deploy:symlink_configs'
+
+  namespace :deploy do
+    task :symlink_configs do
+      shared_configs = File.join(shared_path,'config')
+      release_configs = File.join(release_path,'config')
+      run("ln -nfs #{shared_configs}/database.yml #{release_configs}/database.yml")
+    end
+  end
+end

data/lib/capistrano/relevance/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Relevance
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-relevance
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yoko Harada and Jason Rudolph
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.4
+description: A collection of default Capistrano recipes commonly used on Relevance
+  projects
+email:
+- opensource@thinkrelevance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-relevance.gemspec
+- lib/capistrano/relevance.rb
+- lib/capistrano/relevance/all.rb
+- lib/capistrano/relevance/base.rb
+- lib/capistrano/relevance/common.rb
+- lib/capistrano/relevance/migrate_after_update_code.rb
+- lib/capistrano/relevance/passenger.rb
+- lib/capistrano/relevance/symlink_configs.rb
+- lib/capistrano/relevance/version.rb
+homepage: https://github.com/relevance/capistrano-relevance
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Relevance recipes for Capistrano
+test_files: []