capistrano-helpers 0.7.1 → 0.7.2

data/CHANGELOG.markdown

@@ -5,6 +5,12 @@ Fixed:
 * Campfire notifications were broken. Updated for new API, use git names for announcements.
 * Force a chown of vendor/bundler, since building gems sometimes doesn't preserve group permissions.
   Hopefully there will be a fix for this someday so we can avoid this workaround.
+* Only require tinder gem when using campfire helper, to reduce size of installation.
+
+Added:
+
+* Growl notification helper
+* Ding notifier
 
 ## 0.5.7
 

data/README.rdoc

@@ -1,6 +1,6 @@
 = capistrano-helpers
 
-A set of optional extensions to capistrano to make common tasks easier and 
+A set of optional extensions to capistrano to make common tasks easier and
 reduce redundancy across your deployments.
 
 == Usage
@@ -42,14 +42,22 @@ Automatically runs "bundle install --deployment" to install gems from your Gemfi
 
 === campfire
 
-After the application has been deployed, this helper will post a message to 
-the given campfire room stating the username, the application, the branch/tag,
-and the environment. E.g.:
+Once the deploy is complete, this helper will post a message to the given
+Campfire room stating the username, the application, the branch/tag and the
+environment. E.g.:
 
-  Scott Woods just deployed myapp v0.5.4 to staging
+  Scott Woods finished deploying myapp v0.5.4 to staging
 
-This helper expects to find a configuration file config/campfire.yml or ~/.campfire.yml 
-with the following format:
+By default, it will only post when the deploy is complete. If you'd also
+like it to post when the deploy begins, you can add the following line
+to your deploy script:
+
+  before "deploy", "deploy:post_to_campfire_before"
+
+You will need to install the tinder gem to enable campfire notifications.  Run
+<tt>sudo gem install tinder</tt>, or add <tt>gem 'tinder'</tt> to your Gemfile.
+This helper expects to find a configuration file config/campfire.yml or
+~/.campfire.yml with the following format:
 
   # Configuration for posting to campfire.
   subdomain: mycompany
@@ -60,23 +68,42 @@ You can override the location of the configuration file by setting the
 :campfire_config variable:
 
   set :campfire_config, 'somewhere/else.yml'
-  
+
+You can disable the notification for a specific deployment stage by setting
+the :campfire_notifications variable to false.
+E.g. in config/deploy/staging:
+
+  set :campfire_notifications, false
+
+=== ding
+
+Once the deploy is complete, this helper will play a 'ding' sound (Mac only).
+
 === features
 
 Before the app is deployed, this helper checks out the branch/tag that is
 being deployed and runs all the cucumber features, ensuring that they all
 pass.
 
-== gems
+=== gems
 
 Run the gems:install rake task using sudo after deployment.
 
-== git
+=== git
 
 Set git as the repository type, and set up remote caching to speed up
 deployments.
 
-== migrations
+=== growl
+
+Once the deploy is complete, this helper will post a message to Growl stating
+the application, the branch/tag and the environment. E.g.:
+
+  capistrano
+
+  finished deploying myapp v0.5.4 to staging
+
+=== migrations
 
 Always run migrations during deployment.
 
@@ -144,7 +171,7 @@ and this helper insures they exist. Remember to run this *after* the rest of you
 
 This works much like the shared helper above, except the symbolic link will
 point to the same path under "shared/private" on the server. This allows you
-to set special permissions on that directory for keeping particularly 
+to set special permissions on that directory for keeping particularly
 sensitive files safe, such as those that contain passwords or encryption keys.
 
 After requiring this helper, set the paths to be symlinked using the
@@ -154,7 +181,7 @@ After requiring this helper, set the paths to be symlinked using the
     config/database.yml
     config/session_secret.txt
   }
-  
+
 This will create two symbolic links on the production server:
 
   #{release_path}/config/database.yml -> #{shared_path}/private/config/database.yml
@@ -165,6 +192,11 @@ This will create two symbolic links on the production server:
 Before the app is deployed, this helper checks out the branch/tag that is
 being deployed and runs all the rspec specs, ensuring that they all pass.
 
+=== unicorn
+
+Overrides the default :restart task so that it's compatible with restarting
+unicorn.
+
 === version
 
 Creates a VERSION file in the deployed copy that contains the name of the

data/Rakefile

@@ -9,10 +9,9 @@ begin
     gem.description = %Q{A set of optional extensions to capistrano to make common tasks easier.}
     gem.email = "team@westarete.com"
     gem.homepage = "http://github.com/westarete/capistrano-helpers"
-    gem.authors = ["Scott Woods", "Clinton Judy"]
-    gem.add_dependency('capistrano')
+    gem.authors = ["Scott Woods"]
+    gem.add_dependency('capistrano', '~> 2.0')
     gem.add_dependency('git')
-    gem.add_dependency('tinder')
   end
 
 rescue LoadError
@@ -41,7 +40,7 @@ end
 
 task :default => :test
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION.yml')
     config = YAML.load(File.read('VERSION.yml'))

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.7.2

data/capistrano-helpers.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{capistrano-helpers}
-  s.version = "0.7.1"
+  s.name = "capistrano-helpers"
+  s.version = "0.7.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Scott Woods", "Clinton Judy"]
-  s.date = %q{2012-04-16}
-  s.description = %q{A set of optional extensions to capistrano to make common tasks easier.}
-  s.email = %q{team@westarete.com}
+  s.authors = ["Scott Woods"]
+  s.date = "2013-11-06"
+  s.description = "A set of optional extensions to capistrano to make common tasks easier."
+  s.email = "team@westarete.com"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
@@ -39,31 +39,28 @@ Gem::Specification.new do |s|
     "lib/capistrano-helpers/shared.rb",
     "lib/capistrano-helpers/skylinecms.rb",
     "lib/capistrano-helpers/specs.rb",
+    "lib/capistrano-helpers/unicorn.rb",
     "lib/capistrano-helpers/version.rb",
     "test/test_helper.rb"
   ]
-  s.homepage = %q{http://github.com/westarete/capistrano-helpers}
+  s.homepage = "http://github.com/westarete/capistrano-helpers"
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{A set of optional extensions to capistrano to make common tasks easier.}
+  s.rubygems_version = "1.8.24"
+  s.summary = "A set of optional extensions to capistrano to make common tasks easier."
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<capistrano>, [">= 0"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, ["~> 2.0"])
       s.add_runtime_dependency(%q<git>, [">= 0"])
-      s.add_runtime_dependency(%q<tinder>, [">= 0"])
     else
-      s.add_dependency(%q<capistrano>, [">= 0"])
+      s.add_dependency(%q<capistrano>, ["~> 2.0"])
       s.add_dependency(%q<git>, [">= 0"])
-      s.add_dependency(%q<tinder>, [">= 0"])
     end
   else
-    s.add_dependency(%q<capistrano>, [">= 0"])
+    s.add_dependency(%q<capistrano>, ["~> 2.0"])
     s.add_dependency(%q<git>, [">= 0"])
-    s.add_dependency(%q<tinder>, [">= 0"])
   end
 end
 

data/lib/capistrano-helpers/campfire.rb

@@ -1,34 +1,44 @@
 require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
 
-require 'tinder'
+begin
+  require 'tinder'
+rescue LoadError
+  raise RuntimeError, "tinder gem required for Campfire deploy notifications.  Run `sudo gem install tinder`, or add `gem 'tinder'` to your Gemfile."
+end
+
 require 'git'
 
 CapistranoHelpers.with_configuration do
 
   namespace :deploy do
-    desc 'Make a post to campfire to tell everyone about this deployment.'
+    desc "Post to campfire that this deployment is complete"
+    task :post_to_campfire_after do
+      post_to_campfire(:after)
+    end
+
+    desc "Post to campfire that this deployment has begun"
     task :post_to_campfire_before do
-      config_file = [fetch(:campfire_config, 'config/campfire.yml'), "#{ENV['HOME']}/.campfire.yml"].detect { |f| File.readable?(f) }
-      if config_file.nil?
-         puts "Could not find a campfire configuration. Skipping campfire notification."
+      post_to_campfire(:before)
+    end
+
+    def post_to_campfire(hook=:before)
+      case hook
+      when :before
+        action = 'started deploying'
+      when :after
+        action = 'finished deploying'
       else
-        if ! exists?(:application)
-          puts "You should set :application to the name of this app."
-        end
-        git_config = Git.open('.').config rescue {}
-        someone = ENV['GIT_AUTHOR_NAME'] || git_config['user.name'] || `whoami`.strip
-        target = fetch(:stage, 'production')
-        config = YAML::load_file(config_file)
-        campfire = Tinder::Campfire.new(config['subdomain'], :token => config['token'])
-        room = campfire.find_room_by_name(config['room'])
-        room.speak("#{someone} started deploying #{application} #{branch} to #{target}")
+        return
       end
-    end
 
-    task :post_to_campfire_after do
+      # If the :branch reference is a full SHA1, display it in its abbreviated form
+      campfire_branch = fetch(:branch).sub(/\b([a-f0-9]{7})[a-f0-9]{33}\b/, '\1')
+
       config_file = [fetch(:campfire_config, 'config/campfire.yml'), "#{ENV['HOME']}/.campfire.yml"].detect { |f| File.readable?(f) }
       if config_file.nil?
-         puts "Could not find a campfire configuration. Skipping campfire notification."
+        puts "Could not find a campfire configuration. Skipping campfire notification."
+      elsif fetch(:campfire_notifications, true) == false
+        # Campfire notifications are disabled, nothing to do
       else
         if ! exists?(:application)
           puts "You should set :application to the name of this app."
@@ -39,11 +49,11 @@ CapistranoHelpers.with_configuration do
         config = YAML::load_file(config_file)
         campfire = Tinder::Campfire.new(config['subdomain'], :token => config['token'])
         room = campfire.find_room_by_name(config['room'])
-        room.speak("#{someone} finished deploying #{application} #{branch} to #{target}")
+        room.speak("#{someone} #{action} #{application} #{campfire_branch} to #{target}")
       end
     end
   end
+
   after "deploy:restart", "deploy:post_to_campfire_after"
-  before "deploy", "deploy:post_to_campfire_before"
 
 end

data/lib/capistrano-helpers/privates.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
 
 CapistranoHelpers.with_configuration do
- 
+
   namespace :deploy do
     desc 'Replace named files with a symlink to their counterparts in shared/private/'
     task :symlink_privates do
@@ -15,8 +15,17 @@ CapistranoHelpers.with_configuration do
         run "rm -rf #{release_path}/#{path} && ln -nfs #{shared_path}/private/#{path} #{release_path}/#{path}"
       end
     end
+
+    desc '[internal] Create a private directory in shared'
+    task :create_private_dir do
+      private_dir = 'private'
+      private_path = File.join(shared_path, private_dir)
+      run "#{try_sudo} mkdir -p #{private_path}"
+      run "#{try_sudo} chmod o-rwx #{private_path}"
+    end
   end
 
   before "deploy:finalize_update", "deploy:symlink_privates"
+  after "deploy:setup", "deploy:create_private_dir"
 
-end
+end

data/lib/capistrano-helpers/specs.rb

@@ -6,7 +6,7 @@ CapistranoHelpers.with_configuration do
   namespace :deploy do
     desc "Make sure all specs pass"
     task :check_specs do
-      if scm != 'git'
+      if scm.to_sym != :git
         abort "Sorry, you can only check specs if you're using git as your scm."
       end
       `git branch` =~ /^\* ([^\s]+)/ or abort "Couldn't understand the output of `git branch`."
@@ -30,4 +30,4 @@ CapistranoHelpers.with_configuration do
 
   before "deploy:update_code", "deploy:check_specs"
 
-end
+end

data/lib/capistrano-helpers/unicorn.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../capistrano-helpers' if ! defined?(CapistranoHelpers)
+
+CapistranoHelpers.with_configuration do
+
+  namespace :unicorn do
+    desc "Restart unicorn"
+    task :restart, :roles => :web, :except => { :no_release => true } do
+      run "oldpid=$(cat /var/www/#{application}/#{stage}/shared/pids/unicorn.pid) && kill -s USR2 $oldpid && echo 'Searching for newly spawned master process...' && until (pid=$(cat /var/www/#{application}/#{stage}/shared/pids/unicorn.pid 2>/dev/null) && test '$pid' != '$oldpid' && ps x |grep $pid|grep master) ; do sleep 1 ; done && kill -s WINCH $oldpid && kill -s QUIT $oldpid"
+    end
+  end
+  after "deploy:restart", "unicorn:restart"
+
+end

metadata

@@ -1,69 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: capistrano-helpers
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 7
-  - 1
-  version: 0.7.1
+version: !ruby/object:Gem::Version
+  version: 0.7.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Scott Woods
-- Clinton Judy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-09 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: capistrano
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: git
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: tinder
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id003
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A set of optional extensions to capistrano to make common tasks easier.
 email: team@westarete.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - .document
 - CHANGELOG.markdown
 - LICENSE
@@ -86,37 +73,32 @@ files:
 - lib/capistrano-helpers/shared.rb
 - lib/capistrano-helpers/skylinecms.rb
 - lib/capistrano-helpers/specs.rb
+- lib/capistrano-helpers/unicorn.rb
 - lib/capistrano-helpers/version.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/westarete/capistrano-helpers
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+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.3.6
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A set of optional extensions to capistrano to make common tasks easier.
 test_files: []
-
+has_rdoc: