qonfig 0.0.0 → 0.12.0

data/lib/qonfig/commands/load_from_env.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class Qonfig::Commands::LoadFromENV < Qonfig::Commands::Base
+  require_relative 'load_from_env/value_converter'
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :convert_values
+
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :prefix_pattern
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :trim_prefix
+
+  # @return [Regexp]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :trim_pattern
+
+  # @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 prefix.is_a?(NilClass) || prefix.is_a?(String) || prefix.is_a?(Regexp)
+      raise Qonfig::ArgumentError, ':prefix option should be a nil / string / regexp'
+    end
+
+    unless trim_prefix.is_a?(FalseClass) || trim_prefix.is_a?(TrueClass)
+      raise Qonfig::ArgumentError, ':trim_refix options should be a boolean'
+    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
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def call(settings)
+    env_data = extract_env_data
+
+    env_based_settings = build_data_set_class(env_data).new.settings
+
+    settings.__append_settings__(env_based_settings)
+  end
+
+  private
+
+  # @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_env/value_converter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Qonfig
+  # @api private
+  # @since 0.2.0
+  module Commands::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
+end

data/lib/qonfig/commands/load_from_json.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# @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

data/lib/qonfig/commands/load_from_self.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# @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 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
+
+    settings.__append_settings__(yaml_based_settings)
+  end
+
+  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
+
+    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
+
+    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
+  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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# @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/configurable.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+# @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)
+
+      super
+    end
+  end
+
+  # @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__)
+
+      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
+  end
+
+  # @api private
+  # @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
+    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
+    end
+  end
+
+  # @api private
+  # @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
+    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
+    end
+  end
+end