validus 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/README.md

@@ -0,0 +1,88 @@
+# Validus
+
+Add validation support to Plain Old Ruby Objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'validus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validus
+
+## Usage
+
+Include this module in a target class and override the `validate` method. Use
+`valid?` to perform the validation.
+
+Example:
+
+    require "validus"
+
+    class Person
+      include Validus
+
+      attr_accessor :name, :age
+
+      def initialize
+        @name = ''
+        @age  = 0
+      end
+
+      def validate
+        errors.add(:name, 'cannot be blank') if name == ''
+        errors.add(:age, 'must be greater than 0') if age <= 0
+      end
+    end
+
+    person = Person.new
+    person.valid?                    # => false
+    person.errors.for(:name).to_a    # => ['cannot be blank']
+    person.errors.full_messages.to_a # => ['name cannot be blank', 'age must be greater than 0']
+
+    person.name = 'John'
+    person.age  = 20
+
+    person.valid?        # => true
+    person.errors.empty? # => true
+
+See [documentation](http://www.rubydoc.info/github/bnadlerjr/validus/frames) for more details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2012 Bob Nadler
+
+MIT License
+
+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,56 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
+require "flay_task"
+require "flog"
+
+DEFAULT_TASKS    = %w[test flog flay]
+MAIN_RDOC        = 'README.md'
+EXTRA_RDOC_FILES = [MAIN_RDOC]
+LIB_FILES        = Dir["lib/**/*.rb"]
+TEST_FILES       = Dir["test/**/*_test.rb"]
+TITLE            = 'Validus'
+
+# Import external rake tasks
+Dir.glob('tasks/*.rake').each { |r| import r }
+
+desc "Default tasks: #{DEFAULT_TASKS.join(', ')}"
+task :default => DEFAULT_TASKS
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = TEST_FILES
+end
+
+RDoc::Task.new do |t|
+  t.main = MAIN_RDOC
+  t.rdoc_dir = 'doc'
+  t.rdoc_files.include(EXTRA_RDOC_FILES, LIB_FILES)
+  t.options << '-q'
+  t.title = TITLE
+end
+
+FlayTask.new do |t|
+  t.dirs = %w[lib]
+end
+
+task :flog do
+  flog = Flog.new
+  flog.flog ['lib']
+  threshold = 50
+
+  bad_methods = flog.totals.select do |name, score|
+    score > threshold
+  end
+
+  bad_methods.sort do |a, b|
+    a[1] <=> b[1]
+  end.each do |name, score|
+    puts "%8.1f: %s" % [score, name]
+  end
+
+  unless bad_methods.empty?
+    raise "#{bad_methods.size} methods have a flog complexity > #{threshold}"
+  end
+end

data/lib/validus.rb

@@ -0,0 +1,62 @@
+require "validus/version"
+require "validus/errors"
+
+# Add validation support to Plain Old Ruby Objects. Include this module in a
+# target class and override the +validate+ method. Use +#valid?+ to perform
+# the validation.
+#
+# Example:
+#
+#   require "validus"
+#
+#   class Person
+#     include Validus
+#
+#     attr_accessor :name, :age
+#
+#     def initialize
+#       @name = ''
+#       @age  = 0
+#     end
+#
+#     def validate
+#       errors.add(:name, 'cannot be blank') if name == ''
+#       errors.add(:age, 'must be greater than 0') if age <= 0
+#     end
+#   end
+#
+#   person = Person.new
+#   person.valid?                    # => false
+#   person.errors.for(:name).to_a    # => ['cannot be blank']
+#   person.errors.full_messages.to_a # => ['name cannot be blank', 'age must be greater than 0']
+#
+#   person.name = 'John'
+#   person.age  = 20
+#
+#   person.valid?        # => true
+#   person.errors.empty? # => true
+module Validus
+  # Abstract method that performs validation. Override this method in the
+  # target class. Overriding methods should use +errors#add+ to add
+  # validation errors. For example:
+  #
+  #   def validate
+  #     errors.add(:name, 'cannot be blank') if name.blank?
+  #   end
+  #
+  # This method is not meant to be called directly... use +#valid?+ instead.
+  def validate
+  end
+
+  # Calls +validate+ and returns +true+ if there are any +errors+ on the target's attributes.
+  def valid?
+    errors.clear
+    validate
+    errors.empty?
+  end
+
+  # An instance of an +Errors+ object.
+  def errors
+    @errors ||= Errors.new
+  end
+end

data/lib/validus/errors.rb

@@ -0,0 +1,35 @@
+module Validus
+  # Represents a collection of errors.
+  class Errors
+    def initialize
+      @errors = Hash.new { |hash, key| hash[key] = [] }
+    end
+
+    # Add an error +message+ for an +attribute+.
+    def add(attribute, message)
+      @errors[attribute] << message
+    end
+
+    def empty?
+      @errors.empty?
+    end
+
+    def clear
+      @errors.clear
+    end
+
+    # Returns an Enumerator consisting of all errors associated
+    # with +attribute+.
+    def for(attribute)
+      @errors[attribute].to_enum
+    end
+
+    # Returns an Enumerator consisting of all errors for all attributes. The
+    # name of the attribute is pre-pended to the error message.
+    def full_messages
+      @errors.map do |k, v|
+        v.map { |error| "#{k} #{error}"}
+      end.flatten.to_enum
+    end
+  end
+end

data/lib/validus/version.rb

@@ -0,0 +1,3 @@
+module Validus
+  VERSION = "0.0.1"
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "test/unit"
+require "contest"
+require "minitest/reporters"
+MiniTest::Reporters.use!

data/test/validus/errors_test.rb

@@ -0,0 +1,50 @@
+require_relative "../test_helper"
+require_relative "../../lib/validus/errors"
+
+module Validus
+  class ErrorsTest < Test::Unit::TestCase
+    setup do
+      @errors = Errors.new
+    end
+
+    test "add an error" do
+      @errors.add(:name, "cannot be empty")
+      refute(@errors.empty?, "did not expect errors to be empty")
+    end
+
+    test "can clear errors" do
+      @errors.add(:name, "cannot be empty")
+      refute(@errors.empty?, "did not expect errors to be empty")
+
+      @errors.clear
+      assert(@errors.empty?, "expected errors to be empty")
+    end
+
+    test "can get errors for a particular attribute" do
+      @errors.add(:name, "cannot be empty")
+      assert_equal(['cannot be empty'], @errors.for(:name).to_a)
+    end
+
+    test "add multiple errors for a single attribute" do
+      @errors.add(:name, "cannot be empty")
+      @errors.add(:name, "must be 10 characters")
+
+      expected = ['cannot be empty', 'must be 10 characters']
+      assert_equal(expected, @errors.for(:name).to_a)
+    end
+
+    test "can get full error messages" do
+      @errors.add(:name, "cannot be empty")
+      @errors.add(:name, "must be 10 characters")
+      @errors.add(:age, "must be greater than zero")
+
+      expected = [
+        'name cannot be empty',
+        'name must be 10 characters',
+        'age must be greater than zero'
+      ]
+
+      assert_equal(expected, @errors.full_messages.to_a)
+    end
+  end
+end

data/test/validus_test.rb

@@ -0,0 +1,84 @@
+require_relative "test_helper"
+require_relative "../lib/validus"
+
+class ValidusTest < Test::Unit::TestCase
+  BlankTarget = Class.new do
+    include Validus
+  end
+
+  TargetWithAutoError = Class.new do
+    include Validus
+
+    def validate
+      errors.add(:name, 'cannot be empty')
+    end
+  end
+
+  test "valid? returns true if there are no errors" do
+    assert(BlankTarget.new.valid?, "expected valid? to be true")
+  end
+
+  test "#errors is empty if target is valid" do
+    assert(BlankTarget.new.errors.empty?, "expected errors to be empty")
+  end
+
+  test "valid? returns false if there are any errors" do
+    refute(TargetWithAutoError.new.valid?, "expected valid? to be false")
+  end
+
+  test "valid? clears out any existing errors before validating" do
+    Target = Class.new do
+      include Validus
+
+      attr_accessor :name
+
+      def initialize
+        @name = ''
+      end
+
+      def validate
+        errors.add(:name, 'cannot be blank') if name == ''
+      end
+    end
+
+    target = Target.new
+    refute(target.valid?, "expected target to be invalid")
+
+    target.name = 'John'
+    assert(target.valid?, "expected target to be valid")
+  end
+
+
+  test "end to end" do
+    Person = Class.new do
+      include Validus
+
+      attr_accessor :name, :age
+
+      def initialize
+        @name = ''
+        @age  = 0
+      end
+
+      def validate
+        errors.add(:name, 'cannot be blank') if name == ''
+        errors.add(:age, 'must be greater than 0') if age <= 0
+      end
+    end
+
+    person = Person.new
+
+    refute(person.valid?, "expected person to be invalid")
+    assert_equal(['cannot be blank'], person.errors.for(:name).to_a)
+    assert_equal(
+      ['name cannot be blank', 'age must be greater than 0'],
+      person.errors.full_messages.to_a
+    )
+
+    person.name = 'John'
+    person.age  = 20
+
+    assert(person.valid?, "expected person to be valid")
+    assert(person.errors.empty?, "expected errors to be empty")
+  end
+end

data/validus.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/validus/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bob Nadler, Jr."]
+  gem.email         = ["bnadlerjr@gmail.com"]
+  gem.description   = %q{Valdations for Plain Old Ruby Objects.}
+  gem.summary       = %q{Valdations for Plain Old Ruby Objects.}
+  gem.homepage      = "https://github.com/bnadlerjr/validus"
+  gem.has_rdoc      = true
+  gem.license       = 'MIT'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "validus"
+  gem.require_paths = ["lib"]
+  gem.version       = Validus::VERSION
+
+  gem.add_development_dependency "contest",            "~> 0.1.3"
+  gem.add_development_dependency "flay",               "~> 1.4.3"
+  gem.add_development_dependency "flog",               "~> 2.5.3"
+  gem.add_development_dependency "minitest-reporters", "~> 0.9.0"
+  gem.add_development_dependency "rake",               "~> 0.9.2.2"
+  gem.add_development_dependency "rdoc",               "~> 3.12"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: validus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bob Nadler, Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contest
+  requirement: &70301779203040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: *70301779203040
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: &70301779202220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :development
+  prerelease: false
+  version_requirements: *70301779202220
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: &70301779201560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+  type: :development
+  prerelease: false
+  version_requirements: *70301779201560
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: &70301779200600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70301779200600
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70301779216480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70301779216480
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70301779215980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70301779215980
+description: Valdations for Plain Old Ruby Objects.
+email:
+- bnadlerjr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/validus.rb
+- lib/validus/errors.rb
+- lib/validus/version.rb
+- test/test_helper.rb
+- test/validus/errors_test.rb
+- test/validus_test.rb
+- validus.gemspec
+homepage: https://github.com/bnadlerjr/validus
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1860856656352002206
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1860856656352002206
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Valdations for Plain Old Ruby Objects.
+test_files:
+- test/test_helper.rb
+- test/validus/errors_test.rb
+- test/validus_test.rb