validator_fn 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94899eae6f032c863b53262ae16bee3c17bfd1085db3add84d77bd889a2d537b
-  data.tar.gz: 513ccc5a96f2eb2ff5aed7930288ebba10e66075540f61dc2b7fedb1739aa9e0
+  metadata.gz: dbf0665436aeda62b487528bb8f8f85777c45a357c4cf34884600a14273f289d
+  data.tar.gz: 0ba29a6cf3b5d453f3561f8e9c3f205c060d088226c83f494ff7a269dc672734
 SHA512:
-  metadata.gz: d7f0cc3a38e7a9c6611eee9205e20aba7b5adcf820170332f81116326294e633958df750d596eec5c89161d8d2a045d6511223adea4b9bc3e42f89e198db0e61
-  data.tar.gz: 7d8a6aa61a9c8246a9a8762b94830270f6b0330a24f10bcd5b836ac074998fe6a589eeb943e58c3d3def890d0912df966da3543614a00aa3572700e4663cb540
+  metadata.gz: de5d94c98746fd64ecb55f05e658ec434f57c8e518d16bb817ef39e4c56b53cd7130c52ab3ee69dddd5d8b853830dd271374d29c4ac6573576b9cdaf9287c80b
+  data.tar.gz: cfd9b2aab1a51bae15f335fc74e0970bf406d16f0e522ce3eb239176e0814a59bf0be37f13c4753bb0e2193c828634c7e6de7aeda7f323eb92eede177c3ad8ce

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validator_fn (0.1.4)
+    validator_fn (0.1.8)
       fn_reader
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    fn_reader (0.1.0)
+    fn_reader (0.2.0)
     method_source (0.9.2)
     pry (0.12.2)
       coderay (~> 1.1.0)

data/README.md

@@ -1,8 +1,11 @@
 # 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
+It can be very useful for validating structures that comes from input, such as configuration files,
+JSON apis, test result.
 
 ## Installation
 
@@ -22,7 +25,125 @@ 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.
+
+## Casting
+
+You can also apply converter functions to the structure.
+
+```ruby
+user = { name: "Joe", created_at: "2020-01-03" }
+to_date = ->str { Date.parse(str) }
+user_validator = hash_of.(name: is_a.(String),
+                          created_at: is_a.(String) >> to_date)
+
+user_validator.(user)
+# => {:name=>"Joe", :created_at=>#<Date: 2020-01-03 ((2458852j,0s,0n),+0s,2299161j)>}
+```
+
+This makes it very useful processing JSON payloads.
+
+## Code generation
+
+You can generate validator code from existing structure:
+
+```
+require 'openuri'
+require "json"
+struct = JSON.parse(URI.open("https://api.github.com/users/defunkt").read)
+
+require_relative "validator_fn"
+
+# Generate unformatted code
+code = ValidatorFn.generate_validator.(struct)
+
+# You can reformat it using a code formatter
+require "rufo"
+puts Rufo.format(code)
+hash_of.({ "login" => is_a.(String),
+           "id" => is_a.(Integer),
+           "node_id" => is_a.(String),
+           "avatar_url" => is_a.(String),
+           "gravatar_id" => is_a.(String),
+           "url" => is_a.(String),
+           "html_url" => is_a.(String),
+           "followers_url" => is_a.(String),
+           "following_url" => is_a.(String),
+           "gists_url" => is_a.(String),
+           "starred_url" => is_a.(String),
+           "subscriptions_url" => is_a.(String),
+           "organizations_url" => is_a.(String),
+           "repos_url" => is_a.(String),
+           "events_url" => is_a.(String),
+           "received_events_url" => is_a.(String),
+           "type" => is_a.(String),
+           "site_admin" => is_a_bool,
+           "name" => is_a.(String),
+           "company" => any,
+           "blog" => is_a.(String),
+           "location" => any,
+           "email" => any,
+           "hireable" => any,
+           "bio" => is_a.(String),
+           "twitter_username" => any,
+           "public_repos" => is_a.(Integer),
+           "public_gists" => is_a.(Integer),
+           "followers" => is_a.(Integer),
+           "following" => is_a.(Integer),
+           "created_at" => is_a.(String),
+           "updated_at" => is_a.(String) })
+```
 
 ## Development
 
@@ -34,7 +155,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/validator_fn. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/validator_fn/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
@@ -42,3 +162,4 @@ 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).

data/lib/validator_fn/error.rb

@@ -0,0 +1,23 @@
+module ValidatorFn
+  class Error < StandardError
+    attr_reader :my_msg
+
+    def initialize(msg)
+      @my_msg = msg
+      super(msg)
+    end
+
+    def message(indent = 0)
+      if cause
+        cause_msg = if cause.kind_of?(Error)
+            cause.message(indent + 1)
+          else
+            cause.message
+          end
+        my_msg + "\n" + ("  " * (indent + 1)) + cause_msg
+      else
+        my_msg
+      end
+    end
+  end
+end

data/lib/validator_fn/version.rb

@@ -1,3 +1,3 @@
 module ValidatorFn
-  VERSION = "0.1.4"
+  VERSION = "0.1.8"
 end

data/lib/validator_fn.rb

@@ -1,33 +1,10 @@
 require "validator_fn/version"
+require "validator_fn/error"
 require "fn_reader"
 
 module ValidatorFn
-  class Error < StandardError; end
-
   fn_reader :something, :matches, :either, :array_of, :any, :is_nil,
-    :maybe, :present, :is_a, :int, :hash_of, :invalid, :generate_validator, :handle_error, :error_str, :apply
-
-  class Error < StandardError
-    attr_reader :my_msg
-
-    def initialize(msg)
-      @my_msg = msg
-      super(msg)
-    end
-
-    def message(indent = 0)
-      if cause
-        cause_msg = if cause.kind_of?(Error)
-            cause.message(indent + 1)
-          else
-            cause.message
-          end
-        my_msg + "\n" + ("  " * (indent + 1)) + cause_msg
-      else
-        my_msg
-      end
-    end
-  end
+    :maybe, :present, :is_a, :is_a_bool, :int, :hash_of, :invalid, :generate_validator, :handle_error, :error_str, :apply
 
   @@apply = ->fn, a {
     begin
@@ -56,9 +33,10 @@ 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
+  @@is_a_bool = ->a { invalid.("Expected bool, got #{a.inspect}") unless a == true || a == false; a }.curry
   @@hash_of = ->fields, hash {
     hash ||= {}
     fields.reduce({}) do |memo, (key, fn)|
@@ -92,11 +70,15 @@ 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
       "array_of.( #{generate_validator.(a.first)} )"
+    when TrueClass
+      "is_a_bool"
+    when FalseClass
+      "is_a_bool"
     else
       "is_a.(#{a.class})"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validator_fn
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Martin Chabot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fn_reader
@@ -43,6 +43,7 @@ files:
 - bin/console
 - bin/setup
 - lib/validator_fn.rb
+- lib/validator_fn/error.rb
 - lib/validator_fn/version.rb
 - validator_fn.gemspec
 homepage: https://github.com/martinos/validator_fn
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Series of lambdas for validating Ruby structures