template_class 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 600465ef851b0f80d3a893cef379527402986a6ca048535849d7fd9f769821fb
-  data.tar.gz: 2d51acb9d3b421458d24bba27e31106f82f9d839d34748597b2860bfb4ab6ad8
+  metadata.gz: e4c0985a84c4d73b07449fea319cd108c0a78477fa0975a0a946dcb82d05dbda
+  data.tar.gz: 35cc326a7341985c9d3a416fcad8b58a9465f4e72a083d7c4e9d153ed4f312d4
 SHA512:
-  metadata.gz: 58d7c41b98d98a4d145c4830e05edfc3234be729baf8a6bcae7b3d2a13797c26b4aa36ec2ac71f0d75531e668e0fafde0e0a9bbced5fda9e0e7933fa5ff69f0e
-  data.tar.gz: c569ddaf85a09f3bf8c60b667aa06ed313a9e6cf657b05dac11d03782f7a0b56cb231882cb9911532c13438667e2110a76f42e7add1d933bafdd82ce983e2b1f
+  metadata.gz: 1cc67fea8a072fd2fcf64a7bb7b17d22ae801b1547dd92cccd27a0e6f4c939870b032112bf845dc0974d8860d797f4e12c104f19437be369de70e8d0009ff21a
+  data.tar.gz: f756b227610d4503557b949dde1ed5f908fac9da1f3353a7dd55a7772f84e145eb419a1fad568f0a497d08d772a29a340b20fc839910ceee92baeedda9cc8065

data/CHANGELOG.md

@@ -1,12 +1,29 @@
 # Changelog
 
-[//]: # (
+<!--[//]: # (
 ## <Release number> <Date YYYY-MM-DD>
 ### Breaking changes
 ### Deprecations
 ### New features
 ### Bug fixes
-)
+)-->
+
+## 1.2.0 2024-08-19
+
+### New features
+
+- Bulk instantiation
+
+## 1.1.0 2023-08-31
+
+### New features
+
+- Added support for caching modules.
+- Added RBS type signatures.
+
+### Bug fixes
+
+- Removed the `Error` class.
 
 ## 1.0.0 2023-04-07
 

data/README.md

@@ -58,7 +58,17 @@ end
 
 `klass.new` behaves like `Class.new`, with the key difference that it saves the new class in the internal cache *before* it executes the block in the class scope. If you use `Class.new` the specialization still works as expected, but the class is cached *after* the block is executed, so a loop will be created if the code inside the block references the same specialization it is defining.
 
