redinger-validation_reflection 0.3.2

data/CHANGELOG

@@ -0,0 +1,26 @@
+== 0.3.2, 2009-09-12
+* gemified by Christopher Redinger
+
+== 0.3.1, 2008-01-03
+* require 'ostruct'; thanks to Georg Friedrich.
+
+== 0.3, 2008-01-01
+* Added configurability in config/plugins/validation_reflection.rb
+
+== 0.2.1, 2006-12-28
+* Moved lib files into subfolder boiler_plate.
+
+== 0.2, 2006-08-06
+?
+
+= Deprecation Notice
+
+Version 0.1 had supplied three methods
+
+ - validates_presence_of_mandatory_content_columns
+ - validates_lengths_of_string_attributes
+ - validates_all_associated
+  
+These have been removed. Please use the Enforce Schema Rules plugin instead
+
+  http://enforce-schema-rules.googlecode.com/svn/trunk/enforce_schema_rules/

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Michael Schuerig
+
+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

@@ -0,0 +1,64 @@
+Validation Reflection
+=====================
+
+Version 0.3.1, 2008-01-03
+
+This plugin adds reflective access to validations
+
+ - ModelClass.reflect_on_all_validations
+ - ModelClass.reflect_on_validations_for(:property)
+
+Both of these methods return arrays containing instances of
+ActiveRecord::Reflection::MacroReflection. For example
+
+  class Person < ActiveRecord::Base
+    validates_presence_of :name
+    validates_numericality_of :size, :only_integer => true
+  end
+
+  refl = Person.reflect_on_validations_for(:name)
+  refl[0].macro
+  # => :validates_presence_of
+  
+  refl = Person.reflect_on_validations_for(:size)
+  refl[0].macro
+  # => :validates_numericality_of
+  refl[0].options
+  # => { :only_integer => true }
+  
+
+== Customization
+
+Usually, all the standard Rails validations are reflected.
+You can change this -- add or remove validations -- in an
+application-specific configuration file, 
+
+  config/plugins/validation_reflection.rb
+
+In that file change config.reflected_validations to suit your
+needs. Say, you have a custom validation for email addresses,
+validates_as_email, then you could add it like this
+
+  config.reflected_validations << :validates_as_email
+
+If validates_as_email is implemented in terms of other validation
+methods, these validations are added to the reflection metadata,
+too. As that may not be what you want, you can disable reflection
+for these subordinate validations
+
+  config.reflected_validations << {
+  	:method => :validates_as_email,
+  	:ignore_subvalidations => true
+  }
+
+You have to make sure that all reflected validations are defined
+before this plugin is loaded. To this end, you may have to
+explicitly set the load order of plugins somewhere in the environment
+configuration using
+
+  config.plugins = [...]
+
+
+
+
+Copyright (c) 2006-2008, Michael Schuerig, michael@schuerig.de

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the validation_reflection plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the validation_reflection plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidationReflection'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "validation_reflection"
+    gemspec.summary = "Adds reflective access to validations"
+    gemspec.description = "Adds reflective access to validations"
+    gemspec.email = "redinger@gmail.com"
+    gemspec.homepage = "http://github.com/redinger/validation_reflection"
+    gemspec.authors = ["Christopher Redinger"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 3
+:patch: 2
+:major: 0

data/about.yml

@@ -0,0 +1,7 @@
+author: Michael Schuerig
+summary: Reflection on validations
+homepage: http://rubyforge.org/projects/valirefl/validation_reflection/trunk
+plugin: validation_reflection
+license: MIT
+version: 0.3.1
+rails_version: >= 1.1.6

data/lib/validation_reflection.rb

@@ -0,0 +1,127 @@
+#--
+# Copyright (c) 2006-2008, Michael Schuerig, michael@schuerig.de
+#
+# 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.
+#++
+
+
+require 'active_record/reflection'
+require 'ostruct'
+
+# Based on code by Sebastian Kanthak
+# See http://dev.rubyonrails.org/ticket/861
+module ActiveRecordExtensions # :nodoc:
+  module ValidationReflection # :nodoc:
+    CONFIG_PATH = File.join(RAILS_ROOT, 'config', 'plugins', 'validation_reflection.rb')
+    
+    mattr_accessor :reflected_validations
+    ActiveRecordExtensions::ValidationReflection.reflected_validations = %w(
+       validates_acceptance_of
+       validates_associated
+       validates_confirmation_of
+       validates_exclusion_of
+       validates_format_of
+       validates_inclusion_of
+       validates_length_of
+       validates_numericality_of
+       validates_presence_of
+       validates_uniqueness_of
+    )
+
+    mattr_accessor :in_ignored_subvalidation
+    ActiveRecordExtensions::ValidationReflection.in_ignored_subvalidation = false
+    
+    def self.included(base)
+      return if base.kind_of?(ActiveRecordExtensions::ValidationReflection::ClassMethods)
+      base.extend(ClassMethods)
+    end
+
+    def self.load_config
+      if File.file?(CONFIG_PATH)
+        config = OpenStruct.new
+        config.reflected_validations = reflected_validations
+        silence_warnings do
+          eval(IO.read(CONFIG_PATH), binding, CONFIG_PATH)
+        end
+      end
+    end
+
+    def self.install(base)
+      reflected_validations.freeze
+      reflected_validations.each do |validation_type|
+        next if base.respond_to?("#{validation_type}_with_reflection")
+        ignore_subvalidations = false
+        if validation_type.kind_of?(Hash)
+          ignore_subvalidations = validation_type[:ignore_subvalidations]
+          validation_type = validation_type[:method]
+        end
+        base.class_eval <<-"end_eval"
+          class << self
+            def #{validation_type}_with_reflection(*attr_names)
+              ignoring_subvalidations(#{ignore_subvalidations}) do
+                #{validation_type}_without_reflection(*attr_names)
+                remember_validation_metadata(:#{validation_type}, *attr_names)
+              end
+            end
+
+            alias_method_chain :#{validation_type}, :reflection
+          end
+        end_eval
+      end
+    end
+
+    module ClassMethods
+
+      # Returns an array of MacroReflection objects for all validations in the class
+      def reflect_on_all_validations
+        read_inheritable_attribute(:validations) || []
+      end
+
+      # Returns an array of MacroReflection objects for all validations defined for the field +attr_name+.
+      def reflect_on_validations_for(attr_name)
+        attr_name = attr_name.to_sym
+        reflect_on_all_validations.select do |reflection|
+          reflection.name == attr_name
+        end
+      end
+
+      private
+      
+      def remember_validation_metadata(validation_type, *attr_names)
+        configuration = attr_names.last.is_a?(Hash) ? attr_names.pop : {}
+        attr_names.each do |attr_name|
+          write_inheritable_array :validations,
+            [ ActiveRecord::Reflection::MacroReflection.new(validation_type, attr_name.to_sym, configuration, self) ]
+        end
+      end
+      
+      def ignoring_subvalidations(ignore)
+        save_ignore = ActiveRecordExtensions::ValidationReflection.in_ignored_subvalidation
+        unless ActiveRecordExtensions::ValidationReflection.in_ignored_subvalidation
+          ActiveRecordExtensions::ValidationReflection.in_ignored_subvalidation = ignore
+          yield
+        end
+      ensure
+        ActiveRecordExtensions::ValidationReflection.in_ignored_subvalidation = save_ignore
+      end
+    end
+
+  end
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Base.class_eval do
+  include ActiveRecordExtensions::ValidationReflection
+  ActiveRecordExtensions::ValidationReflection.load_config
+  ActiveRecordExtensions::ValidationReflection.install(self)
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+ENV["RAILS_ENV"] = "test"
+RAILS_ROOT = File.join(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'

data/test/validation_reflection_test.rb

@@ -0,0 +1,122 @@
+require 'test_helper'
+
+ActiveRecord::Base.class_eval do
+  def self.validates_something_weird(*cols)
+    cols.each do |col|
+      validates_format_of col, :with => /weird/
+    end
+  end
+  def self.validates_something_selfcontained(*cols)
+    cols.each do |col|
+      validates_format_of col, :with => /blablabla/
+    end
+  end
+end
+
+require 'validation_reflection'
+
+ActiveRecord::Base.class_eval do
+  include ActiveRecordExtensions::ValidationReflection
+  ActiveRecordExtensions::ValidationReflection.reflected_validations << :validates_something_weird
+  ActiveRecordExtensions::ValidationReflection.reflected_validations << {
+    :method => :validates_something_selfcontained,
+    :ignore_subvalidations => true
+  }
+  ActiveRecordExtensions::ValidationReflection.install(self)
+end
+
+
+class ValidationReflectionTest < Test::Unit::TestCase
+
+  class Dummy < ActiveRecord::Base
+    class << self
+  
+      def create_fake_column(name, null = true, limit = nil)
+        sql_type = limit ? "varchar (#{limit})" : nil
+        col = ActiveRecord::ConnectionAdapters::Column.new(name, nil, sql_type, null)
+        col
+      end
+  
+      def columns
+        [
+         create_fake_column('col0'),
+         create_fake_column('col1'),
+         create_fake_column('col2', false, 100),
+         create_fake_column('col3'),
+         create_fake_column('col4'),
+         create_fake_column('col5'),
+         create_fake_column('col6'),
+         create_fake_column('col7')
+        ]
+      end
+    end
+    
+    has_one :nothing
+    
+    validates_presence_of :col1
+    validates_length_of :col2, :maximum => 100
+    validates_format_of :col3, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+    validates_numericality_of :col4, :only_integer => true
+    validates_numericality_of :col5, :less_than => 5
+    validates_something_weird :col6
+    validates_something_selfcontained :col7
+  end
+
+
+  def test_sanity
+    assert_equal [], Dummy.reflect_on_validations_for(:col0)
+  end
+
+  def test_validates_presence_of_is_reflected
+    refls = Dummy.reflect_on_validations_for(:col1)
+    assert refls.all? { |r| r.name.to_s == 'col1' }
+    assert refls.find { |r| r.macro == :validates_presence_of }
+  end
+
+  def test_string_limit_is_reflected
+    refls = Dummy.reflect_on_validations_for(:col2)
+    assert refls.any? { |r| r.macro == :validates_length_of && r.options[:maximum] == 100 }
+  end
+
+  def test_format_is_reflected
+    refls = Dummy.reflect_on_validations_for(:col3)
+    assert refls.any? { |r| r.macro == :validates_format_of && r.options[:with] == /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i }
+  end
+
+  def test_numeric_integer_is_reflected
+    refls = Dummy.reflect_on_validations_for(:col4)
+    assert refls.any? { |r| r.macro == :validates_numericality_of && r.options[:only_integer] }
+  end
+  
+  def test_numeric_is_reflected
+    refls = Dummy.reflect_on_validations_for(:col5)
+    assert refls.any? { |r| r.macro == :validates_numericality_of }
+  end
+  
+  def test_validation_options_are_reflected
+    refls = Dummy.reflect_on_validations_for(:col5)
+    refl = refls[0]
+    assert_equal 5, refl.options[:less_than]
+  end
+
+  def test_custom_validations_are_reflected
+    refls = Dummy.reflect_on_validations_for(:col6)
+    assert refls.any? { |r| r.macro == :validates_something_weird }
+    assert refls.any? { |r| r.macro == :validates_format_of }
+  end
+
+  def test_custom_validations_with_options_are_reflected
+    refls = Dummy.reflect_on_validations_for(:col7)
+    assert refls.any? { |r| r.macro == :validates_something_selfcontained }
+  end
+
+  def test_subvalidations_are_reflected
+    refls = Dummy.reflect_on_validations_for(:col6)
+    assert_equal 2, refls.size
+  end
+
+  def test_ignored_subvalidations_are_not_reflected
+    refls = Dummy.reflect_on_validations_for(:col7)
+    assert_equal 1, refls.size
+  end
+end

data/validation_reflection.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{validation_reflection}
+  s.version = "0.3.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christopher Redinger"]
+  s.date = %q{2009-09-12}
+  s.description = %q{Adds reflective access to validations}
+  s.email = %q{redinger@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    "CHANGELOG",
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION.yml",
+     "about.yml",
+     "lib/validation_reflection.rb",
+     "rails/init.rb",
+     "test/test_helper.rb",
+     "test/validation_reflection_test.rb",
+     "validation_reflection.gemspec"
+  ]
+  s.homepage = %q{http://github.com/redinger/validation_reflection}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Adds reflective access to validations}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/validation_reflection_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: redinger-validation_reflection
+version: !ruby/object:Gem::Version 
+  version: 0.3.2
+platform: ruby
+authors: 
+- Christopher Redinger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Adds reflective access to validations
+email: redinger@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- CHANGELOG
+- LICENSE
+- README
+- Rakefile
+- VERSION.yml
+- about.yml
+- lib/validation_reflection.rb
+- rails/init.rb
+- test/test_helper.rb
+- test/validation_reflection_test.rb
+- validation_reflection.gemspec
+has_rdoc: false
+homepage: http://github.com/redinger/validation_reflection
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Adds reflective access to validations
+test_files: 
+- test/test_helper.rb
+- test/validation_reflection_test.rb