rbcli 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73760c480505d19af6bf3bbf67df643902f079fe2b5c22cc2368111894ce2da5
-  data.tar.gz: 4fbbd0ca18a2cf4b0dc79bb5b2582ddc2730d2d9944147e90cc8255f20aa92c8
+  metadata.gz: 748853fe49a1c814fa91a3afd45908e307640d9d3ff105cb5577a97ae6483b99
+  data.tar.gz: 9f5e6526fd0a900b768d1589b791e8b87913976d291124bac0cd3be6ea3297b2
 SHA512:
-  metadata.gz: d1e5a99c761cf3bb6ef81fd8877cfcb16d447a60a595189ecaeb8d41f054a6ea3d836d43a8e1776edc6e919f773f673aa1ec61c92b1829d4bdb4a741a20a87c5
-  data.tar.gz: ead35dca33292b7c2cbd591267fe18807932e6d5f98a2f284b4699743c05aefe852af1d94a3507e41ca65aa36ef9b9bb453572a5eb66198b5d04c120907b3fe7
+  metadata.gz: 3428edc78581a3cc2230c6af2a0b6ddf5d9e1d9b8ef0933c38db0bb14b3adf5e95d61ec6a7c8fb896ef4af2403c8c64f189a05b212c9cdc428b2b989f28b9f69
+  data.tar.gz: 87bff9a24cfcf862335be93bfb09590b3b305c446166fe235c777928323431ef8c1b3649d9cd83f4e45e8260f41312f8b094af55f686b6c72a3dd0eec226d311

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

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

@@ -27,9 +27,10 @@ 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}"
+    Rbcli.log.debug "Creating backend of type #{type} at #{filename}", "CONF"
     @registered_types[type].new(filename, type)
   end
 
@@ -43,7 +44,7 @@ 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
+  # The `defaults` parameter is used on some backends which override this method
   def load defaults: nil
     begin
       text = File.read(@path)
@@ -76,17 +77,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

@@ -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/json.rb

@@ -28,5 +28,4 @@ class Rbcli::UserConf::Json < Rbcli::UserConf::Backend
   def inject_banner text, _banner
     text
   end
-
 end

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

@@ -19,14 +19,10 @@ class Rbcli::UserConf::Null < Rbcli::UserConf::Backend
   end
 
   def savable?
-    true
+    false
   end
 
   def exist?
     true
   end
-
-  def annotate! _defaults = nil
-    true
-  end
 end

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

@@ -10,7 +10,6 @@ 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"

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

@@ -21,13 +21,8 @@ module Rbcli::Configurate::Config
     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)
+  def self.defaults hash
+    raise Rbcli::ConfigurateError.new "The default configuration must be a hash." unless hash.is_a?(Hash)
+    Rbcli::Warehouse.get(:config, :parsedopts).defaults = hash
   end
 end

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

@@ -10,76 +10,60 @@ 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)
+    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
+    @original_hash = {}
+    @defaults = {}
     if schema_location
       @schema = self.class.new(location: schema_location)
       @schema.is_schema = true
     end
   end
 
-  attr_accessor :is_schema, :type
+  attr_accessor :is_schema, :defaults
 
   def set_banner text
-    @declared_defaults[:helptext] = text
+    @banner = text
   end
 
-  def add_group path_arr, helptext: nil
-    make_group path_arr, helptext: helptext, nested: @declared_defaults
+  def add_default slug, default: nil
+    @defaults[slug] = default
   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.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)
+      @original_hash = @storage.load(defaults: @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?
+        Rbcli.log.add (@suppress_errors ? :debug : :warn), "Using defaults", "CONF" unless @defaults.empty?
         return false
       else
-        self.deep_merge!(@storage.respond_to?(:parse_defaults) ? @storage.parse_defaults(defaults) : defaults)
+        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
@@ -119,46 +103,7 @@ class Rbcli::Config < Hash
   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
+    @storage.annotate! @banner
   end
 end
 

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

@@ -24,13 +24,11 @@ Rbcli::Configurate.config do
     Tell the user a bit about what they're doing here.
   BANNER
   <%- if @showdocs -%>
-  ## Config Structure & Defaults (Optional)
+  ##### 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.
+  # They will also be used to create new config files when the flag `create_if_not_exists` is set to true.
   <%- end -%>
-  group :group1
-  setting :enable_logins, default: true
+  defaults({ setting_one: true, setting_two: false })
 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,7 @@ module Rbcli::Parser
       bannerstr += " <#{appinfo[:email]}>" unless appinfo[:author].nil? || appinfo[:email].nil?
       bannerstr += "\n"
     end
+    bannerstr += "Compatiblity: " + appinfo[:compatibility].join(', ').reverse.sub(' ,', ' dna ,').reverse + "\n" unless appinfo[:compatibility].nil? || appinfo[:compatibility].empty?
     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

@@ -14,6 +14,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/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,14 @@
 --- !ruby/object:Gem::Specification
 name: rbcli
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Andrew Khoury
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -259,7 +259,6 @@ 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
@@ -279,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: A CLI Application/Tooling Framework for Ruby