lip_validator 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +13 -0
- data/CODE_OF_CONDUCT.md +67 -0
- data/Gemfile +10 -0
- data/LICENSE.txt +21 -0
- data/README.md +83 -0
- data/Rakefile +6 -0
- data/bin/lip_validator +5 -0
- data/lib/lip_validator.rb +53 -0
- data/lib/lip_validator/loader.rb +12 -0
- data/lib/lip_validator/validator.rb +28 -0
- data/lib/lip_validator/version.rb +3 -0
- data/lip_validator.gemspec +37 -0
- metadata +126 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 4fab65dc35d0e9ee267efed4cbdb61bfc29dccc2da03c034936fca0a289353fe
|
4
|
+
data.tar.gz: 6e6c4fa7d57e0828e5ea3f11baca01264c23d990170ae6ce31fed45f26a54d65
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c18f6e9dc2ecd5f81dbe98c70e63e74c573a0206b51b13bcdae192a3d1f13c66f35151a2ffc41e97e81163dc40b58a9ff6d22737bd25ac29e681585baf767659
|
7
|
+
data.tar.gz: 0b5eac85edda7012e2f752e6b07235667b6b28a143d6537ab0263421c2bce5c7a54f3b25a3fa3376273bb4eeedd39274fb0bbde36ba0cf30731eb9e936d48ff6
|
data/.gitignore
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,67 @@
|
|
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 TODO: Write your email address. 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
|
+
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2020 LidoDevelop
|
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,83 @@
|
|
1
|
+
# LIP validator
|
2
|
+
[![Gem](https://img.shields.io/gem/v/lip_validator.svg?style=flat)](http://rubygems.org/gems/lip_validator "View this project in Rubygems")
|
3
|
+
|
4
|
+
|
5
|
+
## Validation rules
|
6
|
+
|
7
|
+
### Mandatory fields
|
8
|
+
|
9
|
+
- lip
|
10
|
+
- title
|
11
|
+
- author
|
12
|
+
- status
|
13
|
+
- created
|
14
|
+
|
15
|
+
### Optional fields
|
16
|
+
|
17
|
+
- discussions-to
|
18
|
+
- layer
|
19
|
+
- replaces
|
20
|
+
- requires
|
21
|
+
- resolution
|
22
|
+
- review-period-end
|
23
|
+
- superseded-by
|
24
|
+
- updated
|
25
|
+
|
26
|
+
### Mandatory values
|
27
|
+
|
28
|
+
- `status` must be:
|
29
|
+
* 'WIP'
|
30
|
+
* 'Proposed'
|
31
|
+
* 'Approved'
|
32
|
+
* 'Implemented'
|
33
|
+
* 'Withdrawn'
|
34
|
+
* 'Deferred'
|
35
|
+
* 'Rejected'
|
36
|
+
* 'Moribund'
|
37
|
+
|
38
|
+
## Prerequisite
|
39
|
+
|
40
|
+
- ruby
|
41
|
+
|
42
|
+
## Setup
|
43
|
+
|
44
|
+
```
|
45
|
+
gem install lip_validator
|
46
|
+
```
|
47
|
+
|
48
|
+
## Usage (command line)
|
49
|
+
|
50
|
+
```ruby
|
51
|
+
lip_validator INPUT_FILES
|
52
|
+
```
|
53
|
+
|
54
|
+
## Usage (as a lib)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
require 'lip_validator
|
58
|
+
|
59
|
+
LipValidator::Runner.run
|
60
|
+
```
|
61
|
+
|
62
|
+
### Example
|
63
|
+
|
64
|
+
```
|
65
|
+
$lip_validator ~/src/LIPs/LIPS/*[0-9].md
|
66
|
+
|
67
|
+
total:1, valid:1, invalid:0, errors:0
|
68
|
+
statuses: [["Implemented", 1]]
|
69
|
+
|
70
|
+
```
|
71
|
+
|
72
|
+
## Running tests
|
73
|
+
|
74
|
+
```
|
75
|
+
bundle exec rspec
|
76
|
+
```
|
77
|
+
|
78
|
+
## Releasing new gem
|
79
|
+
|
80
|
+
```
|
81
|
+
gem bump --version patch|minor|major
|
82
|
+
bundle exec rake release
|
83
|
+
```
|
data/Rakefile
ADDED
data/bin/lip_validator
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
require "lip_validator/version"
|
2
|
+
require 'lip_validator/loader'
|
3
|
+
require 'lip_validator/validator'
|
4
|
+
|
5
|
+
module LipValidator
|
6
|
+
class Runner
|
7
|
+
class << self
|
8
|
+
def run(file_names)
|
9
|
+
num_valid = 0
|
10
|
+
num_invalid = 0
|
11
|
+
num_error = 0
|
12
|
+
total = 0
|
13
|
+
puts "\n"
|
14
|
+
statuses = []
|
15
|
+
types = []
|
16
|
+
categories = []
|
17
|
+
layers = []
|
18
|
+
file_names.map do |file_name|
|
19
|
+
# Disable file check
|
20
|
+
# unless file_name.match(/.*lip-\d+.md$/)
|
21
|
+
# puts "Warning: #{file_name} does not match lip file format"
|
22
|
+
# next
|
23
|
+
# end
|
24
|
+
attributes = Loader.load(file_name)
|
25
|
+
total+=1
|
26
|
+
begin
|
27
|
+
v = Validator.new(attributes)
|
28
|
+
if v.valid?
|
29
|
+
num_valid+=1
|
30
|
+
else
|
31
|
+
num_invalid+=1
|
32
|
+
puts "#{file_name} is NOT valid:\t #{v.errors.messages}"
|
33
|
+
end
|
34
|
+
statuses.push v.status
|
35
|
+
rescue => e
|
36
|
+
puts "Warning: #{file_name} \t #{e}"
|
37
|
+
num_error+=1
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
puts "\n\ntotal:#{total}, valid:#{num_valid}, invalid:#{num_invalid}, errors:#{num_error}"
|
42
|
+
puts "\tstatuses: #{aggregate(statuses)}"
|
43
|
+
raise "#{num_invalid} invalid entities" unless num_invalid == 0
|
44
|
+
end
|
45
|
+
|
46
|
+
private
|
47
|
+
|
48
|
+
def aggregate(array)
|
49
|
+
array.group_by{|k,v| k}.map{|k,v| [k,v.length]}
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
require 'yaml'
|
2
|
+
require 'front_matter_parser'
|
3
|
+
|
4
|
+
module LipValidator
|
5
|
+
class Loader
|
6
|
+
UNSAFE_LOADER = ->(string) { YAML.load(string) }
|
7
|
+
|
8
|
+
def self.load(file_name)
|
9
|
+
FrontMatterParser::Parser.parse_file(file_name, loader: UNSAFE_LOADER).front_matter
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
@@ -0,0 +1,28 @@
|
|
1
|
+
require 'active_model'
|
2
|
+
|
3
|
+
module LipValidator
|
4
|
+
class Validator
|
5
|
+
def initialize(opts = {})
|
6
|
+
# ruby does not allow method with -
|
7
|
+
# replaces - with _
|
8
|
+
opts.keys.each do |key|
|
9
|
+
raise("#{key} incude _ which is not allowed") if key.to_s.match(/_/)
|
10
|
+
if key.to_s.match(/-/)
|
11
|
+
new_key = opts.keys.last.to_s.gsub('-','_')
|
12
|
+
opts[new_key] = opts.delete key
|
13
|
+
end
|
14
|
+
end
|
15
|
+
super(opts)
|
16
|
+
end
|
17
|
+
|
18
|
+
include ActiveModel::Model
|
19
|
+
attr_accessor :lip, :title, :author, :status, :created, :updated
|
20
|
+
attr_accessor :replaces, :requires, :layer, :resolution, :implementation
|
21
|
+
# replace - with _
|
22
|
+
attr_accessor :discussions_to, :superseded_by, :review_period_end
|
23
|
+
validates_presence_of :title, :author, :status, :created
|
24
|
+
validates :lip, presence: true
|
25
|
+
validates_inclusion_of :status, in: ['WIP', 'Proposed', 'Approved', 'Implemented', 'Rejected', 'Withdrawn', 'Deferred', 'Moribund']
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
@@ -0,0 +1,37 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "lip_validator/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "lip_validator"
|
8
|
+
spec.version = LipValidator::VERSION
|
9
|
+
spec.authors = ["LidoDevelop"]
|
10
|
+
spec.email = ["@lidoDevelop"]
|
11
|
+
|
12
|
+
spec.summary = "Small library to check if LIP doc has valid front matter"
|
13
|
+
spec.homepage = "https://github.com/depools/lip_validator"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
17
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
18
|
+
# if spec.respond_to?(:metadata)
|
19
|
+
# spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
|
20
|
+
# else
|
21
|
+
# raise "RubyGems 2.0 or newer is required to protect against " \
|
22
|
+
# "public gem pushes."
|
23
|
+
# end
|
24
|
+
|
25
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
26
|
+
f.match(%r{^(test|spec|features)/})
|
27
|
+
end
|
28
|
+
spec.bindir = "bin"
|
29
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
30
|
+
spec.require_paths = ["lib"]
|
31
|
+
|
32
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
33
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
34
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
35
|
+
spec.add_dependency "front_matter_parser", "~> 0.1.1"
|
36
|
+
spec.add_dependency "activemodel"
|
37
|
+
end
|
metadata
ADDED
@@ -0,0 +1,126 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: lip_validator
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 2.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- LidoDevelop
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-10-12 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: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: front_matter_parser
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 0.1.1
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 0.1.1
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: activemodel
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :runtime
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description:
|
84
|
+
email:
|
85
|
+
- "@lidoDevelop"
|
86
|
+
executables:
|
87
|
+
- lip_validator
|
88
|
+
extensions: []
|
89
|
+
extra_rdoc_files: []
|
90
|
+
files:
|
91
|
+
- ".gitignore"
|
92
|
+
- CODE_OF_CONDUCT.md
|
93
|
+
- Gemfile
|
94
|
+
- LICENSE.txt
|
95
|
+
- README.md
|
96
|
+
- Rakefile
|
97
|
+
- bin/lip_validator
|
98
|
+
- lib/lip_validator.rb
|
99
|
+
- lib/lip_validator/loader.rb
|
100
|
+
- lib/lip_validator/validator.rb
|
101
|
+
- lib/lip_validator/version.rb
|
102
|
+
- lip_validator.gemspec
|
103
|
+
homepage: https://github.com/depools/lip_validator
|
104
|
+
licenses:
|
105
|
+
- MIT
|
106
|
+
metadata: {}
|
107
|
+
post_install_message:
|
108
|
+
rdoc_options: []
|
109
|
+
require_paths:
|
110
|
+
- lib
|
111
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
112
|
+
requirements:
|
113
|
+
- - ">="
|
114
|
+
- !ruby/object:Gem::Version
|
115
|
+
version: '0'
|
116
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
117
|
+
requirements:
|
118
|
+
- - ">="
|
119
|
+
- !ruby/object:Gem::Version
|
120
|
+
version: '0'
|
121
|
+
requirements: []
|
122
|
+
rubygems_version: 3.0.6
|
123
|
+
signing_key:
|
124
|
+
specification_version: 4
|
125
|
+
summary: Small library to check if LIP doc has valid front matter
|
126
|
+
test_files: []
|