rbcli 0.3.2 → 0.4.0

data/lib/rbcli/components/config/backends/toml.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+require 'toml'
+
+class Rbcli::UserConf::Toml < Rbcli::UserConf::Backend
+  private
+
+  def parse str
+    begin
+
+      parsed_str = TOML.load(str).deep_symbolize!
+    rescue => e
+      Rbcli.log.warn "Error when parsing TOML file", "CONF"
+      Rbcli.log.warn e.message, "CONF"
+      Hash.new
+    else
+      @loaded = true
+      parsed_str
+    end
+  end
+
+  def unparse hash
+    TOML::Generator.new(hash).body
+  end
+
+  def inject_banner text, banner
+    banner.lines.map { |line| "# #{line.chomp}" }.join("\n") + "\n" + text
+  end
+end
+
+class Symbol
+  def to_toml(path = "")
+    '"' + self.to_s.sub(/^:/, '') + '"'
+  end
+end

data/lib/rbcli/components/config/backends/yaml.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+require 'yaml'
+
+class Rbcli::UserConf::Yaml < Rbcli::UserConf::Backend
+  private
+
+  def parse str
+    begin
+      parsed_str = YAML.safe_load(str, symbolize_names: true, aliases: true, permitted_classes: [Symbol])
+    rescue Psych::SyntaxError, Psych::DisallowedClass => e
+      Rbcli.log.warn "Invalid #{@type} syntax found at '#{@path}'", "CONF"
+      Rbcli.log.warn e.message, "CONF"
+      Hash.new
+    else
+      @loaded = true
+      parsed_str
+    end
+  end
+
+  def unparse hash
+    hash.to_yaml
+  end
+
+  def inject_banner text, banner
+    banner.lines.map { |line| "# #{line.chomp}" }.join("\n") + "\n" + text
+  end
+end

data/lib/rbcli/components/config/component.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+module Rbcli::Configurate::Config
+  include Rbcli::Configurable
+
+  def self.file location: nil, type: nil, schema_location: nil, save_on_exit: false, create_if_not_exists: false, suppress_errors: false
+    raise Rbcli::ConfigurateError.new "Config file location must either be a path or an array of paths" unless location.nil? || location.is_a?(String) || (location.is_a?(Array) && location.all? { |loc| loc.is_a?(String) })
+    raise Rbcli::ConfigurateError.new "Config schema file location must be a path" unless schema_location.nil? || schema_location.is_a?(String)
+    raise Rbcli::ConfigurateError.new "Config type must be one of the following: #{Rbcli::UserConf::Backend.types.keys.join(', ')}" unless (type.is_a?(String) || type.is_a?(Symbol)) && Rbcli::UserConf::Backend.types.key?(type.downcase.to_sym)
+    config = Rbcli::Config.new location: location, type: type, schema_location: schema_location, create_if_not_exists: create_if_not_exists, suppress_errors: suppress_errors
+    Rbcli::Warehouse.set(:config, config, :parsedopts)
+    Rbcli::Engine.register_operation Proc.new { Rbcli::Warehouse.get(:config, :parsedopts).load!; Rbcli::Warehouse.get(:config, :parsedopts).validate! }, name: :load_config, priority: 40
+    Rbcli::Engine.register_operation Proc.new { Rbcli::Warehouse.get(:config, :parsedopts).save! }, name: :save_config, priority: 160 if save_on_exit
+  end
+
+  def self.banner text
+    raise Rbcli::ConfigurateError.new "The banner must be set to a string." unless text.is_a?(String)
+    Rbcli::Warehouse.get(:config, :parsedopts).set_banner text
+  end
+
+  def self.group slug #, helptext: nil
+    @lastgroup = slug.to_sym
+    Rbcli::Warehouse.get(:config, :parsedopts).add_group(slug.to_sym, helptext: nil)
+  end
+
+  def self.setting slug, default: nil #, helptext: nil
+    # raise Rbcli::ConfigurateError.new "A config group must be defined before declaring any config options" if @lastgroup.nil?
+    Rbcli::Warehouse.get(:config, :parsedopts).add_default(slug.to_sym, helptext: nil, group_path: @lastgroup, default: default)
+  end
+end

data/lib/rbcli/components/config/config.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+require 'deep_merge'
+require 'json-schema'
+require_relative 'backend'
+
+class Rbcli::Config < Hash
+  def initialize location: nil, type: nil, schema_location: nil, create_if_not_exists: false, suppress_errors: false
+    location = [location] unless location.is_a?(Array)
+    find_location = Proc.new do |method|
+      location.each do |loc|
+        storage = Rbcli::UserConf::Backend.create(loc, type: type)
+        if storage.send(method)
+          Rbcli.log.debug("Found config storage at '#{loc}'", "CONF") if method == :exist? && !loc.nil?
+          Rbcli.log.debug("Ready to create config at '#{loc}'", "CONF") if method == :savable? && !loc.nil?
+          @location = loc
+          @storage = storage
+          @should_create = true if method == :savable?
+          break true
+        end
+      end
+    end
+    find_location.call(:exist?)
+    find_location.call(:savable?) if !defined?(@location) && create_if_not_exists
+
+    if (defined?(@location) && !@location.nil? && @location != :null) || type == :env
+      Rbcli.log.debug "Instantiated config of type '#{@storage.type}' at '#{@location}'", "CONF"
+    elsif location.nil? || location == :null || location == [nil]
+      Rbcli.log.debug "Instantiated null config; data will not be stored", "CONF"
+      @location = :null
+      @storage = Rbcli::UserConf::Backend.create(:null)
+    elsif suppress_errors
+      Rbcli.log.debug "Location(s) could not be found and/or are not writeable. Instantiating null config and failing silently.", "CONF"
+      @location = :null
+      @storage = Rbcli::UserConf::Backend.create(:null)
+    else
+      Rbcli.log.fatal "Config file could not be loaded. Please verify that it exists at one of the following locations: #{location.join(", ")}", "CONF"
+      Rbcli::exit 2
+    end
+
+    @original_hash = {}
+    @declared_defaults = { groups: {}, options: {}, helptext: nil }
+    @suppress_errors = suppress_errors
+    @type = @storage.nil? ? nil : @storage.type.downcase.to_sym
+    if schema_location
+      @schema = self.class.new(location: schema_location)
+      @schema.is_schema = true
+    end
+  end
+
+  attr_accessor :is_schema, :type
+
+  def set_banner text
+    @declared_defaults[:helptext] = text
+  end
+
+  def add_group path_arr, helptext: nil
+    make_group path_arr, helptext: helptext, nested: @declared_defaults
+  end
+
+  def add_default slug, helptext: nil, group_path: nil, default: nil, permitted: nil
+    make_group group_path, nested: @declared_defaults
+    make_default slug, helptext: helptext, group_path: group_path, default: default, permitted: permitted, nested: @declared_defaults
+  end
+
+  def load!
+    if @should_create
+      Rbcli.log.add (@suppress_errors ? :debug : :info), "Config file #{@location} does not exist. Creating with default values.", "CONF"
+      self.deep_merge!(@storage.respond_to?(:parse_defaults) ? @storage.parse_defaults(defaults) : defaults)
+      self.save!
+    else
+      Rbcli.log.debug "Loading #{@is_schema ? 'schema' : 'config'} file", "CONF"
+      @original_hash = @storage.load(defaults: self.defaults)
+      if !@storage.loaded?
+        Rbcli.log.add (@suppress_errors ? :debug : :warn), "Could not load #{@is_schema ? 'schema' : 'config'} file", "CONF"
+        Rbcli.log.add (@suppress_errors ? :debug : :warn), "Using defaults", "CONF" unless self.defaults.empty?
+        return false
+      else
+        self.deep_merge!(@storage.respond_to?(:parse_defaults) ? @storage.parse_defaults(defaults) : defaults)
+        self.deep_merge!(@original_hash.deep_symbolize!) if @original_hash.is_a?(Hash)
+      end
+    end
+  end
+
+  def validate!
+    return true if @schema.nil?
+    Rbcli.log.debug "Validating config against schema", "CONF"
+    @schema.load!
+    begin
+      JSON::Validator.validate!(@schema, self)
+    rescue JSON::Schema::ValidationError => e
+      Rbcli.log.send (@suppress_errors ? :debug : :error), "There are errors in the config. Please fix these errors and try again."
+      Rbcli.log.send (@suppress_errors ? :debug : :error), JSON::Validator.fully_validate(@schema, self).join("\n")
+      Rbcli::exit 3 unless @suppress_errors
+      return false
+    end
+    Rbcli.log.debug "Validated config against schema successfully", "CONF"
+    true
+  end
+
+  def save!
+    unless @storage.savable?
+      Rbcli.log.add (@suppress_errors ? :debug : :warn), "Config file not savable. Data not stored.", "CONF"
+      return false
+    end
+    hash_to_save = Marshal.load(Marshal.dump(self)).to_h # This removes all custom instance variables and types from the data
+    if hash_to_save == @original_hash && !@should_create
+      Rbcli.log.debug "No changes detected in the config. Skipping save.", "CONF"
+    else
+      Rbcli.log.debug "Changes detected in the config. Saving updated config.", "CONF"
+      @storage.save(hash_to_save.deep_stringify!)
+      @original_hash = hash_to_save.deep_symbolize!
+      @should_create = false
+    end
+    self
+  end
+
+  def annotate!
+    @storage.annotate! @declared_defaults
+  end
+
+  def inspect
+    @declared_defaults.inspect
+  end
+
+  def defaults
+    data = {}
+    traverse = Proc.new do |dataloc, defaultsloc|
+      dataloc.merge!(defaultsloc[:options].map { |k, v| [k, v[:default]] }.to_h)
+      defaultsloc[:groups].keys.each do |k|
+        dataloc[k] = {}
+        traverse.call dataloc[k], defaultsloc[:groups][k]
+      end
+    end
+    traverse.call(data, @declared_defaults)
+    data
+  end
+
+  private
+
+  def make_group path_arr, helptext: nil, nested: nil
+    return true if path_arr.nil? || path_arr.respond_to?(:empty?) && path_arr.empty?
+    path_arr = [path_arr] unless path_arr.is_a?(Array)
+    nested[:groups][path_arr.first.to_sym] ||= { groups: {}, options: {}, helptext: nil }
+    if path_arr.length == 1
+      nested[:groups][path_arr.first.to_sym][:helptext] = helptext
+    else
+      make_group path_arr[1..-1], helptext: helptext, nested: nested[:groups][path_arr.first.to_sym]
+    end
+  end
+
+  def make_default slug, helptext: nil, group_path: nil, default: nil, permitted: nil, nested: nil
+    group_path = [group_path] unless group_path.is_a?(Array)
+    if group_path.empty? || group_path.first.nil?
+      nested[:options][slug.to_sym] = { helptext: helptext, default: default, permitted: permitted }
+    else
+      make_default(slug, helptext: helptext, group_path: group_path[1..-1], default: default, permitted: permitted, nested: nested[:groups][group_path.first.to_sym])
+    end
+  end
+end
+
+require_relative 'config_of_death'

