config 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73118a0190819d693e81132bc4a2746a453dd74d
-  data.tar.gz: 5c6a339dcfa60f444269f0ba45da298656297471
+  metadata.gz: 8b6ae90fa7f141cfc8e3f6eff8f1434a108f2b99
+  data.tar.gz: b41fb4da0c7de1352f9f192c8fcebc7a6e53382a
 SHA512:
-  metadata.gz: a28428c4f956dacbd9032fa97037819a15956eb0d694a48a4250425d3902ef9fd13bb67fcfdb011d1c67ea043476a386c2dd6e729de85a846ad13d2b772c67a5
-  data.tar.gz: 35fa737c860ca76a6c6aac73ccbdab4e5e399cfdf214d357e26cdd9e00fa1e3652a4701bfb73adcca498981cf67bd10c35088fe510d925605f43087f7cccee0b
+  metadata.gz: e65ffa447a2e2fb94fd0941dbbc8ad4034bec9bdf1a5509224f69f3c927dedb10d7d36f9ca41fe1f452e4e5adc9def529eade2b6a6248570ae9ac92c3fa7afdd
+  data.tar.gz: eabc5a9851556abd9d30b07496b4f3e3fb00108a6d29e3868dcc32004f62368a9d32348beeb211d1425a44d931689cf389116b81cf4f259a6a52aa67a28012d8

data/CHANGELOG.md

@@ -1,14 +1,30 @@
 # Changelog
 
+## Unreleased
+
+...
+
+## 1.5.0
+
+### New features
+* Add ability to validate config schema ([#155](https://github.com/railsconfig/config/pull/155) thanks to [@ok32](https://github.com/ok32))
+* Add count to the reserved names list ([#167](https://github.com/railsconfig/config/pull/167) thanks to [@carbonin](https://github.com/carbonin))
+
+### Bug fixes
+* Correctly parse `env_prefix`, which contains `env_separator` ([#177](https://github.com/railsconfig/config/pull/177) thanks to [@rdodson41](https://github.com/rdodson41))
+
 ## 1.4.0
 
+### New features
 * Added support for passing a raw ruby hash into to both `Settings.add_source!` and `Settings.prepend_source!` ([#108](https://github.com/railsconfig/config/pull/159) thanks to [@halloffame](https://github.com/halloffame))
+
+### Bug fixes
 * Added new reserved name `test` ([#158](https://github.com/railsconfig/config/pull/158) thanks to [@milushov](https://github.com/milushov))
 * `to_hash` should not replace nested config objects with Hash ([#160](https://github.com/railsconfig/config/issues/160) thanks to [@seikichi](https://github.com/seikichi))
 
 ## 1.3.0
 
-* **WARNING:** Overwrite arrays found in previously loaded settings file ([#137](https://github.com/railsconfig/config/pull/137) thanks to [@Fryguy](https://github.com/Fryguy) and [@dtaniwaki](https://github.com/dtaniwaki)) - this is a change breaking previous behaviour. If you want to keep Config to work as before, which is merging arrays found in following loaded settings file, please add `config.overwrite_arrays = false` to your Config initializer 
+* **WARNING:** Overwrite arrays found in previously loaded settings file ([#137](https://github.com/railsconfig/config/pull/137) thanks to [@Fryguy](https://github.com/Fryguy) and [@dtaniwaki](https://github.com/dtaniwaki)) - this is a change breaking previous behaviour. If you want to keep Config to work as before, which is merging arrays found in following loaded settings file, please add `config.overwrite_arrays = false` to your Config initializer
 * Changed default ENV variables loading settings to downcase variable names and parse values
 * Added parsing ENV variables values to Float type
 * Change method definition order in Rails integration module to prevent undefined method `preload` error (based on [@YaroSpace](https://github.com/YaroSpace) suggestion in [#111](https://github.com/railsconfig/config/issues/111)

data/README.md

@@ -45,7 +45,7 @@ which will generate customizable config file `config/initializers/config.rb` and
     config/settings/test.yml
 
 You can now edit them to adjust to your needs.
-a
+
 ### Installing on Padrino
 
 Add the gem to your `Gemfile` and run `bundle install` to install it. Then edit `app.rb` and register `Config`
@@ -275,6 +275,30 @@ located at `config/initializers/config.rb`.
 
 Check [Deep Merge](https://github.com/danielsdeleo/deep_merge) for more details.
 
+### Validation
+
+With Ruby 2.1 or newer, you can optionally define a schema to validate presence (and type) of specific config values:
+
+```ruby
+Config.setup do |config|
+  # ...
+  config.schema do
+    required(:youtube).schema do
+      required(:api_key).filled
+    end
+  end
+end
+```
+
+The above example demonstrates how to ensure that the configuration has the `youtube` structure
+with the `api_key` field filled.
+
+If you define a schema it will automatically be used to validate your config. If validation fails it will
+raise a `Config::Validation::Error` containing a nice message with information about all the mismatches
+between the schema and your config.
+
+Check [dry-validation](https://github.com/dry-rb/dry-validation) for more details.
+
 ### Environment variables
 
 See section below for more details.
@@ -334,7 +358,7 @@ And the following configuration:
 ```ruby
 Config.setup do |config|
   config.use_env = true
-  config.env_prefix = 'Settings'
+  config.env_prefix = 'SETTINGS'
   config.env_separator = '__'
   config.env_converter = :downcase
   config.env_parse_values = true

data/config.gemspec

@@ -26,13 +26,14 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activesupport',           '>= 3.0'
   s.add_dependency 'deep_merge',              '~> 1.1.1'
+  s.add_dependency 'dry-validation',          '~> 0.10.4' if RUBY_VERSION >= '2.1'
 
-  s.add_development_dependency 'bundler',     '~> 1.13',  '>= 1.13.1'
-  s.add_development_dependency 'rake',        '~> 11.2',  '>= 11.2.2'
+  s.add_development_dependency 'bundler',     '~> 1.13',  '>= 1.13.6'
+  s.add_development_dependency 'rake',        '~> 12.0',  '>= 12.0.0'
 
   # Testing
   s.add_development_dependency 'appraisal',   '~> 2.1',   '>= 2.1.0'
-  s.add_development_dependency 'rails',       '~> 5.0',   '>= 5.0.0.1'
+  s.add_development_dependency 'rails',       '~> 5.0',   '>= 5.0.1'
   s.add_development_dependency 'rspec',       '~> 3.5',   '>= 3.5.0'
   s.add_development_dependency 'rspec-rails', '~> 3.5',   '>= 3.5.2'
   s.add_development_dependency 'test-unit',   '~> 3.2',   '>= 3.2.1'
@@ -40,9 +41,10 @@ Gem::Specification.new do |s|
 
   # Static code analysis
   s.add_development_dependency 'mdl',         '~> 0.4',   '>= 0.4.0'
-  s.add_development_dependency 'rubocop',     '~> 0.42',  '>= 0.42.0'
+  s.add_development_dependency 'rubocop',     '~> 0.46',  '>= 0.46.0'
 
   if ENV['TRAVIS']
-    s.add_development_dependency 'codeclimate-test-reporter', '~> 0.6.0'
+    s.add_development_dependency 'simplecov', '~> 0.12.0'
+    s.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.3'
   end
 end

data/lib/config.rb

@@ -6,9 +6,12 @@ require 'config/version'
 require 'config/integrations/rails/engine' if defined?(::Rails)
 require 'config/sources/yaml_source'
 require 'config/sources/hash_source'
+require 'config/validation/schema' if RUBY_VERSION >= '2.1'
 require 'deep_merge'
 
 module Config
+  extend Config::Validation::Schema if RUBY_VERSION >= '2.1'
+
   # Ensures the setup only gets run once
   @@_ran_once = false
 

data/lib/config/options.rb

@@ -1,8 +1,10 @@
 require 'ostruct'
+require 'config/validation/validate' if RUBY_VERSION >= '2.1'
 
 module Config
   class Options < OpenStruct
     include Enumerable
+    include Validation::Validate if RUBY_VERSION >= '2.1'
 
     def keys
       marshal_dump.keys
@@ -35,9 +37,12 @@ module Config
       hash = Hash.new
 
       ENV.each do |variable, value|
-        keys = variable.to_s.split(Config.env_separator)
+        separator = Config.env_separator
+        prefix = (Config.env_prefix || Config.const_name).to_s.split(separator)
 
-        next if keys.shift != (Config.env_prefix || Config.const_name)
+        keys = variable.to_s.split(separator)
+
+        next if keys.shift(prefix.size) != prefix
 
         keys.map! { |key|
           case Config.env_converter
@@ -83,6 +88,7 @@ module Config
       marshal_load(__convert(conf).marshal_dump)
 
       reload_env! if Config.use_env
+      validate! if RUBY_VERSION >= '2.1'
 
       self
     end
@@ -128,7 +134,7 @@ module Config
     end
 
     # Some keywords that don't play nicely with OpenStruct
-    SETTINGS_RESERVED_NAMES = %w{select collect test}
+    SETTINGS_RESERVED_NAMES = %w{select collect test count}
 
     # An alternative mechanism for property access.
     # This let's you do foo['bar'] along with foo.bar.

data/lib/config/validation/error.rb

@@ -0,0 +1,24 @@
+module Config
+  module Validation
+    class Error < StandardError
+
+      def self.format(v_res)
+        flatten_hash(v_res.messages).map do |field, msgs|
+          "#{' ' * 2}#{field}: #{msgs.join('; ')}"
+        end.join('\n')
+      end
+
+      def self.flatten_hash(h, acc={}, pref=[])
+        h.inject(acc) do |a, (k, v)|
+          if v.is_a?(Hash)
+            flatten_hash(v, acc, pref + [k])
+          else
+            acc[(pref + [k]).join('.')] = v
+            acc
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/config/validation/schema.rb

@@ -0,0 +1,21 @@
+require 'dry-validation'
+require 'config/validation/schema'
+
+module Config
+  module Validation
+    module Schema
+
+      mattr_writer :schema
+      @@schema = nil
+
+      def schema(&block)
+        if block_given?
+          @@schema = Dry::Validation.Schema(&block)
+        else
+          @@schema
+        end
+      end
+
+    end
+  end
+end

data/lib/config/validation/validate.rb

@@ -0,0 +1,19 @@
+require 'config/validation/error'
+
+module Config
+  module Validation
+    module Validate
+
+      def validate!
+        if Config.schema
+          v_res = Config.schema.(self.to_hash)
+
+          unless v_res.success?
+            raise Config::Validation::Error.new("Config validation failed:\n\n#{Config::Validation::Error.format(v_res)}")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/config/version.rb

@@ -1,3 +1,3 @@
 module Config
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/lib/generators/config/templates/config.rb

@@ -33,4 +33,13 @@ Config.setup do |config|
   # Parse numeric values as integers instead of strings.
   #
   # config.env_parse_values = true
+
+  # Validate presence and type of specific config values. Check https://github.com/dry-rb/dry-validation for details.
+  #
+  # config.schema do
+  #   required(:name).filled
+  #   required(:age).maybe(:int?)
+  #   required(:email).filled(format?: EMAIL_REGEX)
+  # end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: config
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Piotr Kuczynski
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -40,6 +40,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -49,7 +63,7 @@ dependencies:
         version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: 1.13.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,27 +73,27 @@ dependencies:
         version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: 1.13.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.2.2
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.2.2
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +123,7 @@ dependencies:
         version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: 5.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -119,7 +133,7 @@ dependencies:
         version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -226,20 +240,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: '0.46'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.46.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: '0.46'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.46.0
 description: 'Easiest way to manage multi-environment settings in any ruby project
   or framework: Rails, Sinatra, Pandrino and others'
 email:
@@ -268,6 +282,9 @@ files:
 - lib/config/sources/hash_source.rb
 - lib/config/sources/yaml_source.rb
 - lib/config/tasks/heroku.rake
+- lib/config/validation/error.rb
+- lib/config/validation/schema.rb
+- lib/config/validation/validate.rb
 - lib/config/version.rb
 - lib/generators/config/install_generator.rb
 - lib/generators/config/templates/config.rb