localized_each_validator 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.bundle
+.rvmrc
+
+## PROJECT::DOCUMENTATION
+.yardoc
+doc

data/.rspec

@@ -0,0 +1 @@
+-cfs

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+# DEPENDENCIES
+gem 'activerecord', require: 'active_record'
+gem 'activesupport', require: 'active_record'
+
+# DEVELOPMENT
+gem 'jeweler'
+gem 'yard'
+gem 'RedCloth', require: 'redcloth'
+
+# TEST
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    tzinfo (0.3.23)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  activerecord
+  activesupport
+  jeweler
+  rspec
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tim Morgan
+
+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.textile

@@ -0,0 +1,35 @@
+h1. Localized @EachValidator@
+
+| *Author* | Tim Morgan |
+| *Version* | 1.0 (Oct 31, 2010) |
+| *License* | Released under the MIT license. |
+
+h2. About
+
+Localized @EachValidator@ is a subclass of ActiveRecord's @EachValidator@ that makes it easier to write a localized validator with Rails 3's localization. It's small and simple.
+
+h2. Usage
+
+Add this gem to your project's @Gemfile@, or to your own validator gem's dependencies. Then, sublass @LocalizedEachValidator@ and provide the @error_key@ and override the @valid?@ method, like so:
+
+<pre><code>
+class FourValidator < ActiveRecord::EachValidator
+  error_key :must_be_four
+
+  def valid?(record, field, value)
+    value == 4
+  end
+</code></pre>
+
+Now, users of your validator can create a localization YAML file like so:
+
+<pre><code>
+en:
+  activerecord:
+	errors:
+	  messages:
+	    must_be_four: This number must be four.
+</code></pre>
+
+
+See the {LocalizedEachValidator} class documentation for more information.

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+begin
+  require 'bundler'
+rescue LoadError
+  puts "Bundler is not installed; install with `gem install bundler`."
+  exit 1
+end
+
+Bundler.require :default
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "localized_each_validator"
+  gem.summary = %Q{Simple EachValidator with localization support}
+  gem.description = %Q{Adds an abstract EachValidator superclass that you can use to create localizable validations.}
+  gem.email = "git@timothymorgan.info"
+  gem.homepage = "http://github.com/riscfuture/localized_each_validator"
+  gem.authors = [ "Tim Morgan" ]
+  gem.add_dependency 'activerecord', '>= 3.0'
+  gem.add_dependency 'activesupport', '>= 3.0'
+end
+Jeweler::GemcutterTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+YARD::Rake::YardocTask.new('doc') do |doc|
+  doc.options << "-m" << "textile"
+  doc.options << "--protected"
+  doc.options << "-r" << "README.textile"
+  doc.options << "-o" << "doc"
+  doc.options << "--title" << "Localized EachValidator Documentation".inspect
+  
+  doc.files = [ 'lib/**/*', 'README.textile' ]
+end
+
+task(default: :spec)

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/localized_each_validator.rb

@@ -0,0 +1,56 @@
+require 'active_support/core_ext/hash/except'
+
+# An @EachValidator@ that uses the translation table to build its error
+# messages. Override the {#valid?} method to describe your validation
+# conditions of your subclasses.
+#
+# The error message translation lookups conform to the standard hierarchy of
+# internationalization keys as described by the
+# @ActiveRecord::Errors#generate_message@ method. (See its documentation for
+# more information.) The last portion of the translation key path is the error
+# message key, and by default it is the name of the validator class (excepting
+# "Validator"), underscored and demodulized. For example, an
+# @EmailAddressValidator@ subclass would use the @email_address@ key within the
+# normal ActiveRecord error key structure.
+#
+# @abstract Subclass this validator to perform your specific validations.
+
+class LocalizedEachValidator < ActiveModel::EachValidator
+  extend ActiveSupport::Memoizable
+
+  # @private
+  def validate_each(record, attribute, value)
+    return if options[:allow_nil] and value.nil?
+    return if options[:allow_blank] and value.blank?
+    record.errors.add(attribute, options[:message] || self.class.error_key) unless valid?(record, attribute, value)
+  end
+
+  protected
+
+  # @abstract Override this method to return true or false depending on whether
+  # @value@ is a valid value for @record@'s @attribute@.
+  # @param [ActiveRecord::Base] record The record being validated.
+  # @param [Symbol] attribute The attribute with the given value.
+  # @param value The value of the attribute to be validated.
+  # @return [true, false] Whether the value is valid.
+
+  def valid?(record, attribute, value)
+    raise NotImplementedError, "Implement this method in your subclasses"
+  end
+
+  # @overload error_key
+  #   Returns the error message key this class uses.
+  #   @return [Symbol] The error message key.
+  #
+  # @overload error_key(value)
+  #   Sets the error message key this class uses.
+  #   @param [Symbol] value The new error message key.
+
+  def self.error_key(value=nil)
+    if value then
+      @error_key = value
+    else
+      return @error_key || to_s.demodulize.sub(/Validator$/, '').underscore.to_sym
+    end
+  end
+end

