qonfig 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 364dfdc09c159ed886729491cc0d066f961b5be382b766d99d57705fca5f88d7
-  data.tar.gz: 9525458cf3d84fa9588ab48805cdb8a5ec0150278a7658986fb6325efcd2d191
+  metadata.gz: 29fa558caa3bd1f96663617174ba854aaf286cf17a08433c8fb4a497fde1d702
+  data.tar.gz: 6f3ad5c3bd5c4e6ca9b81897c11cb8a8edf208d50e86238ade40ccab99832e36
 SHA512:
-  metadata.gz: 6cf8f8df874ebcb636f7862247ada545579f413c030b4d4dde51decb72ed18f38f5af3faa9c595e6cf741f25ab6fc8a09afef4c72133ced1448f12bbe76dbb96
-  data.tar.gz: 785f7e10238601b7f5be5c506d516004eee7d914b451e2a4c0a7e0aebf6257ca0003f19a52bad0c86f35c89713b4a837d5e175cbf71217cbd1f0de1a6950cc45
+  metadata.gz: 0aa25942d38b95a2af5f432af94bd642d8b7074e35f4a53f31b987dab409f3a274853b76eb42fe72f2ca171336e2907eb06309c00062ab3fb188ad1d268c775e
+  data.tar.gz: c7870403e266a21f837bd4789b5a7df74bc06e165a78f4155fb707a4083c165c144ba19e2764610efd3aef802ef0644dfc932abf89be63a7c7553596b495010d

data/.gitignore

@@ -10,3 +10,4 @@
 Gemfile.lock
 /.idea
 .ruby-version
+/.vscode/

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.3.0] - 2018-06-13
+### Added
+- Improved configuration process: `#configure` can take a hash as a configuration `[option key => option]`
+  map of values;
+
+### Changed
+- `#clear!` causes `Qonfig::FrozenSettingsError` if config object is frozen;
+
 ## [0.2.0] - 2018-06-07
 ### Added
 - Instant configuration via block `config = Config.new { |conf| <<your configuration code>> }`;

data/README.md

@@ -26,9 +26,9 @@ require 'qonfig'
 - [Inheritance](#inheritance)
 - [Composition](#composition)
 - [Hash representation](#hash-representation)
-- [State freeze](#state-freeze)
 - [Config reloading](#config-reloading) (reload config definitions and option values)
 - [Clear options](#clear-options) (set to nil)
+- [State freeze](#state-freeze)
 - [Settings as Predicates](#settings-as-predicates)
 - [Load from YAML file](#load-from-yaml-file)
 - [Load from ENV](#load-from-env)
@@ -131,6 +131,23 @@ config = Config.new do |conf|
   conf.geo_api.provider = :amazon_maps
   conf.testing.engine = :crypto_test
 end
+
+# using a hash
+config = Config.new(
+  testing: { engine: :mini_test, parallel: false },
+  geo_api: { provider: :rambler_maps },
+  enable_middlewares: true
+)
+config.configure(enable_middlewares: false)
+
+# using both hash and proc (proc has higher priority)
+config = Config.new(enable_middlewares: true) do |conf|
+  conf.testing.parallel = true
+end
+
+config.configure(geo_api: { provider: nil }) do |conf|
+  conf.testing.engine = :rspec
+end
 ```
 
 ---
@@ -272,11 +289,11 @@ config.settings.logger # => #<Logger:0x00007ff9> (reloaded from defaults)
 config.settings.enable_api # => false (new setting)
 
 # reload with instant configuration
-config.reload! do |conf|
+config.reload!(db: { adapter: 'oracle' }) do |conf|
   conf.enable_api = true # changed instantly
 end
 
-config.settings.db.adapter # => 'mongoid'
+config.settings.db.adapter # => 'oracle'
 config.settings.logger = # => #<Logger:0x00007ff9>
 config.settings.enable_api # => true # value from instant change
 ```
@@ -337,6 +354,7 @@ config.settings.worker = :que # => Qonfig::FrozenSettingsError
 config.settings.db.adapter = 'mongoid' # => Qonfig::FrozenSettingsError
 
 config.reload! # => Qonfig::FrozenSettingsError
+config.clear! # => Qonfig::FrozenSettingsError
 ```
 
 ---
@@ -441,7 +459,7 @@ config.settings.ruby.platform # => 'x86_64-darwin17'
 # --- strict mode ---
 class Config < Qonfig::DataSet
   setting :nonexistent_yaml do
-    load_from_yaml 'unexistent_file.yml', strict: true # true by default
+    load_from_yaml 'nonexistent_yaml.yml', strict: true # true by default
   end
 
   setting :another_key
@@ -452,7 +470,7 @@ Config.new # => Qonfig::FileNotFoundError
 # --- non-strict mode ---
 class Config < Qonfig::DataSet
   settings :nonexistent_yaml do
-    load_from_yaml 'unexistent_file.yml', strict: false
+    load_from_yaml 'nonexistent_yaml.yml', strict: false
   end
 
   setting :another_key
@@ -539,7 +557,7 @@ config.settings['RUN_CI'] # => '1'
 class Config < Qonfig::DataSet
   load_from_self # on the root
 
-  setting :clowd do
+  setting :nested do
     load_from_self # nested
   end
 end

data/lib/qonfig/configurable.rb

@@ -58,14 +58,15 @@ module Qonfig
         end
       end
 
+      # @param options_map [Hash]
       # @param block [Proc]
       # @return [void]
       #
       # @api public
       # @since 0.2.0
-      def configure(&block)
+      def configure(options_map = {}, &block)
         @__qonfig_access_lock__.synchronize do
-          config.configure(&block) if block_given?
+          config.configure(options_map, &block)
         end
       end
 
@@ -93,14 +94,15 @@ module Qonfig
         end
       end
 
+      # @param options_map [Hash]
       # @param block [Proc]
       # @return [void]
       #
       # @api public
       # @since 0.2.0
-      def configure(&block)
+      def configure(options_map = {}, &block)
         self.class.instance_variable_get(:@__qonfig_access_lock__).synchronize do
-          config.configure(&block) if block_given?
+          config.configure(options_map, &block)
         end
       end
     end

data/lib/qonfig/data_set.rb

@@ -13,15 +13,16 @@ module Qonfig
     # @since 0.1.0
     attr_reader :settings
 
+    # @param options_map [Hash]
     # @param configurations [Proc]
     #
     # @api public
     # @since 0.1.0
-    def initialize(&configurations)
+    def initialize(options_map = {}, &configurations)
       @__access_lock__ = Mutex.new
       @__definition_lock__ = Mutex.new
 
-      thread_safe_definition { load!(&configurations) }
+      thread_safe_definition { load!(options_map, &configurations) }
     end
 
     # @return [void]
@@ -40,6 +41,7 @@ module Qonfig
       thread_safe_access { settings.__is_frozen__ }
     end
 
+    # @param options_map [Hash]
     # @param configurations [Proc]
     # @return [void]
     #
@@ -47,19 +49,23 @@ module Qonfig
     #
     # @api public
     # @since 0.2.0
-    def reload!(&configurations)
+    def reload!(options_map = {}, &configurations)
       thread_safe_definition do
         raise Qonfig::FrozenSettingsError, 'Frozen config can not be reloaded' if frozen?
-        load!(&configurations)
+        load!(options_map, &configurations)
       end
     end
 
+    # @param options_map [Hash]
     # @return [void]
     #
     # @api public
     # @since 0.1.0
-    def configure
-      thread_safe_access { yield(settings) if block_given? }
+    def configure(options_map = {})
+      thread_safe_access do
+        settings.__apply_values__(options_map)
+        yield(settings) if block_given?
+      end
     end
 
     # @return [Hash]
@@ -107,14 +113,15 @@ module Qonfig
       Qonfig::Settings::Builder.build(self.class.commands.dup)
     end
 
+    # @param options_map [Hash]
     # @param configurations [Proc]
     # @return [void]
     #
     # @api private
     # @since 0.2.0
-    def load!(&configurations)
+    def load!(options_map = {}, &configurations)
       @settings = build_settings
-      configure(&configurations) if block_given?
+      configure(options_map, &configurations)
     end
 
     # @param instructions [Proc]

data/lib/qonfig/settings.rb

@@ -76,6 +76,15 @@ module Qonfig
       __lock__.thread_safe_access { __set_value__(key, value) }
     end
 
+    # @param options_map [Hash]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def __apply_values__(options_map)
+      __lock__.thread_safe_access { __set_values_from_map__(options_map) }
+    end
+
     # @param keys [Array<String, Symbol>]
     # @return [Object]
     #
@@ -114,7 +123,7 @@ module Qonfig
     def method_missing(method_name, *arguments, &block)
       super
     rescue NoMethodError
-      raise Qonfig::UnknownSettingError, "Setting with <#{method_name}> key doesnt exist!"
+      ::Kernel.raise(Qonfig::UnknownSettingError, "Setting with <#{method_name}> key doesnt exist!")
     end
 
     # @return [Boolean]
@@ -151,11 +160,54 @@ module Qonfig
 
     private
 
+    # @return [Qonfig::Settings::Lock]
+    #
+    # @api private
+    # @since 0.2.0
+    attr_reader :__lock__
+
+    # @param options_map [Hash]
     # @return [void]
     #
+    # @raise [Qonfig::ArgumentError]
+    # @raise [Qonfig::AmbiguousSettingValueError]
+    #
+    # @api private
+    # @since 0.3.0
+    def __set_values_from_map__(options_map)
+      ::Kernel.raise(
+        Qonfig::ArgumentError, 'Options map should be represented as a hash'
+      ) unless options_map.is_a?(Hash)
+
+      options_map.each_pair do |key, value|
+        current_value = __get_value__(key)
+
+        # NOTE: some duplications here was made only for the better code readability
+        case
+        when !current_value.is_a?(Qonfig::Settings)
+          __set_value__(key, value)
+        when current_value.is_a?(Qonfig::Settings) && value.is_a?(Hash)
+          current_value.__apply_values__(value)
+        when current_value.is_a?(Qonfig::Settings) && !value.is_a?(Hash)
+          ::Kernel.raise(
+            Qonfig::AmbiguousSettingValueError,
+            "Can not redefine option <#{key}> that contains nested options"
+          )
+        end
+      end
+    end
+
+    # @return [void]
+    #
+    # @raise [Qonfig::FrozenSettingsError]
+    #
     # @api private
     # @since 0.2.0
     def __clear_option_values__
+      ::Kernel.raise(
+        Qonfig::FrozenSettingsError, 'Can not modify frozen settings'
+      ) if __options__.frozen?
+
       __options__.each_pair do |key, value|
         if value.is_a?(Qonfig::Settings)
           value.__clear__
@@ -176,7 +228,7 @@ module Qonfig
       key = __indifferently_accessable_option_key__(key)
 
       unless __options__.key?(key)
-        raise Qonfig::UnknownSettingError, "Setting with <#{key}> key does not exist!"
+        ::Kernel.raise(Qonfig::UnknownSettingError, "Setting with <#{key}> key does not exist!")
       end
 
       __options__[key]
@@ -196,15 +248,18 @@ module Qonfig
       key = __indifferently_accessable_option_key__(key)
 
       unless __options__.key?(key)
-        raise Qonfig::UnknownSettingError, "Setting with <#{key}> key does not exist!"
+        ::Kernel.raise(Qonfig::UnknownSettingError, "Setting with <#{key}> key does not exist!")
       end
 
       if __options__.frozen?
-        raise Qonfig::FrozenSettingsError, 'Can not modify frozen settings'
+        ::Kernel.raise(Qonfig::FrozenSettingsError, 'Can not modify frozen settings')
       end
 
       if __options__[key].is_a?(Qonfig::Settings)
-        raise Qonfig::AmbiguousSettingValueError, 'Can not redefine option with nested options'
+        ::Kernel.raise(
+          Qonfig::AmbiguousSettingValueError,
+          "Can not redefine option <#{key}> that contains nested options"
+        )
       end
 
       __options__[key] = value
@@ -220,7 +275,7 @@ module Qonfig
     # @api private
     # @since 0.2.0
     def __deep_access__(*keys)
-      raise Qonfig::ArgumentError, 'Key list can not be empty' if keys.empty?
+      ::Kernel.raise(Qonfig::ArgumentError, 'Key list can not be empty') if keys.empty?
 
       result = __get_value__(keys.first)
       rest_keys = Array(keys[1..-1])
@@ -229,18 +284,15 @@ module Qonfig
       when rest_keys.empty?
         result
       when !result.is_a?(Qonfig::Settings)
-        raise(Qonfig::UnknownSettingError, 'Setting with required digging sequence does not exist!')
+        ::Kernel.raise(
+          Qonfig::UnknownSettingError,
+          'Setting with required digging sequence does not exist!'
+        )
       when result.is_a?(Qonfig::Settings)
         result.__dig__(*rest_keys)
       end
     end
 
-    # @return [Qonfig::Settings::Lock]
-    #
-    # @api private
-    # @since 0.2.0
-    attr_reader :__lock__
-
     # @param options_part [Hash]
     # @return [Hash]
     #
@@ -310,7 +362,7 @@ module Qonfig
     CORE_METHODS = Array(
       instance_methods(false) |
       private_instance_methods(false) |
-      %i[super raise define_singleton_method]
+      %i[super define_singleton_method self]
     ).map(&:to_s).freeze
   end
 

data/lib/qonfig/version.rb

@@ -2,6 +2,6 @@
 
 module Qonfig
   # @api public
-  # @since 0.2.0
-  VERSION = '0.2.0'
+  # @since 0.3.0
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-07 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls