capistrano3-delayed-job 1.1.0 → 1.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 77a24920733ed73310cf1e7dc67b1d292c69be8a
-  data.tar.gz: a680cae89fee85459df187d9a7db653cd1b5a0a7
+SHA256:
+  metadata.gz: 0752a6724134a2b730dc23b8908e715ea7e28becc3e63014b2a41355d9fc39f4
+  data.tar.gz: 0200a538e00978a37c9c5a88c9cad98485deb05fbddd057f9e0e4f65def9c8e8
 SHA512:
-  metadata.gz: 5a012ebf0aac651a4c6ecfc285f18c7946d4126954c2eea861203e31b22cc7a446b50a201d3c4f8452622d4850b81028fe035804bb0aaf352376a8cc605a0b62
-  data.tar.gz: a33a1905e0f370303f0443dd009b9a54fc658b126f8be69f1195041468b60e0cf08645ca0966d8c6928d5eed8c36c18d120209905df216bac2c6f63d63740d35
+  metadata.gz: d55acc6151887e61e09ad8266f1fa3a6bf266100691e8842df6cee2d85dddd0e0426e86147c237f377175abe83bfcf90dd091d2a9de70f65a9f515a72f7c7c78
+  data.tar.gz: 53ebf37ad1879ce6127863874737065576dc524a1dff389851f866e3bb96900f955604331cbc1b92ed0c3892a11ec9329f5334d3f150bd051011b2191dc18b7c

data/.rubocop.yml

@@ -0,0 +1,56 @@
+# Should just disable for 'lib/capistrano/tasks/delayed_job.rake'
+
+Metrics/AbcSize:
+  Max: 16
+
+Metrics/MethodLength:
+  Max: 10
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/PerceivedComplexity:
+  Max: 7
+
+Metrics/LineLength:
+  Max: 120
+
+Style/FileName:
+  Exclude:
+    - 'lib/capistrano3-delayed-job.rb'
+    - 'lib/capistrano/delayed-job.rb'
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  '{}'
+    '%i': '[]'
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SpaceAfterComma:          # really want a way to allow Array(something)[-1,1]
+  Enabled: false
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/SpaceAroundOperators:
+  AllowForAlignment: true
+  Enabled: false
+
+Style/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
+  SpaceBeforeBlockParameters: false
+
+Style/UnneededPercentQ:
+  Exclude:
+    - 'capistrano3-delayed-job.gemspec'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Juan Ignacio Donoso
+Copyright (c) 2016 Platanus SpA
 
 MIT License
 

data/README.md

@@ -22,15 +22,16 @@ Or install it yourself as:
 Require in `Capfile` to use the default task:
 
 ```ruby
-require 'capistrano/delayed-job'
+require 'capistrano/delayed_job'
 ```
 
 You will get the following tasks
 
 ```ruby
-cap delayed_job:start                    # Start delayed_job service
-cap delayed_job:stop                     # Stop delayed_job service
-cap delayed_job:reload                   # Reload delayed_job service
+cap delayed_job:restart  # Restart the delayed_job process
+cap delayed_job:start    # Start the delayed_job process
+cap delayed_job:status   # Status of the delayed_job process
+cap delayed_job:stop     # Stop the delayed_job process
 ```
 
 Configurable options (copy into deploy.rb), shown here with examples:
@@ -40,19 +41,68 @@ Configurable options (copy into deploy.rb), shown here with examples:
 # default value: 1
 set :delayed_job_workers, 2
 
+# String to be prefixed to worker process names
+# This feature allows a prefix name to be placed in front of the process.
+# For example:  reports/delayed_job.0  instead of just delayed_job.0
+set :delayed_job_prefix, 'reports'
+
 # Delayed_job queue or queues
 # Set the --queue or --queues option to work from a particular queue.
 # default value: nil
 set :delayed_job_queues, ['mailer','tracking']
 
 # Specify different pools
-# You can use this option multiple times to start different numbers of workers for different queues.
+# You can use this option multiple times to start different numbers of workers
+# for different queues.
+# NOTE: When using delayed_job_pools, the settings for delayed_job_workers and
+# delayed_job_queues are ignored.
 # default value: nil
