avalon 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryo NAKAMURA
+
+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,47 @@
+# Avalon
+
+A validator implementation for Ruby.  
+Avalon provides simple validation methods and validator class.
+
+## Requirements
+Avalon is implemented in pure ruby without any gems.  
+Tested in following environments:
+* MRI 1.8.7
+* MRI 1.9.2
+* MRI 1.9.3
+
+## Usage
+
+```
+$ gem install avalon
+```
+
+```ruby
+require "avalon"
+
+Avalon.valid?("abc", /d/)   #=> false
+Avalon.invalid?("abc", /d/) #=> true
+Avalon.validate("abc", /d/) #=> "abc" must match /d/ (Avalon::ValidationError)
+
+Avalon.valid?(:foo => "bar") { |target| target.has_key?(:foo) } #=> true
+Avalon.valid?(:foo => "bar") { has_key?(:foo) }                 #=> true
+
+class Calculator
+  include Avalon
+
+  def square(number)
+    validate(number, Fixnum, /^\d+$/)
+    number.to_i ** 2
+  end
+end
+
+calculator = Calculator.new
+calculator.square(3)       #=> 9
+calculator.square("3")     #=> 9
+calculator.square("three") #=> "three" must match Fixnum or /^\d+$/ (Avalon::ValidationError)
+
+validator = Avalon::Validator.new("1", lambda {|x| x.respond_to?(:to_i) })
+validator.valid?   #=> true
+validator.invalid? #=> false
+validator.validate #=> true
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/avalon.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/avalon/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ryo NAKAMURA"]
+  gem.email         = ["r7kamura@gmail.com"]
+  gem.description   = "Provide a simple validation method and validator class for Ruby"
+  gem.summary       = "A validator implementation for Ruby"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "avalon"
+  gem.require_paths = ["lib"]
+  gem.version       = Avalon::VERSION
+
+  gem.add_development_dependency "rspec"
+end

data/lib/avalon/validator.rb

@@ -0,0 +1,44 @@
+module Avalon
+  class Validator
+    def initialize(target, *patterns, &block)
+      @target   = target
+      @patterns = patterns
+      @patterns << block if block_given?
+    end
+
+    def validate
+      raise_error if invalid?
+      true
+    end
+
+    def valid?
+      @patterns.any? {|pattern| check(pattern) }
+    end
+
+    def invalid?
+      !valid?
+    end
+
+    private
+
+    def check(pattern)
+      if pattern.respond_to?(:call)
+        @target.instance_eval(&pattern)
+      else
+        pattern === @target
+      end
+    end
+
+    def raise_error
+      raise ValidationError, error_message
+    end
+
+    def error_message
+      target   = @target.inspect
+      patterns = @patterns.map(&:inspect).join(" or ")
+      "#{target} must match #{patterns}"
+    end
+  end
+
+  class ValidationError < StandardError; end
+end

data/lib/avalon/version.rb

@@ -0,0 +1,3 @@
+module Avalon
+  VERSION = "0.0.2"
+end

data/lib/avalon.rb

@@ -0,0 +1,18 @@
+require "avalon/version"
+require "avalon/validator"
+
+module Avalon
+  extend self
+
+  def validate(*args, &block)
+    Validator.new(*args, &block).validate
+  end
+
+  def valid?(*args, &block)
+    Validator.new(*args, &block).valid?
+  end
+
+  def invalid?(*args, &block)
+    Validator.new(*args, &block).invalid?
+  end
+end

data/spec/avalon/validator_spec.rb

@@ -0,0 +1,121 @@
+require "spec_helper"
+
+describe Avalon::Validator do
+  describe "#valid?" do
+    context "given String pattern" do
+      context "when matched" do
+        it do
+          Avalon::Validator.new("target", "target").should be_valid
+        end
+      end
+
+      context "not matched" do
+        it do
+          Avalon::Validator.new("target", "not matched").should_not be_valid
+        end
+      end
+    end
+
+    context "given Regexp pattern" do
+      context "when matched" do
+        it do
+          Avalon::Validator.new("target", /target/).should be_valid
+        end
+      end
+
+      context "when not matched" do
+        it do
+          Avalon::Validator.new("target", /not matched/).should_not be_valid
+        end
+      end
+    end
+
+    context "given Class pattern" do
+      context "when matched" do
+        it do
+          Avalon::Validator.new("target", String).should be_valid
+        end
+      end
+
+      context "when not matched" do
+        it do
+          Avalon::Validator.new("target", Fixnum).should_not be_valid
+        end
+      end
+    end
+
+    context "given Proc pattern" do
+      it "should evaluated in target's context" do
+        Avalon::Validator.new("target") { match(/target/) }.should be_valid
+      end
+
+      context "when matched" do
+        it do
+          Avalon::Validator.new("target", proc {|x| x =~ /target/ }).should be_valid
+        end
+      end
+
+      context "when not matched" do
+        it do
+          Avalon::Validator.new("target", proc {|x| x =~ /not match/ }).should_not be_valid
+        end
+      end
+    end
+
+    context "given Block pattern" do
+      context "when matched" do
+        it do
+          Avalon::Validator.new("target") {|x| x =~ /target/ }.should be_valid
+        end
+      end
+
+      context "when not matched" do
+        it do
+          Avalon::Validator.new("target") {|x| x =~ /not match/ }.should_not be_valid
+        end
+      end
+
+      it "should evaluated in target's context" do
+        Avalon::Validator.new("target") { match(/target/) }.should be_valid
+      end
+    end
+
+    context "given multiple OR-patterns" do
+      context "when matched" do
+        it do
+          Avalon::Validator.new("target", Fixnum, "target").should be_valid
+        end
+      end
+
+      context "when not matched" do
+        it do
+          Avalon::Validator.new("target", Fixnum, /not matched/).should_not be_valid
+        end
+      end
+    end
+  end
+
+  describe "#invalid?" do
+    it "should behave like a counter method of #valid?" do
+      Avalon::Validator.new("target", "not matched").should be_invalid
+    end
+  end
+
+  describe "#validate" do
+    context "in valid case" do
+      it do
+        expect do
+          Avalon::Validator.new("target", "target").validate
+        end.to_not raise_error(Avalon::ValidationError)
+      end
+    end
+
+    context "in invalid case" do
+      it "should raise Avalon::ValidationError with message that includes target and patterns" do
+        expect do
+          Avalon::Validator.new("target", Fixnum, /not matched/).validate
+        end.to raise_error(Avalon::ValidationError, '"target" must match Fixnum or /not matched/')
+      end
+    end
+  end
+end

data/spec/avalon_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Avalon do
+  describe ".#validate" do
+    it "should call Validator#validate" do
+      Avalon::Validator.any_instance.should_receive(:validate)
+      Avalon.validate("target", "pattern")
+    end
+  end
+
+  describe ".#valid?" do
+    it "should call Validator#valid?" do
+      Avalon::Validator.any_instance.should_receive(:valid?)
+      Avalon.valid?("target", "pattern")
+    end
+  end
+
+  describe ".#valid?" do
+    it "should call Validator#invalid?" do
+      Avalon::Validator.any_instance.should_receive(:invalid?)
+      Avalon.invalid?("target", "pattern")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "avalon"

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: avalon
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Ryo NAKAMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70209852418340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70209852418340
+description: Provide a simple validation method and validator class for Ruby
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- avalon.gemspec
+- lib/avalon.rb
+- lib/avalon/validator.rb
+- lib/avalon/version.rb
+- spec/avalon/validator_spec.rb
+- spec/avalon_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A validator implementation for Ruby
+test_files:
+- spec/avalon/validator_spec.rb
+- spec/avalon_spec.rb
+- spec/spec_helper.rb
+has_rdoc: