eip_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c7542bb149c300414664dbf78db48be22b880a3
+  data.tar.gz: 6aa34021d899cc4b9922f1af3d195211f3641927
+SHA512:
+  metadata.gz: 8126eec7f3b244efc655b9a7a819cc19fde5566e5ab3c36afcbd021efb4361c5026925e711473ffdecfa3bad685a80630951882f9c8ddf6affac0904a3eab7c9
+  data.tar.gz: 6f0b4617e46cdb2a2b52709a849c553ba59df210fd9c41f91acade445155d2cf3d7543b10a214ef455b9158280ae3a0e9782cfd2f486c48b22980b53e0b27214

data/.gitignore

@@ -0,0 +1,12 @@
+Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

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 TODO: Write your email address. 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,10 @@
+source "https://rubygems.org"
+
+gem 'rake'
+gem 'front_matter_parser'
+gem 'activemodel'
+group :test do
+ gem 'rspec'
+end
+gem 'pry'
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Makoto
+
+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,62 @@
+# EIP validator
+
+## Validation rules
+
+### Mandatory fields
+
+- eip
+- title
+- author
+- type
+- category (conditional on type)
+- status
+- created
+
+### Optional fields
+
+- replaces
+- requires
+- layer
+
+### Mandatory values
+
+- `status` must be `Draft`, `Accepted`, `Final`, or `Deferred`
+
+## Prerequisite
+
+- ruby
+
+## Setup
+
+```
+gem install eip_validator
+```
+
+## Usage
+
+```ruby
+eip_validator "FILE_NAME_WITH_WILDCARD"
+```
+
+### Example
+
+```
+$eip_validator  "/Users/makoto/src/EIPs/EIPS/*[0-9].md"
+
+Warning: /Users/makoto/src/EIPs/EIPS/eip-158.md 	 unknown attribute 'superseded-by' for EipValidator::Validator.
+Warning: /Users/makoto/src/EIPs/EIPS/eip-615.md 	 unknown attribute 'edited' for EipValidator::Validator.
+
+
+total:51, valid:49, invalid:0, errors:2
+	statuses: [["Final", 29], ["Draft", 17], ["Accepted", 2], ["Active", 1]]
+	types: [["Meta", 6], ["Standards Track", 42], ["Standard Track", 1]]
+	categories: [[nil, 6], ["Core", 23], ["ERC", 11], ["Interface", 5], ["Networking", 4]]
+	layers: [[nil, 47], ["Applications", 1], ["Process", 1]]
+
+```
+
+## Running tests
+
+```
+bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/eip_validator

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'eip_validator'
+
+EipValidator::Runner.run ARGV[0]

data/eip_validator.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "eip_validator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "eip_validator"
+  spec.version       = EipValidator::VERSION
+  spec.authors       = ["Makoto"]
+  spec.email         = ["@makoto_inoue"]
+
+  spec.summary       = "Small library to check if EIP doc has valid front matter"
+  spec.homepage      = "https://makoto.github.io/me"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/eip_validator/loader.rb

@@ -0,0 +1,11 @@
+require 'yaml'
+require 'front_matter_parser'
+
+
+class Loader
+  UNSAFE_LOADER = ->(string) { YAML.load(string) }
+
+  def self.load(file_name)
+    FrontMatterParser::Parser.parse_file(file_name, loader: UNSAFE_LOADER).front_matter
+  end
+end

data/lib/eip_validator/validator.rb

@@ -0,0 +1,11 @@
+require 'active_model'
+
+module EipValidator
+  class Validator
+    include ActiveModel::Model
+    attr_accessor :eip, :title, :author, :type, :category, :status, :created, :replaces, :requires, :layer
+    validates_presence_of :eip, :title, :author, :type, :status, :created
+    validates_presence_of :category, if: Proc.new { |v| v.type == 'Standards Track' }
+    validates_inclusion_of :status, in: %w(Draft Active Accepted Final Deferred)
+  end
+end

data/lib/eip_validator/version.rb

@@ -0,0 +1,3 @@
+module EipValidator
+  VERSION = "0.1.0"
+end

data/lib/eip_validator.rb

@@ -0,0 +1,54 @@
+require "eip_validator/version"
+require 'eip_validator/loader'
+require 'eip_validator/validator'
+
+module EipValidator
+  class Runner
+    class << self  
+      def run(dir)
+        num_valid = 0
+        num_invalid = 0
+        num_error = 0
+        total = 0
+        puts "\n"
+        statuses = []
+        types = []
+        categories = []
+        layers = []
+        Dir[dir].map do |file_name|
+          attributes = Loader.load(file_name)
+          total+=1
+          begin 
+            v = Validator.new(attributes)
+            if v.valid?
+              num_valid+=1      
+            else
+              num_invalid+=1
+              puts "#{file_name} is NOT valid:\t #{v.errors.messages}"
+            end
+            statuses.push v.status
+            types.push v.type
+            categories.push v.category
+            layers.push v.layer
+          rescue ActiveModel::UnknownAttributeError => e
+            puts "Warning: #{file_name} \t #{e}"
+            num_error+=1
+          end
+        end
+              
+        puts "\n\ntotal:#{total}, valid:#{num_valid}, invalid:#{num_invalid}, errors:#{num_error}"
+        puts "\tstatuses: #{aggregate(statuses)}"
+        puts "\ttypes: #{aggregate(types)}"
+        puts "\tcategories: #{aggregate(categories)}"
+        puts "\tlayers: #{aggregate(layers)}"
+        raise "#{num_invalid} invalid entities" unless num_invalid == 0
+      end
+
+      private
+
+      def aggregate(array)
+        array.group_by{|k,v| k}.map{|k,v| [k,v.length]}
+      end  
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: eip_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Makoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- "@makoto_inoue"
+executables:
+- eip_validator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/eip_validator
+- eip_validator.gemspec
+- lib/eip_validator.rb
+- lib/eip_validator/loader.rb
+- lib/eip_validator/validator.rb
+- lib/eip_validator/version.rb
+homepage: https://makoto.github.io/me
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Small library to check if EIP doc has valid front matter
+test_files: []