negroku 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf60decc9484455b7b40455dba4b3b72449e4cc5
-  data.tar.gz: ab8aa96292a765d867eedce031e981c2b5ac50ea
+  metadata.gz: 8738821ec803495342cde41c9cb5d3e5fff9047b
+  data.tar.gz: 2e4fb61d9e781ad7d91610c358790dfd65c01e99
 SHA512:
-  metadata.gz: 75e31868e2f96c478899a36d49b8d8b2a2895965cc97a600a82f41af483b2e74be4439adab3b0ae2bee0b4a7968e869fe2d143caee053564b9c1a581e926f0a2
-  data.tar.gz: c70cce3758391c76d3fe1b1b41fc7a7eebd3c097c19f6e16c696e6a71a61f01e1987dcc7d4bed4543c55447f70a596b41d174f03ca809790d93bb83905a5d0c3
+  metadata.gz: ace8c571d9f2b4ee36552cea518dbf238e72bf0b68461bc2006fef26e6bada16583064ae19e405bb11edb0b9ccf76a8fb1048570491e43310fd365c2eddb4c75
+  data.tar.gz: d251e00951daae7c24a600597f8080fdaef8971f575d2998d489c9ba897b5028cc78412a3fe70f16c7daabc7925eed3eb5aa9a32a32a6b11a2610782a4ae6b99

data/CHANGELOG.md

@@ -4,7 +4,25 @@ Reverse Chronological Order:
 
 ## Unreleased
 
-https://github.com/platanus/negroku/compare/v2.6.0...HEAD
+https://github.com/platanus/negroku/compare/v2.7.0...HEAD
+
+## `2.7.0`
+
+https://github.com/platanus/negroku/compare/v2.6.0...v2.7.0
+
+FEAT:
+- Adds support for puma as application server
+- Adds simultaneous log stream support
+  For example you can call
+  `cap production logs` to get all application logs
+  `cap production logs:nginx` to get all nginx logs
+  `cap production logs:nginx:access` to get the nginx access logs only
+
+FIX:
+- Show help when no command is used
+
+BREAKING CHANGES:
+- Log task was renamed to `logs`
 
 ## `2.6.0`
 
@@ -94,7 +112,7 @@ FIX:
 https://github.com/platanus/negroku/compare/v2.4.0...v2.4.1
 
 FIX:
-- Fix unicorn restart bug, thanks to @nicolasmery and @amosrivera 
+- Fix unicorn restart bug, thanks to @nicolasmery and @amosrivera
 
 ## `2.4.0`
 
@@ -104,7 +122,7 @@ FEATURE
 - Unicorn: adds a way to change cpu and memory eye check for unicorn    
 
 FIXES
-- Rbenv: 
+- Rbenv:
   - `rbenv:vars:show` will work even before the firts deploy, close #96
   - Bulk environmental variables on stage creation, close #99
 

data/README.md

@@ -116,6 +116,7 @@ $ bundle install
 
     # App server
     require 'capistrano3/unicorn'
+    # require 'capistrano/puma'
 
     # Static server
     require 'capistrano/nginx'
@@ -125,7 +126,7 @@ $ bundle install
 
     1. Common settings for all stages `deploy.rb`
 
-        Here you can add all the settings that are common to all the stage severs. For example: 
+        Here you can add all the settings that are common to all the stage severs. For example:
 
         ```ruby
         set :unicorn_workers, 1
@@ -140,7 +141,7 @@ $ bundle install
         ```ruby
         set :branch,        "production"        # Optional, defaults to master
 
-        set :rails_env,        "production" 
+        set :rails_env,        "production"
         ```
 
 1. Commit and push the changes to the repository
@@ -153,10 +154,31 @@ To deploy your application you just need to run capistrano task to do so.
 $ cap staging deploy  # to deploy to the staging stage
 ```
 
-## Tasks
+## Supports
 
-1. [Rails](docs/TASKS.md#rails)
-1. [Whenever](docs/TASKS.md#whenever)
+### Web server
+
+  - nginx
+
+### App servers
+
+  - puma
+  - unicorn
+
+### Tools
+
+  - bower
+  - bundler
+  - delayed jobs
+  - eye process monitoring
+  - thinking sphinx
+  - [Whenever](docs/TASKS.md#whenever)
+
+### Other features
+
+  - Github deployment api
+  - [Logs](docs/TASKS.md#logs)
+  - [Rails](docs/TASKS.md#rails)
 
 ## Contributing
 

data/docs/TASKS.md

@@ -4,12 +4,13 @@
     * [Remote Console](#remote-console)
 * [Whenever](#whenever)
     * [Config](#config)
+* [Logs](#logs)
 
-### Rails 
+### Rails
 
 ##### Remote Console
 
-Negroku adds support to remotelly connect to the rails console integrating de [capistrano-rails-console][1] gem. 
+Negroku adds support to remotelly connect to the rails console integrating de [capistrano-rails-console][1] gem.
 
 ```shell
 cap <stage> rails:console
@@ -18,7 +19,7 @@ cap <stage> rails:console sandbox=1
 
 [1]: https://github.com/ydkn/capistrano-rails-console
 
-### Whenever 
+### Whenever
 
 **Note:** By default we are not adding any path to the cron execution PATH. It's up the you to add the needed path to the PATH variable in the cron file.
 
@@ -32,3 +33,63 @@ default tempalte is `bash -lc ':job'`
     set :whenever_template, "bash -lc ':job'" #default
     set :whenever_template, "PATH=./bin:$PATH && bash -lc ':job'" #add location to the path
     ```
+
+### Logs
+
+You can stream al the application logs from the server.
+
+```shell
+# to get all application logs
+cap production logs
+
+# to get all nginx logs
+cap production logs:nginx
+
+# to get the nginx access or error logs only
+cap production logs:nginx:access
+cap production logs:nginx:error
+```
+
+You can pass an argument with the number of line to show in the beginning
+
+```shell
+# to get the nginx access logs starting with 1000 lines
+cap production logs:nginx:access[1000]
+```
+
+The build in supported log tasks are
+
+
+- `logs:nginx:access`
+- `logs:nginx:error`
+- `logs:delayed_job:out`
+- `logs:eye:app`
+- `logs:puma:error`
+- `logs:puma:access`
+- `logs:rails:app`
+- `logs:sphinx:out`
+- `logs:sphinx:query`
+- `logs:unicorn:error`
+- `logs:unicorn:out`
+- `logs:whenever:out`
+
+> The will be loaded based on what module you loaded in your `Capfile`
+
+#### Custom Logs
+
+If you have other logs in your applicacion you can add them to the log task
+using the `define_logs` method in your `deploy.rb` file
+
+This assume that your logs are in the `shared/logs` folder
+
+```ruby
+define_logs(:other_process, {
+  error: 'other_process_error.log',
+  out: 'other_process_out.log'
+})
+```
+
+With that you will have a new `other_process` task
+
+- `logs:other_process:error`
+- `logs:other_process:out`

data/lib/negroku/capistrano/deploy.rb

@@ -29,6 +29,7 @@ load_task "bundler"           if required? 'capistrano/bundler'
 load_task "rails"             if required? 'capistrano/rails'
 load_task "nginx"             if required? 'capistrano/nginx'
 load_task "unicorn"           if required? 'capistrano3/unicorn'
+load_task "puma"              if required? 'capistrano/puma'
 load_task "delayed_job"       if required? 'capistrano/delayed-job'
 load_task "github"            if required? 'capistrano/github'
 load_task "whenever"          if required? 'whenever/capistrano'

data/lib/negroku/capistrano/eye/puma.rb

@@ -0,0 +1 @@
+load_task 'eye/puma', ['capistrano/puma']

data/lib/negroku/capistrano/tasks/eye/puma.rake

@@ -0,0 +1,27 @@
+#########
+## Adds support to monitor puma processes through eye
+#########
+
+# Watch the puma processes using the build in template
+namespace :eye do
+  task :watch_process do
+
+    watch_process(:puma);
+
+  end
+end
+
+# Override start, restart and stop puma tasks to so they call
+# the eye equivalents
+namespace :puma do
+  ['start','restart','stop'].each do |cmd|
+    if Rake::Task.task_defined?("puma:#{cmd}")
+      Rake::Task["puma:#{cmd}"].clear_actions
+      # Reload or restart puma after the application is published
+      desc "using eye"
+      task cmd do
+        invoke "eye:#{cmd}", 'puma'
+      end
+    end
+  end
+end

data/lib/negroku/capistrano/tasks/log.rake

@@ -1,24 +1,60 @@
 ## log.rb
 #
 # Dynamically adds log task based on log definitions
-namespace :log do
 
-  fetch(:negroku_logs, {}).each do |namespace, log|
+desc "Show all logs tail"
+task :logs, :lines do |t, args|
+  on release_roles [:app, :web] do
+    within current_path do
+      paths = fetch(:negroku_logs, {}).values.map(&:values).flatten
+      execute :tail, tail_args(paths, args[:lines])
+    end
+  end
+end
+
+namespace :logs do
+
+  def set_tty
+    old_state = `stty -g`
+    system "stty -echoctl"
+
+    trap("INT") { puts 'Bye!'; system "stty #{old_state}"; exit 0; }
+  end
+
+  def tail_args(paths, lines)
+    set_tty
+
+    args = []
+    p paths
+    paths.each do |path|
+      args << "-f #{Pathname.new(shared_path).join("log", path)}"
+    end
+
+    args << "-n #{lines || 10}"
+    args.join(' ')
+  end
+
+  fetch(:negroku_logs, {}).each do |namespace, logs|
+
+    desc "Show #{namespace} log tail"
+    task namespace, :lines do |t, args|
+      on release_roles [:app, :web] do
+        within current_path do
+          paths = logs.map {|name, path| path}
+          execute :tail, tail_args(paths, args[:lines])
+        end
+      end
+    end
 
     namespace namespace do
 
-      log.each do |name, path|
+      logs.each do |name, path|
 
         desc "Show #{namespace} #{name} log tail"
         task name, :lines do |t, args|
           on release_roles [:app, :web] do
             within current_path do
-              old_state = `stty -g`
-              system "stty -echoctl"
-
-              args.with_defaults(:lines => 10)
-              trap("INT") { puts 'Bye!'; system "stty #{old_state}"; exit 0; }
-              execute :tail, '-f', Pathname.new(shared_path).join("log", path), "-n", args[:lines]
+              execute :tail, tail_args([path], args[:lines])
             end
           end
         end

data/lib/negroku/capistrano/tasks/puma.rake

@@ -0,0 +1,93 @@
+## puma.rb
+#
+# Adds puma variables and tasks
+# Puma main tasks are taken from the gem capistrano3-puma
+
+# Here we are setting up the main negroku default to work with puma
+namespace :load do
+  task :defaults do
+
+    ###################################
+    ## capistrano3/puma variables
+
+    # Defines where the puma config will live.
+    set :puma_conf, -> { "#{shared_path}/config/puma.rb" }
+
+    # Local path to look for custom config template
+    set :puma_template, -> { "config/deploy/#{fetch(:stage)}/puma.rb.erb" }
+
+    # The type of template to use
+    # rails, rails_activerecord
+    set :puma_template_type, -> { "rails_activerecord" }
+
+
+    # Workers timeout in the amount of seconds below, when the master kills it and
+    # forks another one.
+    set :puma_worker_timeout, -> { 30 }
+
+    # The location of the puma socket
+    set :puma_socket, -> { "#{shared_path}/tmp/sockets/puma.sock" }
+    set :puma_bind, -> { "unix://#{fetch(:puma_socket)}" }
+
+    # Preload app for fast worker spawn
+    set :puma_preload, -> { false }
+
+    ###################################
+    ## capistrano3/nginx variables
+
+    # Set the app server socket if nginx is being used
+    set :app_server_socket, -> { fetch(:puma_socket) } if required? 'capistrano/nginx'
+
+    ## Eye monitoring
+    set :puma_master_cpu_checks, "check :cpu, :every => 30, :below => 80, :times => 3"
+    set :puma_master_memory_checks, "check :memory, :every => 30, :below => 150.megabytes, :times => [3,5]"
+
+  end
+end
+
+# Adds some task on complement the capistrano3-puma tasks
+# This tasks are under the negroku namespace for easier identification
+namespace :negroku do
+
+  namespace :puma do
+    desc "Upload puma configuration file"
+    task :setup do
+      on release_roles fetch(:puma_roles) do
+        within "#{shared_path}/config" do
+          template_path = fetch(:puma_template)
+
+          # user a build in template if the template doesn't exists in the project
+          unless File.exists?(template_path)
+            template_path = "capistrano/templates/puma.rb.erb"
+          end
+
+          config = build_template(template_path, nil, binding)
+          upload! config, '/tmp/puma.rb'
+
+          execute :mv, '/tmp/puma.rb', 'puma.rb'
+        end
+      end
+    end
+
+    # Reload or restart puma after the application is published
+    after 'deploy:published', 'restart' do
+      invoke 'negroku:puma:setup'
+      invoke 'puma:smart_restart'
+    end
+
+    define_logs(:puma, {
+      error: 'puma_error.log',
+      access: 'puma_access.log'
+    })
+
+  end
+end
+
+# Ensure the folders needed exist
+task 'deploy:check:directories' do
+  on release_roles fetch(:puma_role) do
+    execute :mkdir, '-pv', "#{shared_path}/config"
+    execute :mkdir, '-pv', "#{shared_path}/tmp/sockets"
+    execute :mkdir, '-pv', "#{shared_path}/tmp/pids"
+  end
+end

data/lib/negroku/capistrano/templates/eye/_puma.erb

@@ -0,0 +1,19 @@
+  process 'puma' do
+    pid_file "<%= fetch(:puma_pid) %>"
+    start_command "<%= fetch(:rbenv_prefix) %> bundle exec puma -C <%= fetch(:puma_conf) %> --daemon -e <%= fetch(:rails_env) %>"
+    stdall "<%= fetch(:puma_access_log) %>"
+
+    # stop signals:
+    # http://puma.bogomips.org/SIGNALS.html
+    stop_signals [:TERM, 10.seconds]
+
+    # soft restart
+    restart_command "kill -USR2 {PID}"
+
+    # Master process checks
+    <%= fetch(:puma_master_cpu_checks) %>
+    <%= fetch(:puma_master_memory_checks) %>
+
+    start_timeout 100.seconds
+    restart_grace 30.seconds
+  end

data/lib/negroku/capistrano/templates/puma.rb.erb

@@ -0,0 +1,42 @@
+#!/usr/bin/env puma
+
+directory '<%= current_path %>'
+rackup "<%=fetch(:puma_rackup)%>"
+environment '<%= fetch(:puma_env) %>'
+<% if fetch(:puma_tag) %>
+  tag '<%= fetch(:puma_tag)%>'
+<% end %>
+pidfile "<%=fetch(:puma_pid)%>"
+state_path "<%=fetch(:puma_state)%>"
+stdout_redirect '<%=fetch(:puma_access_log)%>', '<%=fetch(:puma_error_log)%>', true
+
+
+threads <%=fetch(:puma_threads).join(',')%>
+
+<%= puma_bind %>
+<% if fetch(:puma_control_app) %>
+activate_control_app "<%= fetch(:puma_default_control_app) %>"
+<% end %>
+workers <%= puma_workers %>
+<% if fetch(:puma_worker_timeout) %>
+worker_timeout <%= fetch(:puma_worker_timeout).to_i %>
+<% end %>
+
+<% if puma_preload_app? %>
+preload_app!
+<% else %>
+prune_bundler
+<% end %>
+
+on_restart do
+  puts 'Refreshing Gemfile'
+  ENV["BUNDLE_GEMFILE"] = "<%= fetch(:bundle_gemfile, "#{current_path}/Gemfile") %>"
+end
+
+<% if puma_preload_app? and fetch(:puma_init_active_record) %>
+on_worker_boot do
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::Base.establish_connection
+  end
+end
+<% end %>

data/lib/negroku/cli.rb

@@ -29,9 +29,6 @@ module Negroku::CLI
     # Set th version
     version Negroku::VERSION
 
-    # Negroku commands will manage the interactive cli ui
-    default_command :negroku
-
     # Don't show the negroku commands in the help
     hide_commands_without_desc true
 

data/lib/negroku/config.rb

@@ -53,6 +53,10 @@ class Negroku::ConfigFactory
     name: "unicorn", enabled: loaded_in_bundler('unicorn')
   }
 
+  attribute :puma, Negroku::Feature, default: {
+    name: "puma", enabled: loaded_in_bundler('puma')
+  }
+
   attribute :whenever, Negroku::Feature, default: {
     name: "whenever", enabled: File.exists?('config/schedule.rb')
   }

data/lib/negroku/templates/Capfile.erb

@@ -26,6 +26,7 @@ require 'capistrano/github'
 
 # App server
 <%= "#" unless config.unicorn.enabled? %>require 'capistrano3/unicorn'
+<%= "#" unless config.puma.enabled? %>require 'capistrano/puma'
 
 # Static server
 <%= "#" unless config.nginx.enabled? %>require 'capistrano/nginx'
@@ -38,6 +39,7 @@ require 'capistrano/github'
 # Eye monitoring
 require 'negroku/capistrano/eye'
 <%= "#" unless config.unicorn.enabled? %>require 'negroku/capistrano/eye/unicorn'
+<%= "#" unless config.puma.enabled? %>require 'negroku/capistrano/eye/puma'
 <%= "#" unless config.delayed_job.enabled? %>require 'negroku/capistrano/eye/delayed_job'
 <%= "#" unless config.sphinx.enabled? %>require 'negroku/capistrano/eye/thinking_sphinx'
 

data/lib/negroku/version.rb

@@ -1,3 +1,3 @@
 module Negroku
-  VERSION = '2.6.0'
+  VERSION = '2.7.0'
 end

data/negroku.gemspec

@@ -35,6 +35,7 @@ spec = Gem::Specification.new do |s|
   s.add_runtime_dependency('capistrano-bower', '~> 1.1.0')
   s.add_runtime_dependency('capistrano3-nginx', '~> 2.1.2')
   s.add_runtime_dependency('capistrano3-unicorn', '~> 0.2.1')
+  s.add_runtime_dependency('capistrano3-puma', '~> 1.2.1')
   s.add_runtime_dependency('capistrano3-delayed-job', '~> 1.4.0')
   s.add_runtime_dependency('whenever', '~> 0.9.4')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: negroku
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Juan Ignacio Donoso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -248,6 +248,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: capistrano3-puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: capistrano3-delayed-job
   requirement: !ruby/object:Gem::Requirement
@@ -382,6 +396,7 @@ files:
 - lib/negroku/capistrano/deploy.rb
 - lib/negroku/capistrano/eye.rb
 - lib/negroku/capistrano/eye/delayed_job.rb
+- lib/negroku/capistrano/eye/puma.rb
 - lib/negroku/capistrano/eye/thinking_sphinx.rb
 - lib/negroku/capistrano/eye/unicorn.rb
 - lib/negroku/capistrano/formatters/simple.rb
@@ -391,12 +406,14 @@ files:
 - lib/negroku/capistrano/tasks/env.rake
 - lib/negroku/capistrano/tasks/eye.rake
 - lib/negroku/capistrano/tasks/eye/delayed_job.rake
+- lib/negroku/capistrano/tasks/eye/puma.rake
 - lib/negroku/capistrano/tasks/eye/thinking_sphinx.rake
 - lib/negroku/capistrano/tasks/eye/unicorn.rake
 - lib/negroku/capistrano/tasks/github.rake
 - lib/negroku/capistrano/tasks/log.rake
 - lib/negroku/capistrano/tasks/nginx.rake
 - lib/negroku/capistrano/tasks/nodenv.rake
+- lib/negroku/capistrano/tasks/puma.rake
 - lib/negroku/capistrano/tasks/rails.rake
 - lib/negroku/capistrano/tasks/rbenv.rake
 - lib/negroku/capistrano/tasks/thinking_sphinx.rake
@@ -404,9 +421,11 @@ files:
 - lib/negroku/capistrano/tasks/whenever.rake
 - lib/negroku/capistrano/templates/eye/_delayed_job.erb
 - lib/negroku/capistrano/templates/eye/_process.erb
+- lib/negroku/capistrano/templates/eye/_puma.erb
 - lib/negroku/capistrano/templates/eye/_sphinx.erb
 - lib/negroku/capistrano/templates/eye/_unicorn.erb
 - lib/negroku/capistrano/templates/eye/application.eye.erb
+- lib/negroku/capistrano/templates/puma.rb.erb
 - lib/negroku/capistrano/templates/thinking_sphinx.yml.erb
 - lib/negroku/capistrano/templates/unicorn_rails.rb.erb
 - lib/negroku/capistrano/templates/unicorn_rails_activerecord.rb.erb
@@ -414,7 +433,6 @@ files:
 - lib/negroku/cli.rb
 - lib/negroku/cli/commands/app.rb
 - lib/negroku/cli/commands/env.rb
-- lib/negroku/cli/commands/negroku.rb
 - lib/negroku/cli/commands/stage.rb
 - lib/negroku/config.rb
 - lib/negroku/helpers.rb
@@ -461,7 +479,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Capistrano recipes collection

data/lib/negroku/cli/commands/negroku.rb

@@ -1,15 +0,0 @@
-module Negroku::CLI
-
-  # This is the default negroku command
-  # Here we'll manage the main interative cli ui
-  command :negroku do |c|
-
-    c.default_command :ask
-    c.command :ask do |s|
-      s.action do |global_options,options,args|
-
-      end
-    end
-
-  end
-end