qonfig 0.1.0 → 0.2.0

data/lib/qonfig/command_set.rb

@@ -14,6 +14,7 @@ module Qonfig
     # @since 0.1.0
     def initialize
       @commands = []
+      @access_lock = Mutex.new
     end
 
     # @param command [Qonfig::Commands::Base]
@@ -22,7 +23,7 @@ module Qonfig
     # @api private
     # @since 0.1.0
     def add_command(command)
-      commands << command
+      thread_safe { commands << command }
     end
     alias_method :<<, :add_command
 
@@ -32,16 +33,37 @@ module Qonfig
     # @api private
     # @since 0.1.0
     def each(&block)
-      block_given? ? commands.each(&block) : commands.each
+      thread_safe { block_given? ? commands.each(&block) : commands.each }
     end
 
     # @param command_set [Qonfig::CommandSet]
-    # @return [Qonfig::CommandSet]
+    # @return [void]
     #
     # @api private
     # @since 0.1.0
     def concat(command_set)
-      commands.concat(command_set.commands)
+      thread_safe { commands.concat(command_set.commands) }
+    end
+
+    # @return [Qonfig::CommandSet]
+    #
+    # @api private
+    # @since 0.2.0
+    def dup
+      thread_safe do
+        self.class.new.tap { |duplicate| duplicate.concat(self) }
+      end
+    end
+
+    private
+
+    # @param block [Proc]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def thread_safe(&block)
+      @access_lock.synchronize(&block)
     end
   end
 end

data/lib/qonfig/commands/add_nested_option.rb

@@ -5,26 +5,33 @@ module Qonfig
     # @api private
     # @since 0.1.0
     class AddNestedOption < Base
-      # @return [String,Symbol]
+      # @return [Symbol, String]
       #
       # @api private
       # @since 0.1.0
       attr_reader :key
 
-      # @return [Proc]
+      # @return [Class<Qonfig::DataSet>]
       #
       # @api private
-      # @since 0.1.0
-      attr_reader :nested_definitions
+      # @since 0.2.0
+      attr_reader :nested_data_set_klass
 
-      # @param key [String,Symbol]
+      # @param key [Symbol, String]
       # @param nested_definitions [Proc]
       #
+      # @raise [Qonfig::ArgumentError]
+      # @raise [Qonfig::CoreMethodIntersectionError]
+      #
       # @api private
       # @since 0.1.0
       def initialize(key, nested_definitions)
+        Qonfig::Settings::KeyGuard.prevent_incomparabilities!(key)
+
         @key = key
-        @nested_definitions = nested_definitions
+        @nested_data_set_klass = Class.new(Qonfig::DataSet).tap do |data_set|
+          data_set.instance_eval(&nested_definitions)
+        end
       end
 
       # @param settings [Qonfig::Settings]
@@ -33,11 +40,7 @@ module Qonfig
       # @api private
       # @since 0.1.0
       def call(settings)
-        nested_data_set = Class.new(Qonfig::DataSet).tap do |data_set|
-          data_set.instance_eval(&nested_definitions)
-        end
-
-        nested_settings = nested_data_set.new.settings
+        nested_settings = nested_data_set_klass.new.settings
 
         settings.__define_setting__(key, nested_settings)
       end

data/lib/qonfig/commands/add_option.rb

@@ -5,7 +5,7 @@ module Qonfig
     # @api private
     # @since 0.1.0
     class AddOption < Base
-      # @return [String,Symbol]
+      # @return [Symbol, String]
       #
       # @api private
       # @since 0.1.0
@@ -17,13 +17,18 @@ module Qonfig
       # @since 0.1.0
       attr_reader :value
 
-      # @param key [String,Symbol]
+      # @param key [Symbol, String]
       # @param value [Object]
       #
+      # @raise [Qonfig::ArgumentError]
+      # @raise [Qonfig::CoreMethodIntersectionError]
+      #
       # @api private
       # @since 0.1.0
       def initialize(key, value)
-        @key   = key
+        Qonfig::Settings::KeyGuard.prevent_incomparabilities!(key)
+
+        @key = key
         @value = value
       end
 

data/lib/qonfig/commands/compose.rb

@@ -13,9 +13,16 @@ module Qonfig
 
       # @param data_set_klass [Qonfig::DataSet]
       #
+      # @raise [Qonfig::ArgumentError]
+      #
       # @api private
       # @since 0.1.0
       def initialize(data_set_klass)
+        raise(
+          Qonfig::ArgumentError,
+          'Composed config class should be a subtype of Qonfig::DataSet'
+        ) unless data_set_klass.is_a?(Class) && data_set_klass < Qonfig::DataSet
+
         @data_set_klass = data_set_klass
       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/
+
+    # @return [Regexp]
+    #
+    # @api private
+    # @since 0.2.0
+    FLOAT_PATTERN = /\A\d+\.\d+\z/
+
+    # @return [Regexp]
+    #
+    # @api private
+    # @since 0.2.0
+    TRUE_PATTERN = /\A(t|true)\z/i
+
+    # @return [Regexp]
+    #
+    # @api private
+    # @since 0.2.0
+    FALSE_PATTERN = /\A(f|false)\z/i
+
+    # @return [Regexp]
+    #
+    # @api private
+    # @since 0.2.0
+    ARRAY_PATTERN = /\A[^'"].*\s*,\s*.*[^'"]\z/
+
+    # @return [Regexp]
+    #
+    # @api private
+    # @since 0.2.0
+    QUOTED_STRING_PATTERN = /\A['"].*['"]\z/
+
+    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_env.rb

@@ -0,0 +1,97 @@
+# 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
+
+      # @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
+  end
+end

data/lib/qonfig/commands/load_from_self.rb

@@ -0,0 +1,77 @@
+# 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
+
+      # @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
+  end
+end

data/lib/qonfig/commands/load_from_yaml.rb

@@ -0,0 +1,62 @@
+# 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
+  end
+end

data/lib/qonfig/configurable.rb

@@ -0,0 +1,108 @@
+# 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)
+
+        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 block [Proc]
+      # @return [void]
+      #
+      # @api public
+      # @since 0.2.0
+      def configure(&block)
+        @__qonfig_access_lock__.synchronize do
+          config.configure(&block) if block_given?
+        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
+
+      # @param block [Proc]
+      # @return [void]
+      #
+      # @api public
+      # @since 0.2.0
+      def configure(&block)
+        self.class.instance_variable_get(:@__qonfig_access_lock__).synchronize do
+          config.configure(&block) if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/qonfig/data_set/class_builder.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Qonfig
+  class 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)
+                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
+        end
+      end
+    end
+  end
+end