qonfig 0.1.0 → 0.2.0

data/lib/qonfig/data_set.rb

@@ -13,10 +13,15 @@ module Qonfig
     # @since 0.1.0
     attr_reader :settings
 
+    # @param configurations [Proc]
+    #
     # @api public
     # @since 0.1.0
-    def initialize
-      @settings = Qonfig::SettingsBuilder.build(self.class.commands)
+    def initialize(&configurations)
+      @__access_lock__ = Mutex.new
+      @__definition_lock__ = Mutex.new
+
+      thread_safe_definition { load!(&configurations) }
     end
 
     # @return [void]
@@ -24,7 +29,29 @@ module Qonfig
     # @api public
     # @since 0.1.0
     def freeze!
-      settings.__freeze__
+      thread_safe_access { settings.__freeze__ }
+    end
+
+    # @return [void]
+    #
+    # @api public
+    # @since 0.2.0
+    def frozen?
+      thread_safe_access { settings.__is_frozen__ }
+    end
+
+    # @param configurations [Proc]
+    # @return [void]
+    #
+    # @raise [Qonfig::FrozenSettingsError]
+    #
+    # @api public
+    # @since 0.2.0
+    def reload!(&configurations)
+      thread_safe_definition do
+        raise Qonfig::FrozenSettingsError, 'Frozen config can not be reloaded' if frozen?
+        load!(&configurations)
+      end
     end
 
     # @return [void]
@@ -32,7 +59,7 @@ module Qonfig
     # @api public
     # @since 0.1.0
     def configure
-      yield(settings) if block_given?
+      thread_safe_access { yield(settings) if block_given? }
     end
 
     # @return [Hash]
@@ -40,8 +67,72 @@ module Qonfig
     # @api public
     # @since 0.1.0
     def to_h
-      settings.__to_hash__
+      thread_safe_access { settings.__to_hash__ }
     end
     alias_method :to_hash, :to_h
+
+    # @param key [String, Symbol]
+    # @return [Object]
+    #
+    # @api public
+    # @since 0.2.0
+    def [](key)
+      thread_safe_access { settings[key] }
+    end
+
+    # @param keys [Array<String, Symbol>]
+    # @return [Object]
+    #
+    # @api public
+    # @since 0.2.0
+    def dig(*keys)
+      thread_safe_access { settings.__dig__(*keys) }
+    end
+
+    # @return [void]
+    #
+    # @api public
+    # @since 0.2.0
+    def clear!
+      thread_safe_access { settings.__clear__ }
+    end
+
+    private
+
+    # @return [Qonfig::Settings]
+    #
+    # @api private
+    # @since 0.2.0
+    def build_settings
+      Qonfig::Settings::Builder.build(self.class.commands.dup)
+    end
+
+    # @param configurations [Proc]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.2.0
+    def load!(&configurations)
+      @settings = build_settings
+      configure(&configurations) if block_given?
+    end
+
+    # @param instructions [Proc]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def thread_safe_access(&instructions)
+      @__access_lock__.synchronize(&instructions)
+    end
+
+    # @param instructions [Proc]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def thread_safe_definition(&instructions)
+      @__definition_lock__.synchronize(&instructions)
+    end
   end
 end

data/lib/qonfig/dsl.rb

@@ -13,12 +13,13 @@ module Qonfig
       def extended(child_klass)
         child_klass.instance_variable_set(:@commands, Qonfig::CommandSet.new)
 
-        class << child_klass
+        child_klass.singleton_class.prepend(Module.new do
           def inherited(child_klass)
             child_klass.instance_variable_set(:@commands, Qonfig::CommandSet.new)
             child_klass.commands.concat(commands)
+            super
           end
-        end
+        end)
       end
     end
 
@@ -30,18 +31,17 @@ module Qonfig
       @commands
     end
 
-    # @param key [String,Symbol]
+    # @param key [Symbol, String]
     # @param initial_value [Object]
     # @param nested_settings [Proc]
     # @return [void]
     #
+    # @see Qonfig::Commands::AddNestedOption
+    # @see Qonfig::Commands::AddOption
+    #
     # @api public
     # @since 0.1.0
     def setting(key, initial_value = nil, &nested_settings)
-      unless key.is_a?(Symbol) || key.is_a?(String)
-        raise Qonfig::ArgumentError, 'Setting key should be a symbol or a string!'
-      end
-
       if block_given?
         commands << Qonfig::Commands::AddNestedOption.new(key, nested_settings)
       else
@@ -52,10 +52,51 @@ module Qonfig
     # @param data_set_klass [Class{Qonfig::DataSet}]
     # @return [void]
     #
+    # @see Qonfig::Comamnds::Compose
+    #
     # @api private
     # @sine 0.1.0
     def compose(data_set_klass)
       commands << Qonfig::Commands::Compose.new(data_set_klass)
     end
+
+    # @param file_path [String]
+    # @option strict [Boolean]
+    # @return [void]
+    #
+    # @see Qonfig::Commands::LoadFromYAML
+    #
+    # @api public
+    # @since 0.2.0
+    def load_from_yaml(file_path, strict: true)
+      commands << Qonfig::Commands::LoadFromYAML.new(file_path, strict: strict)
+    end
+
+    # @return [void]
+    #
+    # @see Qonfig::Commands::LoadFromSelf
+    #
+    # @api public
+    # @since 0.2.0
+    def load_from_self
+      caller_location = caller(1, 1).first
+      commands << Qonfig::Commands::LoadFromSelf.new(caller_location)
+    end
+
+    # @option convert_values [Boolean]
+    # @option prefix [NilClass, String, Regexp]
+    # @return [void]
+    #
+    # @see Qonfig::Commands::LoadFromENV
+    #
+    # @api public
+    # @since 0.2.0
+    def load_from_env(convert_values: false, prefix: nil, trim_prefix: false)
+      commands << Qonfig::Commands::LoadFromENV.new(
+        convert_values: convert_values,
+        prefix: prefix,
+        trim_prefix: trim_prefix
+      )
+    end
   end
 end

data/lib/qonfig/error.rb

@@ -9,11 +9,57 @@ module Qonfig
   # @since 0.1.0
   ArgumentError = Class.new(Error)
 
+  # @see Qonfig::Settings
+  #
   # @api public
   # @since 0.1.0
   UnknownSettingError = Class.new(Error)
 
+  # @see Qonfig::Settings
+  #
+  # @api public
+  # @since 0.2.0
+  AmbiguousSettingValueError = Class.new(Error)
+
+  # @see Qonfig::Settings
+  # @see Qonfig::Settings::KeyGuard
+  # @see Qonfig::Commands::AddOption
+  # @see Qonfig::Commands::AddNestedOption
+  #
+  # @api public
+  # @since 0.2.0
+  CoreMethodIntersectionError = Class.new(Error)
+
+  # @see Qonfig::Settings
+  # @see Qonfig::DataSet
+  #
   # @api public
   # @since 0.1.0
-  FrozenSettingsError = Class.new(Error)
+  FrozenSettingsError = begin # rubocop:disable Naming/ConstantName
+    # :nocov:
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+      Class.new(::FrozenError)
+    else
+      Class.new(::RuntimeError)
+    end
+    # :nocov:
+  end
+
+  # @see Qonfig::Commands::LoadFromYAML
+  #
+  # @api public
+  # @since 0.2.0
+  IncompatibleYAMLStructureError = Class.new(Error)
+
+  # @see Qonfig::Loaders::YAML
+  #
+  # @api public
+  # @since 0.2.0
+  FileNotFoundError = Class.new(Errno::ENOENT)
+
+  # @see Qonfig::Commands::LoadFromSelf
+  #
+  # @api public
+  # @since 0.2.0
+  SelfDataNotFoundError = Class.new(Error)
 end

data/lib/qonfig/loaders/yaml.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Qonfig
+  module Loaders
+    # @api private
+    # @since 0.2.0
+    module YAML
+      class << self
+        # @param data [String]
+        # @return [Object]
+        #
+        # @api private
+        # @since 0.2.0
+        def load(data)
+          ::YAML.load(ERB.new(data).result)
+        end
+
+        # @param file_path [String]
+        # @option fail_on_unexist [Boolean]
+        # @return [Object]
+        #
+        # @raise [Qonfig::FileNotFoundError]
+        #
+        # @api private
+        # @since 0.2.0
+        def load_file(file_path, fail_on_unexist: true)
+          load(::File.read(file_path))
+        rescue Errno::ENOENT => error
+          fail_on_unexist ? (raise Qonfig::FileNotFoundError, error.message) : load('{}')
+        end
+      end
+    end
+  end
+end

