qonfig 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afe6dc7a96eec7d6f1e45a84d88fe5d4d7188547c6f55fb6aff65f7e46b92620
-  data.tar.gz: c045b73600ef8b751229a81ca8030cdbd45b6955f47a1c8e1d0cff48b1229a67
+  metadata.gz: f4478b75a75d9df31fedab5728cc55af2509b858158d522cefc8fbe15811c216
+  data.tar.gz: d50efec1ffcc132225be42a6e54d9b47e6d548cde6b45ac09f345a9f01fbc2d3
 SHA512:
-  metadata.gz: '0933d09ee590ab14c764373e66a90adce051cad88e3edcb8fb72ea75c39616797d263621f99f3ffe53645a652a6a8f8d566762a4b12d165168c0196ca4c87579'
-  data.tar.gz: 5dbcfedecf3a20906e00adb5f0ffec49f240bff0402e2db75690c29cb4b0bb8a394ccf9f1531723ff46c97a51d230c4e2484aa0eae122479189fa57882b41df8
+  metadata.gz: e5be60954fc592e1c62545c92d025d48cc6d5643ec80955cc9b4dea9bc0c65ccde98638de01a17aabc451bfdfc1d6be4b2465d5ce1f7d2f472ac9e2ef4012efe
+  data.tar.gz: 1a6e33b588e5df992e10921fd3c09df4de70786aa54968feeb3966170ff33083615110de566f40dd18b8921ee65da5dfd47b40956b08464104f246f68e625671

data/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
 rvm:
-  - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
-  - ruby-head
-  - jruby-head
-
+- 2.3.7
+- 2.4.4
+- 2.5.1
+- ruby-head
+- jruby-head
 sudo: false
 cache: bundler
 before_install: gem install bundler
 script: bundle exec rspec
+notifications:
+  slack:
+    secure: I03SDv+IrKy3IkeGjjHUJ9VneFMiYpLzIgPOixGFO5zGVXgulwmun82KsrPSW5HkK1UEQCahfoXt1hNECPwxcdsY01q6LBYJQx1jD0q17bXHllN/q0C6lx3peRN0KqNAAOU3/mHZxLt3HFV+N3HsSnoxDMuSYJgKbjCL/QVG2L2UYT9vi+JRNM/thj8R6MWKWlOHemik40GbLr2anCOCqiALzxnJzh5nJyGj+9SGvjhHfQq/fAIrg1+Scu+UchG8d+1yS5JWsGTt1/JF08i+Ux4ceTQ7GNBNeA5cj/xuUzvRx6A85renxyTiZMKIL0+jeceUm8c+/46XFcq0F7/kJB36lwjFhX1JRphcu/VouRdEwW/BvH74wnyHtygqOpk0LH4shp7A1DIS1DlnBbeJxrR5hdMDnmV85kTU6w6H0BbncsYY/pH1fji1kgH6jCsdwqDlq4wLB8x8I+eZABBsfb/r55z/HnBmmxlvR7Rt3X5/yR3gJrsgRrDBBZ5LwYy1RSCDu76vMQqWGJKG03FdfqSNqmC5V4MC5Ez8yjGDW0Yle09mwvsL2c6fDXyDPCeB/gwNk+FvgLRXnv7C4BaBNEoG4JnCL/dwauoJNg0lB6uF34BEmYAhZIrdY1CI6BqPWnaVMJfcJSYekBVXDIELDnTFRWjaGU1y8dM6lNzDmYE=

data/CHANGELOG.md

@@ -1,7 +1,16 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.5.0] - 2018-07-27
+### Added
+- `load_from_json`- a command that provides an ability to define config settings
+  by loading them from a json file (in `load_from_yaml` manner);
+
+### Changed
+- Support for Ruby 2.2 has ended;
+
 ## [0.4.0] - 2018-06-24
+### Added
 - Introduce Plugin Ecosystem (`Qonfig::Plugins`):
   - load plugin: `Qonfig.plugin('plugin_name')` or `Qonfig.plugin(:plugin_name)`;
   - get registered plugins: `Qonfig.plugins #=> array of strings`

data/README.md

@@ -31,6 +31,7 @@ require 'qonfig'
 - [State freeze](#state-freeze)
 - [Settings as Predicates](#settings-as-predicates)
 - [Load from YAML file](#load-from-yaml-file)
+- [Load from JSON file](#load-from-json-file)
 - [Load from ENV](#load-from-env)
 - [Load from \_\_END\_\_](#load-from-__end__) (aka `load_from_self`)
 - [Smart Mixin](#smart-mixin) (`Qonfig::Configurable`)
@@ -482,6 +483,65 @@ Config.new.to_h # => { "nonexistent_yaml" => {}, "another_key" => nil }
 
 ---
 
+### Load from JSON file
+
+- `:strict` mode (fail behaviour when the required yaml file doesnt exist):
+  - `true` (by default) - causes `Qonfig::FileNotFoundError`;
+  - `false` - do nothing, ignore current command;
+
+```json
+<!-- options.json -->
+{
+  "user": "0exp",
+  "password": 12345,
+  "rubySettings": {
+    "allowedVersions": ["2.3", "2.4.2", "1.9.8"],
+    "gitLink": null,
+    "withAdditionals": false
+  }
+}
+```
+
+```ruby
+class Config < Qonfig::DataSet
+  load_from_json 'options.json'
+end
+
+config = Config.new
+
+config.settings.user # => '0exp'
+config.settings.password # => 12345
+config.settings.rubySettings.allowedVersions # => ['2.3', '2.4.2', '1.9.8']
+config.settings.rubySettings.gitLink # => nil
+config.settings.rubySettings.withAdditionals # => false
+```
+
+```ruby
+# --- strict mode ---
+class Config < Qonfig::DataSet
+  setting :nonexistent_json do
+    load_from_yaml 'nonexistent_json.json', strict: true # true by default
+  end
+
+  setting :another_key
+end
+
+Config.new # => Qonfig::FileNotFoundError
+
+# --- non-strict mode ---
+class Config < Qonfig::DataSet
+  settings :nonexistent_json do
+    load_from_yaml 'nonexistent_json.json', strict: false
+  end
+
+  setting :another_key
+end
+
+Config.new.to_h # => { "nonexistent_json" => {}, "another_key" => nil }
+```
+
+---
+
 ### Load from ENV
 
 - `:convert_values` (`false` by default):

data/lib/qonfig/commands/load_from_json.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Qonfig
+  module Commands
+    # @api private
+    # @since 0.5.0
+    class LoadFromJSON < Base
+      # @return [String]
+      #
+      # @api private
+      # @since 0.5.0
+      attr_reader :file_path
+
+      # @return [Boolean]
+      #
+      # @api private
+      # @sicne 0.5.0
+      attr_reader :strict
+
+      # @param file_path [String]
+      # @option strict [Boolean]
+      #
+      # @api private
+      # @since 0.5.0
+      def initialize(file_path, strict: true)
+        @file_path = file_path
+        @strict = strict
+      end
+
+      # @param settings [Qonfig::Settings]
+      # @return [void]
+      #
+      # @api private
+      # @since 0.5.0
+      def call(settings)
+        json_data = Qonfig::Loaders::JSON.load_file(file_path, fail_on_unexist: strict)
+
+        raise(
+          Qonfig::IncompatibleJSONStructureError,
+          'JSON object should have a hash-like structure'
+        ) unless json_data.is_a?(Hash)
+
+        json_based_settings = build_data_set_class(json_data).new.settings
+
+        settings.__append_settings__(json_based_settings)
+      end
+
+      private
+
+      # @param json_data [Hash]
+      # @return [Class<Qonfig::DataSet>]
+      #
+      # @api private
+      # @since 0.5.0
+      def build_data_set_class(json_data)
+        Qonfig::DataSet::ClassBuilder.build_from_hash(json_data)
+      end
+    end
+  end
+end

data/lib/qonfig/dsl.rb

@@ -98,5 +98,15 @@ module Qonfig
         trim_prefix: trim_prefix
       )
     end
+
+    # @param file_path [String]
+    # @option strict [Boolean]
+    # @return [void]
+    #
+    # @api public
+    # @since 0.5.0
+    def load_from_json(file_path, strict: true)
+      commands << Qonfig::Commands::LoadFromJSON.new(file_path, strict: strict)
+    end
   end
 end

data/lib/qonfig/error.rb

@@ -51,6 +51,12 @@ module Qonfig
   # @since 0.2.0
   IncompatibleYAMLStructureError = Class.new(Error)
 
+  # @see Qonfig::Commands::LoadFromJSON
+  #
+  # @api public
+  # @since 0.5.0
+  IncompatibleJSONStructureError = Class.new(Error)
+
   # @see Qonfig::Loaders::YAML
   #
   # @api public

data/lib/qonfig/loaders/basic.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Qonfig
+  module Loaders
+    # @api private
+    # @sicne 0.5.0
+    module Basic
+      # @param data [String]
+      # @return [void]
+      #
+      # @api private
+      # @since 0.5.0
+      def load(data)
+        nil
+      end
+
+      # @return [void]
+      #
+      # @api private
+      # @since 0.5.0
+      def load_empty_data
+        nil
+      end
+
+      # @param file_path [String]
+      # @option fail_on_unexist [Boolean]
+      # @return [Object]
+      #
+      # @raise [Qonfig::FileNotFoundError]
+      #
+      # @api private
+      # @since 0.5.0
+      def load_file(file_path, fail_on_unexist: true)
+        load(::File.read(file_path))
+      rescue Errno::ENOENT => error
+        fail_on_unexist ? (raise Qonfig::FileNotFoundError, error.message) : load_empty_data
+      end
+    end
+  end
+end

data/lib/qonfig/loaders/json.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Qonfig
+  module Loaders
+    # @api private
+    # @since 0.5.0
+    module JSON
+      # @since 0.5.0
+      extend Qonfig::Loaders::Basic
+
+      class << self
+        # @param data [String]
+        # @return [Object]
+        #
+        # @api private
+        # @since 0.5.0
+        def load(data)
+          ::JSON.parse(data, max_nesting: false, allow_nan: true)
+        end
+
+        # @return [Object]
+        #
+        # @api private
+        # @since 0.5.0
+        def load_empty_data
+          load('{}')
+        end
+      end
+    end
+  end
+end

data/lib/qonfig/loaders/yaml.rb

@@ -5,6 +5,9 @@ module Qonfig
     # @api private
     # @since 0.2.0
     module YAML
+      # @since 0.5.0
+      extend Qonfig::Loaders::Basic
+
       class << self
         # @param data [String]
         # @return [Object]
@@ -15,18 +18,12 @@ module Qonfig
           ::YAML.load(ERB.new(data).result)
         end
 
-        # @param file_path [String]
-        # @option fail_on_unexist [Boolean]
         # @return [Object]
         #
-        # @raise [Qonfig::FileNotFoundError]
-        #
         # @api private
-        # @since 0.2.0
-        def load_file(file_path, fail_on_unexist: true)
-          load(::File.read(file_path))
-        rescue Errno::ENOENT => error
-          fail_on_unexist ? (raise Qonfig::FileNotFoundError, error.message) : load('{}')
+        # @since 0.5.0
+        def load_empty_data
+          load('{}')
         end
       end
     end

data/lib/qonfig/version.rb

@@ -3,5 +3,5 @@
 module Qonfig
   # @api public
   # @since 0.1.0
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/qonfig.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
 require 'yaml'
+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'

data/qonfig.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'qonfig/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.2.10'
+  spec.required_ruby_version = '>= 2.3.7'
 
   spec.name        = 'qonfig'
   spec.version     = Qonfig::VERSION
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov',        '~> 0.14'
   spec.add_development_dependency 'simplecov-json',   '~> 0.2'
   spec.add_development_dependency 'rspec',            '~> 3.7'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.3'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.4'
 
   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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-24 00:00:00.000000000 Z
+date: 2018-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -152,6 +152,7 @@ files:
 - lib/qonfig/commands/compose.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
@@ -159,6 +160,8 @@ files:
 - lib/qonfig/data_set/class_builder.rb
 - lib/qonfig/dsl.rb
 - lib/qonfig/error.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
@@ -182,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.10
+      version: 2.3.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="