valentine 0.2.1

data/History.txt

@@ -0,0 +1,7 @@
+=== 0.1.0 / 2008-10-11
+
+First Release!
+
+=== 0.2.0 / 2008-10-12
+
+Added support message support via exceptions.

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/valentine.rb
+spec/valentine_spec.rb

data/README.txt

@@ -0,0 +1,48 @@
+= valentine
+
+* FIX (url)
+
+== DESCRIPTION:
+
+Valentine is a simple validation library for JSON and ordinary Hash based on an easy Hash based syntax.
+
+== FEATURES/PROBLEMS:
+
+Currently, Valentine handles the basic task of validatiing hashes very well.  In the future, it should have custom error message support and the ability to apply its logic to arbitary objects, not just hashes.
+
+== SYNOPSIS:
+
+Valentine::validate({:a=>1, :b=>{:c =>[1,2]}}, {:a=> Numeric, :b=>{:c=>[Numeric, Numeric]}}, false) => true
+
+== REQUIREMENTS:
+
+json
+
+== INSTALL:
+
+gem install valentine
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008
+
+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/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'hoe'
+require 'spec/rake/spectask'
+
+Hoe.new('valentine', '0.2.1') do |p|
+  p.developer('Mark Baran', 'mebaran@gmail.com')
+end
+
+desc "Run specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/*_spec.rb']
+end

data/lib/valentine.rb

@@ -0,0 +1,122 @@
+require 'rubygems'
+
+module Valentine
+  VERSION = "0.3.0"
+  DEFAULT_MESSAGES = { 
+        :proc => "Failed to pass validation test.",
+        :array => "Collection failed to pass validation.",
+        :true => "Required key missing.",
+        :false => "Key forbidden in this context",
+        :value => "Invalid value."
+  }
+  
+  ## Convenience class for composing rules and syntactic sugar for supplying custom messages
+  class ValentineNote
+    attr_accessor :defendant, :rules
+    def initialize(defendant, rules={}, msgs={}, &transformer)
+      @rules, @report = defendant, rules
+      @transformer = transformer
+      case defendant
+      when Hash then @defendant = defendant
+      when String then @defendant = transform(defendant)
+      when ValentineNote
+        @defendant = defendant.defendant
+        @rules = defendant.rules.merge rules     
+      end
+      @messages = msgs.merge! DEFAULT_MESSAGES
+    end
+    
+    def revalidate
+      validate!
+    end
+    
+    def validate(msgs={})
+      @validation ||= validate!
+    end
+    
+    def valid?
+      Valentine::judge(self.validate)
+    end
+    
+    protected
+    
+    def validate!(msgs={})
+      Valentine::validate(@defendant, @rules, true, msgs.merge!(@messages))
+    end
+
+    def transform(s)
+      @transformer ? @transformer.call(s) : raise("No transformed defined.")
+    end
+  end
+  
+  
+  ## Module Utility Methods follow.
+  def self::validate(defendant, rules={}, report=true, msgs={})
+    return defendant.validate if defendant.is_a? ValentineNote
+    errors = {}
+    rules.each do |a, rule|
+      begin
+        result = Valentine::doublecheck(defendant[a], rule, report, a, msgs)
+        errors[a] = result
+      rescue Exception => e
+        errors[a] = e
+      end
+    end
+    report ? errors : self::judge(errors)
+  end
+  
+  def self::expectation(r, m="", msg=true, at=nil) 
+    if r
+      true
+    else
+      msg ? ValentineError.new([at, m] * ': ') : false
+    end
+  end
+  
+  def self::doublecheck(value, rule, msg=true, at=nil, msgs={})
+    msgs.merge!(DEFAULT_MESSAGES)
+    case rule
+    when Hash then value.respond_to?(:[]) && self::validate(value, rule)
+    when Proc
+      begin
+        r = rule.call(value)
+        if r.is_a? Exception
+          return r
+        else
+          Valentine::expectation r, msgs[:proc], msg, at
+        end
+      rescue Exception => e
+        return e
+      end
+    when Array
+      valid = true
+      value.is_a?(Array) && rule.each_index do |i| 
+        valid &&= self::doublecheck(value[i], rule[i])
+      end
+      self::expectation valid, msgs[:array], msg, at
+    when true
+     self::expectation !value.nil?, msgs[:true], msg, at
+    when false
+      self::expectation value.nil?, msgs[:false], msg, at
+    when nil then true
+    else 
+      self::expectation rule === value, msgs[:value], msg, at
+    end
+  end
+  
+  def self::judge(valentine)
+    if valentine.is_a? ValentineNote
+      self::judge(valentine.validate)
+    else
+      valentine.values.inject(true) do |s, v|
+        case v
+        when Hash then s && self::judge(v)
+        when Exception then s && false
+        else s && v
+        end
+      end
+    end
+  end
+
+  class ValentineError < Exception; end
+end

data/spec/valentine_spec.rb

@@ -0,0 +1,64 @@
+require './lib/valentine'
+
+describe Valentine do
+  
+  it "should validate true against an empty hash" do
+    Valentine::validate({:a=>1}, {}, false).should == true
+  end
+  
+  it "should validate integers against ranges" do
+    Valentine::validate({:a=>3}, {:a =>Numeric}, false).should == true
+  end
+  
+  it "should check arrays for the proper type" do
+    Valentine::validate({:a=>[1,2,3,4]}, {:a=>[Numeric, Numeric, String]}, false) == false
+  end
+  
+  it "should be able to validate arrays" do
+    Valentine::validate({:a=>[1,2,3,4]}, {:a=>[Numeric, proc{|x| x > 1}, Numeric]}, false).should == true
+  end
+  
+  it "should handle complex cases against the blank ruleset" do
+    Valentine::validate({:a=>8, :b=>{:c=>4, :d => [1, {:e => "f"}]}}, {}, false).should == true
+  end
+  
+  it "should use lambdas as rules" do
+    Valentine::validate({:a=>"superstring"}, {:a=> lambda{|s| s.length > 5}}, false).should == true
+  end
+  
+  it "should recurse for hashes" do
+    Valentine::validate({:a=>8, :b=>{:c=>4, :d => [1, {:e => "f"}]}},
+      {:b=>{:d=>[Numeric, {:e=>String}]}}, false).should == true
+  end
+  
+  it "should enforce exclusion requirements if false is passed" do
+    Valentine::validate({:a=>0}, {:a=>false}, false).should == false
+  end
+  
+  it "should ensure attributes marked true are present" do
+    Valentine::validate({:b => false}, {:a=>true}, false).should == false
+  end
+  
+  it "should use exceptions to indicate validation failures" do
+    Valentine::validate({:a=>4}, {:a=>lambda{|x| x < 3 ? true : Exception.new("Too big!")}}, false).should == false
+  end
+  
+  it "should catch raised errors as validation problems" do
+    Valentine::validate({:a=>3}, {:a=>lambda{|x| x < 2 ? true : raise("Too Big")}}, false).should == false
+  end
+  
+  it "should produce valid reports containing only truth, false, or Exception messages" do
+    tt = lambda do |h, eo|
+      h.values.inject(true) do |s, v|
+        if v.is_a? Hash
+          tt.call(v, eo)
+        else
+          s && (v == true || (!eo && v == false) || v.is_a?(Exception))
+        end
+      end
+    end
+    rep = Valentine::validate({:a=>8, :b=>{:c=>4, :d => [1, {:e => "f"}]}},
+      {:a=>8, :b=>{:c=> Numeric, :d=>String}})
+    tt.call(rep, true).should == true
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: valentine
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Mark Baran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: Valentine is a simple validation library for JSON and ordinary Hash based on an easy Hash based syntax.
+email: 
+- mebaran@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/valentine.rb
+- spec/valentine_spec.rb
+has_rdoc: true
+homepage: FIX (url)
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: valentine
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Valentine is a simple validation library for JSON and ordinary Hash based on an easy Hash based syntax.
+test_files: []
+