potluck 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67a2b224bd6ed00dcfe15688c0ebaa8764649cc7a201174c20c6238bab45bc27
-  data.tar.gz: e1fececdb06d683f1879ac8baab15a26ba8bb6db2a15a3ea8e0dd247876435e9
+  metadata.gz: 6881b14c35b5ae6be793e8390d8ab87d1b8220ea78a2803dac55f5ea8c2bc4cf
+  data.tar.gz: e0c7b0e3a472f03dded30e35e38fbad4f8f484a1d3cb44cd4ced99248cdd298c
 SHA512:
-  metadata.gz: 43b41b2bade1a6b87ee0d266a38f0d59b7417e5a652804521952356d7aec8fb9f98c3e2727e903e5b79b91587ff621c557b7be90325e86db303ab66cf5c193d1
-  data.tar.gz: 6ffedd39746332d83f7c09b3cf3a7a4e40c60503eb88f3083e904347712a60a508199fcb44b8d8949250992e61de160e476654f5acb2f4a1b7ca867e26a13ba8
+  metadata.gz: 0ce2edbef44e0f8e27ffb0bb63e717d5f9781f29a27661b72de6bd77b0421f73757a230f5d3193f8e04bbaba8abd9e282d8021af9c4aded66e5e10efd78bb2c7
+  data.tar.gz: 5246bb757a883318ed514c8a5a5a94d5631732170c9622d1b20f92541a419fb36b9b559a3a6967ca700d2ba765ec58a323fed3b39fb464f222a9ca9dfc84e77b

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 Nate Pickens
+Copyright 2021-2022 Nate Pickens
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/potluck/service.rb

@@ -24,9 +24,10 @@ module Potluck
     # * +manage+ - True if the service runs locally and should be managed by this process (default: true if
     #   launchctl is available and false otherwise).
     #
-    def initialize(logger: nil, manage: launchctl?)
+    def initialize(logger: nil, manage: self.class.launchctl?)
       @logger = logger
       @manage = !!manage
+      @manage_with_launchctl = false
 
       if manage.kind_of?(Hash)
         @status_command = manage[:status]
@@ -34,7 +35,8 @@ module Potluck
         @start_command = manage[:start]
         @stop_command = manage[:stop]
       elsif manage
-        ensure_launchctl!
+        @manage_with_launchctl = true
+        self.class.ensure_launchctl!
       end
     end
 
@@ -46,54 +48,10 @@ module Potluck
     end
 
     ##
-    # Returns true if launchctl is available.
-    #
-    def launchctl?
-      defined?(@@launchctl) ? @@launchctl : (@@launchctl = `which launchctl 2>&1` && $? == 0)
-    end
-
-    ##
-    # Checks if launchctl is available and raises an error if not.
-    #
-    def ensure_launchctl!
-      launchctl? || raise(ServiceError.new("Cannot manage #{self.pretty_name}: launchctl not found"))
-    end
-
-    ##
-    # Command to get the status of the service.
-    #
-    def status_command
-      @status_command || "launchctl list 2>&1 | grep #{SERVICE_PREFIX}#{self.class.service_name}"
-    end
-
-    ##
-    # Regular expression to check the output of +#status_command+ against to determine if the service is in
-    # an error state.
-    #
-    def status_error_regex
-      @status_error_regex || LAUNCHCTL_ERROR_REGEX
-    end
-
-    ##
-    # Command to start the service.
-    #
-    def start_command
-      @start_command || "launchctl bootstrap gui/#{Process.uid} #{self.class.plist_path}"
-    end
-
-    ##
-    # Command to stop the service.
-    #
-    def stop_command
-      @stop_command || "launchctl bootout gui/#{Process.uid}/#{self.class.launchctl_name}"
-    end
-
-    ##
-    # Writes the service's launchctl plist file to disk.
+    # Returns true if the service is managed via launchctl.
     #
-    def ensure_plist
-      FileUtils.mkdir_p(File.dirname(self.class.plist_path))
-      File.write(self.class.plist_path, self.class.plist)
+    def manage_with_launchctl?
+      @manage_with_launchctl
     end
 
     ##
@@ -123,17 +81,16 @@ module Potluck
     def start
       return unless manage?
 
-      ensure_plist unless @start_command
-
       case status
       when :error then stop
       when :active then return
       end
 
+      self.class.write_plist if manage_with_launchctl?
       run(start_command)
       wait { status == :inactive }
 
-      raise(ServiceError.new("Could not start #{self.class.pretty_name}")) if status != :active
+      raise(ServiceError, "Could not start #{self.class.pretty_name}") if status != :active
 
       log("#{self.class.pretty_name} started")
     end
@@ -144,10 +101,11 @@ module Potluck
     def stop
       return unless manage? && status != :inactive
 
+      self.class.write_plist if manage_with_launchctl?
       run(stop_command)
       wait { status != :inactive }
 
-      raise(ServiceError.new("Could not stop #{self.class.pretty_name}")) if status != :inactive
+      raise(ServiceError, "Could not stop #{self.class.pretty_name}") if status != :inactive
 
       log("#{self.class.pretty_name} stopped")
     end
@@ -166,16 +124,16 @@ module Potluck
     # Runs a command with the default shell. Raises an error if the command exits with a non-zero status.
     #
     # * +command+ - Command to run.
-    # * +redirect_stderr+ - True if stderr should be redirected to stdout; otherwise stderr output will not
+    # * +capture_stderr+ - True if stderr should be redirected to stdout; otherwise stderr output will not
     #   be logged (default: true).
     #
-    def run(command, redirect_stderr: true)
-      output = `#{command}#{' 2>&1' if redirect_stderr}`
+    def run(command, capture_stderr: true)
+      output = `#{command}#{' 2>&1' if capture_stderr}`
       status = $?
 
       if status != 0
         output.split("\n").each { |line| log(line, :error) }
-        raise(ServiceError.new("Command exited with status #{status.to_i}: #{command}"))
+        raise(ServiceError, "Command exited with status #{status.exitstatus}: #{command}")
       else
         output
       end
@@ -195,24 +153,6 @@ module Potluck
       end
     end
 
-    private
-
-    ##
-    # Calls the supplied block repeatedly until it returns false. Checks frequently at first and gradually
-    # reduces down to one-second intervals.
-    #
-    # * +timeout+ - Maximum number of seconds to wait before timing out (default: 30).
-    # * +block+ - Block to call until it returns false.
-    #
-    def wait(timeout = 30, &block)
-      while block.call && timeout > 0
-        reduce = [[(30 - timeout.to_i) / 5.0, 0.1].max, 1].min
-        timeout -= reduce
-
-        sleep(reduce)
-      end
-    end
-
     ##
     # Human-friendly name of the service.
     #
@@ -244,7 +184,7 @@ module Potluck
     ##
     # Content of the launchctl plist file.
     #
-    def self.plist(content)
+    def self.plist(content = '')
       <<~EOS
         <?xml version="1.0" encoding="UTF-8"?>
         #{'<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.'\
@@ -262,5 +202,74 @@ module Potluck
         </plist>
       EOS
     end
+
+    ##
+    # Writes the service's launchctl plist file to disk.
+    #
+    def self.write_plist
+      FileUtils.mkdir_p(File.dirname(plist_path))
+      File.write(plist_path, plist)
+    end
+
+    ##
+    # Returns true if launchctl is available.
+    #
+    def self.launchctl?
+      defined?(@@launchctl) ? @@launchctl : (@@launchctl = `which launchctl 2>&1` && $? == 0)
+    end
+
+    ##
+    # Checks if launchctl is available and raises an error if not.
+    #
+    def self.ensure_launchctl!
+      launchctl? || raise(ServiceError, "Cannot manage #{pretty_name}: launchctl not found")
+    end
+
+    private
+
+    ##
+    # Command to get the status of the service.
+    #
+    def status_command
+      @status_command || "launchctl list 2>&1 | grep #{SERVICE_PREFIX}#{self.class.service_name}"
+    end
+
+    ##
+    # Regular expression to check the output of +#status_command+ against to determine if the service is in
+    # an error state.
+    #
+    def status_error_regex
+      @status_error_regex || LAUNCHCTL_ERROR_REGEX
+    end
+
+    ##
+    # Command to start the service.
+    #
+    def start_command
+      @start_command || "launchctl bootstrap gui/#{Process.uid} #{self.class.plist_path}"
+    end
+
+    ##
+    # Command to stop the service.
+    #
+    def stop_command
+      @stop_command || "launchctl bootout gui/#{Process.uid}/#{self.class.launchctl_name}"
+    end
+
+    ##
+    # Calls the supplied block repeatedly until it returns false. Checks frequently at first and gradually
+    # reduces down to one-second intervals.
+    #
+    # * +timeout+ - Maximum number of seconds to wait before timing out (default: 30).
+    # * +block+ - Block to call until it returns false.
+    #
+    def wait(timeout = 30, &block)
+      while block.call && timeout > 0
+        reduce = [[(30 - timeout.to_i) / 5.0, 0.1].max, 1].min
+        timeout -= reduce
+
+        sleep(reduce)
+      end
+    end
   end
 end

data/lib/potluck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Potluck
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potluck
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Nate Pickens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-31 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,7 +44,10 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 6.0.0
-description: An extensible Ruby framework for managing external processes.
+description: Potluck provides a simple interface for managing external processes in
+  a way that plays nice with others as well as smoothly handling both development
+  and production environments. Current official gem extensions provide Nginx and Postgres
+  management.
 email:
 executables: []
 extensions: []