-set :delayed_job_pool, {
-    :mailer => 2,
-    :tracking => 1,
-    :* => 2
-}
+#
+# Single pool of 3 workers looking at all queues: (when alone, '*' is a
+# special case meaning any queue)
+# set :delayed_job_pools, { '*' => 3 }
+# set :delayed_job_pools, { '' => 3 }
+# set :delayed_job_pools, { nil => 3 }
+#
+# Several queues, some with their own dedicated pools: (symbol keys will be
+# converted to strings)
+# set :delayed_job_pools, {
+#     :mailer => 2,    # 2 workers looking only at the 'mailer' queue
+#     :tracking => 1,  # 1 worker exclusively for the 'tracking' queue
+#     :* => 2          # 2 on any queue (including 'mailer' and 'tracking')
+# }
+#
+# Several workers each handling one or more queues:
+# set :delayed_job_pools, {
+#     'high_priority' => 1,                # one just for the important stuff
+#     'high_priority,*' => 1,              # never blocked by low_priority jobs
+#     'high_priority,*,low_priority' => 1, # works on whatever is available
+#     '*,low_priority' => 1,  # high_priority doesn't starve the little guys
+#   }
+
+# If you have several servers handling Delayed Jobs and you want to configure
+# different pools per server, you can define delayed_job_pools_per_server:
+#
+# set :delayed_job_pools_per_server, {
+#   'server11-prod' => {
+#     'default,emails' => 3,
+#     'loud_notifications' => 1,
+#     'silent_notifications' => 1,
+#   },
+#   'server12-prod' => {
+#     'default' => 2
+#   }
+# }
+
+# Server names (server11-prod, server12-prod) in :delayed_job_pools_per_server
+# must match the hostnames on Delayed Job servers. You can verify it by running
+# `hostname` on your servers.
+
+# If you use :delayed_job_pools_per_server, :delayed_job_pools will be ignored.
+
+# Identification is assigned in order 0..3.
+# Note that the '*' in this case is actually a queue with that name and does
+# not mean any queue as it is not used alone, but alongside other queues.
 
 # Set the roles where the delayed_job process should be started
 # default value: :app
@@ -60,16 +110,57 @@ set :delayed_job_roles, [:app, :background]
 
 # Set the location of the delayed_job executable
 # Can be relative to the release_path or absolute
-# default value 'bin'
-set :delayed_job_bin_path: 'scripts' # for rails 3.x
+# default value: 'bin'
+# set :delayed_job_bin_path, 'script' # for rails 3.x
+
+# To pass the `-m` option to the delayed_job executable which will cause each
+# worker to be monitored when daemonized.
+# set :delayed_job_monitor, true
+
+### Set the location of the delayed_job.log logfile
+# default value: "#{Rails.root}/log" or "#{Dir.pwd}/log"
+# set :delayed_log_dir, 'path_to_log_dir'
+
+### Set the location of the delayed_job pid file(s)
+# default value: "#{Rails.root}/tmp/pids" or "#{Dir.pwd}/tmp/pids"
+# set :delayed_job_pid_dir, 'path_to_pid_dir'
+
+### Set the options to be passed along to daemons when starting/stopping/restarting delayed_job workers
+# options supported by daemons can be found at https://github.com/thuehlinger/daemons/blob/master/lib/daemons/cmdline.rb
+# set :delayed_job_daemon_opts, ["no_wait", "shush"]
+```
+
+It also conditionally adds the following hook:
+
+```ruby
+  if Rake::Task.task_defined?('deploy:published')
+    after 'deploy:published', 'delayed_job:default'
+  end
+```
+
+Where the `delayed_job:default` is defined as:
+
+```ruby
+  task :default do
+    invoke 'delayed_job:restart' if fetch(:delayed_job_default_hooks, true)
+  end
+```
+
+Thus you can disable default hook by setting `delayed_job_default_hooks` to `false`. (It still gets _defined_, but will not do anything when called.)
+
+```ruby
+set :delayed_job_default_hooks, false
 ```
 
-It also adds the following hook
+Following setting is recommended to avoid stop/restart problem.
+See [Issue #16](https://github.com/platanus/capistrano3-delayed-job/issues/16) or [PR #22](https://github.com/platanus/capistrano3-delayed-job/pull/22) for more detail.
 
 ```ruby
-after 'deploy:publishing', 'restart' do
-    invoke 'delayed_job:restart'
-end
+set :linked_dirs, %w(tmp/pids)
+
+# or
+
+set :delayed_job_pid_dir, '/tmp'
 ```
 
 ## Contributing
@@ -82,13 +173,13 @@ end
 
 ## Credits
 
-Thank you [contributors](https://github.com/platanus/guides/graphs/contributors)!
+Thank you [contributors](https://github.com/AgileConsultingLLC/capistrano3-delayed-job/graphs/contributors)!
 
-<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+capistrano3-delayed-job is maintained [Rob Biedenharn](https://github.com/rab) and
+[![Logo of Agile Consulting LLC](http://agileconsultingllc.com/agile-logo-small.png "Agile Consulting LLC")](http://agileconsultingllc.com/)
 
-capistrano3-delayed-job is maintained by [platanus](http://platan.us).
+Originally developed by [Platanus](http://platan.us).
 
 ## License
 
-Guides is © 2014 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.
-
+capistrano3-delayed-job is © 2016 Platanus SpA. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

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

data/capistrano3-delayed-job.gemspec

@@ -1,23 +1,32 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "capistrano3-delayed-job"
-  spec.version       = "1.1.0"
-  spec.authors       = ["Juan Ignacio Donoso", "Agustin Feuerhake", "Ignacio Baixas"]
-  spec.email         = ["juan.ignacio@platan.us", "agustin@platan.us", "ignacio@platanus"]
+  spec.version       = "1.7.6"
+  spec.authors       = ["Rob Biedenharn",
+                        "Juan Ignacio Donoso",
+                        "Agustin Feuerhake",
+                        "Ignacio Baixas"]
+  spec.email         = ["rob_biedenharn@alum.mit.edu",
+                        "juan.ignacio@platan.us",
+                        "agustin@platan.us",
+                        "ignacio@platan.us"]
   spec.summary       = %q{Adds support for delayed_jobs to Capistrano 3.x}
-  spec.description   = %q{Adds support for delayed_jobs to Capistrano 3.x}
-  spec.homepage      = ""
+  spec.description   = %q{Manage start/stop/restart/status of DelayedJob workers using Capistrano 3}
+  spec.homepage      = "https://github.com/AgileConsultingLLC/capistrano3-delayed-job"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'capistrano', '>= 3.0.0'
+  spec.add_dependency 'capistrano', '~> 3.0', '>= 3.0.0'
+  spec.add_dependency 'daemons', '~> 1.3'
 
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rubocop", "~> 0.0", '>= 0.39.0'
 end

data/lib/capistrano/delayed-job.rb

@@ -1 +1,2 @@
-load File.expand_path('../tasks/delayed-job.rake', __FILE__)
+warn %{"require 'capistrano/delayed-job'" is deprecated; please use "require 'capistrano/delayed_job'" in #{Kernel.caller(1,1).first}} # rubocop:disable Metrics/LineLength
+require_relative 'delayed_job'

data/lib/capistrano/delayed_job.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/delayed_job.rake', __FILE__)

data/lib/capistrano/tasks/delayed_job.rake

@@ -0,0 +1,102 @@
+# rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/BlockLength
+# rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+# rubocop:disable Style/SpaceInsideParens, Style/EmptyLinesAroundBlockBody
+
+namespace :delayed_job do
+
+  def delayed_job_args
+    args = []
+    args << "-m" if fetch(:delayed_job_monitor) # could be set to false
+    args << "-n #{fetch(:delayed_job_workers)}" unless fetch(:delayed_job_workers).nil?
+    args << "--queues=#{fetch(:delayed_job_queues).join(',')}" unless fetch(:delayed_job_queues).nil?
+    args << "--prefix=#{fetch(:delayed_job_prefix)}" unless fetch(:delayed_job_prefix).nil?
+    args << "--pid-dir=#{fetch(:delayed_job_pid_dir)}" unless fetch(:delayed_job_pid_dir).nil?
+    args << "--log-dir=#{fetch(:delayed_log_dir)}" unless fetch(:delayed_log_dir).nil?
+    if fetch(:delayed_job_pools_per_server, nil)
+      server = capture(:hostname)
+      args << fetch(:delayed_job_pools_per_server, {})[server].map {|k,v| "--pool='#{k}:#{v}'" }.join(' ')
+    elsif fetch(:delayed_job_pools, nil)
+      args << fetch(:delayed_job_pools, {}).map {|k,v| "--pool='#{k}:#{v}'" }.join(' ')
+    end
+    unless fetch(:delayed_job_daemon_opts).nil?
+      args << "--daemon-options='--#{fetch(:delayed_job_daemon_opts, []).join(',--')}'"
+    end
+    args.join(' ')
+  end
+
+  def delayed_job_roles
+    fetch(:delayed_job_roles)
+  end
+
+  def delayed_job_bin
+    Pathname.new(fetch(:delayed_job_bin_path)).join('delayed_job')
+  end
+
+  desc 'Stop the delayed_job process'
+  task :stop do
+    on roles(delayed_job_roles) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :bundle, :exec, delayed_job_bin, delayed_job_args, :stop
+        end
+      end
+    end
+  end
+
+  desc 'Start the delayed_job process'
+  task :start do
+    on roles(delayed_job_roles) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :bundle, :exec, delayed_job_bin, delayed_job_args, :start
+        end
+      end
+    end
+  end
+
+  desc 'Status of the delayed_job process'
+  task :status do
+    on roles(delayed_job_roles) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          capture( :bundle, :exec, delayed_job_bin, delayed_job_args, :status ).each_line do |line|
+            info line
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Restart the delayed_job process'
+  task :restart do
+    on roles(delayed_job_roles) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :bundle, :exec, delayed_job_bin, delayed_job_args, :restart
+        end
+      end
+    end
+  end
+
+  desc 'Default task - conditionally restart'
+  task :default do
+    invoke 'delayed_job:restart' if fetch(:delayed_job_default_hooks, true)
+  end
+
+  if Rake::Task.task_defined?('deploy:published')
+    after 'deploy:published', 'delayed_job:default'
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :delayed_job_workers, 1
+    set :delayed_job_queues, nil
+    set :delayed_job_pools, nil
+    set :delayed_job_pools_per_server, nil
+    set :delayed_job_roles, :app
+    set :delayed_job_bin_path, 'bin'
+    set :delayed_job_monitor, nil
+    set :delayed_job_default_hooks, true
+  end
+end

metadata

@@ -1,64 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-delayed-job
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.7.6
 platform: ruby
 authors:
+- Rob Biedenharn
 - Juan Ignacio Donoso
 - Agustin Feuerhake
 - Ignacio Baixas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2019-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Adds support for delayed_jobs to Capistrano 3.x
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+description: Manage start/stop/restart/status of DelayedJob workers using Capistrano
+  3
 email:
+- rob_biedenharn@alum.mit.edu
 - juan.ignacio@platan.us
 - agustin@platan.us
-- ignacio@platanus
+- ignacio@platan.us
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - capistrano3-delayed-job.gemspec
 - lib/capistrano/delayed-job.rb
-- lib/capistrano/tasks/delayed-job.rake
+- lib/capistrano/delayed_job.rb
+- lib/capistrano/tasks/delayed_job.rake
 - lib/capistrano3-delayed-job.rb
-homepage: ''
+homepage: https://github.com/AgileConsultingLLC/capistrano3-delayed-job
 licenses:
 - MIT
 metadata: {}
@@ -68,17 +113,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Adds support for delayed_jobs to Capistrano 3.x

data/lib/capistrano/tasks/delayed-job.rake

@@ -1,66 +0,0 @@
-namespace :delayed_job do
-
-  def args
-    args = ""
-    args += "-n #{fetch(:delayed_job_workers)}" unless fetch(:delayed_job_workers).nil?
-    args += " --queues=#{fetch(:delayed_job_queues).join(',')} " unless fetch(:delayed_job_queues).nil?
-    args += fetch(:delayed_job_pool).map {|k,v| "--pool=#{k}:#{v}"}.join(' ') unless fetch(:delayed_job_pool).nil?
-    args
-  end
-
-  def delayed_job_roles
-    fetch(:delayed_job_roles)
-  end
-
-  def delayed_job_bin
-    Pathname.new(fetch(:delayed_job_bin_path)).join('delayed_job')
-  end
-
-  desc 'Stop the delayed_job process'
-  task :stop do
-    on roles(delayed_job_roles) do
-      within release_path do
-        with rails_env: fetch(:rails_env) do
-          execute :bundle, :exec, delayed_job_bin, :stop
-        end
-      end
-    end
-  end
-
-  desc 'Start the delayed_job process'
-  task :start do
-    on roles(delayed_job_roles) do
-      within release_path do
-        with rails_env: fetch(:rails_env) do
-          execute :bundle, :exec, delayed_job_bin, args, :start
-        end
-      end
-    end
-  end
-
-  desc 'Restart the delayed_job process'
-  task :restart do
-    on roles(delayed_job_roles) do
-      within release_path do
-        with rails_env: fetch(:rails_env) do
-          execute :bundle, :exec, delayed_job_bin, args, :restart
-        end
-      end
-    end
-  end
-
-  after 'deploy:publishing', 'restart' do
-    invoke 'delayed_job:restart'
-  end
-
-end
-
-namespace :load do
-  task :defaults do
-    set :delayed_job_workers, 1
-    set :delayed_job_queues, nil
-    set :delayed_job_pool, nil
-    set :delayed_job_roles, :app
-    set :delayed_job_bin_path, 'bin'
-  end
-end