structure_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c0b88191b18ae92fc1294dd58ea5682c2e42a49
+  data.tar.gz: 49d5cb2b698018f2dce6521c1cbea879f17e46a1
+SHA512:
+  metadata.gz: 443fc198c4e4369845534e2c76c59433f8a9d55e9a704fd5b86157b7c61ac5b2e81825db1e6616ff1877631cfd74fae6618cc1bf77fd927205cff1fab1155e49
+  data.tar.gz: dca82a629ee8004b94d1d07365337662f64b5d88b2e9fc749fb5e684fe999bbfbd20f99de9414a90be8d7a1cb7b9a5689b07e655804d8df7dd634aeb683c76e9

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Claudio Ortolina
+
+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,46 @@
+# StructureValidator
+
+Allows testing a hash against a specified structure:
+
+    test_hash = { 
+      name: 'Foo',
+      count: 3,
+      data: {
+        text: 'content',
+        meta: 'http://example.com'
+      }
+    }
+
+    expected_structure = {
+      name: 'string',
+      count: 'integer',
+      data: {
+        text: 'string',
+        meta: 'string
+      }
+    }
+
+    StructureValidator.validate(test_hash, expected_structure)
+    # => true
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'structure_validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structure_validator
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/structure_validator.rb

@@ -0,0 +1,43 @@
+require 'json'
+require 'structure_validator/version'
+
+module StructureValidator
+  class UnsupportedDataType < RuntimeError; end
+
+  def self.validate(object, expected_structure)
+    check_required_keys(object, expected_structure) && check_type_for_each_key(object, expected_structure)
+  end
+
+  private
+
+  def self.check_required_keys(object, expected_structure)
+    (expected_structure.keys - object.keys).empty?
+  end
+
+  def self.check_type_for_each_key(object, expected_structure)
+    expected_structure.delete_if do |key, type|
+      if type.is_a?(Hash) && object[key].is_a?(Hash)
+        validate(object[key], type)
+      else
+        test_type_for(object[key], type)
+      end
+    end.empty?
+  end
+
+  def self.test_type_for(value, type)
+    case type.to_sym
+    when :string
+      value.is_a? String
+    when :integer
+      value.is_a? Integer
+    when :json
+      begin
+        !!JSON.parse(value)
+      rescue JSON::ParserError
+        false
+      end
+    else
+      raise UnsupportedDataType.new("Unexpected type: #{type}")
+    end
+  end
+end

data/lib/structure_validator/version.rb

@@ -0,0 +1,3 @@
+module StructureValidator
+  VERSION = "0.0.1"
+end

data/spec/core_ext/hash.rb

@@ -0,0 +1,27 @@
+class Hash
+  # Returns a new hash with +self+ and +other_hash+ merged recursively.
+  #
+  #   h1 = { x: { y: [4,5,6] }, z: [7,8,9] }
+  #   h2 = { x: { y: [7,8,9] }, z: 'xyz' }
+  #
+  #   h1.deep_merge(h2) #=> {x: {y: [7, 8, 9]}, z: "xyz"}
+  #   h2.deep_merge(h1) #=> {x: {y: [4, 5, 6]}, z: [7, 8, 9]}
+  #   h1.deep_merge(h2) { |key, old, new| Array.wrap(old) + Array.wrap(new) }
+  #   #=> {:x=>{:y=>[4, 5, 6, 7, 8, 9]}, :z=>[7, 8, 9, "xyz"]}
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+
+  # Same as +deep_merge+, but modifies +self+.
+  def deep_merge!(other_hash, &block)
+    other_hash.each_pair do |k,v|
+      tv = self[k]
+      if tv.is_a?(Hash) && v.is_a?(Hash)
+        self[k] = tv.deep_merge(v, &block)
+      else
+        self[k] = block && tv ? block.call(k, tv, v) : v
+      end
+    end
+    self
+  end
+end

data/spec/structure_validator_spec.rb

@@ -0,0 +1,49 @@
+require_relative 'core_ext/hash'
+require_relative '../lib/structure_validator'
+
+describe StructureValidator do
+
+  let(:hash_to_validate) do
+    {
+      item: {
+        name: 'Foo',
+        count: 3,
+        data: {
+          some: 'value'
+        }.to_json
+      }
+    }
+  end
+
+  let(:expected_structure) do
+    {
+      item: {
+        name: 'string',
+        count: 'integer',
+        data: 'json'
+      }
+    }
+  end
+
+  it "validates the hash" do
+    expect(StructureValidator.validate(hash_to_validate, expected_structure)).to be_true
+  end
+
+  it "checks required keys" do
+    hash_to_validate[:item].delete(:count)
+    expect(StructureValidator.validate(hash_to_validate, expected_structure)).to be_false
+  end
+
+  it "raises error with an unexpected type" do
+    expected_structure.deep_merge!(item: { name: 'foo' })
+    expect {
+      StructureValidator.validate(hash_to_validate, expected_structure)
+    }.to raise_error(StructureValidator::UnsupportedDataType, 'Unexpected type: foo')
+  end
+
+  it "checks the key type" do
+    hash_to_validate.merge!(item: { count: 'foo' })
+    expect(StructureValidator.validate(hash_to_validate, expected_structure)).to be_false
+  end
+
+end

data/structure_validator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'structure_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "structure_validator"
+  spec.version       = StructureValidator::VERSION
+  spec.authors       = ["Claudio Ortolina"]
+  spec.email         = ["claudio@new-bamboo.co.uk"]
+  spec.description   = %q{Validates a hash against an expected structure.}
+  spec.summary       = %q{Validates a hash against an expected structure.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: structure_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Claudio Ortolina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Validates a hash against an expected structure.
+email:
+- claudio@new-bamboo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/structure_validator.rb
+- lib/structure_validator/version.rb
+- spec/core_ext/hash.rb
+- spec/structure_validator_spec.rb
+- structure_validator.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Validates a hash against an expected structure.
+test_files:
+- spec/core_ext/hash.rb
+- spec/structure_validator_spec.rb