markcatley-validates-constancy-rails-plugin 1.0.20090309 → 1.0.20090327

data/CHANGELOG

@@ -0,0 +1,10 @@
+*SVN*
+
+*1.0.1*
+
+* Fix bug #14521 addressing subclasses of a constancy-validated model that do
+  not themselves have constancy validations
+
+*1.0*
+
+* First public release. Compatible with Rails v1.2.3 and v1.2.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2007-2009 Nils Jonsson (nils@alumni.rice.edu)
+
+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,12 @@
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for the Validates Constancy plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Validates Constancy'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('MIT-LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--line-numbers' << '--inline-source'
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib', 'validates_constancy')

data/lib/validates_constancy/constancy_validation.rb

@@ -0,0 +1,126 @@
+# Defines ConstancyValidation.
+
+require 'active_record'
+
+# When this module is included in ActiveRecord::Base, the validation method in
+# ConstancyValidation::ClassMethods becomes available to all Active Record
+# models.
+module ConstancyValidation
+  
+  ActiveRecord::Errors.default_error_messages[:constancy] = "can't be changed"
+  
+  # The following validation is defined in the class scope of the model that
+  # you're interested in validating. It offers a declarative way of specifying
+  # when the model is valid and when it is not.
+  module ClassMethods
+    
+    # Encapsulates the pattern of wanting to protect one or more model
+    # attributes from being changed after the model object is created. Example:
+    # 
+    #   class Person < ActiveRecord::Base
+    #     
+    #     # Prevent changes to Person#user_name and Person#member_since.
+    #     validates_constancy_of :user_name, :member_since
+    #     
+    #   end
+    # 
+    # This check is performed only on update.
+    # 
+    # Configuration options:
+    # 
+    # [<tt>:message</tt>] A custom error message (default is: "can't be changed")
+    # [<tt>:if</tt>] Specifies a method, Proc or string to call to determine if the validation should occur (e.g., <tt>:if => :allow_validation</tt>, or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>). The method, Proc or string should return or evaluate to +true+ or +false+.
+    # 
+    # Warning: With associations, validate the constancy of a foreign key, not
+    # the instance variable itself: <tt>validates_constancy_of :invoice_id</tt>
+    # instead of <tt>validates_constancy_of :invoice</tt>.
+    # 
+    # Also note the warning under <em>Inheritable callback queues</em> in
+    # http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html. "In order
+    # for inheritance to work for the callback queues, you must specify the
+    # callbacks before specifying the associations. Otherwise, you might trigger
+    # the loading of a child before the parent has registered the callbacks and
+    # they won't be inherited." Validates Constancy uses these callback queues,
+    # so you'll want to specify associations *after* +validates_constancy_of+
+    # statements in your model classes.
+    def validates_constancy_of(*attribute_names)
+      options = {:message =>
+                 ActiveRecord::Errors.default_error_messages[:constancy]}
+      options.merge!(attribute_names.pop) if attribute_names.last.kind_of?(Hash)
+      
+      constant_names = base_class.instance_variable_get(:@constant_attribute_names) ||
+                       []
+      constant_names.concat attribute_names.collect!(&:to_s)
+      base_class.instance_variable_set :@constant_attribute_names,
+                                       constant_names
+      
+      ConstancyValidation::OriginalAttributesCapture.extend self
+      
+      options.merge! :on => :update
+      validates_each(attribute_names, options) do |record, attribute_name, value|
+        unless value ==
+               record.instance_variable_get(:@original_attributes)[attribute_name]
+          record.errors.add attribute_name, options[:message]
+        end
+      end
+      
+      self
+    end
+    
+  end
+  
+  class OriginalAttributesCapture #:nodoc:
+    
+    class << self
+      
+      def extend(klass)
+        return false if klass.method_defined?(:capture_original_attributes)
+        
+        create_method_capture_original_attributes klass
+        
+        create_method_after_find_unless_exists klass
+        klass.after_find :capture_original_attributes
+        klass.after_save :capture_original_attributes
+        
+        true
+      end
+      
+    private
+      
+      def create_method(klass, method_name, &block)
+        klass.class_eval { define_method method_name, &block }
+      end
+      
+      def create_method_after_find_unless_exists(klass)
+        # Active Record does not define Base#after_find -- it gets called
+        # dynamically if present. So we need to define a do-nothing method to
+        # serve as the head of the method chain.
+        return false if klass.method_defined?(:after_find)
+        
+        create_method(klass, :after_find) { self }
+        
+        true
+      end
+      
+      def create_method_capture_original_attributes(klass)
+        create_method(klass, :capture_original_attributes) do
+          constant_names = self.class.base_class.instance_variable_get(:@constant_attribute_names) ||
+                           []
+          originals = constant_names.inject({}) do |result, attribute_name|
+            result[attribute_name] = read_attribute(attribute_name)
+            result
+          end
+          instance_variable_set :@original_attributes, originals
+          self
+        end
+      end
+      
+    end
+    
+  end
+  
+  def self.included(other_module) #:nodoc:
+    other_module.extend ClassMethods
+  end
+  
+end

data/lib/validates_constancy.rb

@@ -0,0 +1,9 @@
+# Includes ConstancyValidation in ActiveRecord::Base.
+
+Dir.glob(File.join(File.dirname(__FILE__),
+         'validates_constancy',
+         '*.rb')) do |filename|
+  require filename
+end
+
+ActiveRecord::Base.class_eval { include ConstancyValidation }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: markcatley-validates-constancy-rails-plugin
 version: !ruby/object:Gem::Version 
-  version: 1.0.20090309
+  version: 1.0.20090327
 platform: ruby
 authors: 
 - Nils Jonsson
@@ -9,7 +9,7 @@ autorequire: validates_constancy
 bindir: bin
 cert_chain: []
 
-date: 2009-02-25 00:00:00 -08:00
+date: 2009-03-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency