qonfig 0.21.0 → 0.25.0

data/lib/qonfig/commands/definition/expose_json.rb

@@ -18,7 +18,7 @@ class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
   # @since 0.14.0
   EMPTY_JSON_DATA = {}.freeze
 
-  # @return [String]
+  # @return [String, Pathname]
   #
   # @api private
   # @since 0.14.0
@@ -42,7 +42,7 @@ class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
   # @since 0.14.0
   attr_reader :env
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [String, Symbol]

data/lib/qonfig/commands/definition/expose_yaml.rb

@@ -18,7 +18,7 @@ class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
   # @since 0.7.0
   EMPTY_YAML_DATA = {}.freeze
 
-  # @return [String]
+  # @return [String, Pathname]
   #
   # @api private
   # @since 0.7.0
@@ -42,7 +42,7 @@ class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
   # @since 0.7.0
   attr_reader :env
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [String, Symbol]

data/lib/qonfig/commands/definition/load_from_json.rb

@@ -6,7 +6,7 @@ class Qonfig::Commands::Definition::LoadFromJSON < Qonfig::Commands::Base
   # @since 0.19.0
   self.inheritable = true
 
-  # @return [String]
+  # @return [String, Pathname]
   #
   # @api private
   # @since 0.5.0
@@ -18,7 +18,7 @@ class Qonfig::Commands::Definition::LoadFromJSON < Qonfig::Commands::Base
   # @sicne 0.5.0
   attr_reader :strict
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   #
   # @api private

data/lib/qonfig/commands/definition/load_from_yaml.rb

@@ -6,7 +6,7 @@ class Qonfig::Commands::Definition::LoadFromYAML < Qonfig::Commands::Base
   # @since 0.19.0
   self.inheritable = true
 
-  # @return [String]
+  # @return [String, Pathname]
   #
   # @api private
   # @since 0.2.0
@@ -18,7 +18,7 @@ class Qonfig::Commands::Definition::LoadFromYAML < Qonfig::Commands::Base
   # @since 0.2.0
   attr_reader :strict
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   #
   # @api private

data/lib/qonfig/commands/instantiation/values_file.rb

@@ -30,10 +30,11 @@ class Qonfig::Commands::Instantiation::ValuesFile < Qonfig::Commands::Base
   # @since 0.17.0
   DEFAULT_FORMAT = :dynamic
 
-  # @return [String, Symbol]
+  # @return [String, Symbol, Pathname]
   #
   # @api private
   # @since 0.17.0
+  # @version 0.22.0
   attr_reader :file_path
 
   # @return [String]
@@ -60,7 +61,7 @@ class Qonfig::Commands::Instantiation::ValuesFile < Qonfig::Commands::Base
   # @since 0.17.0
   attr_reader :expose
 
-  # @param file_path [String, Symbol]
+  # @param file_path [String, Symbol, Pathname]
   # @param caller_location [String]
   # @option format [String, Symbol]
   # @option strict [Boolean]
@@ -69,6 +70,7 @@ class Qonfig::Commands::Instantiation::ValuesFile < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.17.0
+  # @version 0.22.0
   def initialize(
     file_path,
     caller_location,
@@ -140,7 +142,7 @@ class Qonfig::Commands::Instantiation::ValuesFile < Qonfig::Commands::Base
     raise(error) if strict
   end
 
-  # @param file_path [String, Symbol]
+  # @param file_path [String, Symbol, Pathname]
   # @param format [String, Symbol]
   # @param strict [Boolean]
   # @param expose [NilClass, String, Symbol]
@@ -151,8 +153,14 @@ class Qonfig::Commands::Instantiation::ValuesFile < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.17.0
+  # @version 0.22.0
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
   def prevent_incompatible_attributes!(file_path, format, strict, expose)
-    unless file_path.is_a?(String) || file_path == SELF_LOCATED_FILE_DEFINITION
+    unless (
+      file_path.is_a?(String) ||
+      file_path.is_a?(Pathname) ||
+      file_path == SELF_LOCATED_FILE_DEFINITION
+    )
       raise Qonfig::ArgumentError, 'Incorrect file path'
     end
 
@@ -171,4 +179,5 @@ class Qonfig::Commands::Instantiation::ValuesFile < Qonfig::Commands::Base
       raise Qonfig::ArgumentError, ':strict should be a type of boolean'
     end
   end
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 end

data/lib/qonfig/data_set.rb

@@ -97,7 +97,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     end
   end
 
-  # @param file_path [String, Symbol]
+  # @param file_path [String, Symbol, Pathname]
   # @option format [String, Symbol]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol] Environment key
@@ -108,7 +108,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   #
   # @api public
   # @since 0.17.0
-  # @version 0.21.0
+  # @version 0.22.0
   def load_from_file(file_path, format: :dynamic, strict: true, expose: nil, &configurations)
     thread_safe_access do
       load_setting_values_from_file(
@@ -117,7 +117,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     end
   end
 
-  # @param file_path [String]
+  # @param file_path [String, Symbol, Pathname]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol] Environment key
   # @param configurations [Block]
@@ -127,12 +127,12 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   #
   # @api public
   # @since 0.17.0
-  # @version 0.21.0
+  # @version 0.22.0
   def load_from_yaml(file_path, strict: true, expose: nil, &configurations)
     load_from_file(file_path, format: :yml, strict: strict, expose: expose, &configurations)
   end
 
-  # @param file_path [String]
+  # @param file_path [String, Symbol, Pathname]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol] Environment key
   # @param configurations [Block]
@@ -142,7 +142,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   #
   # @api public
   # @since 0.17.0
-  # @version 0.21.0
+  # @version 0.22.0
   def load_from_json(file_path, strict: true, expose: nil, &configurations)
     load_from_file(file_path, format: :json, strict: strict, expose: expose, &configurations)
   end
@@ -184,6 +184,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     end
   end
 
+  # @option dot_style [Boolean]
   # @option key_transformer [Proc]
   # @option value_transformer [Proc]
   # @return [Hash]
@@ -191,11 +192,13 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   # @api public
   # @since 0.1.0
   def to_h(
+    dot_style: Qonfig::Settings::REPRESENT_HASH_IN_DOT_STYLE,
     key_transformer: Qonfig::Settings::BASIC_SETTING_KEY_TRANSFORMER,
     value_transformer: Qonfig::Settings::BASIC_SETTING_VALUE_TRANSFORMER
   )
     thread_safe_access do
       settings.__to_hash__(
+        dot_notation: dot_style,
         transform_key: key_transformer,
         transform_value: value_transformer
       )
@@ -203,7 +206,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   end
   alias_method :to_hash, :to_h
 
-  # @option path [String]
+  # @option path [String, Pathname]
   # @option options [Hash<Symbol|String,Any>] Native (ruby-stdlib) ::JSON#generate attributes
   # @param value_processor [Block]
   # @return [void]
@@ -217,7 +220,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   end
   alias_method :dump_to_json, :save_to_json
 
-  # @option path [String]
+  # @option path [String, Pathname]
   # @option symbolize_keys [Boolean]
   # @option options [Hash<Symbol|String,Any>] Native (ruby-stdlib) ::YAML#dump attributes
   # @param value_processor [Block]
@@ -513,7 +516,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     apply_settings(settings_map, &configurations)
   end
 
-  # @param file_path [String, Symbol]
+  # @param file_path [String, Symbol, Pathname]
   # @option format [String, Symbol]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol]
@@ -525,6 +528,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   #
   # @api private
   # @since 0.17.0
+  # @version 0.22.0
   def load_setting_values_from_file(
     file_path,
     format: :dynamic,

data/lib/qonfig/dsl.rb

@@ -15,7 +15,7 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
     # @api private
     # @since 0.1.0
     # @version 0.20.0
-    # rubocop:disable Metrics/LineLength, Metrics/AbcSize
+    # rubocop:disable Layout/LineLength, Metrics/AbcSize
     def extended(child_klass)
       child_klass.instance_variable_set(:@definition_commands, Qonfig::CommandSet.new)
       child_klass.instance_variable_set(:@instance_commands, Qonfig::CommandSet.new)
@@ -33,7 +33,7 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
         end
       end)
     end
-    # rubocop:enable Metrics/LineLength, Metrics/AbcSize
+    # rubocop:enable Layout/LineLength, Metrics/AbcSize
   end
 
   # @return [Qonfig::CommandSet]
@@ -154,7 +154,7 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
     definition_commands << Qonfig::Commands::Definition::Compose.new(data_set_klass)
   end
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @return [void]
   #
@@ -200,7 +200,7 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
     )
   end
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @return [void]
   #
@@ -212,7 +212,7 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
     definition_commands << Qonfig::Commands::Definition::LoadFromJSON.new(file_path, strict: strict)
   end
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [Symbol, String]
@@ -228,7 +228,7 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
     )
   end
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [Symbol, String]
@@ -261,7 +261,7 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
     )
   end
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option format [String, Symbol]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol] Environment key

data/lib/qonfig/plugins.rb

@@ -8,6 +8,7 @@ module Qonfig::Plugins
   require_relative 'plugins/abstract'
   require_relative 'plugins/toml'
   require_relative 'plugins/pretty_print'
+  require_relative 'plugins/vault'
 
   # @since 0.4.0
   @plugin_registry = Registry.new

