composite_type 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9faec747d46328dfe04c62ee29c4a1e98684db41
-  data.tar.gz: bd68565039a8dbca31c5cc486ca2a705c964e871
+  metadata.gz: 79b73ddf6ca69a94ade50421d460271d88bfa71c
+  data.tar.gz: eff100ef24de4b9136566c47bd123eafe63491d0
 SHA512:
-  metadata.gz: 4d9548cd6e18641f59295f6f7017f92d6ef9196b057b586552130da90f44374abedb7e4a66b8dee63482dc829f7a1fde4c5cb539299bea1e5821a397f98fa5a0
-  data.tar.gz: d0f8c5ec6cce22afca349bb85d464919b3b3eb4b7015e912f45b047274a5265633d99f578218d98449275cd39c960ff0af128c86a349fac2131bc467ca9155bb
+  metadata.gz: 0be9100aa76f309188b51710feb30837f760c03556fa7a76f92541227811bb3499e62cbc8de7b395a045b47f17c98349968758c6800813773d4527263f805fe3
+  data.tar.gz: d05c6b593fee921e608bcb581c3478fb1b2b1d85ba3f2dd5c7582dac0ff3d12d5ad976be1afd3f27657aee22e3054590725b73f6de2422a7bfc5da570fbb7d8e

data/README.md

@@ -1,42 +1,13 @@
-# TypedAttr
+# CompositeType
 
-Typed Attributes and Composite Types for Functional Programming in Ruby
+Composite Types for Ruby
 
 ## Usage
 
-TypedAttr simplifies typed functional programming in Ruby.
-
-The creation of data types is central to functional programming.
-Ruby does not enforce any typing of object attributes or method parameters.
-
-TypedAttr introduces a class macro "typed_attr".  It constructs an #initialize method
-given a list of attributes and their expected types.
-
-Example:
-
-    require 'typed_attr'
-    class Account
-      typed_attr name: String, amount: Money
-    end
-    Account.new("Foo", Money.new(1234))
-    Account.new("Foo", 1234) # => raise TypeError
-
-Use "typecheck" to perform checks on values:
-
-    def m x, y
-      typecheck x, String
-      typecheck y, Positive, Integer
-      x * y
-    end
-    m("string", -1) # => raise TypeError
-    m("string", 2)  # => "stringstring"
-
-The type assertions use the #=== matching operator.
-
 Composite Types can be constructed to match deeper data structures:
 
     h = { "a" => 1, "b" => :symbol }
-    typecheck h, Hash.of(String.with(Integer|Symbol))
+    Hash.of(String.with(Integer|Symbol)) === h  # => true
 
 Defining types through Modules:
 
@@ -58,22 +29,24 @@ Thus composite types can be used in "case when" clauses:
 Logical operators: #|, #&, #~ are supported:
 
     a = [ 1, 2, 3 ]
-    typecheck a, Array.of(Positive & Numeric)
-    typecheck a, Array.of(~ NilClass)
+    Array.of(Positive & Numeric) === a   # => true
+    Array.of(~ NilClass) === a           # => false
     
     b = [ 1, -2, 3 ]
-    typecheck b, Array.of(Positive & Numeric) # => raise TypeError
+    Array.of(Positive & Numeric) === b   # => false
     
     c = [ 1, nil, 3 ]
-    typecheck c, Array.of(~ NilClass)         # => raise TypeError
+    Array.of(~ NilClass) === c           # => false
 
 Composite types are cached indefinitely, therefore anonymous Modules cannot be composed.
 
+See spec/lib/composite_type_spec.rb for more examples.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'typed_attr'
+    gem 'composite_type'
 
 And then execute:
 
@@ -81,7 +54,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install typed_attr
+    $ gem install composite_type
 
 ## Contributing
 

data/lib/composite_type/version.rb

@@ -1,3 +1,3 @@
 module CompositeType
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: composite_type
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kurt Stephens