orats 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a725f12656a6becdd6ae20faf0c0bda7931155d
-  data.tar.gz: 244645b83953ef5e8e86cd384fd3c1af29ff48ea
+  metadata.gz: 06d673cccc421756a9ce6a7398c8a5953245f7c7
+  data.tar.gz: 9bea9a885137b89ff186287604a54bec948ff159
 SHA512:
-  metadata.gz: 22b712f9ff800cb0e0c38849972df8ef4ae3ed787e504a7a8962be3a726530e35bbf16ede4d65f08c6e0f15749f710e6a903de49e46ae0ec9b46b44c2a0bff44
-  data.tar.gz: b25aa0727359cdba80242c209c21811232178ef0f12048924e5967f7397dc3e9b9e921338449541d3332c12dabdcde70d77c0d4f824fcce666e39f5f6b9a625b
+  metadata.gz: 0b6b7592f901be422559dca5b4409e9fd2db5ff579100d5e472d6d522a44cdcfc8e68614a1172ce046f3371385ad414b62a743e014ecdc9ec7691ea32a6bc55e
+  data.tar.gz: 52d2a71d2b084bb80a55e0f97531d3fe6d1738bad452d623452c900d74af8520d43f2f85c27d9a79e1dccee7c00893e46b734e49aa5ef02c21f001a9d1252c3e

data/README.md

@@ -104,7 +104,7 @@ All of the changes have git commits to go with them. After generating a project
 - **Core changes**:
     - Use `postgres` as the primary SQL database
     - Use `redis` as the cache backend
-    - Use `puma` as the web server
+    - Use `puma` or `unicorn` as the web backend
     - Use `sidekiq` as a background worker
 - **Features**:
     - Configure scheduled jobs and tasks using `whenever`

data/lib/orats/cli.rb

@@ -50,6 +50,7 @@ module Orats
     option :template, default: '', aliases: '-t'
     option :custom, default: '', aliases: '-c'
     option :skip_server_start, type: :boolean, default: false, aliases: '-S'
+    option :backend, default: 'puma', aliases: '-b'
     option :rc, default: ''
     desc 'new PATH [options]', 'Create a new orats application'
     long_desc File.read(File.join(File.dirname(__FILE__), 'cli_help/new'))

data/lib/orats/cli_help/new

@@ -24,4 +24,6 @@ Template features:
 
 Project features:
 
+`--backend` to switch to a different server backend, ie. unicorn
+
 `--skip-server-start` to skip automatically running puma and sidekiq [false]

data/lib/orats/commands/new/rails.rb

@@ -41,6 +41,7 @@ module Orats
           gsub_postgres_info
           gsub_redis_info
           gsub_readme
+          gsub_unicorn if @options[:backend] == 'unicorn'
 
           bundle_install
           bundle_binstubs
@@ -99,6 +100,17 @@ module Orats
           commit 'Update the readme'
         end
 
+        def gsub_unicorn
+          task 'Update files for switching to unicorn'
+
+          gsub_file "#{@target_path}/Procfile", 'puma -C config/puma.rb',
+                    'unicorn -c config/unicorn.rb'
+          gsub_file "#{@target_path}/Gemfile", "gem 'puma'", "#gem 'puma'"
+          gsub_file "#{@target_path}/Gemfile", "#gem 'unic", "gem 'unic"
+
+          commit 'Switch from puma to unicorn'
+        end
+
         def bundle_install
           task 'Run bundle install, this may take a while'
           run_from @target_path, 'bundle install'
@@ -108,7 +120,8 @@ module Orats
 
         def bundle_binstubs
           task 'Run bundle binstubs for a few gems'
-          run_from @target_path, 'bundle binstubs whenever puma sidekiq'
+          run_from @target_path,
+                   "bundle binstubs whenever #{@options[:backend]} sidekiq"
 
           commit 'Add binstubs for the important gems'
         end

data/lib/orats/postgres.rb

@@ -38,7 +38,7 @@ module Orats
       task 'Check if the postgres database exists'
 
       # detect if the database already exists
