qonfig 0.10.0 → 0.11.0

data/lib/qonfig/commands/load_from_self.rb

@@ -1,77 +1,73 @@
 # frozen_string_literal: true
 
-module Qonfig
-  module Commands
-    # @api private
-    # @since 0.2.0
-    class LoadFromSelf < Base
-      # @return [String]
-      #
-      # @api private
-      # @since 0.2.0
-      attr_reader :caller_location
+# @api private
+# @since 0.2.0
+class Qonfig::Commands::LoadFromSelf < Qonfig::Commands::Base
+  # @return [String]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :caller_location
 
-      # @param caller_location [String]
-      #
-      # @api private
-      # @since 0.2.0
-      def initialize(caller_location)
-        @caller_location = caller_location
-      end
+  # @param caller_location [String]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(caller_location)
+    @caller_location = caller_location
+  end
 
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.2.0
-      def call(settings)
-        yaml_data = load_self_placed_yaml_data
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def call(settings)
+    yaml_data = load_self_placed_yaml_data
 
-        yaml_based_settings = build_data_set_klass(yaml_data).new.settings
+    yaml_based_settings = build_data_set_klass(yaml_data).new.settings
 
-        settings.__append_settings__(yaml_based_settings)
-      end
+    settings.__append_settings__(yaml_based_settings)
+  end
 
-      private
+  private
 
-      # @return [Hash]
-      #
-      # @raise [Qonfig::SelfDataNotFound]
-      # @raise [Qonfig::IncompatibleYAMLStructureError]
-      #
-      # @api private
-      # @since 0.2.0
-      def load_self_placed_yaml_data
-        caller_file = caller_location.split(':').first
+  # @return [Hash]
+  #
+  # @raise [Qonfig::SelfDataNotFound]
+  # @raise [Qonfig::IncompatibleYAMLStructureError]
+  #
+  # @api private
+  # @since 0.2.0
+  def load_self_placed_yaml_data
+    caller_file = caller_location.split(':').first
 
-        raise(
-          Qonfig::SelfDataNotFoundError,
-          "Caller file does not exist! (location: #{caller_location})"
-        ) unless File.exist?(caller_file)
+    raise(
+      Qonfig::SelfDataNotFoundError,
+      "Caller file does not exist! (location: #{caller_location})"
+    ) unless File.exist?(caller_file)
 
-        data_match = IO.read(caller_file).match(/\n__END__\n(?<end_data>.*)/m)
-        raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless data_match
+    data_match = IO.read(caller_file).match(/\n__END__\n(?<end_data>.*)/m)
+    raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless data_match
 
-        end_data = data_match[:end_data]
-        raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless end_data
+    end_data = data_match[:end_data]
+    raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless end_data
 
-        yaml_data = Qonfig::Loaders::YAML.load(end_data)
-        raise(
-          Qonfig::IncompatibleYAMLStructureError,
-          'YAML content should have a hash-like structure'
-        ) unless yaml_data.is_a?(Hash)
+    yaml_data = Qonfig::Loaders::YAML.load(end_data)
+    raise(
+      Qonfig::IncompatibleYAMLStructureError,
+      'YAML content should have a hash-like structure'
+    ) unless yaml_data.is_a?(Hash)
 
-        yaml_data
-      end
+    yaml_data
+  end
 
