capistrano-pm2 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffda96769c385338ad1973fabf3816edd16df7e7
-  data.tar.gz: ca51a5917d09dedd3cd43f2fd6d273de3311e21a
+  metadata.gz: 045f273a83e6ae8e68ad2497b7fd0efd72069ae4
+  data.tar.gz: 551fa9799c731e6e71a81731b76bd165ba9d941b
 SHA512:
-  metadata.gz: 26f6ca106220a5a0b55310d094a1652a32d6c1bfed301bdac18dbeed8b129f5cd9d17571828776b398cbdd509f5ded6e0dc84451406ac3df2012b210ea925ffd
-  data.tar.gz: 64ae35b315c423d40bc4ac0aeb682dd45905588463a68fc3f06dce21f4fd85f11273434a100a479d6cf88a86d7d2e0f701338eb9c701e24100be636ba41397d5
+  metadata.gz: 053da5f4133f05a7b120d60dff2ae675733b4052b15b98b36355ac607f9646edb46b4aa41618c66cfdaf945128682a3fc4023143e4689f6eb520a5369a4562c1
+  data.tar.gz: a34b39ef9ae9ce2e56b1243f655cba0a3af0f0b95147da3cf01a4737614246293e24b3bde97442cb5f8d65da9aa92ec09c0777ee86bf9cc95aea3294b6e66dbd

data/README.md

@@ -1,7 +1,4 @@
-# capistrano-pm2
-This is a pm2 handler for capistrano 3.x.
-
-# Capistrano::pm2
+# Capistrano::pm2 [![Gem Version](https://badge.fury.io/rb/capistrano-pm2.svg)](http://badge.fury.io/rb/capistrano-pm2)
 
 nodejs [pm2](https://github.com/Unitech/pm2) support for Capistrano 3.x
 
@@ -47,20 +44,24 @@ end
 
 Available Tasks
 ```ruby
+cap pm2:delete                     # Delete pm2 application
+cap pm2:list                       # Show pm2 application info
+cap pm2:logs                       # Watch pm2 logs
 cap pm2:restart                    # Restart app gracefully
-cap pm2:show                       # Show pm2 application info
+cap pm2:setup                      # Install pm2 via npm on the remote host
 cap pm2:start                      # Start pm2 application
-cap pm2:status                     # Show pm2 status
+cap pm2:status                     # List all pm2 applications
 cap pm2:stop                       # Stop pm2 application
 ```
 
 Configurable options:
-
 ```ruby
-set :pm2_app_command, 'main'                      # default, runs main.js
+set :pm2_app_command, 'main.js'                   # default, runs main.js
+set :pm2_app_name, nil                            # app name for pm2, default cap :application
 set :pm2_target_path, -> { release_path.join('subdir') } # default not set
-set :pm2_roles, :all                              # default
-set :pm2_env_variables, {}                        # default
+set :pm2_roles, :all                              # default, cap roles to run on
+set :pm2_env_variables, {}                        # default, env vars for pm2
+set :pm2_start_params, ''                         # default, pm2 start params see http://pm2.keymetrics.io/docs/usage/quick-start/#cheat-sheet
 ```
 
 ## Contributing

data/capistrano-pm2.gemspec

@@ -4,15 +4,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'capistrano-pm2'
-  spec.version       = '1.0.1'
+  spec.version       = '1.0.2'
   spec.authors       = ['Tom Hanoldt']
   spec.email         = ['monotom@gmail.com']
-  spec.description   = %q{nodejs pm2 support for Capistrano 3.x}
-  spec.summary       = %q{nodejs pm2 support for Capistrano 3.x}
+  spec.description   = 'nodejs pm2 support for Capistrano 3.x'
+  spec.summary       = 'nodejs pm2 support for Capistrano 3.x'
   spec.homepage      = 'https://github.com/creative-workflow/capistrano-pm2'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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']

data/lib/capistrano/tasks/pm2.rake

@@ -1,41 +1,6 @@
 require 'json'
 
 namespace :pm2 do
-  def app_status
-    within current_path do
-      ps = JSON.parse(capture :pm2, :jlist, fetch(:pm2_app_command))
-
-      return nil if ps.empty?
-
-      # status: online, errored, stopped
-      return ps[0]["pm2_env"]["status"]
-    end
-  end
-
-  def restart_app
-    within current_path do
-      execute :pm2, :restart, app_command_with_js_extension
-    end
-  end
-
-  def app_command_with_js_extension
-    "#{app_command_without_js_extension}.js"
-  end
-
-  def app_command_without_js_extension
-    fetch(:pm2_app_command).sub(/\.js$/, '')
-  end
-
-  def run_task(*args)
-    on roles fetch(:pm2_roles) do
-      within fetch(:pm2_target_path, release_path) do
-        with fetch(:pm2_env_variables) do
-          execute *args
-        end
-      end
-    end
-  end
-
   desc 'Restart app gracefully'
   task :restart do
     on roles fetch(:pm2_roles) do
@@ -58,30 +23,78 @@ namespace :pm2 do
 
   before 'deploy:restart', 'pm2:restart'
 
-  desc 'Show pm2 status'
+  desc 'List all pm2 applications'
   task :status do
-    run_task :pm2, :status
+    run_task :pm2, :list
   end
 
   desc 'Start pm2 application'
   task :start do
-    run_task :pm2, :start, app_command_with_js_extension
+    run_task :pm2, :start, fetch(:pm2_app_command), "--name #{app_name} #{fetch(:pm2_start_params)}"
   end
 
   desc 'Stop pm2 application'
   task :stop do
-    run_task :pm2, :stop, app_command_without_js_extension
+    run_task :pm2, :stop, app_name
+  end
+
+  desc 'Delete pm2 application'
+  task :delete do
+    run_task :pm2, :delete, app_name
   end
 
   desc 'Show pm2 application info'
-  task :show do
-    run_task :pm2, :show, app_command_without_js_extension
+  task :list do
+    run_task :pm2, :show, app_name
+  end
+
+  desc 'Watch pm2 logs'
+  task :logs do
+    run_task :pm2, :logs
+  end
+
+  desc 'Install pm2 via npm on the remote host'
+  task :setup do
+    run_task :npm, :install,  'pm2 -g'
+  end
+
+  def app_name
+    fetch(:pm2_app_name) || fetch(:application)
+  end
+
+  def app_status
+    within current_path do
+      ps = JSON.parse(capture :pm2, :jlist, app_name)
+
+      return nil if ps.empty?
+
+      # status: online, errored, stopped
+      return ps[0]["pm2_env"]["status"]
+    end
+  end
+
+  def restart_app
+    within current_path do
+      execute :pm2, :restart, app_name
+    end
+  end
+
+  def run_task(*args)
+    on roles fetch(:pm2_roles) do
+      within fetch(:pm2_target_path, release_path) do
+        with fetch(:pm2_env_variables) do
+          execute *args
+        end
+      end
+    end
   end
 end
 
 namespace :load do
   task :defaults do
-    set :pm2_app_command, 'main'
+    set :pm2_app_command, 'main.js'
+    set :pm2_app_name, nil
+    set :pm2_start_params, ''
     set :pm2_roles, :all
     set :pm2_env_variables, {}
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-pm2
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Tom Hanoldt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano