bountiful_blocks 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 931ac5652dcb409ecd827ff2f7adb6daf3e102b344fe8d382ac636641bff7312
-  data.tar.gz: 7f3ad476b417b2fc042491d103943a5ccb57fbe8da3b4b1b39c0cc44617382bc
+  metadata.gz: 67aa1f4e399b6e73e1b336b1c5c1bb93d11dd32f661fcaaa5f9c4436285dc75d
+  data.tar.gz: bf6ab6419e32e4bc6cab4859654afce4c968a5e1505469a8dc7cd626ab037970
 SHA512:
-  metadata.gz: 563b2ed6adb3987cd598edbf28affcc7b72b143867110ebe52a64a5f6604fc5f8daff13460d067c566452764cf8d625d7dc4400d5486da73a24f0f40a21febf2
-  data.tar.gz: 5136107120ac4e8b8d8f4e7fd244d8e18594da36aa6dfa2b6eee40a00ebaf2ee15ce9b8ac9c9c4c067ae10a70aa23564a728c6cbdc3b07085f4662f617b870bd
+  metadata.gz: a5f002cf969382785b756b1e04e62ca870b0d941a824875619666733ce0f708b4e6574d8c24122f582669a579dad0e82452db6381dc7c216be78cd45ffb93ace
+  data.tar.gz: f808fb510faceaf5c1e2aee72ac641cc34e985dca9919d5b7242500f33ab0a1fc3fa52ded5494ab4aa5a9b00a0bde010da6959930409b1cd4572745955d8b4ab

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+<!--[//]: # (
+## <Release number> <Date YYYY-MM-DD>
+### Breaking changes
+### Deprecations
+### New features
+### Bug fixes
+)-->
+
+## 1.1.1 2023-10-12
+
+### New features
+
+- Added `given_blocks!` utility method.
+
+### Bug fixes
+
+- The `given!` utility method was never filled during instantiation, now it works as described.
+- Trying to invoke a block that was not passed now produces `NoMethodError` instead of `FrozenError`.
+
+## 1.1.0 2023-09-07
+
+### New features
+
+- Added `raw!`, `given!`, and `call_all!` utility methods.
+- Now multiblocks are always frozen after construction.
+- Added RBS type signatures.
+
+### Bug fixes
+
+- Fixed enforcing of block names limitations.
+- Removed the `Error` class.
+
 ## 1.0.0 2023-05-30
 
 First release. Refer to [README.md](README.md) for the full documentation.

data/README.md

@@ -94,6 +94,20 @@ def deliver message, &block
 end
 ```
 
+### Names
+
+Block names follow the same rules as method names, with the exception that they can't end in `!`, `?`, or `=`.
+
+### Utility methods
+
+To avoid conflicts, all utility method names will end in either `!`, `?`, or `=`.
+
+- `raw!` returns the value returned by the block, which can be useful to allow a block to work both as a regular block and a multiblock.
+- `given?(name)` returns `true` if a block named `name` was provided.
+- `given!` returns the names of all the provided blocks.
+- `given_blocks!` returns all the provided blocks in a hash indexed by their names.
+- `call_all!` returns a Hash that maps all block names to their results. You can provide arguments to `call_all!` and they will be forwarded in turn to all blocks. Notice that since multiblocks are frozen, `call_all!` can't cache the Hash and must create a new one on every invocation.
+
 ## Version numbers
 
 BountifulBlocks loosely follows [Semantic Versioning](https://semver.org/), with a hard guarantee that breaking changes to the public API will always coincide with an increase to the `MAJOR` number.

data/lib/bountiful_blocks/multiblock.rb

@@ -1,28 +1,61 @@
 module BountifulBlocks
   class Multiblock
     def initialize *required_blocks, &block
-      instance_exec(&block)
+      @raw = instance_exec(&block)
 
       missing_blocks = required_blocks.reject { |method_name| given? method_name }
 
       raise ArgumentError, "Block required for #{missing_blocks.join ', '}" unless missing_blocks.empty?
+
+      singleton_class.class_exec do
+        undef_method :method_missing
+        undef_method :respond_to_missing?
+      end
+
+      given!.freeze
+      given_blocks!.freeze
+      freeze
     end
 
     def method_missing(name, *args, **kwargs, &block)
-      super unless args.empty? && kwargs.empty?
-      super if name.end_with? '!', '?', '='
+      return super unless args.empty? && kwargs.empty?
+      return super if name.end_with? '!', '?', '='
 
       define_singleton_method name, &block
+      given! << name
+      given_blocks![name] = block
+
+      nil
     end
 
     def respond_to_missing?(name, *args, **kwargs, &block)
-      super if name.end_with? '!', '?', '='
+      return super if name.end_with? '!', '?', '='
 
       true
     end
 
     def given? name
-      singleton_class.method_defined? name
+      given_blocks!.key? name
+    end
+
+    def given!
+      @given = [] unless defined?(@given)
+
+      @given
+    end
+
+    def given_blocks!
+      @given_blocks = {} unless defined?(@given_blocks)
+
+      @given_blocks
+    end
+
+    def raw!
+      @raw
+    end
+
+    def call_all!(*args, **kwargs, &block)
+      given_blocks!.transform_values { |given_block| given_block.call(*args, **kwargs, &block) }
     end
   end
 end

data/lib/bountiful_blocks/version.rb

@@ -1,3 +1,3 @@
 module BountifulBlocks
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/lib/bountiful_blocks.rb

@@ -1,8 +1,4 @@
 require_relative 'bountiful_blocks/version'
 
-module BountifulBlocks
-  class Error < StandardError; end
-end
-
 require_relative 'bountiful_blocks/multiblock'
 require_relative 'bountiful_blocks/kernel_patch'

data/sig/lib/bountiful_blocks/kernel_patch.rbs

@@ -0,0 +1,3 @@
+module Kernel
+  def Multiblock: (*Symbol required_blocks) { () -> untyped } -> BountifulBlocks::Multiblock
+end

data/sig/lib/bountiful_blocks/multiblock.rbs

@@ -0,0 +1,9 @@
+module BountifulBlocks
+  class Multiblock
+    def initialize: (*Symbol required_blocks) { () -> untyped } -> void
+    def given?: (Symbol name) -> bool
+    def given!: () -> Array[Symbol]
+    def raw!: () -> untyped
+    def call_all!: () -> Hash[Symbol, untyped]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bountiful_blocks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Moku S.r.l.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies: []
 description: A simple and idiomatic way to pass multiple blocks to a method.
 email:
@@ -28,6 +28,8 @@ files:
 - lib/bountiful_blocks/kernel_patch.rb
 - lib/bountiful_blocks/multiblock.rb
 - lib/bountiful_blocks/version.rb
+- sig/lib/bountiful_blocks/kernel_patch.rbs
+- sig/lib/bountiful_blocks/multiblock.rbs
 homepage: https://github.com/moku-io/bountiful_blocks
 licenses:
 - MIT
@@ -50,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A simple and idiomatic way to pass multiple blocks to a method.