plumb 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 896f2ec4a63cde86dd22aaec579696e19c980b09c09e4a4d9d4690f9505f742d
-  data.tar.gz: 3296480dd0026e8050b624e3e1d65a020fde376a87c4ba269c6481b57c40d19e
+  metadata.gz: 308e76909c6466b0a6c2cc9443498a267186344b9508b8f485975479e0ff165a
+  data.tar.gz: 8498e5a4619437b8f91b3baae4b2d208c27031a5617dba174d52893cd4e3a54a
 SHA512:
-  metadata.gz: 76ecebbe1dc408630107170a213d0145af08bc8d9cec3ef28d66f8aa1eb3fee09352ae89c00aed1eb11b3a52709100f65e6f0a2a43b4a38ed777709f096f9198
-  data.tar.gz: 0cdbf9c24900fdbcd8393dc4f1d260063b303cc44cf84caa86bdb4d34a6edf77e1f75e431481121b9004c7fbac695f3021b4a7be965c34c1d4b96146f17c2c4c
+  metadata.gz: d41ebdf232099770d04abc85f81ead1e8dc1d4f55eb1bc9265484401cfd0418e984d7cf97a67a6ef452d67f05c3f92e66e3e3fe64f11622acbb89e5c223c73b1
+  data.tar.gz: 5e2749e954fae81753d63d6d27b95a53f239b5ac6ad776755646d794fe7819b56087f48bd99394aeab2f40c64d45606cc413a1475512f6943279d51a7dd7d2b2

data/README.md

@@ -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::Array](#typeshash) and [Types::Array](#typesarray). There's also [tuples](#typestuple), [hash maps](#hash-maps) and [data structs](#typesdata), 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](#hash-maps), [data structs](#typesdata) and [streams](#typesstream), and it's possible to create your own composite types.
 
 ### Type composition
 
@@ -235,6 +235,10 @@ You can see more use cases in [the examples directory](https://github.com/ismasa
 * `Types::UUID::V4`
 * `Types::Email`
 * `Types::Date`
+* `Types::Time`
+* `Types::URI::Generic`
+* `Types::URI::HTTP`
+* `Types::URI::File`
 * `Types::Lax::Integer`
 * `Types::Lax::String`
 * `Types::Lax::Symbol`
@@ -243,6 +247,10 @@ You can see more use cases in [the examples directory](https://github.com/ismasa
 * `Types::Forms::True`
 * `Types::Forms::False`
 * `Types::Forms::Date`
+* `Types::Forms::Time`
+* `Types::Forms::URI::Generic`
+* `Types::Forms::URI::HTTP`
+* `Types::Forms::URI::File`
 
 TODO: datetime, others.
 
@@ -824,13 +832,15 @@ Images = Types::Array[ImageDownload].concurrent
 Images.parse(['https://images.com/1.png', 'https://images.com/2.png'])
 ```
 
+See the [concurrent downloads example](https://github.com/ismasan/plumb/blob/main/examples/concurrent_downloads.rb).
+
 TODO: pluggable concurrency engines (Async?)
 
 #### `#stream`
 
 Turn an Array definition into an enumerator that yields each element wrapped in `Result::Valid` or `Result::Invalid`.
 
-See `Types::Stream` below for more.
+See [`Types::Stream`](#typesstream) below for more.
 
 #### `#filtered`
 
@@ -899,6 +909,8 @@ stream.each.with_index(1) do |result, line|
 end
 ```
 
+See a more complete the [CSV Stream example](https://github.com/ismasan/plumb/blob/main/examples/csv_stream.rb)
+
 #### `Types::Stream#filtered`
 
 Use `#filtered` to turn a `Types::Stream` into a stream that only yields valid elements.
@@ -1053,7 +1065,25 @@ Note that this does NOT work with union'd or piped structs.
 attribute :company, Company | Person do
 ```
 
+#### Shorthand array syntax
+
+```ruby
+attribute :things, [] # Same as attribute :things, Types::Array
+attribute :numbers, [Integer] # Same as attribute :numbers, Types::Array[Integer]
+attribute :people, [Person] # same as attribute :people, Types::Array[Person]
+attribute :friends, [Person] do # same as attribute :friends, Types::Array[Person] do...
+  attribute :phone_number, Integer
+end
+```
+
+Note that, if you want to match an attribute value against a literal array, you need to use `#value`
+
+```ruby
+attribute :one_two_three, Types::Array.value[[1, 2, 3]])
+```
+
 #### Optional Attributes
+
 Using `attribute?` allows for optional attributes. If the attribute is not present, these attribute values will be `nil`
 
 ```ruby
@@ -1149,7 +1179,7 @@ CreateUser = User.pipeline do |pl|
   end
 end
 
-# User normally as any other Plumb step
+# Use normally as any other Plumb step
 result = CreateUser.resolve(name: 'Joe', age: 40)
 # result.valid?
 # result.errors
@@ -1189,7 +1219,7 @@ end
 Note that order matters: an _around_ step will only wrap steps registered _after it_.
 
 ```ruby
-# This step will not be wrapper by StepLogger
+# This step will not be wrapped by StepLogger
 pl.step Step1
 
 pl.around StepLogger
@@ -1227,7 +1257,7 @@ end
 ```ruby
 class LoggedPipeline < Plumb::Pipeline
   # class-level midleware will be inherited by sub-classes
-  around StepLogged
+  around StepLogger
 end
 
 # Subclass inherits class-level middleware stack,

data/bench/plumb_hash.rb

@@ -12,22 +12,12 @@ module PlumbHash
   BLANK_STRING = ''
   MONEY_EXP = /(\W{1}|\w{3})?[\d+,.]/
 
-  PARSE_DATE = proc do |result|
-    date = ::Date.parse(result.value)
-    result.valid(date)
-  rescue ::Date::Error
-    result.invalid(errors: 'invalid date')
-  end
-
   PARSE_MONEY = proc do |result|
     value = Monetize.parse!(result.value.to_s.gsub(',', ''))
     result.valid(value)
   end
 
-  Date = Any[::Date] \
-    | (String[MONEY_EXP] >> PARSE_DATE)
-
-  BlankStringOrDate = Forms::Nil | Date
+  BlankStringOrDate = Forms::Nil | Forms::Date
 
   Money = Any[::Money] \
     | (String.present >> PARSE_MONEY) \

data/examples/command_objects.rb

@@ -26,9 +26,6 @@ module Types
   # Turn integers into Money objects (requires the money gem)
   Amount = Integer.build(Money)
 
-  # A naive email check
-  Email = String[/\w+@\w+\.\w+/]
-
   # A valid customer type
   Customer = Hash[
     name: String.present,

data/examples/concurrent_downloads.rb

@@ -12,9 +12,6 @@ require 'digest/md5'
 module Types
   include Plumb::Types
 
-  # Turn a string into an URI
-  URL = String[/^https?:/].build(::URI, :parse)
-
   # a Struct to hold image data
   Image = ::Data.define(:url, :io)
 
@@ -24,7 +21,7 @@ module Types
   # required by all Plumb steps.
   # URI => Image
   Download = Plumb::Step.new do |result|
-    io = URI.open(result.value)
+    io = ::URI.open(result.value)
     result.valid(Image.new(result.value.to_s, io))
   end
 
@@ -81,7 +78,7 @@ cache = Types::Cache.new('./examples/data/downloads')
 # 1). Take a valid URL string.
 # 2). Attempt reading the file from the cache. Return that if it exists.
 # 3). Otherwise, download the file from the internet and write it to the cache.
-IdempotentDownload = Types::URL >> (cache.read | (Types::Download >> cache.write))
+IdempotentDownload = Types::Forms::URI::HTTP >> (cache.read | (Types::Download >> cache.write))
 
 # An array of downloadable images,
 # marked as concurrent so that all IO operations are run in threads.

data/examples/weekdays.rb

@@ -4,7 +4,7 @@ require 'bundler'
 Bundler.setup(:examples)
 require 'plumb'
 
-#   bundle exec examples/weekdays.rb
+#   bundle exec ruby examples/weekdays.rb
 #
 # Data types to represent and parse an array of days of the week.
 # Input data can be an array of day names or numbers, ex.

data/lib/plumb/attributes.rb

@@ -205,12 +205,15 @@ module Plumb
       # attribute(:name, String)
       # attribute(:friends, Types::Array) { attribute(:name, String) }
       # attribute(:friends, Types::Array) # same as Types::Array[Types::Any]
+      # attribute(:friends, []) # same as Types::Array[Types::Any]
       # attribute(:friends, Types::Array[Person])
+      # attribute(:friends, [Person])
       #
       def attribute(name, type = Types::Any, &block)
         key = Key.wrap(name)
         name = key.to_sym
         type = Composable.wrap(type)
+
         if block_given? # :foo, Array[Data] or :foo, Struct
           type = __plumb_struct_class__ if type == Types::Any
           type = Plumb.decorate(type) do |node|

data/lib/plumb/composable.rb

@@ -100,6 +100,7 @@ module Plumb
     # Wrap an object in a Composable instance.
     # Anything that includes Composable is a noop.
     # A Hash is assumed to be a HashClass schema.
+    # An Array with zero or 1 element is assumed to be an ArrayClass.
     # Any `#call(Result) => Result` interface is wrapped in a Step.
     # Anything else is assumed to be something you want to match against via `#===`.
     #
@@ -115,6 +116,16 @@ module Plumb
         callable
       elsif callable.is_a?(::Hash)
         HashClass.new(schema: callable)
+      elsif callable.is_a?(::Array)
+        element_type = case callable.size
+                       when 0
+                         Types::Any
+                       when 1
+                         callable.first
+                       else
+                         raise ArgumentError, '[element_type] syntax allows a single element type'
+                       end
+        Types::Array[element_type]
       elsif callable.respond_to?(:call)
         Step.new(callable)
       else

data/lib/plumb/hash_class.rb

@@ -139,17 +139,8 @@ module Plumb
     end
 
     def wrap_keys_and_values(hash)
-      case hash
-      when ::Array
-        hash.map { |e| wrap_keys_and_values(e) }
-      when ::Hash
-        hash.each.with_object({}) do |(k, v), ret|
-          ret[Key.wrap(k)] = wrap_keys_and_values(v)
-        end
-      when Callable
-        hash
-      else #  leaf values
-        Composable.wrap(hash)
+      hash.each.with_object({}) do |(k, v), ret|
+        ret[Key.wrap(k)] = Composable.wrap(v)
       end
     end
 

data/lib/plumb/json_schema_visitor.rb

@@ -255,6 +255,18 @@ module Plumb
       props.merge(TYPE => 'string', FORMAT => 'date')
     end
 
+    on(::URI::Generic) do |_node, props|
+      props.merge(TYPE => 'string', FORMAT => 'uri')
+    end
+
+    on(::URI::HTTP) do |_node, props|
+      props.merge(TYPE => 'string', FORMAT => 'uri')
+    end
+
+    on(::URI::File) do |_node, props|
+      props.merge(TYPE => 'string', FORMAT => 'uri')
+    end
+
     on(::Hash) do |_node, props|
       props.merge(TYPE => 'object')
     end

data/lib/plumb/types.rb

@@ -3,6 +3,7 @@
 require 'bigdecimal'
 require 'uri'
 require 'date'
+require 'time'
 
 module Plumb
   # Define core policies
@@ -161,11 +162,18 @@ module Plumb
     Interface = InterfaceClass.new
     Email = String[URI::MailTo::EMAIL_REGEXP].as_node(:email)
     Date = Any[::Date]
+    Time = Any[::Time]
 
     module UUID
       V4 = String[/\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i].as_node(:uuid)
     end
 
+    module URI
+      Generic = Any[::URI::Generic]
+      HTTP = Any[::URI::HTTP]
+      File = Any[::URI::File]
+    end
+
     class Data
       extend Composable
       include Plumb::Attributes
@@ -214,6 +222,16 @@ module Plumb
       # Accept a Date, or a string that can be parsed into a Date
       # via Date.parse
       Date = Date | (String >> Any.build(::Date, :parse).policy(:rescue, ::Date::Error))
+      Time = Time | (String >> Any.build(::Time, :parse).policy(:rescue, ::ArgumentError))
+
+      # Turn strings into different URI types
+      module URI
+        # URI.parse is very permisive - a blank string is valid.
+        # We want to ensure that a generic URI at least starts with a scheme as per RFC 3986
+        Generic = Types::URI::Generic | (String[/^([a-z][a-z0-9+\-.]*)/].build(::URI, :parse))
+        HTTP = Generic[::URI::HTTP]
+        File = Generic[::URI::File]
+      end
     end
   end
 end

data/lib/plumb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plumb
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ismael Celis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal