qonfig 0.10.0 → 0.11.0

data/lib/qonfig/uploaders/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.11.0
+class Qonfig::Uploaders::Base
+  class << self
+    # @param settings [Qonfig::Settings]
+    # @param options [Hash<Symbol,Any>]
+    # @param value_procssor [Block]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.11.0
+    def upload(settings, options: {}, &value_processor)
+      nil # NOTE: consciously return nil (for clarity)
+    end
+  end
+end

data/lib/qonfig/uploaders/file.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.11.0
+class Qonfig::Uploaders::File < Qonfig::Uploaders::Base
+  # @return [String]
+  #
+  # @api private
+  # @since 0.11.0
+  FILE_OPENING_MODE = 'w'
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.11.0
+  EMPTY_SETTINGS_REPRESENTATION = ''
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.11.0
+  DEFAULT_OPTIONS = {}.freeze
+
+  class << self
+    # @param settings [Qonfig::Settings]
+    # @param options [Hash<Symbol|String,Any>]
+    # @param value_processor [Block]
+    # @option path [String]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.11.0
+    def upload(settings, path:, options: self::DEFAULT_OPTIONS, &value_processor)
+      ::File.open(path, FILE_OPENING_MODE) do |file_descriptor|
+        settings_representation = represent_settings(settings, options, &value_processor)
+        file_descriptor.write(settings_representation)
+      end
+    end
+
+    private
+
+    # @param settings [Qonfig::Settings]
+    # @param options [Hash<Symbol|String,Any>]
+    # @param value_processor [Block]
+    # @return [String]
+    #
+    # @api private
+    # @since 0.11.0
+    def represent_settings(settings, options, &value_processor)
+      # :nocov:
+      EMPTY_SETTINGS_REPRESENTATION
+      # :nocov:
+    end
+  end
+end

data/lib/qonfig/uploaders/json.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.11.0
+class Qonfig::Uploaders::JSON < Qonfig::Uploaders::File
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api private
+  # @since 0.11.0
+  DEFAULT_OPTIONS = {
+    indent: ' ',
+    space: ' ',
+    object_nl: "\n"
+  }.freeze
+
+  class << self
+    # @param settings [Qonfig::Settings]
+    # @param options [Hash<Symbol,Any>]
+    # @param value_processor [Block]
+    # @return [String]
+    #
+    # @api private
+    # @since 0.11.0
+    def represent_settings(settings, options, &value_processor)
+      settings_hash =
+        if block_given?
+          settings.__to_hash__(transform_value: value_processor)
+        else
+          settings.__to_hash__
+        end
+
+      ::JSON.generate(settings_hash, options)
+    end
+  end
+end

data/lib/qonfig/uploaders/yaml.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.11.0
+class Qonfig::Uploaders::YAML < Qonfig::Uploaders::File
+  # @api private
+  # @since 0.11.0
+  class YAMLRepresenter < Psych::Visitors::YAMLTree
+    # Needed for using the '~' symbol used for null value representation in YAML files
+    # (instead of space symbol (' ')) (see psych/lib/psych/visitors/yaml_tree.rb)
+    #
+    # @param object [Any]
+    # @return [Any]
+    #
+    # @api private
+    # @since 0.11.0
+    def visit_NilClass(object) # rubocop:disable Naming/MethodName
+      @emitter.scalar('~', nil, 'tag:yaml.org,2002:null', true, false, Psych::Nodes::Scalar::ANY)
+    end
+  end
+
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api private
+  # @since 0.11.0
+  DEFAULT_OPTIONS = {
+    indentation: 2,
+    line_width: -1,
+    canonical: false,
+    header: false,
+    symbolize_keys: false
+  }.freeze
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.11.0
+  KEY_SYMBOLIZER = -> (value) { value.to_sym }.freeze
+
+  class << self
+    # @param settings [Qonfig::Settings]
+    # @param options [Hash<Symbol,Any>]
+    # @param value_processor [Block]
+    # @return [String]
+    #
+    # @api private
+    # @since 0.11.0
+    def represent_settings(settings, options, &value_processor)
+      settings_hash_opts = hash_representation_options(options, &value_processor)
+      settings_hash = settings.__to_hash__(settings_hash_opts)
+      to_yaml_string(settings_hash, options)
+    end
+
+    # @param options [Hash<Symbol|String,Any>]
+    # @param value_processor [Block]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.11.0
+    def hash_representation_options(options, &value_processor)
+      {}.tap do |representation_opts|
+        # NOTE: this case/when with the same logic is only used for better code readbility
+        case
+        # NOTE: options has :symbolize_keys key
+        when options.key?(:symbolize_keys) && !!options[:symbolize_keys]
+          representation_opts[:transform_key] = KEY_SYMBOLIZER
+        # NOTE: options does not have :symbolize_keys key
+        when !options.key?(:symbolize_keys) && DEFAULT_OPTIONS[:symbolize_keys]
+          # :nocov:
+          representation_opts[:transform_key] = KEY_SYMBOLIZER
+          # :nocov:
+        end
+
+        # NOTE: provide value transformer
+        if block_given?
+          representation_opts[:transform_value] = value_processor
+        end
+      end
+    end
+
+    # @param settings_hash [Hash<String|Symbol,Any>]
+    # @param yaml_options [Hash<Symbol,Any>]
+    # @return [String]
+    #
+    # @api private
+    # @since 0.11.0
+    def to_yaml_string(settings_hash, yaml_options)
+      representer = YAMLRepresenter.create(yaml_options)
+      representer << settings_hash
+      representer.tree.yaml(nil, yaml_options)
+    end
+  end
+end

data/lib/qonfig/uploaders.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.11.0
+module Qonfig::Uploaders
+  require_relative 'uploaders/base'
+  require_relative 'uploaders/file'
+  require_relative 'uploaders/json'
+  require_relative 'uploaders/yaml'
+end

data/lib/qonfig/version.rb

@@ -5,5 +5,5 @@ module Qonfig
   #
   # @api public
   # @since 0.1.0
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

data/lib/qonfig.rb

@@ -5,33 +5,16 @@ require 'json'
 require 'erb'
 
 module Qonfig
-  require_relative 'qonfig/error'
-  require_relative 'qonfig/loaders/basic'
-  require_relative 'qonfig/loaders/json'
-  require_relative 'qonfig/loaders/yaml'
-  require_relative 'qonfig/commands/base'
-  require_relative 'qonfig/commands/add_option'
-  require_relative 'qonfig/commands/add_nested_option'
-  require_relative 'qonfig/commands/compose'
-  require_relative 'qonfig/commands/load_from_yaml'
-  require_relative 'qonfig/commands/load_from_json'
-  require_relative 'qonfig/commands/load_from_self'
-  require_relative 'qonfig/commands/load_from_env'
-  require_relative 'qonfig/commands/load_from_env/value_converter'
-  require_relative 'qonfig/commands/expose_yaml'
+  require_relative 'qonfig/exceptions'
+  require_relative 'qonfig/loaders'
+  require_relative 'qonfig/uploaders'
+  require_relative 'qonfig/commands'
   require_relative 'qonfig/command_set'
   require_relative 'qonfig/settings'
-  require_relative 'qonfig/settings/lock'
-  require_relative 'qonfig/settings/builder'
-  require_relative 'qonfig/settings/key_guard'
   require_relative 'qonfig/dsl'
   require_relative 'qonfig/data_set'
-  require_relative 'qonfig/data_set/class_builder'
   require_relative 'qonfig/configurable'
-  require_relative 'qonfig/plugins/registry'
   require_relative 'qonfig/plugins'
-  require_relative 'qonfig/plugins/access_mixin'
-  require_relative 'qonfig/plugins/abstract'
 
   # @api public
   # @since 0.4.0

data/qonfig.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls',        '~> 0.8'
   spec.add_development_dependency 'simplecov',        '~> 0.16'
   spec.add_development_dependency 'rspec',            '~> 3.8'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.21'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.30'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-26 00:00:00.000000000 Z
+date: 2019-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.30'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,7 @@ files:
 - bin/setup
 - lib/qonfig.rb
 - lib/qonfig/command_set.rb
+- lib/qonfig/commands.rb
 - lib/qonfig/commands/add_nested_option.rb
 - lib/qonfig/commands/add_option.rb
 - lib/qonfig/commands/base.rb
@@ -147,7 +148,8 @@ files:
 - lib/qonfig/data_set/class_builder.rb
 - lib/qonfig/data_set/validator.rb
 - lib/qonfig/dsl.rb
-- lib/qonfig/error.rb
+- lib/qonfig/exceptions.rb
+- lib/qonfig/loaders.rb
 - lib/qonfig/loaders/basic.rb
 - lib/qonfig/loaders/json.rb
 - lib/qonfig/loaders/yaml.rb
@@ -159,6 +161,11 @@ files:
 - lib/qonfig/settings/builder.rb
 - lib/qonfig/settings/key_guard.rb
 - lib/qonfig/settings/lock.rb
+- lib/qonfig/uploaders.rb
+- lib/qonfig/uploaders/base.rb
+- lib/qonfig/uploaders/file.rb
+- lib/qonfig/uploaders/json.rb
+- lib/qonfig/uploaders/yaml.rb
 - lib/qonfig/version.rb
 - qonfig.gemspec
 homepage: https://github.com/0exp/qonfig
@@ -180,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Config object