hv 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: '0353278d4798a60106d524f47a02b0b9f823fe0a'
4
+ data.tar.gz: 7c0c2bf9299d9fe828bf631ec64452c76fa0e2bd
5
+ SHA512:
6
+ metadata.gz: d00da52f72a809c438a7b1d27e83770893327e2eb4dd7f30f0c97365d90a792b34b8cefb6726e8df77c9b8bf2404f993fd580351cf0d20e98b3992d256eb0014
7
+ data.tar.gz: d083ba5b30499bee85e19abc7e482cfe4225853eb9a39a3fe78e759b92c44bafdd59060cfeed5a017dbdeae61275bce7e89ad246f85aa6360c9efcdc4b44c9aa
data/.gitignore ADDED
@@ -0,0 +1,8 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.1
5
+ before_install: gem install bundler -v 1.16.0
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at monkeysquarelab@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in hv.gemspec
6
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Monkey Square Lab
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # Hv
2
+
3
+ Hash validation. At the moment the validation only return true or false when it match the schema.
4
+
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'hv'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install hv
21
+
22
+ ## Usage
23
+
24
+ ```ruby
25
+ person_schema = { name: {type?: String} }
26
+ schema = {
27
+ people: {
28
+ array?: person_schema
29
+ }
30
+ }
31
+ schema = Schema.new(schema)
32
+ schema.validates?({people: [{name: "juan"}, {name: "chus"}]}) # => true
33
+ ```
34
+
35
+ Check 'test' folder for more validators examples.
36
+
37
+
38
+ ## TODO
39
+
40
+ - Improve documentation
41
+ - return errors
42
+ - sanitize input
43
+
44
+ ## License
45
+
46
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
47
+
48
+ ## Code of Conduct
49
+
50
+ Everyone interacting in the Hv project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hv/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "hv"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/hv.gemspec ADDED
@@ -0,0 +1,27 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "hv/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "hv"
8
+ spec.version = Hv::VERSION
9
+ spec.authors = ["Monkey Square Lab"]
10
+ spec.email = ["monkeysquarelab@gmail.com"]
11
+
12
+ spec.summary = %q{Hash validation}
13
+ spec.description = %q{Hash validation}
14
+ spec.homepage = "https://github.com/monkeysquarelab/hv"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.16"
25
+ spec.add_development_dependency "minitest", "~> 5.0"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ end
data/lib/hv/schema.rb ADDED
@@ -0,0 +1,108 @@
1
+ module Hv
2
+ class Schema
3
+
4
+ def allowed_validators
5
+ [:optional?, :format?, :min_size?, :max_size?, :size?, :lt?, :gt?, :types?, :type?, :enum?, :proc?, :array?, :empty?]
6
+ end
7
+
8
+ def initialize(schema)
9
+ @schema = schema
10
+ end
11
+
12
+ def result
13
+ @result
14
+ end
15
+
16
+ def path
17
+ @path
18
+ end
19
+
20
+ def validates?(input)
21
+ @result = []
22
+ validate_schema(@schema, input, [])
23
+ end
24
+
25
+ private
26
+
27
+ def validate_schema(spec, value, path=nil)
28
+ spec.each do |key, _spec|
29
+ if !allowed_validators.include?(key)
30
+ _value = value[key] rescue nil
31
+ validate_schema(_spec, _value, [path, key].flatten)
32
+ else
33
+ match = if value.nil? && optional_attr?(path)
34
+ true
35
+ else
36
+ next if key == :optional?
37
+ method("validate_#{key}").call(_spec, value)
38
+ end
39
+ @result << [path, key, _spec, false, value] unless match
40
+ end
41
+ end
42
+ @result.empty?
43
+ end
44
+
45
+ def optional_attr?(path)
46
+ @schema.dig(*path)[:optional?] rescue false
47
+ end
48
+
49
+ def validate_enum?(spec, value)
50
+ spec.include?(value)
51
+ end
52
+
53
+ def validate_types?(spec, value)
54
+ raise "Argument for :types? must be an array of types" unless spec.is_a? Array
55
+ spec.any? { |_type| value.is_a?(_type) }
56
+ end
57
+
58
+
59
+ def validate_type?(spec, value)
60
+ value.is_a?(spec)
61
+ end
62
+
63
+ def validate_size(spec, value, oper)
64
+ case value
65
+ when Enumerable, String
66
+ value.size.send(oper, spec)
67
+ when Numeric
68
+ value.send(oper, spec)
69
+ end
70
+ end
71
+
72
+ def validate_min_size?(spec, value)
73
+ validate_size(spec, value, '>=')
74
+ end
75
+
76
+ def validate_max_size?(spec, value)
77
+ validate_size(spec, value, '<=')
78
+ end
79
+
80
+ def validate_size?(spec, value)
81
+ validate_size(spec, value, '==')
82
+ end
83
+
84
+ def validate_lt?(spec, value)
85
+ validate_size(spec, value, '<')
86
+ end
87
+
88
+ def validate_gt?(spec, value)
89
+ validate_size(spec, value, '>')
90
+ end
91
+
92
+ def validate_format?(spec, value)
93
+ if value.respond_to? :match?
94
+ value.match?(spec)
95
+ else
96
+ false
97
+ end
98
+ end
99
+
100
+ def validate_array?(spec, values, path=nil)
101
+ return false unless values.is_a?(Array)
102
+ values.all? {|value|
103
+ validate_schema(spec, value, path)
104
+ }
105
+ end
106
+
107
+ end
108
+ end
data/lib/hv/version.rb ADDED
@@ -0,0 +1,3 @@
1
+ module Hv
2
+ VERSION = "0.1.0"
3
+ end
data/lib/hv.rb ADDED
@@ -0,0 +1,5 @@
1
+ require "hv/version"
2
+ require "hv/schema"
3
+
4
+ module Hv
5
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: hv
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Monkey Square Lab
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-03-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
27
+ - !ruby/object:Gem::Dependency
28
+ name: minitest
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '5.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '5.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ description: Hash validation
56
+ email:
57
+ - monkeysquarelab@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".travis.yml"
64
+ - CODE_OF_CONDUCT.md
65
+ - Gemfile
66
+ - LICENSE.txt
67
+ - README.md
68
+ - Rakefile
69
+ - bin/console
70
+ - bin/setup
71
+ - hv.gemspec
72
+ - lib/hv.rb
73
+ - lib/hv/schema.rb
74
+ - lib/hv/version.rb
75
+ homepage: https://github.com/monkeysquarelab/hv
76
+ licenses:
77
+ - MIT
78
+ metadata: {}
79
+ post_install_message:
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubyforge_project:
95
+ rubygems_version: 2.6.13
96
+ signing_key:
97
+ specification_version: 4
98
+ summary: Hash validation
99
+ test_files: []