validator_fn 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 860e9db64270b3cb2520b593d0ad026e1653497889cb5cf0a3e8a884f9da7f31
-  data.tar.gz: fa55b8d02579d6d38f3dd2f3222a6a0a3574f4de9d9efc71696605d02572bec0
+  metadata.gz: 9a18a2dee04cebf84a277132258a1456f981fe477467d041ea6c29e564051a74
+  data.tar.gz: 2c82211054e4b07ee55f068dd87218b8f4d2da001889cd054d220be6346d84f0
 SHA512:
-  metadata.gz: becdc4ee94dfa39c885257213f04927b6dcb160421ba80a328b0405d5f51f1c674975e0898056765f927ca4e0ad4062658a03400e149f554c693a120c3ecef01
-  data.tar.gz: a98a27f35f8aa7fd2b0832b931bd5b876d0af2d89d9f5f8b153d49afebdb691dbcc6675bf7abfe75fba20e5f5dce210837398d878442148657620977de7c625e
+  metadata.gz: d027d9af4b77d44e4b0dc9271faeb9bc89dc0e617439442f1858215ff06a8f806edac282379c1e28b176cc532522b3c5258aadc29c6745649930e2bfe6ac92ef
+  data.tar.gz: 42385b0fbcdeb03906d81e4e4d32c29d6d19edcbb950586afc85553baba260823792e72e1f9f03fae5440e16d07160272996dacee50a2c971817dc8f68d0297e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validator_fn (0.1.5)
+    validator_fn (0.1.6)
       fn_reader
 
 GEM

data/README.md

@@ -1,8 +1,9 @@
 # ValidatorFn
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/validator_fn`. To experiment with that code, run `bin/console` for an interactive prompt.
+ValidatorFn is a collection of very simple lambdas that can be used for validating/transforming 
+data structures.  It makes use of currying in order to provide a very composable 
+DSL. To help you understand the concepts it is stongly advised to read [this blog post.](http://blog.martinosis.com/blog/simple-functional-strong-params-in-ruby/). 
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +23,58 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+require 'validator_fn'
+include ValidatorFn
+```
+
+You can start validating type of an object. 
+
+```
+is_a.(String).(3)
+```
+
+Note that parameters are curried. The first param of `is_a` is the Ruby class that you want to check the last parameter against.
+In the previous example, aValidatorFn::Error`exception will be raised.
+
+However if you send a valid entry as the second parameter, it will return that last parameter.
+
+```
+is_a.(String).("Joe")
+# => "Joe"
+```
+
+This allows chaining lambdas:
+
+```
+to_int = is_a.(String) >> -> a { Integer(a) }
+
+to_int.("12")
+# => 12
+to_int.("asdf") # will raise an exception
+```
+
+You can validate a hash:
+
+```
+user = hash_of.({name: is_a.(String), age: to_int})
+user.({name: "", age: "234"})
+```
+
+Since we are using curried lambdas, you can compose validators as you which. 
+
+```
+postal_code = -> a { 
+  invalid.("Invalid postal code: #{a}")  unless a =~ /[a-z]\d[a-z]\s*\d[a-z]\d/i
+  a
+}
+contact =  hash_of.(user: user, 
+                    address: hash_of.({ street_number: is_a.(Integer), 
+                                        postal_code: postal_code}))
+```
+
+This is a very simple library (100 lines of code) that can be extended as you which by
+creating your own lambdas.
 
 ## Development
 
@@ -42,3 +94,6 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the ValidatorFn project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/validator_fn/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ValidatorFn project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/validator_fn/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ValidatorFn project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/validator_fn/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ValidatorFn project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/validator_fn/blob/master/CODE_OF_CONDUCT.md).

data/lib/validator_fn/version.rb

@@ -1,3 +1,3 @@
 module ValidatorFn
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/validator_fn.rb

@@ -92,7 +92,7 @@ module ValidatorFn
       "any"
     when Hash
       inner = a.map do |k, v|
-        %{"#{k}" => #{generate_validator.(v)}}
+        %{#{k.inspect} => #{generate_validator.(v)}}
       end.join(",\n  ")
       "hash_of.({ #{inner} })"
     when Array

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validator_fn
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Martin Chabot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2021-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fn_reader