qonfig 0.0.0 → 0.12.0

data/lib/qonfig/settings/builder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module Qonfig::Settings::Builder
+  class << self
+    # @param commands [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

data/lib/qonfig/settings/key_guard.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class Qonfig::Settings::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

data/lib/qonfig/settings/lock.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class Qonfig::Settings::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

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/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/version.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
 module Qonfig
-  VERSION = "0.0.0"
+  # @return [String]
+  #
+  # @api public
+  # @since 0.1.0
+  VERSION = '0.12.0'
 end

data/qonfig.gemspec

@@ -1,27 +1,39 @@
+# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "qonfig/version"
+require 'qonfig/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "qonfig"
-  spec.version       = Qonfig::VERSION
-  spec.authors       = ["Rustam Ibragimov"]
-  spec.email         = ["iamdaiver@icloud.com"]
+  spec.required_ruby_version = '>= 2.3.8'
 
-  spec.summary       = "Soon"
-  spec.description   = "Soon"
-  spec.homepage      = "https://github.com/0exp/qonfig"
-  spec.license       = "MIT"
+  spec.name        = 'qonfig'
+  spec.version     = Qonfig::VERSION
+  spec.authors     = ['Rustam Ibragimov']
+  spec.email       = ['iamdaiver@icloud.com']
+  spec.summary     = 'Config object'
+  spec.description = 'Config. Defined as a class. Used as an instance. ' \
+                     'Support for inheritance and composition. ' \
+                     'Lazy instantiation. Thread-safe. Command-style DSL. ' \
+                     'Extremely simple to define. Extremely simple to use. That\'s all.'
+  spec.homepage    = 'https://github.com/0exp/qonfig'
+  spec.license     = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  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.73'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,58 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2019-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: armitage-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.73'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: Soon
+        version: '0.73'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Config. Defined as a class. Used as an instance. Support for inheritance
+  and composition. Lazy instantiation. Thread-safe. Command-style DSL. Extremely simple
+  to define. Extremely simple to use. That's all.
 email:
 - iamdaiver@icloud.com
 executables: []
@@ -60,16 +118,65 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".jrubyrc"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
 - bin/setup
+- gemfiles/with_external_deps.gemfile
+- gemfiles/without_external_deps.gemfile
 - 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
+- lib/qonfig/commands/compose.rb
+- lib/qonfig/commands/expose_yaml.rb
+- lib/qonfig/commands/load_from_env.rb
+- lib/qonfig/commands/load_from_env/value_converter.rb
+- lib/qonfig/commands/load_from_json.rb
+- lib/qonfig/commands/load_from_self.rb
+- lib/qonfig/commands/load_from_yaml.rb
+- lib/qonfig/configurable.rb
+- lib/qonfig/data_set.rb
+- lib/qonfig/data_set/class_builder.rb
+- lib/qonfig/data_set/validator.rb
+- lib/qonfig/dsl.rb
+- lib/qonfig/errors.rb
+- lib/qonfig/loaders.rb
+- lib/qonfig/loaders/basic.rb
+- lib/qonfig/loaders/json.rb
+- lib/qonfig/loaders/yaml.rb
+- lib/qonfig/plugins.rb
+- lib/qonfig/plugins/abstract.rb
+- lib/qonfig/plugins/access_mixin.rb
+- lib/qonfig/plugins/registry.rb
+- lib/qonfig/plugins/toml.rb
+- lib/qonfig/plugins/toml/commands/expose_toml.rb
+- lib/qonfig/plugins/toml/commands/load_from_toml.rb
+- lib/qonfig/plugins/toml/data_set.rb
+- lib/qonfig/plugins/toml/dsl.rb
+- lib/qonfig/plugins/toml/loaders/toml.rb
+- lib/qonfig/plugins/toml/tomlrb_fixes.rb
+- lib/qonfig/plugins/toml/uploaders/toml.rb
+- lib/qonfig/settings.rb
+- 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
@@ -84,16 +191,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Soon
+summary: Config object
 test_files: []