dry-container 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d2d74bfa80e0afcee1e54dd79e10a7c21548e0c634c99c2c7af17d97f34166
-  data.tar.gz: 62b18ac8bd11c5b56b8637fa4a0bc90da69f61ac84a1b02d01e6b0739d2f166c
+  metadata.gz: 1142596b0e507d66a8d2fc50b0e547e562194002a66b560945b386007fee17ae
+  data.tar.gz: 01a300ee230fa9047f002d90c0a02fe8d80da49e56706deb2a29da67d2e1ea08
 SHA512:
-  metadata.gz: b0f906601ede92930ad8c12621a5f68ea1ce6a8ce1e126c967632e51b4e79b8d20d49b682d273b6ca32ebdcd87d8201c3edcae007504ef74b5ac888dd4da0cb1
-  data.tar.gz: 92fff5321a53a6e44644f82b56f1cf53a890c6c3b2ab4158bbb2caedbbd0538040165c650cb490e9d204bf585cf7121b61a8361cf895b588989b9e547cece0a4
+  metadata.gz: 7df2087f89345b9e5225f24226b7b20a2beceec88ebd424fa4a759808f7df1b355d2771370b4fbdc26d536891a68bd0c1f5b9353cb2301d10c80787466f59eaa
+  data.tar.gz: 3d83f9c597b41ad3b446ee0f1441ed42b443ac70ad0775bd17d8d5947fdf2508bf0f883e5f298ec16e908cd07bb7966f3688fba9ccd5606d76c400a76d0822c9

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 0.10.0 2022-07-10
+
+⚠️ Notice that dry-container no longer depends on dry-configurable. If you happen to rely on the advanced configurable functionality, add dry-configurable as a dependency and require it **before** requiring dry-container.
+
+### Added
+
+- Accept block given to `#merge` (via #83) (@timriley)
+
+### Changed
+
+- [BREAKING] Replace dep on dry-configurable with a simple `Configuration` mod (see #84 for more details) (@solnic)
+- Raise KeyError for missing key, with DidYouMean integration (via #82) (@cllns)
+- Wrap FrozenError, to state that the container itself is frozen (see #74) (@cllns)
+
+[Compare v0.9.0...v0.10.0](https://github.com/dry-rb/dry-container/compare/v0.9.0...v0.10.0)
+
 ## 0.9.0 2021-09-12
 
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 dry-rb team
+Copyright (c) 2015-2022 dry-rb team
 
 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/README.md

@@ -8,10 +8,10 @@
 # dry-container [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-container.svg)][gem]
-[![CI Status](https://github.com/dry-rb/dry-container/workflows/CI/badge.svg)][actions]
+[![CI Status](https://github.com/dry-rb/dry-container/workflows/ci/badge.svg)][actions]
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/227509c9034340b493f769f6277f4ecb)][codacy]
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/227509c9034340b493f769f6277f4ecb)][codacy]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-container.svg?branch=master)][inchpages]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-container.svg?branch=main)][inchpages]
 
 ## Links
 
@@ -22,8 +22,8 @@
 
 This library officially supports the following Ruby versions:
 
-* MRI `>= 2.6.0`
-* ~~jruby~~ `>= 9.3` (we are waiting for [2.6 support](https://github.com/jruby/jruby/issues/6161))
+* MRI `>= 2.7.0`
+* jruby `>= 9.3` (postponed until 2.7 is supported)
 
 ## License
 

data/dry-container.gemspec

@@ -26,11 +26,10 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-container"
   spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-container/issues"
 
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # to update dependencies edit project.yml
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
-  spec.add_runtime_dependency "dry-configurable", "~> 0.13", ">= 0.13.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/dry/container/error.rb

@@ -4,5 +4,10 @@ module Dry
   class Container
     # @api public
     Error = Class.new(StandardError)
+
+    KeyError = Class.new(::KeyError)
+    DidYouMean.correct_error(KeyError, DidYouMean::KeyErrorChecker)
+
+    deprecate_constant(:Error)
   end
 end

data/lib/dry/container/item/memoizable.rb

@@ -41,7 +41,7 @@ module Dry
 
         # @private
         def raise_not_supported_error
-          raise ::Dry::Container::Error, "Memoize only supported for a block or a proc".freeze
+          raise ::Dry::Container::Error, "Memoize only supported for a block or a proc"
         end
       end
     end

data/lib/dry/container/mixin.rb

@@ -4,6 +4,61 @@ require "concurrent/hash"
 
 module Dry
   class Container
+    # @api public
+    class Config
+      DEFAULT_NAMESPACE_SEPARATOR = "."
+      DEFAULT_RESOLVER = Resolver.new
+      DEFAULT_REGISTRY = Registry.new
+
+      # @api public
+      attr_accessor :namespace_separator
+
+      # @api public
+      attr_accessor :resolver
+
+      # @api public
+      attr_accessor :registry
+
+      # @api private
+      def initialize(
+        namespace_separator: DEFAULT_NAMESPACE_SEPARATOR,
+        resolver: DEFAULT_RESOLVER,
+        registry: DEFAULT_REGISTRY
+      )
+        @namespace_separator = namespace_separator
+        @resolver = resolver
+        @registry = registry
+      end
+    end
+
+    # @api public
+    module Configuration
+      # Use dry/configurable if it's available
+      if defined?(Configurable)
+        # @api private
+        def self.extended(klass)
+          super
+          klass.class_eval do
+            extend Dry::Configurable
+
+            setting :namespace_separator, default: Config::DEFAULT_NAMESPACE_SEPARATOR
+            setting :resolver, default: Config::DEFAULT_RESOLVER
+            setting :registry, default: Config::DEFAULT_REGISTRY
+          end
+        end
+      else
+        # @api private
+        def config
+          @config ||= Config.new
+        end
+      end
+
+      # @api private
+      def configure
+        yield config
+      end
+    end
+
     PREFIX_NAMESPACE = lambda do |namespace, key, config|
       [namespace, key].join(config.namespace_separator)
     end
@@ -31,7 +86,6 @@ module Dry
     #   container.resolve(:item)
     #   => 'item'
     #
-    #
     # @api public
     module Mixin
       # @private
@@ -44,13 +98,9 @@ module Dry
         end
 
         base.class_eval do
-          extend ::Dry::Configurable
+          extend Configuration
           extend hooks_mod
 
-          setting :registry, default: Dry::Container::Registry.new
-          setting :resolver, default: Dry::Container::Resolver.new
-          setting :namespace_separator, default: "."
-
           @_container = ::Concurrent::Hash.new
         end
       end
@@ -66,13 +116,9 @@ module Dry
       # @private
       def self.included(base)
         base.class_eval do
-          extend ::Dry::Configurable
+          extend Configuration
           prepend Initializer
 
-          setting :registry, default: Dry::Container::Registry.new
-          setting :resolver, default: Dry::Container::Resolver.new
-          setting :namespace_separator, default: "."
-
           def config
             self.class.config
           end
@@ -105,6 +151,9 @@ module Dry
         config.registry.call(_container, key, item, options)
 
         self
+      rescue FrozenError
+        raise FrozenError,
+              "can't modify frozen #{self.class} (when attempting to register '#{key}')"
       end
 
       # Resolve an item from the container
@@ -145,15 +194,16 @@ module Dry
       # @return [Dry::Container::Mixin] self
       #
       # @api public
-      def merge(other, namespace: nil)
+      def merge(other, namespace: nil, &block)
         if namespace
           _container.merge!(
-            other._container.each_with_object(::Concurrent::Hash.new) do |a, h|
-              h[PREFIX_NAMESPACE.call(namespace, a.first, config)] = a.last
-            end
+            other._container.each_with_object(::Concurrent::Hash.new) { |(key, item), hsh|
+              hsh[PREFIX_NAMESPACE.call(namespace, key, config)] = item
+            },
+            &block
           )
         else
-          _container.merge!(other._container)
+          _container.merge!(other._container, &block)
         end
 
         self
@@ -192,7 +242,8 @@ module Dry
         self
       end
 
-      # Calls block once for each key/value pair in the container, passing the key and the registered item parameters.
+      # Calls block once for each key/value pair in the container, passing the key and
+      # the registered item parameters.
       #
       # If no block is given, an enumerator is returned instead.
       #
@@ -200,9 +251,9 @@ module Dry
       #
       # @api public
       #
-      # @note In discussions with other developers, it was felt that being able to iterate over not just
-      #       the registered keys, but to see what was registered would be very helpful. This is a step
-      #       toward doing that.
+      # @note In discussions with other developers, it was felt that being able to iterate
+      #       over not just the registered keys, but to see what was registered would be
+      #       very helpful. This is a step toward doing that.
       def each(&block)
         config.resolver.each(_container, &block)
       end
@@ -293,5 +344,6 @@ module Dry
         copy
       end
     end
+    # rubocop: enable Metrics/ModuleLength
   end
 end

data/lib/dry/container/namespace.rb

@@ -24,6 +24,7 @@ module Dry
       attr_reader :name
       # @return [Proc] The block to be executed when the namespace is imported
       attr_reader :block
+
       # Create a new namespace
       #
       # @param [Mixed] name

data/lib/dry/container/resolver.rb

@@ -16,7 +16,7 @@ module Dry
       #   Fallback block to call when a key is missing. Its result will be returned
       # @yieldparam [Mixed] key Missing key
       #
-      # @raise [Dry::Container::Error]
+      # @raise [KeyError]
       #   If the given key is not registered with the container (and no block provided)
       #
       #
@@ -28,7 +28,7 @@ module Dry
           if block_given?
             return yield(key)
           else
-            raise Error, "Nothing registered with the key #{key.inspect}"
+            raise KeyError.new(%(key not found: "#{key}"), key: key.to_s, receiver: container)
           end
         end
 
@@ -69,16 +69,17 @@ module Dry
         container.each_key(&block)
       end
 
-      # Calls block once for each key in container, passing the key and the registered item parameters.
+      # Calls block once for each key in container, passing the key and
+      # the registered item parameters.
       #
       # If no block is given, an enumerator is returned instead.
       #
       # @return Key, Value
       #
       # @api public
-      # @note In discussions with other developers, it was felt that being able to iterate over not just
-      #       the registered keys, but to see what was registered would be very helpful. This is a step
-      #       toward doing that.
+      # @note In discussions with other developers, it was felt that being able
+      #       to iterate over not just the registered keys, but to see what was
+      #       registered would be very helpful. This is a step toward doing that.
       def each(container, &block)
         container.map { |key, value| [key, value.call] }.each(&block)
       end

data/lib/dry/container/version.rb

@@ -3,6 +3,6 @@
 module Dry
   class Container
     # @api public
-    VERSION = "0.9.0".freeze
+    VERSION = "0.10.0"
   end
 end

data/lib/dry/container.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "dry-configurable"
 require "dry/container/error"
 require "dry/container/namespace"
 require "dry/container/registry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-container
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-12 00:00:00.000000000 Z
+date: 2022-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,26 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: dry-configurable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="