validator_fn 0.1.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3c19ca1d1f502bed0157cfafa1f2a1b895ada518a58770f22f7ea3eeb159fb8
-  data.tar.gz: e7d7cb6dd656953bded2541458316019a1578913907b473499520f86b59fda8a
+  metadata.gz: 6ea7512cdc3b010b687c5cf9d2fec7d79f6724c56547e31ced2903762e81e9b3
+  data.tar.gz: 5e45c2d9df2ff27104da89d0a97f19788a3de304b4575a3a317fa567620a6692
 SHA512:
-  metadata.gz: c03edea5b8e2fecf7fb892ca22a4157ebfbe0dd8e717578cc5d38e3280c99ada72e72a18b6ee7c661e1d533261560037c47ff6c18065c28af7eb5478fc5c9f4e
-  data.tar.gz: 382a11b7ea12ebda356c03039b3e5b2228d1dcc0d7e38ac95da7419f36b69ab932f14054fb44029cf6dfed670a6257f6bb270d2cd5abae98be54e004badc6af7
+  metadata.gz: e683c7186d468ac169210bab0a8033601b7873051381ee14f24dc1760d30f9dd8731723b303b8090464081afea842f8db309c8f5fc2d0666a54500efb31fd22d
+  data.tar.gz: f172ff2aa6e4b1f243ae50000da20f8a6cd86c385f872cbe0c2cea6f222e2c1b025ead98c1af6191637467646e1c11c42628bb9205546dc5a5ac8042b3f3b6ee

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validator_fn (0.1.6)
+    validator_fn (0.2.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,9 +1,10 @@
 # ValidatorFn
 
-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/). 
+ValidatorFn is a collection of very simple lambdas that can be used for validating/transforming
+data structures. It makes use of currying to provide a very composable
+DSL. To help you understand the concepts, I strongly advise reading [this blog post.](http://blog.martinosis.com/blog/simple-functional-strong-params-in-ruby/).
 
+It can be very useful for validating structures that come from input, such as configuration files, JSON APIs, test results.
 
 ## Installation
 
@@ -23,30 +24,30 @@ Or install it yourself as:
 
 ## Usage
 
-```
+```ruby
 require 'validator_fn'
 include ValidatorFn
 ```
 
-You can start validating type of an object. 
+You can start validating the type of an object.
 
-```
+```ruby
 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.
+Note that parameters are curried. The first param of `is_a` is the Ruby class you want to check the last parameter against.
+In the previous example, a `ValidatorFn::Error`exception will be raised.
 
-However if you send a valid entry as the second parameter, it will return that last parameter.
+However, setting a valid entry as the second parameter will return that last parameter.
 
-```
+```ruby
 is_a.(String).("Joe")
 # => "Joe"
 ```
 
 This allows chaining lambdas:
 
-```
+```ruby
 to_int = is_a.(String) >> -> a { Integer(a) }
 
 to_int.("12")
@@ -56,25 +57,91 @@ to_int.("asdf") # will raise an exception
 
 You can validate a hash:
 
-```
+```ruby
 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. 
+Since we are using curried lambdas, you can compose validators as you which.
 
-```
-postal_code = -> a { 
+```ruby
+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), 
+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.
+This very simple library (100 lines of code) can be extended easily by creating new 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 for processing JSON payloads.
+
+## Code generation
+
+You can generate validator code from existing structure:
+
+```ruby
+require 'openuri'
+require "json"
+struct = JSON.parse(URI.open("https://api.github.com/users/defunkt").read)
+
+require "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
 
@@ -86,7 +153,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).
@@ -94,6 +160,3 @@ 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/error.rb

@@ -0,0 +1,29 @@
+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
+
+  class MissingKey < Error
+    def initialize(key)
+      super("Missing field #{key}")
+    end
+  end
+end

data/lib/validator_fn/version.rb

@@ -1,3 +1,3 @@
 module ValidatorFn
-  VERSION = "0.1.7"
+  VERSION = "0.3.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
@@ -59,13 +36,14 @@ module ValidatorFn
   @@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)|
-      memo[key] ||= fn.(hash[key]) if hash[key]
+      memo[key] = fn.(hash[key])
       memo
     rescue Error => e
-      invalid.("Invalid value for #{key.inspect} key.")
+      invalid.("Invalid value for #{key.inspect} key:")
     end
   }.curry
 
@@ -97,6 +75,10 @@ module ValidatorFn
       "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.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Martin Chabot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2022-06-30 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