foreman 0.87.1 → 0.88.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5539f4ab7e8b7e1d8fd1d6c3c0e41d7b65c41d7c6d4ba5529e4d467825305899
-  data.tar.gz: 4a104c4dc91f9f43535970192a7a5812ee2f9e5063ad21b21f80c8eea8534b2a
+  metadata.gz: 0dfe6fcff4e6a0293ccee732ad38fe72e7a05b2beb662ba2bdf8cc54437e7242
+  data.tar.gz: 2abc2ad27e0c30aebf936508467b7a74217d9c6f1fbabeaf80e1c771247f22cd
 SHA512:
-  metadata.gz: f62298c87cf3ed7572070ab0c6b89eb6c1b9521c437c4c7481445d541a0a72bb7da14314cdc26eaebfaf3d2db4c0832c163104850ac3b4a9b02245ff223fa2e8
-  data.tar.gz: 96f415f01ba692c272b1a23c410a8d7ba9f96ad9b42febd576bcd2b2cefa4849ecd4967683b03f1f0599db6819b9abe060faba7b0463a216ce9c1cb03168591e
+  metadata.gz: d5f8cdb2f096a15c7f83e7ee3d8c870b37d2a3e1c7085af59e8c34810f88110a87d1db30e44e2f4bf5beb4abede9f0976456e675b174512cee5745d4c8223345
+  data.tar.gz: ed5640039e33ef6a492449ddeae69718f8a8a6a333ddce677f21860e707620f730fd124f19cac9687849783372115eba1e846c72d198325346234ed5c146ed4f

data/README.md

@@ -1,8 +1,6 @@
 # Foreman
 
-[![Build Status](https://travis-ci.org/ddollar/foreman.svg?branch=master)](https://travis-ci.org/ddollar/foreman)
-[![Code Climate](https://codeclimate.com/github/ddollar/foreman.svg)](https://codeclimate.com/github/ddollar/foreman)
-[![Inline docs](http://inch-ci.org/github/ddollar/foreman.svg?branch=master)](http://inch-ci.org/github/ddollar/foreman)
+[![CI](https://github.com/ddollar/foreman/actions/workflows/ci.yml/badge.svg)](https://github.com/ddollar/foreman/actions/workflows/ci.yml)
 
 Manage Procfile-based applications
 
@@ -10,41 +8,43 @@ Manage Procfile-based applications
 
     $ gem install foreman
 
-Ruby users should take care *not* to install foreman in their project's `Gemfile`. See this [wiki article](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman) for more details.
+Ruby users should take care _not_ to install foreman in their project's `Gemfile`. See this [wiki article](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman) for more details.
 
 ## Getting Started
 
-* http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
+- http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
 
 ## Supported Ruby versions
 
-See [.travis.yml](.travis.yml) for a list of Ruby versions against which Foreman is tested.
+See [ci.yml](.github/workflows/ci.yml) for a list of Ruby versions against which Foreman is tested.
 
 ## Documentation
 
-* [man page](http://ddollar.github.io/foreman/)
-* [wiki](https://github.com/ddollar/foreman/wiki)
-* [changelog](https://github.com/ddollar/foreman/blob/master/Changelog.md)
+- [man page](http://ddollar.github.io/foreman/)
+- [wiki](https://github.com/ddollar/foreman/wiki)
+- [changelog](https://github.com/ddollar/foreman/blob/main/Changelog.md)
 
 ## Ports
 
-* [forego](https://github.com/ddollar/forego) - Go
-* [node-foreman](https://github.com/strongloop/node-foreman) - Node.js
-* [gaffer](https://github.com/jingweno/gaffer) - Java/JVM
-* [goreman](https://github.com/mattn/goreman) - Go
-* [honcho](https://github.com/nickstenning/honcho) - python
-* [proclet](https://github.com/kazeburo/Proclet) - Perl
-* [shoreman](https://github.com/chrismytton/shoreman) - shell
-* [crank](https://github.com/arktisklada/crank) - Crystal
-* [houseman](https://github.com/fujimura/houseman) - Haskell
-* [spm](https://github.com/bytegust/spm) - Go
+- [forego](https://github.com/ddollar/forego) - Go
+- [node-foreman](https://github.com/strongloop/node-foreman) - Node.js
+- [gaffer](https://github.com/jingweno/gaffer) - Java/JVM
+- [goreman](https://github.com/mattn/goreman) - Go
+- [honcho](https://github.com/nickstenning/honcho) - python
+- [proclet](https://github.com/kazeburo/Proclet) - Perl
+- [shoreman](https://github.com/chrismytton/shoreman) - shell
+- [crank](https://github.com/arktisklada/crank) - Crystal
+- [houseman](https://github.com/fujimura/houseman) - Haskell
+- [spm](https://github.com/bytegust/spm) - Go
 
 ## Authors
 
 #### Created and maintained by
+
 David Dollar
 
 #### Patches contributed by
+
 [Contributor List](https://github.com/ddollar/foreman/contributors)
 
 ## License

data/lib/foreman/cli.rb

@@ -40,6 +40,8 @@ class Foreman::CLI < Foreman::Thor
     engine.load_procfile(procfile)
     engine.options[:formation] = "#{process}=1" if process
     engine.start
+  rescue Foreman::Procfile::EmptyFileError
+    error "no processes defined"
   end
 
   desc "export FORMAT LOCATION", "Export the application to another process management format"
@@ -60,7 +62,7 @@ class Foreman::CLI < Foreman::Thor
     engine.load_procfile(procfile)
     formatter = Foreman::Export.formatter(format)
     formatter.new(location, engine, options).export
-  rescue Foreman::Export::Exception => ex
+  rescue Foreman::Export::Exception, Foreman::Procfile::EmptyFileError => ex
     error ex.message
   end
 
@@ -69,8 +71,9 @@ class Foreman::CLI < Foreman::Thor
   def check
     check_procfile!
     engine.load_procfile(procfile)
-    error "no processes defined" unless engine.processes.length > 0
     puts "valid procfile detected (#{engine.process_names.join(', ')})"
+  rescue Foreman::Procfile::EmptyFileError
+    error "no processes defined"
   end
 
   desc "run COMMAND [ARGS...]", "Run a command using your application's environment"
@@ -105,6 +108,8 @@ class Foreman::CLI < Foreman::Thor
     Process.wait(pid)
     exit $?.exitstatus || 0
   rescue Interrupt
+  rescue Foreman::Procfile::EmptyFileError
+    error "no processes defined"
   end
 
   desc "version", "Display Foreman gem version"

data/lib/foreman/engine/cli.rb

@@ -49,7 +49,7 @@ class Foreman::Engine::CLI < Foreman::Engine
 
   def startup
     @colors = map_colors
-    proctitle "foreman: master" unless Foreman.windows?
+    proctitle "foreman: main" unless Foreman.windows?
     Color.enable($stdout, options[:color])
   end
 
@@ -77,7 +77,7 @@ private
     @name_padding ||= begin
       index_padding = @names.values.map { |n| formation[n] }.max.to_s.length + 1
       name_padding  = @names.values.map { |n| n.length + index_padding }.sort.last
-      [ 6, name_padding ].max
+      [ 6, name_padding.to_i ].max
     end
   end
 

data/lib/foreman/export/base.rb

@@ -74,8 +74,8 @@ private ######################################################################
     puts "WARNING: Using deprecated exporter interface. Please update your exporter"
     puts "the interface shown in the upstart exporter:"
     puts
-    puts "https://github.com/ddollar/foreman/blob/master/lib/foreman/export/upstart.rb"
-    puts "https://github.com/ddollar/foreman/blob/master/data/export/upstart/process.conf.erb"
+    puts "https://github.com/ddollar/foreman/blob/main/lib/foreman/export/upstart.rb"
+    puts "https://github.com/ddollar/foreman/blob/main/data/export/upstart/process.conf.erb"
     puts
     @@deprecation_warned = true
   end
@@ -83,7 +83,7 @@ private ######################################################################
   def chown user, dir
     FileUtils.chown user, nil, dir
   rescue
-    error("Could not chown #{dir} to #{user}") unless File.writable?(dir) || ! File.exists?(dir)
+    error("Could not chown #{dir} to #{user}") unless File.writable?(dir) || ! File.exist?(dir)
   end
 
   def error(message)
@@ -95,13 +95,13 @@ private ######################################################################
   end
   
   def clean(filename)
-    return unless File.exists?(filename)
+    return unless File.exist?(filename)
     say "cleaning up: #{filename}"
     FileUtils.rm(filename)
   end
 
   def clean_dir(dirname)
-    return unless File.exists?(dirname)
+    return unless File.exist?(dirname)
     say "cleaning up directory: #{dirname}"
     FileUtils.rm_r(dirname)
   end
@@ -130,7 +130,7 @@ private ######################################################################
       matchers << File.join(options[:template], name_without_first) if options[:template]
       matchers << File.expand_path("~/.foreman/templates/#{name}")
       matchers << File.expand_path("../../../../data/export/#{name}", __FILE__)
-      File.read(matchers.detect { |m| File.exists?(m) })
+      File.read(matchers.detect { |m| File.exist?(m) })
     end
   end
 

data/lib/foreman/procfile.rb

@@ -4,12 +4,14 @@ require "foreman"
 #
 # A valid Procfile entry is captured by this regex:
 #
-#   /^([A-Za-z0-9_]+):\s*(.+)$/
+#   /^([A-Za-z0-9_-]+):\s*(.+)$/
 #
 # All other lines are ignored.
 #
 class Foreman::Procfile
 
+  EmptyFileError = Class.new(StandardError)
+
   # Initialize a Procfile
   #
   # @param [String] filename (nil)  An optional filename to read from
@@ -60,7 +62,11 @@ class Foreman::Procfile
   # @param [String] filename  The filename of the +Procfile+ to load
   #
   def load(filename)
-    @entries.replace parse(filename)
+    parse_data = parse(filename)
+
+    raise EmptyFileError if parse_data.empty?
+
+    @entries.replace parse_data
   end
 
   # Save a Procfile to a file

data/lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.87.1"
+  VERSION = "0.88.1"
 
 end

data/man/foreman.1

@@ -1,284 +1,181 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "FOREMAN" "1" "January 2020" "Foreman 0.87.1" "Foreman Manual"
-.
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "FOREMAN" "1" "April 2024" "Foreman 0.88.1" "Foreman Manual"
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
-.
 .SH "SYNOPSIS"
 \fBforeman start [process]\fR
-.
 .br
 \fBforeman run <command>\fR
-.
 .br
 \fBforeman export <format> [location]\fR
-.
 .SH "DESCRIPTION"
 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\.
-.
 .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\-m\fR, \fB\-\-formation\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\-e\fR, \fB\-\-env\fR
 Specify one or more \.env files to load
-.
 .TP
 \fB\-f\fR, \fB\-\-procfile\fR
 Specify an alternate Procfile to load, implies \fB\-d\fR at the Procfile root\.
-.
 .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\-t\fR, \fB\-\-timeout\fR
 Specify the amount of time (in seconds) processes have to shutdown gracefully before receiving a SIGKILL, defaults to 5\.
-.
 .P
 \fBforeman run\fR is used to run one\-off commands using the same environment as your defined processes\.
-.
 .SH "EXPORTING"
 \fBforeman export\fR is used to export your application to another process management format\.
-.
 .P
 A 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\.
-.
+Use this name rather than the application's root directory name as the name of the application when exporting\.
 .TP
 \fB\-m\fR, \fB\-\-formation\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\-t\fR, \fB\-\-template\fR
 Specify an alternate template to use for creating export files\. See \fIhttps://github\.com/ddollar/foreman/tree/master/data/export\fR for examples\.
-.
 .TP
 \fB\-u\fR, \fB\-\-user\fR
 Specify the user the application should be run as\. Defaults to the app name
-.
 .SH "GLOBAL OPTIONS"
-These options control all modes of foreman\'s operation\.
-.
+These options control all modes of foreman's operation\.
 .TP
 \fB\-d\fR, \fB\-\-root\fR
 Specify an alternate application root\. This defaults to the directory containing the Procfile\.
-.
 .TP
 \fB\-e\fR, \fB\-\-env\fR
 Specify an alternate environment file\. You can specify more than one file by using: \fB\-\-env file1,file2\fR\.
-.
 .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\.
-.
+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
 bluepill
-.
 .IP "\(bu" 4
 inittab
-.
 .IP "\(bu" 4
 launchd
-.
 .IP "\(bu" 4
 runit
-.
 .IP "\(bu" 4
 supervisord
-.
 .IP "\(bu" 4
 systemd
-.
 .IP "\(bu" 4
 upstart
-.
 .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\'
+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 "SYSTEMD EXPORT"
 Will create a series of systemd scripts in the location you specify\. Scripts will be structured to make the following commands valid:
-.
 .P
 \fBsystemctl start appname\.target\fR
-.
 .P
 \fBsystemctl stop appname\-processname\.target\fR
-.
 .P
 \fBsystemctl restart appname\-processname\-3\.service\fR
-.
 .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
 A process name may contain letters, numbers and the underscore character\. You can validate your Procfile format using the \fBcheck\fR command:
-.
 .IP "" 4
-.
 .nf
-
 $ foreman check
-.
 .fi
-.
 .IP "" 0
-.
 .P
 The special environment variables \fB$PORT\fR and \fB$PS\fR are available within the Procfile\. \fB$PORT\fR is the port selected for that process\. \fB$PS\fR is the name of the process for the line\.
-.
 .P
 The \fB$PORT\fR value starts as the base port as specified by \fB\-p\fR, then increments by 100 for each new process line\. Multiple instances of the same process are assigned \fB$PORT\fR values that increment by 1\.
-.
 .SH "ENVIRONMENT"
 If a \fB\.env\fR file exists in the current directory, the default environment will be read from it\. This file should contain key/value pairs, separated by \fB=\fR, with one key/value pair per line\.
-.
 .IP "" 4
-.
 .nf
-
 FOO=bar
 BAZ=qux
-.
 .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
-
 formation: alpha=0,bravo=1
 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 \-f ~/myapp/Procfile
-.
 .fi
-.
 .IP "" 0
-.
 .P
 Start all processes except the one named worker:
-.
 .IP "" 4
-.
 .nf
-
 $ foreman start \-m all=1,worker=0
-.
 .fi
-.
 .IP "" 0
-.
 .SH "COPYRIGHT"
 Foreman is Copyright (C) 2010 David Dollar \fIhttp://daviddollar\.org\fR

data/spec/foreman/export/daemon_spec.rb

@@ -60,7 +60,7 @@ describe Foreman::Export::Daemon, :fakefs do
       expect(File.read("/tmp/init/app-alpha.conf")).to      eq(example_export_file("daemon/app-alpha.conf"))
       expect(File.read("/tmp/init/app-alpha-1.conf")).to    eq(example_export_file("daemon/app-alpha-1.conf"))
       expect(File.read("/tmp/init/app-alpha-2.conf")).to    eq(example_export_file("daemon/app-alpha-2.conf"))
-      expect(File.exists?("/tmp/init/app-bravo-1.conf")).to eq(false)
+      expect(File.exist?("/tmp/init/app-bravo-1.conf")).to eq(false)
     end
   end
 

data/spec/foreman/export/upstart_spec.rb

@@ -81,7 +81,7 @@ describe Foreman::Export::Upstart, :fakefs do
       expect(File.read("/tmp/init/app-alpha.conf")).to      eq(example_export_file("upstart/app-alpha.conf"))
       expect(File.read("/tmp/init/app-alpha-1.conf")).to    eq(example_export_file("upstart/app-alpha-1.conf"))
       expect(File.read("/tmp/init/app-alpha-2.conf")).to    eq(example_export_file("upstart/app-alpha-2.conf"))
-      expect(File.exists?("/tmp/init/app-bravo-1.conf")).to eq(false)
+      expect(File.exist?("/tmp/init/app-bravo-1.conf")).to eq(false)
     end
   end
 

data/spec/foreman/procfile_spec.rb

@@ -22,6 +22,14 @@ describe Foreman::Procfile, :fakefs do
     expect(procfile["foo_bar"]).to eq("./foo_bar")
   end
 
+  it "raises an error if Procfile is empty" do
+    write_file "Procfile" do |procfile|
+      procfile.puts
+    end
+
+    expect { Foreman::Procfile.new("Procfile") }.to raise_error described_class::EmptyFileError
+  end
+
   it 'only creates Procfile entries for lines matching regex' do
     write_procfile
     procfile = Foreman::Procfile.new("Procfile")

data/spec/foreman_spec.rb

@@ -10,7 +10,7 @@ describe Foreman do
 
   describe "runner" do
     it "should exist" do
-      expect(File.exists?(Foreman.runner)).to eq(true)
+      expect(File.exist?(Foreman.runner)).to eq(true)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,13 +1,3 @@
-# it throws following message:
-# W, [2018-02-06T18:16:06.360071 #72025]  WARN -- :       This usage of the Code Climate Test Reporter is now deprecated. Since version
-#       1.0, we now require you to run `SimpleCov` in your test/spec helper, and then
-#       run the provided `codeclimate-test-reporter` binary separately to report your
-#       results to Code Climate.
-#
-#       More information here: https://github.com/codeclimate/ruby-test-reporter/blob/master/README.md
-# require "codeclimate-test-reporter"
-# CodeClimate::TestReporter.start
-
 require "simplecov"
 SimpleCov.start do
   add_filter "/spec/"
@@ -78,7 +68,7 @@ def fork_and_get_exitstatus(args)
 end
 
 def mock_exit(&block)
-  expect(block).to raise_error(SystemExit)
+  expect { block.call }.to raise_error(SystemExit)
 end
 
 def write_foreman_config(app)
@@ -181,7 +171,4 @@ RSpec.configure do |config|
   config.before(:each) do
     FileUtils.mkdir_p('/tmp')
   end
-  config.after(:each) do
-    FileUtils.rm_rf('/tmp')
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman
 version: !ruby/object:Gem::Version
-  version: 0.87.1
+  version: 0.88.1
 platform: ruby
 authors:
 - David Dollar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies: []
 description: Process manager for applications with multiple components
 email: ddollar@gmail.com
@@ -151,11 +151,11 @@ files:
 - spec/resources/export/upstart/app-bravo.conf
 - spec/resources/export/upstart/app.conf
 - spec/spec_helper.rb
-homepage: http://github.com/ddollar/foreman
+homepage: https://github.com/ddollar/foreman
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Process manager for applications with multiple components
 test_files: []