simple_validation 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+simple_validation-*.gem

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+v0.0.1
+------
+
+* Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) <2011> <Chirantan Mitra>
+
+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,72 @@
+Overview
+--------
+
+This is very simple gem to allow custom validations in a ruby object. You are supposed to define your validations.
+
+Dependencies
+------------
+
+These are no dependencies for this gem. You need minitest to run the tests for this gem.
+
+Installation
+------------
+
+``` script
+gem install simple_validation
+```
+
+Usage
+------
+
+``` ruby
+require "simple_validation"
+
+class AlienNumber
+  include SimpleValidation
+
+  validate :digits_are_positive
+  validate :digits_are_less_than_ten
+
+  def initialize(*digits)
+    @digits = digits
+  end
+
+  def value
+	@digits.reduce(1) {|result, digit| result + digit}
+  end
+
+  private
+
+  def digits_are_positive
+	@digits.each do |digit|
+	  add_error("#{digit} is negative") unless digit > 0
+	end
+  end
+
+  def digits_are_less_than_ten
+	@digits.each do |digit|
+	  add_error("#{digit} is greater than 9") unless digit < 10
+	end
+  end
+end
+
+valid_number = AlienNumber.new(1, 2, 3)
+valid_number.valid? # true
+valid_number.invalid? # false
+valid_number.errors # []
+
+invalid_number = AlienNumber.new(-1, 12)
+invalid_number.valid? # false
+invalid_number.invalid? # true
+invalid_number.errors # ["-1 is negative", "12 is greater than 9"]
+```
+
+Running tests
+-------------
+
+Clone the repository and run the following 'rake' from the repository.
+
+License
+-------
+
+This tool is released under the MIT license. Please refer to LICENSE for more details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task :default => :test

data/lib/simple_validation/version.rb

@@ -0,0 +1,3 @@
+module SimpleValidation
+  VERSION = "0.1.0"
+end

data/lib/simple_validation.rb

@@ -0,0 +1,41 @@
+module SimpleValidation
+  def self.included(base)
+    base.class_eval do
+      base.extend SimpleValidation::ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def validate(method_name)
+      validation_methods << method_name
+    end
+
+    def validation_methods
+      @validation_methods ||= []
+    end
+  end
+
+  def valid?
+    self.class.validation_methods.each do |method_name|
+      send method_name
+    end
+
+    errors.empty?
+  end
+
+  def invalid?
+    not valid?
+  end
+
+  def add_error(error)
+    errors << error unless errors.include?(error)
+  end
+
+  def add_errors(more_errors)
+    errors.concat(more_errors)
+  end
+
+  def errors
+    @errors ||= []
+  end
+end

data/simple_validation.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+
+require "simple_validation/version"
+
+Gem::Specification.new do |s|
+  s.name                     = "simple_validation"
+  s.version                  = SimpleValidation::VERSION
+  s.authors                  = ["Chirantan Mitra"]
+  s.email                    = ["chirantan.mitra@gmail.com"]
+  s.homepage                 = "https://github.com/chiku/simple_validation"
+  s.summary                  = "Validations for a ruby object"
+  s.description              = <<-EOS
+A simple way to validate custom ruby objects using validation defined in the class.
+EOS
+  s.rubyforge_project        = "simple_validation"
+  s.files                    = `git ls-files`.split("\n")
+  s.test_files               = `git ls-files -- {test}/*`.split("\n")
+  s.executables              = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths            = ["lib"]
+
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "minitest"
+end

data/spec/simple_validation_spec.rb

@@ -0,0 +1,119 @@
+require_relative "spec_helper"
+
+require_relative "../lib/simple_validation"
+
+class TestEntity
+  include SimpleValidation
+end
+
+class TestEntityWithValidation
+  include SimpleValidation
+
+  attr_reader :always_valid_invoked
+  attr_reader :always_invalid_invoked
+
+  validate :always_valid
+  validate :always_invalid
+
+  def initialize
+    @always_valid_invoked = false
+    @always_invalid_invoked = false
+  end
+
+  def always_valid
+    @always_valid_invoked = true
+  end
+
+  def always_invalid
+    @always_invalid_invoked = true
+    add_error "Always invalid"
+  end
+end
+
+describe "An entity that can be validated" do
+  describe "when it has errors" do
+    before do
+      @entity = TestEntity.new
+      @entity.add_error("An error")
+    end
+
+    it "is invalid" do
+      @entity.invalid?.must_equal true
+    end
+
+    it "is not valid" do
+      @entity.valid?.must_equal false
+    end
+
+    it "exposes its errors" do
+      @entity.errors.must_equal ["An error"]
+    end
+
+    it "allows custom validation" do
+      @entity.errors.must_equal ["An error"]
+    end
+  end
+
+  describe "when it doesn't have any error" do
+    before do
+      @entity = TestEntity.new
+    end
+
+    it "is not invalid" do
+      @entity.invalid?.must_equal false
+    end
+
+    it "is valid" do
+      @entity.valid?.must_equal true
+    end
+
+    it "exposes its errors as an empty array" do
+      @entity.errors.must_equal []
+    end
+  end
+
+  describe "when it has a custom validation" do
+    before do
+      @entity = TestEntityWithValidation.new
+    end
+
+    describe "on validation" do
+      before do
+        @entity.valid?
+      end
+
+      it "invokes the validations" do
+        @entity.always_valid_invoked.must_equal true
+        @entity.always_invalid_invoked.must_equal true
+      end
+
+      it "has errors added during validation" do
+        @entity.errors.must_equal ["Always invalid"]
+      end
+    end
+
+    describe "with already existing errors" do
+      it "doesn't lose its older errors on validation" do
+        @entity = TestEntityWithValidation.new
+        @entity.add_errors(["An error", "Another error"])
+        @entity.valid?
+        @entity.errors.must_equal ["An error", "Another error", "Always invalid"]
+      end
+    end
+
+    describe "when double validated" do
+      it "doesn't duplicate its errors" do
+        @entity = TestEntityWithValidation.new
+        @entity.valid?
+        @entity.valid?
+        @entity.errors.must_equal ["Always invalid"]
+      end
+    end
+  end
+
+  it "can be added an array of errors" do
+    @entity = TestEntity.new
+    @entity.add_errors(["An error", "Another error"])
+    @entity.errors.must_equal ["An error", "Another error"]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "minitest/autorun"
+require "minitest/spec"

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: simple_validation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Chirantan Mitra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'A simple way to validate custom ruby objects using validation defined
+  in the class.
+
+'
+email:
+- chirantan.mitra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  Q0hBTkdFTE9HLm1k
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  TElDRU5TRQ==
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  bGliL3NpbXBsZV92YWxpZGF0aW9uLnJi
+- !binary |-
+  bGliL3NpbXBsZV92YWxpZGF0aW9uL3ZlcnNpb24ucmI=
+- !binary |-
+  c2ltcGxlX3ZhbGlkYXRpb24uZ2Vtc3BlYw==
+- !binary |-
+  c3BlYy9zaW1wbGVfdmFsaWRhdGlvbl9zcGVjLnJi
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==
+homepage: https://github.com/chiku/simple_validation
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: simple_validation
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Validations for a ruby object
+test_files: []