data/lib/rbcli/components/config/config_of_death.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+class Rbcli::ConfigOfDeath < Rbcli::Config
+  (Rbcli::Config.instance_methods - Class.instance_methods).each do |method|
+    self.define_method(method) do |*args|
+      raise Rbcli::ConfigurateError.new "Attempted to access config that was not configured."
+    end
+  end
+end

data/lib/rbcli/components/config/template.rb.erb

@@ -0,0 +1,36 @@
+Rbcli::Configurate.config do
+  <%- if @showdocs -%>
+  ##### Config (Optional) #####
+  # The built-in config will automatically pull in a config file to a hash and vice versa
+  # It can either be used immutably (as user-defined configuration) and/or to store application state
+  #
+  # file location:             <string> or <array>            (Required) Provide either a specific config file location or a hierarchy to search
+  #      type:                 (:yaml|:json|:ini|:toml|:null) (Optional) Select which backend/file format to use. If the file has an associated extension (i.e. '.yaml') then this can be omitted.
+  #      schema_location:      <string>                       (Optional) The file location of a JSON Schema (https://json-schema.org). If provided, the config will automatically be validated. (default: nil)
+  #      save_on_exit:         (true|false)                   (Optional) Save changes to the config file on exit (default: false)
+  #      create_if_not_exists: (true|false)                   (Optional) Create the file using default values if it is not found on the system (default: false)
+  #      suppress_errors:      (true|false)                   (Optional) If set to false, the application will halt on any errors in loading the config. If set to true, defaults will be provided (default: true)
+  <%- end -%>
+  file location: ['./<%= @appname.downcase %>.yaml', '~/.<%= @appname.downcase %>.yaml', '/etc/<%= @appname.downcase %>.yaml'],
+       type: :yaml, schema_location: nil, save_on_exit: false,
+       create_if_not_exists: false, suppress_errors: true
+  <%- if @showdocs -%>
+  ##### Banner (Optional) #####
+  # Define a banner to be placed at the top of the config file.
+  # Note that the banner will only be written to backends that support comments (:yaml, :ini, and :toml).
+  <%- end -%>
+  banner <<~BANNER
+    This text appears at the top of the config file when using a backend that supports comments.
+    Tell the user a bit about what they're doing here.
+  BANNER
+  <%- if @showdocs -%>
+  ## Config Structure & Defaults (Optional)
+  # Set defaults for your config values.
+  #
+  # Defaults set here will be provided to your application if the values are missing in the config.
+  # They will also be used to create new config files when the flag `create_if_not_exists` is set above.
+  # will be written to a config file, along with the helptext and/or short descriptions.
+  <%- end -%>
+  group :group1
+  setting :enable_logins, default: true
+end

