validator_fn 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a79bc916ca1dba284aa215464f30a5734be7384e74153e704e57cade0bd4856
-  data.tar.gz: 1e4ae24e5abd2cff941117b3558fe39fe9c0c2efdf1ef13f87806dc07902e341
+  metadata.gz: f3c19ca1d1f502bed0157cfafa1f2a1b895ada518a58770f22f7ea3eeb159fb8
+  data.tar.gz: e7d7cb6dd656953bded2541458316019a1578913907b473499520f86b59fda8a
 SHA512:
-  metadata.gz: abb3834b1c0f4a93770ec973f39fd65f44f1e63bc7cf30beeadbf69e6fa3bddbb48ca13d77f33ca76426bd1d7b4fe60253c680d038c01680b399871dd7fdf8db
-  data.tar.gz: fe879dc647418bbd36a31784e740b08a52e4ed63774b9e5e1c40b785cd303e69dfd0c94e921c47f37ccc9466f61b51f3dde7ee5c01696eef4ddcdaec7a94d0af
+  metadata.gz: c03edea5b8e2fecf7fb892ca22a4157ebfbe0dd8e717578cc5d38e3280c99ada72e72a18b6ee7c661e1d533261560037c47ff6c18065c28af7eb5478fc5c9f4e
+  data.tar.gz: 382a11b7ea12ebda356c03039b3e5b2228d1dcc0d7e38ac95da7419f36b69ab932f14054fb44029cf6dfed670a6257f6bb270d2cd5abae98be54e004badc6af7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validator_fn (0.1.3)
+    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.3"
+  VERSION = "0.1.7"
 end

data/lib/validator_fn.rb

@@ -1,6 +1,5 @@
 require "validator_fn/version"
 require "fn_reader"
-require "pry-nav"
 
 module ValidatorFn
   class Error < StandardError; end
@@ -57,7 +56,7 @@ module ValidatorFn
     end
   }.curry
   @@any = ->a { a }
-  @@is_nil = ->a { invalid.("Should be nil") unless a.nil?; a }
+  @@is_nil = ->a { invalid.("Should be nil but was #{a}") unless a.nil?; a }
   @@maybe = either.(is_nil)
   @@is_a = ->klass, a { invalid.("Expected type #{klass}, got #{a.inspect}") unless a.is_a?(klass); a }.curry
   @@hash_of = ->fields, hash {
@@ -93,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.3
+  version: 0.1.7
 platform: ruby
 authors:
 - Martin Chabot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fn_reader