Class: Foreman::Procfile

Inherits:
Object
  • Object
show all
Defined in:
lib/foreman/procfile.rb

Overview

Reads and writes Procfiles

A valid Procfile entry is captured by this regex:

/^([A-Za-z0-9_]+):\s*(.+)$/

All other lines are ignored.

Instance Method Summary collapse

Constructor Details

#initialize(filename = nil) ⇒ Procfile

Initialize a Procfile

Parameters:

  • filename (String) (defaults to: nil) —

    (nil) An optional filename to read from



17
18
19
20
 
# File 'lib/foreman/procfile.rb', line 17

def initialize(filename=nil)
  @entries = []
  load(filename) if filename
end

Instance Method Details

#[](name) ⇒ Object

Retrieve a Procfile command by name

Parameters:

  • name (String) —

    The name of the Procfile entry to retrieve



34
35
36
37
38
 
# File 'lib/foreman/procfile.rb', line 34

def [](name)
  if entry = @entries.detect { |n,c| name == n }
    entry.last
  end
end

#[]=(name, command) ⇒ Object

Create a Procfile entry

Parameters:

  • name (String) —

    The name of the Procfile entry to create

  • command (String) —

    The command of the Procfile entry to create



45
46
47
48
 
# File 'lib/foreman/procfile.rb', line 45

def []=(name, command)
  delete name
  @entries << [name, command]
end

#delete(name) ⇒ Object

Remove a Procfile entry

Parameters:

  • name (String) —

    The name of the Procfile entry to remove



54
55
56
 
# File 'lib/foreman/procfile.rb', line 54

def delete(name)
  @entries.reject! { |n,c| name == n }
end

#entries ⇒ Object

Yield each Procfile entry in order



24
25
26
27
28
 
# File 'lib/foreman/procfile.rb', line 24

def entries
  @entries.each do |(name, command)|
    yield name, command
  end
end

#load(filename) ⇒ Object

Load a Procfile from a file

Parameters:

  • filename (String) —

    The filename of the Procfile to load



62
63
64
 
# File 'lib/foreman/procfile.rb', line 62

def load(filename)
  @entries.replace parse(filename)
end

#save(filename) ⇒ Object

Save a Procfile to a file

Parameters:

  • filename (String) —

    Save the Procfile to this file



70
71
72
73
74
 
# File 'lib/foreman/procfile.rb', line 70

def save(filename)
  File.open(filename, 'w') do |file|
    file.puts self.to_s
  end
end

#to_s ⇒ Object

Get the Procfile as a String



78
79
80
81
82
 
# File 'lib/foreman/procfile.rb', line 78

def to_s
  @entries.map do |name, command|
    [ name, command ].join(": ")
  end.join("\n")
end