plumb 0.0.1 → 0.0.3

data/examples/programmers.csv

@@ -0,0 +1,201 @@
+name,age,language
+Krysten Tromp,57,C++
+Irena Mayert III,21,ruby
+Lucile Jacobi I,28,lisp
+Warner Ullrich DC,64,rust
+Refugio Cronin,13,F#
+Emery Kris,84,ocaml
+Sherise Wisoky,73,elm
+Bridget DuBuque,75,elixir
+Maynard Lubowitz V,58,C++
+Rosamaria Heidenreich,61,fortran
+Marla Fritsch,70,golang
+Williams Little MD,48,golang
+Bernard Wilderman,25,ocaml
+Sen. Hiram Bayer,37,gleam
+Ginger Mueller,60,elixir
+Karyl Hegmann,63,ruby
+Terrilyn Fadel,40,ocaml
+Edward Abshire,14,gleam
+Clyde Lesch,67,elixir
+Ms. Loretta Botsford,40,ruby
+Sen. Susann Gleichner,19,zig
+Von Thompson,80,javascript
+Carrol Kirlin II,43,ocaml
+Samual Welch,17,elm
+Samara Hegmann II,50,fortran
+Tyron Bogan,65,rust
+Juan Quitzon,57,zig
+Bev Feest CPA,15,javascript
+Walter Parisian,17,golang
+The Hon. Zachary Funk,55,ruby
+Jaimie Stoltenberg,77,rust
+Jarrod Turcotte DC,68,elixir
+Dr. Jason Jacobs,40,zig
+Miss Neal Leffler,17,rust
+Wilfredo Kemmer,30,C++
+Fr. Leon Jerde,35,ruby
+Mr. Ray Anderson,31,C
+Jed Skiles,63,lua
+Delena Raynor LLD,40,ruby
+Pres. Dirk Kunde,74,rust
+Franklyn Kuhic,55,ruby
+Jon Deckow,68,golang
+Anglea Beier LLD,17,C++
+Jene Labadie,60,lisp
+Ezequiel Wyman,50,F#
+Jessie Medhurst,33,F#
+Luke Bergnaum,57,ruby
+Douglass Goodwin,83,zig
+Garry Farrell,67,ocaml
+Warren Harber III,23,rust
+Britni Mohr,60,elixir
+Terra Pouros DDS,60,F#
+Pia Bernhard,37,fortran
+Akiko Hoppe,14,ocaml
+Samuel Muller,56,rust
+Esperanza Kutch,67,C++
+Hal Gislason,75,ruby
+Prof. Jonell Turcotte,61,ruby
+Lindsey Hermiston,29,ruby
+Deadra Muller,51,fortran
+Amb. Fern Crist,58,elm
+Enola Grant,39,zig
+Mickey Lueilwitz DVM,80,lua
+Raymon Jacobi,34,golang
+Jody Rowe V,27,golang
+Lilliam Hyatt,36,zig
+Fr. Larraine Klein,22,javascript
+Derick Rutherford DC,41,C
+Eugene Kiehn DVM,20,C
+Dianna Kunze DDS,22,fortran
+Denis Reilly,67,zig
+Alejandrina Waelchi,70,rust
+Odell Cassin,20,ocaml
+Travis Daugherty,77,F#
+Guillermo McCullough,15,ruby
+Malena Nitzsche,12,lisp
+Jess Gleason,61,ruby
+Mr. Kenton Quitzon,77,C++
+Sixta Torp,36,ruby
+Teddy McClure,15,ruby
+Alexandra Towne CPA,73,elixir
+Harrison Hartmann CPA,66,lua
+Gretta Kirlin Sr.,17,rust
+Rev. Jordan Yost,36,ruby
+Geraldo Yundt LLD,17,elixir
+Emelia Pouros,31,fortran
+Msgr. Coletta Crist,43,zig
+Vernice Pfannerstill,31,zig
+Rev. Marvel Mayer,55,ruby
+Amb. Chanelle Ruecker,14,elixir
+Sallie Roob PhD,75,gleam
+Enoch Funk,33,golang
+Alex Reichel,85,F#
+Laure Boehm,24,julia
+Valeri Dietrich,72,ruby
+Tabatha Kerluke,58,julia
+Bert Sauer,73,gleam
+Morgan Heaney,39,julia
+Lora Hackett,74,javascript
+Rona Leuschke,72,rust
+Mora Bode,19,elm
+Daniell Hegmann,37,golang
+Richie Waters CPA,23,javascript
+Katharine Huel,36,C
+Lauren Abbott,37,C
+Daisey Cremin,62,ruby
+Evelyn Koch,49,F#
+Pres. Cassey Hammes,82,gleam
+Msgr. Wilhelmina Bauch,18,C
+Hilaria Emmerich,35,rust
+Rev. Julieann Hickle,18,C
+Pres. Corey Shields,14,ruby
+Donetta Lehner PhD,34,ruby
+Cyndi Schumm,83,ruby
+Newton West,52,elm
+Carleen Wisozk,42,F#
+Alysha Marvin Ret.,35,lisp
+Alex Balistreri,83,javascript
+Zulma Parker PhD,45,ocaml
+Reyes Bogisich Sr.,70,ocaml
+Dario Batz,38,elm
+Jacquelyn MacGyver,59,gleam
+Gov. Zachary Schuster,64,ruby
+Leonard Braun,65,ruby
+Ivette Schuppe,30,ruby
+Adrian Parisian,45,elm
+Dr. Young Rohan,20,fortran
+Dong Hansen,77,F#
+Johnny Hammes,44,F#
+Amb. Terence Cummerata,49,ruby
+Taylor Nitzsche,40,F#
+Mr. Bennett Price,46,C
+Genaro Blick VM,23,fortran
+Ashley Osinski,71,ruby
+Jae D'Amore,50,elm
+Katherine Ward,63,lisp
+Anderson O'Conner,70,ocaml
+Amb. Chrystal Schmitt,70,rust
+Vaughn Larkin,52,F#
+Jada Brown Jr.,53,golang
+Pauletta Krajcik,72,gleam
+Cinthia Morar,26,ruby
+Loyce Windler,51,julia
+Ms. Sharee Walker,84,ruby
+Raymundo Kohler,14,fortran
+Natalya Towne Sr.,72,C++
+Rayford Kemmer,12,golang
+Rev. Tisa Harber,44,elm
+Jorge Schaden,72,lua
+Pam Marquardt,12,lua
+Xenia Wisoky,13,javascript
+Audrea Purdy,75,lua
+Joesph Russel DC,18,javascript
+Marty Ratke III,38,rust
+Jordon Bradtke,25,C
+Titus Cronin Esq.,36,ruby
+Ms. Lucio Vandervort,64,golang
+Theo Nicolas,50,julia
+Hazel Pouros,29,ruby
+Rey Lubowitz,59,elixir
+Ike Hessel,66,C
+Alec Wilderman,42,ruby
+Leesa Ledner,71,lisp
+Jeneva Gutkowski,33,lua
+Isaias MacGyver,32,F#
+Daryl Senger I,36,ruby
+Mr. Gonzalo Breitenberg,50,julia
+Aretha Halvorson,17,ocaml
+Ralph Wisoky,15,F#
+Demarcus Stehr,80,javascript
+Sheldon Lemke,47,golang
+Kimiko Hermiston,20,golang
+Manda Pfannerstill,20,F#
+Haywood Rowe,85,F#
+Roxanne Gerhold,29,ruby
+Chanelle Beatty,70,ruby
+Shirlee Hoeger,18,ruby
+Beula Denesik,68,C++
+Roberto Lang,59,gleam
+Marcy Rau,77,javascript
+Samira Hilll,51,F#
+Clarissa Simonis,82,javascript
+Elijah Cole,57,ocaml
+Freida Wilkinson,34,lua
+Polly Wehner,82,C++
+Lindsey Ullrich,80,elixir
+Freddie Auer,42,ruby
+Luz Zemlak,37,lisp
+Colin Emard,74,ruby
+Dion Hudson,56,gleam
+Daisy Crist,12,lua
+Keturah Ortiz,64,ruby
+Everette Shanahan Sr.,28,zig
+Prof. Beckie Wiza,80,ruby
+Msgr. Annabelle Howe,35,ocaml
+Jeremy Effertz,22,julia
+Dinorah Graham,38,elixir
+Kate Bernier,35,ruby
+Jerrold Ortiz,22,ruby
+Bart Moen,74,ruby

