infusible 3.12.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f8f3b8f6436cd0680e83f6fd85cf24a937564c532e30cb1ed673ae021cacba5
-  data.tar.gz: 3b196093e64782508fc4a0ecd62f097e51558461ecd3f990dd167b7ac8d27b57
+  metadata.gz: 8aafcac6a14000c504e84fefaf288d754358473a8c5d339ee149608dcc9dae74
+  data.tar.gz: 5fb2e41cb5b78221c4988024b8d41c472610fefe15176f344a70d6de441b4449
 SHA512:
-  metadata.gz: 256c3ddb473dd6a3c0ab609c104e7a464ecd65b6a43f25f751f8346dd48192b7422b8f8f5b751ee2db06e30867a048991d021c5c70dafe8f26eafa603addef58
-  data.tar.gz: beeb2782f186e40cc56b7d4ad6a347e94fa9710627d330e3fef26db1300604fd39a7dd247844f874da831a6bdb18f37e418cc86acfc9dd6a6a44b9cdf2bdf888
+  metadata.gz: ed25aa5de1c5ab6b967d3000ba2fa3b12a63973e68a04f48a3d55adcb6ffcf41140061bb208b091f5de249036f0ea826999f6f506fb6db2e6cc283e98b15a215
+  data.tar.gz: 38506f23c2abf7450dd61ca7888b606cec74cb290cc173c789aa886006cf925398bf6c56c2e99ebb1331018fa8ed8129ec98392620120db3c475e6f2dc89263d

data/README.adoc

@@ -14,10 +14,10 @@ When coupled with {dependency_injection_containers_link}, as provided by the {co
 
 [source,ruby]
 ----
-Import = Infusible[a: 1, b: 2, c: 3]
+Dependencies = Infusible[a: 1, b: 2, c: 3]
 
 class Demo
-  include Import[:a, :b, :c]
+  include Dependencies[:a, :b, :c]
 
   def to_s = "My injected dependencies are: #{a}, #{b}, and #{c}."
 end
@@ -80,10 +80,10 @@ There is basic and advanced usage. We'll start with the basics and work our to m
 This gem requires three steps for proper use:
 
 . A container.
-. An import constant.
+. A dependencies constant.
 . An object and/or multiple objects for dependencies to be injected into.
 
-Let's walk through each staring by defining a container of dependencies.
+Let's walk through each by defining a container of dependencies.
 
 ==== Containers
 
@@ -105,25 +105,25 @@ module Container
 end
 ----
 
-==== Imports
+==== Setup
 
-Once your container is defined, you'll want to define the corresponding import for reuse within your application. Defining an import only requires two lines of code:
+Once your container is defined, you'll want to set it up for reuse within your application. This only requires two lines of code:
 
 [source,ruby]
 ----
 require "infusible"
 
-Import = Infusible[Container]
+Dependencies = Infusible[Container]
 ----
 
 ==== Dependencies
 
-With your container and import defined, you can inject your dependencies by including what you need:
+With your container configured for injection, you can inject your dependencies by including what you need:
 
 [source,ruby]
 ----
 class Pinger
-  include Import[:http, :logger]
+  include Dependencies[:http, :logger]
 
   def call url
     http.get(url).status.then { |status| logger.info %(The status of "#{url}" is #{status}.) }
@@ -150,7 +150,7 @@ You can use symbols, strings, or a combination of both when defining which depen
 [source,ruby]
 ----
 class Pinger
-  include Import[:http, "logger"]
+  include Dependencies[:http, "logger"]
 
   def call = puts "Using: #{http.inspect} and #{logger.inspect}."
 end
@@ -163,7 +163,7 @@ To access namespaced dependencies within a container, you only need to provide t
 [source,ruby]
 ----
 class Pinger
-  include Import["primary.http", "primary.logger"]
+  include Dependencies["primary.http", "primary.logger"]
 
   def call = puts "Using: #{http.inspect} and #{logger.inspect}."
 end
@@ -178,7 +178,7 @@ Should you want to rename your namespaced dependencies to something more appropr
 [source,ruby]
 ----
 class Pinger
-  include Import[client: "primary.http"]
+  include Dependencies[client: "primary.http"]
 
   def call = puts "Using: #{client.inspect}."
 end
@@ -191,7 +191,7 @@ You can also mix names, namespaces, and aliases for injection as long as the ali
 [source,ruby]
 ----
 class Pinger
-  include Import[:configuration, "primary.logger", client: :http]
+  include Dependencies[:configuration, "primary.logger", client: :http]
 
   def call = puts "Using: #{configuration.inspect}, #{logger.inspect}, and #{client.inspect}."
 end
@@ -204,7 +204,7 @@ Earlier, when demonstrating basic usage, all dependencies were injected by defau
 [source,ruby]
 ----
 class Pinger
-  include Import[:http, :logger]
+  include Dependencies[:http, :logger]
 end
 ----
 
@@ -213,11 +213,11 @@ end
 [source,ruby]
 ----
 class Downloader
-  include Import[:http]
+  include Dependencies[:http]
 end
 ----
 
-This allows you to reuse `Import` in as many situations as makes sense while improving performance.
+This allows you to reuse `Dependencies` in as many situations as makes sense while improving performance.
 
 ==== Custom Initialization
 
@@ -226,7 +226,7 @@ Should you want to use injection in combination with your own initializer, you'l
 [source,ruby]
 ----
 class Pinger
-  include Import[:logger]
+  include Dependencies[:logger]
 
   def initialize(http: HTTP, **)
     super(**)
@@ -258,7 +258,7 @@ class Parent
 end
 
 class Child < Parent
-  include Import[:logger]
+  include Dependencies[:logger]
 end
 ----
 
@@ -267,11 +267,11 @@ In the above situation, the child's logger will be the logger that is injected w
 [source,ruby]
 ----
 class Parent
-  include GeneralImport[:logger]
+  include GeneralDependencies[:logger]
 end
 
 class Child < Parent
-  include Import[:logger]
+  include Dependencies[:logger]
 end
 ----
 
@@ -280,25 +280,25 @@ Once again, the child's logger will take precedence over the what is provided by
 [source,ruby]
 ----
 class Parent
-  include Import[:logger]
+  include Dependencies[:logger]
 end
 
 class Child < Parent
-  include Import[:http]
+  include Dependencies[:http]
 end
 ----
 
 With the above, the child class will have access to both the `logger` and `http` dependencies.
 
-⚠️ Be careful when using parent dependencies within your child classes since they are _private by default_. Even though you can reach them, they might change, which can break your downstream dependencies and probably should be avoided or at least defined as `protected` by your parent objects in order to avoid breaking the parent/child relationship.
+⚠️ Be careful when using parent dependencies within your child classes since they are _private by default_. Even though you can reach them, they might change, which can break downstream dependencies and should be avoided. To prevent this, use `protected` injection via your parent objects in order to avoid breaking the parent/child relationship (this is explained further below).
 
 ==== Scopes
 
 By default -- and in all of the examples shown so far -- your dependencies are private by default when injected but you can make them public or protected. Here's a quick guide:
 
-* `include Import[:logger]`: Injects a _private_ logger dependency.
-* `include Import.protected(logger)`: Injects a _protected_ logger dependency. Useful with inheritance and a subclass that needs access to the dependency.
-* `include Import.public(:logger)`: Injects a _public_ logger dependency.
+* `include Dependencies[:logger]`: Injects a _private_ logger dependency.
+* `include Dependencies.protected(logger)`: Injects a _protected_ logger dependency. Useful with inheritance and a subclass that needs access to the dependency.
+* `include Dependencies.public(:logger)`: Injects a _public_ logger dependency.
 
 There is no `+#private+` method since `#[]` does this for you and is _recommended practice_. Use of `+#public+` and `+#protected+` should be used sparingly or not at all if you can avoid it. Here's an example where public, protected, and private dependencies are injected:
 
@@ -312,12 +312,12 @@ module Container
   register :three, "Three"
 end
 
-Import = Infusible[Container]
+Dependencies = Infusible[Container]
 
 class Demo
-  include Import.public(:one)
-  include Import.protected(:two)
-  include Import[:three]
+  include Dependencies.public(:one)
+  include Dependencies.protected(:two)
+  include Dependencies[:three]
 end
 
 demo = Demo.new
@@ -342,10 +342,10 @@ module Container
   register :two, "Two"
 end
 
-Import = Infusible[Container]
+Dependencies = Infusible[Container]
 
 class Demo
-  include Import[:one, :two]
+  include Dependencies[:one, :two]
 
   def call = infused_keys.each { |key| puts __send__(key) }
 end
@@ -359,7 +359,7 @@ As you can see, with the _private_ `#infused_keys` attribute reader, we are able
 
 Since `#infused_keys` is a private attribute reader, this means the infused keys are private to each instance. This includes all ancestors when using inheritance as each parent class in the hierarchy will have it's own unique array of infused keys depending on what was injected for that object.
 
-All infused keys are frozen by default.
+All infused keys are frozen by default as well.
 
 === Tests
 
@@ -375,11 +375,11 @@ module Container
 end
 
 # Our import which defines our container for potential injection.
-Import = Infusible[Container]
+Dependencies = Infusible[Container]
 
 # Our action class which injects our kernel dependency from our container.
 class Action
-  include Import[:kernel]
+  include Dependencies[:kernel]
 
   def call = kernel.puts "This is a test."
 end
@@ -487,7 +487,7 @@ When you use this gem all of the construction, initialization, and setting of pr
 [source,ruby]
 ----
 class Pinger
-  include Import[:http, :logger]
+  include Dependencies[:http, :logger]
 
   def call url
     http.get(url).status.then { |status| logger.info %(The status of "#{url}" is #{status}.) }
@@ -503,9 +503,9 @@ When using this gem, along with a container like {containable_link}, make sure t
 
 * Use containers to group related dependencies that make logical sense for the namespace you are working in and avoid using containers as a junk drawer for throwing random objects in.
 * Use containers that don't have a lot of registered dependencies. If you register too many dependencies, that means your objects are too complex and need to be simplified further.
-* Use the `Import` constant to define _what_ is possible to import much like you'd use a `Container` to define your dependencies. Defining what is importable improves performance and should be defined in separate files for improved fuzzy file finding.
+* Use the `Dependencies` constant to define _what_ is possible to inject much like you'd use a `Container` to define your dependencies. Defining what is importable improves performance and should be defined in separate files for improved fuzzy file finding.
 * Use `**` to forward keyword arguments when defining an initializer which needs to pass injected dependencies upwards.
-* Prefer `Import#[]` over the use of `Import#public` and/or `Import#protected` as much as a possible since injected dependencies should be private, by default, in order to not break encapsulation. That said, there are times where making them public and/or protected can save you from writing boilerplate code.
+* Prefer `Dependencies#[]` over the use of `Dependencies#public` and/or `Dependencies#protected` as much as a possible since injected dependencies should be private, by default, in order to not break encapsulation. That said, there are times where making them public and/or protected can save you from writing boilerplate code.
 
 == Tests
 

data/infusible.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "infusible"
-  spec.version = "3.12.0"
+  spec.version = "4.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/infusible"
@@ -22,8 +22,8 @@ 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", "<= 3.4"
-  spec.add_dependency "marameters", "~> 3.12"
+  spec.required_ruby_version = "~> 3.4"
+  spec.add_dependency "marameters", "~> 4.0"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
   spec.files = Dir["*.gemspec", "lib/**/*"]

data/lib/infusible/actuator.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
 module Infusible
-  # Associates the container with the constructor for actualization.
+  # Associates the container with the builder for actualization.
   class Actuator
-    def initialize container, constructor: Infusible::Builder
+    def initialize container, builder: Infusible::Builder
       @container = container
-      @constructor = constructor
+      @builder = builder
     end
 
-    def [](*configuration) = constructor.new container, *configuration
+    def [](*configuration) = builder.new container, *configuration
 
-    def public(*configuration) = constructor.new container, *configuration, scope: __method__
+    def public(*configuration) = builder.new container, *configuration, scope: __method__
 
-    def protected(*configuration) = constructor.new container, *configuration, scope: __method__
+    def protected(*configuration) = builder.new container, *configuration, scope: __method__
 
     private
 
-    attr_reader :container, :constructor
+    attr_reader :container, :builder
   end
 end

data/lib/infusible/builder.rb

@@ -8,7 +8,6 @@ module Infusible
   class Builder < Module
     def self.define_instance_variables target, keys, keywords
       unless target.instance_variable_defined? :@infused_keys
-        target.instance_variable_set :@infused_names, keys
         target.instance_variable_set :@infused_keys, keys
       end
 
@@ -107,13 +106,6 @@ module Infusible
 
       instance_module.module_eval <<-READERS, __FILE__, __LINE__ + 1
         attr_reader :infused_keys
-
-        def infused_names
-          warn "`Inusible#infused_names` is deprecated, use `#infused_keys` instead.",
-               category: :deprecated
-          @infused_names
-        end
-
         #{computed_scope} attr_reader #{methods.join ", "}
       READERS
     end

data/lib/infusible.rb

@@ -11,9 +11,4 @@ module Infusible
   METHOD_SCOPES = %i[public protected private].freeze
 
   def self.[](container) = Actuator.new container
-
-  def self.with container
-    warn "`Infusible.#{__method__}` is deprecated, use `.[]` instead.", category: :deprecated
-    Actuator.new container
-  end
 end

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: infusible
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +34,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-11-09 00:00:00.000000000 Z
+date: 2024-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marameters
@@ -43,15 +42,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
-description:
+        version: '4.0'
 email:
 - brooke@alchemists.io
 executables: []
@@ -69,7 +67,6 @@ files:
 - lib/infusible/dependency_map.rb
 - lib/infusible/errors/duplicate_dependency.rb
 - lib/infusible/errors/invalid_dependency.rb
-- lib/infusible/stub.rb
 homepage: https://alchemists.io/projects/infusible
 licenses:
 - Hippocratic-2.1
@@ -81,16 +78,12 @@ metadata:
   label: Infusible
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/infusible
-post_install_message:
 rdoc_options: []
 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
@@ -99,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: An automatic dependency injector.
 test_files: []

data/lib/infusible/stub.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require "infusible"
-
-module Infusible
-  # Provides stubbing of the injected container when used in a test framework.
-  module Stub
-    refine Actuator do
-      def stub_with(pairs, &)
-        warn "`#{self.class}##{__method__}` is deprecated, use the Containable gem instead.",
-             category: :deprecated
-
-        return unless block_given?
-
-        container.is_a?(Hash) ? stub_hash_with(pairs, &) : stub_container_with(pairs, &)
-      end
-
-      def stub pairs
-        warn "`#{self.class}##{__method__}` is deprecated, use the Containable gem instead",
-             category: :deprecated
-
-        container.is_a?(Hash) ? stub_hash(pairs) : stub_container(pairs)
-      end
-
-      def unstub(*keys)
-        warn "`#{self.class}##{__method__}` is deprecated, use the Containable gem instead",
-             category: :deprecated
-
-        container.is_a?(Hash) ? unstub_hash(*keys) : unstub_container(*keys)
-      end
-
-      private
-
-      def stub_container_with pairs
-        stub_container pairs
-        yield
-        unstub_container(*pairs.keys)
-      end
-
-      def stub_container pairs
-        container.enable_stubs!
-        pairs.each { |key, value| container.stub key, value }
-      end
-
-      def unstub_container(*keys) = keys.each { |key| container.unstub key }
-
-      def stub_hash_with pairs
-        stub_hash pairs
-        yield
-        unstub_hash(*pairs.keys)
-      end
-
-      def stub_hash pairs
-        @backup = container.dup
-        container.merge! pairs
-      end
-
-      def unstub_hash(*keys) = container.merge! @backup.slice(*keys)
-    end
-  end
-end