inoculate 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd8610b9bbde1304734505a64fdf22c8665961e3b02d93171ac4fc6ccf313aa
-  data.tar.gz: 66ee174fa4bd02dfd671a39a946a8343da1d63bb88f9be05ee94816d033a5e4e
+  metadata.gz: 7f86297ac65acf1b0193d5afc05cda7cd6970b6ffcd3699f0003256f2fc06b8b
+  data.tar.gz: ce435f6820bd36596f50fa23d5bfbd1a018bca2f2926f5d404f04ac0f54a1296
 SHA512:
-  metadata.gz: bbc2655324e68cd2ad977192b81f9cbef0d63b72da91f05521c59eb91f1d58993da68dbcd8d4f6b69be5e5d93708e847f567955f80cb042761e187b64c1bcdbc
-  data.tar.gz: ef316f9b6e6dfa9cd42811f8af5082f402d0c03478a280a2728b61ce9c706a9e0b1cd0249921d18818cfa85b28ccf81969a1330744c3d8d19e95e5fd4f73a81c
+  metadata.gz: 885671688aa9dc16c6bde1f677326049d8c5d53fbaf8300e77c4c86d5ded34719ba1dbee542f3baa29a1d5d6c35e75773564142aab6e159448a564a8f49ca9f0
+  data.tar.gz: 2b709302a5cba52f5eff6d8faae9e0d1fbfefe893c20763d6ea4865f113af010993bbf89b15cdfe6c6090a52b36e3fb9d8ff513d16d24a0741b323f7c5aff0c5

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## v0.4.0 \[Unreleased]
+## v0.5.0 \[2022-10-13]
+
+* Add thread singleton dependency registration.
+
+## v0.4.0 \[2022-10-13]
 
 * Add singleton dependency registration.
 

data/README.md

@@ -210,6 +210,80 @@ This results in:
 => 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

@@ -36,6 +36,15 @@ module Inoculate
       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

@@ -88,6 +88,29 @@ module Inoculate
       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)
@@ -110,6 +133,7 @@ module Inoculate
         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
 
@@ -144,6 +168,13 @@ module Inoculate
       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

data/lib/inoculate/version.rb

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

data/sig/inoculate.rbs

@@ -35,6 +35,7 @@ module Inoculate
     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
@@ -43,6 +44,7 @@ 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inoculate
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Stephan Tarulli