deeply_valid 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,62 @@
-= deeply_valid
+= DeeplyValid
+
+There are times when you just can't fake it. Maybe you're 
+implementing an API, or interacting with a legacy system. 
+But for whatever reason, you have complex data structures 
+that absolutely have to be valid.
+
+DeeplyValid lets you define a "schema" for your data structures
+in a nice, declarative, way.
+
+== The Simplest Example:
+
+  class MyValidations < DeeplyValid::Base
+    define :name, "bob"
+  end
+
+  # true
+  MyValidations[:name].valid?("bob") 
+
+  # false
+  MyValidations[:name].valid?("joe") 
+
+
+== A more realistic example
+
+  class MyValidations < DeeplyValid::Base
+    define :person, {
+      :id => token(32),
+      :age => integer(1..100),
+      :name => string(1..100),
+      :department => {
+        :name => any('sales', 'accounting', 'engineering'),
+        :building => integer
+      },
+      :performace_reviews => array( structure(:review) )
+    }
+
+    # This structure is referenced in the "person" structure
+    define :review, {
+      :author => string(1..100),
+      :body => string(1..1024)
+    }
+  end
+ 
+  # true
+  MyValidations[:person].valid?({
+    :id => "x"*32,
+    :age => 22,
+    :name => "Bob Jones",
+    :department => {
+      :name => "sales",
+      :building => 33
+    },
+    :performace_reviews  => [
+      { :author => "joe", :body => "a review" }, 
+      { :author => "bill", :body => "another review" } 
+    ]
+  })
 
-Description goes here.
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/deeply_valid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{deeply_valid}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Starr Horne"]
-  s.date = %q{2010-06-06}
+  s.date = %q{2010-06-07}
   s.description = %q{This gem lets you declaratively specify validations for complex data structures, like those returned from an api.}
   s.email = %q{starr@chromahq.com}
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
      "lib/deeply_valid/validation_helpers.rb",
      "test/base_test.rb",
      "test/helper.rb",
+     "test/system_test.rb",
      "test/validation_helpers_test.rb",
      "test/validation_test.rb"
   ]
@@ -41,6 +42,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/base_test.rb",
      "test/helper.rb",
+     "test/system_test.rb",
      "test/validation_helpers_test.rb",
      "test/validation_test.rb"
   ]

data/lib/deeply_valid/base.rb

@@ -1,5 +1,6 @@
 module DeeplyValid
 
+
   #
   # By subclassing the base class, you can easily create 
   # groups of validations.

data/lib/deeply_valid/validation_helpers.rb

@@ -22,8 +22,7 @@ module DeeplyValid
       # @return [Validation] The validation
       #
       def token(size = nil)
-        s = size ? "{#{size.is_a?(Range) ? [size.first, size.last].uniq.join(",") : size}}" : nil 
-        /[0-9a-zA-Z_]#{ s }/
+        Validation.new { |d| (d =~ /^[0-9a-zA-Z_]*$/) && in_range?(d.size, size) }
       end
 
       #
@@ -46,6 +45,36 @@ module DeeplyValid
         Validation.new { |d| d.is_a?(Integer) && in_range?(d, limit) }
       end
 
+      #
+      # Validates date with optional limit
+      #
+      # @param limit 
+      # @return [Validation] The validation
+      #
+      def date(limit = nil)
+        Validation.new { |d| d.is_a?(Date) && in_range?(d, limit) }
+      end
+
+      #
+      # Validates float with optional limit
+      #
+      # @param limit 
+      # @return [Validation] The validation
+      #
+      def float(limit = nil)
+        Validation.new { |d| d.is_a?(Float) && in_range?(d, limit) }
+      end
+
+      #
+      # Validates date with optional limit
+      #
+      # @param [Integer, Range] limit 
+      # @return [Validation] The validation
+      #
+      def datetime(limit = nil)
+        Validation.new { |d| d.is_a?(DateTime) && in_range?(d, limit) }
+      end
+
       #
       # Validate by class
       #
@@ -146,17 +175,42 @@ module DeeplyValid
         end
       end
 
-      protected
+      #
+      # Determine if a val is included in a range. A number of
+      # range formats are supportet
+      #
+      # == Example:
+      #
+      # All these will return true
+      #
+      #   in_range(1, 1)    
+      #   in_range(1, 0..9)    
+      #   in_range(1, :min => 0, :max => 9)    
+      #   in_range(1, :less_than_or_equal_to => 2)    
+      #
+      # @param val A number, date, or other other object to compare
+      # @param [Integer, Range, Hash] range The range to test `val` against
+      #
+      def in_range?(val, range)
+        return true unless range
 
-        #
-        # Determine if a val is included in a range. Handles
-        # range==int and range==nil correctly
-        #
-        def in_range?(val, range)
-          return true unless range
+        if range.is_a?(Hash)
+          result = true
+          result &= ( val < range[:before] ) if range[:before]
+          result &= ( val > range[:after] ) if range[:after]
+          result &= ( val <= range[:max] ) if range[:max]
+          result &= ( val >= range[:min] ) if range[:min]
+          result &= ( val < range[:less_than] ) if range[:less_than]
+          result &= ( val <= range[:less_than_or_equal_to] ) if range[:less_than_or_equal_to]
+          result &= ( val > range[:greater_than] ) if range[:greater_than]
+          result &= ( val >= range[:greater_than_or_equal_to] ) if range[:greater_than_or_equal_to]
+          result
+        else
           range = [range] unless range.respond_to?(:include?)
           range.include?(val)
         end
+
+        end
     end
   end
 end

data/test/system_test.rb

@@ -0,0 +1,66 @@
+require 'helper'
+
+class SystemTest < Test::Unit::TestCase
+
+  include DeeplyValid
+
+  context "a complex of validation" do
+    setup do
+
+      class MyValidations < DeeplyValid::Base
+        define :person, {
+          :id => token(32),
+          :age => integer(1..100),
+          :name => string(1..100),
+          :department => {
+            :name => any('sales', 'accounting', 'engineering'),
+            :building => integer
+          },
+          :performace_reviews => array( structure(:review) )
+        }
+
+        # This structure is referenced in the "person" structure
+        define :review, {
+          :author => string(1..100),
+          :body => string(1..1024)
+        }
+      end
+
+      @valid_person = {
+        :id => "x"*32,
+        :age => 22,
+        :name => "Bob Jones",
+        :department => {
+          :name => "sales",
+          :building => 33
+        },
+        :performace_reviews  => [
+          { :author => "joe", :body => "a review" }, 
+          { :author => "bill", :body => "another review" } 
+        ]
+      }
+
+      @invalid_person = {
+        :id => "x"*32,
+        :age => 22,
+        :name => "Bob Jones",
+        :department => {
+          :name => "sales",
+          :building => 33
+        },
+        :performace_reviews  => [
+          { :author =>  11, :body => "a review" }, 
+          { :author => "bill", :body => "another review" } 
+        ]
+      }
+
+    end
+
+    should "validate correctly" do
+      assert MyValidations[:person].valid?(@valid_person)
+      assert !MyValidations[:person].valid?(@invalid_person)
+    end
+    
+  end
+
+end

data/test/validation_helpers_test.rb

@@ -14,16 +14,19 @@ class ValidationHelpersTest < Test::Unit::TestCase
 
     context "token helper" do
 
-      should "return correct regexp when no size specified" do
-        assert Sample.token == /[0-9a-zA-Z_]/
+      should "validate correctly, without size" do
+        assert Sample.token.valid?("a_sdf123")
+        assert !Sample.token.valid?("a_!@#sdf123")
       end
 
-      should "return correct regexp when exact size specified" do
-        assert Sample.token(32) == /[0-9a-zA-Z_]{32}/
+      should "validate correctly, with exact size" do
+        assert Sample.token(4).valid?("asdf")
+        assert !Sample.token(4).valid?("a")
       end
 
-      should "return correct regexp when range size specified" do
-        assert Sample.token(1..23) == /[0-9a-zA-Z_]{1,23}/
+      should "validate correctly, with range size" do
+        assert Sample.token(1..5).valid?("asdf")
+        assert !Sample.token(3..5).valid?("a")
       end
 
     end
@@ -64,6 +67,33 @@ class ValidationHelpersTest < Test::Unit::TestCase
 
     end
 
+    context "float helper" do
+
+      should "validate correctly" do
+        assert Sample.float.valid?(1.234)
+        assert !Sample.float(:max => 0.5).valid?(1.234)
+      end
+
+    end
+
+    context "date helper" do
+
+      should "validate correctly" do
+        assert Sample.date.valid?(Date.today)
+        assert !Sample.date(:before => Date.today).valid?(Date.today)
+      end
+
+    end
+
+    context "datetime helper" do
+
+      should "validate correctly" do
+        assert Sample.datetime.valid?(DateTime.now)
+        assert !Sample.datetime(:before => DateTime.now).valid?(DateTime.now)
+      end
+
+    end
+
     context "instance_of helper" do
 
       should "validate correctly" do
@@ -140,6 +170,63 @@ class ValidationHelpersTest < Test::Unit::TestCase
         assert !Sample.array(Validation.new { |d| d > 10 }).valid?([ 11, 0, 12, 23 ])
       end
     end
+
+    context "in_range? method" do
+
+      should "work with int" do
+        assert Sample.in_range?(1, 1)
+        assert !Sample.in_range?(1, 2)
+      end
+      
+      should "work with range" do
+        assert Sample.in_range?(1, 0..10)
+        assert !Sample.in_range?(20, 1..5)
+      end
+
+      should "work with min" do
+        assert Sample.in_range?(1, :min => 0 )
+        assert Sample.in_range?(0, :min => 0 )
+        assert !Sample.in_range?(-1, :min => 0 )
+      end
+
+      should "work with max" do
+        assert Sample.in_range?(-1, :max => 0 )
+        assert Sample.in_range?(0, :max => 0 )
+        assert !Sample.in_range?(1, :max => 0 )
+      end
+
+      should "work with before" do
+        assert Sample.in_range?(1, :before => 2 )
+        assert !Sample.in_range?(2, :before => 2 )
+      end
+
+      should "work with after" do
+        assert Sample.in_range?(3, :after => 2 )
+        assert !Sample.in_range?(2, :after => 2 )
+      end
+
+      should "work with less_than" do
+        assert Sample.in_range?(1, :less_than => 2 )
+        assert !Sample.in_range?(2, :less_than => 2 )
+      end
+
+      should "work with greater_than" do
+        assert Sample.in_range?(3, :greater_than => 2 )
+        assert !Sample.in_range?(2, :greater_than => 2 )
+      end
+
+      should "work with greater_than_or_equal_to" do
+        assert Sample.in_range?(1, :greater_than_or_equal_to => 0 )
+        assert Sample.in_range?(0, :greater_than_or_equal_to => 0 )
+        assert !Sample.in_range?(-1, :greater_than_or_equal_to => 0 )
+      end
+
+      should "work with less_than_or_equal_to" do
+        assert Sample.in_range?(-1, :less_than_or_equal_to => 0 )
+        assert Sample.in_range?(0, :less_than_or_equal_to => 0 )
+        assert !Sample.in_range?(1, :less_than_or_equal_to => 0 )
+      end
+    end
     
   end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Starr Horne
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-06 00:00:00 -05:00
+date: 2010-06-07 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,7 @@ files:
 - lib/deeply_valid/validation_helpers.rb
 - test/base_test.rb
 - test/helper.rb
+- test/system_test.rb
 - test/validation_helpers_test.rb
 - test/validation_test.rb
 has_rdoc: true
@@ -87,5 +88,6 @@ summary: Validation for complex data structures
 test_files: 
 - test/base_test.rb
 - test/helper.rb
+- test/system_test.rb
 - test/validation_helpers_test.rb
 - test/validation_test.rb