data/lib/qonfig/plugins/pretty_print.rb

@@ -8,8 +8,15 @@ class Qonfig::Plugins::PrettyPrint < Qonfig::Plugins::Abstract
     #
     # @api private
     # @since 0.19.0
-    # @version 0.21.0
+    # @version 0.24.0
     def install!
+      # :nocov:
+      if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
+        require_relative 'pretty_print/ruby_2_7_basic_object_pp_patch'
+      end
+      # :nocov:
+
+      require_relative 'pretty_print/requirements'
       require_relative 'pretty_print/mixin'
       require_relative 'pretty_print/data_set'
       require_relative 'pretty_print/settings'

data/lib/qonfig/plugins/pretty_print/requirements.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'pp'

data/lib/qonfig/plugins/pretty_print/ruby_2_7_basic_object_pp_patch.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# NOTE: why not `.prepend` ?
+#  `prepend` in this case works incorrectly and sometimes this patch can not be correctly
+#  injected to the original module and it's children ancestors (Ruby-specific behaviour of
+#  module including and prepending).
+
+# @api public
+# @since 0.24.0
+module PP::PPMethods
+  # :nocov:
+  def pp(obj)
+    # If obj is a Delegator then use the object being delegated to for cycle
+    # detection
+
+    # NOTE: --- PATCH ---
+    if defined?(::Delegator) and (
+      begin
+        (class << obj; self; end) <= ::Delegator # patch
+      rescue ::TypeError
+        obj.is_a?(::Delegator)
+      end
+    )
+      obj = obj.__getobj__
+    end # instead of: obj = obj.__getobj__ if defined?(::Delegator) and obj.is_a?(::Delegator)
+    # NOTE:
+    #  Old implementation can not be used with BasicObject instances
+    #  (with Qonfig::Compacted in our case)
+    # NOTE: --- PATCH ---
+
+    if check_inspect_key(obj)
+      group { obj.pretty_print_cycle self }
+      return
+    end
+
+    begin
+      push_inspect_key(obj)
+      group { obj.pretty_print self }
+    ensure
+      pop_inspect_key(obj) unless PP.sharing_detection
+    end
+  end
+  # :nocov:
+end

data/lib/qonfig/plugins/toml/commands/definition/expose_toml.rb

@@ -19,7 +19,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
   # @since 0.12.0
   EMPTY_TOML_DATA = {}.freeze
 
-  # @return [String]
+  # @return [String, Pathname]
   #
   # @api private
   # @since 0.12.0
@@ -101,7 +101,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
     realfile = dirname.join(envfile).to_s
 
     toml_data = load_toml_data(realfile)
-    toml_based_settings = builde_data_set_klass(toml_data).new.settings
+    toml_based_settings = build_data_set_klass(toml_data).new.settings
 
     settings.__append_settings__(toml_based_settings)
   end
@@ -125,7 +125,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
       "#{file_path} file does not contain settings with <#{env}> environment key!"
     ) unless toml_data_slice
 
-    toml_based_settings = builde_data_set_klass(toml_data_slice).new.settings
+    toml_based_settings = build_data_set_klass(toml_data_slice).new.settings
 
     settings.__append_settings__(toml_based_settings)
   end
@@ -145,7 +145,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.12.0
-  def builde_data_set_klass(toml_data)
+  def build_data_set_klass(toml_data)
     Qonfig::DataSet::ClassBuilder.build_from_hash(toml_data)
   end
 end

data/lib/qonfig/plugins/toml/commands/definition/load_from_toml.rb

@@ -7,7 +7,7 @@ class Qonfig::Commands::Definition::LoadFromTOML < Qonfig::Commands::Base
   # @since 0.20.0
   self.inheritable = true
 
-  # @return [String]
+  # @return [String, Pathname]
   #
   # @api private
   # @since 0.12.0

data/lib/qonfig/plugins/toml/data_set.rb

@@ -3,7 +3,7 @@
 # @api public
 # @since 0.12.0
 class Qonfig::DataSet
-  # @option path [String]
+  # @option path [String, Pathname]
   # @option options [Hash<Symbol,Any>] Nothing, just for compatability and consistency
   # @param value_processor [Block]
   # @return [void]
@@ -17,7 +17,7 @@ class Qonfig::DataSet
   end
   alias_method :dump_to_toml, :save_to_toml
 
-  # @param file_path [String]
+  # @param file_path [String, Pathmame]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol] Environment key
   # @param configuration [Block]

data/lib/qonfig/plugins/toml/dsl.rb

@@ -3,7 +3,7 @@
 # @api private
 # @since 0.12.0
 module Qonfig::DSL
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @return [void]
   #
@@ -18,7 +18,7 @@ module Qonfig::DSL
     )
   end
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [Symbol, String]