data/lib/rbcli/components/core/configurate.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+module Rbcli::Configurate
+  # If a non-existant method is called, we attempt to load the plugin.
+  # If the plugin fails to load we display a message to the developer
+  def self.method_missing(method, *args, &block)
+    filename = File.join(RBCLI_LIBDIR, 'plugins', method.to_s.downcase, 'component.rb')
+    if File.exist? filename
+      require filename
+      self.send method, *args, &block
+    else
+      raise Rbcli::ConfigurateError.new "Invalid Rbcli Configurate plugin called: `#{method}` in file #{File.expand_path caller[0]}"
+    end
+  end
+end
+
+module Rbcli::Configurable
+  def self.included klass
+    # We dynamically add two methods to the module: one that runs other methods dynamially, and one that
+    # displays a reasonable message if a method is missing
+    klass.singleton_class.class_eval do
+      define_method :rbcli_private_running_method do |&block|
+        @self_before_instance_eval = eval 'self', block.binding
+        instance_eval &block
+      end
+
+      define_method :method_missing do |method, *args, &block|
+        raise Rbcli::ConfigurateError.new "Invalid Configurate.#{self.name.split('::')[-1].downcase} method called: `#{method}` in file #{File.expand_path caller[0]}"
+      end
+    end
+
+    # This will dynamically create the configurate block based on the class name.
+    # For example, if the class name is 'Me', then the resulting block is `Configurate.me`
+    name = klass.name.split('::')[-1]
+    Rbcli::Configurate.singleton_class.class_eval do
+      define_method name.downcase.to_sym do |&block|
+        mod = self.const_get name
+        begin
+          mod.rbcli_private_running_method &block
+        rescue Rbcli::ConfigurateError => e
+          Rbcli.log.fatal 'Rbcli Configuration Error: ' + e.message
+          Rbcli::exit 255
+        end
+      end
+    end
+  end
+end
+
+Dir.glob(File.dirname(__FILE__) + '/../**/component.rb', &method(:require))
+
+# module Rbcli
+#   def self.configuration mod, key = nil
+#     begin
+#       d = Rbcli::Configurate.const_get(mod.to_s.capitalize.to_sym).config
+#       (key.nil?) ? d : d[key]
+#     rescue
+#       nil
+#     end
+#   end
+# end

