0.11.1

.gitignore

@@ -5,3 +5,5 @@ man/*.?
 man/*.html
 man/*.markdown
 pkg
+tags
+

Gemfile

@@ -9,9 +9,10 @@ end
 group :test do
   gem 'fakefs', '~> 0.2.1'
   gem 'rcov',   '~> 0.9.8'
-  gem 'rr',     '~> 0.10.11'
-  gem 'rspec',  '~> 2.0.0.beta.19'
+  gem 'rr',     '~> 1.0.2'
+  gem 'rspec',  '~> 2.0.0'
 end
 
+gem 'json',           '~> 1.5.1'
 gem 'term-ansicolor', '~> 1.0.5'
 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)
@@ -18,15 +19,17 @@ GEM
       hpricot (>= 0.8.2)
       mustache (>= 0.7.0)
       rdiscount (>= 1.5.8)
-    rr (0.10.11)
-    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)
+    rr (1.0.2)
+    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)
 
@@ -35,11 +38,12 @@ PLATFORMS
 
 DEPENDENCIES
   fakefs (~> 0.2.1)
+  json (~> 1.5.1)
   parka
   rake
   rcov (~> 0.9.8)
   ronn
-  rr (~> 0.10.11)
-  rspec (~> 2.0.0.beta.19)
+  rr (~> 1.0.2)
+  rspec (~> 2.0.0)
   term-ansicolor (~> 1.0.5)
   thor (~> 0.13.6)

README.markdown

@@ -1,4 +1,9 @@
-Foreman
-=======
+# Foreman
+
+## Manual
 
 See the [man page](http://ddollar.github.com/foreman) for usage.
+
+## License
+
+MIT

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

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

lib/foreman.rb

@@ -1,6 +1,6 @@
 module Foreman
 
-  VERSION = "0.9.0.beta.1"
+  VERSION = "0.11.1"
 
   class AppDoesNotExist < Exception; end
 

lib/foreman/cli.rb

@@ -5,7 +5,7 @@ require "thor"
 
 class Foreman::CLI < Thor
 
-  class_option :pstypes, :type => :string, :aliases => "-f", :desc => "Default: Pstypes"
+  class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile"
 
   desc "start [PROCESS]", "Start the application, or a specific process"
 
@@ -14,7 +14,7 @@ class Foreman::CLI < Thor
     :banner => '"alpha=5,bar=3"'
 
   def start(process=nil)
-    check_pstypes!
+    check_procfile!
 
     if process
       engine.execute(process, options)
@@ -33,11 +33,12 @@ class Foreman::CLI < Thor
     :banner => '"alpha=5,bar=3"'
 
   def export(format, location=nil)
-    check_pstypes!
+    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,29 +48,46 @@ 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_pstypes!
-    error("#{pstypes} does not exist.") unless File.exist?(pstypes)
+  def check_procfile!
+    error("#{procfile} does not exist.") unless File.exist?(procfile)
   end
 
   def engine
-    @engine ||= Foreman::Engine.new(pstypes)
+    @engine ||= Foreman::Engine.new(procfile)
   end
 
-  def pstypes
-    options[:pstypes] || "Pstypes"
+  def procfile
+    options[:procfile] || "Procfile"
   end
 
-private ######################################################################
+  def display(message)
+    puts message
+  end
 
   def error(message)
     puts "ERROR: #{message}"
     exit 1
   end
 
-  def pstypes_exists?(pstypes)
-    File.exist?(pstypes)
+  def procfile_exists?(procfile)
+    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

@@ -8,34 +8,51 @@ require "fileutils"
 
 class Foreman::Engine
 
-  attr_reader :pstypes
+  attr_reader :procfile
   attr_reader :directory
 
   extend Term::ANSIColor
 
   COLORS = [ cyan, yellow, green, magenta, red ]
 
-  def initialize(pstypes)
-    @pstypes   = read_pstypes(pstypes)
-    @directory = File.expand_path(File.dirname(pstypes))
+  def initialize(procfile)
+    @procfile  = read_procfile(procfile)
+    @directory = File.expand_path(File.dirname(procfile))
   end
 
   def processes
     @processes ||= begin
-      pstypes.split("\n").inject({}) do |hash, line|
+      @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
         hash.update(process.name => process)
       end
     end
   end
 
+  def process_order
+    processes
+    @order.uniq
+  end
+
+  def processes_in_order
+    process_order.map do |name|
+      [name, processes[name]]
+    end
+  end
+
   def start(options={})
     proctitle "ruby: foreman master"
 
-    processes.each do |name, process|
+    processes_in_order.each do |name, process|
       fork process, options
     end
 
@@ -56,7 +73,7 @@ class Foreman::Engine
 
   def port_for(process, num, base_port=nil)
     base_port ||= 5000
-    offset = processes.keys.sort.index(process.name) * 100
+    offset = processes_in_order.map { |p| p.first }.index(process.name) * 100
     base_port.to_i + offset + num - 1
   end
 
@@ -78,16 +95,15 @@ private ######################################################################
       run(process)
     end
 
-    info "started with pid #{pid}, PORT=#{port}", process
+    info "started with pid #{pid}", process
     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|
@@ -144,8 +160,8 @@ private ######################################################################
     $0 = title
   end
 
-  def read_pstypes(pstypes)
-    File.read(pstypes)
+  def read_procfile(procfile)
+    File.read(procfile)
   end
 
   def watch_for_termination
@@ -166,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

man/foreman.1.ronn

@@ -1,4 +1,4 @@
-foreman(1) -- manage Pstypes-based applications
+foreman(1) -- manage Procfile-based applications
 ================================================
 
 ## SYNOPSIS
@@ -8,8 +8,8 @@ foreman(1) -- manage Pstypes-based applications
 
 ## DESCRIPTION
 
-**Foreman** is a manager for Pstypes-based applications. Its aim is to
-abstract away the details of the Pstypes 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 Pstypes.
+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`, `--pstypes`:
-    Specify an alternate location for the application's Pstypes. 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`
 
-## PSTYPES
+## PROCFILE
 
-A Pstyes file 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 Pstypes:
+Run one process type from the application defined in a specific Procfile:
 
-    $ foreman start alpha -p ~/app/Pstypes
+    $ foreman start alpha -p ~/myapp/Procfile
 
 ## COPYRIGHT
 

spec/foreman/cli_spec.rb

@@ -5,17 +5,17 @@ describe "Foreman::CLI" do
   subject { Foreman::CLI.new }
 
   describe "start" do
-    describe "with a non-existent Pstypes" do
+    describe "with a non-existent Procfile" do
       it "prints an error" do
-        mock_error(subject, "Pstypes does not exist.") do
+        mock_error(subject, "Procfile does not exist.") do
           dont_allow.instance_of(Foreman::Engine).start
           subject.start
         end
       end
     end
 
-    describe "with a Pstypes" do
-      before(:each) { write_pstypes }
+    describe "with a Procfile" do
+      before(:each) { write_procfile }
 
       it "runs successfully" do
         dont_allow(subject).error
@@ -26,17 +26,17 @@ describe "Foreman::CLI" do
   end
 
   describe "export" do
-    describe "with a non-existent Pstypes" do
+    describe "with a non-existent Procfile" do
       it "prints an error" do
-        mock_error(subject, "Pstypes does not exist.") do
+        mock_error(subject, "Procfile does not exist.") do
           dont_allow.instance_of(Foreman::Engine).export
           subject.export("testapp")
         end
       end
     end
 
-    describe "with a Pstypes" do
-      before(:each) { write_pstypes }
+    describe "with a Procfile" do
+      before(:each) { write_procfile }
 
       describe "with an invalid formatter" do
         it "prints an error" do
@@ -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

@@ -2,27 +2,41 @@ require "spec_helper"
 require "foreman/engine"
 
 describe "Foreman::Engine" do
-  subject { Foreman::Engine.new("Pstypes") }
+  subject { Foreman::Engine.new("Procfile") }
 
   describe "initialize" do
-    describe "without an existing Pstypes" do
+    describe "without an existing Procfile" do
       it "raises an error" do
         lambda { subject }.should raise_error
       end
     end
 
-    describe "with a Pstypes" do
+    describe "with a Procfile" do
+      before { write_procfile }
+
       it "reads the processes" do
-        write_pstypes
         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
     it "forks the processes" do
-      write_pstypes
+      write_procfile
       mock(subject).fork(subject.processes["alpha"], {})
       mock(subject).fork(subject.processes["bravo"], {})
       mock(subject).watch_for_termination
@@ -30,10 +44,10 @@ describe "Foreman::Engine" do
     end
 
     it "handles concurrency" do
-      write_pstypes
-      mock(subject).fork_individual(subject.processes["alpha"], 5000)
-      mock(subject).fork_individual(subject.processes["alpha"], 5001)
-      mock(subject).fork_individual(subject.processes["bravo"], 5100)
+      write_procfile
+      mock(subject).fork_individual(subject.processes["alpha"], 1, 5000)
+      mock(subject).fork_individual(subject.processes["alpha"], 2, 5001)
+      mock(subject).fork_individual(subject.processes["bravo"], 1, 5100)
       mock(subject).watch_for_termination
       subject.start(:concurrency => "alpha=2")
     end
@@ -41,7 +55,7 @@ describe "Foreman::Engine" do
 
   describe "execute" do
     it "runs the processes" do
-      write_pstypes
+      write_procfile
       mock(subject).fork(subject.processes["alpha"], {})
       mock(subject).watch_for_termination
       subject.execute("alpha")

spec/spec_helper.rb

@@ -24,10 +24,10 @@ def write_foreman_config(app)
   end
 end
 
-def write_pstypes(pstypes="Pstypes")
-  File.open(pstypes, "w") do |file|
-    file.puts "alpha ./alpha"
-    file.puts "bravo ./bravo"
+def write_procfile(procfile="Procfile")
+  File.open(procfile, "w") do |file|
+    file.puts "alpha: ./alpha"
+    file.puts "bravo: ./bravo"
   end
 end