Project

sdl_validator

0.0
No release in over a year
sdl_validatorsaddle-finance/sdl_validatorHomepageDocumentationSource CodeBug TrackerWiki
A small library to check if SIPs have valid front matter
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
1,628
Stars
0
Forks
1
Watchers
2
 Releases
Current version
0.0.1
Total releases
1
First release
2021-11-24
Latest release
2021-11-24
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2021-11-24
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.16
rake
~> 10.0
rspec
~> 3.0

Runtime

activemodel
>= 0
front_matter_parser
~> 0.1.1
 Project Readme

SDL validator

Gem

Validation rules

Mandatory fields

  • sip
  • 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'
    • 'Implemented'
    • 'Withdrawn'
    • 'Deferred'
    • 'Rejected'
    • 'Moribund'

Prerequisite

  • ruby

Setup

gem install sdl_validator

Usage (command line)

sdl_validator INPUT_FILES

Usage (as a lib)

require 'sdl_validator

SDLValidator::Runner.run

Example

$sdl_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