inoculate 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2649bf406a68234451cc147c069a8b9d58ce91d2a1538e728a532ff4abda2180
-  data.tar.gz: 3bf808d9e35467647432ed7d74cab98e669a41f7e887e889735c8d583844eaf7
+  metadata.gz: 7f86297ac65acf1b0193d5afc05cda7cd6970b6ffcd3699f0003256f2fc06b8b
+  data.tar.gz: ce435f6820bd36596f50fa23d5bfbd1a018bca2f2926f5d404f04ac0f54a1296
 SHA512:
-  metadata.gz: ff27ab41b2f2da2cc6ebf22e434c88b626b9b0c2bf6dab505a9baa1a777faf82c60512a44bb258e19bf0ceb71315b0f0123ab724d6dcb65dfb0468d3d9cf7b35
-  data.tar.gz: 23212f8eeb9dc79c159651ebebc93d4ca13ad7623aa2d85622fe8de7b64f993880db5837e51a072f9116bffc169f02030b0676247f1befb254e86023443436ed
+  metadata.gz: 885671688aa9dc16c6bde1f677326049d8c5d53fbaf8300e77c4c86d5ded34719ba1dbee542f3baa29a1d5d6c35e75773564142aab6e159448a564a8f49ca9f0
+  data.tar.gz: 2b709302a5cba52f5eff6d8faae9e0d1fbfefe893c20763d6ea4865f113af010993bbf89b15cdfe6c6090a52b36e3fb9d8ff513d16d24a0741b323f7c5aff0c5

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.5.0 \[2022-10-13]
+
+* Add thread singleton dependency registration.
+
+## v0.4.0 \[2022-10-13]
+
+* Add singleton dependency registration.
+
 ## v0.3.0 \[2022-10-11]
 
 * Add instance dependency registration.

data/README.md

@@ -25,6 +25,7 @@ It provides several life-cycles and provides dependency access through private a
    1. [Dependency Life Cycles](#dependency-life-cycles)
       1. [Transient](#transient)
       2. [Instance](#instance)
+      3. [Singleton](#singleton)
    2. [Renaming the Declaration API](#renaming-the-declaration-api)
    3. [Hide Your Dependency on Inoculate](#hide-your-dependency-on-inoculate)
 3. [Installation](#installation)
@@ -100,13 +101,16 @@ class Example
    end
 end
 
-puts Example.new
+a = Example.new
+puts a, a, a
 ```
 
 This results in:
 
 ```
 Count is: 0
+Count is: 0
+Count is: 0
 => nil    
 ```
 
@@ -158,6 +162,128 @@ This results in:
 => nil  
 ```
 
+#### Singleton
+Singleton dependencies are constructed once.
+
+```ruby
+class Counter
+   attr_reader :count
+
+   def initialize
+      @count = 0
+   end
+   
+   def inc
+      @count += 1
+   end
+end
+
+Inoculate.initialize do |config|
+   config.singleton(:counter) { Counter.new }
+end
+
+class Example
+   include Inoculate::Porter
+   inoculate_with :counter
+   
+   def initialize(name)
+      @name = name
+   end
+   
+   def to_s
+      counter.inc
+      "[#{@name}] Count is: #{counter.count}"
+   end
+end
+
+a = Example.new("a")
+b = Example.new("b")
+puts a, a, b
+```
+
+This results in:
+
+```
+[a] Count is: 1
+[a] Count is: 2                         
+[b] Count is: 3                         
+=> nil   
+```
+
+#### Thread Singleton
+Thread Singleton dependencies are constructed once for any thread or fiber.
+
+```ruby
+class Counter
+   attr_reader :count
+
+   def initialize
+      @count = 0
+   end
+   
+   def inc
+      @count += 1
+   end
+end
+
+Inoculate.initialize do |config|
+   config.thread_singleton(:counter) { Counter.new }
+end
+
+class Example
+   include Inoculate::Porter
+   inoculate_with :counter
+   
+   def initialize(name)
+      @name = "Example: #{name}"
+   end
+   
+   def to_s
+      counter.inc
+      "[#{@name}] Count is: #{counter.count}"
+   end
+end
+
+class AnotherExample
+   include Inoculate::Porter
+   inoculate_with :counter
+
+   def initialize(name)
+      @name = "AnotherExample: #{name}"
+   end
+
+   def to_s
+      5.times { counter.inc }
+      "[#{@name}] Count is: #{counter.count}"
+   end
+end
+
+threads = %w[a b].map do |tag|
+   Thread.new(tag) do |t|
+      e = Example.new(t)
+      a = AnotherExample.new(t)
+      puts e, e, a, a
+   end
+end
+
+threads.each(&:join)
+```
+
+This results in:
+
+```
+[Example: a] Count is: 1
+[Example: b] Count is: 1
+[Example: b] Count is: 2
+[Example: a] Count is: 2
+[AnotherExample: b] Count is: 7
+[AnotherExample: a] Count is: 7
+[AnotherExample: b] Count is: 12
+[AnotherExample: a] Count is: 12
+=> [#<Thread:0x000000010d703c68 (irb):177 dead>, #<Thread:0x000000010d703b50 (irb):177 dead>]
+```
+
+
 ### Renaming the Declaration API
 The `inoculate_with` API is named to avoid immediate collisions with other modules
 and code you may have. You can use it as-is, or rename it to something you see fit

data/lib/inoculate/configurer.rb

@@ -27,6 +27,24 @@ module Inoculate
       nil
     end
 
+    # Register a singleton dependency.
+    # @see Manufacturer#singleton
+    #
+    # @since 0.4.0
+    def singleton(name, &block)
+      manufacturer.singleton(name, &block)
+      nil
+    end
+
+    # Register a thread singleton dependency.
+    # @see Manufacturer#thread_singleton
+    #
+    # @since 0.5.0
+    def thread_singleton(name, &block)
+      manufacturer.thread_singleton(name, &block)
+      nil
+    end
+
     private
 
     attr_reader :manufacturer

data/lib/inoculate/manufacturer.rb

@@ -5,7 +5,6 @@ require "digest"
 module Inoculate
   # Registers and builds dependency injection modules.
   # @todo singleton life cycle
-  # @todo instance life cycle
   # @todo thread singleton life cycle
   #
   # @since 0.1.0
@@ -40,16 +39,7 @@ module Inoculate
     #
     # @since 0.1.0
     def transient(name, &block)
-      validate_dependency_name name
-      raise Errors::AlreadyRegistered if @registered_blueprints.has_key? name
-      raise Errors::RequiresCallable if block.nil?
-
-      blueprint_name = name.to_sym
-      @registered_blueprints[blueprint_name] = {
-        lifecycle: :transient,
-        factory: block,
-        accessor_module: build_module(blueprint_name, :transient, block)
-      }
+      register_blueprint(name, :transient, &block)
     end
 
     # Register an instance dependency.
@@ -72,26 +62,78 @@ module Inoculate
     #
     # @since 0.3.0
     def instance(name, &block)
+      register_blueprint(name, :instance, &block)
+    end
+
+    # Register a singleton dependency.
+    #
+    # A singleton dependency gets created once.
+    #
+    # @example With a block
+    #   manufacturer.singleton(:sha1_hasher) { Digest::SHA1.new }
+    #
+    # @example With a Proc
+    #   manufacturer.singleton(:sha1_hasher, &-> { Digest::SHA1.new })
+    #
+    # @param name [Symbol, #to_sym] the dependency name which will be used to access it
+    # @param block [Block, Proc] a factory method to build the dependency
+    #
+    # @raise [Errors::RequiresCallable] if no block is provided
+    # @raise [Errors::InvalidName] if the name is not a symbol, cannot be converted to a symbol,
+    #                              or is not a valid attribute name
+    # @raise [Errors::AlreadyRegistered] if the name has been registered previously
+    #
+    # @since 0.4.0
+    def singleton(name, &block)
+      register_blueprint(name, :singleton, &block)
+    end
+
+    # Register a thread singleton dependency.
+    #
+    # A thread singleton dependency gets created once per thread or fiber.
+    #
+    # @example With a block
+    #   manufacturer.thread_singleton(:sha1_hasher) { Digest::SHA1.new }
+    #
+    # @example With a Proc
+    #   manufacturer.thread_singleton(:sha1_hasher, &-> { Digest::SHA1.new })
+    #
+    # @param name [Symbol, #to_sym] the dependency name which will be used to access it
+    # @param block [Block, Proc] a factory method to build the dependency
+    #
+    # @raise [Errors::RequiresCallable] if no block is provided
+    # @raise [Errors::InvalidName] if the name is not a symbol, cannot be converted to a symbol,
+    #                              or is not a valid attribute name
+    # @raise [Errors::AlreadyRegistered] if the name has been registered previously
+    #
+    # @since 0.5.0
+    def thread_singleton(name, &block)
+      register_blueprint(name, :thread_singleton, &block)
+    end
+
+    private
+
+    def register_blueprint(name, lifecycle, &block)
       validate_dependency_name name
       raise Errors::AlreadyRegistered if @registered_blueprints.has_key? name
       raise Errors::RequiresCallable if block.nil?
 
       blueprint_name = name.to_sym
       @registered_blueprints[blueprint_name] = {
-        lifecycle: :instance,
+        lifecycle: lifecycle,
         factory: block,
-        accessor_module: build_module(blueprint_name, :instance, block)
+        accessor_module: build_module(blueprint_name, lifecycle, block)
       }
     end
 
-    private
-
     def build_module(name, lifecycle, factory)
-      module_name = "I#{Digest::SHA1.hexdigest(name.to_s)}"
+      module_name = "I#{hash_name(name)}"
       module_body =
         case lifecycle
         when :transient then build_transient(name, factory)
         when :instance then build_instance(name, factory)
+        when :singleton then build_singleton(name, factory)
+        when :thread_singleton then build_thread_singleton(name, factory)
         else raise ArgumentError, "Life cycle #{lifecycle} is not valid. Something has gone very wrong."
         end
 
@@ -105,7 +147,7 @@ module Inoculate
     end
 
     def build_instance(name, factory)
-      cache_variable_name = "@icache_#{Digest::SHA1.hexdigest(name.to_s)}"
+      cache_variable_name = "@icache_#{hash_name(name)}"
       Module.new do
         define_method(name) do
           instance_variable_set(cache_variable_name, factory.call) unless instance_variable_defined?(cache_variable_name)
@@ -115,6 +157,24 @@ module Inoculate
       end
     end
 
+    def build_singleton(name, factory)
+      cache_variable_name = "@@icache_#{hash_name(name)}"
+      Module.new do |mod|
+        define_method(name) do
+          mod.class_variable_set(cache_variable_name, factory.call) unless mod.class_variable_defined?(cache_variable_name)
+          mod.class_variable_get(cache_variable_name)
+        end
+        private name
+      end
+    end
+
+    def build_thread_singleton(name, factory)
+      thread_variable_name = "icache_#{hash_name(name)}"
+      Module.new do
+        private define_method(name) { Thread.current[thread_variable_name] ||= factory.call }
+      end
+    end
+
     def validate_dependency_name(name)
       raise Errors::InvalidName, "name must be a symbol or convert to one" unless name.respond_to? :to_sym
       begin
@@ -123,5 +183,9 @@ module Inoculate
         raise Errors::InvalidName, "name must be a valid attr_reader"
       end
     end
+
+    def hash_name(name)
+      Digest::SHA1.hexdigest(name.to_s)
+    end
   end
 end

data/lib/inoculate/version.rb

@@ -2,5 +2,5 @@
 
 module Inoculate
   # The library version.
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/sig/inoculate.rbs

@@ -34,6 +34,8 @@ module Inoculate
     attr_reader registered_blueprints: Hash[builder_name, blueprint]
     def transient: (builder_name | _ToSymbol) { () -> void } -> void
     def instance: (builder_name | _ToSymbol) { () -> void } -> void
+    def singleton: (builder_name | _ToSymbol) { () -> void } -> void
+    def thread_singleton: (builder_name | _ToSymbol) { () -> void } -> void
   end
 
   class Configurer
@@ -41,6 +43,8 @@ module Inoculate
 
     def transient: (builder_name | _ToSymbol) { () -> void } -> nil
     def instance: (builder_name | _ToSymbol) { () -> void } -> nil
+    def singleton: (builder_name | _ToSymbol) { () -> void } -> nil
+    def thread_singleton: (builder_name | _ToSymbol) { () -> void } -> nil
 
     private
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inoculate
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Stephan Tarulli
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies: []
 description: |
   Inoculate is a small, thread-safe dependency injection library configured entirely with Ruby.