-`klass.new` also redefines `inspect` and `to_s` for the new class, so in strings it will appear with the usual C++ style:
+A module analogue to `klass` is passed as third parameter to the block:
+
+```ruby
+resolve_template_specialization do |item_type, _, mod|
+  mod.new do
+    ...
+  end
+end
+```
+
+`klass.new` and `mod.new` also redefine `inspect` and `to_s` for the new class/module, so in strings it will appear with the usual C++ style:
 
 ```ruby
 List[Integer].to_s # => List<Integer>
@@ -72,6 +82,32 @@ List[:any] = Array
 
 Notice that the parameter isn't constrained to classes: you can use any object.
 
+### Bulk Instantiation
+
+A module (or class) containing multiple templates can include `TemplateClass::BulkInstanceable` to be able to instantiate them in bulk using the same parameter.
+
+```ruby
+module Templates
+  include TemplateClass::BulkInstantiable
+  
+  class Template1
+    ...
+  end
+  
+  class Template2
+    ...
+  end
+end
+
+module Instances
+  Templates.bulk_instance Integer, into: self
+end
+```
+
+The new constants `Instances::Template1` and `Instances::Template2` are now defined, and they point respectively to `Templates::Template1[Integer]` and `Templates::Template2[Integer]`.
+
+The optional keyword argument `with_overrides`, which defaults to `true` if `Zeitwerk` is defined and to `false` otherwise, allows you to automatically access and reopen the instances in files that follow the Zeitwerk naming conventions (eg. you can reopen `Instances::Template1` in the file `instances/template1.rb`). If `with_overrides` is `false`, you can still reopen the instances, but you need to manually handle the appropriate `requires` in the appropriate order.
+
 ## Plans for future development
 
 - Multiple specialization parameters

data/lib/template_class/bulk_instantiable.rb

@@ -0,0 +1,21 @@
+module TemplateClass
+  module BulkInstantiable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def bulk_instantiate(*args, into:, with_overrides: defined?(Zeitwerk))
+        constants(false)
+          .map { |constant_name| const_get(constant_name) }
+          .map do |constant|
+            into.const_set constant.name.demodulize.to_sym, constant[*args]
+          end
+          .tap { return unless with_overrides } # rubocop:disable Lint/NonLocalExitFromIterator
+          .each do |instance|
+            require instance.name.underscore
+          rescue LoadError
+            nil
+          end
+      end
+    end
+  end
+end

data/lib/template_class/template.rb

@@ -46,13 +46,43 @@ module TemplateClass
         klass
       end
     end
-    private_constant :CacheClassConstructor
+
+    class CacheModuleConstructor
+      attr_reader :key
+      attr_reader :owner
+
+      delegate_missing_to :owner
+
+      def initialize key, owner
+        @key = key
+        @owner = owner
+      end
+
+      def new &block
+        mod = Module.new
+        owner[key] = mod
+
+        outer_self = self
+
+        mod.define_singleton_method :to_s do
+          "#{outer_self.owner}<#{outer_self.key}>"
+        end
+
+        mod.singleton_class.alias_method :inspect, :to_s
+
+        mod.module_exec(&block)
+        mod
+      end
+    end
+
+    private_constant :CacheClassConstructor, :CacheModuleConstructor
 
     class_methods do
       def resolve_template_specialization &block
         cache.default_proc = proc do |h, k|
           class_constructor = CacheClassConstructor.new k, self
-          result = block.call k, class_constructor
+          module_constructor = CacheModuleConstructor.new k, self
+          result = block.call k, class_constructor, module_constructor
 
           h[k] = result unless h.key? k
 

data/lib/template_class/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TemplateClass
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/lib/template_class.rb

@@ -1,9 +1,3 @@
-# frozen_string_literal: true
-
 require_relative 'template_class/version'
-
-module TemplateClass
-  class Error < StandardError; end
-end
-
 require_relative 'template_class/template'
+require_relative 'template_class/bulk_instantiable'

data/sig/lib/template_class/template.rbs

@@ -0,0 +1,13 @@
+module TemplateClass
+  module Template[T]
+    interface _CacheClassConstructor
+      def new: (?Class base_class) { () [self: Class] -> void } -> Class
+    end
+
+    interface _CacheModuleConstructor
+      def new: () { () [self: Module] -> void } -> Module
+    end
+
+    def resolve_template_specialization: () { (T key, _CacheClassConstructor klass, _CacheModuleConstructor mod) -> Class } -> void
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: template_class
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Moku S.r.l.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-07 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,14 +43,14 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/template_class.rb
+- lib/template_class/bulk_instantiable.rb
 - lib/template_class/template.rb
 - lib/template_class/version.rb
-- sig/template_class.rbs
+- sig/lib/template_class/template.rbs
 homepage: https://github.com/moku-io/template_class
 licenses:
 - MIT
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A way to define templated classes, in a similar fashion to C++ templates.

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    template_class (1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.5.0)
-    json (2.6.3)
-    parallel (1.22.1)
-    parser (3.2.1.1)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.48.1)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.13.0)
-    unicode-display_width (2.4.2)
-
-PLATFORMS
-  arm64-darwin-22
-
-DEPENDENCIES
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-  template_class!
-
-BUNDLED WITH
-   2.4.6

data/sig/template_class.rbs

@@ -1,4 +0,0 @@
-module TemplateClass
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end