matross 0.1.0 → 0.2.0

data/README.md

@@ -6,7 +6,7 @@ Put matross in the `:development` group of your `Gemfile`:
 
 ```ruby
 group :development do
-    gem 'matross', :git => 'git://github.com/innvent/matross.git'
+  gem 'matross', :git => 'git://github.com/innvent/matross.git'
 end
 ```
 
@@ -23,5 +23,25 @@ We made a bunch of additions and customizations. Below we list the most relevant
 
 * **Foreman by default**:
 * **Custom foreman upstart template**: we use a custom upstart template, that enables `console log`, allowing `logrotate` to work properly.
-* **User template overwrite**:
 
+## Overriding default templates
+We have our opinions, but don't know everything. What works for us, may not fit your needs since each app is a unique snowflake. To take care of that `matross` allows you to define your own templates to use instead of the built in ones. Look at the included ones in `lib/matross/templates` to see how we think things should go.
+
+For example to override the default `lib/matross/templates/unicorn.rb.erb` simply put your template in your applications `config/matross/unicorn/unicorn.rb.erb`. The general idea is `config/matross/#{recipe_name}/#{erb_template}`
+
+## Managing application daemons with Foreman
+
+Foreman has freed us of the tedious task of writing `init` and `upstart` scripts. Some of our `matross` recipes automatically add processes - such as the `unicorn` server - to the Procfile.
+
+If you have an application Procfile with custom daemons defined, such as `delayed_job`, they will be concantenated with all the processes defined in `matross`, resulting in one final Procfile-matross file that will be used to start your app and export init scrips.
+
+You can specify the number of each instance defined in Procfile-matross using the `foreman_procs` capistrano variable.
+Supose you have a process called `dj` and want to export 3 instances of it:
+
+```ruby
+set :foreman_procs, {
+    dj: 3
+}
+```
+
+We also modified the default upstart template to log through upstart instead of just piping stdout and stderr into files. Goodbye nocturnal logexplosion. (Like all templates you can override it)

data/lib/matross/base.rb

@@ -1,3 +1,6 @@
+require 'bundler'
+require 'matross/errors'
+
 def template(from, to)
   override_template = File.join(Dir.pwd, 'config/matross', from)
   if File.exist?(override_template)
@@ -7,3 +10,21 @@ def template(from, to)
   end
   put ERB.new(erb).result(binding), to
 end
+
+def dep_included?(dependency)
+  lockfile = Bundler::LockfileParser.new(Bundler.read_file(Bundler.default_lockfile)) 
+  if not lockfile.specs.any? { |gem| gem.name == dependency} then
+    raise Matross::MissingDepError, "recipe requires the #{dependency} gem"
+  end
+end
+
+namespace :base do
+
+  task :logrotate, :roles => :app do
+    run "mkdir -p #{shared_path}/config"
+    template "base/logrotate.erb", "#{shared_path}/config/logrotate"
+    run "#{sudo} ln -nfs #{shared_path}/config/logrotate /etc/logrotate.d/#{application}"
+  end
+  after "deploy:setup", "base:logrotate"
+
+end

data/lib/matross/delayed_job.rb

@@ -0,0 +1,15 @@
+dep_included? 'delayed_job'
+
+namespace :delayed_job do
+
+  desc "Writes the delayed job part of the Procfile"
+  task :procfile, :roles => :dj do
+    procfile_template = <<-EOF.gsub(/^\s+/, '')
+      dj: bundle exec rake jobs:work
+    EOF
+    procfile = ERB.new(procfile_template, nil, '-')
+    put procfile.result(binding), "#{shared_path}/Procfile.dj"
+  end
+  after "foreman:pre_setup", "delayed_job:procfile"
+
+end

data/lib/matross/errors.rb

@@ -0,0 +1,4 @@
+module Matross
+  Error = Class.new(RuntimeError)
+  MissingDepError = Class.new(Error)
+end

data/lib/matross/foreman.rb

@@ -1,5 +1,8 @@
+dep_included? 'foreman'
+
 _cset(:foreman_user)  { user }
 _cset :foreman_bin,   "bundle exec foreman"
+_cset :foreman_procs, {}
 
 namespace :foreman do
 
@@ -9,10 +12,18 @@ namespace :foreman do
   end
   before "foreman:setup", "foreman:pre_setup"
 
-  desc "Merges all partial Procfiles"
+  desc "Merges all partial Procfiles and defines a specific dotenv"
   task :setup do
-    run "cat #{shared_path}/Procfile.* > #{shared_path}/Procfile"
+    run "cat $(test -f #{current_path}/Procfile && echo -n \"#{current_path}/Procfile\") #{shared_path}/Procfile.* > #{shared_path}/Procfile-matross"
     run "rm #{shared_path}/Procfile.*"
+
+    dotenv_template = <<-EOF.gsub(/^\s+/, '')
+      RAILS_ENV=#{rails_env.to_s.shellescape}
+    EOF
+    dotenv = ERB.new(dotenv_template, nil, '-')
+    put dotenv.result(binding), "#{shared_path}/.env-matross-partial"
+    run "cat $(test -f #{current_path}/.env && echo \"$_\") #{shared_path}/.env-matross-partial > #{shared_path}/.env-matross"
+    run "rm #{shared_path}/.env-matross-partial"
   end
   before "foreman:export", "foreman:setup"
 
@@ -23,22 +34,53 @@ namespace :foreman do
     upload File.expand_path("../templates/foreman", __FILE__), matross_path,
            :via => :scp, :recursive => true
 
+    # By default spawn one instance of every process
+    procs = {}
+    capture("cat #{current_path}/Procfile-matross").split("\n").each { |line|
+      process = line[/^([A-Za-z0-9_]+):\s*(.+)$/, 1]
+      procs[process] = 1
+    }
+    procs.merge!(foreman_procs)
+
+    proc_list = ""
+    procs.each { |process, num|
+      proc_list << ',' unless proc_list.empty?
+      proc_list << "#{process}=#{num}"
+    }
+    proc_list = " -c #{proc_list}" unless proc_list.empty?
+
     run "cd #{current_path} && #{foreman_bin} export upstart #{shared_path}/upstart "\
-      "-f #{current_path}/Procfile "\
+      "-f #{current_path}/Procfile-matross "\
       "-a #{application} "\
       "-u #{foreman_user} "\
       "-l #{shared_path}/log "\
-      "-t #{matross_path}/foreman"
+      "-t #{matross_path}/foreman "\
+      "-e #{shared_path}/.env-matross"\
+      << proc_list
     run "cd #{shared_path}/upstart && #{sudo} cp * /etc/init/"
   end
   before "deploy:restart", "foreman:export"
 
   desc "Symlink configuration scripts"
   task :symlink, :roles => [:app, :dj], :except => { :no_release => true } do
-    run "ln -nfs #{shared_path}/Procfile #{release_path}/Procfile"
+    run "ln -nfs #{shared_path}/Procfile-matross #{current_path}/Procfile-matross"
+    run "ln -nfs #{shared_path}/.env-matross #{current_path}/.env-matross"
   end
   after "foreman:setup", "foreman:symlink"
 
+  desc "Symlink upstart logs to application shared/log"
+  task :log, :roles => [:app, :dj] do
+    capture("ls #{shared_path}/upstart -1").split(/\r?\n/).each { |line|
+      log = File.basename(line.sub(/\.conf\Z/, ".log"))
+      run <<-EOF.gsub(/^\s+/, '')
+        #{sudo} touch /var/log/upstart/#{log} &&
+        #{sudo} chmod o+r /var/log/upstart/#{log} &&
+        ln -nfs /var/log/upstart/#{log} #{shared_path}/log/#{log}
+      EOF
+    }
+  end
+  after "foreman:export", "foreman:log"
+
   desc "Restart services"
   task :restart, :roles => [:app, :dj] do
     run "#{sudo} start #{application} || #{sudo} restart #{application}"

data/lib/matross/mysql.rb

@@ -0,0 +1,43 @@
+dep_included? 'mysql2'
+
+_cset(:database_config) { "#{shared_path}/config/database.yml" }
+
+namespace :db do
+
+  desc "Creates the database.yml file in shared path"
+  task :setup, :roles => [:app, :dj] do
+    run "mkdir -p #{shared_path}/config"
+    template "mysql/database.yml.erb", database_config
+  end
+  after "deploy:setup", "db:setup"
+
+  desc "Updates the symlink for database.yml for the just deployed release"
+  task :symlink, :roles => [:app, :dj] do
+    run "ln -nfs #{database_config} #{current_path}/config/database.yml"
+  end
+  before "deploy:restart", "db:symlink"
+
+  desc "Creates the application database"
+  task :create, :roles  => [:db] do
+    sql = <<-EOF.gsub(/^\s+/, '')
+      CREATE DATABASE IF NOT EXISTS #{mysql_database};
+    EOF
+    run "mysql --user=#{mysql_user} --password=#{mysql_passwd} --host=#{mysql_host} --execute=\"#{sql}\""
+  end
+  after "db:setup", "db:create"
+
+  desc "Loads the application schema into the database"
+  task :schema_load, :roles => [:db] do
+    sql = <<-EOF.gsub(/^\s+/, '')
+      SELECT count(*) FROM information_schema.TABLES WHERE (TABLE_SCHEMA = '#{mysql_database}');
+    EOF
+    table_count = capture("mysql --batch --skip-column-names "\
+                          "--user=#{mysql_user} "\
+                          "--password=#{mysql_passwd} "\
+                          "--host=#{mysql_host} "\
+                          "--execute=\"#{sql}\"").to_i
+    run "cd #{current_path} &&"\
+      "RAILS_ENV=#{rails_env.to_s.shellescape} bundle exec rake db:schema:load" if table_count == 0
+  end
+  after "db:symlink", "db:schema_load"
+end

data/lib/matross/templates/base/logrotate.erb

@@ -0,0 +1,9 @@
+<%= shared_path %>/log/<%= rails_env %>.log {
+        weekly
+        missingok
+        rotate 52
+        compress
+        delaycompress
+        notifempty
+        copytruncate
+}

data/lib/matross/templates/mysql/database.yml.erb

@@ -0,0 +1,9 @@
+<%= rails_env %>:
+  adapter: mysql2
+  host: <%= mysql_host %>
+  database: <%= mysql_database %>
+  username: <%= mysql_user %>
+  password: <%= mysql_passwd %>
+  pool: 5
+  encoding: utf8
+  reconnect: true

data/lib/matross/templates/unicorn/unicorn.rb.erb

@@ -2,8 +2,6 @@ app_path            = "<%= current_path %>"
 
 working_directory   "#{app_path}"
 pid                 "#{app_path}/tmp/pids/unicorn.pid"
-stderr_path         "#{app_path}/log/unicorn.log"
-stdout_path         "#{app_path}/log/unicorn.log"
 
 listen              "/tmp/unicorn.sock"
 worker_processes    <%= unicorn_workers %>

data/lib/matross/unicorn.rb

@@ -1,3 +1,5 @@
+dep_included? 'unicorn'
+
 _cset(:unicorn_config)  { "#{shared_path}/config/unicorn.rb" }
 _cset(:unicorn_log)     { "#{shared_path}/log/unicorn.log" }
 _cset :unicorn_workers, 1
@@ -17,7 +19,7 @@ namespace :unicorn do
       web: bundle exec unicorn -c <%= unicorn_config %> -E <%= rails_env %>
     EOF
     procfile = ERB.new(procfile_template, nil, '-')
-    put procfile.result(binding), "#{shared_path}/Procfile.app"
+    put procfile.result(binding), "#{shared_path}/Procfile.web"
   end
   after "foreman:pre_setup", "unicorn:procfile"
 

data/lib/matross/version.rb

@@ -1,3 +1,3 @@
 module Matross
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/matross.gemspec

@@ -6,7 +6,7 @@ require "matross/version"
 Gem::Specification.new do |spec|
   spec.name          = "matross"
   spec.version       = Matross::VERSION
-  spec.authors       = ["Artur Rodrigues" , "Joao Sa"]
+  spec.authors       = ["Artur Rodrigues", "Joao Sa"]
   spec.email         = ["arturhoo@gmail.com", "me@joaomsa.com"]
   spec.description   = %q{Our collection of opnionated Capistrano recipes}
   spec.summary       = %q{Our collection of opnionated Capistrano recipes}
@@ -19,8 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry"
 
-  spec.add_dependency "capistrano", "~> 2.15.5"
+  spec.add_dependency "capistrano", "~> 2.15.0"
 end
 
 

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: matross
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Artur Rodrigues
@@ -9,11 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2013-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -21,24 +23,43 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.15.5
+        version: 2.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.15.5
+        version: 2.15.0
 description: Our collection of opnionated Capistrano recipes
 email:
 - arturhoo@gmail.com
@@ -53,13 +74,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - lib/matross.rb
 - lib/matross/base.rb
+- lib/matross/delayed_job.rb
+- lib/matross/errors.rb
 - lib/matross/foreman.rb
 - lib/matross/local_assets.rb
+- lib/matross/mysql.rb
 - lib/matross/nginx.rb
+- lib/matross/templates/base/logrotate.erb
 - lib/matross/templates/foreman/process.conf.erb
+- lib/matross/templates/mysql/database.yml.erb
 - lib/matross/templates/nginx/nginx_virtual_host_conf.erb
 - lib/matross/templates/unicorn/unicorn.rb.erb
 - lib/matross/unicorn.rb
@@ -68,25 +93,27 @@ files:
 homepage: https://github.com/innvent/matross
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Our collection of opnionated Capistrano recipes
 test_files: []
+has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Mjc1ZTA0NDY3NTgzOTE4ODFlNmU2NDM2ODkxYjBmOGIwMmYxYTg4NA==
-  data.tar.gz: !binary |-
-    ZjFkM2Q0OGMwNTZiMmJkMGRiNzliMjYwYTcwNTZiZjcyOGNhZDA1Nw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MjA2MjczMGRjMDNjZDM5M2ZiOGIwMDRjMmNlYTY3NjM1NmE5MWJhODgxYmQ0
-    ZDM3MGZkMDhkMWM4YWY5ZjA5MzI0MzEzYjIxM2VkM2E1YWM2OTU2NWMzZWEy
-    MDBjODgxYmIyZWNmOTM0MmUxNzVhYmNhMjVlNGJjYWMzNzg1MmU=
-  data.tar.gz: !binary |-
-    MjZmMzllNzlkMjMxMjE1MGRmMjdjZjMxYjdkMmZiZTA5YmQ4MWE2YjdlYWVh
-    MjA3YTgyNTc5YjI4NzA3MzdhYWEzNmM3YjAyYjUyMmY5MjcyZmJlYWI4MGY2
-    ZWZjNzc5ZjhlNTVhZThiNmZlZTFmODg2ZWJmOTU5MDBjMjQ0Zjk=

data/VERSION

@@ -1 +0,0 @@
-0.0.0