validates_constancy 1.0.0

data/CHANGELOG

@@ -0,0 +1,6 @@
+*SVN*
+
+
+*1.0*
+
+* First public release. Compatible with Rails v1.2.3 and v1.2.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright � 2007 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/README

@@ -0,0 +1,123 @@
+== Validates Constancy for Active Record
+
+http://constancy.rubyforge.org
+
+Compatible with Rails v1.2.2 and v1.2.3 (Active Record v1.15.2 and v1.15.3)
+
+
+=== Introduction
+
+This RubyGem and Rails plugin adds a +validates_constancy_of+ validation to
+Active Record. It allows you to prevent particular database fields from being
+changed after a record is created. A validation error occurs on updates if an
+attribute of a model object is different from its value in the database.
+
+
+=== Installing Validates Constancy
+
+The code is packaged as both a RubyGem and a Rails plugin. You can use either
+one, depending on what your needs are.
+
+<b>The Validates Constancy gem</b> is compatible with various versions of Rails
+(Active Record) -- see the _test_ subdirectories of
+http://constancy.rubyforge.org/svn/gem/branches. You can install the gem with
+the command:
+
+  gem install validates_constancy
+
+<b>The Validates Constancy plugin</b> is compatible with the latest released
+version of the Rails framework (and possibly also other versions -- see
+http://constancy.rubyforge.org/svn/plugin/test). You can install the plugin with
+the command:
+
+  ruby script/plugin install http://constancy.rubyforge.org/svn/plugin/validates_constancy
+
+Use the gem (http://constancy.rubyforge.org/svn/gem) if you're using Active
+Record apart from Rails, or for compatibility with a version of Rails (Active
+Record) that is not supported by the plugin. Use the plugin if your Rails
+version is up to date and if you like the convenience of a Rails plugin.
+
+
+=== Using constancy validation
+
+Here's how to use this validation in your code.
+
+  class Person < ActiveRecord::Base
+    
+    # Prevent changes to Person#social_security_number.
+    validates_constancy_of :social_security_number
+    
+  end
+
+
+==== Options
+
+The validation takes two options, <tt>:if</tt> and <tt>:message</tt>. These may
+be familiar because several of Active Record's validations also use them. The
+<tt>:if</tt> option takes a Proc, or a symbol, or string with a model object
+argument and a return value of +true+ or +false+.
+
+  class Comment < ActiveRecord::Base
+    
+    # Prevent changes to Comment#text if it is "locked."
+    validates_constancy_of :text, :if => Proc.new { |comment| comment.locked? }
+    
+  end
+
+The default error message is "can't be changed". Use your own error message by
+specifying the <tt>:message</tt> option.
+
+  class LicensePlate < ActiveRecord::Base
+    
+    # Prevent changes to LicensePlate#number.
+    validates_constancy_of :number,
+                           :message => 'is off-limits! What are you thinking?'
+    
+  end
+
+More than one model attribute can be specified. Any specified options will be
+applied to all the specified attributes.
+
+
+==== 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.
+
+
+=== Running automated tests for Validates Constancy
+
+There's a suite of tests that exercises all the functionality of Validates
+Constancy. You can check out a version of the test suite from the repository
+according to the version of Rails (Active Record) it works with.
+
+==== Gem
+
+[<b>Rails v1.2.2 (Active Record v1.15.2)</b>] Check out http://constancy.rubyforge.org/svn/gem/tags/rel_1-0-0/test/rails_1-2-2
+[<b>Rails v1.2.3 (Active Record v1.15.3)</b>] Check out http://constancy.rubyforge.org/svn/gem/tags/rel_1-0-0/test/rails_1-2-3
+[<b>Edge Rails</b>]                           Check out http://constancy.rubyforge.org/svn/gem/tags/rel_1-0-0/test/rails_edge
+
+==== Plugin
+
+[<b>Rails v1.2.2 (Active Record v1.15.2)</b>] Check out http://constancy.rubyforge.org/svn/plugin/test/rails_1-2-2
+[<b>Rails v1.2.3 (Active Record v1.15.3)</b>] Check out http://constancy.rubyforge.org/svn/plugin/test/rails_1-2-3
+[<b>Edge Rails</b>]                           Check out http://constancy.rubyforge.org/svn/plugin/test/rails_edge
+
+Then read rails_*/doc/README_FOR_APP for instructions on how to run the tests.
+
+
+=== Credits
+
+Copyright � 2007 Nils Jonsson (mailto:nils@alumni.rice.edu)
+
+Released under the MIT license.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for the Validates Constancy RubyGem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Validates Constancy'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('MIT-LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--line-numbers' << '--inline-source'
+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 }

data/lib/validates_constancy/constancy_validation.rb

@@ -0,0 +1,121 @@
+# 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_attribute_names ||= []).concat attribute_names.collect!(&:to_s)
+      
+      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.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/test/README

@@ -0,0 +1,6 @@
+There are no unit tests for the Validates Constancy RubyGem. Instead, there are
+suites of integration tests in the form of Active Record models that use the
+gem while running against different versions of Active Record.
+
+See the doc/README_FOR_APP files that are included in the various Rails
+applications in http://constancy.rubyforge.org/svn/gem/tags/rel_1-0-0/test.

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: validates_constancy
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-08-29 00:00:00 -05:00
+summary: "[Rails] Adds a 'validates_constancy_of' validation to Active Record. It allows you to protect model attributes from being changed after a record is created."
+require_paths: 
+- lib
+email: nils@alumni.rice.edu
+homepage: http://constancy.rubyforge.org/
+rubyforge_project: constancy
+description: This RubyGem allows you to prevent particular database fields from being changed after an Active Record object is created. A validation error occurs on updates if an attribute of a model object is different from its value in the database.
+autorequire: validates_constancy
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Nils Jonsson
+files: 
+- CHANGELOG
+- lib
+- lib/validates_constancy
+- lib/validates_constancy/constancy_validation.rb
+- lib/validates_constancy.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- test
+- test/README
+- validates_constancy-1.0.0.gem
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README
+executables: []
+
+extensions: []
+
+requirements: 
+- Active Record v1.15.2 through v1.15.x
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.15.2
+    version: