capistrano-unicorn-nginx 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feb8b0da77445c6c9ab71b8cb47ebd81beaeeb73
-  data.tar.gz: 67825da92ed8d2d476f6f35ad797974b494c60f0
+  metadata.gz: 3e038ef42790b2e2e9fdbc34f37ac6d4b44e1f4b
+  data.tar.gz: 7180b47e77e78edc458a79911acc901df9a95a6e
 SHA512:
-  metadata.gz: 4f90081c4e412b9e724eadb8523a4de5a5f2b7ec4006a2c7c83ee4dceb6d0925cc2fdb23857ff944477268ebbcdbc68a7687792f6214673705b9fad0fbd6d851
-  data.tar.gz: b6f29cc5a2d965c1ea751123037dd121a93010f70758d84b1ef59082f7986966c3d32f67e544bb524126983b29b95d823f71aee43b198ca972132ccd4c8325a3
+  metadata.gz: f39f6cbd00235af5642493388123b78b084499076f8ca23f00ab2b08a0279211cc0a3ade952375fda65c74ec4bb8066dc09921e0b3f2ed847d41d7dd559c659f
+  data.tar.gz: 89ede75ee9776a58a9f0749764b888e04baea723e0b9174a804ec0a26e8f504b1674d02ff562dc09ba21c04ebd9b25fbfa1ade6fa2b180d0ef30fab8e034daed

data/CHANGELOG.md

@@ -1,2 +1,6 @@
+### v1.0.1, 2014-03-30
+- refactor all unicorn and nginx paths to separate modules
+- speed up `nginx:setup_ssl` task
+- small README update
 ### v1.0.0, 2014-03-39
 - @bruno- all the v1.0.0 features

data/README.md

@@ -115,15 +115,15 @@ This file will be copied to remote server. Example value:
 
 Defaults are listed near option name in the first line.
 
+- `set :unicorn_service, "unicorn_#{fetch(:application)}_#{fetch(:stage)}`<br/>
+Unicorn service name is `unicorn_myapp_production` by default.
+
 - `set :unicorn_pid, shared_path.join("tmp/pids/unicorn.pid")`<br/>
 Path for unicorn process pid file.
 
 - `set :unicorn_config, shared_path.join("config/unicorn.rb")`<br/>
 Path for unicorn config file.
 
-- `set :unicorn_log, shared_path.join("log/unicorn.log")`<br/>
-Unicorn log path.
-
 - `set :unicorn_workers, 2`<br/>
 Number of unicorn workers.
 

data/lib/capistrano/dsl/nginx_paths.rb

@@ -0,0 +1,53 @@
+module Capistrano
+  module DSL
+    module NginxPaths
+
+      def nginx_config_tmp_file
+        "#{fetch(:tmp_dir)}/#{fetch(:nginx_config_name)}"
+      end
+
+      def nginx_sites_available_file
+        "/etc/nginx/sites-available/#{fetch(:nginx_config_name)}"
+      end
+
+      def nginx_sites_enabled_file
+        "/etc/nginx/sites-enabled/#{fetch(:nginx_config_name)}"
+      end
+
+      def nginx_service_path
+        '/etc/init.d/nginx'
+      end
+
+      def nginx_default_pid_file
+        '/run/nginx.pid'
+      end
+
+      # ssl related files
+      def nginx_default_ssl_cert_file_name
+        "#{fetch(:nginx_server_name)}.crt"
+      end
+
+      def nginx_default_ssl_cert_key_file_name
+        "#{fetch(:nginx_server_name)}.key"
+      end
+
+      def nginx_ssl_cert_file
+        "/etc/ssl/certs/#{fetch(:nginx_ssl_cert)}"
+      end
+
+      def nginx_ssl_cert_key_file
+        "/etc/ssl/private/#{fetch(:nginx_ssl_cert_key)}"
+      end
+
+      # log files
+      def nginx_access_log_file
+        shared_path.join('log/nginx.access.log')
+      end
+
+      def nginx_error_log_file
+        shared_path.join('log/nginx.error.log')
+      end
+
+    end
+  end
+end

data/lib/capistrano/dsl/unicorn_paths.rb

@@ -0,0 +1,31 @@
+module Capistrano
+  module DSL
+    module UnicornPaths
+
+      def unicorn_initd_tmp_file
+        "#{fetch(:tmp_dir)}/#{fetch(:unicorn_service)}"
+      end
+
+      def unicorn_initd_file
+        "/etc/init.d/#{fetch(:unicorn_service)}"
+      end
+
+      def unicorn_default_config_file
+        shared_path.join('config/unicorn.rb')
+      end
+
+      def unicorn_default_pid_file
+        shared_path.join('tmp/pids/unicorn.pid')
+      end
+
+      def unicorn_log_file
+        shared_path.join('log/unicorn.stdout.log')
+      end
+
+      def unicorn_error_log_file
+        shared_path.join('log/unicorn.stderr.log')
+      end
+
+    end
+  end
+end

data/lib/capistrano/tasks/nginx.rake

@@ -1,20 +1,24 @@
+require 'capistrano/dsl/nginx_paths'
 require 'capistrano/unicorn_nginx/helpers'
 
 include Capistrano::UnicornNginx::Helpers
+include Capistrano::DSL::NginxPaths
 
 namespace :load do
   task :defaults do
     set :templates_path, 'config/deploy/templates'
     set :nginx_config_name, -> { "#{fetch(:application)}_#{fetch(:stage)}" }
-    set :nginx_pid, '/run/nginx.pid'
+    set :nginx_pid, nginx_default_pid_file
     # set :nginx_server_name # default set in the `nginx:defaults` task
     # ssl options
     set :nginx_use_ssl, false
-    set :nginx_ssl_cert, -> { "#{fetch(:nginx_server_name)}.crt" }
-    set :nginx_ssl_cert_key, -> { "#{fetch(:nginx_server_name)}.key" }
+    set :nginx_ssl_cert, -> { nginx_default_ssl_cert_file_name }
+    set :nginx_ssl_cert_key, -> { nginx_default_ssl_cert_key_file_name }
     set :nginx_upload_local_cert, true
     set :nginx_ssl_cert_local_path, -> { ask(:nginx_ssl_cert_local_path, 'Local path to ssl certificate: ') }
     set :nginx_ssl_cert_key_local_path, -> { ask(:nginx_ssl_cert_key_local_path, 'Local path to ssl certificate key: ') }
+
+    set :linked_dirs, fetch(:linked_dirs, []).push('log')
   end
 end
 
@@ -29,42 +33,37 @@ namespace :nginx do
   desc 'Setup nginx configuration'
   task :setup do
     on roles :web do
-      config_name = fetch(:nginx_config_name)
-      next if file_exists? "/etc/nginx/sites-available/#{config_name}"
-
-      execute :mkdir, '-p', shared_path.join('log')
-      template 'nginx_conf.erb', "#{fetch(:tmp_dir)}/#{config_name}"
-      sudo :mv, "#{fetch(:tmp_dir)}/#{config_name}", "/etc/nginx/sites-available/#{config_name}"
-      sudo :ln, '-fs', "/etc/nginx/sites-available/#{config_name}", "/etc/nginx/sites-enabled/#{config_name}"
+      next if file_exists? nginx_sites_available_file
+      template 'nginx_conf.erb', nginx_config_tmp_file
+      sudo :mv, nginx_config_tmp_file, nginx_sites_available_file
+      sudo :ln, '-fs', nginx_sites_available_file, nginx_sites_enabled_file
     end
   end
 
   desc 'Setup nginx ssl certs'
   task :setup_ssl do
+    next unless fetch(:nginx_use_ssl)
     on roles :web do
-      next unless fetch(:nginx_use_ssl)
-      next if file_exists?("/etc/ssl/certs/#{fetch(:nginx_ssl_cert)}") && file_exists?("/etc/ssl/private/#{fetch(:nginx_ssl_cert_key)}")
-
+      next if file_exists?(nginx_ssl_cert_file) && file_exists?(nginx_ssl_cert_key_file)
       if fetch(:nginx_upload_local_cert)
-        upload! fetch(:nginx_ssl_cert_local_path), "#{fetch(:tmp_dir)}/#{fetch(:nginx_ssl_cert)}"
-        upload! fetch(:nginx_ssl_cert_key_local_path), "#{fetch(:tmp_dir)}/#{fetch(:nginx_ssl_cert_key)}"
-        sudo :mv, "#{fetch(:tmp_dir)}/#{fetch(:nginx_ssl_cert)}", "/etc/ssl/certs/#{fetch(:nginx_ssl_cert)}"
-        sudo :mv, "#{fetch(:tmp_dir)}/#{fetch(:nginx_ssl_cert_key)}", "/etc/ssl/private/#{fetch(:nginx_ssl_cert_key)}"
+        upload! fetch(:nginx_ssl_cert_local_path), nginx_ssl_cert_file
+        upload! fetch(:nginx_ssl_cert_key_local_path), nginx_ssl_cert_key_file
       end
-      sudo :chown, 'root:root', "/etc/ssl/certs/#{fetch(:nginx_ssl_cert)}"
-      sudo :chown, 'root:root', "/etc/ssl/private/#{fetch(:nginx_ssl_cert_key)}"
+      sudo :chown, 'root:root', nginx_ssl_cert_file
+      sudo :chown, 'root:root', nginx_ssl_cert_key_file
     end
   end
 
   desc 'Reload nginx configuration'
   task :reload do
     on roles :web do
-      sudo '/etc/init.d/nginx reload'
+      sudo nginx_service_path, 'reload'
     end
   end
 
   before :setup, :defaults
   before :setup_ssl, :defaults
+
 end
 
 namespace :deploy do

data/lib/capistrano/tasks/unicorn.rake

@@ -1,34 +1,38 @@
+require 'capistrano/dsl/unicorn_paths'
 require 'capistrano/unicorn_nginx/helpers'
 
 include Capistrano::UnicornNginx::Helpers
+include Capistrano::DSL::UnicornPaths
 
 namespace :load do
   task :defaults do
-    set :unicorn_service_name, -> { "unicorn_#{fetch(:application)}_#{fetch(:stage)}" }
-    set :templates_path, "config/deploy/templates"
-    set :unicorn_pid, -> { shared_path.join("tmp/pids/unicorn.pid") }
-    set :unicorn_config, -> { shared_path.join("config/unicorn.rb") }
-    set :unicorn_log, -> { shared_path.join("log/unicorn.log") }
-    set :unicorn_user, nil # user is set by executing `id -un` on the server
+    set :unicorn_service, -> { "unicorn_#{fetch(:application)}_#{fetch(:stage)}" }
+    set :templates_path, 'config/deploy/templates'
+    set :unicorn_pid, -> { unicorn_default_pid_file }
+    set :unicorn_config, -> { unicorn_default_config_file }
     set :unicorn_workers, 2
+    # set :unicorn_user # default set in `unicorn:defaults` task
 
     set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids')
   end
 end
 
 namespace :unicorn do
+
+  task :defaults do
+    on roles :app do
+      set :unicorn_user, fetch(:unicorn_user, deploy_user)
+    end
+  end
+
   desc 'Setup Unicorn initializer'
   task :setup_initializer do
     on roles :app do
-      next if file_exists? "/etc/init.d/#{fetch(:unicorn_service_name)}"
-
-      set :unicorn_user, capture(:id, '-un') unless fetch(:unicorn_user)
-      init_tmp = "#{fetch(:tmp_dir)}/unicorn_init"
-
-      template 'unicorn_init.erb', init_tmp
-      execute :chmod, "+x", init_tmp
-      sudo :mv, init_tmp, "/etc/init.d/#{fetch(:unicorn_service_name)}"
-      sudo 'update-rc.d', '-f', fetch(:unicorn_service_name), 'defaults'
+      next if file_exists? unicorn_initd_file
+      template 'unicorn_init.erb', unicorn_initd_tmp_file
+      execute :chmod, '+x', unicorn_initd_tmp_file
+      sudo :mv, unicorn_initd_tmp_file, unicorn_initd_file
+      sudo 'update-rc.d', '-f', fetch(:unicorn_service), 'defaults'
     end
   end
 
@@ -36,10 +40,6 @@ namespace :unicorn do
   task :setup_app_config do
     on roles :app do
       next if file_exists? fetch(:unicorn_config)
-
-      execute :mkdir, '-p', shared_path.join('config')
-      execute :mkdir, '-p', shared_path.join('log')
-      execute :mkdir, '-p', shared_path.join('tmp/pids')
       template 'unicorn.rb.erb', fetch(:unicorn_config)
     end
   end
@@ -48,10 +48,13 @@ namespace :unicorn do
     desc "#{command} unicorn"
     task command do
       on roles :app do
-        execute :service, fetch(:unicorn_service_name), command
+        execute :service, fetch(:unicorn_service), command
       end
     end
   end
+
+  before :setup_initializer, :defaults
+
 end
 
 namespace :deploy do

data/lib/capistrano/unicorn_nginx/helpers.rb

@@ -22,6 +22,10 @@ module Capistrano
         test "[ -e #{path} ]"
       end
 
+      def deploy_user
+        capture :id, '-un'
+      end
+
     end
   end
 end

data/lib/capistrano/unicorn_nginx/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module UnicornNginx
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/capistrano/unicorn_nginx.rb

@@ -1,2 +1,3 @@
+require 'capistrano/dsl/nginx_paths'
 load File.expand_path("../tasks/nginx.rake", __FILE__)
 load File.expand_path("../tasks/unicorn.rake", __FILE__)

data/lib/generators/capistrano/unicorn_nginx/templates/nginx_conf.erb

@@ -13,8 +13,8 @@ server {
 <% if fetch(:nginx_use_ssl) %>
   listen 443;
   ssl on;
-  ssl_certificate /etc/ssl/certs/<%= fetch(:nginx_ssl_certificate) %>;
-  ssl_certificate_key /etc/ssl/private/<%= fetch(:nginx_ssl_certificate_key) %>;
+  ssl_certificate <%= nginx_ssl_cert_file %>;
+  ssl_certificate_key <%= nginx_ssl_cert_key_file %>;
 <% else %>
   listen 80;
 <% end %>
@@ -38,8 +38,8 @@ server {
 <% end %>
     proxy_pass http://unicorn_<%= fetch(:nginx_config_name) %>;
     # limit_req zone=one;
-    access_log <%= shared_path %>/log/nginx.access.log;
-    error_log <%= shared_path %>/log/nginx.error.log;
+    access_log <%= nginx_access_log_file %>;
+    error_log <%= nginx_error_log_file %>;
   }
 
   location ^~ /assets/ {

data/lib/generators/capistrano/unicorn_nginx/templates/unicorn.rb.erb

@@ -1,7 +1,7 @@
 working_directory "<%= current_path %>"
 pid "<%= fetch(:unicorn_pid) %>"
-stderr_path "<%= fetch(:unicorn_log) %>"
-stdout_path "<%= fetch(:unicorn_log) %>"
+stdout_path "<%= unicorn_log_file %>"
+stderr_path "<%= unicorn_error_log_file %>"
 
 listen "/tmp/unicorn.<%= fetch(:nginx_config_name) %>.sock"
 worker_processes <%= fetch(:unicorn_workers) %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-unicorn-nginx
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Bruno Sutic
@@ -72,6 +72,8 @@ files:
 - Rakefile
 - capistrano-unicorn-nginx.gemspec
 - lib/capistrano-unicorn-nginx.rb
+- lib/capistrano/dsl/nginx_paths.rb
+- lib/capistrano/dsl/unicorn_paths.rb
 - lib/capistrano/tasks/nginx.rake
 - lib/capistrano/tasks/unicorn.rake
 - lib/capistrano/unicorn_nginx.rb