standalone_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bca879be6bf42bd2a02eae2221a168206782348c
+  data.tar.gz: a82ee314d96bf3d10b3dbc16538de68d6311fbbe
+SHA512:
+  metadata.gz: 1eb6e22ab8bd654da4d87a0917b52d1ffa25a4ae81bf9e6ab30dc9c07460bd8a7de3022f4dc7a74ecee7c3259b69e75284009fe27c3cdfec07e45a88f57ba9cf
+  data.tar.gz: 97822fabfa6deb523853f135df9ce830b2b05b3f785a524e6f0f3fc02a1dce48df91353037d38711d5e94bf2519b321fe8b0991cdcb7015b182ec6a73e75c6c6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "jruby-19mode"
+  - "rbx-19mode"
+bundler_args: --binstubs --without debugging
+before_install:
+  - gem install bundler
+script: bin/rspec

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in standalone_validator.gemspec
+gemspec
+
+group :debugging do
+  gem "pry"
+  gem "pry-doc"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Renato Zannon
+
+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/README.md

@@ -0,0 +1,69 @@
+# StandaloneValidator
+[![Build Status](https://secure.travis-ci.org/riccieri/standalone_validator.png)](http://travis-ci.org/riccieri/standalone_validator)
+
+A library for creating PORO validators that are composable and can be used with ActiveRecord or standalone.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'standalone_validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install standalone_validator
+
+## Usage
+
+```ruby
+require 'standalone_validator'
+
+class NameLengthValidator < StandaloneValidator
+  def initialize(min_length, attribute_name = :name)
+    @min_length = min_length
+    @attribute_name = attribute_name
+  end
+
+  include_validation do |object, result|
+    if object.send(attribute_name).length < @min_length
+      result.add_violation(attribute_name, 'should be bigger')
+    end
+  end
+
+private
+
+  attr_reader :attribute_name
+end
+
+class AllNamesValidator < StandaloneValidator
+  include_validation NameLengthValidator, 5
+  include_validation NameLengthValidator, 4, :last_name
+end
+
+
+Person = Struct.new(:name, :last_name)
+validator = AllNamesValidator.new
+
+person = Person.new("Renato", "Zannon")
+puts validator.violations_of(person).any? # false
+
+other_person = Person.new("Renato", "Foo")
+puts validator.violations_of(other_person).any? # true
+
+validator.violations_of(other_person).each do |violation|
+  puts violation.attribute.inspect # :last_name
+  puts violation.message.inspect   # "should be bigger"
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/standalone_validator.rb

@@ -0,0 +1,75 @@
+require 'backports'
+require 'hamster/set'
+
+require 'standalone_validator/version'
+
+require 'standalone_validator/definitions'
+require 'standalone_validator/validation_result_builder'
+
+class StandaloneValidator
+  class << self
+    Definitions.on_validation_registered do |name, validation|
+      define_method(name) do |*args, &block|
+        include_validation(validation, *args, &block)
+      end
+    end
+
+    def create(&block)
+      Class.new(StandaloneValidator, &block)
+    end
+
+    def register_as(name)
+      NamedValidations.create(name, self)
+    end
+
+    def validations
+      return @validations if defined?(@validations)
+
+      if superclass.kind_of?(StandaloneValidator)
+        @validations = superclass.validations
+      else
+        @validations = Hamster.set
+      end
+    end
+
+  private
+
+    def include_validation(*args, &block)
+      validation = Definitions.coerce_to_validation(*args, &block)
+      @validations = validations.add(validation)
+    end
+  end
+
+  require 'standalone_validator/named_validations'
+
+  def violations_of(object)
+    builder = ValidationResultBuilder.new
+    builder.validated_object = object
+
+    validations.each do |validation|
+      if validation.respond_to?(:to_proc)
+        result = instance_exec(object, &validation)
+      else
+        result = validation.call(object)
+      end
+
+      builder.merge_result(result)
+    end
+
+    builder.result
+  end
+
+  alias_method :call, :violations_of
+
+  def add_errors_to(object)
+    validation_result = violations_of(object)
+    validation_result.add_errors_to(object.errors)
+    validation_result
+  end
+
+private
+
+  def validations
+    self.class.validations
+  end
+end

data/lib/standalone_validator/definitions.rb

@@ -0,0 +1,58 @@
+require 'hamster/hash'
+require 'hamster/vector'
+
+class StandaloneValidator
+  class ValidationNotFoundException < Exception
+    def initialize(validation_name)
+      super("No such validation: #{validation_name.inspect}")
+    end
+  end
+
+  module Definitions
+    module_function
+
+    def register_validation_factory(name, validation_factory)
+      @registry = registry.put(name.to_sym, validation_factory)
+      listeners.each do |listener|
+        listener.call(name, validation_factory)
+      end
+      self
+    end
+
+    def lookup_validation_factory(name)
+      registry[name.to_sym]
+    end
+
+    def on_validation_registered(callable = nil, &block)
+      if block_given?
+        @listeners = listeners.add(block)
+      else
+        @listeners = listeners.add(block)
+      end
+
+      self
+    end
+
+    def coerce_to_validation(validation_or_validation_class = nil, *args, &block)
+      if validation_or_validation_class.respond_to?(:new)
+        validation_or_validation_class.new(*args, &block)
+      elsif validation_or_validation_class.nil? && block_given?
+        lambda { |object|
+          ValidationResult.build_for(object) do |result|
+            instance_exec(object, result, &block)
+          end
+        }
+      else
+        validation_or_validation_class
+      end
+    end
+
+    def registry
+      @registry ||= Hamster.hash
+    end
+
+    def listeners
+      @listeners ||= Hamster.vector
+    end
+  end
+end

data/lib/standalone_validator/named_validations.rb

@@ -0,0 +1,17 @@
+require 'standalone_validator'
+require 'standalone_validator/definitions'
+
+class StandaloneValidator
+  module NamedValidations
+    def self.create(name, klass)
+      Definitions.register_validation_factory(name, klass)
+    end
+  end
+end
+
+require 'pathname'
+validations = Pathname(__FILE__).parent + "named_validations" + "*.rb"
+
+Dir[validations].each do |validation_file|
+  require validation_file
+end

data/lib/standalone_validator/named_validations/common_rails_options.rb

@@ -0,0 +1,61 @@
+class StandaloneValidator
+  module NamedValidations
+    module CommonRailsOptions
+      def self.extract_options!(array)
+        if array.last.is_a?(Hash)
+          array.pop
+        else
+          {}
+        end
+      end
+
+      ALWAYS_TRUE = Proc.new { true }
+
+      def self.condition_for(options)
+        if options.has_key?(:if)
+          options[:if].to_proc
+        elsif options.has_key?(:unless)
+          reverse_condition = options[:unless].to_proc
+          Proc.new { |*args| not reverse_condition.call(*args) }
+        else
+          ALWAYS_TRUE
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def include_validation(&block)
+          super do |object, result|
+            condition = CommonRailsOptions.condition_for(options)
+
+            if condition.call(object)
+              instance_exec(object, result, &block)
+            end
+          end
+        end
+      end
+
+      def initialize(*names)
+        options = CommonRailsOptions.extract_options!(names)
+
+        @attributes = names
+        @options    = options
+      end
+
+    private
+      attr_reader :attributes, :options
+
+      def each_validated_attribute_on(object)
+        return to_enum(:each_validated_attribute, object) unless block_given?
+
+        attributes.each do |attribute_name|
+          value = object.send(attribute_name)
+          yield(attribute_name, value)
+        end
+      end
+    end
+  end
+end

data/lib/standalone_validator/named_validations/validates_presence_of.rb

@@ -0,0 +1,20 @@
+require 'standalone_validator'
+require_relative 'common_rails_options'
+
+class StandaloneValidator
+  module NamedValidations
+    class ValidatesPresenceOf < StandaloneValidator
+      register_as :validates_presence_of
+
+      include CommonRailsOptions
+
+      include_validation do |object, result|
+        each_validated_attribute_on(object) do |attribute_name, value|
+          if value.blank?
+            result.add_violation(attribute_name, :blank)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/standalone_validator/validation_result.rb

@@ -0,0 +1,54 @@
+require 'standalone_validator/validation_result_builder'
+require 'hamster/list'
+
+class StandaloneValidator
+  class ValidationResult
+    def self.build_for(object, &block)
+      builder = ValidationResultBuilder.new
+      builder.validated_object = object
+
+      if block.arity == 1
+        block.call(builder)
+      else
+        builder.instance_eval(&block)
+      end
+
+      builder.result
+    end
+
+    attr_reader :validated_object, :violations
+
+    def initialize(attributes)
+      @validated_object = attributes.fetch(:validated_object) { nil }
+
+      violations  = attributes.fetch(:violations) { Hamster::EmptyList }
+      @violations = violations.to_list
+    end
+
+    def add_errors_to(errors_object)
+      violations.each do |violation|
+        violation.add_to(errors_object)
+      end
+
+      self
+    end
+
+    OK = new({})
+
+    include Enumerable
+
+    def each(&block)
+      violations.each(&block)
+    end
+
+    def empty
+      violations.empty?
+    end
+
+    def ok?
+      violations.empty?
+    end
+
+    alias_method :valid?, :ok?
+  end
+end

data/lib/standalone_validator/validation_result_builder.rb

@@ -0,0 +1,57 @@
+require 'standalone_validator/validation_result'
+require 'standalone_validator/violation'
+
+class StandaloneValidator
+  class ValidationResultBuilder
+    attr_writer :validated_object
+
+    def merge_result(result)
+      combined_results << result
+      self
+    end
+
+    def add_violation(attribute_name, violation_type_or_message)
+      creation_attributes = {
+        :attribute     => attribute_name.to_sym,
+        :source_object => validated_object
+      }
+
+      if violation_type_or_message.kind_of?(Symbol)
+        creation_attributes[:type] = violation_type_or_message
+      else
+        creation_attributes[:message] = violation_type_or_message
+      end
+
+      push_violation(Violation.new(creation_attributes))
+      self
+    end
+
+    def result
+      ValidationResult.new(
+        :validated_object => validated_object,
+        :violations       => all_violations
+      )
+    end
+
+  private
+    attr_reader :validated_object
+
+    def all_violations
+      combined_results.inject(violations) do |violations_list, subresult|
+        violations_list.append(subresult.violations)
+      end
+    end
+
+    def combined_results
+      @combined_results ||= []
+    end
+
+    def push_violation(violation)
+      @violations = violations.cons(violation)
+    end
+
+    def violations
+      @violations ||= Hamster.list
+    end
+  end
+end

data/lib/standalone_validator/version.rb

@@ -0,0 +1,3 @@
+class StandaloneValidator
+  VERSION = "0.0.1"
+end

data/lib/standalone_validator/violation.rb

@@ -0,0 +1,17 @@
+require 'virtus'
+
+class StandaloneValidator
+  class Violation
+    include Virtus::ValueObject
+
+    attribute :source_object, Object
+    attribute :attribute,     Symbol, :default => :base
+    attribute :type,          Symbol, :default => :invalid
+    attribute :message,       String, :default => nil
+
+    def add_to(errors_object)
+      errors_object.add(attribute, message || type)
+      self
+    end
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'standalone_validator'
+
+describe "core features" do
+  let(:valid_object)   { stub(:valid? => true) }
+  let(:invalid_object) { stub(:valid? => false) }
+
+  it "accepts inline lambdas via 'include_validation'" do
+    validator_class = StandaloneValidator.create do
+      include_validation do |object, result|
+        unless object.valid?
+          result.add_violation(:base, "is invalid")
+        end
+      end
+    end
+
+    validator = validator_class.new
+
+    result = validator.violations_of(valid_object)
+    expect(result).to be_ok
+
+    result = validator.violations_of(invalid_object)
+    expect(result).to_not be_ok
+  end
+
+  specify "the methods added to the class are accessible inside the lambda" do
+    validator_class = StandaloneValidator.create do
+      include_validation do |object, result|
+        unless valid?(object)
+          result.add_violation(:base, "is invalid")
+        end
+      end
+
+      def valid?(object)
+        object.valid?
+      end
+    end
+
+    validator = validator_class.new
+
+    result = validator.violations_of(valid_object)
+    expect(result).to be_ok
+
+    result = validator.violations_of(invalid_object)
+    expect(result).to_not be_ok
+  end
+
+  specify "initialization options can be accepted by defining a constructor" do
+    validator_class = StandaloneValidator.create do
+      def initialize(bias)
+        @bias = bias
+      end
+
+      include_validation do |object, result|
+        unless @bias
+          result.add_violation(:base, "is invalid")
+        end
+      end
+    end
+
+    biased_validator = validator_class.new(true)
+    result = biased_validator.violations_of(invalid_object)
+    expect(result).to be_ok
+
+    biased_validator = validator_class.new(false)
+    result = biased_validator.violations_of(valid_object)
+    expect(result).to_not be_ok
+  end
+end

data/spec/named_validations/validates_presence_of_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+require "standalone_validator"
+
+module StandaloneValidator::NamedValidations
+  describe "validates_presence_of" do
+    let(:blank_value)     { stub(:blank? => true)  }
+    let(:non_blank_value) { stub(:blank? => false) }
+
+    it "adds a 'blank' violation if the attribute is blank" do
+      validator = ValidatesPresenceOf.new(:foo)
+      result = validator.violations_of(stub(:foo => blank_value))
+      expect(result).to_not be_ok
+    end
+
+    it "doesn't add the violation if the attribute isn't blank" do
+      validator = ValidatesPresenceOf.new(:foo)
+      result = validator.violations_of(stub(:foo => non_blank_value))
+      expect(result).to be_ok
+    end
+
+    it "accepts an :if condition that can block the validation" do
+      validator = ValidatesPresenceOf.new :foo, :if => :bar
+
+      triggers       = stub(:foo => blank_value, :bar => true)
+      doesnt_trigger = stub(:foo => blank_value, :bar => false)
+
+      result = validator.violations_of(triggers)
+      expect(result).to_not be_ok
+
+      result = validator.violations_of(doesnt_trigger)
+      expect(result).to be_ok
+    end
+
+    it "accepts an :unless condition that can block the validation" do
+      validator = ValidatesPresenceOf.new :foo, :unless => :bar
+
+      triggers       = stub(:foo => blank_value, :bar => false)
+      doesnt_trigger = stub(:foo => blank_value, :bar => true)
+
+      result = validator.violations_of(triggers)
+      expect(result).to_not be_ok
+
+      result = validator.violations_of(doesnt_trigger)
+      expect(result).to be_ok
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/standalone_validator.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'standalone_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "standalone_validator"
+  spec.version       = StandaloneValidator::VERSION
+  spec.authors       = ["Renato Zannon"]
+  spec.email         = ["renato.riccieri@gmail.com"]
+  spec.description   = <<-DESCRIPTION
+    A library for creating PORO validators that are composable and can be used
+    with ActiveRecord or standalone.
+  DESCRIPTION
+
+  spec.summary       = %q{PORO standalone validators compatible with ActiveRecord}
+  spec.homepage      = "http://github.com/riccieri/standalone_validator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "backports"
+  spec.add_dependency "hamster", "~> 0.4"
+  spec.add_dependency "virtus",  "~> 0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec",   "~> 2.13"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: standalone_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Renato Zannon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hamster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      A library for creating PORO validators that are composable and can be used
+      with ActiveRecord or standalone.
+email:
+- renato.riccieri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/standalone_validator.rb
+- lib/standalone_validator/definitions.rb
+- lib/standalone_validator/named_validations.rb
+- lib/standalone_validator/named_validations/common_rails_options.rb
+- lib/standalone_validator/named_validations/validates_presence_of.rb
+- lib/standalone_validator/validation_result.rb
+- lib/standalone_validator/validation_result_builder.rb
+- lib/standalone_validator/version.rb
+- lib/standalone_validator/violation.rb
+- spec/integration_spec.rb
+- spec/named_validations/validates_presence_of_spec.rb
+- spec/spec_helper.rb
+- standalone_validator.gemspec
+homepage: http://github.com/riccieri/standalone_validator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: PORO standalone validators compatible with ActiveRecord
+test_files:
+- spec/integration_spec.rb
+- spec/named_validations/validates_presence_of_spec.rb
+- spec/spec_helper.rb
+has_rdoc: