qonfig 0.10.0 → 0.11.0

data/lib/qonfig/commands/expose_yaml.rb

@@ -1,163 +1,159 @@
 # frozen_string_literal: true
 
-module Qonfig
-  module Commands
-    # @api private
-    # @since 0.7.0
-    class ExposeYAML < Base
-      # @return [Hash]
-      #
-      # @api private
-      # @since 0.7.0
-      EXPOSERS = { file_name: :file_name, env_key: :env_key }.freeze
-
-      # @return [Hash]
-      #
-      # @api private
-      # @since 0.7.0
-      EMPTY_YAML_DATA = {}.freeze
-
-      # @return [String]
-      #
-      # @api private
-      # @since 0.7.0
-      attr_reader :file_path
-
-      # @return [Boolean]
-      #
-      # @api private
-      # @since 0.7.0
-      attr_reader :strict
-
-      # @return [Symbol]
-      #
-      # @api private
-      # @since 0.7.0
-      attr_reader :via
-
-      # @return [Symbol, String]
-      #
-      # @api private
-      # @since 0.7.0
-      attr_reader :env
-
-      # @param file_path [String]
-      # @option strict [Boolean]
-      # @option via [Symbol]
-      # @option env [String, Symbol]
-      #
-      # @api private
-      # @since 0.7.0
-      def initialize(file_path, strict: true, via:, env:)
-        unless env.is_a?(Symbol) || env.is_a?(String) || env.is_a?(Numeric)
-          raise Qonfig::ArgumentError, ':env should be a string or a symbol'
-        end
-
-        raise Qonfig::ArgumentError, ':env should be provided'  if env.to_s.empty?
-        raise Qonfig::ArgumentError, 'used :via is unsupported' unless EXPOSERS.key?(via)
-
-        @file_path = file_path
-        @strict    = strict
-        @via       = via
-        @env       = env
-      end
-
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.7.0
-      def call(settings)
-        case via
-        when EXPOSERS[:file_name]
-          expose_file_name!(settings)
-        when EXPOSERS[:env_key]
-          expose_env_key!(settings)
-        end
-      end
-
-      private
-
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.7.0
-      # rubocop:disable Metrics/AbcSize
-      def expose_file_name!(settings)
-        # NOTE: transform file name (insert environment name into the file name)
-        #   from: path/to/file/file_name.file_extension
-        #   to:   path/to/file/file_name.env_name.file_extension
-
-        pathname = Pathname.new(file_path)
-        dirname  = pathname.dirname
-        extname  = pathname.extname.to_s
-        basename = pathname.basename.to_s.sub!(extname, '')
-        envname  = [env.to_s, extname].reject(&:empty?).join('')
-        envfile  = [basename, envname].reject(&:empty?).join('.')
-        realfile = dirname.join(envfile).to_s
-
-        yaml_data = load_yaml_data(realfile)
-        yaml_based_settings = build_data_set_class(yaml_data).new.settings
-
-        settings.__append_settings__(yaml_based_settings)
-      end
-      # rubocop:enable Metrics/AbcSize
-
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @raise [Qonfig::ExposeError]
-      # @raise [Qonfig::IncompatibleYAMLStructureError]
-      #
-      # @api private
-      # @since 0.7.0
-      # rubocop:disable Metrics/AbcSize
-      def expose_env_key!(settings)
-        yaml_data       = load_yaml_data(file_path)
-        yaml_data_slice = yaml_data[env] || yaml_data[env.to_s] || yaml_data[env.to_sym]
-        yaml_data_slice = EMPTY_YAML_DATA.dup if yaml_data_slice.nil? && !strict
-
-        raise(
-          Qonfig::ExposeError,
-          "#{file_path} file does not contain settings with <#{env}> environment key!"
-        ) unless yaml_data_slice
-
-        raise(
-          Qonfig::IncompatibleYAMLStructureError,
-          'YAML content should have a hash-like structure'
-        ) unless yaml_data_slice.is_a?(Hash)
-
-        yaml_based_settings = build_data_set_class(yaml_data_slice).new.settings
-
-        settings.__append_settings__(yaml_based_settings)
-      end
-      # rubocop:enable Metrics/AbcSize
-
-      # @param file_path [String]
-      # @return [Hash]
-      #
-      # @raise [Qonfig::IncompatibleYAMLStructureError]
-      #
-      # @api private
-      # @since 0.7.0
-      def load_yaml_data(file_path)
-        Qonfig::Loaders::YAML.load_file(file_path, fail_on_unexist: strict).tap do |yaml_data|
-          raise(
-            Qonfig::IncompatibleYAMLStructureError,
-            'YAML content should have a hash-like structure'
-          ) unless yaml_data.is_a?(Hash)
-        end
-      end
-
-      # @param yaml_data [Hash]
-      # @return [Class<Qonfig::DataSet>]
-      #
-      # @api private
-      # @since 0.7.0
-      def build_data_set_class(yaml_data)
-        Qonfig::DataSet::ClassBuilder.build_from_hash(yaml_data)
-      end
+# @api private
+# @since 0.7.0
+class Qonfig::Commands::ExposeYAML < Qonfig::Commands::Base
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.7.0
+  EXPOSERS = { file_name: :file_name, env_key: :env_key }.freeze
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.7.0
+  EMPTY_YAML_DATA = {}.freeze
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :file_path
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :strict
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :via
+
+  # @return [Symbol, String]
+  #
+  # @api private
+  # @since 0.7.0
+  attr_reader :env
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  # @option via [Symbol]
+  # @option env [String, Symbol]
+  #
+  # @api private
+  # @since 0.7.0
+  def initialize(file_path, strict: true, via:, env:)
+    unless env.is_a?(Symbol) || env.is_a?(String) || env.is_a?(Numeric)
+      raise Qonfig::ArgumentError, ':env should be a string or a symbol'
     end