-      # @param self_placed_yaml_data [Hash]
-      # @return [Class<Qonfig::DataSet>]
-      #
-      # @api private
-      # @since 0.2.0
-      def build_data_set_klass(self_placed_yaml_data)
-        Qonfig::DataSet::ClassBuilder.build_from_hash(self_placed_yaml_data)
-      end
-    end
+  # @param self_placed_yaml_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.2.0
+  def build_data_set_klass(self_placed_yaml_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(self_placed_yaml_data)
   end
 end

data/lib/qonfig/commands/load_from_yaml.rb

@@ -1,62 +1,58 @@
 # frozen_string_literal: true
 
-module Qonfig
-  module Commands
-    # @api private
-    # @since 0.2.0
-    class LoadFromYAML < Base
-      # @return [String]
-      #
-      # @api private
-      # @since 0.2.0
-      attr_reader :file_path
-
-      # @return [Boolean]
-      #
-      # @api private
-      # @since 0.2.0
-      attr_reader :strict
-
-      # @param file_path [String]
-      # @option strict [Boolean]
-      #
-      # @api private
-      # @since 0.2.0
-      def initialize(file_path, strict: true)
-        @file_path = file_path
-        @strict = strict
-      end
-
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @raise [Qonfig::IncompatibleYAMLStructureError]
-      #
-      # @api private
-      # @since 0.2.0
-      def call(settings)
-        yaml_data = Qonfig::Loaders::YAML.load_file(file_path, fail_on_unexist: strict)
-
-        raise(
-          Qonfig::IncompatibleYAMLStructureError,
-          'YAML content should have a hash-like structure'
-        ) unless yaml_data.is_a?(Hash)
-
-        yaml_based_settings = build_data_set_class(yaml_data).new.settings
-
-        settings.__append_settings__(yaml_based_settings)
-      end
-
-      private
-
-      # @param yaml_data [Hash]
-      # @return [Class<Qonfig::DataSet>]
-      #
-      # @api private
-      # @since 0.2.0
-      def build_data_set_class(yaml_data)
-        Qonfig::DataSet::ClassBuilder.build_from_hash(yaml_data)
-      end
-    end
+# @api private
+# @since 0.2.0
+class Qonfig::Commands::LoadFromYAML < Qonfig::Commands::Base
+  # @return [String]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :file_path
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :strict
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(file_path, strict: true)
+    @file_path = file_path
+    @strict = strict
+  end
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @raise [Qonfig::IncompatibleYAMLStructureError]
+  #
+  # @api private
+  # @since 0.2.0
+  def call(settings)
+    yaml_data = Qonfig::Loaders::YAML.load_file(file_path, fail_on_unexist: strict)
+
+    raise(
+      Qonfig::IncompatibleYAMLStructureError,
+      'YAML content should have a hash-like structure'
+    ) unless yaml_data.is_a?(Hash)
+
+    yaml_based_settings = build_data_set_class(yaml_data).new.settings
+
+    settings.__append_settings__(yaml_based_settings)
+  end
+
+  private
+
+  # @param yaml_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.2.0
+  def build_data_set_class(yaml_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(yaml_data)
   end
 end

data/lib/qonfig/commands.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# @api private
+# @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'
+end

data/lib/qonfig/configurable.rb

@@ -1,117 +1,115 @@
 # frozen_string_literal: true
 
-module Qonfig
-  # @api public
-  # @since 0.2.0
-  module Configurable
-    class << self
-      # @param base_klass [Class]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.2.0
-      def included(base_klass)
-        base_klass.instance_variable_set(:@__qonfig_access_lock__, Mutex.new)
-        base_klass.instance_variable_set(:@__qonfig_definition_lock__, Mutex.new)
-        base_klass.instance_variable_set(:@__qonfig_config_klass__, Class.new(Qonfig::DataSet))
-        base_klass.instance_variable_set(:@__qonfig_config__, nil)
+# @api public
+# @since 0.2.0
+module Qonfig::Configurable
+  class << self
+    # @param base_klass [Class]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.2.0
+    def included(base_klass)
+      base_klass.instance_variable_set(:@__qonfig_access_lock__, Mutex.new)
+      base_klass.instance_variable_set(:@__qonfig_definition_lock__, Mutex.new)
+      base_klass.instance_variable_set(:@__qonfig_config_klass__, Class.new(Qonfig::DataSet))
+      base_klass.instance_variable_set(:@__qonfig_config__, nil)
 
-        base_klass.extend(ClassMethods)
-        base_klass.include(InstanceMethods)
-        base_klass.singleton_class.prepend(ClassInheritance)
+      base_klass.extend(ClassMethods)
+      base_klass.include(InstanceMethods)
+      base_klass.singleton_class.prepend(ClassInheritance)
 
-        super
-      end
+      super
     end
+  end
 
+  # @api private
+  # @since 0.2.0
+  module ClassInheritance
+    # @param child_klass [Class]
+    # @return [void]
+    #
     # @api private
     # @since 0.2.0
-    module ClassInheritance
-      # @param child_klass [Class]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.2.0
-      def inherited(child_klass)
-        inherited_config_klass = Class.new(@__qonfig_config_klass__)
+    def inherited(child_klass)
+      inherited_config_klass = Class.new(@__qonfig_config_klass__)
 
-        child_klass.instance_variable_set(:@__qonfig_definition_lock__, Mutex.new)
-        child_klass.instance_variable_set(:@__qonfig_access_lock__, Mutex.new)
-        child_klass.instance_variable_set(:@__qonfig_config_klass__, inherited_config_klass)
-        child_klass.instance_variable_set(:@__qonfig_config__, nil)
+      child_klass.instance_variable_set(:@__qonfig_definition_lock__, Mutex.new)
+      child_klass.instance_variable_set(:@__qonfig_access_lock__, Mutex.new)
+      child_klass.instance_variable_set(:@__qonfig_config_klass__, inherited_config_klass)
+      child_klass.instance_variable_set(:@__qonfig_config__, nil)
 
-        super
-      end
+      super
     end
+  end
 
-    # @api private
+  # @api private
+  # @since 0.2.0
+  module ClassMethods
+    # @param block [Proc]
+    # @return [void]
+    #
+    # @api public
     # @since 0.2.0
-    module ClassMethods
-      # @param block [Proc]
-      # @return [void]
-      #
-      # @api public
-      # @since 0.2.0
-      def configuration(&block)
-        @__qonfig_definition_lock__.synchronize do
-          @__qonfig_config_klass__.instance_eval(&block) if block_given?
-        end
+    def configuration(&block)
+      @__qonfig_definition_lock__.synchronize do
+        @__qonfig_config_klass__.instance_eval(&block) if block_given?
       end
+    end
 
-      # @param options_map [Hash]
-      # @param block [Proc]
-      # @return [void]
-      #
-      # @api public
-      # @since 0.2.0
-      def configure(options_map = {}, &block)
-        @__qonfig_access_lock__.synchronize do
-          config.configure(options_map, &block)
-        end
+    # @param options_map [Hash]
+    # @param block [Proc]
+    # @return [void]
+    #
+    # @api public
+    # @since 0.2.0
+    def configure(options_map = {}, &block)
+      @__qonfig_access_lock__.synchronize do
+        config.configure(options_map, &block)
       end
+    end
 
-      # @return [Qonfig::DataSet]
-      #
-      # @api public
-      # @since 0.2.0
-      def config
-        @__qonfig_definition_lock__.synchronize do
-          @__qonfig_config__ ||= @__qonfig_config_klass__.new
-        end
+    # @return [Qonfig::DataSet]
+    #
+    # @api public
+    # @since 0.2.0
+    def config
+      @__qonfig_definition_lock__.synchronize do
+        @__qonfig_config__ ||= @__qonfig_config_klass__.new
       end
     end
+  end
 
-    # @api private
+  # @api private
+  # @since 0.2.0
+  module InstanceMethods
+    # @return [Qonfig::DataSet]
+    #
+    # @api public
     # @since 0.2.0
-    module InstanceMethods
-      # @return [Qonfig::DataSet]
-      #
-      # @api public
-      # @since 0.2.0
-      def config
-        self.class.instance_variable_get(:@__qonfig_definition_lock__).synchronize do
-          @__qonfig_config__ ||= self.class.instance_variable_get(:@__qonfig_config_klass__).new
-        end
+    def config
+      self.class.instance_variable_get(:@__qonfig_definition_lock__).synchronize do
+        @__qonfig_config__ ||= self.class.instance_variable_get(:@__qonfig_config_klass__).new
       end
+    end
 
-      # @return [Qonfig::DataSet]
-      #
-      # @api public
-      # @since 0.6.0
-      def shared_config
-        self.class.config
-      end
+    # @return [Qonfig::DataSet]
+    #
+    # @api public
+    # @since 0.6.0
+    def shared_config
+      self.class.config
+    end
 
-      # @param options_map [Hash]
-      # @param block [Proc]
-      # @return [void]
-      #
-      # @api public
-      # @since 0.2.0
-      def configure(options_map = {}, &block)
-        self.class.instance_variable_get(:@__qonfig_access_lock__).synchronize do
-          config.configure(options_map, &block)
-        end
+    # @param options_map [Hash]
+    # @param block [Proc]
+    # @return [void]
+    #
+    # @api public
+    # @since 0.2.0
+    def configure(options_map = {}, &block)
+      self.class.instance_variable_get(:@__qonfig_access_lock__).synchronize do
+        config.configure(options_map, &block)
       end
     end
   end

data/lib/qonfig/data_set/class_builder.rb

@@ -1,28 +1,24 @@
 # frozen_string_literal: true
 
-module Qonfig
-  class DataSet
+# @api private
+# @since 0.2.0
+module Qonfig::DataSet::ClassBuilder
+  class << self
+    # @param hash [Hash]
+    # @return [Class<Qonfig::DataSet>]
+    #
+    # @see Qonfig::DataSet
+    #
     # @api private
     # @since 0.2.0
-    module ClassBuilder
-      class << self
-        # @param hash [Hash]
-        # @return [Class<Qonfig::DataSet>]
-        #
-        # @see Qonfig::DataSet
-        #
-        # @api private
-        # @since 0.2.0
-        def build_from_hash(hash)
-          Class.new(Qonfig::DataSet).tap do |data_set_klass|
-            hash.each_pair do |key, value|
-              if value.is_a?(Hash) && value.any?
-                sub_data_set_klass = build_from_hash(value)
-                data_set_klass.setting(key) { compose sub_data_set_klass }
-              else
-                data_set_klass.setting key, value
-              end
-            end
+    def build_from_hash(hash)
+      Class.new(Qonfig::DataSet).tap do |data_set_klass|
+        hash.each_pair do |key, value|
+          if value.is_a?(Hash) && value.any?
+            sub_data_set_klass = build_from_hash(value)
+            data_set_klass.setting(key) { compose sub_data_set_klass }
+          else
+            data_set_klass.setting key, value
           end
         end
       end