warehouse_supervisor 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+log/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in warehouse_supervisor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Diego Guerra
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Warehouse Supervisor
+
+Easily create [supervisor](http://supervisord.org/) configuration files and run them in dev mode.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'warehouse_supervisor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install warehouse_supervisor
+
+## Usage
+
+There are 2 basic commands:
+
+### print
+
+    warehouse_supervisor print -g production -c config.yml processes.conf.erb
+    
+This will print your config file according to config.yml and processes.conf.erb
+
+### start
+
+    warehouse_supervisor start -g production -c config.yml processes.conf.erb
+
+This will start a supervisor instance running in the foreground with the config you specified
+
+Both these commands take the following options:
+
+  * --group | -g: Group to use
+  * --config | -c: Definition file
+  * --log-dir | -q (only in `start`): Log directory
+
+## Files
+
+Warehouse Supervisor needs 2 files to work:
+
+- Templates file
+- Definitions file
+
+### Templates file
+
+This is an erb file where you'll define the different *program templates* that your app uses, for example:
+
+    <% template :resque_web do %>
+    user = <%= user || ENV["USER"] %>
+    directory = <%=dir || ENV["RAILS_ROOT"]%>
+    command = bundle exec resque-web -F -L -p 5678 config/resque_config.rb 
+    environment = HOME='<%=home || ENV["HOME"]%>',USER=<%=user || ENV["USER"]%>
+    <% end %>
+
+Each program template that you need will be define in a `template` block.
+
+### Definitions file
+
+This is a yml file where you can define the *programs* that supervisor will run. For example:
+
+    development:
+      resque_web:
+        template: resque_web
+        dir: "/my/dir"
+
+It defines groups of programs and for each one defines the template to be used and the variables 
+that each program requires.
+
+For each program Warehouse Supervisor will compile its template with the provided variables, and it'll add this to
+the output. This way you may use generic templates to define similar programs.
+
+For a full example of both files check the examples dir.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/warehouse_supervisor

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require 'lib/warehouse_supervisor/warehouse_supervisor_cli'
+
+WarehouseSupervisor::WarehouseSupervisorCli.start(ARGV)

data/example/processes.conf.erb

@@ -0,0 +1,25 @@
+<% template :worker do %>
+  user = <%= user || ENV["USER"] %>
+  command = bundle exec rake environment resque:work
+  environment = QUEUE='<%=queues.join(",")%>',HOME='<%=home || ENV["HOME"]%>',USER=<%=user || ENV["USER"]%>, RAILS_ENV=<%=rails_env || ENV["RAILS_ENV"]%>, VERBOSE=1
+  directory = <%=dir || ENV["RAILS_ROOT"]%>
+  numprocs = <%=num_procs || 1%>
+  process_name = %(program_name)s_%(process_num)d
+  redirect_stderr = true
+  stdout_logfile = log/%(program_name)s_%(process_num)d
+<% end %>
+
+<% template :scheduler do %>
+  user = <%= user || ENV["USER"] %>
+  command = bundle exec rake resque:scheduler
+  directory = <%=dir || ENV["RAILS_ROOT"]%>
+  environment = HOME='<%=home || ENV["HOME"]%>',USER=<%=user || ENV["USER"]%>, RAILS_ENV=<%=rails_env || ENV["RAILS_ENV"]%>, VERBOSE=1
+<% end %>
+
+<% template :resque_web do %>
+  user = <%= user || ENV["USER"] %>
+  directory = <%=dir || ENV["RAILS_ROOT"]%>
+  command = bundle exec resque-web -F -L -p 5678 config/resque_config.rb 
+  environment = HOME='<%=home || ENV["HOME"]%>',USER=<%=user || ENV["USER"]%>, RAILS_ENV=<%=rails_env || ENV["RAILS_ENV"]%>, VERBOSE=1
+<% end %>
+

data/example/warehouse_supervisor.yml

@@ -0,0 +1,32 @@
+development:
+  resque_workers:
+    template: worker
+    queues: 
+      - high
+      - medium
+      - low
+    num_procs: 1
+  resque_scheduler:
+    template: scheduler
+  resque_web:
+    template: resque_web
+    dir: awesome
+    
+production:
+  high_resque_workers:
+    template: worker
+    queues: 
+     - high
+    num_procs: 2
+  all_resque_workers:
+    template: worker
+    queues: 
+     - high
+     - medium
+     - low
+  resque_scheduler:
+    template: scheduler
+  resque_web:
+    template: resque_web
+
+

data/lib/warehouse_supervisor.rb

@@ -0,0 +1,5 @@
+require "warehouse_supervisor/version"
+
+module WarehouseSupervisor
+  # Your code goes here...
+end

data/lib/warehouse_supervisor/program_renderer.rb

@@ -0,0 +1,18 @@
+require 'erb'
+require 'warehouse_supervisor/template_binding'
+
+module WarehouseSupervisor
+  class ProgramRenderer
+
+    def initialize(definitions, erb_content)
+      @definitions = definitions
+      @erb_content = erb_content
+    end
+
+    def render(program_name)
+      program_definition = TemplateBinding.new(program_name, @definitions[program_name])
+      ERB.new(@erb_content, nil, nil, "@output").result(program_definition.get_binding).gsub(/^$\n/, "").gsub(/^[\s]+/, "")
+    end
+  end
+
+end

data/lib/warehouse_supervisor/renderer.rb

@@ -0,0 +1,16 @@
+require 'warehouse_supervisor/program_renderer'
+
+module WarehouseSupervisor
+  class Renderer
+    def initialize(definitions, erb_content)
+      @definitions = definitions
+      @erb_content = erb_content
+    end
+
+    def render
+      r = ProgramRenderer.new(@definitions, @erb_content)
+      @definitions.keys.map { |program_name| r.render(program_name) }.join("\n")
+    end
+
+  end
+end

data/lib/warehouse_supervisor/template_binding.rb

@@ -0,0 +1,29 @@
+module WarehouseSupervisor
+
+  class TemplateBinding 
+    def initialize(program_name, hash)
+      @program_name = program_name
+      @template = hash["template"]
+      singleton = class << self; self end
+      hash.each do |method_name, value|
+        singleton.send(:define_method, method_name) {value} unless method_name == "template"
+      end
+    end
+
+    def template(t)
+      if @template == t.to_s
+        @output << "[program:#{@program_name}]"
+        yield
+      end
+    end
+
+    def method_missing(*args)
+      nil
+    end
+
+    def get_binding
+      binding
+    end
+
+  end
+end

data/lib/warehouse_supervisor/version.rb

@@ -0,0 +1,3 @@
+module WarehouseSupervisor
+  VERSION = "0.0.1"
+end

data/lib/warehouse_supervisor/warehouse_supervisor_cli.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'yaml'
+require 'tempfile'
+require 'fileutils'
+require 'thor'
+require 'warehouse_supervisor/renderer'
+
+module WarehouseSupervisor
+  class WarehouseSupervisorCli < Thor
+    class_option :group, :aliases => :g, :default => "development"
+    class_option :config, :aliases => :c, :required => true
+
+    desc "print file", "output the file acording to the config"
+    def print(erb_file)
+      puts generate_contents(options[:group], options[:config], erb_file)
+    end
+
+    desc "start file", "start an undemonized supervisor with file"
+    option :log_dir, :aliases => :q, :default => "log"
+    def start(erb_file)
+      Tempfile.open("supervisord.conf") do |f|
+        log_dir = options[:log_dir]
+        f.puts "[supervisord]"
+        f.puts "logfile = #{File.join(log_dir, "supervisord.log")}"
+        f.puts "childlogdir = #{log_dir}"
+        f.puts "nodaemon = true"
+        f.puts
+        f.write generate_contents(options[:group], options[:config], erb_file)
+        f.flush
+        FileUtils.mkdir_p options[:log_dir]
+        command = "supervisord -c '#{f.path}'"
+        puts command
+        exec command
+      end
+    end
+
+    private 
+
+    def generate_contents(group, definitions_file, erb_file)
+      definitions = YAML.load(File.read(definitions_file))[group.to_s]
+      erb_content = File.read(erb_file)
+      Renderer.new(definitions, erb_content).render
+    end
+
+  end
+end

data/spec/warehouse_supervisor/program_renderer_spec.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'yaml'
+require 'warehouse_supervisor/program_renderer'
+
+include WarehouseSupervisor
+
+describe ProgramRenderer do
+
+  let(:erb_content) {File.read "example/processes.conf.erb"}
+  let(:definitions) {YAML.load(File.read "example/warehouse_supervisor.yml")}
+
+  it "should render the title once" do
+    pr = ProgramRenderer.new(definitions["development"], erb_content).render("resque_web")
+    pr.scan(/\[program:resque_web\]/).should have(1).element
+  end
+
+  it "should not render other templates" do
+    pr = ProgramRenderer.new(definitions["development"], erb_content).render("resque_web")
+    pr.should_not =~ /worker/
+  end
+
+  it "should render the variables" do
+    pr = ProgramRenderer.new(definitions["development"], erb_content).render("resque_web")
+    pr.should =~ /directory = awesome/
+  end
+
+  it "should have a pretty output" do
+    pr = ProgramRenderer.new(definitions["development"], erb_content).render("resque_web")
+    pr.should_not include "\n\n"
+  end
+
+  it "should remove starting spaces" do
+    pr = ProgramRenderer.new(definitions["development"], erb_content).render("resque_web")
+    pr.should_not include "^\s+"
+  end
+end

data/spec/warehouse_supervisor/renderer_spec.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'yaml'
+require 'warehouse_supervisor/renderer'
+
+include WarehouseSupervisor
+
+describe Renderer do
+  let(:erb_content) {File.read "example/processes.conf.erb"}
+  let(:definitions) {YAML.load(File.read "example/warehouse_supervisor.yml")}
+
+  it "should render the full file" do
+    c = Renderer.new(definitions["development"], erb_content).render
+    c.scan(/\[program:resque_web\]/).should have(1).element
+    c.scan(/\[program:resque_workers\]/).should have(1).element
+    c.scan(/\[program:resque_scheduler\]/).should have(1).element
+  end
+
+
+end

data/spec/warehouse_supervisor/template_binding_spec.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'yaml'
+require 'warehouse_supervisor/template_binding'
+
+include WarehouseSupervisor
+
+describe TemplateBinding do
+
+  it "should define methods" do
+    t = TemplateBinding.new("tal", "cosa" => "otra")
+    t.cosa.should eql "otra"
+  end
+
+  it "should not redefine template" do
+    t = TemplateBinding.new("tal", "cosa" => "otra", "template" => "tala")
+    expect {t.template}.to raise_error
+  end
+
+  it "should not break on non-existing methods" do
+    t = TemplateBinding.new("tal", "cosa" => "otra", "template" => "tala")
+    t.otrassss.should be_nil
+  end
+
+end

data/warehouse_supervisor.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'warehouse_supervisor/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "warehouse_supervisor"
+  gem.version       = WarehouseSupervisor::VERSION
+  gem.authors       = ["Diego Guerra"]
+  gem.email         = ["diego.guerra.suarez@gmail.com"]
+  gem.description   = %q{Easily create and run supervisord configuration files}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/dgsuarez/warehouse_supervisor"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rake'
+  gem.add_dependency 'thor'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: warehouse_supervisor
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Diego Guerra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-04-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Easily create and run supervisord configuration files
+email: 
+- diego.guerra.suarez@gmail.com
+executables: 
+- warehouse_supervisor
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/warehouse_supervisor
+- example/processes.conf.erb
+- example/warehouse_supervisor.yml
+- lib/warehouse_supervisor.rb
+- lib/warehouse_supervisor/program_renderer.rb
+- lib/warehouse_supervisor/renderer.rb
+- lib/warehouse_supervisor/template_binding.rb
+- lib/warehouse_supervisor/version.rb
+- lib/warehouse_supervisor/warehouse_supervisor_cli.rb
+- spec/warehouse_supervisor/program_renderer_spec.rb
+- spec/warehouse_supervisor/renderer_spec.rb
+- spec/warehouse_supervisor/template_binding_spec.rb
+- warehouse_supervisor.gemspec
+homepage: https://github.com/dgsuarez/warehouse_supervisor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Easily create and run supervisord configuration files
+test_files: 
+- spec/warehouse_supervisor/program_renderer_spec.rb
+- spec/warehouse_supervisor/renderer_spec.rb
+- spec/warehouse_supervisor/template_binding_spec.rb