capistrano-psw 1.0.0.pre5 → 1.0.0.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48d2c344f620b4ae02802db0043b4cd107f4cf5d
-  data.tar.gz: 678bfc8d223f9c5f79bcdba8dbd9309c34936472
+  metadata.gz: cc10b5622674ae3323a5136fccfa43120186422a
+  data.tar.gz: 264b6d4fcdc320c2f82ae0d1c266c0299bad98fd
 SHA512:
-  metadata.gz: 6caf23b698fb936c13ef4d615bdf0368bb3feedf04121c87f89f03169c6ce7852dbfbcb76a9bbc79821d4f7bea274165ca6f1d331c0460cb09052b547e7bd7b6
-  data.tar.gz: 2249806a01337d04102bac6565a9882500c0f0f0b7d3ac5b73bf34116dcdfd6caf37a33b3d6c0d76e1dcb2fb1c26183f556c5101d874fb1875bfacc46a5095f4
+  metadata.gz: 212bcf427877757ee04341e0ae3d3c8d10b744b065e37e0a028151e3cf61d4dc8fab952ff4e1bf9e4661911f11d02407d02ddcf93f545734a187129b22e61fe8
+  data.tar.gz: 9e4f03b7d9869e389fb9810a5ff6045c01cee5c9284e1f0f881e8203c9942d7fb778a539d3b4e8f43a24d6691bdc9273e0a46b0924c15abc81ab21b3a24edc24

data/README.md

@@ -132,6 +132,34 @@ still points to the last run (otherwise the PID files won't exist)
 ### psw_sidekiq:restart
 Executes the following tasks:  stop, start
 
+## Clockwork-related Tasks
+These tasks provides controls for clockwork (https://github.com/tomykaira/clockwork/), by providing 
+mechanisms to stop, start, and restart associated clockwork servers.  Unfortunately the standard daemon 
+engine for clockwork, clockworkd (https://github.com/arufanov/Clockworkd), doesn't support Capistrano 
+v3, so this serves as a replacement.
+
+These tasks require that the 'daemon' packaged be installed on the executing system.  On Ubuntu,
+# this can be installed by executing the following command:  sudo apt-get install daemon
+
+### psw_clockwork:start
+Starts a clockwork server.
+
+```ruby
+before :'psw_clockwork:stop', :set_clockwork_options do  
+  set :psw_clockwork_log_file, "#{fetch(:current_path)}/log/clockwork.log"
+  set :psw_clockwork_pid_file, "#{fetch(:current_path)}/tmp/pids/clockwork.pid"
+  set :psw_clockwork_config_file, "config/clockwork.rb"
+end
+```
+
+### psw_clockwork:stop
+Stops all known clockwork servers (by reviewing the PID files in the 'current' deployment).  It 
+should be noted that this task should run as a'before' hook, so that the 'current' directory 
+still points to the last run (otherwise the PID files won't exist)
+
+### psw_clockwork:restart
+Executes the following tasks:  stop, start
+
 ## License
 
 2013 Lexmark International Technology S.A.  All rights reserved.

data/lib/capistrano/psw/version.rb

@@ -10,6 +10,6 @@
 
 module Capistrano
   module Psw
-    VERSION = "1.0.0.pre5"
+    VERSION = "1.0.0.pre6"
   end
 end

data/resources/lib/capistrano/tasks/psw-clockwork.cap

@@ -0,0 +1,99 @@
+# == psw-clockwork.cap
+#
+# These tasks provides controls for clockwork (https://github.com/tomykaira/clockwork/), by providing
+# mechanisms to stop, start, and restart associated clockwork servers.  Unfortunately the standard daemon
+# engine for clockwork, clockworkd (https://github.com/arufanov/Clockworkd), doesn't support Capistrano 
+# v3, so this serves as a replacement.
+#
+# Note:  These tasks require that the 'daemon' packaged be installed on the executing system.  On Ubuntu,
+# this can be installed by executing the following command:  sudo apt-get install daemon
+#
+# == Configuration
+# The following configuration options may be set (should be set before the 'stop' task is executed):
+#
+# before :'psw_clockwork:stop', :set_clockwork_options do  
+#   set :psw_clockwork_log_file, "#{fetch(:current_path)}/log/clockwork.log"
+#   set :psw_clockwork_pid_file, "#{fetch(:current_path)}/tmp/pids/clockwork.pid"
+#   set :psw_clockwork_config_file, "config/clockwork.rb"
+# end
+#
+# * psw_clockwork_log_file
+# ** Defines (absolutely) the log file that will be written.
+# ** Default Value:  #{fetch(:current_path)}/log/clockwork.log
+# * psw_clockwork_pid_file
+# ** Defines (absolutely) the PID file that will be written.
+# ** Default Value:  #{fetch(:current_path)}/tmp/pids/clockwork.pid
+# * psw_clockwork_config_file
+# ** Defines (relative to project root), the configuration file that will be used.
+# ** Default Value:  config/clockwork.rb
+#
+# == Tasks
+#
+# === psw_clockwork:start
+# Starts a clockwork server.
+#
+# === psw_clockwork:stop
+# Stops all known clockwork servers (by reviewing the PID files in the 'current' deployment).  It
+# should be noted that this task should run as a'before' hook, so that the 'current' directory
+# still points to the last run (otherwise the PID files won't exist)
+#
+# === psw_clockwork:restart
+# Executes the following tasks:  stop, start
+#
+# == Contact
+#
+# Author::    Lexmark International Technology S.A.
+# Copyright:: 2013 Lexmark International Technology S.A.  All rights reserved.
+# License::   3-Clause BSD
+
+namespace :psw_clockwork do
+
+  def rails_env
+    fetch(:rails_env, false) ? "RAILS_ENV=#{fetch(:rails_env)}" : ''
+  end
+
+  def current_path
+    fetch(:current_path, '')
+  end  
+
+  def log_file
+    fetch(:psw_clockwork_log_file, "#{current_path}/log/clockwork.log")
+  end
+
+  def pid_file
+    fetch(:psw_clockwork_pid_file, "#{current_path}/tmp/pids/clockwork.pid")
+  end
+
+  def config_file
+    fetch(:psw_clockwork_config_file, "config/clockwork.rb")
+  end
+
+  desc "Start clockwork server(s)..."
+  task :start do
+    on roles(:all) do |host|  
+      info "Preparing to start clockwork server(s)..."      
+      execute "daemon --inherit --name=clockwork --env='#{rails_env}' --output=#{log_file} --pidfile=#{pid_file} -D #{current_path} -- bundle exec clockwork #{config_file}"
+      info "Finished starting all clockwork server(s)"
+    end
+  end
+   
+  desc "Stop clockwork server(s)..."
+  task :stop do
+    on roles(:all) do |host|
+      info "Looking for any running clockwork server(s)..."
+      execute "if [ -d #{current_path} ] && [ -f #{pid_file} ]; then cd #{current_path} && kill -INT `cat #{pid_file}` ; fi"
+      info "Finished stopping all clockwork server(s)"
+    end
+  end
+
+  desc "Restart any clockwork server(s)..."
+  task :restart do
+    #force a re-execution
+    Rake::Task['psw_clockwork:stop'].reenable
+    invoke :'psw_clockwork:stop'
+
+    #force a re-execution
+    Rake::Task['psw_clockwork:start'].reenable
+    invoke :'psw_clockwork:start'      
+  end 
+end

data/spec/psw-clockwork_spec.rb

@@ -0,0 +1,50 @@
+require "rake"
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+
+describe "psw_clockwork:" do
+  describe "restart" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_clockwork:restart"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-clockwork.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end
+
+  describe "start" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_clockwork:start"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-clockwork.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end  
+
+  describe "stop" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_clockwork:stop"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-clockwork.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end   
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-psw
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre5
+  version: 1.0.0.pre6
 platform: ruby
 authors:
 - Lexmark International Technology S.A
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,8 +85,10 @@ files:
 - lib/capistrano/psw.rb
 - lib/capistrano/psw/task_loader.rb
 - lib/capistrano/psw/version.rb
+- resources/lib/capistrano/tasks/psw-clockwork.cap
 - resources/lib/capistrano/tasks/psw-repo.cap
 - resources/lib/capistrano/tasks/psw-sidekiq.cap
+- spec/psw-clockwork_spec.rb
 - spec/psw-repo_spec.rb
 - spec/psw-sidekiq_spec.rb
 - spec/spec_helper.rb
@@ -116,6 +118,7 @@ signing_key:
 specification_version: 4
 summary: Contains Capistrano v3 Deployment Tasks
 test_files:
+- spec/psw-clockwork_spec.rb
 - spec/psw-repo_spec.rb
 - spec/psw-sidekiq_spec.rb
 - spec/spec_helper.rb