plumb 0.0.15 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 104313a59a2f9187f582058b8f0f3c6dce43763079518d68fde511aef6112400
-  data.tar.gz: 4fc765c09d840145ebf5777cfd4e326f3705db5cfda8ee5324c5f6f4f81e0070
+  metadata.gz: 24a6b9a58d29c5aa9e443586d0d529aaf79fcf91a5ee724366d9153174c73fa9
+  data.tar.gz: c6200d6bc762aecf985e359c5326c6014003950f998406dabbfaa9c7aca8fc10
 SHA512:
-  metadata.gz: 2ca83f0ed1b4fbb2a83e11ff05bded28ed99550de9bfbec2d20d79943d886209c6b4cabeb2055857e24e60748642f0f7b541dcf5dc433107073772b085c5025a
-  data.tar.gz: 9d7b79dc0509f481730331bd3e65a1b85378d3609279b6c575ec8d77d8e786ccbe33b8dd54b0abfa826df06454793b235c1f8086a581c9a143359899cebb0318
+  metadata.gz: d683a2a89fc717f406efcc16b884cafa10dafa148be86ffc1810a377b4f065e1e40e0d21719fe70752e67d5c4eef86843076fa9ffd1513a2d345f666b705577f
+  data.tar.gz: 5788b7b83dfb2c342a9c59f1080b30e3db93f9ff7b3c3f6eda0060021275ae648406559bb9bbee96fe204463a3715571e7e042401771e98c9836f5d5306a4087

data/.rubocop.yml

@@ -1,5 +1,11 @@
 AllCops:
-  TargetRubyVersion: 3.2.2
+  TargetRubyVersion: 3.4
+inherit_from:
+  - ~/.rubocop.yml
+Style/StringLiterals:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
 Style/CaseEquality:
   Enabled: false
 Style/LambdaCall:

data/README.md

@@ -2,9 +2,9 @@
 
 **This library is work in progress!**
 
-Composable data validation, coercion and processing in Ruby. Takes over from https://github.com/ismasan/parametric
+Composable data validation, coercion and processing in Ruby. Takes over from [https://github.com/ismasan/parametric](https://github.com/ismasan/parametric)
 
-This library takes ideas from the excellent https://dry-rb.org ecosystem, with some of the features offered by Dry-Types, Dry-Schema, Dry-Struct. However, I'm aiming at a subset of the functionality with a (hopefully) smaller API surface and fewer concepts, focusing on lessons learned after using Parametric in production for many years.
+This library takes ideas from the excellent [https://dry-rb.org](https://dry-rb.org) ecosystem, with some of the features offered by Dry-Types, Dry-Schema, Dry-Struct. However, I'm aiming at a subset of the functionality with a (hopefully) smaller API surface and fewer concepts, focusing on lessons learned after using Parametric in production for many years.
 
 If you're after raw performance and versatility I strongly recommend you use the Dry gems.
 
@@ -135,7 +135,7 @@ joe = User.parse({ name: 'Joe', email: 'joe@email.com', age: 20}) # returns vali
 Users.parse([joe]) # returns valid array of user hashes
 ```
 
-More about [Types::Hash](#typeshash) and [Types::Array](#typesarray). There's also [tuples](#typestuple), [hash maps](#hash-maps), [data structs](#typesdata) and [streams](#typesstream), and it's possible to create your own composite types.
+More about [Types::Hash](#typeshash) and [Types::Array](#typesarray). There's also [tuples](#typestuple), [hash maps](#maps), [data structs](#typesdata) and [streams](#typesstream), and it's possible to create your own composite types.
 
 ### Type composition
 
@@ -329,26 +329,26 @@ type.resolve(['a', 'a', 'b']) # Valid
 type.resolve(['a', 'x', 'b']) # Failure
 ```
 
-### `#with`
+### `#where`
 
-The `#with` helper matches attributes of the object with values, using `#===`.
+The `#where` helper matches attributes of the object with values, using `#===`.
 
 ```ruby
-LimitedArray = Types::Array[String].with(size: 10)
-LimitedString = Types::String.with(size: 10)
-LimitedSet = Types::Any[Set].with(size: 10)
+LimitedArray = Types::Array[String].where(size: 10)
+LimitedString = Types::String.where(size: 10)
+LimitedSet = Types::Any[Set].where(size: 10)
 ```
 
 The size is matched via `#===`, so ranges also work.
 
 ```ruby
-Password = Types::String.with(bytesize: 10..20)
+Password = Types::String.where(bytesize: 10..20)
 ```
 
 The helper accepts multiple attribute/value pairs
 
 ```ruby
-JoeBloggs = Types::Any[User].with(first_name: 'Joe', last_name: 'Bloggs')
+JoeBloggs = Types::Any[User].where(first_name: 'Joe', last_name: 'Bloggs')
 ```
 
 #### `#transform`
@@ -669,6 +669,40 @@ when Readable
 end
 ```
 
+Or pattern matching
+
+```ruby
+case args
+  in [Iterable => list, String => id]
+    # etc
+  in [Resolvable => r]
+    # etc
+end
+```
+
+#### Merging interfaces
+
+Use the `+` operator to merge two interfaces into a new one that must support both sets of method names.
+
+```ruby
+Iterable = Types::Interface[:each, :map]
+Countable = Types::Interface[:size]
+# This one expects objects with methods :each, :map and :size
+CountableIterable = Iterable + Countable
+```
+
+#### Intersecting interfaces
+
+Use the `&` operator to produce a new interface with the intersection of method names
+
+```ruby
+I1 = Types::Interface[:a, :b, :c]
+I2 = Types::Interface[:b, :c, :d]
+# This one expects methods :b and :c
+I3 = Types::Interface[:b, :c]
+```
+
+
 TODO: make this a bit more advanced. Check for method arity.
 
 ### `Types::Hash`
@@ -1039,7 +1073,7 @@ end
 
 ### Types::Data
 
-`Types::Data` provides a superclass to define **inmutable** structs or value objects with typed / coercible attributes.
+`Types::Data` provides a superclass to define **immutable** structs or value objects with typed / coercible attributes.
 
 #### `[]` Syntax
 
@@ -1816,3 +1850,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ismasa
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Created by [Ismael Celis](https://ismaelcelis.com)

data/Rakefile

@@ -2,6 +2,8 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'docco/tasks'
+
 
 RSpec::Core::RakeTask.new(:spec)
 

data/examples/concurrent_downloads.rb

@@ -54,7 +54,7 @@ module Types
       image = result.value
       path = path_for(image.url)
       File.open(path, 'wb') { |f| f.write(image.io.read) }
-      result.valid image.with(url: path, io: File.new(path))
+      result.valid image.where(url: path, io: File.new(path))
     end
 
     def path_for(url)

data/examples/csv_stream.rb

@@ -22,7 +22,7 @@ module Types
               .transform(::Enumerator, &:each)
 
   # Turn a string file path into a CSV stream
-  # ex. csv_enum = StrinToCSV.parse('./files/data.csv') #=> Enumerator
+  # ex. csv_enum = StringToCSV.parse('./files/data.csv') #=> Enumerator
   StringToCSV = OpenFile >> FileToCSV
 end
 

data/lib/plumb/composable.rb

@@ -311,16 +311,22 @@ module Plumb
 
     # Check attributes of an object against values, using #===
     # @example
-    #   type = Types::Array.with(size: 1..10)
-    #   type = Types::String.with(bytesize: 1..10)
+    #   type = Types::Array.where(size: 1..10)
+    #   type = Types::String.where(bytesize: 1..10)
     #
     # @param attrs [Hash]
-    def with(attrs)
+    def where(attrs)
       attrs.reduce(self) do |t, (name, value)|
         t >> AttributeValueMatch.new(t, name, value)
       end
     end
 
+    # @deprecated User {#where} instead
+    def with(...)
+      warn 'Composable#with() is deprecated. Use #where() instead. #with is reserved to make copies of Data structs'
+      where(...)
+    end
+
     # Register a policy for this step.
     # Mode 1.a: #policy(:name, arg) a single policy with an argument
     # Mode 1.b: #policy(:name) a single policy without an argument

data/lib/plumb/interface_class.rb

@@ -28,6 +28,34 @@ module Plumb
 
     alias [] of
 
+    # Merge two interfaces into a new one with the method names of both
+    # @example
+    #   i1 = Types::Interface[:foo]
+    #   i2 = Types::Interface[:bar, :lol]
+    #   i3 = i1 + i2 # expects objects with methods :foo, :bar, :lol
+    #
+    # @param other [InterfaceClass]
+    # @return [InterfaceClass]
+    def +(other)
+      raise ArgumentError, "expected another Types::Interface, but got #{other.inspect}" unless other.is_a?(self.class)
+
+      self.class.new((method_names + other.method_names).uniq)
+    end
+
+    # Produce a new Interface with the intersection of two interfaces
+    # @example
+    #   i1 = Types::Interface[:foo, :bar]
+    #   i2 = Types::Interface[:bar, :lol]
+    #   i3 = i1 + i2 # expects objects with methods :bar
+    #
+    # @param other [InterfaceClass]
+    # @return [InterfaceClass]
+    def &(other)
+      raise ArgumentError, "expected another Types::Interface, but got #{other.inspect}" unless other.is_a?(self.class)
+
+      self.class.new(method_names & other.method_names)
+    end
+
     def call(result)
       obj = result.value
       missing_methods = @method_names.reject { |m| obj.respond_to?(m) }

data/lib/plumb/json_schema_visitor.rb

@@ -61,6 +61,13 @@ module Plumb
       props
     end
 
+    # Trying to visit the deferred could go into infinite recursion
+    # if a type is deferring to itself
+    # Not clear what deferred types would mean for JSON Schema anyway.
+    on(:deferred) do |node, props|
+      props
+    end
+
     on(:hash) do |node, props|
       props.merge(
         TYPE => 'object',

data/lib/plumb/pipeline.rb

@@ -41,9 +41,8 @@ module Plumb
       @type = type
       @children = [type].freeze
       @around_blocks = self.class.around_blocks.dup
-      return unless block_given?
 
-      configure(&setup)
+      configure(&setup) if block_given?
       freeze if freeze_after
     end
 

data/lib/plumb/schema.rb

@@ -178,8 +178,8 @@ module Plumb
         self
       end
 
-      def with(...)
-        @_type = @_type.with(...)
+      def where(...)
+        @_type = @_type.where(...)
         self
       end
 

data/lib/plumb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Plumb
-  VERSION = '0.0.15'
+  VERSION = '0.0.17'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: plumb
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.17
 platform: ruby
 authors:
 - Ismael Celis
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -38,7 +37,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Data validation and transformation library.
+description: Data structures, validation, coercion and processing toolkit for Ruby
 email:
 - ismaelct@gmail.com
 executables: []
@@ -97,11 +96,11 @@ files:
 - lib/plumb/value_class.rb
 - lib/plumb/version.rb
 - lib/plumb/visitor_handlers.rb
-homepage: https://github.com/ismasan/plumb
+homepage: https://ismasan.github.io/plumb
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  source_code_uri: https://github.com/ismasan/plumb
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Data validation and transformation library.
 test_files: []