yaml-schema 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 701e8ba71eb1d60990092ad38d7dca6f3954f4bd70ec1a5f292ed9eb244a7aef
-  data.tar.gz: a930db9675bdfe08fe078431e3d8ded4104ee427694641e7d88961aed3cd9e16
+  metadata.gz: 1c8b8b2332c8bfbf1061b7082c1fc4d5df88ce365d6f9ff4796561abfb25a3af
+  data.tar.gz: e91a4093b75138771c8a78f64a2de9beb4a55dd6727a3604f1863c3a130907b6
 SHA512:
-  metadata.gz: c943fc76323ec4ad6159939b00773537c76a360ff93bac4dad0e2f1bda94dd814a55437f60e80df6fa37e8d99b4a890a6c150c8d393f10c309d6a4899ee73976
-  data.tar.gz: 4bc0b0c28f916e2fb86a43390303714ca19d290d6d5dbf4561a189cfeb6da99b6d01e76d579e3d8b4b6a0aee835173aac31ada6cc0401e6fd41005a80a3168a4
+  metadata.gz: 0fe1aba2b8398416020a28757d3b00e05927fa55c1c44d410bbf285d26ef0577fc186161c98a5daa87622604d20708d415a0b7231018842b199573906998d615
+  data.tar.gz: 3e2f19f68706ef4404b6d7fc4cad4087f183518fade8158fbdb519cc14d530965a973efeaaf354397db3359030c4d72be0a3d93a937a79b6116ed1e29de42ded

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  ruby-versions:
+    uses: ruby/actions/.github/workflows/ruby_versions.yml@master
+
+  test:
+    needs: ruby-versions
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
+
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Ruby
+        uses: ruby/setup-ruby-pkgs@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          apt-get: "haveged libyaml-dev"
+          brew: libyaml
+          vcpkg: libyaml
+      
+      - name: Run tests
+        run: bundle exec rake test

data/.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: Publish gem to rubygems.org
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository == 'tenderlove/yaml-schema'
+    runs-on: ubuntu-latest
+
+    environment:
+      name: rubygems.org
+      url: https://rubygems.org/gems/yaml-schema
+
+    permissions:
+      contents: write
+      id-token: write
+
+    strategy:
+      matrix:
+        ruby: ["ruby"]
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@v2
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Publish to RubyGems
+        uses: rubygems/release-gem@v1
+
+      - name: Create GitHub release
+        run: |
+          tag_name="$(git describe --tags --abbrev=0)"
+          gh release create "${tag_name}" --verify-tag --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+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 aaron.patterson at gmail.com. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

data/lib/yaml-schema.rb

@@ -1,6 +1,67 @@
 # frozen_string_literal: true
 
 module YAMLSchema
+  VERSION = "1.0.1"
+
+  class Pointer
+    include Enumerable
+
+    class Exception < StandardError; end
+    class FormatError < Exception; end
+
+    def initialize path
+      @path = Pointer.parse path
+    end
+
+    def each(&block); @path.each(&block); end
+
+    def eval object
+      Pointer.eval @path, object
+    end
+    alias :[] :eval
+
+    ESC = {'^/' => '/', '^^' => '^', '~0' => '~', '~1' => '/'} # :nodoc:
+
+    def self.[] path, object
+      eval parse(path), object
+    end
+
+    def self.eval list, object # :nodoc:
+      object = object.children.first if object.document?
+
+      list.inject(object) { |o, part|
+        return nil unless o
+
+        if o.sequence?
+          raise IndexError unless part =~ /\A(?:\d|[1-9]\d+)\Z/
+          o.children.fetch(part.to_i)
+        else
+          o.children.each_slice(2) do |key, value|
+            if key.value == part
+              break value
+            end
+          end
+        end
+      }
+    end
+
+    def self.parse path
+      return [''] if path == '/'
+      return []   if path == ''
+
+      unless path.start_with? '/'
+        raise FormatError, "Pointer should start with a slash"
+      end
+
+      parts = path.sub(/^\//, '').split(/(?<!\^)\//).each { |part|
+        part.gsub!(/\^[\/^]|~[01]/) { |m| ESC[m] }
+      }
+
+      parts.push("") if path[-1] == '/'
+      parts
+    end
+  end
+
   class Validator
     class Exception < StandardError; end
     class UnexpectedType < Exception; end
@@ -8,6 +69,8 @@ module YAMLSchema
     class UnexpectedTag < Exception; end
     class UnexpectedValue < Exception; end
     class InvalidSchema < Exception; end
+    class InvalidString < Exception; end
+    class MissingRequiredField < Exception; end
 
     Valid = Struct.new(:exception).new.freeze
 
@@ -112,18 +175,30 @@ module YAMLSchema
         end
         if schema["properties"]
           properties = schema["properties"].dup
+          key_restriction = schema["propertyNames"] || {}
           node.children.each_slice(2) do |key, val|
-            valid = _validate("string", {}, key, valid, aliases, path)
+            valid = _validate("string", key_restriction, key, valid, aliases, path)
 
             return valid if valid.exception
 
             sub_schema = properties.delete(key.value) {
-              return make_error UnexpectedProperty, "unknown property #{key.value.dump}", path
+              if schema["additionalProperties"]
+                schema["additionalProperties"]
+              else
+                return make_error UnexpectedProperty, "unknown property #{key.value.dump}", path
+              end
             }
             valid = _validate(sub_schema["type"], sub_schema, val, valid, aliases, path + [key.value])
 
             return valid if valid.exception
           end
+
+          if schema["required"]
+            missing_fields = properties.keys & schema["required"]
+            unless missing_fields.empty?
+              return make_error MissingRequiredField, "missing fields #{missing_fields.map(&:dump).join(" ")}", path
+            end
+          end
         else
           if schema["items"]
             sub_schema = schema["items"]
@@ -155,6 +230,18 @@ module YAMLSchema
             return make_error UnexpectedValue, "expected string, got integer", path
           end
         end
+
+        if schema["maxLength"] && node.value.bytesize > schema["maxLength"]
+          return make_error InvalidString, "expected string length to be <= #{schema["maxLength"]}", path
+        end
+
+        if schema["minLength"] && node.value.bytesize < schema["minLength"]
+          return make_error InvalidString, "expected string length to be >= #{schema["minLength"]}", path
+        end
+
+        if schema["pattern"] && !(node.value.match?(schema["pattern"]))
+          return make_error InvalidString, "expected string to match #{schema["pattern"]}", path
+        end
       when "array"
         unless node.sequence?
           return make_error UnexpectedType, "expected Sequence, got #{node.class.name.dump}", path
@@ -164,6 +251,10 @@ module YAMLSchema
           return make_error UnexpectedValue, "expected maximum #{schema["maxItems"]} items, but found #{node.children.length}", path
         end
 
+        if schema["minItems"] && node.children.length < schema["minItems"]
+          return make_error UnexpectedValue, "expected minimum #{schema["minItems"]} items, but found #{node.children.length}", path
+        end
+
         if schema["items"]
           node.children.each_with_index { |item, i|
             sub_schema = schema["items"]

data/test/pointer_test.rb

@@ -0,0 +1,36 @@
+require "minitest/autorun"
+require "yaml-schema"
+require "psych"
+
+module YAMLSchema
+  class PointerTest < Minitest::Test
+    def test_value
+      ast = Psych.parse("---\n  hello: world")
+      pointer = YAMLSchema::Pointer.new("/hello")
+      assert_equal "world", pointer.eval(ast).value
+      assert_equal "world", pointer.eval(ast.children.first).value
+    end
+
+    def test_nested_values
+      ast = Psych.parse("---\n  hello: \n    nested: world")
+      pointer = YAMLSchema::Pointer.new("/hello/nested")
+      assert_equal "world", pointer.eval(ast).value
+      assert_equal "world", pointer.eval(ast.children.first).value
+    end
+
+    def test_array_part
+      ast = Psych.parse("---\n- a\n- b\n- c")
+      pointer = YAMLSchema::Pointer.new("/0")
+      assert_equal "a", pointer.eval(ast).value
+      assert_equal "a", pointer[ast].value
+      assert_equal "b", Pointer["/1", ast].value
+      assert_equal "c", Pointer["/2", ast].value
+      assert_raises(IndexError) { Pointer["/3", ast] }
+    end
+
+    def test_map_key
+      ast = Psych.parse("---\n- a\n- b\n- c")
+      assert_raises(IndexError) { Pointer["/foo", ast] }
+    end
+  end
+end

data/test/validator_test.rb

@@ -5,6 +5,161 @@ require "psych"
 module YAMLSchema
   class Validator
     class ErrorTest < Minitest::Test
+      def test_property_max_length
+        ast = Psych.parse("---\n  hello: world")
+        assert_raises InvalidString do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "hello" => { "type" => "string" },
+            },
+            "propertyNames" => {
+              "maxLength" => 4
+            },
+            "items" => { "type" => "string" },
+          }, ast.children.first)
+        end
+
+        assert Validator.validate({
+          "type" => "object",
+          "properties" => {
+            "hello" => { "type" => "string" },
+          },
+          "maxPropertyLength" => 5,
+          "items" => { "type" => "string" },
+        }, ast.children.first)
+      end
+
+      def test_additional_properties
+        ast = Psych.parse("---\n  hello: world\n  foo: bar")
+        assert_raises UnexpectedProperty do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "hello" => { "type" => "string" },
+            },
+            "items" => { "type" => "string" }
+          }, ast.children.first)
+        end
+
+        ast = Psych.parse("---\n  hello: world\n  foo: bar")
+        assert Validator.validate({
+          "type" => "object",
+          "properties" => {
+            "hello" => { "type" => "string" },
+          },
+          "items" => { "type" => "string" },
+          "additionalProperties" => {
+            "type" => "string"
+          },
+        }, ast.children.first)
+
+        ast = Psych.parse("---\n  hello: world\n  foo: bar")
+        assert_raises UnexpectedValue do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "hello" => { "type" => "string" },
+            },
+            "items" => { "type" => "string" },
+            "additionalProperties" => {
+              "type" => "null"
+            },
+          }, ast.children.first)
+        end
+      end
+
+      def test_string_min_length
+        ast = Psych.parse("--- hello")
+        assert_raises InvalidString do
+          Validator.validate({
+            "type" => "string",
+            "minLength" => 6,
+          }, ast.children.first)
+        end
+
+        ast = Psych.parse("--- hello")
+        assert Validator.validate({
+          "type" => "string",
+          "minLength" => 5,
+        }, ast.children.first)
+      end
+
+      def test_string_max_length
+        ast = Psych.parse("--- hello")
+        assert_raises InvalidString do
+          Validator.validate({
+            "type" => "string",
+            "maxLength" => 4,
+          }, ast.children.first)
+        end
+
+        ast = Psych.parse("--- hello")
+        assert Validator.validate({
+          "type" => "string",
+          "maxLength" => 5,
+        }, ast.children.first)
+      end
+
+      def test_minItems
+        ast = Psych.parse("---\n- bar")
+        assert_raises UnexpectedValue do
+          Validator.validate({
+            "type" => "array",
+            "items" => { "type" => "string" },
+            "minItems" => 2
+          }, ast.children.first)
+        end
+
+        ast = Psych.parse("---\n- bar")
+        assert Validator.validate({
+          "type" => "array",
+          "items" => { "type" => "string" },
+          "minItems" => 1
+        }, ast.children.first)
+      end
+
+      def test_regular_expression
+        ast = Psych.parse("bar")
+        assert_raises InvalidString do
+          Validator.validate({
+            "type" => "string",
+            "pattern" => /foo/
+          }, ast.children.first)
+        end
+
+        assert Validator.validate({
+          "type" => "string",
+          "pattern" => /bar/
+        }, ast.children.first)
+      end
+
+      def test_missing_required
+        ast = Psych.parse("foo: bar")
+        assert_raises MissingRequiredField do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "foo" => { "type" => "string" },
+              "bar" => { "type" => "string" },
+              "baz" => { "type" => "string" },
+            },
+            "required" => [ "foo", "baz"],
+          }, ast.children.first)
+        end
+
+        ast = Psych.parse("---\n  foo: bar\n  baz: hello")
+        assert Validator.validate({
+          "type" => "object",
+          "properties" => {
+            "foo" => { "type" => "string" },
+            "bar" => { "type" => "string" },
+            "baz" => { "type" => "string" },
+          },
+          "required" => [ "foo", "baz"],
+        }, ast.children.first)
+      end
+
       def test_missing_tag
         ast = Psych.parse("foo: bar")
         assert_raises UnexpectedTag do

data/yaml-schema.gemspec

@@ -1,8 +1,9 @@
 $: << File.expand_path("lib")
+require "yaml-schema"
 
 Gem::Specification.new do |s|
   s.name        = "yaml-schema"
-  s.version     = "1.0.0"
+  s.version     = YAMLSchema::VERSION
   s.summary     = "Validate YAML against a schema"
   s.description = "If you need to validate YAML against a schema, use this"
   s.authors     = ["Aaron Patterson"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml-schema
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Aaron Patterson
@@ -57,11 +57,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/yaml-schema.rb
+- test/pointer_test.rb
 - test/validator_test.rb
 - yaml-schema.gemspec
 homepage: https://github.com/tenderlove/yaml-schema
@@ -82,8 +86,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.0.dev
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Validate YAML against a schema
 test_files:
+- test/pointer_test.rb
 - test/validator_test.rb