hval 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b83187f62263478bc58819593b0e7a1a380c7a74
+  data.tar.gz: 60ec151b5e44e23273175a854dad4a45f4128800
+SHA512:
+  metadata.gz: 90d3b069dfc9aa4989409ed2f29d5d3cbf68e0b73a2b902092c48e0fffb7b2bc54b420b3372b7db572dfd9a15fedae3cfadbbdea4b9a51d862a527a26931326f
+  data.tar.gz: fe1b6024f4f0d11f89dbde205e03714c6aaa1f24dd414770c860508185caf91c97c53d6f0264251a2ed4c78b9a2fa36dff9513658728e36a48c0fef6d5b893da

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at juan.repetti@tecnocratica.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hval.gemspec
+gemspec
+gem 'byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Juan Repetti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Hval 🐳
+
+Hval is a Hash Validation gem.
+
+## Installation
+
+Not available in rubygems (yet) so you can clone the repo and build the gem from source.
+
+```
+$ gem build hval.gemspec
+$ gem install hval-0.1.0.gem
+```
+
+## Usage
+
+```ruby
+schema = {name: {type?: String, format?: /brush/}, age: {type?: Integer }
+validator = Hval::Validator.new(schema)
+validator.call({name: "guybrush", age: 45})
+validator.valid?
+=> true
+```
+
+
+## Development
+
+Hval is swimming under water, and will suffer a lot of changes. The gem approach is very naive and not fully tested, so if you 
+use it be carefull. Critics, fixes, suggestions are more than welcome. 
+
+## Todo
+
+* Return errors with messages and in a friendly format. Now, the return of the #call method return information about the result of the validation.
+ 
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Hval project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jmrepetti/hval/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hval"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hval.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hval/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hval"
+  spec.version       = Hval::VERSION
+  spec.authors       = ["Juan Repetti"]
+  spec.email         = ["jmrepetti@github.com"]
+  spec.summary       = %q{Hval 🐳 is hash validation gem }
+  spec.homepage      = "http://github.com/jmrepetti/hval"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/hval.rb

@@ -0,0 +1,9 @@
+require "hval/version"
+require "hval/errors"
+require "hval/result"
+require "hval/validators"
+require "hval/schema"
+require "hval/validator"
+
+module Hval
+end

data/lib/hval/result.rb

@@ -0,0 +1,35 @@
+module Hval
+  class Result
+    
+    def initialize(result)
+      @success = reduce_to_boolean(result)
+    end
+    
+    def success?
+      @success
+    end
+    
+    private
+    def reduce_to_boolean(res)
+      case res
+      when TrueClass, FalseClass
+        return res
+      when Array
+        res.all? do |result|
+          if result.size == 2 #[key, [results]]
+            _, results = result
+            reduce_to_boolean(results)            
+          elsif result.size == 4 #[name, spec, result, given]
+            _, _, results, _ = result
+            reduce_to_boolean(results)        
+          elsif
+            raise "Result size #{result.size} not expected: #{result.inspect}"
+          end
+        end
+      else
+        raise "Result must be TrueClass, FalseClass or Array: #{res.inspect}"
+      end
+    end
+    
+  end
+end

data/lib/hval/schema.rb

@@ -0,0 +1,26 @@
+module Hval
+  class Schema
+    include Hval::Validators
+    
+    def initialize(schema)
+      @validators = schema.collect do |op, spec|
+        method("validate_#{op}").call(spec)
+      end
+    end
+    
+    def validators
+      @validators
+    end
+    
+    def call(value)
+      @validators.collect do |validator|
+        validator.call(value)
+      end
+    end
+    
+    def match?(value)
+      Hval::Result.new(self.call(value)).success?
+    end
+    
+  end  
+end

data/lib/hval/validator.rb

@@ -0,0 +1,41 @@
+module Hval
+  class Validator
+    
+    
+    # Return a Validator
+    # 
+    # ==== Example
+    #
+    # schema = {name: {type?: String, format?: /brush/}, age: {type?: Integer }
+    # validator = Hval::Validator.new(schema)
+    def initialize(hash)
+      @validators = hash.collect do |k, schema|
+        [k, Hval::Schema.new(schema)]
+      end
+    end
+
+    # Return an Array with the results of the validation 
+    #
+    # ==== Example
+    #
+    # schema = {name: {type?: String, format?: /brush/}, age: {type?: Integer }
+    # validator = Hval::Validator.new(schema)            
+    # validator.call({name: "guybrush", age: "45"})
+    # => [[:name, [[:type, String, true, "guybrush"], [:format, /brush/, true, "guybrush"]]], [:age, [[:type, Integer, false, "45"]]]]
+    def call(hash)
+      @result = @validators.collect do |key, validator|
+        [key, validator.call(hash[key])]
+      end
+    end
+    
+    def valid?
+      return false if @result.nil?      
+      Hval::Result.new(@result).success?
+    end
+    
+    def errors(processor=Hval::Errors)
+      processor.process(@result)
+    end
+    
+  end  
+end

data/lib/hval/validators.rb

@@ -0,0 +1,186 @@
+module Hval
+  module Validators
+    
+    # Validators return a Proc to be called with a value to test,  
+    # this call return a result which is an array of 4 elements with:
+    # - a name (validator name, eg.: :type)
+    # - an expected value (eg.: String)
+    # - a result which can be true, false or another result array
+    # - the given value
+    # 
+    # ==== Example
+    #
+    #  irb> include Hval::Validators
+    #  irb> validate_format?(/guy/).call("guybrush")
+    #  => [:format, /guy/, true, "guybrush"]    
+    #  irb> validate_type?(String).call(10)
+    #  => [:type, String, false, 10]
+    
+    
+    # Validates the format of a value with a regular expression
+    # 
+    # ==== Example
+    #
+    #  irb> include Hval::Validators
+    #  irb> validate_format?(/guy/).call("guybrush")
+    #  => [:format, /guy/, true, "guybrush"]        
+    def validate_format?(spec)
+      -> (value) { 
+        res = if value.respond_to? :match?
+          value.match?(spec)
+        else
+          false
+        end
+        [ :format, spec, res, value ]
+      }
+    end
+    
+    # Validates the minimal size of a value with an Number
+    # 
+    # ==== Example
+    #
+    #  irb> include Hval::Validators
+    #  irb> validate_min_size?(10).call(13)
+    #  => [:min_size, 10, true, 13]
+    def validate_min_size?(spec)
+      -> (value) { 
+        res = case value
+        when Enumerable, String
+          value.size >= spec
+        when Numeric
+          value >= spec
+        end
+        [ :min_size, spec, res, value ]
+      }
+    end
+    
+    # Validates the maximal size of a value with an Number
+    # 
+    # ==== Example
+    #
+    #  irb> include Hval::Validators
+    #  irb> validate_max_size?(10).call(9)
+    #  => [:max_size, 10, true, 9]
+    def validate_max_size?(spec)
+      -> (value) { 
+        res = case value
+        when Enumerable, String
+          value.size <= spec
+        when Numeric
+          value <= spec
+        end
+        [ :max_size, spec, res, value ]
+      }
+    end
+    
+    # Validates a type of a given value
+    # 
+    # ==== Example
+    #
+    #  irb> include Hval::Validators
+    #  irb> validate_type?(String).call(10)
+    #  => [:type, String, false, 10]
+    def validate_type?(spec)
+      -> (value) { 
+        [ :type, spec, value.is_a?(spec), value ]
+      }
+    end
+
+    # Validates that a value is included in a list
+    # 
+    # ==== Example
+    #
+    #  irb> include Hval::Validators
+    #  irb> validate_enum?([1,2,3,4]).call(2)
+    #  => [:enum, [1, 2, 3, 4], true, 2]
+    def validate_enum?(spec)
+      -> (value) { 
+        [ :enum, spec, spec.include?(value), value ] 
+      }
+    end
+
+    # Validates a value with a block. The block must return the result
+    # in the array format [name, spec, result, given]
+    #
+    # ==== Example
+    #
+    #  irb> include Hval::Validators    
+    #  irb> _proc = ->(val){ [:proc, :greater_than_ten, val > 10, val] }
+    #  irb> validate_proc?(_proc).(10)
+    #  => [:proc, :greater_than_ten, false, 10]
+    def validate_proc?(spec)
+      -> (value) {
+        spec.call(value)
+      }
+    end
+    
+    # Validates that the elements of an Array conform the schema
+    # 
+    # ==== Example
+    #
+    #  irb> include Hval::Validators    
+    #  irb> validate_array?({type?: Integer}).([1,2,3,4,5])
+    #  => [:array, {:type?=>Integer}, true, [1, 2, 3, 4, 5]]
+    #  irb> validate_array?({type?: String}).([1,2,3,4,5])
+    #  => [:array, {:type?=>String}, false, [1, 2, 3, 4, 5]]
+    def validate_array?(spec)
+      -> (values) { 
+        res = if values.is_a? Array
+          values.all? { |value|
+            Hval::Schema.new(spec).match?(value)
+          }
+        else
+          false
+        end
+        [ :array, spec, res, values ]
+      }
+    end
+    
+    # Validates that a value conform a schema only if provided. Nil or blank are allowed.
+    # 
+    # ==== Example
+    #
+    #  irb> include Hval::Validators        
+    #  irb> validate_optional?({type?: Integer}).(1)
+    #  => [:optional, {:type?=>Integer}, true, 1]
+    #  irb> validate_optional?({type?: Integer}).(nil)
+    #  => [:optional, {:type?=>Integer}, true, nil]
+    #  irb> validate_optional?({type?: Integer}).("asdasd")
+    #  => [:optional, {:type?=>Integer}, false, "asdasd"]
+    def validate_optional?(spec)
+      -> (value) { 
+        res = case value
+        when NilClass, ""
+          true
+        else
+          Hval::Schema.new(spec).match?(value)
+        end
+        [ :optional, spec, res, value ]
+      }
+    end
+    
+    # Validates a Hash against a schema. 
+    # 
+    # The result on hashes also contains the key with the results associated with the key. As many results as validators defined.
+    #
+    # ==== Example
+    #
+    #  irb> include Hval::Validators  
+    #  irb> validate_hash?({name: {type?: String}}).({name: "carlos"})
+    #  => [:hash, {:name=>{:type?=>String}}, [[:name, [[:type, String, true, "carlos"]]]], {:name=>"carlos"}]
+    #  irb> validate_hash?({name: {type?: String}}).({name: 123})
+    #  => [:hash, {:name=>{:type?=>String}}, [[:name, [[:type, String, false, 123]]]], {:name=>123}]
+    #  irb> validate_hash?({name: {type?: String, format?: /carl/}}).({name: 123})
+    #  => [:hash, {:name=>{:type?=>String, :format?=>/carl/}}, [[:name, [[:type, String, false, 123], [:format, /carl/, false, 123]]]], {:name=>123}]
+    def validate_hash?(spec)
+      -> (value) { 
+        res = if value.is_a? Hash
+          Hval::Validator.new(spec).call(value)
+        else
+          false
+        end
+        [ :hash, spec, res, value ]
+      }
+    end
+  end
+end

data/lib/hval/version.rb

@@ -0,0 +1,3 @@
+module Hval
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: hval
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Juan Repetti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- jmrepetti@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hval.gemspec
+- lib/hval.rb
+- lib/hval/result.rb
+- lib/hval/schema.rb
+- lib/hval/validator.rb
+- lib/hval/validators.rb
+- lib/hval/version.rb
+homepage: http://github.com/jmrepetti/hval
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: "Hval \U0001F433 is hash validation gem"
+test_files: []