potluck 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1c7870515c28013595dbe15f34ba4c2cf3e76fabbbd55c1859066462df9227f
-  data.tar.gz: a87627ecfe3232593fd0f7223089a15893ad3e7227aed8a47d48ec32326b0572
+  metadata.gz: 67a2b224bd6ed00dcfe15688c0ebaa8764649cc7a201174c20c6238bab45bc27
+  data.tar.gz: e1fececdb06d683f1879ac8baab15a26ba8bb6db2a15a3ea8e0dd247876435e9
 SHA512:
-  metadata.gz: 6b4cc348d159c69e95de691c0e6f0c159ef94818174f3f45319e76e21b971669e600a1d3fb4040edecc0a05b130c6ab0fcdcd2eb08dfdf3fe5e32936d13d7685
-  data.tar.gz: 9e69dd441a0bf951edbccf7d7c590a9697327033e3e88a61801ceaefb3d05ba13734ecba4580f446e1497964a947d99b725a25832d9c0e8efe841a8fdc3414c0
+  metadata.gz: 43b41b2bade1a6b87ee0d266a38f0d59b7417e5a652804521952356d7aec8fb9f98c3e2727e903e5b79b91587ff621c557b7be90325e86db303ab66cf5c193d1
+  data.tar.gz: 6ffedd39746332d83f7c09b3cf3a7a4e40c60503eb88f3083e904347712a60a508199fcb44b8d8949250992e61de160e476654f5acb2f4a1b7ca867e26a13ba8

data/README.md

@@ -1,6 +1,19 @@
 # Potluck
 
-Potluck is an extensible Ruby framework for managing external processes.
+Potluck is an extensible Ruby framework for configuring, controlling, and interacting with external
+processes. It leverages `launchctl` for starting and stopping processes when the command is available (e.g.
+when developing locally on macOS) while gracefully taking either a more passive or manual role with external
+processes in other environments (e.g. production).
+
+The core Potluck gem provides a simple interface which is used by service-specific extensions to the gem.
+Currently there are two official extensions:
+
+* [Potluck::Nginx](potluck-nginx/README.md) - Generates Nginx configuration files and (optionally) controls
+  the Nginx process with `launchctl` or manual commands. Allows for multiple Ruby apps as well as other
+  external processes to all seamlessly use Nginx simultaneously.
+* [Potluck::Postgres](potluck-postgres/README.md) - Provides control of the Postgres process and basic
+  common functionality for connecting to and setting up a database. Uses the
+  [Sequel](https://github.com/jeremyevans/sequel) and [pg](https://github.com/ged/ruby-pg) gems.
 
 ## Installation
 
@@ -18,7 +31,9 @@ gem install potluck
 
 ## Usage
 
-[Coming soon.]
+The core Potluck gem is not meant to be used directly. Rather its `Service` class defines a common interface
+for external processes which can be inherited by service-specific child classes. See
+[Potluck::Nginx](potluck-nginx/README.md) and [Potluck::Postgres](potluck-postgres/README.md) for examples.
 
 ## Contributing
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/potluck/service.rb

@@ -4,16 +4,16 @@ require('fileutils')
 
 module Potluck
   ##
-  # A Ruby interface for controlling, configuring, and interacting with external processes. Serves as a
+  # General error class used for errors encountered with a service.
+  #
+  class ServiceError < StandardError; end
+
+  ##
+  # A Ruby interface for configuring, controlling, and interacting with external processes. Serves as a
   # parent class for service-specific child classes.
   #
   class Service
     SERVICE_PREFIX = 'potluck.npickens.'
-
-    PLIST_XML = '<?xml version="1.0" encoding="UTF-8"?>'
-    PLIST_DOCTYPE = '<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/Prope'\
-      'rtyList-1.0.dtd">'
-
     LAUNCHCTL_ERROR_REGEX = /^-|\t[^0]\t/.freeze
 
     ##
@@ -23,9 +23,8 @@ module Potluck
     #   be sent to stdout and stderr if none is supplied.
     # * +manage+ - True if the service runs locally and should be managed by this process (default: true if
     #   launchctl is available and false otherwise).
-    # * +is_local+ - DEPRECATED. True if the service runs locally (use +manage+ instead).
     #
-    def initialize(logger: nil, manage: launchctl?, is_local: (is_local_omitted = true; nil))
+    def initialize(logger: nil, manage: launchctl?)
       @logger = logger
       @manage = !!manage
 
@@ -37,14 +36,6 @@ module Potluck
       elsif manage
         ensure_launchctl!
       end
-
-      # DEPRECATED. Use +manage+ instead.
-      @is_local = is_local.nil? ? (IS_MACOS && ensure_launchctl! rescue false) : is_local
-
-      unless is_local_omitted
-        warn("#{self.class}#initialize `is_local` parameter is deprecated and will be removed soon (use "\
-          '`manage` instead)')
-      end
     end
 
     ##
@@ -65,7 +56,7 @@ module Potluck
     # Checks if launchctl is available and raises an error if not.
     #
     def ensure_launchctl!
-      launchctl? || raise("Cannot manage #{self.class.to_s.split('::').last}: launchctl not found")
+      launchctl? || raise(ServiceError.new("Cannot manage #{self.pretty_name}: launchctl not found"))
     end
 
     ##
@@ -142,7 +133,7 @@ module Potluck
       run(start_command)
       wait { status == :inactive }
 
-      raise("Could not start #{self.class.pretty_name}") if status != :active
+      raise(ServiceError.new("Could not start #{self.class.pretty_name}")) if status != :active
 
       log("#{self.class.pretty_name} started")
     end
@@ -156,7 +147,7 @@ module Potluck
       run(stop_command)
       wait { status != :inactive }
 
-      raise("Could not stop #{self.class.pretty_name}") if status != :inactive
+      raise(ServiceError.new("Could not stop #{self.class.pretty_name}")) if status != :inactive
 
       log("#{self.class.pretty_name} stopped")
     end
@@ -184,7 +175,7 @@ module Potluck
 
       if status != 0
         output.split("\n").each { |line| log(line, :error) }
-        raise("Command exited with status #{status.to_i}: #{command}")
+        raise(ServiceError.new("Command exited with status #{status.to_i}: #{command}"))
       else
         output
       end
@@ -255,8 +246,9 @@ module Potluck
     #
     def self.plist(content)
       <<~EOS
-        #{PLIST_XML}
-        #{PLIST_DOCTYPE}
+        <?xml version="1.0" encoding="UTF-8"?>
+        #{'<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.'\
+          '0.dtd">'}
         <plist version="1.0">
         <dict>
           <key>Label</key>
@@ -271,17 +263,4 @@ module Potluck
       EOS
     end
   end
-
-  ##
-  # DEPRECATED. Old name of Potluck::Service class.
-  #
-  Dish = Service.clone
-
-  # :nodoc: all
-  class Dish
-    def self.inherited(subclass)
-      warn("Potluck::Dish has been renamed to Potluck::Service. Please update #{subclass} to inherit from "\
-        'Potluck::Service instead of Potluck::Dish.')
-    end
-  end
 end

data/lib/potluck/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potluck
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nate Pickens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler