qonfig 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e73813f816c3ed07773bfd932c9d4d628688327326463d5d7a2755058acd49bc
-  data.tar.gz: 513fe5d381b2cbddddb6e5bc0f10f518b3cae24dce6f8689810600a22698396f
+  metadata.gz: bc263b67aa4feb6e9c42f6f5f593e61dec61e758e7d7de41f4d36fc40bee18a6
+  data.tar.gz: f2e3e3f49318c392749c742a299edea3e58169bb5fc13930517a1c39cede4c91
 SHA512:
-  metadata.gz: 1855afada5513df5986bd45b2d4ce8d747f6389886763841ace0b4cd6a2f1b063c69feaff8075da4b803cee23cc335c3b4a6cfa434a328d1d9b43080e7b65b54
-  data.tar.gz: 7990a53bd25a8c6d0f78c8daff1453b4e14d2c9b380dde31e813499829d28f9667d8ae30e886a51ea5f8c5d2392d3bef9c23315afd7314a8c54bb008bac77ae1
+  metadata.gz: 46a9fd484859f615746bb5f1c21df8024ebd1766cc40353c313276b759795ec11b61e479306d3fb9f3f3e3764455ec06541746d827c56de0145c13838ccae6de
+  data.tar.gz: 491d96820bd2be04f8dde6d103598643d26dfafbf13a50a150a5b1c8469b8a4a726d02aeb35d9450a5a3785ee8fe3e7cc865c68e6080cd2f74701a20465de304

data/.gitignore

@@ -11,3 +11,4 @@ Gemfile.lock
 /.idea
 .ruby-version
 /.vscode/
+/spec/artifacts/

data/.rspec

@@ -1,3 +1,3 @@
 --color
---format=progress
+--format progress
 --require spec_helper

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.6.1
+  TargetRubyVersion: 2.6.3
   Include:
     - lib/**/*.rb
     - spec/**/*.rb

data/.travis.yml

@@ -3,9 +3,9 @@ matrix:
   fast_finish: true
   include:
   - rvm: 2.3.8
-  - rvm: 2.4.5
-  - rvm: 2.5.3
-  - rvm: 2.6.1
+  - rvm: 2.4.6
+  - rvm: 2.5.5
+  - rvm: 2.6.3
   - rvm: ruby-head
   - rvm: jruby-head
   allow_failures:

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.11.0] - 2019-05-15
+### Added
+- `#save_to_json` - save configurations to a json file (uses native `::JSON.generate` under the hood);
+- `#save_to_yaml` - save configurations to a yaml file (uses native `::Psych.dump` under the hood);
+
+### Changed
+- new `#to_h` signature: `#to_h(key_transformer:, value_transformer:)`
+  - `:key_transformer` - proc object used for key pre-processing (`-> (key) { key }` by default);
+  - `:value_transformer` - proc object used for value pre-processing (`-> (value) { value }` by default);
+
 ## [0.10.0] - 2019-02-26
 ### Added
 - `#slice_value` - get a slice of config options as a hash set and fetch the required value using the given key set;

data/README.md

