schema_hash 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David James
+
+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,41 @@
+# schema_hash
+
+Is your hash in shape? Validates a hash against a (basic) schema.
+
+This was built to support validation of config.yml files with nested keys.
+
+## Usage
+
+    > require 'schema_hash'
+    > h = { :timeout => 10, :uri => "data.gov" }
+
+    > h.schema = { :timeout => true }
+    > h.valid?
+    => false
+    
+    h.schema = { :timeout => true, :uri => true, :key => true }
+    h.valid?
+    => false
+
+    h.schema = { :timeout => true, :uri => true }
+    h.valid?
+    => true
+
+## Future Ideas
+
+* Specify optional keys
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 David James. See LICENSE for details.

data/README.rdoc

@@ -0,0 +1,20 @@
+= schema_hash
+
+Is your hash in shape? Validates a hash against a (basic) schema.
+
+This was built to support validation of config.yml files with nested keys.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 David James. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "schema_hash"
+    gem.summary = %Q{Validates a hash against a schema.}
+    gem.description = %Q{Is your hash in shape? We can help.}
+    gem.email = "djames@sunlightfoundation.com"
+    gem.homepage = "http://github.com/djsun/schema_hash"
+    gem.authors = ["David James"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "schema_hash #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/hash.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/schemable')
+
+class Hash
+  
+  def schema=(hash)
+    self.extend Schemable
+    self.schema = hash
+  end
+  
+end

data/lib/schema_hash.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + '/hash')

data/lib/schemable.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/traversable')
+
+module Schemable
+
+  include Traversable
+
+  attr_reader :schema
+  
+  def schema=(schema)
+    hash = schema.dup
+    hash.extend Traversable
+    @schema = hash.dup.extend Traversable
+  end
+
+  def valid?
+    valid_subset? && !invalid_superset?
+  end
+
+  # Are all required keys present?
+  # "valid when nothing is missing"
+  def valid_subset?
+    valid = true
+    schema.traverse do |key_path, value|
+      actual = self.ref(key_path)
+      missing = actual.nil?
+      valid = valid && !missing
+    end
+    valid
+  end
+  
+  # Are no extra keys present?
+  # "invalid when something is unexpected"
+  def invalid_superset?
+    invalid = false
+    self.traverse do |key_path, value|
+      expected = schema.ref(key_path)
+      invalid = invalid || !expected
+    end
+    invalid
+  end
+  
+end

data/lib/traversable.rb

@@ -0,0 +1,30 @@
+module Traversable
+  
+  def traverse(&block)
+    self.each do |key, value|
+      Traversable._traverse(key, value, [], &block)
+    end
+  end
+    
+  def self._traverse(key, value, path, &block)
+    if value.is_a?(Hash)
+      value.each do |k, v|
+        p = path + [key]
+        yield(p, value)
+        _traverse(k, v, p, &block)
+      end
+    else
+      yield(path + [key], value)
+    end
+  end
+  
+  # reference(["a", "b"]) is a safe version of self["a"]["b"]
+  def ref(key_path)
+    object = self
+    key_path.each do |key|
+      object = object.is_a?(Hash) ? object[key] : nil
+    end
+    object
+  end
+  
+end

data/schema_hash.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{schema_hash}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David James"]
+  s.date = %q{2009-10-08}
+  s.description = %q{Is your hash in shape? We can help.}
+  s.email = %q{djames@sunlightfoundation.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/hash.rb",
+     "lib/schema_hash.rb",
+     "lib/schemable.rb",
+     "lib/traversable.rb",
+     "schema_hash.gemspec",
+     "spec/hash_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/traversable_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/djsun/schema_hash}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Validates a hash against a schema.}
+  s.test_files = [
+    "spec/hash_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/traversable_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/spec/hash_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Hash do
+
+  describe "calling #schema on a Hash" do
+    before do
+      @h = { :a => "a" }
+      @h.schema = {} # value is arbitrary
+      @h
+    end
+  
+    it "should be Schemable" do
+      @h.is_a?(Schemable).should be_true
+    end
+
+    it "should have #valid?" do
+      @h.respond_to?(:valid?).should be_true
+    end
+
+    it "should have #schema" do
+      @h.respond_to?(:schema).should be_true
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'schema_hash'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/traversable_spec.rb

@@ -0,0 +1,137 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Traversable do
+  
+  describe "#ref" do
+    describe "simple hash" do
+      before do
+        @h = { :a => "a" }
+        @h.extend Traversable
+      end
+    
+      it "[]" do
+        @h.ref([]).should == @h
+      end
+    
+      it "[:x]" do
+        @h.ref([:x]).should == nil
+      end
+
+      it "[:x, :y]" do
+        @h.ref([:x, :y]).should == nil
+      end
+    
+      it "[:a]" do
+        @h.ref([:a]).should == @h[:a]
+      end
+    end
+    
+    describe "2 level hash" do
+      before do
+        @h = { :a => { :b => "b" } }
+        @h.extend Traversable
+      end
+    
+      it "[]" do
+        @h.ref([]).should == @h
+      end
+    
+      it "[:x]" do
+        @h.ref([:x]).should == nil
+      end
+
+      it "[:x, :y]" do
+        @h.ref([:x, :y]).should == nil
+      end
+    
+      it "[:a]" do
+        @h.ref([:a]).should == @h[:a]
+      end
+    
+      it "[:a, :b]" do
+        @h.ref([:a, :b]).should == @h[:a][:b]
+      end
+    end
+    
+    describe "3 level hash" do
+      before do
+        @h = { :a => { :b => { :c => "c" } } }
+        @h.extend Traversable
+      end
+    
+      it "[]" do
+        @h.ref([]).should == @h
+      end
+    
+      it "[:x]" do
+        @h.ref([:x]).should == nil
+      end
+
+      it "[:x, :y]" do
+        @h.ref([:x, :y]).should == nil
+      end
+    
+      it "[:a]" do
+        @h.ref([:a]).should == @h[:a]
+      end
+
+      it "[:a, :x]" do
+        @h.ref([:a, :x]).should == nil
+      end
+    
+      it "[:a, :b]" do
+        @h.ref([:a, :b]).should == @h[:a][:b]
+      end
+
+      it "[:a, :b, :x]" do
+        @h.ref([:a, :b, :x]).should == nil
+      end
+    
+      it "[:a, :b, :c]" do
+        @h.ref([:a, :b, :c]).should == @h[:a][:b][:c]
+      end
+    end
+  end
+
+  describe "#traverse" do
+    it "over a 1 level hash" do
+      @h = { :a => "a" }
+      @h.extend Traversable
+      array = []
+      @h.traverse do |key_path, value|
+        array << [key_path, value]
+      end
+      array.should == [
+        [[:a], "a"]
+      ]
+    end
+    
+    it "over a 2 level hash" do
+      @h = { :a => { :b => "b" } }
+      @h.extend Traversable
+      array = []
+      @h.traverse do |key_path, value|
+        array << [key_path, value]
+      end
+      array.should == [
+        [[:a], { :b => "b" }],
+        [[:a, :b], "b"]
+      ]
+    end
+
+    it "over a 3 level hash" do
+      @h = { :a => { :b => { :c => "c" } } }
+      @h.extend Traversable
+      array = []
+      @h.traverse do |key_path, value|
+        array << [key_path, value]
+      end
+      array.should == [
+        [[:a], { :b => {:c => "c" }}],
+        [[:a, :b], { :c => "c"}],
+        [[:a, :b, :c], "c"]
+      ]
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: schema_hash
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- David James
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Is your hash in shape? We can help.
+email: djames@sunlightfoundation.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/hash.rb
+- lib/schema_hash.rb
+- lib/schemable.rb
+- lib/traversable.rb
+- schema_hash.gemspec
+- spec/hash_spec.rb
+- spec/spec_helper.rb
+- spec/traversable_spec.rb
+has_rdoc: true
+homepage: http://github.com/djsun/schema_hash
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Validates a hash against a schema.
+test_files: 
+- spec/hash_spec.rb
+- spec/spec_helper.rb
+- spec/traversable_spec.rb