dry-configurable 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90bd271135f8ccb892c1cf3afc448f92fe50587567725e860de78b4ed58bb57a
-  data.tar.gz: 8580ad144d2fa3e0189c65a9873282db49c8ddd7d5c349b0f4d6f292e7f675ce
+  metadata.gz: b464e3a14e23a75467fc56883a5e222ad96139fee156972e58729607113cba55
+  data.tar.gz: 599d39ad241c3a6c17d27dd3ea8be2d94c1821a1c23ca9dea675126ba6c05ca6
 SHA512:
-  metadata.gz: b6613b8677ab724316dde1440ff0640021621d48eec1e0ca1125e28dfdb82bfd94800a3bf5d511fc704062dded24de5bd266012c7145028f2d2322a2837ad77c
-  data.tar.gz: 69a5d08bfbf53bc232ec8f0fb56186576fe1fe5128205d9597b87bccce750bc94256da9cd9644fa94b4e175f6f86911bad99e866f627e06f2386c29fbc89a634
+  metadata.gz: 8d306539d687ef4dc2ee1a999008ab3ead0f466cef01cc17b0122bc088d503da4515b906fa1d26449a4c1dd57b82d39cfd2558c4734061025fb6954383364ee3
+  data.tar.gz: 421f2b5bc4a89b155d889ee4305183a3f97c42ab74db8cd9c41fecbccbb0f11ff739a4a01afa780da4291bf3404e6ed87c224093ee08f8de706ce46d30b39da8

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 0.15.0 2022-04-21
+
+
+### Changed
+
+- The `finalize!` method (as class or instance method, depending on whether you extend or include `Dry::Configurable` respectively) now accepts a boolean `freeze_values:` argument, which if true, will recursively freeze all config values in addition to the `config` itself. (#105 by @ojab)
+
+  ```ruby
+  class MyConfigurable
+    include Dry::Configurable
+
+    setting :db, default: "postgre"
+  end
+
+  my_obj = MyConfigurable.new
+  my_obj.finalize!(freeze_values: true)
+  my_obj.config.db << "sql" # Will raise FrozenError
+  ```
+- `Dry::Configurable::Config#update` will set hashes as values for non-nested settings (#131 by @ojab)
+
+  ```ruby
+  class MyConfigurable
+    extend Dry::Configurable
+
+    setting :sslcert, constructor: ->(v) { v&.values_at(:pem, :pass)&.join }
+  end
+
+  MyConfigurable.config.update(sslcert: {pem: "cert", pass: "qwerty"})
+  MyConfigurable.config.sslcert # => "certqwerty"
+  ```
+- `Dry::Configurable::Config#update` will accept any values implicitly convertible to hash via `#to_hash` (#133 by @timriley)
+
+[Compare v0.14.0...v0.15.0](https://github.com/dry-rb/dry-configurable/compare/v0.14.0...v0.15.0)
+
 ## 0.14.0 2022-01-14
 
 

data/README.md

@@ -11,7 +11,7 @@
 [![CI Status](https://github.com/dry-rb/dry-configurable/workflows/ci/badge.svg)][actions]
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/0276a97990e04eb0ac722b3e7f3620b5)][codacy]
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/0276a97990e04eb0ac722b3e7f3620b5)][codacy]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-configurable.svg?branch=master)][inchpages]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-configurable.svg?branch=main)][inchpages]
 
 ## Links
 

data/dry-configurable.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-configurable/blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-configurable/blob/main/CHANGELOG.md"
   spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-configurable"
   spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-configurable/issues"
 

data/lib/dry/configurable/config.rb

@@ -50,16 +50,19 @@ module Dry
 
       # Update config with new values
       #
-      # @param values [Hash] A hash with new values
+      # @param values [Hash, #to_hash] A hash with new values
       #
       # @return [Config]
       #
       # @api public
       def update(values)
         values.each do |key, value|
-          case value
-          when Hash
-            self[key].update(value)
+          if self[key].is_a?(self.class)
+            unless value.respond_to?(:to_hash)
+              raise ArgumentError, "#{value.inspect} is not a valid setting value"
+            end
+
+            self[key].update(value.to_hash)
           else
             self[key] = value
           end
@@ -81,8 +84,8 @@ module Dry
       alias_method :to_h, :values
 
       # @api private
-      def finalize!
-        _settings.freeze
+      def finalize!(freeze_values: false)
+        _settings.finalize!(freeze_values: freeze_values)
         freeze
       end
 

data/lib/dry/configurable/instance_methods.rb

@@ -38,9 +38,7 @@ module Dry
       # Finalize the config and freeze the object
       #
       # @api public
-      def finalize!
-        return self if frozen?
-
+      def finalize!(freeze_values: false)
         super
         freeze
       end

data/lib/dry/configurable/methods.rb

@@ -21,10 +21,8 @@ module Dry
       # @return [Dry::Configurable::Config]
       #
       # @api public
-      def finalize!
-        return self if config.frozen?
-
-        config.finalize!
+      def finalize!(freeze_values: false)
+        config.finalize!(freeze_values: freeze_values)
         self
       end
     end

data/lib/dry/configurable/setting.rb

@@ -84,8 +84,12 @@ module Dry
 
       # @api private
       def value
-        @value ||= evaluate
+        return @value if evaluated?
+
+        @value = constructor[Undefined.coalesce(input, default, nil)]
       end
+      alias_method :evaluate, :value
+      private :evaluate
 
       # @api private
       def evaluated?
@@ -102,6 +106,16 @@ module Dry
         with(input: Undefined)
       end
 
+      # @api private
+      def finalize!(freeze_values: false)
+        if value.is_a?(Config)
+          value.finalize!(freeze_values: freeze_values)
+        elsif freeze_values
+          value.freeze
+        end
+        freeze
+      end
+
       # @api private
       def with(new_opts)
         self.class.new(name, input: input, default: default, **options, **new_opts)
@@ -149,11 +163,6 @@ module Dry
           @value = source.value.dup if source.evaluated?
         end
       end
-
-      # @api private
-      def evaluate
-        @value = constructor[Undefined.coalesce(input, default, nil)]
-      end
     end
   end
 end

data/lib/dry/configurable/settings.rb

@@ -54,6 +54,12 @@ module Dry
         self.class.new(map(&:pristine))
       end
 
+      # @api private
+      def finalize!(freeze_values: false)
+        each { |element| element.finalize!(freeze_values: freeze_values) }
+        freeze
+      end
+
       private
 
       # @api private

data/lib/dry/configurable/version.rb

@@ -3,6 +3,6 @@
 module Dry
   module Configurable
     # @api public
-    VERSION = "0.14.0"
+    VERSION = "0.15.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-configurable
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -111,7 +111,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/dry-rb/dry-configurable/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/dry-rb/dry-configurable/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/dry-rb/dry-configurable
   bug_tracker_uri: https://github.com/dry-rb/dry-configurable/issues
 post_install_message: