locd 0.1.3

data/lib/locd/config.rb

@@ -0,0 +1,237 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+require 'pathname'
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# @todo document Locd::Config class.
+class Locd::Config
+  
+  # Constants
+  # ===================================================================
+  
+  # Absolute path to the default config file (`//config/default.yml`).
+  # 
+  # Has to be defined as a constant because no other config is loaded
+  # before it and it contains the ENV var prefix.
+  # 
+  # @return [Pathname]
+  # 
+  DEFAULT_CONFIG_PATH = Locd::ROOT / 'config' / 'default.yml'
+  
+  
+  # Absolute path to the dev override config, which will be loaded
+  # last if it exists.
+  # 
+  # @return [Pathname]
+  # 
+  DEV_CONFIG_PATH = Locd::ROOT / 'dev' / 'config.yml'
+  
+  
+  # What to split string keys into key path segments on.
+  # 
+  # @return [String]
+  # 
+  KEY_SEPARATOR = '.'
+  
+  
+  # Attributes
+  # ============================================================================
+  
+  # Absolute path to the built-in default configuration file in use.
+  # 
+  # @return [Pathname]
+  #     
+  attr_reader :default_config_path
+  
+  
+  # Constructor
+  # ===================================================================
+  
+  # Instantiate a new `Locd::Config`.
+  def initialize  default_config_path: DEFAULT_CONFIG_PATH,
+                  dev_config_path: DEV_CONFIG_PATH
+    @default_config_path = default_config_path.to_pn
+    @dev_config_path = dev_config_path.to_pn
+    
+    @from_files = {}
+    
+    load_file default_config_path
+    
+    if user_config_path.exist?
+      load_file user_config_path
+    end
+    
+    if dev_config_path && dev_config_path.exist?
+      load_file dev_config_path
+    end
+  end # #initialize
+  
+  
+  # Instance Methods
+  # ===================================================================
+  
+  protected
+  # ========================================================================
+    
+    
+    # @todo Document load_file method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def load_file path
+      bnd = binding
+      
+      path.
+        to_pn.
+        read.
+        thru { |contents|
+            YAML.load contents
+        }.
+        map_leaves { |path, leaf|
+          case leaf
+          when String
+            bnd.erb leaf
+          else
+            leaf
+          end
+        }.
+        thru { |tree|
+          @from_files.deep_merge! tree
+        }
+      
+      nil
+    end # #load_file
+    
+  public # end protected ***************************************************
+  
+  
+  def key_path_for *key
+    key.flat_map { |k| k.to_s.split KEY_SEPARATOR }
+  end
+  
+  
+  def from_files *key, type: nil
+    key_path = key_path_for *key
+    value = @from_files.dig Locd::GEM_NAME, *key_path
+    
+    if value.nil?
+      nil
+    else
+      parse_and_check value, type: type
+    end
+  end
+  
+  
+  def env_key_for *key
+    [
+      from_files( :namespace, :env, type: t.non_empty_str ),
+      *key_path_for( *key )
+    ].join( '_' ).upcase
+  end
+  
+  
+  def parse_and_check value, type: nil
+    return value if type.nil?
+    
+    if value.is_a?( String ) && type.has_from_s?
+      type.from_s value
+    else
+      type.check value
+    end
+  end
+  
+  
+  def from_env *key, type: nil
+    env_key = env_key_for *key
+    
+    value = ENV[env_key]
+    
+    case value
+    when nil, ''
+      nil
+    else
+      parse_and_check value, type: type
+    end
+  end
+  
+  
+  def get *key, type: nil, default: nil
+    env_value = from_env *key, type: type
+    return env_value unless env_value.nil?
+    
+    files_value = from_files *key, type: type
+    return files_value unless files_value.nil?
+    
+    parse_and_check default, type: type
+  end
+  
+  alias_method :[], :get
+  
+  
+  def to_h
+    @from_files.merge \
+      "locd" => @from_files["locd"].map_leaves { |key_path, value|
+        env_value = from_env *key_path
+        
+        if env_value.nil?
+          value
+        else
+          env_value
+        end
+      }
+  end
+  
+  
+  # @return [Pathname]
+  #   Absolute path to Loc'd home directory (it's workspace).
+  #   Directory may not exist, or may be something else like a file.
+  #   
+  def home_dir
+    self[:home, type: t.abs_path].to_pn
+  end
+  
+  
+  def log_dir
+    self[
+      :log_dir,
+      type: t.abs_path,
+      default: (home_dir / 'log')
+    ]
+  end
+  
+  
+  # @return [Pathname]
+  #   Absolute path to the user config file, which may not exist, but
+  #   will be loaded if it does.
+  # 
+  def user_config_path
+    home_dir / 'config.yml'
+  end
+  
+end # class Locd::Config

