qonfig 0.16.0 → 0.17.0

data/gemfiles/with_external_deps.gemfile

@@ -2,7 +2,7 @@
 
 source 'https://rubygems.org'
 
-# @since 0.12.0 (qonfig: :toml plugin)
-gem 'toml-rb', '>= 1'
+# @since 0.17.0 (qonfig: :toml plugin)
+gem 'toml-rb', '>= 2'
 
 gemspec path: '..'

data/lib/qonfig/commands/{add_nested_option.rb → definition/add_nested_option.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-class Qonfig::Commands::AddNestedOption < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::AddNestedOption < Qonfig::Commands::Base
   # @return [Symbol, String]
   #
   # @api private

data/lib/qonfig/commands/{add_option.rb → definition/add_option.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-class Qonfig::Commands::AddOption < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::AddOption < Qonfig::Commands::Base
   # @return [Symbol, String]
   #
   # @api private

data/lib/qonfig/commands/{compose.rb → definition/compose.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-class Qonfig::Commands::Compose < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::Compose < Qonfig::Commands::Base
   # @return [Qonfig::DataSet]
   #
   # @api private

data/lib/qonfig/commands/{expose_json.rb → definition/expose_json.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.14.0
-class Qonfig::Commands::ExposeJSON < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
   # @return [Hash]
   #
   # @api private

data/lib/qonfig/commands/{expose_self.rb → definition/expose_self.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.14.0
-class Qonfig::Commands::ExposeSelf < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::ExposeSelf < Qonfig::Commands::Base
   # @return [String, Symbol]
   #
   # @api private

data/lib/qonfig/commands/{expose_yaml.rb → definition/expose_yaml.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.7.0
-class Qonfig::Commands::ExposeYAML < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
   # @return [Hash]
   #
   # @api private

data/lib/qonfig/commands/definition/load_from_env/value_converter.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module Qonfig::Commands::Definition::LoadFromENV::ValueConverter
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  INTEGER_PATTERN = /\A\d+\z/.freeze
+
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  FLOAT_PATTERN = /\A\d+\.\d+\z/.freeze
+
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  TRUE_PATTERN = /\A(t|true)\z/i.freeze
+
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  FALSE_PATTERN = /\A(f|false)\z/i.freeze
+
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  ARRAY_PATTERN = /\A[^'"].*\s*,\s*.*[^'"]\z/.freeze
+
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  QUOTED_STRING_PATTERN = /\A['"].*['"]\z/.freeze
+
+  class << self
+    # @param env_data [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.2.0
+    def convert_values!(env_data)
+      env_data.each_pair do |key, value|
+        env_data[key] = convert_value(value)
+      end
+    end
+
+    private
+
+    # @param value [Object]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def convert_value(value)
+      return value unless value.is_a?(String)
+
+      case value
+      when INTEGER_PATTERN
+        Integer(value)
+      when FLOAT_PATTERN
+        Float(value)
+      when TRUE_PATTERN
+        true
+      when FALSE_PATTERN
+        false
+      when ARRAY_PATTERN
+        value.split(/\s*,\s*/).map(&method(:convert_value))
+      when QUOTED_STRING_PATTERN
+        value.gsub(/(\A['"]|['"]\z)/, '')
+      else
+        value
+      end
+    end
+  end
+end

data/lib/qonfig/commands/{load_from_env.rb → definition/load_from_env.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.2.0
-class Qonfig::Commands::LoadFromENV < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::LoadFromENV < Qonfig::Commands::Base
   require_relative 'load_from_env/value_converter'
 
   # @return [Boolean]

data/lib/qonfig/commands/{load_from_json.rb → definition/load_from_json.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.5.0
-class Qonfig::Commands::LoadFromJSON < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::LoadFromJSON < Qonfig::Commands::Base
   # @return [String]
   #
   # @api private

data/lib/qonfig/commands/{load_from_self.rb → definition/load_from_self.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.2.0
-class Qonfig::Commands::LoadFromSelf < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::LoadFromSelf < Qonfig::Commands::Base
   # @return [String, Symbol]
   #
   # @api private

data/lib/qonfig/commands/{load_from_yaml.rb → definition/load_from_yaml.rb}

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.2.0
-class Qonfig::Commands::LoadFromYAML < Qonfig::Commands::Base
+class Qonfig::Commands::Definition::LoadFromYAML < Qonfig::Commands::Base
   # @return [String]
   #
   # @api private

data/lib/qonfig/commands/definition.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.17.0
+module Qonfig::Commands::Definition
+  require_relative 'definition/add_option'
+  require_relative 'definition/add_nested_option'
+  require_relative 'definition/compose'
+  require_relative 'definition/load_from_yaml'
+  require_relative 'definition/load_from_json'
+  require_relative 'definition/load_from_self'
+  require_relative 'definition/load_from_env'
+  require_relative 'definition/expose_yaml'
+  require_relative 'definition/expose_json'
+  require_relative 'definition/expose_self'
+end

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

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.17.0
+class Qonfig::Commands::Instantiation::ValuesFile < Qonfig::Commands::Base
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.17.0
+  SELF_LOCATED_FILE_DEFINITION = :self
+
+  # @return [NilClass]
+  #
+  # @api private
+  # @since 0.17.0
+  NO_EXPOSE = nil
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.17.0
+  DEFAULT_STRICT_BEHAVIOR = false
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.17.0
+  DEFAULT_FORMAT = :dynamic
+
+  # @return [String, Symbol]
+  #
+  # @api private
+  # @since 0.17.0
+  attr_reader :file_path
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.17.0
+  attr_reader :caller_location
+
+  # @return [String, Symbol]
+  #
+  # @api private
+  # @since 0.17.0
+  attr_reader :format
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.17.0
+  attr_reader :strict
+
+  # @return [NilClass, String, Symbol]
+  #
+  # @api private
+  # @since 0.17.0
+  attr_reader :expose
+
+  # @param file_path [String, Symbol]
+  # @param caller_location [String]
+  # @option format [String, Symbol]
+  # @option strict [Boolean]
+  # @option expose [NilClass, String, Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.17.0
+  def initialize(
+    file_path,
+    caller_location,
+    format: DEFAULT_FORMAT,
+    strict: DEFAULT_STRICT_BEHAVIOR,
+    expose: NO_EXPOSE
+  )
+    prevent_incompatible_attributes!(file_path, format, strict, expose)
+
+    @file_path = file_path
+    @caller_location = caller_location
+    @format = format
+    @strict = strict
+    @expose = expose
+  end
+
+  # @param data_set [Qonfig::DataSet]
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.17.0
+  def call(data_set, settings)
+    settings_values = load_settings_values
+    return unless settings_values
+    settings_values = (settings_values[expose.to_sym] || settings_values[expose.to_s]) if expose
+    data_set.configure(settings_values) if settings_values
+  end
+
+  private
+
+  # @return [Hash]
+  #
+  # @raise [Qonfig::IncompatibleDataStructureError]
+  #
+  # @api private
+  # @since 0.17.0
+  def load_settings_values
+    (file_path == SELF_LOCATED_FILE_DEFINITION) ? load_from_self : load_from_file
+  end
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.17.0
+  def load_from_file
+    Qonfig::Loaders.resolve(format).load_file(file_path, fail_on_unexist: strict).tap do |values|
+      raise(
+        Qonfig::IncompatibleDataStructureError,
+        'Setting values must be a hash-like structure'
+      ) unless values.is_a?(Hash)
+    end
+  end
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.17.0
+  def load_from_self
+    end_data = Qonfig::Loaders::EndData.extract(caller_location)
+
+    Qonfig::Loaders.resolve(format).load(end_data).tap do |values|
+      raise(
+        Qonfig::IncompatibleDataStructureError,
+        'Setting values must be a hash-like structure'
+      ) unless values.is_a?(Hash)
+    end
+  rescue Qonfig::SelfDataNotFoundError => error
+    raise(error) if strict
+  end
+
+  # @param file_path [String, Symbol]
+  # @param format [String, Symbol]
+  # @param strict [Boolean]
+  # @param expose [NilClass, String, Symbol]
+  # @return [void]
+  #
+  # @raise [Qonfig::ArgumentError]
+  # @raise [Qonfig::UnsupportedLoaderError]
+  #
+  # @api private
+  # @since 0.17.0
+  def prevent_incompatible_attributes!(file_path, format, strict, expose)
+    unless file_path.is_a?(String) || file_path == SELF_LOCATED_FILE_DEFINITION
+      raise Qonfig::ArgumentError, 'Incorrect file path'
+    end
+
+    unless format.is_a?(String) || format.is_a?(Symbol)
+      raise Qonfig::ArgumentError, 'Format should be a symbol or a string'
+    end
+
+    # NOTE: try to resolve corresponding loader (and fail if cannot be resolved)
+    Qonfig::Loaders.resolve(format)
+
+    unless expose.nil? || expose.is_a?(Symbol) || expose.is_a?(String)
+      raise Qonfig::ArgumentError, ':expose should be a string or a symbol (or nil)'
+    end
+
+    unless strict.is_a?(TrueClass) || strict.is_a?(FalseClass)
+      raise Qonfig::ArgumentError, ':strict should be a type of boolean'
+    end
+  end
+end

data/lib/qonfig/commands/instantiation.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.17.0
+module Qonfig::Commands::Instantiation
+  require_relative 'instantiation/values_file'
+end

data/lib/qonfig/commands.rb

@@ -4,14 +4,6 @@
 # @since 0.1.0
 module Qonfig::Commands
   require_relative 'commands/base'
-  require_relative 'commands/add_option'
-  require_relative 'commands/add_nested_option'
-  require_relative 'commands/compose'
-  require_relative 'commands/load_from_yaml'
-  require_relative 'commands/load_from_json'
-  require_relative 'commands/load_from_self'
-  require_relative 'commands/load_from_env'
-  require_relative 'commands/expose_yaml'
-  require_relative 'commands/expose_json'
-  require_relative 'commands/expose_self'
+  require_relative 'commands/definition'
+  require_relative 'commands/instantiation'
 end

data/lib/qonfig/data_set/lock.rb

@@ -10,24 +10,48 @@ class Qonfig::DataSet::Lock
   def initialize
     @access_lock = Mutex.new
     @definition_lock = Mutex.new
+    @arbitary_lock = Mutex.new
   end
 
-  # @param instructions [Proc]
+  # @param instructions [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.17.0
+  def with_arbitary_access(&instructions)
+    acquire_arbitary_lock(&instructions)
+  end
+
+  # @param instructions [Block]
   # @return [void]
   #
   # @api private
   # @since 0.13.0
   def thread_safe_access(&instructions)
-    access_lock.owned? ? yield : access_lock.synchronize(&instructions)
+    if arbitary_lock.locked?
+      # :nocov:
+      # NOTE: covered in thread-based specs but simplecov can't gather this fact
+      with_arbitary_access { acquire_access_lock(&instructions) } # :nocov:
+      # :nocov:
+    else
+      acquire_access_lock(&instructions)
+    end
   end
 
-  # @param instructions [Proc]
+  # @param instructions [Block]
   # @return [void]
   #
   # @api private
   # @since 0.13.0
   def thread_safe_definition(&instructions)
-    definition_lock.owned? ? yield : definition_lock.synchronize(&instructions)
+    if arbitary_lock.locked?
+      # :nocov:
+      # NOTE: covered in thread-based specs but simplecov can't gather this fact
+      with_arbitary_access { acquire_definition_lock(&instructions) }
+      # :nocov:
+    else
+      acquire_definition_lock(&instructions)
+    end
   end
 
   private
@@ -43,4 +67,37 @@ class Qonfig::DataSet::Lock
   # @api private
   # @since 0.13.0
   attr_reader :definition_lock
+
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 0.17.0
+  attr_reader :arbitary_lock
+
+  # @param instructions [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.17.0
+  def acquire_arbitary_lock(&instructions)
+    arbitary_lock.owned? ? yield : arbitary_lock.synchronize(&instructions)
+  end
+
+  # @param instructions [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def acquire_access_lock(&instructions)
+    access_lock.owned? ? yield : access_lock.synchronize(&instructions)
+  end
+
+  # @param instructions [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def acquire_definition_lock(&instructions)
+    definition_lock.owned? ? yield : definition_lock.synchronize(&instructions)
+  end
 end