data/lib/rbcli/components/core/engine.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+module Rbcli::Engine
+  @operations = []
+
+  def self.register_operation operation, name: nil, priority: nil
+    if @operations.select { |op| op[:priority] == priority }.count != 0
+      raise Rbcli::Error.new "The Rbcli engine can not have two operations defined with the same priority: #{name}, #{@operations.select { |op| op[:priority] == priority }.join(", ")}"
+    end
+    @operations << { operation: operation, name: name, priority: priority }
+  end
+
+  def self.run!
+    Rbcli.log.debug "The engine has been started", "ENGN"
+    @operations.sort_by { |op| op[:priority] }.each do |op|
+      Rbcli.log.debug "Running operation #{op[:priority]} -- #{op[:name]}", "ENGN"
+      op[:operation].call
+    end
+    Rbcli.log.debug "The engine has been stopped", "ENGN"
+  end
+end
+
+module Rbcli
+  def self.go!
+    Rbcli::Engine.run!
+  end
+end

data/lib/rbcli/components/core/warehouse.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+module Rbcli::Warehouse
+  @data = {}
+
+  def self.set key, value, namespace = :default
+    raise Rbcli::Error.new "Namespace must be a symbol" unless namespace.is_a? Symbol
+    @data[namespace] ||= {}
+    @data[namespace][key] = value
+  end
+
+  def self.get key, namespace = :default
+    key.nil? ? @data.dig(namespace) : @data.dig(namespace, key)
+  end
+end

data/lib/rbcli/components/envvars/component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+module Rbcli::Configurate::Envvars
+  include Rbcli::Configurable
+
+  def self.prefix envvar_prefix
+    raise Rbcli::ConfigurateError.new "Environment variable prefix must be a string" unless envvar_prefix.is_a?(String)
+    env = Rbcli::Config.new location: envvar_prefix.sub(/_+$/, ''), type: :env
+    Rbcli::Warehouse.set(:env, env, :parsedopts)
+    Rbcli::Engine.register_operation Proc.new { Rbcli::Warehouse.get(:env, :parsedopts).load! }, name: :load_envvars, priority: 50
+  end
+
+  def self.envvar envvar, default
+    raise Rbcli::ConfigurateError.new "Environment variables must be a string" unless envvar.is_a?(String)
+    Rbcli::Warehouse.get(:env, :parsedopts).add_default(envvar, default: default)
+  end
+end

data/lib/rbcli/components/envvars/template.rb.erb

@@ -0,0 +1,24 @@
+Rbcli::Configurate.envvars do
+  <%- if @showdocs -%>
+  ##### Environment Variable Parsing (Optional) #####
+  # The envvars module can pull in all environment variables with a given
+  # prefix and organize them into a hash structure based on name.
+  # It will also parse the string values and convert them to the proper type (Integer, Boolean, etc)
+  # Any values set here will be treated as defaults and made available when a variable is missing
+  #
+  # For example, these two environment variables:
+  #   <%= @appname.upcase %>_TERM_HEIGHT=40
+  #   <%= @appname.upcase %>_TERM_WIDTH=120
+  # Would be declared here as:
+  #   prefix '<%= @appname.upcase %>'
+  #   envvar 'TERM_HEIGHT', 40
+  #   envvar 'TERM_WIDTH', 120
+  # And get loaded into the env hash as:
+  #   { term: { height: 40, width: 120 } }
+  #
+  # If the prefix is unset or equal to nil, the environment variables specified here will
+  # be loaded without one.
+  <%- end -%>
+  prefix '<%= @appname.upcase %>'
+  envvar 'DEVELOPMENT', false
+end

