containable 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49be2a5c56c8ad8cd53ce41a6498bdb8aa47ab042cb123660dae6936ff4daade
-  data.tar.gz: dc75daed9d1f05881d54164e76e0e57a505a9d0699dc49bd1fde20f698dc6f45
+  metadata.gz: 014d1582fc52d294c3c860f611866683ec3308dd0f95c23083defc93b8db0f8a
+  data.tar.gz: 321b1a573df10500ddbc4eede5503537caee0cb3380cfd296eb6baf68c478f4e
 SHA512:
-  metadata.gz: 4a67b2f11f343e08f9e351605e9721dbd302db977c4cd0ba6146235cca362e8b348be834f274c665669de8102659445519eb08f19ddaa54d948e09613d816b18
-  data.tar.gz: 3cf88215110cc8e90f84280df6bbcc764744454b8b58a4a9cbe53bd115a4d78824cff6a5dcb08927cacafa33fc062298fa8ccd38efacdc4d8a17e23c4d10fe45
+  metadata.gz: 3dd07f1911ceb4df23b10dcdbf5364c0391a6341e5869a0f1dc94c619b493c1acaec058d315d1bc3b6c2c93dd6a2c5c5c9e23e80366098ee4e5bd99a7263a3dd
+  data.tar.gz: 7f3d378b0e9a2ecb0385e50ffcd07f9054e559104e5ebd3f2ca3ad17f1c4999107d5748aeb0a316e67742ac594901b649f8a0490cc2726dc913fc37e498a07f2

data/README.adoc

@@ -407,7 +407,7 @@ Container.clone.frozen?  # true
 
 === Customization
 
-You can customize how the container registers and resolves dependencies by creating your own register and resolver. Internally, both of these objects have access to and use `dependencies` (i.e. `Concurrent::Hash`) which stores the registered key and tuple. Example:
+You can customize how the container registers and resolves dependencies by creating your own register and resolver classes. Both classes should inherit from either `Containable::Register` or `Containable::Resolver`. Internally, each subclass has access to the `dependencies` (i.e. `Concurrent::Hash`) object which stores the registered key and associated value (tuple). Example:
 
 [source,ruby]
 ----
@@ -417,9 +417,13 @@ You can customize how the container registers and resolves dependencies by creat
 }
 ----
 
-Each tuple captures the dependency (value) and directive (i.e. `:cache` or `:fresh`). This allows you to have access to all information captured at registration. Below are a few examples on how to use and customize this information for your own purposes.
+Each tuple captures the dependency (value) and directive (i.e. `:cache` or `:fresh`). This allows you to have access to all information captured at registration. Definitely read the source code of each class to learn more.
 
-Here's how to use a custom register that doesn't care if you override an existing key.
+The following provides a few examples on how you can customize further.
+
+==== Registers
+
+Here's an example of a custom register that doesn't care if you override an existing key.
 
 [source,ruby]
 ----
@@ -441,6 +445,39 @@ end
 Container[:one]  # "override"
 ----
 
+Alternatively, you could specify which keys are allowed to be overwritten. Here's a modification to the above example that would make this possible:
+
+[source,ruby]
+----
+require "containable"
+require "refinements/array"
+
+class Register < Containable::Register
+  using Refinements::Array
+
+  def initialize(*, allowed_keys: %w[http logger], **)
+    super(*, **)
+    @allowed_keys = allowed_keys
+  end
+
+  protected
+
+  def check_duplicate key, namespaced_key
+    return if allowed_keys.include? namespaced_key
+
+    message = "Dependency is already registered: #{key.inspect}."
+
+    fail KeyError, message if dependencies.key? namespaced_key
+  end
+
+  private
+
+  attr_reader :allowed_keys
+end
+----
+
+==== Resolvers
+
 Here's an example with a custom resolver that only allows specific keys to be resolved:
 
 [source,ruby]
@@ -477,8 +514,6 @@ Container[:two]    # Only use these keys: [:one, :three] (KeyError)
 Container[:three]  # 3
 ----
 
-In both cases, you only need to inject your custom register or resolver when extending your container with `Containable`. Both of these classes should inherit from either `Containable::Register` or `Containable::Resolver` to customize behavior as you like. Definitely read the source code of both these classes to learn more.
-
 === Infusible
 
 To fully leverage the power of this gem, check out {infusible_link}. You can get far with simple containers but if you want to supercharge your containers and make your architecture truly come alive then make sure to couple this gem with the {infusible_link} gem. 🚀

data/containable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "containable"
-  spec.version = "2.2.0"
+  spec.version = "2.2.1"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/containable"

data/lib/containable/builder.rb

@@ -89,5 +89,17 @@ module Containable
     def define_frozen?
       define_method(:frozen?) { dependencies.frozen? }
     end
+
+    def define_stub
+      define_method :stub! do |**keywords|
+        require "containable/test"
+
+        extend Test
+
+        stub(**keywords)
+      end
+    end
+
+    def define_restore = define_method(:restore) { false }
   end
 end

data/lib/containable/register.rb

@@ -35,12 +35,14 @@ module Containable
       visit(&)
     end
 
-    private
+    protected
 
     attr_reader :dependencies, :separator, :directives
 
     attr_accessor :keys, :depth
 
+    def namespacify(key) = keys[..depth].append(key).join separator
+
     def check_duplicate key, namespaced_key
       message = "Dependency is already registered: #{key.inspect}."
 
@@ -54,6 +56,8 @@ module Containable
            %(Invalid directive: #{value.inspect}. Use #{directives.map(&:inspect).join " or "}.)
     end
 
+    private
+
     def visit &block
       increment
       instance_eval(&block) if block
@@ -64,7 +68,5 @@ module Containable
     def increment = self.depth += 1
 
     def decrement = self.depth -= 1
-
-    def namespacify(key) = keys[..depth].append(key).join separator
   end
 end

data/lib/containable/resolver.rb

@@ -18,7 +18,7 @@ module Containable
       process key, value, as
     end
 
-    private
+    protected
 
     attr_reader :dependencies
 

data/lib/containable.rb

@@ -12,14 +12,4 @@ module Containable
   end
 
   def self.[](register: Register, resolver: Resolver) = Builder.new(register:, resolver:)
-
-  def stub!(**)
-    require "containable/test"
-
-    extend Test
-
-    stub(**)
-  end
-
-  def restore = false
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: containable
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.11
 specification_version: 4
 summary: A thread-safe dependency injection container.
 test_files: []