rbcli 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73760c480505d19af6bf3bbf67df643902f079fe2b5c22cc2368111894ce2da5
-  data.tar.gz: 4fbbd0ca18a2cf4b0dc79bb5b2582ddc2730d2d9944147e90cc8255f20aa92c8
+  metadata.gz: bad65e9d8cefa0a82adb9305a68294eeaed6cfefed1d06be9cce6edb5eb2a2eb
+  data.tar.gz: 6add98a08da1c55f18e87e60bb279a31adad0979b31d3b00745b9016ab5870d5
 SHA512:
-  metadata.gz: d1e5a99c761cf3bb6ef81fd8877cfcb16d447a60a595189ecaeb8d41f054a6ea3d836d43a8e1776edc6e919f773f673aa1ec61c92b1829d4bdb4a741a20a87c5
-  data.tar.gz: ead35dca33292b7c2cbd591267fe18807932e6d5f98a2f284b4699743c05aefe852af1d94a3507e41ca65aa36ef9b9bb453572a5eb66198b5d04c120907b3fe7
+  metadata.gz: af5e0383b0bf15283007c3e9e45470b5925037e5d73ae9c6ce4fb329ecf3ef983321e4e23bdcbc761676ce79e1adb48b151364067bbc5130e15adc789ed663ce
+  data.tar.gz: 01e6bba1b239653d59cb8e3b4c7c9e6c9ee33efe28ea50aa11cdafd55bcebdab433dc17082464f65ee38ee1290b2f40f39543272a5604a1f5e93d25f99e01c27

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.2

data/lib/rbcli/components/commands/command.rb

@@ -92,7 +92,7 @@ module Rbcli
     unless command.has_function?
       raise Rbcli::CommandError.new "Command #{command.name} does not have a function. An action, inline script, or external script must be defined."
     end
-    if command.default? && Rbcli::Warehouse.get(:commands).any? { |cmd| cmd.default? }
+    if command.default? && Rbcli::Warehouse.get(:commands).any? { |_k, cmd| cmd.default? }
       raise Rbcli::CommandError.new "Only one command may be assigned as default"
     end
     Rbcli::Warehouse.get(:commands)[name] = command

data/lib/rbcli/components/commands/command.rb.erb

@@ -46,10 +46,14 @@ Rbcli.command "<%= @command_name || 'example' %>" do
     Rbcli.log.unknown "Example Unknown Message", "MYAPP"
     Rbcli.log.info ""
 
+    config.add_default :foo, 'bar'
+    config.create!
+    config.load!
     config[:davey] = 'Davey Jones'.compress
     Rbcli.log.info "Compressed String: " + config[:davey]
     Rbcli.log.info "Decompressed String: " + config[:davey].decompress
     config.save!
+    Rbcli.log.info config
     <%- end -%>
   end
 end

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

@@ -27,7 +27,7 @@ class Rbcli::UserConf::Backend
   end
 
   def self.create filename, type: nil
-    type ||= self.types.map { |slug, check| [slug, check.call(filename)] }.to_h.select { |slug, match| match }.first.first
+    type ||= self.types.map { |slug, check| [slug, check.call(filename)] }.select { |slug, match| match }.first.first
     type = type.to_s.downcase.to_sym
     require_relative "backends/#{type.to_s}"
     @registered_types[type].new(filename, type)
@@ -43,8 +43,8 @@ class Rbcli::UserConf::Backend
   attr_reader :type, :loaded
   alias_method :loaded?, :loaded
 
-  # The defaults: parameter is used on some backends to know which fields to expect and parse
-  def load defaults: nil
+  # The `defaults` parameter is used on some backends which override this method
+  def load _defaults = nil
     begin
       text = File.read(@path)
     rescue Errno::ENOENT => _
@@ -68,6 +68,19 @@ class Rbcli::UserConf::Backend
     end
   end
 
+  def save_raw text
+    Rbcli.log.debug "Saving #{@type} config file at '#{@path}' using raw text", "CONF"
+    begin
+      File.write(@path, text)
+    rescue Errno => err
+      Rbcli.log.error "Could not save config to file at '#{@path}'", "CONF"
+      Rbcli.log.error "Error: #{err.message}", "CONF"
+      false
+    else
+      true
+    end
+  end
+
   def savable?
     File.writable?(File.exist?(@path) ? @path : File.dirname(@path))
   end
@@ -76,17 +89,18 @@ class Rbcli::UserConf::Backend
     File.exist?(@path)
   end
 
-  def annotate! defaults
+  def annotate! banner
+    return true unless self.respond_to?(:inject_banner) || self.private_methods.include?(:inject_banner)
+
     begin
       text = File.read(@path)
     rescue Errno::ENOENT => _
       Rbcli.log.debug "Attempted to annotate #{@type} config file but did not find it at '#{@path}'", "CONF"
       return nil
     end
-    Rbcli.log.debug "Annotating #{@type} config file at '#{@path}'", "CONF"
 
-    text = self.inject_banner(text, defaults[:helptext])
-    File.write(@path, text)
+    Rbcli.log.debug "Annotating #{@type} config file at '#{@path}'", "CONF"
+    text = self.inject_banner(text, banner)
 
     begin
       File.write(@path, text)

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

@@ -14,7 +14,7 @@ class Rbcli::UserConf::Env < Rbcli::UserConf::Backend
     @loaded = false
   end
 
-  def load defaults: nil
+  def load defaults = nil
     vars = ENV.select { |k, v| k.match(/^#{@prefix}_.+/i) && !k.match(/^_/) }
     if @prefix.nil? && !defaults.nil? && !defaults.empty?
       lowercase_default_keys = defaults.keys.map { |k| k.downcase.to_sym }
@@ -25,10 +25,6 @@ class Rbcli::UserConf::Env < Rbcli::UserConf::Backend
     vars.each do |key, value|
       deep_assign(final_vars, key.split('_').map { |k| k.to_sym }, translate_value(value))
     end
-    if @prefix.nil? && !defaults.nil? && !defaults.empty?
-      lowercase_default_keys = defaults.keys.map { |k| k.downcase.to_sym }
-      vars = ENV.select { |k, v| lowercase_default_keys.include?(k.downcase.to_sym) }.map { |k, v| [k.downcase.to_sym, v] }.to_h
-    end
     @loaded = true
     final_vars
   end
@@ -43,6 +39,10 @@ class Rbcli::UserConf::Env < Rbcli::UserConf::Backend
     end
   end
 
+  def save_raw text
+    true
+  end
+
   def parse_defaults defaults
     final_vars = Hash.new
     defaults.each do |key, value|
@@ -60,8 +60,4 @@ class Rbcli::UserConf::Env < Rbcli::UserConf::Backend
   def exist?
     true
   end
-
-  def annotate! _defaults = nil
-    true
-  end
 end

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

@@ -22,8 +22,7 @@ class Rbcli::UserConf::Ini < Rbcli::UserConf::Backend
         key, value = line.split('=').map { |part| part.strip }
         deep_assign(ini, nest + [key], translate_value(value))
       else
-        Rbcli.log.warn "Invalid #{@type} syntax found on line #{i} at '#{@path}'. Offending syntax: #{line}", "CONF"
-        return Hash.new
+        raise Rbcli::ParseError.new "Invalid #{@type} syntax found on line #{i} at '#{@path}'. Offending syntax: #{line}"
       end
     end
     @loaded = true

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

@@ -12,9 +12,7 @@ class Rbcli::UserConf::Json < Rbcli::UserConf::Backend
     begin
       parsed_str = JSON.parse(str)
     rescue JSON::JSONError => e
-      Rbcli.log.warn "Invalid #{@type} syntax found at '#{@path}'", "CONF"
-      Rbcli.log.warn e.message, "CONF"
-      Hash.new
+      raise Rbcli::ParseError.new "Invalid #{@type} syntax found at '#{@path}': #{e.message}"
     else
       @loaded = true
       parsed_str
@@ -28,5 +26,4 @@ class Rbcli::UserConf::Json < Rbcli::UserConf::Backend
   def inject_banner text, _banner
     text
   end
-
 end

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

@@ -9,7 +9,7 @@ class Rbcli::UserConf::Null < Rbcli::UserConf::Backend
     @loaded = false
   end
 
-  def load defaults: nil
+  def load _defaults = nil
     @loaded = true
     {}
   end
@@ -18,15 +18,15 @@ class Rbcli::UserConf::Null < Rbcli::UserConf::Backend
     hash
   end
 
-  def savable?
+  def save_raw text
     true
   end
 
-  def exist?
-    true
+  def savable?
+    false
   end
 
-  def annotate! _defaults = nil
+  def exist?
     true
   end
 end

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

@@ -10,12 +10,9 @@ class Rbcli::UserConf::Toml < Rbcli::UserConf::Backend
 
   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
+      raise Rbcli::ParseError.new "Invalid #{@type} syntax found at '#{@path}': #{e.message}"
     else
       @loaded = true
       parsed_str

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

@@ -12,9 +12,7 @@ class Rbcli::UserConf::Yaml < Rbcli::UserConf::Backend
     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
+      raise Rbcli::ParseError.new "Invalid #{@type} syntax found at '#{@path}': #{e.message}"
     else
       @loaded = true
       parsed_str

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

@@ -6,28 +6,63 @@
 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
+  @params = {}
+  @on_declare = Proc.new do
+    Rbcli::Engine.register_operation Proc.new {
+      config = Rbcli::Config.new(**@params)
+      Rbcli::Warehouse.set(:config, config, :parsedopts)
+      Rbcli::Warehouse.get(:config, :parsedopts).load!; Rbcli::Warehouse.get(:config, :parsedopts).validate!
+    }, name: :load_config, priority: 40
+  end
+
+  def self.file location
     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)
+    @params[:location] = location
+  end
+
+  def self.type type
     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
+    @params[:type] = type
+  end
+
+  def self.schema_file path
+    raise Rbcli::ConfigurateError.new "Config schema file location must be a path" unless path.nil? || path.is_a?(String)
+    raise Rbcli::ConfigurateError.new "May not define both a schema_hash and schema_file together." if @params[:schema_hash] && !path.nil?
+    @params[:schema_file] = path
+  end
+
+  def self.schema_hash hash
+    raise Rbcli::ConfigurateError.new "Config schema hash must be a hash" unless hash.nil? || hash.is_a?(Hash)
+    raise Rbcli::ConfigurateError.new "May not define both a schema_hash and schema_file together." if @params[:schema_file] && !hash.nil?
+    @params[:schema_hash] = hash
+  end
+
+  def self.save_on_exit soe
+    Rbcli::Engine.register_operation Proc.new { Rbcli::Warehouse.get(:config, :parsedopts).save! }, name: :save_config, priority: 160 if soe
+  end
+
+  def self.create_if_not_exists cne
+    raise Rbcli::ConfigurateError.new "Config 'create_if_not_exists' must be true or false" unless cne.is_a?(TrueClass) || cne.is_a?(FalseClass)
+    @params[:create_if_not_exists] = cne
+  end
+
+  def self.suppress_errors suppress
+    raise Rbcli::ConfigurateError.new "Config 'suppress_errors' must be true or false" unless suppress.is_a?(TrueClass) || suppress.is_a?(FalseClass)
+    @params[:suppress_errors] = suppress
   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
+    @params[: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)
+  def self.defaults hash
+    raise Rbcli::ConfigurateError.new "The default configuration must be a hash." unless hash.is_a?(Hash)
+    @params[:defaults] = hash
   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)
+  def self.skeleton text
+    raise Rbcli::ConfigurateError.new "The skeleton data must be set to a string." unless text.is_a?(String)
+    @params[:skeleton] = text
   end
 end

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

@@ -8,93 +8,85 @@ 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
+  def initialize location: nil, type: nil, schema_file: nil, schema_hash: nil, create_if_not_exists: false, suppress_errors: false, banner: nil, defaults: {}, skeleton: nil
     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)
+    locations = location.map { |path| [path, Rbcli::UserConf::Backend.create(path, type: type)] }.reject { |path, storage| !(path.nil? || path == :null) && storage.type == 'NULL' }
+    existing_location = locations.select { |_path, storage| storage.exist? }.first
+    savable_location = locations.select { |_path, storage| storage.savable? }.first
+    if !existing_location.nil?
+      @location, @storage = existing_location
+      Rbcli.log.debug @location.nil? ? "Instantiated null config; data will not be stored" : "Found config of type '#{@storage.type}' at '#{@location}'", "CONF"
+    elsif !savable_location.nil? && create_if_not_exists
+      @location, @storage = savable_location
+      @should_create = true
+      Rbcli.log.debug "Ready to create new config of type '#{@storage.type}' at '#{@location}'", "CONF"
     elsif suppress_errors
+      @location, @storage = :null, Rbcli::UserConf::Backend.create(:null)
       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)
+    @original_hash = {}
+    @defaults = defaults
+    @skeleton = skeleton
+    @banner = banner
+    if schema_hash
+      @schema = self.class.new
+      schema_hash.each_key { |key| @schema[key] = schema_hash[key] }
+      @schema.is_schema = true
+    elsif schema_file
+      @schema = self.class.new(location: schema_file)
       @schema.is_schema = true
+    else
+      @schema = nil
     end
   end
 
-  attr_accessor :is_schema, :type
+  attr_accessor :is_schema, :defaults
+  attr_reader :location, :schema, :skeleton, :banner, :suppress_errors
 
-  def set_banner text
-    @declared_defaults[:helptext] = text
+  def add_default slug, default = nil
+    @defaults[slug] = default
   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
+  def type
+    @storage.type.downcase.to_sym
   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
+      return self.create!(force: true)
+    end
+    Rbcli.log.debug "Loading #{@is_schema ? 'schema' : 'config'} file", "CONF"
+    begin
+      @original_hash = @storage.load(@defaults)
+    rescue Rbcli::ParseError => e
+      Rbcli.log.add (@suppress_errors ? :debug : :fatal), e.message, "CONF"
+      Rbcli.exit 3 unless @suppress_errors
+      @original_hash = {}
+    end
+    unless @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 @defaults.empty?
     end
+    self.clear
+    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
 
   def validate!
     return true if @schema.nil?
     Rbcli.log.debug "Validating config against schema", "CONF"
-    @schema.load!
+    @schema.load! unless @schema.location.nil?
     begin
       JSON::Validator.validate!(@schema, self)
-    rescue JSON::Schema::ValidationError => e
+    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
+      Rbcli::exit 4 unless @suppress_errors
       return false
     end
     Rbcli.log.debug "Validated config against schema successfully", "CONF"
@@ -118,47 +110,24 @@ class Rbcli::Config < Hash
     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
+  def create! path: nil, force: false
+    return false unless @location.is_a?(String)
+    if File.exist?(path || @location) && !force
+      Rbcli.log.add (@suppress_errors ? :debug : :error), "Config file already exists; can not overwrite.", "CONF"
+      Rbcli::exit 4 unless @suppress_errors
+      return false
     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
+    if @skeleton
+      (path.nil? ? @storage : Rbcli::UserConf::Backend.create(path, type: self.type)).save_raw @skeleton
     else
-      make_group path_arr[1..-1], helptext: helptext, nested: nested[:groups][path_arr.first.to_sym]
+      self.deep_merge!(@storage.respond_to?(:parse_defaults) ? @storage.parse_defaults(@defaults) : @defaults)
+      self.save!
     end
+    @storage.annotate!(@banner) if @banner
   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
+  def annotate!
+    @storage.annotate! @banner
   end
 end
 

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

@@ -4,33 +4,30 @@ Rbcli::Configurate.config do
   # 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).
+  #   file:                 <string> or <array>            (Required) Provide either a specific config file location or a hierarchy to search. If creating a :null type of config this can be omitted.
+  #   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_file:          <string>                       (Optional) The file location of a JSON Schema (https://json-schema.org). If provided, the config will automatically be validated. (default: nil)
+  #   schema_hash:          <string>                       (Optional) If you'd like to provide a JSON schema hash directly instead, do it here. May not use `schema_hash` and `schema_file` together. (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)
+  #   banner:               <string>                       (Optional) Define a banner to be placed at the top of the config file on disk. Note that it will only be written to backends that support comments
+  #   defaults:             <hash>                         (Optional) Defaults set here will be provided to your application if any 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 to true.
+  #   skeleton:             <string>                       (Optional) If a skeleton is provided, it will be used as the data source when creating new config files on disk instead of the defaults. (default: nil)`
+  #                                                                     Please provide the text exactly as you want the user to see it in the config file (plus the banner if provided).
   <%- end -%>
+  file ['./<%= @appname.downcase %>.yaml', '~/.<%= @appname.downcase %>.yaml', '/etc/<%= @appname.downcase %>.yaml']
+  type :yaml
+  schema_file nil
+  schema_hash nil
+  save_on_exit false
+  create_if_not_exists false
+  suppress_errors true
   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
+  defaults({ setting_one: true, setting_two: false })
+  skeleton "eJzT1dXlSsvPt1JISiziAhFWSYlVAD1hBjs=".decompress
 end

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

@@ -32,12 +32,15 @@ module Rbcli::Configurable
       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
+        on_declare = mod.instance_variable_get('@on_declare')
+        on_declare.call if on_declare.is_a?(Proc)
         begin
           mod.rbcli_private_running_method &block
         rescue Rbcli::ConfigurateError => e

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

@@ -15,6 +15,6 @@ module Rbcli::Configurate::Envvars
 
   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)
+    Rbcli::Warehouse.get(:env, :parsedopts).add_default(envvar, default)
   end
 end

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

@@ -13,6 +13,7 @@ module Rbcli::Configurate::Cli
       author: nil,
       email: nil,
       copyright_year: nil,
+      compatibility: nil,
       license: nil,
       helptext: nil
     }

data/lib/rbcli/components/parser/parser.rb

@@ -23,6 +23,14 @@ module Rbcli::Parser
       bannerstr += " <#{appinfo[:email]}>" unless appinfo[:author].nil? || appinfo[:email].nil?
       bannerstr += "\n"
     end
+    unless appinfo[:compatibility].nil? || appinfo[:compatibility].empty?
+      bannerstr += "Compatiblity: "
+      if appinfo[:compatibility].length == 2
+        bannerstr += appinfo[:compatibility].join(' and ') + "\n"
+      else
+        bannerstr += appinfo[:compatibility][0..-2].join(', ') + ', and ' + appinfo[:compatibility][-1] + "\n"
+      end
+    end
     bannerstr += "License: #{appinfo[:license]}\n" unless appinfo[:license].nil?
     bannerstr += "\n"
     bannerstr += appinfo[:helptext].chomp + "\n\n" unless appinfo[:helptext].nil?

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

@@ -6,6 +6,7 @@ Rbcli::Configurate.cli do
   # email            (Optional) - An email for users to contact
   # version          (Optional) - major.minor.patch notation, required if using update checks
   # copyright_year   (Optional) - Self explanatory
+  # compatibility    (Optional) - Array of Operating Systems, devices, or other targets (For example: %w[MacOS Linux Ubuntu Windows Raspberry\ Pi]
   # license          (Optional) - Convention is to use an identifier from here: https://spdx.org/licenses/
   # helptext         (Optional) - Text that gets shown with --help or -h
   <%- end -%>
@@ -14,6 +15,7 @@ Rbcli::Configurate.cli do
   email nil
   version <%= @appname.capitalize %>::VERSION
   copyright_year <%= Time.now.year %>
+  compatibility nil
   license nil
   helptext "This text shows up in `<%= @appname.downcase %> --help`"
   <%- if @showdocs -%>

data/lib/rbcli/util/errors.rb

@@ -9,4 +9,6 @@ module Rbcli
   class ConfigurateError < Rbcli::Error; end
 
   class CommandError < Rbcli::Error; end
+
+  class ParseError < Rbcli::Error; end
 end

data/lib/rbcli/util/hash_deep_symbolize.rb

@@ -8,6 +8,18 @@
 # Functions to convert hash keys to all symbols or all strings
 ##
 class Hash
+  def deep_symbolize hsh = nil
+    hsh ||= Marshal.load(Marshal.dump(self))
+    hsh.keys.each do |k|
+      if k.is_a? String
+        hsh[k.to_sym] = hsh[k]
+        hsh.delete k
+      end
+      deep_symbolize! hsh[k.to_sym] if hsh[k.to_sym].is_a? Hash
+    end
+    hsh
+  end
+
   def deep_symbolize! hsh = nil
     hsh ||= self
     hsh.keys.each do |k|
@@ -20,6 +32,18 @@ class Hash
     hsh
   end
 
+  def deep_stringify hsh = nil
+    hsh ||= Marshal.load(Marshal.dump(self))
+    hsh.keys.each do |k|
+      if k.is_a? Symbol
+        hsh[k.to_s] = hsh[k]
+        hsh.delete k
+      end
+      deep_stringify! hsh[k.to_s] if hsh[k.to_s].is_a? Hash
+    end
+    hsh
+  end
+
   def deep_stringify! hsh = nil
     hsh ||= self
     hsh.keys.each do |k|

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rbcli
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Andrew Khoury
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2025-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -259,12 +258,10 @@ homepage: https://akhoury6.github.io/rbcli/
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
   homepage_uri: https://akhoury6.github.io/rbcli/
   documentation_uri: https://akhoury6.github.io/rbcli/
   source_code_uri: https://github.com/akhoury6/rbcli
   changelog_uri: https://github.com/akhoury6/rbcli/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -279,8 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A CLI Application/Tooling Framework for Ruby
 test_files: []