declarative_initialization 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2def6406dabc72b117248ec302ac3fbb6b69dc2a67721abd229a1f5787ae50ce
-  data.tar.gz: 1bfa5430363018213e882a330e5ee83267b65a282a7cfb4f3439243a70e79887
+  metadata.gz: 3e75bb2a0843cd7164493d2acedd4c50671ad63a010b0a2ca0061ec85caa2238
+  data.tar.gz: fd8829609b1523653b8b33820e04d28714c75a08e19056b555dd35e43d8a2cbd
 SHA512:
-  metadata.gz: 150ee62b3d7034af1b9d171bbfe6f472914439c1b9af558b78f34c4e4e66a6fdf28f870af998d00fc0d73f2ef699f76cfe3443a675cdff047668d66f15179e87
-  data.tar.gz: 84dabfae84540cd6d7e0fe130e33edd1eb4126fc5a8e32d83fea676c2401c297ae70fe6de6b6c4210228ea86d7789b90be5c17311af5880e320a701b405aa3b9
+  metadata.gz: 0bf42818fb4f780f28fdaa2a9da06db4f1c7332ef9393cb93d676a875459b63efebc904c267a0cb7815593b17123003763b3c30de97a314fd928d45a72f4a067
+  data.tar.gz: 5b3dc48637e3b8b8bdf226e06185da514c0ebb6b35c7d3aaacc6364d9342ef0f694e0df47052640986333aa6ee1533b1449814efe80f56d203f2dc569947e7e1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
-## [0.1.0] - 2025-03-05
+## [0.1.1] - 2025-05-02
+- Refactor internals
+- [BUGFIX] Only trigger `attr_reader` creation on initial class load (vs on every call to `#new`)
+
 
+## [0.1.0] - 2025-03-05
 - Initial release

data/README.md

@@ -55,7 +55,7 @@ We support that by passing an optional block to `initialize_with` -- for instanc
 
 * If a method with same name already exists, we log a warning and do not create the `attr_reader`.  In that case you'll need to reference the instance variable directly.
 
-  * Because of this, best practice when referencing variables in the post-initialize block is use `@foo` rather than relying on the `foo` attr_reader
+  * Because of this, best practice when referencing variables in the post-initialize block is to use `@foo` rather than relying on the `foo` attr_reader
 
 * Due to ruby syntax limitations, we do not support referencing other fields directly in the declaration:
 

data/lib/declarative_initialization/class_methods.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module DeclarativeInitialization
+  module ClassMethods
+    # Defines an initializer expecting the specified keyword arguments.
+    # @param args [Array<Symbol>] Required keyword arguments
+    # @param kwargs [Hash<Symbol, Object>] Optional keyword arguments (required, but have default values)
+    # @param post_initialize_block [Proc] Block to execute after initialization (optional)
+    def initialize_with(*args, **kwargs, &post_initialize_block)
+      declared = args + kwargs.keys
+      _validate_arguments!(declared)
+
+      _set_up_attribute_readers(declared)
+      _set_up_block_reader
+      _define_initializer(declared, kwargs, post_initialize_block)
+    end
+
+    private
+
+    def _class_name
+      name || "Anonymous Class"
+    end
+
+    def _logger
+      @_logger ||= if defined?(Rails) && Rails.respond_to?(:logger)
+                     Rails.logger
+                   else
+                     logger = Logger.new($stdout)
+                     logger.level = Logger::WARN
+                     logger
+                   end
+    end
+
+    def _validate_arguments!(declared)
+      return if declared.all? { |arg| arg.is_a?(Symbol) }
+
+      raise ArgumentError, "[#{_class_name}] All arguments to #initialize_with must be symbols"
+    end
+
+    def _set_up_attribute_readers(declared)
+      declared.each do |key|
+        if method_defined?(key)
+          _logger.warn "[#{_class_name}] Method ##{key} already exists -- skipping attr_reader generation"
+        else
+          attr_reader key
+        end
+      end
+    end
+
+    def _set_up_block_reader
+      if method_defined?(:block)
+        _logger.warn "[#{_class_name}] Method #block already exists -- may NOT be able to reference a block " \
+                     "passed to #new as #block (use @block instead)"
+      else
+        attr_reader :block
+      end
+    end
+
+    def _define_initializer(declared, defaults, post_initialize_block)
+      define_method(:initialize) do |*given_args, **given_kwargs, &given_block|
+        class_name = self.class.name || "Anonymous Class"
+        _validate_initialization_arguments!(class_name, given_args, given_kwargs, declared, defaults)
+
+        declared.each do |key|
+          instance_variable_set(:"@#{key}", given_kwargs.fetch(key, defaults[key]))
+        end
+
+        instance_variable_set(:@block, given_block) if given_block
+        instance_exec(&post_initialize_block) if post_initialize_block
+      end
+    end
+  end
+end

data/lib/declarative_initialization/instance_methods.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DeclarativeInitialization
+  module InstanceMethods
+    private
+
+    def _validate_initialization_arguments!(class_name, given_args, given_kwargs, declared, defaults)
+      raise ArgumentError, "[#{class_name}] Only keyword arguments are accepted" unless given_args.empty?
+
+      missing = declared - given_kwargs.keys - defaults.keys
+      extra = given_kwargs.keys - declared
+
+      raise ArgumentError, "[#{class_name}] Missing keyword argument(s): #{missing.join(", ")}" unless missing.empty?
+      raise ArgumentError, "[#{class_name}] Unknown keyword argument(s): #{extra.join(", ")}" unless extra.empty?
+    end
+  end
+end

data/lib/declarative_initialization/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclarativeInitialization
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/declarative_initialization.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "declarative_initialization/version"
-require "logger"
+require_relative "declarative_initialization/class_methods"
+require_relative "declarative_initialization/instance_methods"
 
 module DeclarativeInitialization
   def self.included(base)
@@ -10,52 +11,6 @@ module DeclarativeInitialization
       extend ClassMethods
     end
   end
-
-  module ClassMethods
-    def initialize_with(*args, **kwargs, &post_initialize_block)
-      declared = args + kwargs.keys
-      raise ArgumentError, "initialize_with expects to receive symbols" unless declared.all? { |arg| arg.is_a?(Symbol) }
-
-      defaults = kwargs
-
-      define_method(:initialize) do |*given_args, **given_kwargs, &block|
-        class_name = self.class.name || "Anonymous Class"
-        raise ArgumentError, "[#{class_name}] Only accepts keyword arguments" unless given_args.empty?
-
-        missing = declared - given_kwargs.keys - defaults.keys
-        extra = given_kwargs.keys - declared
-
-        raise ArgumentError, "[#{class_name}] Missing keyword arguments: #{missing.join(", ")}" unless missing.empty?
-        raise ArgumentError, "[#{class_name}] Unknown keyword arguments: #{extra.join(", ")}" unless extra.empty?
-
-        declared.each do |key|
-          instance_variable_set(:"@#{key}", given_kwargs.fetch(key, defaults[key]))
-          if respond_to?(key, true)
-            __logger.warn "Method ##{key} already exists on #{self.class.name}. Skipping attr_reader generation."
-          else
-            self.class.send(:attr_reader, key)
-          end
-        end
-
-        if block # Automatically record any block passed to .new as an instance variable
-          instance_variable_set(:@block, block)
-          self.class.send(:attr_reader, :block) unless respond_to?(:block)
-        end
-
-        instance_exec(&post_initialize_block) if post_initialize_block
-      end
-    end
-  end
-
-  module InstanceMethods
-    def __logger
-      @__logger ||= begin
-        Rails.logger
-      rescue NameError
-        Logger.new($stdout)
-      end
-    end
-  end
 end
 
 # Set up an alias so you can also do `include InitializeWith`

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: declarative_initialization
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kali Donovan
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A declarative replacement for `def initialize` in keyword-argument-based
   POROs.
@@ -26,6 +25,8 @@ files:
 - README.md
 - Rakefile
 - lib/declarative_initialization.rb
+- lib/declarative_initialization/class_methods.rb
+- lib/declarative_initialization/instance_methods.rb
 - lib/declarative_initialization/version.rb
 homepage: https://github.com/teamshares/declarative_initialization
 licenses: []
@@ -33,7 +34,6 @@ metadata:
   homepage_uri: https://github.com/teamshares/declarative_initialization
   source_code_uri: https://github.com/teamshares/declarative_initialization
   changelog_uri: https://github.com/teamshares/declarative_initialization/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -48,8 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Reduce initialization boilerplate for Ruby classes
 test_files: []