data/lib/qonfig/settings/builder.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Qonfig
+  class Settings
+    # @api private
+    # @since 0.2.0
+    module Builder
+      class << self
+        # @param [Qonfig::CommandSet]
+        # @return [Qonfig::Settings]
+        #
+        # @api private
+        # @since 0.2.0
+        def build(commands)
+          Qonfig::Settings.new.tap do |settings|
+            commands.each { |command| command.call(settings) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qonfig/settings/key_guard.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Qonfig
+  class Settings
+    # @api private
+    # @since 0.2.0
+    class KeyGuard
+      class << self
+        # @param key [String, Symbol, Object]
+        # @return [void]
+        #
+        # @raise [Qonfig::ArgumentError]
+        # @raise [Qonfig::CoreMethodIntersectionError]
+        #
+        # @api private
+        # @since 0.2.0
+        def prevent_incomparabilities!(key)
+          new(key).prevent_incomparabilities!
+        end
+      end
+
+      # @return [String, Symbol, Object]
+      #
+      # @api private
+      # @sicne 0.2.0
+      attr_reader :key
+
+      # @param key [String, Symbol, Object]
+      #
+      # @api private
+      # @since 0.2.0
+      def initialize(key)
+        @key = key
+      end
+
+      # @return [void]
+      #
+      # @raise [Qonfig::ArgumentError]
+      # @raise [Qonfig::CoreMethodIntersectionError]
+      #
+      # @api private
+      # @since 0.2.0
+      def prevent_incomparabilities!
+        prevent_incompatible_key_type!
+        prevent_core_method_intersection!
+      end
+
+      # @return [void]
+      #
+      # @raise [Qonfig::ArgumentError]
+      #
+      # @api private
+      # @since 0.2.0
+      def prevent_incompatible_key_type!
+        raise(
+          Qonfig::ArgumentError,
+          'Setting key should be a symbol or a string!'
+        ) unless key.is_a?(Symbol) || key.is_a?(String)
+      end
+
+      # @return [void]
+      #
+      # @raise [Qonfig::CoreMethodIntersectionError]
+      #
+      # @api private
+      # @since 0.2.0
+      def prevent_core_method_intersection!
+        raise(
+          Qonfig::CoreMethodIntersectionError,
+          "<#{key}> key can not be used since this is a private core method"
+        ) if Qonfig::Settings::CORE_METHODS.include?(key.to_s)
+      end
+    end
+  end
+end

data/lib/qonfig/settings/lock.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Qonfig
+  class Settings
+    # @api private
+    # @since 0.2.0
+    class Lock
+      # @api private
+      # @since 0.2.0
+      def initialize
+        @definition_lock = Mutex.new
+        @access_lock = Mutex.new
+        @merge_lock = Mutex.new
+      end
+
+      # @param instructions [Proc]
+      # @return [Object]
+      #
+      # @api private
+      # @since 0.2.0
+      def thread_safe_definition(&instructions)
+        definition_lock.synchronize(&instructions)
+      end
+
+      # @param instructions [Proc]
+      # @return [Object]
+      #
+      # @api private
+      # @since 0.2.0
+      def thread_safe_access(&instructions)
+        access_lock.synchronize(&instructions)
+      end
+
+      # @param instructions [Proc]
+      # @return [Object]
+      #
+      # @api private
+      # @since 0.2.0
+      def thread_safe_merge(&instructions)
+        merge_lock.synchronize(&instructions)
+      end
+
+      private
+
+      # @return [Mutex]
+      #
+      # @api private
+      # @since 0.2.0
+      attr_reader :definition_lock
+
+      # @return [Mutex]
+      #
+      # @api private
+      # @since 0.2.0
+      attr_reader :access_lock
+
+      # @return [Mutex]
+      #
+      # @api private
+      # @since 0.2.0
+      attr_reader :merge_lock
+    end
+  end
+end