data/examples/weekdays.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup(:examples)
+require 'plumb'
+
+#   bundle exec 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.
+#   ['monday', 'tuesday', 'wednesday']
+#   [1, 2, 3]
+#
+# Or mixed:
+#   [1, 'Tuesday', 3]
+#
+# Validate that there aren't repeated days, ex. [1, 2, 4, 2]
+# The output is an array of day numbers, ex. [1, 2, 3]
+module Types
+  include Plumb::Types
+
+  DAYS = {
+    'monday' => 1,
+    'tuesday' => 2,
+    'wednesday' => 3,
+    'thursday' => 4,
+    'friday' => 5,
+    'saturday' => 6,
+    'sunday' => 7
+  }.freeze
+
+  # Validate that a string is a valid day name, down-case it.
+  DayName = String
+            .transform(::String, &:downcase)
+            .options(DAYS.keys)
+
+  # Turn a day name into its number, or validate that a number is a valid day number.
+  DayNameOrNumber = DayName.transform(::Integer) { |v| DAYS[v] } | Integer.options(DAYS.values)
+
+  # An Array for days of the week, with no repeated days.
+  # Ex. [1, 2, 3, 4, 5, 6, 7], [1, 2, 4], ['monday', 'tuesday', 'wednesday', 7]
+  # Turn day names into numbers, and sort the array.
+  Week = Array[DayNameOrNumber]
+         .policy(size: 1..7)
+         .check('repeated days') { |days| days.uniq.size == days.size }
+         .transform(::Array, &:sort)
+end
+
+p Types::DayNameOrNumber.parse('monday')            # => 1
+p Types::DayNameOrNumber.parse(3)                   # => 3
+p Types::DayName.parse('TueSday')                   # => "tuesday
+p Types::Week.parse([3, 2, 1, 4, 5, 6, 7])          # => [1, 2, 3, 4, 5, 6, 7]
+p Types::Week.parse([1, 'Tuesday', 3, 4, 5, 'saturday', 7]) # => [1, 2, 3, 4, 5, 6, 7]
+
+# p Types::Week[[1, 1, 3, 4, 5, 6, 7]] # raises Plumb::TypeError: repeated days
+#
+# Or use these types as part of other composite types, ex.
+#
+#   PartTimeJob = Types::Hash[
+#     role: Types::String.present,
+#     days_of_the_week: Types::Week
+#   ]
+#
+#   result = PartTimeJob.resolve(role: 'Ruby dev', days_of_the_week: %w[Tuesday Wednesday])
+#   result.valid? # true
+#   result.value # { role: 'Ruby dev', days_of_the_week: [2, 3] }

data/lib/plumb/array_class.rb

@@ -3,7 +3,7 @@
 require 'concurrent'
 require 'plumb/steppable'
 require 'plumb/result'
-require 'plumb/hash_class'
+require 'plumb/stream_class'
 
 module Plumb
   class ArrayClass
@@ -12,15 +12,7 @@ module Plumb
     attr_reader :element_type
 
     def initialize(element_type: Types::Any)
-      @element_type = case element_type
-      when Steppable
-        element_type
-      when ::Hash
-        HashClass.new(element_type)
-      else
-        raise ArgumentError,
-          "element_type #{element_type.inspect} must be a Steppable"
-      end
+      @element_type = Steppable.wrap(element_type)
 
       freeze
     end
@@ -35,12 +27,22 @@ module Plumb
       ConcurrentArrayClass.new(element_type:)
     end
 
-    private def _inspect
-      %(#{name}[#{element_type}])
+    def stream
+      StreamClass.new(element_type:)
+    end
+
+    def filtered
+      MatchClass.new(::Array) >> Step.new(nil, "Array[#{element_type}].filtered") do |result|
+        arr = result.value.each.with_object([]) do |e, memo|
+          r = element_type.resolve(e)
+          memo << r.value if r.valid?
+        end
+        result.valid(arr)
+      end
     end
 
     def call(result)
-      return result.invalid(errors: 'is not an Array') unless result.value.is_a?(::Enumerable)
+      return result.invalid(errors: 'is not an Array') unless ::Array === result.value
 
       values, errors = map_array_elements(result.value)
       return result.valid(values) unless errors.any?
@@ -50,6 +52,10 @@ module Plumb
 
     private
 
+    def _inspect
+      %(Array[#{element_type}])
+    end
+
     def map_array_elements(list)
       # Reuse the same result object for each element
       # to decrease object allocation.
@@ -73,12 +79,12 @@ module Plumb
         errors = {}
 
         values = list
-          .map { |e| Concurrent::Future.execute { element_type.resolve(e) } }
-          .map.with_index do |f, idx|
-            re = f.value
-            errors[idx] = f.reason if f.rejected?
-            re.value
-          end
+                 .map { |e| Concurrent::Future.execute { element_type.resolve(e) } }
+                 .map.with_index do |f, idx|
+          re = f.value
+          errors[idx] = f.reason if f.rejected?
+          re.value
+        end
 
         [values, errors]
       end

data/lib/plumb/build.rb

@@ -11,8 +11,11 @@ module Plumb
     def initialize(type, factory_method: :new, &block)
       @type = type
       @block = block || ->(value) { type.send(factory_method, value) }
+      freeze
     end
 
     def call(result) = result.valid(@block.call(result.value))
+
+    private def _inspect = "Build[#{@type.inspect}]"
   end
 end

data/lib/plumb/hash_class.rb

@@ -12,8 +12,9 @@ module Plumb
 
     attr_reader :_schema
 
-    def initialize(schema = {})
+    def initialize(schema: BLANK_HASH, inclusive: false)
       @_schema = wrap_keys_and_values(schema)
+      @inclusive = inclusive
       freeze
     end
 
@@ -28,12 +29,12 @@ module Plumb
     def schema(*args)
       case args
       in [::Hash => hash]
-      self.class.new(_schema.merge(wrap_keys_and_values(hash)))
-      in [Steppable => key_type, Steppable => value_type]
-      HashMap.new(key_type, value_type)
-    else
-      raise ::ArgumentError, "unexpected value to Types::Hash#schema #{args.inspect}"
-    end
+        self.class.new(schema: _schema.merge(wrap_keys_and_values(hash)), inclusive: @inclusive)
+      in [key_type, value_type]
+        HashMap.new(Steppable.wrap(key_type), Steppable.wrap(value_type))
+      else
+        raise ::ArgumentError, "unexpected value to Types::Hash#schema #{args.inspect}"
+      end
     end
 
     alias [] schema
@@ -45,7 +46,7 @@ module Plumb
     def +(other)
       raise ArgumentError, "expected a HashClass, got #{other.class}" unless other.is_a?(HashClass)
 
-      self.class.new(merge_rightmost_keys(_schema, other._schema))
+      self.class.new(schema: merge_rightmost_keys(_schema, other._schema), inclusive: @inclusive)
     end
 
     def &(other)
@@ -56,21 +57,43 @@ module Plumb
         memo[k] = other.at_key(k)
       end
 
-      self.class.new(intersected)
+      self.class.new(schema: intersected, inclusive: @inclusive)
     end
 
     def tagged_by(key, *types)
       TaggedHash.new(self, key, types)
     end
 
+    def inclusive
+      self.class.new(schema: _schema, inclusive: true)
+    end
+
     def at_key(a_key)
       _schema[Key.wrap(a_key)]
     end
 
     def to_h = _schema
 
-    private def _inspect
-      %(#{name}[#{_schema.map { |(k, v)| [k.inspect, v.inspect].join(':') }.join(' ')}])
+    def filtered
+      op = lambda do |result|
+        return result.invalid(errors: 'must be a Hash') unless result.value.is_a?(::Hash)
+        return result unless _schema.any?
+
+        input = result.value
+        field_result = BLANK_RESULT.dup
+        output = _schema.each.with_object({}) do |(key, field), ret|
+          key_s = key.to_sym
+          if input.key?(key_s)
+            r = field.call(field_result.reset(input[key_s]))
+            ret[key_s] = r.value if r.valid?
+          elsif !key.optional?
+            r = field.call(BLANK_RESULT)
+            ret[key_s] = r.value if r.valid?
+          end
+        end
+        result.valid(output)
+      end
+      Step.new(op, [_inspect, 'filtered'].join('.'))
     end
 
     def call(result)
@@ -80,7 +103,9 @@ module Plumb
       input = result.value
       errors = {}
       field_result = BLANK_RESULT.dup
-      output = _schema.each.with_object({}) do |(key, field), ret|
+      initial = {}
+      initial = initial.merge(input) if @inclusive
+      output = _schema.each.with_object(initial) do |(key, field), ret|
         key_s = key.to_sym
         if input.key?(key_s)
           r = field.call(field_result.reset(input[key_s]))
@@ -98,6 +123,10 @@ module Plumb
 
     private
 
+    def _inspect
+      %(Hash[#{_schema.map { |(k, v)| [k.inspect, v.inspect].join(': ') }.join(', ')}])
+    end
+
     def wrap_keys_and_values(hash)
       case hash
       when ::Array
@@ -109,7 +138,7 @@ module Plumb
       when Callable
         hash
       else #  leaf values
-        StaticClass.new(hash)
+        Steppable.wrap(hash)
       end
     end
 

data/lib/plumb/hash_map.rb

@@ -15,6 +15,8 @@ module Plumb
     end
 
     def call(result)
+      return result.invalid(errors: 'must be a Hash') unless result.value.is_a?(::Hash)
+
       failed = result.value.lazy.filter_map do |key, value|
         key_r = @key_type.resolve(key)
         value_r = @value_type.resolve(value)
@@ -31,5 +33,37 @@ module Plumb
     rescue StopIteration
       result
     end
+
+    def filtered
+      FilteredHashMap.new(key_type, value_type)
+    end
+
+    private def _inspect = "HashMap[#{@key_type.inspect}, #{@value_type.inspect}]"
+
+    class FilteredHashMap
+      include Steppable
+
+      attr_reader :key_type, :value_type
+
+      def initialize(key_type, value_type)
+        @key_type = key_type
+        @value_type = value_type
+        freeze
+      end
+
+      def call(result)
+        result.invalid(errors: 'must be a Hash') unless result.value.is_a?(::Hash)
+
+        hash = result.value.each.with_object({}) do |(key, value), memo|
+          key_r = @key_type.resolve(key)
+          value_r = @value_type.resolve(value)
+          memo[key_r.value] = value_r.value if key_r.valid? && value_r.valid?
+        end
+
+        result.valid(hash)
+      end
+
+      private def _inspect = "HashMap[#{@key_type.inspect}, #{@value_type.inspect}].filtered"
+    end
   end
 end

data/lib/plumb/interface_class.rb

@@ -16,10 +16,10 @@ module Plumb
     def of(*args)
       case args
       in Array => symbols if symbols.all? { |s| s.is_a?(::Symbol) }
-      self.class.new(symbols)
-    else
-      raise ::ArgumentError, "unexpected value to Types::Interface#of #{args.inspect}"
-    end
+        self.class.new(symbols)
+      else
+        raise ::ArgumentError, "unexpected value to Types::Interface#of #{args.inspect}"
+      end
     end
 
     alias [] of
@@ -31,5 +31,7 @@ module Plumb
 
       result
     end
+
+    private def _inspect = "Interface[#{method_names.join(', ')}]"
   end
 end