capistrano-campout 0.0.1 → 0.0.2

data/README.md

@@ -11,7 +11,7 @@ post-deployment success or failure. Event sounds are also supported.
 
 ## Design goals
 
-Capistrano::Campout is insipred by and borrows concepts (and in some cases code) 
+Capistrano::Campout is inspired by and borrows concepts (and in some cases code) 
 from two projects: [capistrano-mountaintop](https://github.com/technicalpickles/capistrano-mountaintop) and [capfire](https://github.com/pjaspers/capfire). 
 
 I created my own instead of forking either for the following reasons

data/lib/capistrano-campout/core.rb

@@ -2,8 +2,13 @@
 # Copyright (c) 2012 Jason Adam Young
 # === LICENSE:
 # see LICENSE file
+
+
 module Capistrano
-  module Campout
+  module Campout    
+    class TemplateError < NameError
+    end
+
     class Core
       attr_accessor :settings, :campfire, :room
     
@@ -64,7 +69,7 @@ module Capistrano
       end
       
       def pre_announce(options = {})
-        self.speak(ERB.new(settings.pre_deploy.message).result(options[:binding]))
+        self.speak(erberize(settings.pre_deploy.message,'pre_deploy message',options[:binding]))
         if(!settings.suppress_sounds and settings.pre_deploy.play)
           self.play(settings.pre_deploy.play)
         end
@@ -72,7 +77,7 @@ module Capistrano
       end
       
       def post_announce_success(options = {})
-        message = ERB.new(settings.post_deploy_success.message).result(options[:binding])
+        message = erberize(settings.post_deploy_success.message,'post_deploy_success message',options[:binding])
         if(!settings.suppress_deploy_time and @pre_announce_time)
           message += " (#{time_period_to_s(Time.now - @pre_announce_time)})"
         end
@@ -112,7 +117,7 @@ module Capistrano
       end
       
       def post_announce_failure(options = {})
-        message = ERB.new(settings.post_deploy_failure.message).result(options[:binding])        
+        message = erberize(settings.post_deploy_failure.message,'post_deploy_failure message',options[:binding])        
         self.speak(message)
         if(!settings.suppress_sounds and settings.post_deploy_failure.play)
           self.play(settings.post_deploy_failure.play)
@@ -133,7 +138,7 @@ module Capistrano
             
       def will_do(options = {})
         puts "Before Deployment:"
-        puts "Message: #{ERB.new(settings.pre_deploy.message).result(options[:binding])}"
+        puts "Message: #{erberize(settings.pre_deploy.message,'pre_deploy message',options[:binding])}"
         if(!settings.suppress_sounds and settings.pre_deploy.play)
           puts "Will play sound: #{settings.pre_deploy.play}"
         else
@@ -142,7 +147,7 @@ module Capistrano
   
         puts "\n"
         puts "After Successful Deployment:"
-        puts "Message: #{ERB.new(settings.post_deploy_success.message).result(options[:binding])}"
+        puts "Message: #{erberize(settings.post_deploy_success.message,'post_deploy_success message',options[:binding])}"
         if(!settings.suppress_sounds and settings.post_deploy_success.play)
           puts "Will play sound: #{settings.post_deploy_success.play}"
         else
@@ -157,7 +162,7 @@ module Capistrano
         
         puts "\n"
         puts "After Failed Deployment:"
-        puts "Message: #{ERB.new(settings.post_deploy_failure.message).result(options[:binding])}"
+        puts "Message: #{erberize(settings.post_deploy_failure.message,'post_deploy_failure message',options[:binding])}"
         if(!settings.suppress_sounds and settings.post_deploy_failure.play)
           puts "Will play sound: #{settings.post_deploy_failure.play}"
         else
@@ -170,6 +175,23 @@ module Capistrano
         end
       end
       
+      def whereto(capistrano_namespace)
+        default_value =  ENV['SERVER'] || 'production'
+        capistrano_namespace.fetch(:stage,default_value)
+      end
+      
+      protected 
+      
+      
+      def erberize(string,context,binding)
+        begin
+          ERB.new(string).result(binding)
+        rescue NameError => error
+          raise TemplateError, "Your #{context} message references an undefined value: #{error.name}. Set this in your capistrano deploy script"
+        end
+      end
+        
+      
       # Takes a period of time in seconds and returns it in human-readable form (down to minutes)
       # code from http://www.postal-code.com/binarycode/2007/04/04/english-friendly-timespan/
       def time_period_to_s(time_period,abbreviated=false,defaultstring = '')

data/lib/capistrano-campout/defaults.yml

@@ -1,6 +1,22 @@
+## campfire settings
+# campfire:
+#     domain: 'your_campfire_domain'
+#     room: your_room_id
+#     token: your_campfire_token
+
+## global action settings
+# copy_log_to_server: false
+# suppress_sounds: false
+# suppress_deploy_time: false
+# suppress_github_compare: false
+
+## deployment settings
 pre_deploy:
-    message: "<%= campout_deployer %> is starting to deploy <%= application %> to <%= stage %>"
+    message: "<%= campout_deployer %> is starting to deploy <%= application %> to <%= whereto %>"
+#	 play: 'pushit'
 post_deploy_success:
-    message: "<%= campout_deployer %> deployed <%= application %> to <%= stage %>"
+    message: "<%= campout_deployer %> deployed <%= application %> to <%= whereto %>"
+#	 play: 'yeah'
 post_deploy_failure:
-    message: "The deploy of <%= application %> to <%= stage %> by <%= campout_deployer %> has failed."
+    message: "The deploy of <%= application %> to <%= whereto %> by <%= campout_deployer %> has failed."
+#	 play: 'drama'

data/lib/capistrano-campout/recipes/campout.rb

@@ -13,10 +13,12 @@ Capistrano::Configuration.instance(:must_exist).load do
     
     ## no descriptions for the following tasks - meant to be hooked by capistrano
     task :pre_announce do
+      set(:whereto,campout_core.whereto(self))
       campout_core.pre_announce(binding: binding)
     end
     
     task :post_announce_success do
+      set(:whereto,campout_core.whereto(self))
       campout_core.post_announce_success(binding: binding, 
                                          repository: repository, 
                                          previous_revision: previous_revision, 
@@ -24,17 +26,21 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
     
     task :post_announce_failure do
+      set(:whereto,campout_core.whereto(self))
       campout_core.post_announce_failure(binding: binding)
     end
     
     task :copy_log, :except => { :no_release => true} do
-      logger = Capistrano::CampoutLogger
-      run "mkdir -p #{shared_path}/deploy_logs"
-      put File.open(logger.log_file_path).read, "#{shared_path}/deploy_logs/#{logger.remote_log_file_name}"
+      if(campout_core.settings.copy_log_to_server)
+        logger = Capistrano::CampoutLogger
+        run "mkdir -p #{shared_path}/deploy_logs"
+        put File.open(logger.log_file_path).read, "#{shared_path}/deploy_logs/#{logger.remote_log_file_name}"
+      end
     end
     
     desc "Display campfire messages and actions based on current configuration"
     task :will_do do
+      set(:whereto,campout_core.whereto(self))
       campout_core.will_do(binding: binding)
     end
     

data/lib/capistrano-campout/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Campout
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-campout
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-07 00:00:00.000000000 Z
+date: 2012-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70114418631680 !ruby/object:Gem::Requirement
+  requirement: &70315888091420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.11'
   type: :runtime
   prerelease: false
-  version_requirements: *70114418631680
+  version_requirements: *70315888091420
 - !ruby/object:Gem::Dependency
   name: tinder
-  requirement: &70114418615660 !ruby/object:Gem::Requirement
+  requirement: &70315888075700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '1.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70114418615660
+  version_requirements: *70315888075700
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70114418614880 !ruby/object:Gem::Requirement
+  requirement: &70315888074660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '2.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70114418614880
+  version_requirements: *70315888074660
 description: ! "    Capistrano::Campout is a gem extension to capistrano to post/speak
   messages and paste logs from a capistrano deployment \n    to a campfire room. Settings
   are configurable using ERB in a \"config/campout.yml\" or \"config/campout.local.yml\"
@@ -62,7 +62,6 @@ files:
 - Rakefile
 - capistrano-campout.gemspec
 - lib/capistrano-campout.rb
-- lib/capistrano-campout/cap_tasks.rb
 - lib/capistrano-campout/core.rb
 - lib/capistrano-campout/deep_merge.rb
 - lib/capistrano-campout/defaults.yml

data/lib/capistrano-campout/cap_tasks.rb

@@ -1,50 +0,0 @@
-# === COPYRIGHT:
-# Copyright (c) 2012 Jason Adam Young
-# === LICENSE:
-# see LICENSE file
-
-Capistrano::Configuration.instance(:must_exist).load do
-  # Don't bother users who have capfire installed but don't have a ~/.campfire file
-
-  if Capfire.config_file_exists?
-    if Capfire.valid_config?
-      before "deploy:update_code", "capfire:check_for_push"
-      after "deploy:update_code", "capfire:post_to_campfire"
-    else
-      logger.info "Not all required keys found in your .campfire file. Please regenerate."
-    end
-  else
-    logger.info "Couldn't find a .campfire in your home directory."
-  end
-
-
-
-    desc <<-DESC
-This will post to the campfire room as specified in your ~/.campfire. \
-The message posted will contain a link to Github's excellent compare view, \
-the commiters name, the project name and the arguments supplied to cap.
-  DESC
-    task :post_to_campfire do
-      begin
-        source_repo_url = repository
-        deployed_version = previous_revision[0,7] rescue "000000"
-        local_version = `git rev-parse HEAD`[0,7]
-
-        compare_url = Capfire.github_compare_url source_repo_url, deployed_version, local_version
-        message = Capfire.deploy_message(ARGV.join(' '), compare_url, application)
-        message = `cowsay "#{message}"` if Capfire.cowsay?
-
-        if dry_run
-          logger.info "Capfire would have posted:\n#{message}"
-        else
-          Capfire.speak message
-        end
-        logger.info "Posting to Campfire"
-      rescue => e
-        # Making sure we don't make capistrano fail.
-        # Cause nothing sucks donkeyballs like not being able to deploy
-        logger.important e.message
-      end
-    end
-  end
-end