foreman 0.10.0 → 0.11.0

data/data/example/Procfile

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

data/data/example/Procfile.without_colon

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

data/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!
@@ -63,6 +72,10 @@ private ######################################################################
 
 private ######################################################################
 
+  def display(message)
+    puts message
+  end
+
   def error(message)
     puts "ERROR: #{message}"
     exit 1

data/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

data/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

data/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"

data/lib/foreman.rb

@@ -1,6 +1,6 @@
 module Foreman
 
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 
   class AppDoesNotExist < Exception; end
 

data/man/foreman.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "FOREMAN" "1" "June 2010" "Foreman 0.6.0" "Foreman Manual"
+.TH "FOREMAN" "1" "January 2011" "Foreman 0.10.1" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
@@ -28,8 +28,12 @@ If a parameter is passed, foreman will run one instance of the specified applica
 The following options control how the application is run:
 .
 .TP
-\fB\-s\fR, \fB\-\-screen\fR
-Run the application as a series of screen windows rather than interleaved in stdout\.
+\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\.
@@ -71,6 +75,9 @@ Specify an alternate location for the application\'s Procfile\. This file\'s con
 foreman currently supports the following output formats:
 .
 .IP "\(bu" 4
+json
+.
+.IP "\(bu" 4
 inittab
 .
 .IP "\(bu" 4
@@ -78,6 +85,19 @@ 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:
 .
@@ -113,8 +133,21 @@ A Procfile should contain both a name for the process and the command used to ru
 .
 .nf
 
-web  bundle exec thin start
-job  bundle exec rake jobs:work
+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
 .
@@ -153,7 +186,7 @@ Run one process type from the application defined in a specific Procfile:
 .
 .nf
 
-$ foreman start alpha \-p ~/app/Procfile
+$ foreman start alpha \-p ~/myapp/Procfile
 .
 .fi
 .

data/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

data/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

data/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
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: foreman
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 51
+  prerelease: 
   segments: 
   - 0
-  - 10
+  - 11
   - 0
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors: 
 - |
@@ -16,138 +17,163 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 -05:00
+date: 2011-01-27 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: parka
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
+  requirement: *id001
   prerelease: false
-  version_requirements: *id001
+  name: parka
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: rake
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
+  requirement: *id002
   prerelease: false
-  version_requirements: *id002
+  name: rake
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: ronn
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :development
+  requirement: *id003
   prerelease: false
-  version_requirements: *id003
+  name: ronn
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: fakefs
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 0
         - 2
         - 1
         version: 0.2.1
-  type: :development
+  requirement: *id004
   prerelease: false
-  version_requirements: *id004
+  name: fakefs
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 43
         segments: 
         - 0
         - 9
         - 8
         version: 0.9.8
-  type: :development
+  requirement: *id005
   prerelease: false
-  version_requirements: *id005
+  name: rcov
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: rr
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 1
         - 0
         - 2
         version: 1.0.2
-  type: :development
+  requirement: *id006
   prerelease: false
-  version_requirements: *id006
+  name: rr
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 2
         - 0
         - 0
         version: 2.0.0
+  requirement: *id007
+  prerelease: false
+  name: rspec
   type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id008
   prerelease: false
-  version_requirements: *id007
+  name: json
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: term-ansicolor
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 29
         segments: 
         - 1
         - 0
         - 5
         version: 1.0.5
-  type: :runtime
+  requirement: *id009
   prerelease: false
-  version_requirements: *id008
+  name: term-ansicolor
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: thor
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 39
         segments: 
         - 0
         - 13
         - 6
         version: 0.13.6
-  type: :runtime
+  requirement: *id010
   prerelease: false
-  version_requirements: *id009
+  name: thor
+  type: :runtime
 description: Process manager for applications with multiple components
 email: |
   <ddollar@gmail.com>
@@ -163,6 +189,7 @@ files:
 - man/foreman.1
 - README.markdown
 - data/example/Procfile
+- data/example/Procfile.without_colon
 - data/example/error
 - data/example/log/neverdie.log
 - data/example/ticker
@@ -175,6 +202,7 @@ files:
 - lib/foreman/export.rb
 - lib/foreman/export/base.rb
 - lib/foreman/export/inittab.rb
+- lib/foreman/export/json.rb
 - lib/foreman/export/upstart.rb
 - lib/foreman/process.rb
 - lib/foreman/utils.rb
@@ -199,6 +227,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -207,13 +236,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: nowarning
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Process manager for applications with multiple components