containable 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0196e80ae25f490ddef02425b0c6b6653a00919ded08f09ca0b296d11198c07
-  data.tar.gz: c8c754a7040e460342483ac3b5076e98f941f8e4c5a40db74a0a134a6871adb3
+  metadata.gz: 03b03ef9e9b2f3963c7b8dc64807da3db0a5ba339cd933aa83929f48e12fe996
+  data.tar.gz: 49898b80595fdeb8be50235944f64716d0cc3abd76446245553b278b9b01268e
 SHA512:
-  metadata.gz: b6097aa38991af6cf7c30da1854043a62902a4ba64d29ad06a1801644b9a9a37d450d180f62afc930c4d26d277f327552e2de910138bec36ab97663f82ed66b4
-  data.tar.gz: 29d0f74c94018358c72156ef2a02479652cc844cb9abbafb68fa6f46abf855c0c8876c7af2e411674c26680d2377c9b588e66a138d011c6459b124e62f432fe6
+  metadata.gz: e983cb009b3666b52a17f6a6e353d6fc3ff2af45d90f006b77f5ff5cc995c635e6c85156609ac48a171e617940fa65e7078138b0e19946cbc7815aa65e1b30bc
+  data.tar.gz: '054188fa73ba2ea431b4f15152ba361a3dd8e9dad24c54181d327f357506d382482ec9d629d6a291e2e17e78a147630c3376e75799b28a32685517c9f5f66337'

data/README.adoc

@@ -93,7 +93,7 @@ end
 # Only a module can be a container. (TypeError)
 ----
 
-This is important since containers are only meant to hold your dependencies and nothing else. Modules are the perfect construct for this.
+This is important since containers are only meant to hold your dependencies and nothing else. Modules are perfect for this.
 
 === Registration
 
@@ -175,6 +175,19 @@ Container[:three] = 3
 
 With the above, a combination of `.register` and `.[]=` (setter) messages are used. While the latter is handy the former should be preferred for improved readability.
 
+⚠️ Due to registration being flexible to begin with, avoid nesting closures. Example:
+
+[source,ruby]
+----
+# No
+register(:sanitizer) { -> content { Sanitize.fragment content, Sanitize::Config::BASIC } }
+
+# Yes
+register :sanitizer, -> content { Sanitize.fragment content, Sanitize::Config::BASIC }
+----
+
+While the former will work, there is no benefit to nesting like this. The latter is more performant because you don't have to unwrap the nested closure to achieve the same functionality since there is nothing to achieve from the lazy resolution of the sanitize functionality.
+
 === Resolution
 
 Now that you understand how to register dependencies, we can talk about resolving them. There are two ways to resolve a dependency. Example:
@@ -504,7 +517,7 @@ You'll notice, in all of the examples, only two methods are used: `.stub!` and `
 
 _Always_ use `.stub!` to set your container up for testing. Once setup, you can add more stubs by using the `.stub` method (without the bang). So, to recap, use `.stub!` as a one-liner for setup and initial stubs then use `.stub` to add more stubs after the fact. Finally, ensure you restore (i.e. `.restore`) your container for proper cleanup after each test.
 
-‼️ Use of `.stub!`, while convenient for testing, should -- under no circmstances -- be used in production code because it is meant for testing purposes only.
+‼️ Use of `.stub!`, while convenient for testing, should -- under no circumstances -- be used in production code because it is meant for testing purposes only.
 
 == Development
 
@@ -541,6 +554,8 @@ bin/rake
 
 == link:https://alchemists.io/policies/contributions[Contributions]
 
+== link:https://alchemists.io/policies/developer_certificate_of_origin[Developer Certificate of Origin]
+
 == link:https://alchemists.io/projects/containable/versions[Versions]
 
 == link:https://alchemists.io/community[Community]

data/containable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "containable"
-  spec.version = "0.3.0"
+  spec.version = "0.5.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/containable"
@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     "bug_tracker_uri" => "https://github.com/bkuhlmann/containable/issues",
     "changelog_uri" => "https://alchemists.io/projects/containable/versions",
-    "documentation_uri" => "https://alchemists.io/projects/containable",
+    "homepage_uri" => "https://alchemists.io/projects/containable",
     "funding_uri" => "https://github.com/sponsors/bkuhlmann",
     "label" => "Containable",
     "rubygems_mfa_required" => "true",
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = "~> 3.3"
+  spec.required_ruby_version = ">= 3.3", "<= 3.4"
   spec.add_dependency "concurrent-ruby", "~> 1.2"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

data/lib/containable.rb

@@ -18,4 +18,6 @@ module Containable
     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: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -74,7 +74,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/containable/issues
   changelog_uri: https://alchemists.io/projects/containable/versions
-  documentation_uri: https://alchemists.io/projects/containable
+  homepage_uri: https://alchemists.io/projects/containable
   funding_uri: https://github.com/sponsors/bkuhlmann
   label: Containable
   rubygems_mfa_required: 'true'
@@ -85,16 +85,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '3.3'
+  - - "<="
+    - !ruby/object:Gem::Version
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: A thread-safe dependency injection container.