karafka-core 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1dc79b27db2c0435b33651aa0e9431206f5154c7f1666888323d9c0c5ca4c50
-  data.tar.gz: 00e3d7694bb29cb286a926cdae3f2690a08f441b560b8a86289ec4dac4d8ddef
+  metadata.gz: 5725a5489ddec63bb880cba5cb2b2e69394f3aafeb573892c380c475812c2aa8
+  data.tar.gz: 4eafb4c97db61bae7373bed200f64329b440eae496d5712bd37374e0a20134dc
 SHA512:
-  metadata.gz: 80bfce9c07d877da97ecf1d1f0cf5c2e628d265dd38a9134654ef87d2590e431f4a18501a5a56193cdc5daa6593f10023bba12364df8fcd6f2f41d6cfedf9142
-  data.tar.gz: 249c81d7588bd7824a474bd0fd679d7840b13e21ed7bf754b0840a5075daf675d9ef758720b73adea91f50ccc328b59c6907768bc48f7e58df1b2b416c9b03d5
+  metadata.gz: 5e9f1322799d2ecc16f930a1a2cf80c3e122b25101a32a8f3899e78df0ef1aba2dd4b97b7959c69c348d23cdaba2a65a287548a26022056f7b04714579df34f3
+  data.tar.gz: 13f54f8a7e697ce744ace8f5932d5ddeacb1a28fb181e8a1ac53e66e236b482bf3e3c3823161b33ed6e852f4301435d7b3d6ac5dc930450e27d93781f9c9dbf8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Karafka core changelog
 
+### 2.2.4 (2023-10-25)
+- [Enhancement] Allow for `lazy` evaluated constructors.
+- [Enhancement] Allow no-arg constructors.
+
 ### 2.2.3 (2023-10-17)
 - [Change] Set minimum `karafka-rdkafka` on `0.13.6`.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.2.3)
+    karafka-core (2.2.4)
       concurrent-ruby (>= 1.1)
       karafka-rdkafka (>= 0.13.6, < 0.14.0)
 

data/karafka-core.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'funding_uri' => 'https://karafka.io/#become-pro',
     'homepage_uri' => 'https://karafka.io',
-    'changelog_uri' => 'https://github.com/karafka/karafka-core/blob/master/CHANGELOG.md',
+    'changelog_uri' => 'https://karafka.io/docs/Changelog-Karafka-Core',
     'bug_tracker_uri' => 'https://github.com/karafka/karafka-core/issues',
     'source_code_uri' => 'https://github.com/karafka/karafka-core',
     'documentation_uri' => 'https://karafka.io/docs',

data/lib/karafka/core/configurable/leaf.rb

@@ -4,11 +4,16 @@ module Karafka
   module Core
     module Configurable
       # Single end config value representation
-      Leaf = Struct.new(:name, :default, :constructor, :compiled) do
+      Leaf = Struct.new(:name, :default, :constructor, :compiled, :lazy) do
         # @return [Boolean] true if already compiled
         def compiled?
           compiled
         end
+
+        # @return [Boolean] is this a lazy evaluated leaf
+        def lazy?
+          lazy == true
+        end
       end
     end
   end

data/lib/karafka/core/configurable/node.rb

@@ -30,12 +30,13 @@ module Karafka
         # @param name [Symbol] setting or nested node name
         # @param default [Object] default value
         # @param constructor [#call, nil] callable or nil
+        # @param lazy [Boolean] is this a lazy leaf
         # @param block [Proc] block for nested settings
-        def setting(name, default: nil, constructor: nil, &block)
+        def setting(name, default: nil, constructor: nil, lazy: false, &block)
           @children << if block
                          Node.new(name, block)
                        else
-                         Leaf.new(name, default, constructor, false)
+                         Leaf.new(name, default, constructor, false, lazy)
                        end
 
           compile
@@ -95,27 +96,75 @@ module Karafka
           @children.each do |value|
             # Do not redefine something that was already set during compilation
             # This will allow us to reconfigure things and skip override with defaults
-            skippable = respond_to?(value.name)
+            skippable = respond_to?(value.name) || (value.is_a?(Leaf) && value.compiled?)
+            lazy_leaf = value.is_a?(Leaf) && value.lazy?
 
-            singleton_class.attr_accessor value.name
+            # Do not create accessor for leafs that are lazy as they will get a custom method
+            # created instead
+            singleton_class.attr_accessor(value.name) unless lazy_leaf
 
             next if skippable
 
             initialized = if value.is_a?(Leaf)
-                            next if value.compiled?
-
                             value.compiled = true
-                            value.constructor ? value.constructor.call(value.default) : value.default
+
+                            if value.constructor && value.lazy?
+                              false
+                            elsif value.constructor
+                              call_constructor(value)
+                            else
+                              value.default
+                            end
                           else
                             value.compile
                             value
                           end
 
-            public_send("#{value.name}=", initialized)
+            if lazy_leaf && !initialized
+              build_dynamic_accessor(value)
+            else
+              public_send("#{value.name}=", initialized)
+            end
           end
 
           @compiled = true
         end
+
+        private
+
+        # Defines a lazy evaluated read and writer that will re-evaluate in case value constructor
+        # evaluates to `nil` or `false`. This allows us to define dynamic constructors that
+        # can react to external conditions to become expected value once this value is
+        # available
+        #
+        # @param value [Leaf]
+        def build_dynamic_accessor(value)
+          singleton_class.attr_writer(value.name)
+
+          define_singleton_method(value.name) do
+            existing = instance_variable_get("@#{value.name}")
+
+            return existing if existing
+
+            built = call_constructor(value)
+
+            instance_variable_set("@#{value.name}", built)
+          end
+        end
+
+        # Runs the constructor with or without the default depending on its arity and returns the
+        # result
+        #
+        # @param value [Leaf]
+        def call_constructor(value)
+          constructor = value.constructor
+
+          if constructor.arity.zero?
+            constructor.call
+          else
+            constructor.call(value.default)
+          end
+        end
       end
     end
   end

data/lib/karafka/core/configurable.rb

@@ -65,14 +65,14 @@ module Karafka
 
         # Two versions are needed to pass arguments in the correct way
         if RUBY_VERSION >= '2.7'
-          class_eval <<~CODE, __FILE__, __LINE__
+          class_eval <<~CODE, __FILE__, __LINE__ + 1
             # Pipes the settings setup to the config root node
             def setting(...)
               config.setting(...)
             end
           CODE
         else
-          class_eval <<~CODE, __FILE__, __LINE__
+          class_eval <<~CODE, __FILE__, __LINE__ + 1
             # Pipes the settings setup to the config root node
             # @param args [Object] anything provided to settings
             # @param block [Proc] block for settings

data/lib/karafka/core/version.rb

@@ -4,6 +4,6 @@ module Karafka
   module Core
     # Current Karafka::Core version
     # We follow the versioning schema of given Karafka version
-    VERSION = '2.2.3'
+    VERSION = '2.2.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.4
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -128,7 +128,7 @@ licenses:
 metadata:
   funding_uri: https://karafka.io/#become-pro
   homepage_uri: https://karafka.io
-  changelog_uri: https://github.com/karafka/karafka-core/blob/master/CHANGELOG.md
+  changelog_uri: https://karafka.io/docs/Changelog-Karafka-Core
   bug_tracker_uri: https://github.com/karafka/karafka-core/issues
   source_code_uri: https://github.com/karafka/karafka-core
   documentation_uri: https://karafka.io/docs