qonfig 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 881009df231adc7035ec25267ffe8d63a58a66878eb5017cc8a8f2084bd5753d
-  data.tar.gz: de6d094271c5a42737b1f868cb5e6ec61d4e1c15090bf69249f4147ae168ae15
+  metadata.gz: 985a8b16d7fd6a86ec41fea68569c83f283e60f293ac8bca047ad4b0ca21b563
+  data.tar.gz: b94a684b24f696a67ce8c6a5ff2ceec98da628a9768ce6689fe1bd4a49ef130c
 SHA512:
-  metadata.gz: d65fa945c02683ed445089bfec0f558eda6db5e34157ed315b781cf4410302b5c9a7908580f484ea82657a211674d1a04615291ec81e3fda127d45accf060858
-  data.tar.gz: 6dab7357d7315839c5aeeb8a3a67b53cda1ad535847635ba099f37a979d43517c1b464d85eb7b37bd85c5864c5ee6ac8eb3eadce5ea3bb7f23367a45b34fe30c
+  metadata.gz: cc879948b2e2a88aa1e207802d6cc7870944af239d67a0ab8e0c1dea21e8410eb0dd4d7063830f8ee0fd37cf7f0a2b61606d9fec6504918e1243128adacb70a3
+  data.tar.gz: ce80093052178e5d59c5b8f713029da8e74cc1ac14febcfc3fefd7023e0b37b2b1422638ac0ba4dc14e7b90b45a4094bde876274c757b8eea6df2194285c52cd

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.15.0] - 2019-09-02
+### Added
+- `:format`-option for `load_from_self` and `expose_self` commands thath identifies which data format
+  should be chosen for parsing;
+
 ## [0.14.0] - 2019-08-28
 ### Added
 - `expose_json`

data/README.md

@@ -1329,14 +1329,17 @@ config.settings['RUN_CI'] # => '1'
 ### Load from \_\_END\_\_
 
 - aka `load_from_self`
-- works with `YAML` format;
+- `:format` - specify the format of data placed under the `__END__` instruction:
+  - `format: :yaml` - **YAML** format (by default);
+  - `format: :json` - **JSON** format;
+  - `format: :toml` - **TOML** format (via `toml`-plugin);
 
 ```ruby
 class Config < Qonfig::DataSet
-  load_from_self # on the root
+  load_from_self # on the root (format: :yaml is used by default)
 
   setting :nested do
-    load_from_self # nested
+    load_from_self, format: :yaml # with explicitly identified YAML format
   end
 end
 
@@ -1373,11 +1376,14 @@ connection_timeout:
 - aka `expose_self`;
 - works in `expose_json` and `expose_yaml` manner, but with `__END__` instruction of the current file;
 - `env:` - your environment name (must be a type of `String`, `Symbol` or `Numeric`);
-- works with `YAML` format;
+- `:format` - specify the format of data placed under the `__END__` instruction:
+  - `format: :yaml` - **YAML** format (by default);
+  - `format: :json` - **JSON** format;
+  - `format: :toml` - **TOML** format (via `toml`-plugin);
 
 ```ruby
 class Config < Qonfig::DataSet
-  expose_self env: :production
+  expose_self env: :production, format: :yaml # with explicitly identified YAML format
 
   # NOTE: for Rails-like applications you can use this:
   expose_self env: Rails.env
@@ -1391,6 +1397,7 @@ config.settings.creds.user # => "D@iVeR" (from :production environment)
 config.settings.creds.password # => "test123" (from :production environment)
 
 __END__
+
 default: &default
   log: false
   api_enabled: true

data/lib/qonfig/commands/expose_json.rb

@@ -124,7 +124,7 @@ class Qonfig::Commands::ExposeJSON < Qonfig::Commands::Base
 
     raise(
       Qonfig::IncompatibleJSONStructureError,
-      'JSON content should have a hash-like structure'
+      'JSON content must be a hash-like structure'
     ) unless json_data_slice.is_a?(Hash)
 
     json_based_settings = build_data_set_klass(json_data_slice).new.settings
@@ -144,7 +144,7 @@ class Qonfig::Commands::ExposeJSON < Qonfig::Commands::Base
     Qonfig::Loaders::JSON.load_file(file_path, fail_on_unexist: strict).tap do |json_data|
       raise(
         Qonfig::IncompatibleJSONStructureError,
-        'JSON content should have a hash-like structure'
+        'JSON content must be a hash-like structure'
       ) unless json_data.is_a?(Hash)
     end
   end

data/lib/qonfig/commands/expose_self.rb

@@ -3,6 +3,12 @@
 # @api private
 # @since 0.14.0
 class Qonfig::Commands::ExposeSelf < Qonfig::Commands::Base
+  # @return [String, Symbol]
+  #
+  # @api private
+  # @since 0.15.0
+  attr_reader :format
+
   # @return [String]
   #
   # @api private
@@ -17,20 +23,24 @@ class Qonfig::Commands::ExposeSelf < Qonfig::Commands::Base
 
   # @param caller_location [String]
   # @option env [String, Symbol]
+  # @option format [String, Symbol]
   #
   # @api private
   # @since 0.14.0
-  def initialize(caller_location, env:)
+  def initialize(caller_location, env:, format:)
     unless env.is_a?(Symbol) || env.is_a?(String)
       raise Qonfig::ArgumentError, ':env should be a string or a symbol'
     end
 
-    if env.to_s.empty?
-      raise Qonfig::ArgumentError, ':env should be provided'
+    raise Qonfig::ArgumentError, ':env should be provided' if env.to_s.empty?
+
+    unless format.is_a?(String) || format.is_a?(Symbol)
+      raise Qonfig::ArgumentError, 'Format should be a symbol or a string'
     end
 
     @caller_location = caller_location
     @env = env
+    @format = format.tap { Qonfig::Loaders.resolve(format) }
   end
 
   # @param data_set [Qonfig::DataSet]
@@ -40,21 +50,22 @@ class Qonfig::Commands::ExposeSelf < Qonfig::Commands::Base
   # @api private
   # @since 0.14.0
   def call(data_set, settings)
-    yaml_data = load_self_placed_yaml_data
-    yaml_data_slice = yaml_data[env] || yaml_data[env.to_s] || yaml_data[env.to_sym]
+    self_placed_data = load_self_placed_end_data
+    env_based_data_slice =
+      self_placed_data[env] || self_placed_data[env.to_s] || self_placed_data[env.to_sym]
 
     raise(
       Qonfig::ExposeError,
       "#{file_path} file does not contain settings with <#{env}> environment key!"
-    ) unless yaml_data_slice
+    ) unless env_based_data_slice
 
     raise(
-      Qonfig::IncompatibleYAMLStructureError,
-      'YAML content should have a hash-like structure'
-    ) unless yaml_data_slice.is_a?(Hash)
+      Qonfig::IncompatibleEndDataStructureError,
+      '__END__-data content must be a hash-like structure'
+    ) unless env_based_data_slice.is_a?(Hash)
 
-    yaml_based_settings = build_data_set_klass(yaml_data_slice).new.settings
-    settings.__append_settings__(yaml_based_settings)
+    self_placed_settings = build_data_set_klass(env_based_data_slice).new.settings
+    settings.__append_settings__(self_placed_settings)
   end
 
   private
@@ -62,39 +73,28 @@ class Qonfig::Commands::ExposeSelf < Qonfig::Commands::Base
   # @return [Hash]
   #
   # @raise [Qonfig::SelfDataNotFound]
-  # @raise [Qonfig::IncompatibleYAMLStructureError]
+  # @raise [Qonfig::IncompatibleEndDataStructureError]
   #
   # @api private
   # @since 0.14.0
-  def load_self_placed_yaml_data
-    caller_file = caller_location.split(':').first
-
-    raise(
-      Qonfig::SelfDataNotFoundError,
-      "Caller file does not exist! (location: #{caller_location})"
-    ) unless File.exist?(caller_file)
-
-    data_match = IO.read(caller_file).match(/\n__END__\n(?<end_data>.*)/m)
-    raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless data_match
-
-    end_data = data_match[:end_data]
-    raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless end_data
+  def load_self_placed_end_data
+    end_data      = Qonfig::Loaders::EndData.extract(caller_location)
+    settings_data = Qonfig::Loaders.resolve(format).load(end_data)
 
