dry-configurable 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24d1584b6f9d1d9fbe7fe62ef7b7c0afbd558176
-  data.tar.gz: b94c4d0b877b2093de30add176fc70e413c28ef0
+  metadata.gz: eeb18b428640615a653b1e669bcbedf1130f83ef
+  data.tar.gz: 294ec402fe8dbfb378c6a5e1d5d442c49ac7baf1
 SHA512:
-  metadata.gz: 796c1b446cb4e31947f2274409325e4ec21ae2c8c8a34d5100723f74063c410756bd96a0327844f140a49bf0fd0e489194684c1876ed03c748e6e85a6c177c64
-  data.tar.gz: 44e36011d7d0c59f15d1dfb59b6e800c094be7a02ac60c781e8410f7ecfc151ed660ba4cec7928c6955f873ee215d7ef9ab2eb54d7ea237ca9e98027e1fff7ba
+  metadata.gz: f3c268381efd9f202447a9785873ea151e5ce4edc004c87006a0c5b91165b3b29827d99799cf2f75a386214c5906b09d9b12983aec05502ad88591f1fa702896
+  data.tar.gz: fd8c289e25a8fa28ec55e1f69ec5f569e2b6dbf0506ca7df49a80c6277c99510bc0505dc7c063fd97144f2723105bba62448472bc2db73c941dce1bca8db9cbf

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## Unreleased
+
+## Added
+
+* Introduce `Configurable.finalize!` which freezes config and its dependencies ([qcam](https://github.com/qcam))
+
+## Fixed
+
+* Allow for boolean false as default setting value ([yuszuv](https://github.com/yuszuv))
+* Convert nested configs to nested hashes with `Config#to_h` ([saverio-kantox](https://github.com/saverio-kantox))
+* Disallow modification on frozen config ([qcam](https://github.com/qcam))
+
+[Compare v0.6.2...HEAD](https://github.com/dry-rb/dry-configurable/compare/v0.6.2...HEAD)

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Ruby Object Mapper
+Copyright (c) 2015-2017 dry-rb
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/lib/dry/configurable.rb

@@ -66,9 +66,20 @@ module Dry
     #
     # @api public
     def configure
+      raise_frozen_config if frozen?
       yield(config) if block_given?
     end
 
+    # Finalize and freeze configuration
+    #
+    # @return [Dry::Configurable::Config]
+    #
+    # @api public
+    def finalize!
+      freeze
+      config.finalize!
+    end
+
     # Add a setting to the configuration
     #
     # @param [Mixed] key
@@ -96,7 +107,7 @@ module Dry
 
       _settings << ::Dry::Configurable::Config::Value.new(
         key,
-        value || ::Dry::Configurable::Config::Value::NONE,
+        !value.nil? ? value : ::Dry::Configurable::Config::Value::NONE,
         processor || ::Dry::Configurable::Config::DEFAULT_PROCESSOR
       )
       store_reader_options(key, options) if options.any?
@@ -151,6 +162,11 @@ module Dry
             "Cannot add setting +#{key}+, #{self} is already configured"
     end
 
+    # @private
+    def raise_frozen_config
+      raise FrozenConfig, 'Cannot modify frozen config'
+    end
+
     # @private
     def store_reader_options(key, options)
       _reader_attributes << key if options.fetch(:reader, false)

data/lib/dry/configurable/config.rb

@@ -13,6 +13,7 @@ module Dry
           end
 
           klass.__send__(:define_method, "#{setting.name}=") do |value|
+            raise_frozen_config if frozen?
             @config[setting.name] = setting.processor.call(value)
           end
         end
@@ -44,11 +45,17 @@ module Dry
         clone
       end
 
+      def finalize!
+        @config.freeze
+        freeze
+      end
+
       def to_h
         @config.each_with_object({}) do |tuple, hash|
           key, value = tuple
 
-          if value.is_a?(::Dry::Configurable::Config)
+          case value
+          when ::Dry::Configurable::Config, ::Dry::Configurable::NestedConfig
             hash[key] = value.to_h
           else
             hash[key] = value
@@ -69,6 +76,10 @@ module Dry
 
       private
 
+      def raise_frozen_config
+        raise FrozenConfig, 'Cannot modify frozen config'
+      end
+
       def raise_unknown_setting_error(name)
         raise ArgumentError, "+#{name}+ is not a setting name"
       end

data/lib/dry/configurable/error.rb

@@ -4,5 +4,6 @@ module Dry
   module Configurable
     Error = Class.new(::StandardError)
     AlreadyDefinedConfig = ::Class.new(Error)
+    FrozenConfig = ::Class.new(Error)
   end
 end

data/lib/dry/configurable/version.rb

@@ -1,6 +1,6 @@
 module Dry
   module Configurable
     # @api public
-    VERSION = '0.6.2'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

data/spec/support/shared_examples/configurable.rb

@@ -23,6 +23,16 @@ RSpec.shared_examples 'a configurable class' do
             end
           end
 
+          context 'with a false default value' do
+            before do
+              klass.setting :dsn, false
+            end
+
+            it 'returns the default value' do
+              expect(klass.config.dsn).to be(false)
+            end
+          end
+
           context 'with a string default value' do
             before do
               klass.setting :dsn, 'sqlite:memory'
@@ -241,6 +251,30 @@ RSpec.shared_examples 'a configurable class' do
         end
       end
 
+      context 'when finalized' do
+        before do
+          klass.setting :dsn
+          klass.configure do |config|
+            config.dsn = 'jdbc:sqlite'
+          end
+          klass.finalize!
+        end
+
+        it 'disallows modification' do
+          expect do
+            klass.configure do |config|
+              config.dsn = 'jdbc:sqlite'
+            end
+          end.to raise_error(Dry::Configurable::FrozenConfig, 'Cannot modify frozen config')
+        end
+
+        it 'disallows direct modification on config' do
+          expect do
+            klass.config.dsn = 'jdbc:sqlite:memory'
+          end.to raise_error(Dry::Configurable::FrozenConfig, 'Cannot modify frozen config')
+        end
+      end
+
       context 'when inherited' do
         context 'without processor' do
           before do

data/spec/unit/dry/configurable/config_spec.rb

@@ -53,6 +53,15 @@ RSpec.describe Dry::Configurable::Config do
     end
   end
 
+  describe '#finalize!' do
+    subject!(:dup) { config.finalize! }
+
+    it 'freezes itself and the config' do
+      expect { config.user = 'whoami' }
+        .to raise_error(Dry::Configurable::FrozenConfig, 'Cannot modify frozen config')
+    end
+  end
+
   describe '#to_h' do
     subject! { config.to_h }
 
@@ -68,7 +77,9 @@ RSpec.describe Dry::Configurable::Config do
 
     context 'with nesting' do
       let(:nested_setting) do
-        klass.create([value_class.new(:bar, 'baz', ->(v) { v })])
+        ::Dry::Configurable::NestedConfig.new do
+          setting(:bar, 'baz') { |v| v }
+        end.tap(&:create_config)
       end
       let(:settings) do
         [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-configurable
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-26 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -78,6 +78,7 @@ files:
 - .rspec
 - .ruby-version
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A mixin to add configuration functionality to your classes