sanatio 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0519a019706d7b884adb4aadb461e572bb966395
-  data.tar.gz: c92a11cf8416f2209bdabbbcb0c1d9b13a85ec5b
+  metadata.gz: 699ced36fd16610bf36b5aff22c232db0964db66
+  data.tar.gz: 168e872cca8ec73fd08adacb070fd49b205f7997
 SHA512:
-  metadata.gz: 873be4fe9aa533a5c879b5b2fa94d4b95b501bf27e94fcc64fad2bd4b4ff400493c4d940eb4a40e457407f44d5565928f4165ae7bd4031d6cd069bd50535545a
-  data.tar.gz: 85fb148a1ea81e9f23e1b8d7d67a8f3c177701aebca7ad20c7d98c27e1730f96c6d8accc02274dca8c49ed282f7ece2d09ef4fe4136706ed1694bfb4269368c6
+  metadata.gz: 9c4cf10bcaadea803a7119c61abb46531537d985287ecaf095a07a227617d0a9a49ed19ec991682a922248f794784f3aba149864d8b4e8b911f801fcf56a5562
+  data.tar.gz: d539982a01572c22dd55cab8cfbe868fee89af3fc0f44eaf485c47cd9dfde574fcad4f9963361b191ec847828cf7b52ffc1711e8b66301828f85ac42a4567530

data/README.md

@@ -93,6 +93,118 @@ Person.new(nil).valid? # true
 Person.new("").valid? # false
 ```
 
+### Built-in validations
+
+#### Present
+
+This validation fails when the value is not present. Or empty when appropriate.
+
+```ruby
+class Person
+  include Sanatio
+
+  def initialize(name)
+    @name = name
+  end
+
+  attr_reader :name
+
+  ensure_that(:name).is Present
+end
+
+Person.new(nil).valid? #false
+Person.new("").valid? #false
+Person.new("Test Testington").valid? #true
+```
+
+#### GreaterThanOrEqualTo
+
+This validation fails when the value is smaller than a given value.
+
+```ruby
+class Person
+  include Sanatio
+
+  def initialize(age)
+    @age = age
+  end
+
+  attr_reader :age
+
+  ensure_that(:age).is GreaterThanOrEqualTo, 18
+endO
+
+Person.new(nil).valid? #true, validation is skipped
+Person.new(15).valid? #false
+Person.new(18).valid? #true
+```
+
+#### GreaterThan
+
+This validation fails when the value is smaller than or equal a given value.
+
+```ruby
+class Person
+  include Sanatio
+
+  def initialize(age)
+    @age = age
+  end
+
+  attr_reader :age
+
+  ensure_that(:age).is GreaterThan, 18
+endO
+
+Person.new(nil).valid? #true, validation is skipped
+Person.new(15).valid? #false
+Person.new(19).valid? #true
+```
+
+#### LessThanOrEqualTo
+
+This validation fails when the value is greater than a given value.
+
+```ruby
+class Person
+  include Sanatio
+
+  def initialize(age)
+    @age = age
+  end
+
+  attr_reader :age
+
+  ensure_that(:age).is LessThanOrEqualTo, 18
+endO
+
+Person.new(nil).valid? #true, validation is skipped
+Person.new(15).valid? #true
+Person.new(19).valid? #false
+```
+
+#### LessThan
+
+This validation fails when the value is greater than or equal to a given value.
+
+```ruby
+class Person
+  include Sanatio
+
+  def initialize(age)
+    @age = age
+  end
+
+  attr_reader :age
+
+  ensure_that(:age).is LessThan, 18
+endO
+
+Person.new(nil).valid? #true, validation is skipped
+Person.new(15).valid? #true
+Person.new(19).valid? #false
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/sanatio.rb

@@ -1,11 +1,12 @@
 require "sanatio/version"
-require "sanatio/error"
-require "sanatio/validator_factory"
+require "sanatio/class_validator"
+require "sanatio/field_validator"
+require "sanatio/built-in"
 
 module Sanatio
   module ClassMethods
     def ensure_that(target)
-      ValidatorFactory.create(target).tap do |validator|
+      create(target).tap do |validator|
         validators << validator
       end
     end
@@ -13,6 +14,15 @@ module Sanatio
     def validators
       @validation ||= []
     end
+
+    private
+    def create(target)
+      if target.instance_of? Class
+        ClassValidator.new
+      else
+        FieldValidator.new(target)
+      end
+    end
   end
 
   module InstanceMethods
@@ -25,12 +35,14 @@ module Sanatio
         validator.skip?(self)
       end.reject do |validator|
         validator.valid?(self)
-      end.map(&Error.method(:new))
+      end.map(&:error)
     end
   end
 
   def self.included(other)
     other.send(:include, InstanceMethods)
     other.send(:extend, ClassMethods)
+
+    other.send(:include, Sanatio::BuiltIn)
   end
 end

data/lib/sanatio/block_validator.rb

@@ -1,13 +1,18 @@
+require 'sanatio/skippable'
+
 module Sanatio
-  module BlockValidator
-    def is(&validation_block)
-      raise UsageError.new("You need to give a block to #is.") unless block_given?
+  class BlockValidator
+    include Skippable
+
+    attr_accessor :reason
+
+    def initialize(validation_block)
       @validation_block = validation_block
-      self
     end
 
     def valid?(object)
-      evaluate(object, @validation_block)
+      object.instance_eval(&@validation_block)
     end
   end
 end
+

data/lib/sanatio/built-in.rb

@@ -0,0 +1,5 @@
+require 'sanatio/built-in/present'
+require 'sanatio/built-in/greater_than_or_equal_to'
+require 'sanatio/built-in/greater_than'
+require 'sanatio/built-in/less_than_or_equal_to'
+require 'sanatio/built-in/less_than'

data/lib/sanatio/built-in/greater_than.rb

@@ -0,0 +1,25 @@
+module Sanatio
+  module BuiltIn
+    class GreaterThan
+      def initialize(value)
+        @value = value
+      end
+
+      def skip?(object)
+        !object.respond_to?(:>)
+      end
+
+      def valid?(object)
+        object > @value
+      end
+
+      def reason
+        :less_than_or_equal_to
+      end
+
+      def params
+        [@value]
+      end
+    end
+  end
+end

data/lib/sanatio/built-in/greater_than_or_equal_to.rb

@@ -0,0 +1,25 @@
+module Sanatio
+  module BuiltIn
+    class GreaterThanOrEqualTo
+      def initialize(value)
+        @value = value
+      end
+
+      def skip?(object)
+        !object.respond_to?(:>=)
+      end
+
+      def valid?(object)
+        object >= @value
+      end
+
+      def reason
+        :less_than
+      end
+
+      def params
+        [@value]
+      end
+    end
+  end
+end

data/lib/sanatio/built-in/less_than.rb

@@ -0,0 +1,25 @@
+module Sanatio
+  module BuiltIn
+    class LessThan
+      def initialize(value)
+        @value = value
+      end
+
+      def skip?(object)
+        !object.respond_to?(:<)
+      end
+
+      def valid?(object)
+        object < @value
+      end
+
+      def reason
+        :greater_than_or_equal_to
+      end
+
+      def params
+        [@value]
+      end
+    end
+  end
+end

data/lib/sanatio/built-in/less_than_or_equal_to.rb

@@ -0,0 +1,25 @@
+module Sanatio
+  module BuiltIn
+    class LessThanOrEqualTo
+      def initialize(value)
+        @value = value
+      end
+
+      def skip?(object)
+        !object.respond_to?(:<=)
+      end
+
+      def valid?(object)
+        object <= @value
+      end
+
+      def reason
+        :greater_than
+      end
+
+      def params
+        [@value]
+      end
+    end
+  end
+end

data/lib/sanatio/built-in/present.rb

@@ -0,0 +1,16 @@
+module Sanatio
+  module BuiltIn
+    class Present
+      def skip?(_)
+      end
+
+      def valid?(object)
+        !object.nil? && (!object.respond_to?(:empty?) || !object.empty?)
+      end
+
+      def reason
+        :not_present
+      end
+    end
+  end
+end

data/lib/sanatio/class_validator.rb

@@ -1,17 +1,30 @@
-require 'sanatio/usage_error'
-require 'sanatio/skippable'
-require 'sanatio/block_validator'
+require 'sanatio/validator_factory'
 
 module Sanatio
   class ClassValidator
-    include Skippable
-    include BlockValidator
+    include ValidatorFactory
 
-    attr_accessor :reason
+    Error = Struct.new(:reason, :params)
+
+    def valid?(object)
+      @validator.valid?(object)
+    end
+
+    def skip?(object)
+      @validator.skip?(object)
+    end
+
+    def error
+      Error.new(@validator.reason, params)
+    end
 
     private
-    def evaluate(object, block)
-      object.instance_eval(&block)
+    def params
+      if @validator.respond_to?(:params)
+        @validator.params
+      else
+        []
+      end
     end
   end
 end

data/lib/sanatio/field_validator.rb

@@ -1,22 +1,34 @@
-require 'sanatio/usage_error'
-require 'sanatio/skippable'
-require 'sanatio/block_validator'
+require 'sanatio/validator_factory'
 
 module Sanatio
   class FieldValidator
-    include Skippable
-    include BlockValidator
+    include ValidatorFactory
 
-    attr_reader :field
-    attr_accessor :reason
+    Error = Struct.new(:field, :reason, :params)
 
     def initialize(field)
       @field = field
     end
 
+    def valid?(object)
+      @validator.valid?(object.send(@field))
+    end
+
+    def skip?(object)
+      @validator.skip?(object.send(@field))
+    end
+
+    def error
+      Error.new(@field, @validator.reason, params)
+    end
+
     private
-    def evaluate(object, test)
-      object.send(@field).instance_eval &test
+    def params
+      if @validator.respond_to?(:params)
+        @validator.params
+      else
+        []
+      end
     end
   end
 end

data/lib/sanatio/skippable.rb

@@ -13,7 +13,7 @@ module Sanatio
     end
 
     def skip?(object)
-      evaluate(object, skip_test)
+      object.instance_eval(&skip_test)
     end
   end
 end

data/lib/sanatio/validator_factory.rb

@@ -1,13 +1,14 @@
-require "sanatio/field_validator"
-require "sanatio/class_validator"
+require 'sanatio/block_validator'
+require 'sanatio/usage_error'
 
 module Sanatio
   module ValidatorFactory
-    def self.create(target)
-      if target.instance_of? Class
-        ClassValidator.new
+    def is(validator = nil, *params, &validation_block)
+      if validator
+        @validator = validator.new(*params)
       else
-        FieldValidator.new(target)
+        raise UsageError.new("You need to give a block to #is.") unless block_given?
+        @validator = BlockValidator.new(validation_block)
       end
     end
   end

data/lib/sanatio/version.rb

@@ -1,3 +1,3 @@
 module Sanatio
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanatio
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Thijs Wouters
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-12 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,8 +71,13 @@ files:
 - bin/setup
 - lib/sanatio.rb
 - lib/sanatio/block_validator.rb
+- lib/sanatio/built-in.rb
+- lib/sanatio/built-in/greater_than.rb
+- lib/sanatio/built-in/greater_than_or_equal_to.rb
+- lib/sanatio/built-in/less_than.rb
+- lib/sanatio/built-in/less_than_or_equal_to.rb
+- lib/sanatio/built-in/present.rb
 - lib/sanatio/class_validator.rb
-- lib/sanatio/error.rb
 - lib/sanatio/field_validator.rb
 - lib/sanatio/skippable.rb
 - lib/sanatio/usage_error.rb

data/lib/sanatio/error.rb

@@ -1,13 +0,0 @@
-require 'forwardable'
-
-module Sanatio
-  class Error
-    extend Forwardable
-
-    def_delegators :@validation, :field, :reason
-
-    def initialize(validation)
-      @validation = validation
-    end
-  end
-end