sip_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86abda949c8a90d8158fd474ff82b27329316ede
+  data.tar.gz: 86b95dd0873d29cddac6fbf08779da7b4c192aee
+SHA512:
+  metadata.gz: 2537ce0e5170f2147e84ba5baaf041f9536f166e7b48f03e9da6700f038a29d96ab4e7a215bf3e976b66372e645c76f6b9fde17a14d551117ea343c03899781c
+  data.tar.gz: 9dc694d71b9ff4be937d7a3590dc09382899784fc89361a22b3a66a85cceabfd5c3f941b1d9bc3536b796eab2dd9c7a31df6ca7c9c6c92e1eec9993a4a3dfe92

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 Bakaoh
+
+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,72 @@
+# SIP validator
+
+## Validation rules
+
+### Mandatory fields
+
+- sip or sccp
+- title
+- author
+- status
+- created
+
+### Optional fields
+
+- discussions-to
+- layer
+- replaces
+- requires
+- resolution
+- review-period-end
+- superseded-by
+- updated
+
+### Mandatory values
+
+- `status` must be 'WIP', 'Proposed', 'Approved', or 'Implemented'
+## Prerequisite
+
+- ruby
+
+## Setup
+
+```
+gem install sip_validator
+```
+
+## Usage (command line)
+
+```ruby
+sip_validator INPUT_FILES
+```
+
+## Usage (as a lib)
+
+```ruby
+require 'sip_validator
+
+SipValidator::Runner.run 
+```
+
+### Example
+
+```
+$sip_validator  ~/src/SIPs/SIPS/*[0-9].md
+
+total:1, valid:1, invalid:0, errors:0
+	statuses: [["Implemented", 1]]
+
+```
+
+## Running tests
+
+```
+bundle exec rspec
+```
+
+## Releasing new gem
+
+```
+gem bump --version patch|minor|major
+bundle exec rake release
+```

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/sip_validator

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'sip_validator'
+
+SipValidator::Runner.run ARGV

data/lib/sip_validator/loader.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+require 'front_matter_parser'
+
+module SipValidator
+  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
+end

data/lib/sip_validator/validator.rb

@@ -0,0 +1,33 @@
+require 'active_model'
+
+module SipValidator
+  class Validator
+    def initialize(opts = {})
+      # ruby does not allow method with -
+      # replaces - with _
+      opts.keys.each do |key|
+        raise("#{key} incude _ which is not allowed") if key.to_s.match(/_/)
+        if key.to_s.match(/-/)
+          new_key = opts.keys.last.to_s.gsub('-','_')
+          opts[new_key] = opts.delete key
+        end
+      end
+      super(opts)
+    end
+
+    include ActiveModel::Model
+    attr_accessor :sip, :sccp, :title, :author, :status, :created, :updated
+    attr_accessor :replaces, :requires, :layer, :resolution
+    # replace - with _
+    attr_accessor :discussions_to, :superseded_by, :review_period_end
+    validates_presence_of :title, :author, :status, :created
+    validates :sip,
+              presence: true,
+              unless: ->(v){v.sccp.present?}
+    validates :sccp, 
+              presence: true, 
+              unless: ->(v){v.sip.present?}
+    validates_inclusion_of :status, in: ['WIP', 'Proposed', 'Approved', 'Implemented']
+  end
+end
+

data/lib/sip_validator/version.rb

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

data/lib/sip_validator.rb

@@ -0,0 +1,53 @@
+require "sip_validator/version"
+require 'sip_validator/loader'
+require 'sip_validator/validator'
+
+module SipValidator
+  class Runner
+    class << self  
+      def run(file_names)
+        num_valid = 0
+        num_invalid = 0
+        num_error = 0
+        total = 0
+        puts "\n"
+        statuses = []
+        types = []
+        categories = []
+        layers = []
+        file_names.map do |file_name|
+          # Disable file check
+          # unless file_name.match(/.*sip-\d+.md$/)
+          #   puts "Warning: #{file_name} does not match sip file format"
+          #   next
+          # end
+          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
+          rescue => 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)}"
+        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

data/sip_validator.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sip_validator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sip_validator"
+  spec.version       = SipValidator::VERSION
+  spec.authors       = ["Bakaoh"]
+  spec.email         = ["@bakaoh"]
+
+  spec.summary       = "Small library to check if SIP doc has valid front matter"
+  spec.homepage      = "https://github.com/bakaoh/sip_validator"
+  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"
+  spec.add_dependency "front_matter_parser", "~> 0.1.1"
+  spec.add_dependency "activemodel"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: sip_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bakaoh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-16 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'
+- !ruby/object:Gem::Dependency
+  name: front_matter_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- "@bakaoh"
+executables:
+- sip_validator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sip_validator
+- lib/sip_validator.rb
+- lib/sip_validator/loader.rb
+- lib/sip_validator/validator.rb
+- lib/sip_validator/version.rb
+- sip_validator.gemspec
+homepage: https://github.com/bakaoh/sip_validator
+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.10
+signing_key: 
+specification_version: 4
+summary: Small library to check if SIP doc has valid front matter
+test_files: []