hash_schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a30a25b38f10cad859deefa8e318414c94055ab
+  data.tar.gz: 4683b1715e4b134c3ea58bbf72bb711268b13e35
+SHA512:
+  metadata.gz: 134fe97ce8908958baa7ca21b01990e5e50da4ff3d4c99fa9025cfd2228f639d045dcb453f2f0ff6c70ec1608433ba4f8c986467bbc445d41221c5081887359c
+  data.tar.gz: d1c4aacaa841a7ce398becee5dc10a8cce192905a4eb84c82c23d5ce8258e0e0af5cd80827ddaf78943b04340b961d0ba8db1b96c6a903ba0d9f06d54524fe0f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hash_schema.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Po Chen
+
+MIT License
+
+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,29 @@
+# HashSchema
+
+A ruby gem that validates Hash against some schema, works for hashes created from loading json and yml files, and suchlike
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hash_schema'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_schema
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hash_schema/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bump/tasks"
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/hash_schema.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_schema/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_schema"
+  spec.version       = HashSchema::VERSION
+  spec.authors       = ["Po Chen"]
+  spec.email         = ["pchen@zendesk.com"]
+  spec.summary       = %q{Validate Hash against Schema}
+  spec.description   = <<-DESC
+    This gem provides schema building blocks that can be used to define
+    complicated hash structures, which can then be used to validate hashes
+    that are created by loading json or yml files.
+  DESC
+  spec.homepage      = "https://github.com/princemaple/hash_schema"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bump"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/hash_schema.rb

@@ -0,0 +1,188 @@
+require "hash_schema/version"
+
+module HashSchema
+  class Schema
+    def initialize(chain = nil)
+      @chain = chain
+    end
+
+    def interpret(data)
+      (@interpretations = []).tap do |_|
+        interpret_errors(validate(data), 'root')
+      end
+    end
+
+    attr_reader :chain
+
+    def pretty_validate(data)
+      require 'json'
+      JSON.pretty_generate(validate(data))
+    end
+
+    def expectation
+      self.class.name.split('::').last.sub('Schema', '')
+    end
+
+    protected
+
+    def error(data)
+      expect(expectation, data)
+    end
+
+    def expect(wanted, unwanted)
+      "Expected #{wanted} but got #{unwanted.inspect}"
+    end
+
+    private
+
+    def interpret_errors(errors, *prefixes)
+      *prefixes, prefix = prefixes
+      prefixes <<= format(errors, prefix)
+
+      case errors
+        when Hash
+          errors.each do |key, val|
+            next if val.nil?
+            interpret_errors(val, *prefixes, key)
+          end
+        when Array
+          errors.each_with_index do |val, index|
+            next if val.nil?
+            interpret_errors(val, *prefixes, index)
+          end
+        when String
+          @interpretations << (prefixes << errors).join(' > ')
+      end
+    end
+
+    def format(error, name)
+      if name.kind_of?(Numeric)
+        name = "##{name}"
+        return name if error.is_a?(String)
+      end
+
+      case error
+        when Hash
+          "#{name}:{}"
+        when Array
+          "#{name}:[]"
+        when String
+          ".#{name}"
+      end
+    end
+  end
+
+  class OptionalSchema < Schema
+    def validate(data)
+      return if data.is_a?(Void)
+      return chain.validate(data) if chain.kind_of?(Schema)
+      expect(chain.inspect, data) unless chain == data
+    end
+  end
+
+  class OrSchema < Schema
+    def initialize(*schemas)
+      @chain = schemas
+    end
+
+    def validate(data)
+      chain.each do |schema|
+        if data.is_a?(Array) && schema.is_a?(ArraySchema) || data.is_a?(Hash) && schema.is_a?(HashSchema)
+          return schema.validate(data)
+        end
+        return if schema.validate(data).nil?
+      end
+      error(data)
+    end
+
+    def expectation
+      *names, name = chain.map(&:expectation)
+      names.join(', ') << " or #{name}"
+    end
+  end
+
+  class StringSchema < Schema
+    def validate(data)
+      return if data.is_a?(String)
+      error(data)
+    end
+  end
+
+  class NumberSchema < Schema
+    def validate(data)
+      return if data.kind_of?(Numeric)
+      error(data)
+    end
+  end
+
+  class BooleanSchema < Schema
+    def validate(data)
+      return if data.is_a?(TrueClass) || data.is_a?(FalseClass)
+      error(data)
+    end
+  end
+
+  class ArraySchema < Schema
+    def validate(data)
+      return data.map { |item| chain.validate(item) } if data.is_a?(Array)
+      error(data)
+    end
+
+    def expectation
+      "[#{chain.expectation}]"
+    end
+  end
+
+  class EnumSchema < Schema
+    def initialize(*enum)
+      @chain = enum
+    end
+
+    def validate(data)
+      return if chain.include?(data)
+      error(data)
+    end
+
+    def expectation
+      *vals, val = chain.map(&:inspect)
+      vals.join(', ') << " or #{val}"
+    end
+  end
+
+  class HashSchema < Schema
+    def initialize(strict: false, **hash)
+      @chain = hash
+      @strict = strict
+    end
+
+    def validate(hash)
+      return error(hash) unless hash.is_a?(Hash)
+      {}.tap do |output|
+        chain.each do |key, schema|
+          val = hash[key] || hash.fetch(key.to_s, Void.new)
+          output[key] = if schema.kind_of?(Schema)
+            schema.validate(val)
+          else
+            schema == val ? nil : expect(schema.inspect, val)
+          end
+        end
+
+        output.merge!((hash.keys - chain.keys).map { |k| [k, unexpected(k)] }.to_h) if @strict
+      end
+    end
+
+    def unexpected(key)
+      "Unexpected key: #{key.to_s.inspect}"
+    end
+  end
+
+  private
+
+  class Void
+    def to_s
+      'Nothing'
+    end
+
+    alias :inspect :to_s
+  end
+end

data/lib/hash_schema/version.rb

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

data/spec/hash_schema_spec.rb

@@ -0,0 +1,232 @@
+require 'spec_helper'
+
+describe HashSchema do
+  Testers = ['abc123', 123, true, HashSchema::Void.new]
+
+  def except(type)
+    Testers.reject { |tester| tester.is_a? type }
+  end
+
+  describe HashSchema::StringSchema do
+    subject { HashSchema::StringSchema }
+
+    it 'passes for String type value' do
+      expect(subject.new.validate('abc123!@#$%^&*()_=-+')).to be_nil
+    end
+
+    it 'fails for other types' do
+      except(String).each do |tester|
+        expect(subject.new.validate(tester)).to_not be_nil
+      end
+    end
+  end
+
+  describe HashSchema::NumberSchema do
+    subject { HashSchema::NumberSchema }
+
+    it 'passes for Numeric type value' do
+      expect(subject.new.validate(1234567890)).to be_nil
+    end
+
+    it 'fails for other types' do
+      except(Numeric).each do |tester|
+        expect(subject.new.validate(tester)).to_not be_nil
+      end
+    end
+  end
+
+  describe HashSchema::BooleanSchema do
+    subject { HashSchema::BooleanSchema }
+
+    it 'passes for Boolean type value' do
+      expect(subject.new.validate(true)).to be_nil
+    end
+
+    it 'fails for other types' do
+      except(TrueClass).each do |tester|
+        expect(subject.new.validate(tester)).to_not be_nil
+      end
+    end
+  end
+
+  describe HashSchema::OptionalSchema do
+    subject { HashSchema::OptionalSchema }
+
+    it 'passes for Void type value' do
+      expect(subject.new.validate(HashSchema::Void.new)).to be_nil
+    end
+
+    context 'when initialized with a Schema' do
+      it 'delegates to the inner Schema' do
+        schema = Class.new(HashSchema::Schema).new
+
+        expect(schema).to receive(:validate)
+
+        subject.new(schema).validate(1)
+      end
+    end
+
+    context 'when initialized with literal value' do
+      it 'passes for the exact value' do
+        expect(subject.new(1).validate(1)).to be_nil
+      end
+
+      it 'fails for different value' do
+        expect(subject.new(1).validate(2)).to_not be_nil
+      end
+    end
+  end
+
+  describe HashSchema::EnumSchema do
+    subject { HashSchema::EnumSchema.new(1, 'a', true) }
+
+    it 'passes for provided literal values' do
+      expect(subject.validate(1)).to be_nil
+    end
+
+    it 'passes for provided literal values' do
+      expect(subject.validate('a')).to be_nil
+    end
+
+    it 'passes for provided literal values' do
+      expect(subject.validate(true)).to be_nil
+    end
+
+    it 'fails for other values' do
+      expect(subject.validate(2)).to_not be_nil
+    end
+
+    it 'fails for other values' do
+      expect(subject.validate('b')).to_not be_nil
+    end
+
+    it 'fails for other values' do
+      expect(subject.validate(false)).to_not be_nil
+    end
+  end
+
+  describe HashSchema::OrSchema do
+    subject { HashSchema::OrSchema }
+
+    let(:multitype) do
+      subject.new(
+        HashSchema::NumberSchema.new,
+        HashSchema::StringSchema.new,
+        HashSchema::ArraySchema.new(HashSchema::StringSchema.new),
+        HashSchema::HashSchema.new
+      )
+    end
+
+    it 'passes if any inner schema passes' do
+      expect(multitype.validate(1)).to be_nil
+    end
+
+    it 'passes if any inner schema passes' do
+      expect(multitype.validate('a')).to be_nil
+    end
+
+    context 'when having inner ArraySchema or HashSchema' do
+      it 'delegates to given ArraySchema for array' do
+        expect(multitype.validate([])).to be_a(Array)
+      end
+
+      it 'delegates to given HashSchema for hash' do
+        expect(multitype.validate({})).to be_a(Hash)
+      end
+    end
+
+    it 'fails if all inner schema fail' do
+      expect(multitype.validate(false)).to_not be_nil
+    end
+  end
+
+  describe HashSchema::ArraySchema do
+    subject { HashSchema::ArraySchema }
+
+    let(:string_array) { ['a', 'b', 'c', 'd'] }
+    let(:chaos_array) { ['a', 1, false, [], {}] }
+    let(:string_array_schema) { subject.new(HashSchema::StringSchema.new) }
+    let(:hash_array_schema) { subject.new(HashSchema::HashSchema.new) }
+
+    it 'passes for array of the given type' do
+      expect(string_array_schema.validate(string_array).compact).to eq([])
+    end
+
+    it 'fails for non-array input' do
+      expect(string_array_schema.validate(123)).to_not be_nil
+    end
+
+    it 'handles nested structure' do
+      expect(hash_array_schema.validate([{}, { x: 1 }, { y: 2 }])).to eq([{}, {}, {}])
+    end
+
+    it 'fails for array containing values not being the given type' do
+      expect(string_array_schema.validate(chaos_array).compact.size).to eq(4)
+    end
+  end
+
+  describe HashSchema::HashSchema do
+    subject { HashSchema::HashSchema }
+
+    it 'passes if all literal attributes pass' do
+      schema = subject.new(
+        string: HashSchema::StringSchema.new,
+        number: HashSchema::NumberSchema.new,
+        boolean: HashSchema::BooleanSchema.new,
+        nothing: HashSchema::OptionalSchema.new,
+        enum: HashSchema::EnumSchema.new(1, 'a', true)
+      )
+
+      data = {
+        string: 'abc',
+        number: 123,
+        boolean: true,
+        enum: 'a'
+      }
+
+      expect(schema.validate(data).reject { |_, v| v.nil? }).to be_empty
+    end
+
+    it 'handles nested structure' do
+      schema = subject.new(
+        hash: subject.new(
+          literal: 1
+        )
+      )
+
+      data = {
+        hash: {
+          literal: 1
+        }
+      }
+
+      expect(schema.validate(data)).to eq({ hash: { literal: nil } })
+    end
+
+    it 'handles nested structure' do
+      schema = subject.new(
+        array: HashSchema::ArraySchema.new(HashSchema::BooleanSchema.new)
+      )
+
+      data = {
+        array: [true, false]
+      }
+
+      expect(schema.validate(data)).to eq({ array: [nil, nil] })
+    end
+
+    it 'fails for non-hash input' do
+      expect(subject.new.validate(123)).to_not be_nil
+    end
+
+    context 'when strict mode' do
+      it 'fails for extra attributes' do
+        schema = subject.new(strict: true, x: 0)
+
+        data = { x: 0, y: 1 }
+
+        expect(schema.validate(data).reject { |_, v| v.nil? }).to include(:y)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'hash_schema'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: hash_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Po Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      This gem provides schema building blocks that can be used to define
+      complicated hash structures, which can then be used to validate hashes
+      that are created by loading json or yml files.
+email:
+- pchen@zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_schema.gemspec
+- lib/hash_schema.rb
+- lib/hash_schema/version.rb
+- spec/hash_schema_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/princemaple/hash_schema
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Validate Hash against Schema
+test_files:
+- spec/hash_schema_spec.rb
+- spec/spec_helper.rb