locd 0.1.12 → 0.1.13

data/lib/locd/config/types.rb

@@ -60,20 +60,28 @@ module Types
   def self.by_key
     # Got sick of writing "Hamster::Hash[...]"... "I8" <=> "Immutable"
     @by_key ||= I8[
-      'home'  => config_path,
-      'bin'   => ( t.when( 'locd' ) | config_path ),
+      'home'  => self.ConfigPath,
+      'bin'   => ( t.When( 'locd' ) | self.ConfigPath ),
+
+      'log' => I8[
+        'dir' => self.ConfigPath,
+      ],
+
+      'tmp' => I8[
+        'dir' => self.ConfigPath,
+      ],
       
       'cli' => I8[
         'log' => I8[
           'application' => t.non_empty_str,
           'level' => NRSER::Log::Types.level?,
-          'dest' => ( NRSER::Log::Types.stdio | config_path ),
+          'dest' => ( NRSER::Log::Types.stdio | self.ConfigPath ),
         ],
         
         'bash_comp' => I8[
           'log' => I8[
             'level' => NRSER::Log::Types.level,
-            'dest' => config_path,
+            'dest' => self.ConfigPath,
           ],
         ]
       ]
@@ -94,20 +102,23 @@ module Types
   
   # @!group Type Factory Class Methods
   # --------------------------------------------------------------------------
-  
-  def_factory :package_path do |
-    name: 'PackagePath',
-    
-    from_s: ->( string ) {
-      if string.start_with? '//'
-        Locd::ROOT.join string[2..-1]
-      end
-    },
-    
-    **options
-  |
-    t.path &
-      t.where( name: name, from_s: from_s, **options) { |path|
+
+  #@!method self.PackagePath **options
+  #   @todo Document PackagePath type factory.
+  #   
+  #   @param [Hash] options
+  #     Passed to {Type#initialize}.
+  #   
+  #   @return [Type]
+  #   
+  def_type        :PackagePath,
+    from_s:       ->( s ) {
+                    Locd::ROOT.join( s[2..-1] ) if s.start_with? '//'
+                  },
+  &->( **options ) do
+    t.Intersection \
+      t.Path,
+      t.Where { |path|
         begin
           false == path.
                     to_pn.
@@ -116,17 +127,35 @@ module Types
         rescue StandardError => error
           false
         end
-      }
-  end # def_factory :package_path
-  
+      },
+      **options
+  end # .PackagePath
   
-  def_factory :config_path do |name: 'ConfigPath', **options|
-    t.or \
-      package_path,
-      t.abs_path,
-      name: name,
+
+  #@!method self.ConfigPath **options
+  #   A path we accept in the config. One of:
+  #   
+  #   1.  A {.PackagePath} that starts with `//...`, denoting it's relative to
+  #       the package root.
+  #   
+  #   2.  A {NRSER::Types.HomePath} that starts with `~`, meaning it's relative
+  #       to a user's home directory.
+  #   
+  #   3.  An {NRSER::Types.AbsPath}
+  #   
+  #   @param [Hash] options
+  #     Passed to {Type#initialize}.
+  #   
+  #   @return [Type]
+  #   
+  def_type        :ConfigPath,
+  &->( **options ) do
+    t.Union \
+      self.PackagePath,
+      t.HomePath,
+      t.AbsPath,
       **options
-  end # def_factory :config_path
+  end # .ConfigPath
   
   # @!endgroup Type Factory Class Methods # **********************************
   

data/lib/locd/newsyslog.rb

@@ -32,13 +32,6 @@ module Locd::Newsyslog
   include NRSER::Log::Mixin
   
   
-  # Default place to work out of.
-  # 
-  # @return [Pathname]
-  # 
-  DEFAULT_WORKDIR = Pathname.new( '~/.locd/tmp/newsyslog' ).expand_path
-  
-  
   # Lil' class that holds values for a `newsyslog` conf file entry.
   # 
   # @see https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man5/newsyslog.conf.5.html
@@ -74,8 +67,7 @@ module Locd::Newsyslog
     # @param [type] arg_name
     #   @todo Add name param description.
     # 
-    # @return [return_type]
-    #   @todo Document return value.
+    # @return [String]
     # 
     def self.mode_string_for mode
       # t.match mode,
@@ -91,7 +83,7 @@ module Locd::Newsyslog
         raise ArgumentError,
           "Bad mode: #{ mode.inspect }, need String or Fixnum: '644'; 0644"
       end
-    end # .normalize_mode
+    end # .mode_string_for
     
     
     def self.sig_num_for signal
@@ -201,7 +193,7 @@ module Locd::Newsyslog
   # @param [Locd::Agent] agent:
   #   Agent to run for.
   # 
-  # @param [Pathname | String] workdir:
+  # @param [Pathname | String] tmp_conf_dir:
   #   Directory to write working files to, which are removed after successful
   #   runs.
   # 
@@ -212,13 +204,15 @@ module Locd::Newsyslog
   #   If we didn't run the command 'cause the agent doesn't have any logs
   #   (that we know/care about).
   # 
-  def self.run agent, workdir: DEFAULT_WORKDIR
+  def self.run  agent,
+                tmp_conf_dir: self.tmp_conf_dir,
+                keep_conf_files: false
     logger.debug "Calling {.run_for} agent #{ agent.label }...",
       agent: agent,
-      workdir: workdir
+      tmp_conf_dir: tmp_conf_dir
     
-    # Make sure `workdir` is a {Pathname}
-    workdir = workdir.to_pn
+    # Make sure `tmp_conf_dir` is a {Pathname}
+    tmp_conf_dir = tmp_conf_dir.to_pn
     
     # Collect the unique log paths
     log_paths = agent.log_paths
@@ -237,7 +231,7 @@ module Locd::Newsyslog
     if pid = agent.pid( refresh: true )
       logger.debug "Agent is running", pid: pid
       
-      pid_path = workdir / 'pids' / "#{ agent.label }.pid"
+      pid_path = tmp_conf_dir / 'pids' / "#{ agent.label }.pid"
       FileUtils.mkdir_p( pid_path.dirname ) unless pid_path.dirname.exist?
       pid_path.write pid
       
@@ -253,13 +247,13 @@ module Locd::Newsyslog
       entries.map { |entry|
         [
           entry.log_path.to_s,
-          entry.instance_variables.map_values { |name|
+          entry.instance_variables.map { |name|
             entry.instance_variable_get name
           }
         ]
       }.to_h
     
-    conf_path = workdir / 'confs' / "#{ agent.label }.conf"
+    conf_path = tmp_conf_dir / 'confs' / "#{ agent.label }.conf"
     FileUtils.mkdir_p( conf_path.dirname ) unless conf_path.dirname.exist?
     conf_path.write conf_contents
     
@@ -290,7 +284,7 @@ module Locd::Newsyslog
           ", output:\n" + result.out.indent(1, indent_string: '> ') )
       
       FileUtils.rm( pid_path ) if pid_path
-      FileUtils.rm conf_path
+      FileUtils.rm( conf_path ) unless keep_conf_files
       
       logger.debug "Files cleaned up."
       
@@ -308,19 +302,19 @@ module Locd::Newsyslog
   
   # Call {.run} for each agent.
   # 
-  # @param workdir (see .run)
+  # @param tmp_conf_dir: (see .run)
   # 
   # @return [Hash<Locd::Agent, Cmds::Result?>]
   #   Hash mapping each agent to it's {.run} result (which may be `nil`).
   # 
-  def self.run_all workdir: DEFAULT_WORKDIR, trim_logs: true
+  def self.run_all tmp_conf_dir: self.tmp_conf_dir, trim_logs: true
     log_to_file do
       Locd::Agent.all.values.
         reject { |agent|
-          agent.label == Locd::ROTATE_LOGS_LABEL
+          agent.label == Locd::Agent::RotateLogs.label
         }.
         map { |agent|
-          [agent, run( agent, workdir: workdir )]
+          [agent, run( agent, tmp_conf_dir: tmp_conf_dir )]
         }.
         to_h.
         tap { |_|
@@ -331,7 +325,12 @@ module Locd::Newsyslog
   
   
   def self.log_dir
-    @log_dir ||= Locd.config.log_dir / Locd::ROTATE_LOGS_LABEL
+    @log_dir ||= Locd.config.log_dir.join( Locd::Agent::RotateLogs.label )
+  end
+
+
+  def self.tmp_conf_dir
+    @tmp_conf_dir ||= Locd.config.tmp_dir.join( Locd::Agent::RotateLogs.label )
   end
   
   

data/lib/locd/proxy.rb

@@ -2,6 +2,19 @@
 # encoding: UTF-8
 
 
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Namespace
+# ============================================================================
+
+module  Locd
+
+
 # Definitions
 # =======================================================================
 
@@ -15,7 +28,7 @@
 # [proxymachine]: https://rubygems.org/gems/proxymachine
 # [eventmachine]: https://rubygems.org/gems/eventmachine
 # 
-module Locd::Proxy
+module Proxy
   
   # Constants
   # ======================================================================
@@ -27,13 +40,6 @@ module Locd::Proxy
   HOST_RE = /^Host\:\ /i
   
   
-  # Label for the Loc'd proxy agent itself
-  # 
-  # @return [String]
-  # 
-  ROTATE_LOGS_LABEL = 'com.nrser.locd.rotate-logs'
-  
-  
   # Mixins
   # ============================================================================
   
@@ -264,4 +270,10 @@ module Locd::Proxy
     ProxyMachine.run 'locd', bind, port
   end # .serve
   
-end # module Locd::Proxy
+end # module Proxy
+
+
+# /Namespace
+# ============================================================================
+
+end # module  Locd

data/lib/locd/version.rb

@@ -1,7 +1,44 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
+##############################################################################
+# This file is kind-of special: you should be able to load it totally 
+# independently.
+# 
+# This means you can go
+# 
+#     load 'path/to/gem/lib/locd/version.rb'
+# 
+# and it will succeed, regardless of paths or gems or any other environment or
+# state.
+# 
+# It defines a few very basic pieces of information about the app, and it turns
+# out to be incredibly useful on an adminstration level to be able to fire up
+# any old Ruby interpreter and pull that info in without worrying about all
+# the other shit you need to actually run it.
+# 
+# In general, that means that this file shouldn't require anything, and 
+# anything it does require must not depend on anything outside Ruby's standard
+# library.
+# 
+# This file is loaded by `//locd.gemspec` to get the version information,
+# which is in turn loaded from the `//VERSION` file (see {Locd::VERSION}).
+# 
+##############################################################################
+
+
+# Requirements
+# ========================================================================
+
+# Stdlib
+# ------------------------------------------------------------------------
+
 require 'pathname'
+require 'singleton'
+
+
+# Definitions
+# ========================================================================
 
 module Locd
   # Absolute, expanded path to the gem's root directory.
@@ -11,16 +48,68 @@ module Locd
   ROOT = Pathname.new( __dir__ ).join( '..', '..' ).expand_path
   
   
-  # String version read from `//VERSION`
+  # String version read from `//VERSION` and used in the gemspec.
+  # 
+  # I use this approach in order to create a standard versioning system across
+  # *any* package, regardless or runtime, and so that tools can figure out
+  # what version a package is without even having it's runtime available.
+  # 
+  # This has turned out to be super helpful, and I'm surprised it isn't more
+  # common or standardized in some way... I think pretty much every package
+  # in very language has a root directory and is capable of reading a file
+  # to figure out it's state.
   # 
   # @return [String]
   # 
-  VERSION = (ROOT / 'VERSION').read
+  VERSION = (ROOT + 'VERSION').read.chomp
   
   
-  # The gem name
+  # The gem name, read from the `//NAME` file, and used in the gemspec.
+  # 
+  # See {Locd::VERSION} for an explanation of why bare files in the package
+  # root are used.
   # 
   # @return [String]
   # 
-  GEM_NAME = 'locd'
-end
+  GEM_NAME = (ROOT + 'NAME').read.chomp
+
+  
+  # {Singleton} extension of {Gem::Version} that loads {Locd::VERSION} and
+  # provides some convenient methods.
+  # 
+  class Version < Gem::Version
+    include ::Singleton
+
+    # Private method to instantiate the {#instance} using the {Locd::VERSION}
+    # {String}.
+    # 
+    # @return [Version]
+    # 
+    def self.new
+      super Locd::VERSION
+    end
+
+    # We need to mark {.new} as private to dissuade construction of additional
+    # instances.
+    private_class_method :new
+
+    # Proxies to the {#instance}'s {#dev?}.
+    # 
+    # @return (see #dev?)
+    # 
+    def self.dev?
+      instance.dev?
+    end
+
+    # Tests if the package's version is a development pre-release.
+    # 
+    # @return [Boolean]
+    #   `true` if this is a development pre-release.
+    # 
+    def dev?
+      segments[3] == 'dev'
+    end
+    
+  end # module Version
+
+end # module Locd

data/locd.gemspec

@@ -29,12 +29,16 @@ Gem::Specification.new do |spec|
   # Development Dependencies
   # ----------------------------------------------------------------------------
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", ">= 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.7"
   
   # Nicer REPL experience
   spec.add_development_dependency "pry", '~> 0.10.4'
+  spec.add_development_dependency "pry-rescue", '~> 1.4.5'
+  spec.add_development_dependency "pry-stack_explorer", '~> 0.4.9'
+  
+
   # GitHub-Flavored Markdown (GFM) for use with `yard`
   spec.add_development_dependency 'github-markup', '~> 1.6'
   # Doc site generation with `yard`
@@ -47,7 +51,7 @@ Gem::Specification.new do |spec|
   # ----------------------------------------------------------------------------
   
   # My guns
-  spec.add_dependency "nrser", '~> 0.3.9'
+  spec.add_dependency "nrser", '~> 0.3.12'
   
   # Used to process command templates from projects' `//dev/locd.yml` files
   spec.add_dependency "cmds", ">= 0.2.10"
@@ -59,8 +63,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'plist', '~> 3.4'
   
   # Atli, my fork of Thor for CLI interface
-  spec.add_dependency 'atli', '~> 0.1.12'
+  spec.add_dependency 'atli', '~> 0.1.13'
   
-  # 
+  # TODO IDK what was going on here..
   # spec.add_dependency 'terminal-table', '~> 1.8'
+
+  spec.add_dependency 'rouge', '~> 3.1.1'
 end