+
+    raise Qonfig::ArgumentError, ':env should be provided'  if env.to_s.empty?
+    raise Qonfig::ArgumentError, 'used :via is unsupported' unless EXPOSERS.key?(via)
+
+    @file_path = file_path
+    @strict    = strict
+    @via       = via
+    @env       = env
+  end
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  def call(settings)
+    case via
+    when EXPOSERS[:file_name]
+      expose_file_name!(settings)
+    when EXPOSERS[:env_key]
+      expose_env_key!(settings)
+    end
+  end
+
+  private
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.7.0
+  # rubocop:disable Metrics/AbcSize
+  def expose_file_name!(settings)
+    # NOTE: transform file name (insert environment name into the file name)
+    #   from: path/to/file/file_name.file_extension
+    #   to:   path/to/file/file_name.env_name.file_extension
+
+    pathname = Pathname.new(file_path)
+    dirname  = pathname.dirname
+    extname  = pathname.extname.to_s
+    basename = pathname.basename.to_s.sub!(extname, '')
+    envname  = [env.to_s, extname].reject(&:empty?).join('')
+    envfile  = [basename, envname].reject(&:empty?).join('.')
+    realfile = dirname.join(envfile).to_s
+
+    yaml_data = load_yaml_data(realfile)
+    yaml_based_settings = build_data_set_class(yaml_data).new.settings
+
+    settings.__append_settings__(yaml_based_settings)
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @raise [Qonfig::ExposeError]
+  # @raise [Qonfig::IncompatibleYAMLStructureError]
+  #
+  # @api private
+  # @since 0.7.0
+  # rubocop:disable Metrics/AbcSize
+  def expose_env_key!(settings)
+    yaml_data       = load_yaml_data(file_path)
+    yaml_data_slice = yaml_data[env] || yaml_data[env.to_s] || yaml_data[env.to_sym]
+    yaml_data_slice = EMPTY_YAML_DATA.dup if yaml_data_slice.nil? && !strict
+
+    raise(
+      Qonfig::ExposeError,
+      "#{file_path} file does not contain settings with <#{env}> environment key!"
+    ) unless yaml_data_slice
+
+    raise(
+      Qonfig::IncompatibleYAMLStructureError,
+      'YAML content should have a hash-like structure'
+    ) unless yaml_data_slice.is_a?(Hash)
+
+    yaml_based_settings = build_data_set_class(yaml_data_slice).new.settings
+
+    settings.__append_settings__(yaml_based_settings)
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  # @param file_path [String]
+  # @return [Hash]
+  #
+  # @raise [Qonfig::IncompatibleYAMLStructureError]
+  #
+  # @api private
+  # @since 0.7.0
+  def load_yaml_data(file_path)
+    Qonfig::Loaders::YAML.load_file(file_path, fail_on_unexist: strict).tap do |yaml_data|
+      raise(
+        Qonfig::IncompatibleYAMLStructureError,
+        'YAML content should have a hash-like structure'
+      ) unless yaml_data.is_a?(Hash)
+    end
+  end
+
+  # @param yaml_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.7.0
+  def build_data_set_class(yaml_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(yaml_data)
   end
 end

data/lib/qonfig/commands/load_from_env.rb

@@ -1,97 +1,95 @@
 # frozen_string_literal: true
 
-module Qonfig
-  module Commands
-    # @api private
-    # @since 0.2.0
-    class LoadFromENV < Base
-      # @return [Boolean]
-      #
-      # @api private
-      # @since 0.2.0
-      attr_reader :convert_values
+# @api private
+# @since 0.2.0
+class Qonfig::Commands::LoadFromENV < Qonfig::Commands::Base
+  require_relative 'load_from_env/value_converter'
 
-      # @return [Regexp]
-      #
-      # @api private
-      # @since 0.2.0
-      attr_reader :prefix_pattern
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :convert_values
 
-      # @return [Boolean]
-      #
-      # @api private
-      # @since 0.2.0
-      attr_reader :trim_prefix
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :prefix_pattern
 
-      # @return [Regexp]
-      #
-      # @api private
-      # @since 0.2.0
-      attr_reader :trim_pattern
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :trim_prefix
 
-      # @option convert_values [Boolean]
-      # @opion prefix [NilClass, String, Regexp]
-      #
-      # @raise [Qonfig::ArgumentError]
-      #
-      # @api private
-      # @since 0.2.0
-      def initialize(convert_values: false, prefix: nil, trim_prefix: false)
-        unless convert_values.is_a?(FalseClass) || convert_values.is_a?(TrueClass)
-          raise Qonfig::ArgumentError, ':convert_values option should be a boolean'
-        end
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :trim_pattern
 
-        unless prefix.is_a?(NilClass) || prefix.is_a?(String) || prefix.is_a?(Regexp)
-          raise Qonfig::ArgumentError, ':prefix option should be a nil / string / regexp'
-        end
+  # @option convert_values [Boolean]
+  # @opion prefix [NilClass, String, Regexp]
+  #
+  # @raise [Qonfig::ArgumentError]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(convert_values: false, prefix: nil, trim_prefix: false)
+    unless convert_values.is_a?(FalseClass) || convert_values.is_a?(TrueClass)
+      raise Qonfig::ArgumentError, ':convert_values option should be a boolean'
+    end
 
-        unless trim_prefix.is_a?(FalseClass) || trim_prefix.is_a?(TrueClass)
-          raise Qonfig::ArgumentError, ':trim_refix options should be a boolean'
-        end
+    unless prefix.is_a?(NilClass) || prefix.is_a?(String) || prefix.is_a?(Regexp)
+      raise Qonfig::ArgumentError, ':prefix option should be a nil / string / regexp'
+    end
 
-        @convert_values = convert_values
-        @prefix_pattern = prefix.is_a?(Regexp) ? prefix : /\A#{Regexp.escape(prefix.to_s)}.*\z/m
-        @trim_prefix    = trim_prefix
-        @trim_pattern   = prefix.is_a?(Regexp) ? prefix : /\A(#{Regexp.escape(prefix.to_s)})/m
-      end
+    unless trim_prefix.is_a?(FalseClass) || trim_prefix.is_a?(TrueClass)
+      raise Qonfig::ArgumentError, ':trim_refix options should be a boolean'
+    end
 
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.2.0
-      def call(settings)
-        env_data = extract_env_data
+    @convert_values = convert_values
+    @prefix_pattern = prefix.is_a?(Regexp) ? prefix : /\A#{Regexp.escape(prefix.to_s)}.*\z/m
+    @trim_prefix    = trim_prefix
+    @trim_pattern   = prefix.is_a?(Regexp) ? prefix : /\A(#{Regexp.escape(prefix.to_s)})/m
+  end
 
-        env_based_settings = build_data_set_class(env_data).new.settings
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def call(settings)
+    env_data = extract_env_data
 
-        settings.__append_settings__(env_based_settings)
-      end
+    env_based_settings = build_data_set_class(env_data).new.settings
 
-      private
+    settings.__append_settings__(env_based_settings)
+  end
 
-      # @return [Hash]
-      #
-      # @api private
-      # @since 0.2.0
-      def extract_env_data
-        ENV.each_with_object({}) do |(key, value), env_data|
-          next unless key.match(prefix_pattern)
-          key = key.sub(trim_pattern, '') if trim_prefix
-          env_data[key] = value
-        end.tap do |env_data|
-          ValueConverter.convert_values!(env_data) if convert_values
-        end
-      end
+  private
 
-      # @param env_data [Hash]
-      # @return [Class<Qonfig::DataSet>]
-      #
-      # @api private
-      # @since 0.2.0
-      def build_data_set_class(env_data)
-        Qonfig::DataSet::ClassBuilder.build_from_hash(env_data)
-      end
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.2.0
+  def extract_env_data
+    ENV.each_with_object({}) do |(key, value), env_data|
+      next unless key.match(prefix_pattern)
+      key = key.sub(trim_pattern, '') if trim_prefix
+      env_data[key] = value
+    end.tap do |env_data|
+      ValueConverter.convert_values!(env_data) if convert_values
     end
   end
+
+  # @param env_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.2.0
+  def build_data_set_class(env_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(env_data)
+  end
 end

data/lib/qonfig/commands/load_from_json.rb

@@ -1,60 +1,56 @@
 # frozen_string_literal: true
 
-module Qonfig
-  module Commands
-    # @api private
-    # @since 0.5.0
-    class LoadFromJSON < Base
-      # @return [String]
-      #
-      # @api private
-      # @since 0.5.0
-      attr_reader :file_path
-
-      # @return [Boolean]
-      #
-      # @api private
-      # @sicne 0.5.0
-      attr_reader :strict
-
-      # @param file_path [String]
-      # @option strict [Boolean]
-      #
-      # @api private
-      # @since 0.5.0
-      def initialize(file_path, strict: true)
-        @file_path = file_path
-        @strict = strict
-      end
-
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.5.0
-      def call(settings)
-        json_data = Qonfig::Loaders::JSON.load_file(file_path, fail_on_unexist: strict)
-
-        raise(
-          Qonfig::IncompatibleJSONStructureError,
-          'JSON object should have a hash-like structure'
-        ) unless json_data.is_a?(Hash)
-
-        json_based_settings = build_data_set_class(json_data).new.settings
-
-        settings.__append_settings__(json_based_settings)
-      end
-
-      private
-
-      # @param json_data [Hash]
-      # @return [Class<Qonfig::DataSet>]
-      #
-      # @api private
-      # @since 0.5.0
-      def build_data_set_class(json_data)
-        Qonfig::DataSet::ClassBuilder.build_from_hash(json_data)
-      end
-    end
+# @api private
+# @since 0.5.0
+class Qonfig::Commands::LoadFromJSON < Qonfig::Commands::Base
+  # @return [String]
+  #
+  # @api private
+  # @since 0.5.0
+  attr_reader :file_path
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @sicne 0.5.0
+  attr_reader :strict
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  #
+  # @api private
+  # @since 0.5.0
+  def initialize(file_path, strict: true)
+    @file_path = file_path
+    @strict = strict
+  end
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def call(settings)
+    json_data = Qonfig::Loaders::JSON.load_file(file_path, fail_on_unexist: strict)
+
+    raise(
+      Qonfig::IncompatibleJSONStructureError,
+      'JSON object should have a hash-like structure'
+    ) unless json_data.is_a?(Hash)
+
+    json_based_settings = build_data_set_class(json_data).new.settings
+
+    settings.__append_settings__(json_based_settings)
+  end
+
+  private
+
+  # @param json_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.5.0
+  def build_data_set_class(json_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(json_data)
   end
 end