data/localized_each_validator.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{localized_each_validator}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Morgan"]
+  s.date = %q{2010-10-31}
+  s.description = %q{Adds an abstract EachValidator superclass that you can use to create localizable validations.}
+  s.email = %q{git@timothymorgan.info}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/localized_each_validator.rb",
+     "localized_each_validator.gemspec",
+     "spec/localized_each_validator_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/riscfuture/localized_each_validator}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple EachValidator with localization support}
+  s.test_files = [
+    "spec/localized_each_validator_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0"])
+  end
+end
+

data/spec/localized_each_validator_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module SpecSupport
+  class TestLocalizedEachValidator < LocalizedEachValidator
+    def valid?(_,_, v) v == 'foo' end
+  end
+  class FakeModel
+    extend ActiveModel::Translation
+    def errors() @errors ||= ActiveModel::Errors.new(self) end
+    def self.lookup_ancestors() [ self ] end
+    def read_attribute_for_validation(_) "mock" end
+  end
+end
+
+describe LocalizedEachValidator do
+  before :each do
+    @model = SpecSupport::FakeModel.new
+  end
+
+  describe ".error_key_prefix" do
+    it "should be the downcased name of the validator by default" do
+      SpecSupport::TestLocalizedEachValidator.error_key.should eql(:test_localized_each)
+    end
+
+    it "should be able to be set" do
+      SpecSupport::TestLocalizedEachValidator.error_key(:foo)
+      SpecSupport::TestLocalizedEachValidator.error_key.should eql(:foo)
+      SpecSupport::TestLocalizedEachValidator.instance_variable_set :@error_key, nil
+    end
+  end
+
+  describe ".validate_each" do
+    it "should do nothing if given nil and :allow_nil is set" do
+      SpecSupport::TestLocalizedEachValidator.new(attributes: :field, allow_nil: true).validate_each(@model, :field, nil)
+      @model.errors.should be_empty
+    end
+
+    it "should do nothing if given a blank value and :allow_blank is set" do
+      SpecSupport::TestLocalizedEachValidator.new(attributes: :field, allow_blank: true).validate_each(@model, :field, "")
+      @model.errors.should be_empty
+    end
+
+    it "should validate according to the #valid? method" do
+      SpecSupport::TestLocalizedEachValidator.new(attributes: :field).validate_each(@model, :field, "foo")
+      @model.errors.should be_empty
+    end
+
+    it "should add an error if the validation fails" do
+      SpecSupport::TestLocalizedEachValidator.new(attributes: :field).validate_each(@model, :field, "bar")
+      @model.errors[:field].should_not be_empty
+      @model.errors[:field].first.should include('test_localized_each')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+Bundler.require :default, :test
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'localized_each_validator'
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: localized_each_validator
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-31 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+description: Adds an abstract EachValidator superclass that you can use to create localizable validations.
+email: git@timothymorgan.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/localized_each_validator.rb
+- localized_each_validator.gemspec
+- spec/localized_each_validator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/riscfuture/localized_each_validator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4590308378211320386
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple EachValidator with localization support
+test_files: 
+- spec/localized_each_validator_spec.rb
+- spec/spec_helper.rb