data/lib/locd/config/base.rb

@@ -0,0 +1,93 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+
+
+# Definitions
+# =======================================================================
+
+
+# @todo document Locd::Config::Base class.
+class Locd::Config::Base
+  
+  # Constants
+  # ======================================================================
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  
+  # Attributes
+  # ======================================================================
+  
+  
+  # TODO document `key_separator` attribute.
+  # 
+  # @return [attr_type]
+  #     
+  attr_reader :key_separator
+  
+  
+  # Constructor
+  # ======================================================================
+  
+  # Instantiate a new `Locd::Config::Base`.
+  def initialize source:, parent: nil, key_separator: '.'
+    @source = source
+    @parent = parent
+    @key_separator = key_separator
+  end # #initialize
+  
+  
+  # Instance Methods
+  # ======================================================================
+  
+  def key_path_for *key
+    key.flat_map { |k| k.to_s.split key_separator }
+  end
+  
+  
+  def dig *key_path
+    if key_path.length == 1
+      if source.key? key_path[0]
+        return source[key_path[0]]
+      end
+    else
+      just_before = source.dig key_path[0...-1]
+      if  just_before.respond_to?( :key? ) &&
+          just_before.key? key_path[-1]
+        return just_before[key_path[-1]]
+      end
+    end
+    
+    if parent
+      parent.dig key_path
+    else
+      nil
+    end
+  end
+  
+  
+  def get *key
+    dig key_path_for( *key )
+  end
+  
+  
+end # class Locd::Config::Base

data/lib/locd/errors.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Refinements
+# =======================================================================
+
+using NRSER
+
+
+# Definitions
+# =======================================================================
+
+module Locd
+  
+  # Classes
+  # ----------------------------------------------------------------------------
+  
+  # Base class for errors that are to be expected and should be handled
+  # gracefully.
+  # 
+  class HandledError < StandardError; end
+  
+  
+  # Base class for {HandledError} that happen during request processing which
+  # should result in useful error responses to the user.
+  # 
+  class RequestError < HandledError
+    STATUS_CODE = 400
+    STATUS_MESSAGE = "Bad Request"
+    
+    def self.status
+      "#{ self::STATUS_CODE } #{ self::STATUS_MESSAGE }"
+    end
+    
+    
+    # TODO document `text` attribute.
+    # 
+    # @return [attr_type]
+    #     
+    attr_reader :text
+    
+    
+    def initialize text = self.class::STATUS_MESSAGE
+      @text = text
+      super "#{ self.class.status }\n\n#{ text }"
+    end
+    
+    def to_http_response
+      Locd.http_response_for self.class.status, text
+    end
+    
+    def to_proxy_machine_cmd
+      { close: to_http_response }
+    end
+  end
+  
+  
+  # Raised when we couldn't find what the request seems to be looking for
+  # (`404 Not Found` in HTTP).
+  # 
+  class NotFoundError < RequestError
+    STATUS_CODE = 404
+    STATUS_MESSAGE = "Not Found"
+  end
+  
+end # module Locd

data/lib/locd/label.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Refinements
+# =======================================================================
+
+using NRSER
+
+
+# Definitions
+# =======================================================================
+
+# Static method namespace for dealing with labels.
+# 
+module Locd::Label
+  
+  def self.url_for label, tld:, port:
+    "http://#{ label }:#{ port }"
+  end
+  
+  
+  # Simple transformation of "glob-style" label patterns to {Regexp}.
+  # 
+  # **_Right now only handles the `*` wildcard!_**
+  # 
+  # @param [String] string
+  #   Glob-style pattern to search for in {Locd::Agent#label} strings.
+  # 
+  # @param [Boolean] exact:
+  #   When `false`, the returned Regexp will match any part of label
+  #   strings.
+  #   
+  #   When `true`, the generated Regexp will only match if `pattern` matches
+  #   entire label strings.
+  # 
+  # @param [Boolean] ignore_case:
+  #   Makes the Regexp case-insensitive.
+  # 
+  # 
+  def self.regexp_for_glob string, exact: false, ignore_case: false
+    string.
+      # Uncommon option: `-1` causes empty segments to be included, which
+      # fixes the issue of `*` at start or end
+      split( '*', -1 ).
+      map( &Regexp.method( :escape ) ).
+      join( '.*' ).
+      thru { |regexp_string|
+        # Add `\A` and `\z` caps if `exact` is set
+        regexp_string = "\\A#{ regexp_string }\\z" if exact
+        
+        Regexp.new regexp_string, ignore_case
+      }
+  end
+  
+  
+  def self.compare label_a, label_b
+    [label_a, label_b].
+      map { |label| label.split( '.' ).reverse }.
+      thru { |a, b| a <=> b }
+  end
+    
+end # module Locd::Label