Class: Homebrew::Service

Inherits:
Object show all
Extended by:
Forwardable
Includes:
OnSystem::MacOSAndLinux
Defined in:
service.rb,
service.rbi,
sorbet/rbi/parlour.rbi

Overview

The Service class implements the DSL methods used in a formula’s service block and stores related instance variables. Most of these methods also return the related instance variable when no argument is provided.

Constant Summary collapse

RUN_TYPE_IMMEDIATE =
:immediate
RUN_TYPE_INTERVAL =
:interval
RUN_TYPE_CRON =
:cron
PROCESS_TYPE_BACKGROUND =
:background
PROCESS_TYPE_STANDARD =
:standard
PROCESS_TYPE_INTERACTIVE =
:interactive
PROCESS_TYPE_ADAPTIVE =
:adaptive
KEEP_ALIVE_KEYS =
[:always, :successful_exit, :crashed, :path].freeze
SOCKET_STRING_REGEX =
%r{^([a-z]+)://(.+):([0-9]+)$}i

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OnSystem::MacOSAndLinux

included

Constructor Details

#initialize(formula, &block) ⇒ Service

sig { params(formula: Formula).void }



27
28
29
30
31
32
33
# File 'service.rb', line 27

def initialize(formula, &block)
  @formula = formula
  @run_type = RUN_TYPE_IMMEDIATE
  @run_at_load = true
  @environment_variables = {}
  instance_eval(&block) if block
end

Class Method Details

.from_hash(api_hash) ⇒ Hash

Turn the service API hash values back into what is expected by the formula DSL.

Parameters:

Returns:



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
# File 'service.rb', line 571

def self.from_hash(api_hash)
  hash = {}
  hash[:name] = api_hash["name"].transform_keys(&:to_sym) if api_hash.key?("name")

  # The service hash might not have a "run" command if it only documents
  # an existing service file with the "name" command.
  return hash unless api_hash.key?("run")

  hash[:run] =
    case api_hash["run"]
    when String
      replace_placeholders(api_hash["run"])
    when Array
      api_hash["run"].map { replace_placeholders(_1) }
    when Hash
      api_hash["run"].to_h do |key, elem|
        run_cmd = if elem.is_a?(Array)
          elem.map { replace_placeholders(_1) }
        else
          replace_placeholders(elem)
        end

        [key.to_sym, run_cmd]
      end
    else
      raise ArgumentError, "Unexpected run command: #{api_hash["run"]}"
    end

  if api_hash.key?("environment_variables")
    hash[:environment_variables] = api_hash["environment_variables"].to_h do |key, value|
      [key.to_sym, replace_placeholders(value)]
    end
  end

  %w[run_type process_type].each do |key|
    next unless (value = api_hash[key])

    hash[key.to_sym] = value.to_sym
  end

  %w[working_dir root_dir input_path log_path error_log_path].each do |key|
    next unless (value = api_hash[key])

    hash[key.to_sym] = replace_placeholders(value)
  end

  %w[interval cron launch_only_once require_root restart_delay macos_legacy_timers].each do |key|
    next if (value = api_hash[key]).nil?

    hash[key.to_sym] = value
  end

  %w[sockets keep_alive].each do |key|
    next unless (value = api_hash[key])

    hash[key.to_sym] = if value.is_a?(Hash)
      value.transform_keys(&:to_sym)
    else
      value
    end
  end

  hash
end

.replace_placeholders(string) ⇒ String

Replace API path placeholders with local paths.

Parameters:

Returns:



638
639
640
641
642
# File 'service.rb', line 638

def self.replace_placeholders(string)
  string.gsub(HOMEBREW_PREFIX_PLACEHOLDER, HOMEBREW_PREFIX)
        .gsub(HOMEBREW_CELLAR_PLACEHOLDER, HOMEBREW_CELLAR)
        .gsub(HOMEBREW_HOME_PLACEHOLDER, Dir.home)
end

Instance Method Details

#bin(*args, **options, &block) ⇒ T.untyped

Parameters:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


391
# File 'sorbet/rbi/parlour.rbi', line 391

def bin(*args, **options, &block); end

#commandArray<String>?

Returns:



366
367
368
# File 'service.rb', line 366

def command
  @run&.map(&:to_s)&.map { |arg| arg.start_with?("~") ? File.expand_path(arg) : arg }
end

#command?Boolean

Returns:

  • (Boolean)


371
372
373
# File 'service.rb', line 371

def command?
  @run.present?
end

#cron(value = nil) ⇒ Hash?

Parameters:

  • value (String, nil) (defaults to: nil)

Returns:



285
286
287
288
289
290
291
292
# File 'service.rb', line 285

def cron(value = nil)
  case value
  when nil
    @cron
  when String
    @cron = parse_cron(T.must(value))
  end
end

#default_cron_valuesHash{Symbol => Integer, String}

Returns:



295
296
297
298
299
300
301
302
303
# File 'service.rb', line 295

def default_cron_values
  {
    Month:   "*",
    Day:     "*",
    Weekday: "*",
    Hour:    "*",
    Minute:  "*",
  }
end

#default_plist_nameString

Returns:



41
42
43
# File 'service.rb', line 41

def default_plist_name
  "homebrew.mxcl.#{@formula.name}"
end

#default_service_nameString

Returns:



51
52
53
# File 'service.rb', line 51

def default_service_name
  "homebrew.#{@formula.name}"
end

#environment_variables(variables = {}) ⇒ Hash{Symbol => String}?

Parameters:

Returns:



341
342
343
344
345
346
# File 'service.rb', line 341

def environment_variables(variables = {})
  case variables
  when Hash
    @environment_variables = variables.transform_values(&:to_s)
  end
end

#error_log_path(path = nil) ⇒ String?

Parameters:

Returns:



135
136
137
138
139
140
141
142
# File 'service.rb', line 135

def error_log_path(path = nil)
  case path
  when nil
    @error_log_path
  when String, Pathname
    @error_log_path = path.to_s
  end
end

#etc(*args, **options, &block) ⇒ T.untyped

Parameters:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


394
# File 'sorbet/rbi/parlour.rbi', line 394

def etc(*args, **options, &block); end

#fFormula

Returns:



36
37
38
# File 'service.rb', line 36

def f
  @formula
end

#input_path(path = nil) ⇒ String?

Parameters:

Returns:



115
116
117
118
119
120
121
122
# File 'service.rb', line 115

def input_path(path = nil)
  case path
  when nil
    @input_path
  when String, Pathname
    @input_path = path.to_s
  end
end

#interval(value = nil) ⇒ Integer?

Parameters:

  • value (Integer, nil) (defaults to: nil)

Returns:

  • (Integer, nil)


275
276
277
278
279
280
281
282
# File 'service.rb', line 275

def interval(value = nil)
  case value
  when nil
    @interval
  when Integer
    @interval = value
  end
end

#keep_alive(value = nil) ⇒ Hash{Symbol => T.untyped}?

Parameters:

  • value (Boolean, Hash{Symbol => T.untyped}, nil) (defaults to: nil)

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'service.rb', line 148

def keep_alive(value = nil)
  case value
  when nil
    @keep_alive
  when true, false
    @keep_alive = { always: value }
  when Hash
    hash = T.cast(value, Hash)
    unless (hash.keys - KEEP_ALIVE_KEYS).empty?
      raise TypeError, "Service#keep_alive allows only #{KEEP_ALIVE_KEYS}"
    end

    @keep_alive = value
  end
end

#keep_alive?Boolean

Returns a Boolean describing if a service is set to be kept alive.

Returns:

  • (Boolean)


224
225
226
# File 'service.rb', line 224

def keep_alive?
  @keep_alive.present? && @keep_alive[:always] != false
end

#launch_only_once(value = nil) ⇒ Boolean?

Parameters:

  • value (Boolean, nil) (defaults to: nil)

Returns:

  • (Boolean, nil)


229
230
231
232
233
234
235
236
# File 'service.rb', line 229

def launch_only_once(value = nil)
  case value
  when nil
    @launch_only_once
  when true, false
    @launch_only_once = value
  end
end

#libexec(*args, **options, &block) ⇒ T.untyped

Parameters:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


397
# File 'sorbet/rbi/parlour.rbi', line 397

def libexec(*args, **options, &block); end

#log_path(path = nil) ⇒ String?

Parameters:

Returns:



125
126
127
128
129
130
131
132
# File 'service.rb', line 125

def log_path(path = nil)
  case path
  when nil
    @log_path
  when String, Pathname
    @log_path = path.to_s
  end
end

#macos_legacy_timers(value = nil) ⇒ Boolean?

Parameters:

  • value (Boolean, nil) (defaults to: nil)

Returns:

  • (Boolean, nil)


349
350
351
352
353
354
355
356
# File 'service.rb', line 349

def macos_legacy_timers(value = nil)
  case value
  when nil
    @macos_legacy_timers
  when true, false
    @macos_legacy_timers = value
  end
end

#manual_commandString

Returns the String command to run manually instead of the service.

Returns:



378
379
380
381
382
383
384
# File 'service.rb', line 378

def manual_command
  vars = @environment_variables.except(:PATH)
                               .map { |k, v| "#{k}=\"#{v}\"" }

  out = vars + T.must(command).map { |arg| Utils::Shell.sh_quote(arg) } if command?
  out.join(" ")
end

#name(macos: nil, linux: nil) ⇒ void

This method returns an undefined value.

Parameters:

  • macos (String, nil) (defaults to: nil)
  • linux (String, nil) (defaults to: nil)

Raises:

  • (TypeError)


61
62
63
64
65
66
# File 'service.rb', line 61

def name(macos: nil, linux: nil)
  raise TypeError, "Service#name expects at least one String" if [macos, linux].none?(String)

  @plist_name = macos if macos
  @service_name = linux if linux
end

#on_system_conditional(macos: nil, linux: nil) ⇒ Object



5
# File 'service.rbi', line 5

def on_system_conditional(macos: nil, linux: nil); end

#opt_bin(*args, **options, &block) ⇒ T.untyped

Parameters:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


400
# File 'sorbet/rbi/parlour.rbi', line 400

def opt_bin(*args, **options, &block); end

#opt_libexec(*args, **options, &block) ⇒ T.untyped

Parameters:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


403
# File 'sorbet/rbi/parlour.rbi', line 403

def opt_libexec(*args, **options, &block); end

#opt_pkgshare(*args, **options, &block) ⇒ T.untyped

Parameters:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


406
# File 'sorbet/rbi/parlour.rbi', line 406

def opt_pkgshare(*args, **options, &block); end

#opt_prefix(*args, **options, &block) ⇒ T.untyped

Parameters:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


409
# File 'sorbet/rbi/parlour.rbi', line 409

def opt_prefix(*args, **options, &block); end

#opt_sbin(*args, **options, &block) ⇒ T.untyped

Parameters:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


412
# File 'sorbet/rbi/parlour.rbi', line 412

def opt_sbin(*args, **options, &block); end

#parse_cron(cron_statement) ⇒ Hash{Symbol => Integer, String}

Parameters:

Returns:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'service.rb', line 306

def parse_cron(cron_statement)
  parsed = default_cron_values

  case cron_statement
  when "@hourly"
    parsed[:Minute] = 0
  when "@daily"
    parsed[:Minute] = 0
    parsed[:Hour] = 0
  when "@weekly"
    parsed[:Minute] = 0
    parsed[:Hour] = 0
    parsed[:Weekday] = 0
  when "@monthly"
    parsed[:Minute] = 0
    parsed[:Hour] = 0
    parsed[:Day] = 1
  when "@yearly", "@annually"
    parsed[:Minute] = 0
    parsed[:Hour] = 0
    parsed[:Day] = 1
    parsed[:Month] = 1
  else
    cron_parts = cron_statement.split
    raise TypeError, "Service#parse_cron expects a valid cron syntax" if cron_parts.length != 5

    [:Minute, :Hour, :Day, :Month, :Weekday].each_with_index do |selector, index|
      parsed[selector] = Integer(cron_parts.fetch(index)) if cron_parts.fetch(index) != "*"
    end
  end

  parsed
end

#plist_nameString

Returns:



46
47
48
# File 'service.rb', line 46

def plist_name
  @plist_name ||= default_plist_name
end

#process_type(value = nil) ⇒ Symbol?

Parameters:

  • value (Symbol, nil) (defaults to: nil)

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
# File 'service.rb', line 249

def process_type(value = nil)
  case value
  when nil
    @process_type
  when :background, :standard, :interactive, :adaptive
    @process_type = value
  when Symbol
    raise TypeError, "Service#process_type allows: " \
                     "'#{PROCESS_TYPE_BACKGROUND}'/'#{PROCESS_TYPE_STANDARD}'/" \
                     "'#{PROCESS_TYPE_INTERACTIVE}'/'#{PROCESS_TYPE_ADAPTIVE}'"
  end
end

#require_root(value = nil) ⇒ Boolean?

Parameters:

  • value (Boolean, nil) (defaults to: nil)

Returns:

  • (Boolean, nil)


165
166
167
168
169
170
171
172
# File 'service.rb', line 165

def require_root(value = nil)
  case value
  when nil
    @require_root
  when true, false
    @require_root = value
  end
end

#requires_root?Boolean

Returns a Boolean describing if a service requires root access.

Returns:

  • (Boolean)


177
178
179
# File 'service.rb', line 177

def requires_root?
  @require_root.present? && @require_root == true
end

#restart_delay(value = nil) ⇒ Integer?

Parameters:

  • value (Integer, nil) (defaults to: nil)

Returns:

  • (Integer, nil)


239
240
241
242
243
244
245
246
# File 'service.rb', line 239

def restart_delay(value = nil)
  case value
  when nil
    @restart_delay
  when Integer
    @restart_delay = value
  end
end

#root_dir(path = nil) ⇒ String?

Parameters:

Returns:



105
106
107
108
109
110
111
112
# File 'service.rb', line 105

def root_dir(path = nil)
  case path
  when nil
    @root_dir
  when String, Pathname
    @root_dir = path.to_s
  end
end

#run(command = nil, macos: nil, linux: nil) ⇒ Array<String, Pathname>?

Parameters:

Returns:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'service.rb', line 75

def run(command = nil, macos: nil, linux: nil)
  # Save parameters for serialization
  if command
    @run_params = command
  elsif macos || linux
    @run_params = { macos:, linux: }.compact
  end

  command ||= on_system_conditional(macos:, linux:)
  case command
  when nil
    @run
  when String, Pathname
    @run = [command]
  when Array
    @run = command
  end
end

#run_at_load(value = nil) ⇒ Boolean?

Parameters:

  • value (Boolean, nil) (defaults to: nil)

Returns:

  • (Boolean, nil)


182
183
184
185
186
187
188
189
# File 'service.rb', line 182

def run_at_load(value = nil)
  case value
  when nil
    @run_at_load
  when true, false
    @run_at_load = value
  end
end

#run_type(value = nil) ⇒ Symbol?

Parameters:

  • value (Symbol, nil) (defaults to: nil)

Returns:



263
264
265
266
267
268
269
270
271
272
# File 'service.rb', line 263

def run_type(value = nil)
  case value
  when nil
    @run_type
  when :immediate, :interval, :cron
    @run_type = value
  when Symbol
    raise TypeError, "Service#run_type allows: '#{RUN_TYPE_IMMEDIATE}'/'#{RUN_TYPE_INTERVAL}'/'#{RUN_TYPE_CRON}'"
  end
end

#service_nameString

Returns:



56
57
58
# File 'service.rb', line 56

def service_name
  @service_name ||= default_service_name
end

#sockets(value = nil) ⇒ Hash{Symbol => Hash{Symbol => String}}?

Parameters:

Returns:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'service.rb', line 197

def sockets(value = nil)
  return @sockets if value.nil?

  @sockets = case value
  when String
    { listeners: value }
  when Hash
    value
  end.transform_values do |socket_string|
    match = socket_string.match(SOCKET_STRING_REGEX)
    raise TypeError, "Service#sockets a formatted socket definition as <type>://<host>:<port>" if match.blank?

    type, host, port = match.captures

    begin
      IPAddr.new(host)
    rescue IPAddr::InvalidAddressError
      raise TypeError, "Service#sockets expects a valid ipv4 or ipv6 host address"
    end

    { host:, port:, type: }
  end
end

#std_service_path_envString

Returns:



361
362
363
# File 'service.rb', line 361

def std_service_path_env
  "#{HOMEBREW_PREFIX}/bin:#{HOMEBREW_PREFIX}/sbin:/usr/bin:/bin:/usr/sbin:/sbin"
end

#timed?Boolean

Returns a Boolean describing if a service is timed.

Returns:

  • (Boolean)


389
390
391
# File 'service.rb', line 389

def timed?
  @run_type == RUN_TYPE_CRON || @run_type == RUN_TYPE_INTERVAL
end

#to_hashHash

Prepare the service hash for inclusion in the formula API JSON.

Returns:



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
# File 'service.rb', line 518

def to_hash
  name_params = {
    macos: (plist_name if plist_name != default_plist_name),
    linux: (service_name if service_name != default_service_name),
  }.compact

  return { name: name_params }.compact_blank if @run_params.blank?

  cron_string = if @cron.present?
    [:Minute, :Hour, :Day, :Month, :Weekday]
      .map { |key| @cron[key].to_s }
      .join(" ")
  end

  sockets_var = if @sockets.present?
    @sockets.transform_values { |info| "#{info[:type]}://#{info[:host]}:#{info[:port]}" }
            .then do |sockets_hash|
              # TODO: Remove this code when all users are running on versions of Homebrew
              # that can process sockets hashes (this commit or later).
              if sockets_hash.size == 1 && sockets_hash.key?(:listeners)
                # When original #sockets argument was a string: `sockets "tcp://127.0.0.1:80"`
                sockets_hash.fetch(:listeners)
              else
                # When original #sockets argument was a hash: `sockets http: "tcp://0.0.0.0:80"`
                sockets_hash
              end
            end
  end

  {
    name:                  name_params.presence,
    run:                   @run_params,
    run_type:              @run_type,
    interval:              @interval,
    cron:                  cron_string,
    keep_alive:            @keep_alive,
    launch_only_once:      @launch_only_once,
    require_root:          @require_root,
    environment_variables: @environment_variables.presence,
    working_dir:           @working_dir,
    root_dir:              @root_dir,
    input_path:            @input_path,
    log_path:              @log_path,
    error_log_path:        @error_log_path,
    restart_delay:         @restart_delay,
    process_type:          @process_type,
    macos_legacy_timers:   @macos_legacy_timers,
    sockets:               sockets_var,
  }.compact
end

#to_plistString

Returns a String plist.

Returns:



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'service.rb', line 396

def to_plist
  # command needs to be first because it initializes all other values
  base = {
    Label:            plist_name,
    ProgramArguments: command,
    RunAtLoad:        @run_at_load == true,
  }

  base[:LaunchOnlyOnce] = @launch_only_once if @launch_only_once == true
  base[:LegacyTimers] = @macos_legacy_timers if @macos_legacy_timers == true
  base[:TimeOut] = @restart_delay if @restart_delay.present?
  base[:ProcessType] = @process_type.to_s.capitalize if @process_type.present?
  base[:StartInterval] = @interval if @interval.present? && @run_type == RUN_TYPE_INTERVAL
  base[:WorkingDirectory] = File.expand_path(@working_dir) if @working_dir.present?
  base[:RootDirectory] = File.expand_path(@root_dir) if @root_dir.present?
  base[:StandardInPath] = File.expand_path(@input_path) if @input_path.present?
  base[:StandardOutPath] = File.expand_path(@log_path) if @log_path.present?
  base[:StandardErrorPath] = File.expand_path(@error_log_path) if @error_log_path.present?
  base[:EnvironmentVariables] = @environment_variables unless @environment_variables.empty?

  if keep_alive?
    if (always = @keep_alive[:always].presence)
      base[:KeepAlive] = always
    elsif @keep_alive.key?(:successful_exit)
      base[:KeepAlive] = { SuccessfulExit: @keep_alive[:successful_exit] }
    elsif @keep_alive.key?(:crashed)
      base[:KeepAlive] = { Crashed: @keep_alive[:crashed] }
    elsif @keep_alive.key?(:path) && @keep_alive[:path].present?
      base[:KeepAlive] = { PathState: @keep_alive[:path].to_s }
    end
  end

  if @sockets.present?
    base[:Sockets] = {}
    @sockets.each do |name, info|
      base[:Sockets][name] = {
        SockNodeName:    info[:host],
        SockServiceName: info[:port],
        SockProtocol:    info[:type].upcase,
      }
    end
  end

  if @cron.present? && @run_type == RUN_TYPE_CRON
    base[:StartCalendarInterval] = @cron.reject { |_, value| value == "*" }
  end

  # Adding all session types has as the primary effect that if you initialise it through e.g. a Background session
  # and you later "physically" sign in to the owning account (Aqua session), things shouldn't flip out.
  # Also, we're not checking @process_type here because that is used to indicate process priority and not
  # necessarily if it should run in a specific session type. Like database services could run with ProcessType
  # Interactive so they have no resource limitations enforced upon them, but they aren't really interactive in the
  # general sense.
  base[:LimitLoadToSessionType] = %w[Aqua Background LoginWindow StandardIO System]

  base.to_plist
end

#to_systemd_timerString

Returns a String systemd unit timer.

Returns:



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'service.rb', line 491

def to_systemd_timer
  timer = <<~EOS
    [Unit]
    Description=Homebrew generated timer for #{@formula.name}

    [Install]
    WantedBy=timers.target

    [Timer]
    Unit=#{service_name}
  EOS

  options = []
  options << "Persistent=true" if @run_type == RUN_TYPE_CRON
  options << "OnUnitActiveSec=#{@interval}" if @run_type == RUN_TYPE_INTERVAL

  if @run_type == RUN_TYPE_CRON
    minutes = (@cron[:Minute] == "*") ? "*" : format("%02d", @cron[:Minute])
    hours   = (@cron[:Hour] == "*") ? "*" : format("%02d", @cron[:Hour])
    options << "OnCalendar=#{@cron[:Weekday]}-*-#{@cron[:Month]}-#{@cron[:Day]} #{hours}:#{minutes}:00"
  end

  timer + options.join("\n")
end

#to_systemd_unitString

Returns a String systemd unit.

Returns:



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
# File 'service.rb', line 457

def to_systemd_unit
  unit = <<~EOS
    [Unit]
    Description=Homebrew generated unit for #{@formula.name}

    [Install]
    WantedBy=default.target

    [Service]
  EOS

  # command needs to be first because it initializes all other values
  cmd = command&.map { |arg| Utils::Shell.sh_quote(arg) }
               &.join(" ")

  options = []
  options << "Type=#{(@launch_only_once == true) ? "oneshot" : "simple"}"
  options << "ExecStart=#{cmd}"

  options << "Restart=always" if @keep_alive.present? && @keep_alive[:always].present?
  options << "RestartSec=#{restart_delay}" if @restart_delay.present?
  options << "WorkingDirectory=#{File.expand_path(@working_dir)}" if @working_dir.present?
  options << "RootDirectory=#{File.expand_path(@root_dir)}" if @root_dir.present?
  options << "StandardInput=file:#{File.expand_path(@input_path)}" if @input_path.present?
  options << "StandardOutput=append:#{File.expand_path(@log_path)}" if @log_path.present?
  options << "StandardError=append:#{File.expand_path(@error_log_path)}" if @error_log_path.present?
  options += @environment_variables.map { |k, v| "Environment=\"#{k}=#{v}\"" } if @environment_variables.present?

  unit + options.join("\n")
end

#var(*args, **options, &block) ⇒ T.untyped

Parameters:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped)


415
# File 'sorbet/rbi/parlour.rbi', line 415

def var(*args, **options, &block); end

#working_dir(path = nil) ⇒ String?

Parameters:

Returns:



95
96
97
98
99
100
101
102
# File 'service.rb', line 95

def working_dir(path = nil)
  case path
  when nil
    @working_dir
  when String, Pathname
    @working_dir = path.to_s
  end
end