-    yaml_data = Qonfig::Loaders::YAML.load(end_data)
     raise(
-      Qonfig::IncompatibleYAMLStructureError,
-      'YAML content should have a hash-like structure'
-    ) unless yaml_data.is_a?(Hash)
+      Qonfig::IncompatibleEndDataStructureError,
+      '__END__-data must be a hash-like structure'
+    ) unless settings_data.is_a?(Hash)
 
-    yaml_data
+    settings_data
   end
 
-  # @param self_placed_yaml_data [Hash]
+  # @param self_placed_settings [Hash]
   # @return [Class<Qonfig::DataSet>]
   #
   # @api private
   # @since 0.14.0
-  def build_data_set_klass(self_placed_yaml_data)
-    Qonfig::DataSet::ClassBuilder.build_from_hash(self_placed_yaml_data)
+  def build_data_set_klass(self_placed_settings)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(self_placed_settings)
   end
 end

data/lib/qonfig/commands/expose_yaml.rb

@@ -124,7 +124,7 @@ class Qonfig::Commands::ExposeYAML < Qonfig::Commands::Base
 
     raise(
       Qonfig::IncompatibleYAMLStructureError,
-      'YAML content should have a hash-like structure'
+      'YAML content must be a hash-like structure'
     ) unless yaml_data_slice.is_a?(Hash)
 
     yaml_based_settings = build_data_set_klass(yaml_data_slice).new.settings
@@ -144,7 +144,7 @@ class Qonfig::Commands::ExposeYAML < Qonfig::Commands::Base
     Qonfig::Loaders::YAML.load_file(file_path, fail_on_unexist: strict).tap do |yaml_data|
       raise(
         Qonfig::IncompatibleYAMLStructureError,
-        'YAML content should have a hash-like structure'
+        'YAML content must be a hash-like structure'
       ) unless yaml_data.is_a?(Hash)
     end
   end

data/lib/qonfig/commands/load_from_env.rb

@@ -63,9 +63,7 @@ class Qonfig::Commands::LoadFromENV < Qonfig::Commands::Base
   # @since 0.2.0
   def call(data_set, settings)
     env_data = extract_env_data
-
     env_based_settings = build_data_set_klass(env_data).new.settings
-
     settings.__append_settings__(env_based_settings)
   end
 

data/lib/qonfig/commands/load_from_json.rb

@@ -36,11 +36,10 @@ class Qonfig::Commands::LoadFromJSON < Qonfig::Commands::Base
 
     raise(
       Qonfig::IncompatibleJSONStructureError,
-      'JSON object should have a hash-like structure'
+      'JSON object must be a hash-like structure'
     ) unless json_data.is_a?(Hash)
 
     json_based_settings = build_data_set_klass(json_data).new.settings
-
     settings.__append_settings__(json_based_settings)
   end
 

data/lib/qonfig/commands/load_from_self.rb

@@ -3,6 +3,12 @@
 # @api private
 # @since 0.2.0
 class Qonfig::Commands::LoadFromSelf < Qonfig::Commands::Base
+  # @return [String, Symbol]
+  #
+  # @api private
+  # @since 0.15.0
+  attr_reader :format
+
   # @return [String]
   #
   # @api private
@@ -10,11 +16,17 @@ class Qonfig::Commands::LoadFromSelf < Qonfig::Commands::Base
   attr_reader :caller_location
 
   # @param caller_location [String]
+  # @option format [String, Symbol]
   #
   # @api private
   # @since 0.2.0
-  def initialize(caller_location)
+  def initialize(caller_location, format:)
+    unless format.is_a?(String) || format.is_a?(Symbol)
+      raise Qonfig::ArgumentError, 'Format should be a symbol or a string'
+    end
+
     @caller_location = caller_location
+    @format = format.tap { Qonfig::Loaders.resolve(format) }
   end
 
   # @param data_set [Qonfig::DataSet]
@@ -24,11 +36,10 @@ class Qonfig::Commands::LoadFromSelf < Qonfig::Commands::Base
   # @api private
   # @since 0.2.0
   def call(data_set, settings)
-    yaml_data = load_self_placed_yaml_data
-
-    yaml_based_settings = build_data_set_klass(yaml_data).new.settings
+    self_placed_end_data = load_self_placed_end_data
+    self_placed_settings = build_data_set_klass(self_placed_end_data).new.settings
 
-    settings.__append_settings__(yaml_based_settings)
+    settings.__append_settings__(self_placed_settings)
   end
 
   private
@@ -40,35 +51,24 @@ class Qonfig::Commands::LoadFromSelf < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.2.0
-  def load_self_placed_yaml_data
-    caller_file = caller_location.split(':').first
-
-    raise(
-      Qonfig::SelfDataNotFoundError,
-      "Caller file does not exist! (location: #{caller_location})"
-    ) unless File.exist?(caller_file)
-
-    data_match = IO.read(caller_file).match(/\n__END__\n(?<end_data>.*)/m)
-    raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless data_match
-
-    end_data = data_match[:end_data]
-    raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless end_data
+  def load_self_placed_end_data
+    end_data      = Qonfig::Loaders::EndData.extract(caller_location)
+    settings_data = Qonfig::Loaders.resolve(format).load(end_data)
 
-    yaml_data = Qonfig::Loaders::YAML.load(end_data)
     raise(
-      Qonfig::IncompatibleYAMLStructureError,
-      'YAML content should have a hash-like structure'
-    ) unless yaml_data.is_a?(Hash)
+      Qonfig::IncompatibleEndDataStructureError,
+      '__END__-data must be a hash-like structure'
+    ) unless settings_data.is_a?(Hash)
 
-    yaml_data
+    settings_data
   end
 
-  # @param self_placed_yaml_data [Hash]
+  # @param self_placed_settings [Hash]
   # @return [Class<Qonfig::DataSet>]
   #
   # @api private
   # @since 0.2.0
-  def build_data_set_klass(self_placed_yaml_data)
-    Qonfig::DataSet::ClassBuilder.build_from_hash(self_placed_yaml_data)
+  def build_data_set_klass(self_placed_settings)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(self_placed_settings)
   end
 end

data/lib/qonfig/commands/load_from_yaml.rb

@@ -38,11 +38,10 @@ class Qonfig::Commands::LoadFromYAML < Qonfig::Commands::Base
 
     raise(
       Qonfig::IncompatibleYAMLStructureError,
-      'YAML content should have a hash-like structure'
+      'YAML content must be a hash-like structure'
     ) unless yaml_data.is_a?(Hash)
 
     yaml_based_settings = build_data_set_klass(yaml_data).new.settings
-
     settings.__append_settings__(yaml_based_settings)
   end
 

data/lib/qonfig/dsl.rb

@@ -77,9 +77,9 @@ module Qonfig::DSL
   #
   # @api public
   # @since 0.2.0
-  def load_from_self
+  def load_from_self(format: :yaml)
     caller_location = caller(1, 1).first
-    commands << Qonfig::Commands::LoadFromSelf.new(caller_location)
+    commands << Qonfig::Commands::LoadFromSelf.new(caller_location, format: format)
   end
 
   # @option convert_values [Boolean]
@@ -139,8 +139,8 @@ module Qonfig::DSL
   #
   # @api public
   # @since 0.14.0
-  def expose_self(env:)
+  def expose_self(env:, format: :yaml)
     caller_location = caller(1, 1).first
-    commands << Qonfig::Commands::ExposeSelf.new(caller_location, env: env)
+    commands << Qonfig::Commands::ExposeSelf.new(caller_location, env: env, format: format)
   end
 end

data/lib/qonfig/errors.rb

@@ -81,6 +81,13 @@ module Qonfig
   # @since 0.5.0
   IncompatibleJSONStructureError = Class.new(Error)
 
+  # @see Qonfig::Commands::LoadFromSelf
+  # @see Qonfig::Commands::ExposeSelf
+  #
+  # @api public
+  # @since 0.15.0
+  IncompatibleEndDataStructureError = Class.new(Error)
+
   # @see Qonfig::Loaders::YAML
   #
   # @api public
@@ -111,6 +118,12 @@ module Qonfig
   # @since 0.7.0
   ExposeError = Class.new(Error)
 
+  # @see Qonfig::Loaders
+  #
+  # @api public
+  # @since 0.15.0
+  UnsupportedLoaderFormatError = Class.new(Error)
+
   # @see Qonfig::Plugin::TOMLFormat
   #
   # @api public

data/lib/qonfig/loaders/end_data.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.15.0
+module Qonfig::Loaders::EndData
+  class << self
+    # @param caller_location [String]
+    # @return [String]
+    #
+    # @raise [Qonfig::SelfDataNotFoundError]
+    #
+    # @api private
+    # @since 0.15.0
+    def extract(caller_location)
+      caller_file = caller_location.split(':').first
+
+      raise(
+        Qonfig::SelfDataNotFoundError,
+        "Caller file does not exist! (location: #{caller_location})"
+      ) unless File.exist?(caller_file)
+
+      data_match = IO.read(caller_file).match(/\n__END__\n(?<end_data>.*)/m)
+      raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless data_match
+
+      end_data = data_match[:end_data]
+      raise Qonfig::SelfDataNotFoundError, '__END__ data not found!' unless end_data
+
+      end_data
+    end
+  end
+end

data/lib/qonfig/loaders.rb

@@ -6,4 +6,26 @@ module Qonfig::Loaders
   require_relative 'loaders/basic'
   require_relative 'loaders/json'
   require_relative 'loaders/yaml'
+  require_relative 'loaders/end_data'
+
+  class << self
+    # @param format [String, Symbol]
+    # @return [Module]
+    #
+    # @raise [Qonfig::UnsupportedLoaderFormatError]
+    #
+    # @api private
+    # @since 0.15.0
+    def resolve(format)
+      case format.to_s
+      when 'yaml', 'yml'
+        Qonfig::Loaders::YAML
+      when 'json'
+        Qonfig::Loaders::JSON
+      else
+        raise(Qonfig::UnsupportedLoaderFormatError, "<#{format}> format is not supported.")
+      end
+    end
+    alias_method :[], :resolve
+  end
 end

data/lib/qonfig/plugins/toml/loaders.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.15.0
+module Qonfig::Loaders
+  class << self
+    prepend(Module.new do
+      # @param format [String, Symbol]
+      # @return [Module]
+      #
+      # @raise [Qonfig::UnsupportedLoaderFormatError]
+      #
+      # @see Qonfig::Loaders.resolve
+      #
+      # @api private
+      # @since 0.15.0
+      def resolve(format)
+        return Qonfig::Loaders::TOML if format.to_s == 'toml'
+        super(format)
+      end
+    end)
+  end
+end

data/lib/qonfig/plugins/toml.rb

@@ -15,6 +15,7 @@ class Qonfig::Plugins::TOML < Qonfig::Plugins::Abstract
       ) unless const_defined?('::TomlRB')
 
       require_relative 'toml/tomlrb_fixes'
+      require_relative 'toml/loaders'
       require_relative 'toml/loaders/toml'
       require_relative 'toml/uploaders/toml'
       require_relative 'toml/commands/load_from_toml'

data/lib/qonfig/version.rb

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

data/qonfig.gemspec

@@ -14,9 +14,10 @@ Gem::Specification.new do |spec|
   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.'
+                     'Support for inheritance and composition. Lazy instantiation. Thread-safe. ' \
+                     'Command-style DSL. Validation layer. ' \
+                     'Support for YAML, TOML, JSON, __END__, ENV. ' \
+                     'Extremely simple to define. Extremely simple to use.'
   spec.homepage    = 'https://github.com/0exp/qonfig'
   spec.license     = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2019-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -109,8 +109,9 @@ dependencies:
       - !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.
+  and composition. Lazy instantiation. Thread-safe. Command-style DSL. Validation
+  layer. Support for YAML, TOML, JSON, __END__, ENV. Extremely simple to define. Extremely
+  simple to use.
 email:
 - iamdaiver@icloud.com
 executables: []
@@ -156,6 +157,7 @@ files:
 - lib/qonfig/errors.rb
 - lib/qonfig/loaders.rb
 - lib/qonfig/loaders/basic.rb
+- lib/qonfig/loaders/end_data.rb
 - lib/qonfig/loaders/json.rb
 - lib/qonfig/loaders/yaml.rb
 - lib/qonfig/plugins.rb
@@ -167,6 +169,7 @@ files:
 - 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.rb
 - lib/qonfig/plugins/toml/loaders/toml.rb
 - lib/qonfig/plugins/toml/tomlrb_fixes.rb
 - lib/qonfig/plugins/toml/uploaders/toml.rb