-      database = File.basename(@target_path)
+      database = "#{File.basename(@target_path)}_development"
       return if run("#{postgres_bin} -d #{database} -l | " + \
                     "grep #{database} | wc -l", capture: true).chomp == '0'
 

data/lib/orats/templates/base.rb

@@ -195,9 +195,18 @@ def add_puma_config
   task __method__
 
   orats_to_local 'config/puma.rb'
+  gsub_file 'config/puma.rb', 'app_name', app_name
   commit 'Add the puma config'
 end
 
+def add_unicorn_config
+  task __method__
+
+  orats_to_local 'config/unicorn.rb'
+  gsub_file 'config/unicorn.rb', 'app_name', app_name
+  commit 'Add the unicorn config'
+end
+
 def add_sidekiq_config
   task __method__
 
@@ -494,6 +503,7 @@ update_app_secrets
 update_app_config
 update_database_config
 add_puma_config
+add_unicorn_config
 add_sidekiq_config
 add_sitemap_config
 add_whenever_config

data/lib/orats/templates/includes/new/rails/.env

@@ -29,8 +29,24 @@ ACTION_MAILER_DEFAULT_TO: 'me@app_name.com'
 DATABASE_URL: 'postgresql://db_user@db_location:db_port/app_name?encoding=utf8&pool=5&timeout=5000'
 CACHE_URL: 'redis://cache_location:cache_port/0'
 
-PUMA_THREADS_MIN: 0
-PUMA_THREADS_MAX: 1
-PUMA_WORKERS: 0
-
+# try setting these to 0/16 in production and tweak from there
+# in development mode you should use 0/1 ( multi-threaded + debugging = :< )
+# these only apply if you're using puma
+THREADS_MIN: 0
+THREADS_MAX: 1
+
+# this should equal the number of CPU cores in production
+# in development mode it set to 0 so puma does not go into cluster mode, unicorn
+# will also correctly function with 0 workers in development mode
+WORKERS: 1
+
+# this should equal the database pool size
 SIDEKIQ_CONCURRENCY: 5
+
+# the path where logs get written to
+# in production you might consider /var/log/app_name
+LOG_PATH: 'log'
+
+# the path that will contain pids and sockets
+# in production you will likely want to set this to '/var/run/app_name'
+RUN_STATE_PATH: 'tmp'

data/lib/orats/templates/includes/new/rails/Gemfile

@@ -13,6 +13,7 @@ gem 'pg', '~> 0.17.1'
 gem 'redis-rails', '~> 4.0.0'
 
 gem 'puma', '~> 2.9.0'
+#gem 'unicorn', '~> 4.8.3'
 gem 'sidekiq', '~> 3.2.1'
 gem 'sinatra', '>= 1.4.5', require: false
 

data/lib/orats/templates/includes/new/rails/Procfile

@@ -1,3 +1,3 @@
-web: puma -C config/puma.rb -p 3000 | grep -v --line-buffered ' 304 -'
+web: puma -C config/puma.rb | grep -v --line-buffered ' 304 -'
 worker: sidekiq -C config/sidekiq.yml
 log: tail -f log/development.log | grep -xv --line-buffered '^[[:space:]]*' | grep -v --line-buffered '/assets/'

data/lib/orats/templates/includes/new/rails/config/puma.rb

@@ -1,19 +1,29 @@
 environment ENV['RAILS_ENV']
 
-threads ENV['PUMA_THREADS_MIN'].to_i, ENV['PUMA_THREADS_MAX'].to_i
-workers ENV['PUMA_WORKERS'].to_i
+threads ENV['THREADS_MIN'].to_i, ENV['THREADS_MAX'].to_i
+workers ENV['WORKERS'].to_i
 
-pidfile "tmp/puma.pid"
+if ENV['RAILS_ENV'] == 'development' || ENV['RAILS_ENV'] == 'test'
+  bind 'tcp://0.0.0.0:3000'
+else
+  bind "unix:#{ENV['RUN_STATE_PATH']}/app_name"
+end
+
+pidfile "#{ENV['RUN_STATE_PATH']}/app_name.pid"
+
+worker_timeout 30
+
+stdout_redirect "#{ENV['LOG_PATH']}/app_name.stdout.log",
+                "#{ENV['LOG_PATH']}/app_name.stderr.log"
 
-# https://github.com/puma/puma/blob/master/examples/config.rb#L125
-prune_bundler
+preload_app!
 
-restart_command 'bundle exec bin/puma'
+restart_command 'bundle exec puma'
 
 on_worker_boot do
-  require 'active_record'
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.connection.disconnect!
 
-  config_path = File.expand_path('../database.yml', __FILE__)
-  ActiveRecord::Base.connection.disconnect! rescue ActiveRecord::ConnectionNotEstablished
-  ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'] || YAML.load_file(config_path)[ENV['RAILS_ENV']])
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.establish_connection
 end

data/lib/orats/templates/includes/new/rails/config/sidekiq.yml

@@ -1,5 +1,5 @@
 ---
-:pidfile: 'tmp/sidekiq.pid'
+:pidfile: "<%= ENV['RUN_STATE_PATH'] %>/sidekiq.pid"
 :concurrency: <%= ENV['SIDEKIQ_CONCURRENCY'].to_i %>
 :queues:
   - default

data/lib/orats/templates/includes/new/rails/config/unicorn.rb

@@ -0,0 +1,52 @@
+# heavily inspired by gitlab:
+# https://github.com/gitlabhq/gitlabhq/blob/master/config/unicorn.rb.example
+
+worker_processes ENV['WORKERS'].to_i
+
+if ENV['RAILS_ENV'] == 'development' || ENV['RAILS_ENV'] == 'test'
+  listen '0.0.0.0:3000'
+else
+  listen "unix:#{ENV['RUN_STATE_PATH']}/app_name", backlog: 64
+end
+
+pid "#{ENV['RUN_STATE_PATH']}/app_name.pid"
+
+timeout 30
+
+stdout_path "#{ENV['LOG_PATH']}/app_name.stdout.log"
+stderr_path "#{ENV['LOG_PATH']}/app_name.stderr.log"
+
+preload_app true
+
+GC.respond_to?(:copy_on_write_friendly=) and
+  GC.copy_on_write_friendly = true
+
+check_client_connection false
+
+before_fork do |server, worker|
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.connection.disconnect!
+
+  # The following is only recommended for memory/DB-constrained
+  # installations. It is not needed if your system can house
+  # twice as many worker_processes as you have configured.
+  #
+  # This allows a new master process to incrementally
+  # phase out the old master process with SIGTTOU to avoid a
+  # thundering herd (especially in the "preload_app false" case)
+  # when doing a transparent upgrade. The last worker spawned
+  # will then kill off the old master process with a SIGQUIT.
+  old_pid = "#{server.config[:pid]}.oldbin"
+  if old_pid != server.pid
+    begin
+      sig = (worker.nr + 1) >= server.worker_processes ? :QUIT : :TTOU
+      Process.kill(sig, File.read(old_pid).to_i)
+    rescue Errno::ENOENT, Errno::ESRCH
+    end
+  end
+end
+
+after_fork do |server, worker|
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.establish_connection
+end

data/lib/orats/version.rb

@@ -1,4 +1,4 @@
 # set the version of this gem
 module Orats
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 end

data/test/integration/cli_test.rb

@@ -23,6 +23,10 @@ class TestCLI < Minitest::Test
     assert_new '--template auth'
   end
 
+  def test_new_with_unicorn
+    assert_new '--backend unicorn'
+  end
+
   def test_new_with_invalid_template
     @target_path = generate_app_name
     @extra_flags = "#{ORATS_NEW_FLAGS} --template foo"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orats
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Nick Janetakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -137,6 +137,7 @@ files:
 - lib/orats/templates/includes/new/rails/config/secrets.yml
 - lib/orats/templates/includes/new/rails/config/sidekiq.yml
 - lib/orats/templates/includes/new/rails/config/sitemap.rb
+- lib/orats/templates/includes/new/rails/config/unicorn.rb
 - lib/orats/templates/includes/new/rails/lib/tasks/orats/favicon.rake
 - lib/orats/templates/includes/new/rails/public/404.html
 - lib/orats/templates/includes/new/rails/public/422.html