@@ -22,7 +22,6 @@ require 'qonfig'
 ## Usage
 
 - [Definition and Settings Access](#definition-and-access)
-- [Dynamic value calculation](???)
 - [Configuration](#configuration)
 - [Inheritance](#inheritance)
 - [Composition](#composition)
@@ -36,6 +35,8 @@ require 'qonfig'
 - [Load from JSON file](#load-from-json-file)
 - [Load from ENV](#load-from-env)
 - [Load from \_\_END\_\_](#load-from-__end__) (aka `load_from_self`)
+- [Save to JSON file](#save-to-json-file) (`save_to_json`)
+- [Save to YAML file](#save-to-yaml-file) (`save_to_yaml`)
 - [Smart Mixin](#smart-mixin) (`Qonfig::Configurable`)
 - [Plugins](#plugins)
 
@@ -777,6 +778,150 @@ connection_timeout:
 
 ---
 
+### Save to JSON file
+
+- `#save_to_json` - represents config object as a json structure and saves it to a file:
+  - uses native `::JSON.generate` under the hood;
+  - writes new file (or rewrites existing file);
+  - attributes:
+    - `:path` - (required) - file path;
+    - `:options` - (optional) - native `::JSON.generate` options (from stdlib):
+      - `:indent` - `" "` by default;
+      - `:space` - `" "` by default/
+      - `:object_nl` - `"\n"` by default;
+    - `&value_preprocessor` - (optional) - value pre-processor;
+
+#### Without value preprocessing (standard usage)
+
+```ruby
+class AppConfig < Qonfig::DataSet
+  setting :server do
+    setting :address, 'localhost'
+    setting :port, 12_345
+  end
+
+  setting :enabled, true
+end
+
+config = AppConfig.new
+
+# NOTE: save to json file
+config.save_to_json(path: 'config.json')
+```
+
+```json
+{
+ "sentry": {
+  "address": "localhost",
+  "port": 12345
+ },
+ "enabled": true
+}
+```
+
+#### With value preprocessing
+
+```ruby
+class AppConfig < Qonfig::DataSet
+  setting :server do
+    setting :address, 'localhost'
+    setting :port, 12_345
+  end
+
+  setting :enabled, true
+  setting :dynamic, -> { 1 + 2 }
+end
+
+config = AppConfig.new
+
+# NOTE: save to json file with custom options (no spaces / no new line / no indent; call procs)
+config.save_to_json(path: 'config.json', options: { indent: '', space: '', object_nl: '' }) do |value|
+  value.is_a?(Proc) ? value.call : value
+end
+```
+
+```json
+// no spaces / no new line / no indent / calculated "dynamic" setting key
+{"sentry":{"address":"localhost","port":12345},"enabled":true,"dynamic":3}
+```
+
+---
+
+### Save to YAML file
+
+- `#save_to_yaml` - represents config object as a yaml structure and saves it to a file:
+  - uses native `::Psych.dump` under the hood;
+  - writes new file (or rewrites existing file);
+  - attributes:
+    - `:path` - (required) - file path;
+    - `:options` - (optional) - native `::Psych.dump` options (from stdlib):
+      - `:indentation` - `2` by default;
+      - `:line_width` - `-1` by default;
+      - `:canonical` - `false` by default;
+      - `:header` - `false` by default;
+      - `:symbolize_keys` - (non-native option) - `false` by default;
+    - `&value_preprocessor` - (optional) - value pre-processor;
+
+#### Without value preprocessing (standard usage)
+
+```ruby
+class AppConfig < Qonfig::DataSet
+  setting :server do
+    setting :address, 'localhost'
+    setting :port, 12_345
+  end
+
+  setting :enabled, true
+end
+
+config = AppConfig.new
+
+# NOTE: save to yaml file
+config.save_to_yaml(path: 'config.yml')
+```
+
+```yaml
+---
+server:
+  address: localhost
+  port: 12345
+enabled: true
+```
+
+#### With value preprocessing and custom options
+
+```ruby
+class AppConfig < Qonfig::DataSet
+  setting :server do
+    setting :address, 'localhost'
+    setting :port, 12_345
+  end
+
+  setting :enabled, true
+  setting :dynamic, -> { 5 + 5 }
+end
+
+config = AppConfig.new
+
+# NOTE: save to yaml file with custom options (add yaml version header; call procs)
+config.save_to_yaml(path: 'config.yml', options: { header: true }) do |value|
+  value.is_a?(Proc) ? value.call : value
+end
+```
+
+```yaml
+# yaml version header / calculated "dynamic" setting key
+%YAML 1.1
+---
+server:
+  address: localhost
+  port: 12345
+enabled: true
+dynamic: 10
+```
+
+---
+
 ### Smart Mixin
 
 - class-level:

data/Rakefile

@@ -4,6 +4,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop'
 require 'rubocop-rspec'
+require 'rubocop-performance'
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new(:rubocop) do |t|
@@ -11,6 +12,7 @@ RuboCop::RakeTask.new(:rubocop) do |t|
 
   t.options = ['--config', config_path]
   t.requires << 'rubocop-rspec'
+  t.requires << 'rubocop-performance'
 end
 
 RSpec::Core::RakeTask.new(:rspec)

data/lib/qonfig/command_set.rb

@@ -1,69 +1,67 @@
 # frozen_string_literal: true
 
-module Qonfig
+# @api private
+# @since 0.1.0
+class Qonfig::CommandSet
+  # @return [Array<Qonfig::Commands::Base>]
+  #
   # @api private
   # @since 0.1.0
-  class CommandSet
-    # @return [Array<Qonfig::Commands::Base>]
-    #
-    # @api private
-    # @since 0.1.0
-    attr_reader :commands
+  attr_reader :commands
 
-    # @api private
-    # @since 0.1.0
-    def initialize
-      @commands = []
-      @access_lock = Mutex.new
-    end
+  # @api private
+  # @since 0.1.0
+  def initialize
+    @commands = []
+    @access_lock = Mutex.new
+  end
 
-    # @param command [Qonfig::Commands::Base]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.1.0
-    def add_command(command)
-      thread_safe { commands << command }
-    end
-    alias_method :<<, :add_command
+  # @param command [Qonfig::Commands::Base]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def add_command(command)
+    thread_safe { commands << command }
+  end
+  alias_method :<<, :add_command
 
-    # @param block [Proc]
-    # @return [Enumerable]
-    #
-    # @api private
-    # @since 0.1.0
-    def each(&block)
-      thread_safe { block_given? ? commands.each(&block) : commands.each }
-    end
+  # @param block [Proc]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.0
+  def each(&block)
+    thread_safe { block_given? ? commands.each(&block) : commands.each }
+  end
 
-    # @param command_set [Qonfig::CommandSet]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.1.0
-    def concat(command_set)
-      thread_safe { commands.concat(command_set.commands) }
-    end
+  # @param command_set [Qonfig::CommandSet]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def concat(command_set)
+    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
+  # @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
+  private
 
-    # @param block [Proc]
-    # @return [Object]
-    #
-    # @api private
-    # @since 0.2.0
-    def thread_safe(&block)
-      @access_lock.synchronize(&block)
-    end
+  # @param block [Proc]
+  # @return [Object]
+  #
+  # @api private
+  # @since 0.2.0
+  def thread_safe(&block)
+    @access_lock.synchronize(&block)
   end
 end

data/lib/qonfig/commands/add_nested_option.rb

@@ -1,49 +1,45 @@
 # frozen_string_literal: true
 
-module Qonfig
-  module Commands
-    # @api private
-    # @since 0.1.0
-    class AddNestedOption < Base
-      # @return [Symbol, String]
-      #
-      # @api private
-      # @since 0.1.0
-      attr_reader :key
+# @api private
+# @since 0.1.0
+class Qonfig::Commands::AddNestedOption < Qonfig::Commands::Base
+  # @return [Symbol, String]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :key
 
-      # @return [Class<Qonfig::DataSet>]
-      #
-      # @api private
-      # @since 0.2.0
-      attr_reader :nested_data_set_klass
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :nested_data_set_klass
 
-      # @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)
+  # @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_data_set_klass = Class.new(Qonfig::DataSet).tap do |data_set|
-          data_set.instance_eval(&nested_definitions)
-        end
-      end
+    @key = key
+    @nested_data_set_klass = Class.new(Qonfig::DataSet).tap do |data_set|
+      data_set.instance_eval(&nested_definitions)
+    end
+  end
 
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.1.0
-      def call(settings)
-        nested_settings = nested_data_set_klass.new.settings
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(settings)
+    nested_settings = nested_data_set_klass.new.settings
 
-        settings.__define_setting__(key, nested_settings)
-      end
-    end
+    settings.__define_setting__(key, nested_settings)
   end
 end

data/lib/qonfig/commands/add_option.rb

@@ -1,45 +1,41 @@
 # frozen_string_literal: true
 
-module Qonfig
-  module Commands
-    # @api private
-    # @since 0.1.0
-    class AddOption < Base
-      # @return [Symbol, String]
-      #
-      # @api private
-      # @since 0.1.0
-      attr_reader :key
+# @api private
+# @since 0.1.0
+class Qonfig::Commands::AddOption < Qonfig::Commands::Base
+  # @return [Symbol, String]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :key
 
-      # @return [Object]
-      #
-      # @api private
-      # @since 0.1.0
-      attr_reader :value
+  # @return [Object]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :value
 
-      # @param key [Symbol, String]
-      # @param value [Object]
-      #
-      # @raise [Qonfig::ArgumentError]
-      # @raise [Qonfig::CoreMethodIntersectionError]
-      #
-      # @api private
-      # @since 0.1.0
-      def initialize(key, value)
-        Qonfig::Settings::KeyGuard.prevent_incomparabilities!(key)
+  # @param key [Symbol, String]
+  # @param value [Object]
+  #
+  # @raise [Qonfig::ArgumentError]
+  # @raise [Qonfig::CoreMethodIntersectionError]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(key, value)
+    Qonfig::Settings::KeyGuard.prevent_incomparabilities!(key)
 
-        @key = key
-        @value = value
-      end
+    @key = key
+    @value = value
+  end
 
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.1.0
-      def call(settings)
-        settings.__define_setting__(key, value)
-      end
-    end
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(settings)
+    settings.__define_setting__(key, value)
   end
 end

data/lib/qonfig/commands/base.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-module Qonfig
-  module Commands
-    # @api private
-    # @since 0.1.0
-    class Base
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.1.0
-      def call(settings); end
-    end
-  end
+# @api private
+# @since 0.1.0
+class Qonfig::Commands::Base
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(settings); end
 end

data/lib/qonfig/commands/compose.rb

@@ -1,41 +1,37 @@
 # frozen_string_literal: true
 
-module Qonfig
-  module Commands
-    # @api private
-    # @since 0.1.0
-    class Compose < Base
-      # @return [Qonfig::DataSet]
-      #
-      # @api private
-      # @since 0.1.0
-      attr_reader :data_set_klass
+# @api private
+# @since 0.1.0
+class Qonfig::Commands::Compose < Qonfig::Commands::Base
+  # @return [Qonfig::DataSet]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :data_set_klass
 
-      # @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
+  # @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_set_klass = data_set_klass
+  end
 
-      # @param settings [Qonfig::Settings]
-      # @return [void]
-      #
-      # @api private
-      # @since 0.1.0
-      def call(settings)
-        composite_settings = data_set_klass.new.settings
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(settings)
+    composite_settings = data_set_klass.new.settings
 
-        settings.__append_settings__(composite_settings)
-      end
-    end
+    settings.__append_settings__(composite_settings)
   end
 end