0.12.0

.gitignore

@@ -1,7 +1,8 @@
 .bundle
 coverage
 example/log/*
-man/*.?
 man/*.html
 man/*.markdown
 pkg
+tags
+

Gemfile

@@ -13,5 +13,6 @@ group :test do
   gem 'rspec',  '~> 2.0.0'
 end
 
+gem 'json',           '~> 1.5.1'
 gem 'term-ansicolor', '~> 1.0.5'
-gem 'thor',           '~> 0.13.6'
+gem 'thor',           '>= 0.13.6'

Gemfile.lock

@@ -4,6 +4,7 @@ GEM
     diff-lcs (1.1.2)
     fakefs (0.2.1)
     hpricot (0.8.2)
+    json (1.5.1)
     mime-types (1.16)
     mustache (0.11.2)
     parka (0.3.1)
@@ -19,22 +20,25 @@ GEM
       mustache (>= 0.7.0)
       rdiscount (>= 1.5.8)
     rr (1.0.2)
-    rspec (2.0.0.beta.19)
-      rspec-core (= 2.0.0.beta.19)
-      rspec-expectations (= 2.0.0.beta.19)
-      rspec-mocks (= 2.0.0.beta.19)
-    rspec-core (2.0.0.beta.19)
-    rspec-expectations (2.0.0.beta.19)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
       diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0.beta.19)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
     term-ansicolor (1.0.5)
-    thor (0.13.8)
+    thor (0.14.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   fakefs (~> 0.2.1)
+  json (~> 1.5.1)
   parka
   rake
   rcov (~> 0.9.8)
@@ -42,4 +46,4 @@ DEPENDENCIES
   rr (~> 1.0.2)
   rspec (~> 2.0.0)
   term-ansicolor (~> 1.0.5)
-  thor (~> 0.13.6)
+  thor (>= 0.13.6)

Rakefile

@@ -25,7 +25,7 @@ end
 Rspec::Core::RakeTask.new("rcov:build") do |t|
   t.pattern = 'spec/**/*_spec.rb'
   t.rcov = true
-  t.rcov_opts = [ "--exclude", Gem.default_dir , "--exclude", "spec" ]
+  t.rcov_opts = [ "--exclude", ".bundle", "--exclude", "spec" ]
 end
 
 desc 'Build the manual'
@@ -37,6 +37,7 @@ task :man do
   sh "git commit -m 'update readme' || echo 'nothing to commit'"
 end
 
+desc "Generate the Github docs"
 task :pages => :man do
   sh %{
     cp man/foreman.1.html /tmp/foreman.1.html

data/example/Procfile

@@ -1,2 +1,2 @@
-ticker ./ticker $PORT
-error  ./error
+ticker: ./ticker $PORT
+error : ./error

data/example/Procfile.without_colon

@@ -0,0 +1,2 @@
+ticker ./ticker $PORT
+error  ./error

foreman.gemspec

@@ -1,12 +1,29 @@
-require "rubygems"
-require "parka/specification"
+$:.unshift File.expand_path("../lib", __FILE__)
+require "foreman/version"
 
-Parka::Specification.new do |gem|
+Gem::Specification.new do |gem|
   gem.name     = "foreman"
   gem.version  = Foreman::VERSION
-  gem.summary  = "Process manager for applications with multiple components"
-  gem.homepage = "http://github.com/ddollar/foreman"
 
-  gem.executables  = "foreman"
-  gem.files       << "man/foreman.1"
+  gem.author   = "David Dollar"
+  gem.email    = "ddollar@gmail.com"
+  gem.homepage = "http://github.com/ddollar/foreman"
+  gem.summary  = "Process manager for applications with multiple components"
+
+  gem.description = gem.summary
+
+  gem.executables = "foreman"
+  gem.files = Dir["**/*"].select { |d| d =~ %r{^(README|bin/|data/|ext/|lib/|spec/|test/)} }
+  gem.files << "man/foreman.1"
+
+  gem.add_dependency 'json',           '~> 1.5.1'
+  gem.add_dependency 'term-ansicolor', '~> 1.0.5'
+  gem.add_dependency 'thor',           '>= 0.13.6'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'ronn'
+  gem.add_development_dependency 'fakefs', '~> 0.2.1'
+  gem.add_development_dependency 'rcov',   '~> 0.9.8'
+  gem.add_development_dependency 'rr',     '~> 1.0.2'
+  gem.add_development_dependency 'rspec',  '~> 2.0.0'
 end

lib/foreman.rb

@@ -1,6 +1,6 @@
-module Foreman
+require "foreman/version"
 
-  VERSION = "0.10.0"
+module Foreman
 
   class AppDoesNotExist < Exception; end
 

lib/foreman/cli.rb

@@ -36,8 +36,9 @@ class Foreman::CLI < Thor
     check_procfile!
 
     formatter = case format
-      when "upstart" then Foreman::Export::Upstart
+      when "json"    then Foreman::Export::JSON
       when "inittab" then Foreman::Export::Inittab
+      when "upstart" then Foreman::Export::Upstart
       else error "Unknown export format: #{format}."
     end
 
@@ -47,6 +48,14 @@ class Foreman::CLI < Thor
     error ex.message
   end
 
+  desc "check", "Validate your application's Procfile"
+
+  def check
+    processes = engine.processes_in_order.map { |p| p.first }
+    error "no processes defined" unless processes.length > 0
+    display "valid procfile detected (#{processes.join(', ')})"
+  end
+
 private ######################################################################
 
   def check_procfile!
@@ -61,7 +70,9 @@ private ######################################################################
     options[:procfile] || "Procfile"
   end
 
-private ######################################################################
+  def display(message)
+    puts message
+  end
 
   def error(message)
     puts "ERROR: #{message}"
@@ -72,4 +83,11 @@ private ######################################################################
     File.exist?(procfile)
   end
 
+  def options
+    original_options = super
+    return original_options unless File.exists?(".foreman")
+    defaults = YAML::load_file(".foreman")
+    Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
+  end
+
 end

lib/foreman/engine.rb

@@ -25,7 +25,11 @@ class Foreman::Engine
       @order = []
       procfile.split("\n").inject({}) do |hash, line|
         next if line.strip == ""
-        name, command = line.split(/:? +/, 2)
+        name, command = line.split(/ *: +/, 2)
+        unless command
+          warn_deprecated_procfile!
+          name, command = line.split(/ +/, 2)
+        end
         process = Foreman::Process.new(name, command)
         process.color = next_color
         @order << process.name
@@ -95,12 +99,11 @@ private ######################################################################
     running_processes[pid] = process
   end
 
-  def run(process, log_to_file=true)
+  def run(process)
     proctitle "ruby: foreman #{process.name}"
 
     begin
       Dir.chdir directory do
-        FileUtils.mkdir_p "log"
         command = process.command
 
         PTY.spawn("#{process.command} 2>&1") do |stdin, stdout, pid|
@@ -179,4 +182,12 @@ private ######################################################################
     @current_color >= COLORS.length ? "" : COLORS[@current_color]
   end
 
+  def warn_deprecated_procfile!
+    return if @already_warned_deprecated
+    @already_warned_deprecated = true
+    puts "!!! This format of Procfile is deprecated, and will not work starting in v0.12"
+    puts "!!! Use a colon to separate the process name from the command"
+    puts "!!! e.g.   web: thin start"
+  end
+
 end

lib/foreman/export.rb

@@ -4,5 +4,6 @@ module Foreman::Export
   class Exception < ::Exception; end
 end
 
-require "foreman/export/upstart"
+require "foreman/export/json"
 require "foreman/export/inittab"
+require "foreman/export/upstart"

lib/foreman/export/json.rb

@@ -0,0 +1,13 @@
+require "foreman/export/base"
+require "json"
+
+class Foreman::Export::JSON < Foreman::Export::Base
+
+  def export(fname=nil, options={})
+    processes = engine.processes.values.inject({}) do |hash, process|
+      hash.update(process.name => { "command" => process.command })
+    end
+    puts processes.to_json
+  end
+
+end

lib/foreman/version.rb

@@ -0,0 +1,5 @@
+module Foreman
+
+  VERSION = "0.12.0"
+
+end

man/foreman.1

@@ -0,0 +1,210 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "FOREMAN" "1" "March 2011" "Foreman 0.12.0.pre1" "Foreman Manual"
+.
+.SH "NAME"
+\fBforeman\fR \- manage Procfile\-based applications
+.
+.SH "SYNOPSIS"
+\fBforeman start [process]\fR
+.
+.br
+\fBforeman export <format> [location]\fR
+.
+.SH "DESCRIPTION"
+\fBForeman\fR is a manager for Procfile\-based applications\. Its aim is to abstract away the details of the Procfile format, and allow you to either run your application directly or export it to some other process management format\.
+.
+.SH "RUNNING"
+\fBforeman start\fR is used to run your application directly from the command line\.
+.
+.P
+If no additional parameters are passed, foreman will run one instance of each type of process defined in your Procfile\.
+.
+.P
+If a parameter is passed, foreman will run one instance of the specified application type\.
+.
+.P
+The following options control how the application is run:
+.
+.TP
+\fB\-c\fR, \fB\-\-concurrency\fR
+Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
+.
+.TP
+\fB\-p\fR, \fB\-\-port\fR
+Specify which port to use as the base for this application\. Should be a multiple of 1000\.
+.
+.SH "EXPORTING"
+\fBforeman export\fR is used to export your application to another process management format\.
+.
+.P
+An location to export can be passed as an argument\. This argument may be either required or optional depending on the export format\.
+.
+.P
+The following options control how the application is run:
+.
+.TP
+\fB\-a\fR, \fB\-\-app\fR
+Use this name rather than the application\'s root directory name as the name of the application when exporting\.
+.
+.TP
+\fB\-c\fR, \fB\-\-concurrency\fR
+Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
+.
+.TP
+\fB\-l\fR, \fB\-\-log\fR
+Specify the directory to place process logs in\.
+.
+.TP
+\fB\-p\fR, \fB\-\-port\fR
+Specify which port to use as the base for this application\. Should be a multiple of 1000\.
+.
+.TP
+\fB\-u\fR, \fB\-\-user\fR
+Specify the user the application should be run as\. Defaults to the app name
+.
+.SH "OPTIONS"
+These options control all modes of foreman\'s operation\.
+.
+.TP
+\fB\-f\fR, \fB\-\-procfile\fR
+Specify an alternate location for the application\'s Procfile\. This file\'s containing directory will be assumed to be the root directory of the application\.
+.
+.SH "EXPORT FORMATS"
+foreman currently supports the following output formats:
+.
+.IP "\(bu" 4
+json
+.
+.IP "\(bu" 4
+inittab
+.
+.IP "\(bu" 4
+upstart
+.
+.IP "" 0
+.
+.SH "JSON EXPORT"
+Will export your processes as JSON:
+.
+.IP "" 4
+.
+.nf
+
+{ "web": { "command": "bundle exec thin start" } }
+.
+.fi
+.
+.IP "" 0
+.
+.SH "INITTAB EXPORT"
+Will export a chunk of inittab\-compatible configuration:
+.
+.IP "" 4
+.
+.nf
+
+# \-\-\-\-\- foreman example processes \-\-\-\-\-
+EX01:4:respawn:/bin/su \- example \-c \'PORT=5000 bundle exec thin start >> /var/log/web\-1\.log 2>&1\'
+EX02:4:respawn:/bin/su \- example \-c \'PORT=5100 bundle exec rake jobs:work >> /var/log/job\-1\.log 2>&1\'
+# \-\-\-\-\- end foreman example processes \-\-\-\-\-
+.
+.fi
+.
+.IP "" 0
+.
+.SH "UPSTART EXPORT"
+Will create a series of upstart scripts in the location you specify\. Scripts will be structured to make the following commands valid:
+.
+.P
+\fBstart appname\fR
+.
+.P
+\fBstop appname\-processname\fR
+.
+.P
+\fBrestart appname\-processname\-3\fR
+.
+.SH "PROCFILE"
+A Procfile should contain both a name for the process and the command used to run it\.
+.
+.IP "" 4
+.
+.nf
+
+web: bundle exec thin start
+job: bundle exec rake jobs:work
+.
+.fi
+.
+.IP "" 0
+.
+.P
+You can validate your Procfile format using the \fBcheck\fR command
+.
+.IP "" 4
+.
+.nf
+
+$ foreman check
+.
+.fi
+.
+.IP "" 0
+.
+.SH "DEFAULT OPTIONS"
+If a \fB\.foreman\fR file exists in the current directory, default options will be read from it\. This file should be in YAML format with the long option name as keys\. Example:
+.
+.IP "" 4
+.
+.nf
+
+concurrency: alpha=0
+port: 15000
+.
+.fi
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+Start one instance of each process type, interleave the output on stdout:
+.
+.IP "" 4
+.
+.nf
+
+$ foreman start
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Export the application in upstart format:
+.
+.IP "" 4
+.
+.nf
+
+$ foreman export upstart /etc/init
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Run one process type from the application defined in a specific Procfile:
+.
+.IP "" 4
+.
+.nf
+
+$ foreman start alpha \-p ~/myapp/Procfile
+.
+.fi
+.
+.IP "" 0
+.
+.SH "COPYRIGHT"
+Foreman is Copyright (C) 2010 David Dollar \fIhttp://daviddollar\.org\fR

man/foreman.1.ronn

@@ -1,4 +1,4 @@
-foreman(1) -- manage Psfile-based applications
+foreman(1) -- manage Procfile-based applications
 ================================================
 
 ## SYNOPSIS
@@ -8,8 +8,8 @@ foreman(1) -- manage Psfile-based applications
 
 ## DESCRIPTION
 
-**Foreman** is a manager for Psfile-based applications. Its aim is to
-abstract away the details of the Psfile format, and allow you to either run
+**Foreman** is a manager for Procfile-based applications. Its aim is to
+abstract away the details of the Procfile format, and allow you to either run
 your application directly or export it to some other process management
 format.
 
@@ -18,7 +18,7 @@ format.
 `foreman start` is used to run your application directly from the command line.
 
 If no additional parameters are passed, foreman will run one instance of each
-type of process defined in your Psfile.
+type of process defined in your Procfile.
 
 If a parameter is passed, foreman will run one instance of the specified
 application type.
@@ -66,8 +66,8 @@ The following options control how the application is run:
 
 These options control all modes of foreman's operation.
 
-  * `-f`, `--psfile`:
-    Specify an alternate location for the application's Psfile. This file's
+  * `-f`, `--procfile`:
+    Specify an alternate location for the application's Procfile. This file's
     containing directory will be assumed to be the root directory of the
     application.
 
@@ -75,10 +75,18 @@ These options control all modes of foreman's operation.
 
 foreman currently supports the following output formats:
 
+  * json
+
   * inittab
 
   * upstart
 
+## JSON EXPORT
+
+Will export your processes as JSON:
+
+    { "web": { "command": "bundle exec thin start" } }
+
 ## INITTAB EXPORT
 
 Will export a chunk of inittab-compatible configuration:
@@ -99,13 +107,26 @@ will be structured to make the following commands valid:
 
   `restart appname-processname-3`
 
-## PSFILE
+## PROCFILE
 
-A Psfile should contain both a name for the process and the command used
+A Procfile should contain both a name for the process and the command used
 to run it.
 
-    web  bundle exec thin start
-    job  bundle exec rake jobs:work
+    web: bundle exec thin start
+    job: bundle exec rake jobs:work
+
+You can validate your Procfile format using the `check` command
+
+    $ foreman check
+
+## DEFAULT OPTIONS
+
+If a `.foreman` file exists in the current directory, default options will
+be read from it. This file should be in YAML format with the long option
+name as keys. Example:
+
+    concurrency: alpha=0
+    port: 15000
 
 ## EXAMPLES
 
@@ -117,9 +138,9 @@ Export the application in upstart format:
 
     $ foreman export upstart /etc/init
 
-Run one process type from the application defined in a specific Psfile:
+Run one process type from the application defined in a specific Procfile:
 
-    $ foreman start alpha -p ~/myapp/Psfile
+    $ foreman start alpha -p ~/myapp/Procfile
 
 ## COPYRIGHT
 

spec/foreman/cli_spec.rb

@@ -58,4 +58,27 @@ describe "Foreman::CLI" do
     end
   end
 
+  describe "check" do
+    describe "with a valid Procfile" do
+      before { write_procfile }
+
+      it "displays the jobs" do
+        mock(subject).display("valid procfile detected (alpha, bravo)")
+        subject.check
+      end
+    end
+
+    describe "with a blank Procfile" do
+      before do
+        FileUtils.touch("Procfile")
+      end
+
+      it "displays an error" do
+        mock_error(subject, "no processes defined") do
+          subject.check
+        end
+      end
+    end
+  end
+
 end

spec/foreman/engine_spec.rb

@@ -12,12 +12,26 @@ describe "Foreman::Engine" do
     end
 
     describe "with a Procfile" do
+      before { write_procfile }
+
       it "reads the processes" do
-        write_procfile
         subject.processes["alpha"].command.should == "./alpha"
         subject.processes["bravo"].command.should == "./bravo"
       end
     end
+
+    describe "with a deprecated Procfile" do
+      before do
+        File.open("Procfile", "w") do |file|
+          file.puts "name command"
+        end
+      end
+
+      it "should print a deprecation warning" do
+        mock(subject).warn_deprecated_procfile!
+        subject.processes.length.should == 1
+      end
+    end
   end
 
   describe "start" do

spec/spec_helper.rb

@@ -26,8 +26,8 @@ end
 
 def write_procfile(procfile="Procfile")
   File.open(procfile, "w") do |file|
-    file.puts "alpha ./alpha"
-    file.puts "bravo ./bravo"
+    file.puts "alpha: ./alpha"
+    file.puts "bravo: ./bravo"
   end
 end