data/lib/rbcli/components/hooks/component.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+module Rbcli::Configurate::Hooks
+  include Rbcli::Configurable
+
+  def self.pre_execute & block
+    Rbcli::Warehouse.set(:pre_execute, block, :hooks)
+    Rbcli.log.debug "Registered pre_execute hook", "HOOK"
+    Rbcli::Engine.register_operation(Proc.new do
+      Rbcli::Warehouse.get(:pre_execute, :hooks).call(
+        Rbcli::Warehouse.get(:opts, :parsedopts),
+        Rbcli::Warehouse.get(:params, :parsedopts),
+        Rbcli::Warehouse.get(:args, :parsedopts),
+        Rbcli::Warehouse.get(:config, :parsedopts) || Rbcli::ConfigOfDeath.new,
+        Rbcli::Warehouse.get(:env, :parsedopts) || Rbcli::ConfigOfDeath.new
+      )
+    end, name: :pre_execute_hook, priority: 90)
+  end
+
+  def self.post_execute & block
+    Rbcli::Warehouse.set(:post_execute, block, :hooks)
+    Rbcli.log.debug "Registered post_execute hook", "HOOK"
+    Rbcli::Engine.register_operation(Proc.new do
+      Rbcli::Warehouse.get(:post_execute, :hooks).call(
+        Rbcli::Warehouse.get(:opts, :parsedopts),
+        Rbcli::Warehouse.get(:params, :parsedopts),
+        Rbcli::Warehouse.get(:args, :parsedopts),
+        Rbcli::Warehouse.get(:config, :parsedopts) || Rbcli::ConfigOfDeath.new,
+        Rbcli::Warehouse.get(:env, :parsedopts) || Rbcli::ConfigOfDeath.new
+      )
+    end, name: :post_execute_hook, priority: 110)
+  end
+end

data/lib/rbcli/components/hooks/template.rb.erb

@@ -0,0 +1,20 @@
+Rbcli::Configurate.hooks do
+  <%- if @showdocs -%>
+  ##### Hooks (Optional) #####
+  # These hooks are scheduled on the Rbcli execution engine to run
+  # Pre- and Post- the command specified. They are executed after
+  # everything else has been initialized, so the runtime configuration
+  # values are all made available, as they will appear to the command.
+  #
+  # These are good for parsing and/or doing transformations on the provided
+  # configuration before passing them to the command, and for cleaning
+  # up your environment afterwards.
+  <%- end -%>
+  pre_execute do |opts, params, args, config, env|
+    Rbcli.log.info "I'm about to run a command..."
+  end
+
+  post_execute do |opts, params, args, config, env|
+    Rbcli.log.info "I'm done running the command!"
+  end
+end

data/lib/rbcli/components/logger/component.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+module Rbcli::Configurate::Logger
+  include Rbcli::Configurable
+
+  def self.logger target: :stdout, level: :info, format: :display
+    unless target.is_a?(IO) ||
+      (defined?(StringIO) && target.is_a?(StringIO)) ||
+      (target.is_a?(String) && Dir.exist?(File.dirname(File.expand_path(target)))) ||
+      (target.is_a?(Symbol) && [:stdout, :stderr].include?(target.to_sym))
+      raise Rbcli::ConfigurateError.new "Log Target is invalid. Please use either :stdout, :stderr, or a valid file path where the directory already exists on the system. Target given: #{target}"
+    end
+    unless level.is_a?(Integer) || %i(debug info warn error fatal unknown).include?(level)
+      raise Rbcli::ConfigurateError.new "Log Level must be one of the following: #{%i(debug info warn error fatal unknown)}. Level provided: #{level}"
+    end
+    unless Rbcli::Logger.formats.include?(format)
+      raise Rbcli::ConfigurateError.new "Log format must be one of the following: #{Rbcli::Logger.formats}. Format provided: #{format}"
+    end
+    Rbcli.start_logger(target: target, level: level, format: format)
+    Rbcli.log.debug "Logger initialized with target #{target} at level #{level}", "CORE"
+  end
+
+  def self.format slug, prok
+    raise Rbcli::ConfigurateError.new "The slug for the custom log format must be a string or a symbol." unless slug.is_a?(String) || slug.is_a?(Symbol)
+    raise Rbcli::ConfigurateError.new "A proc must be provided to use a custom log format" unless prok.is_a?(Proc)
+    Rbcli.log.add_format slug, prok
+    Rbcli.log.format slug
+  end
+end