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

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2007-2009 Nils Jonsson (nils@alumni.rice.edu)
+Copyright (c) 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

data/README.rdoc

@@ -0,0 +1,100 @@
+== Validates Constancy for Ruby on Rails (Active Record)
+
+http://constancy.rubyforge.org
+
+Compatible with Rails v1.2.2 through v2.0.4 (Active Record v1.15.2 through
+v2.0.4)
+
+
+=== Introduction
+
+This 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 a Rails plugin. It is compatible with the latest
+released version of the Rails framework (and possibly also other versions -- see
+the 'test' branch of this repository). You can install the plugin with the
+command:
+
+  ruby script/plugin install git://github.com/njonsson/validates-constancy-rails-plugin.git
+
+
+=== 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.
+
+  git checkout test
+  git submodule update --init
+
+Then read rails_*/doc/README_FOR_APP for instructions on how to run the tests.
+
+
+=== Credits
+
+Copyright (c) 2007-2009 Nils Jonsson (mailto:nils@alumni.rice.edu)
+
+Released under the MIT license.

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  activerecord:
+    errors:
+      messages:
+        constancy: "can't be changed"

data/config/locales/ru.yml

@@ -0,0 +1,5 @@
+ru:
+  activerecord:
+    errors:
+      messages:
+        constancy: "не может быть изменён"

data/lib/validates_constancy/constancy_validation.rb

@@ -7,8 +7,6 @@ require '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.
@@ -44,7 +42,8 @@ module ConstancyValidation
     # so you'll want to specify associations *after* +validates_constancy_of+
     # statements in your model classes.
     def validates_constancy_of(*attribute_names)
-      options = {:message =>
+      options = {:message => Object.const_defined?(:I18n) ?
+                 I18n.translate('activerecord.errors.messages.constancy') :
                  ActiveRecord::Errors.default_error_messages[:constancy]}
       options.merge!(attribute_names.pop) if attribute_names.last.kind_of?(Hash)
       

data/lib/validates_constancy.rb

@@ -7,3 +7,9 @@ Dir.glob(File.join(File.dirname(__FILE__),
 end
 
 ActiveRecord::Base.class_eval { include ConstancyValidation }
+
+if Object.const_defined?(:I18n)
+  I18n.load_path << File.join(File.dirname(__FILE__), '..', 'config', 'locales', 'en.yml')
+else
+  ActiveRecord::Errors.default_error_messages[:constancy] = "can't be changed"
+end

data/test/README.rdoc

@@ -0,0 +1,7 @@
+There are no unit tests for the Validates Constancy plugin. Instead, there are
+suites of integration tests in the form of Active Record models that use the
+plugin while running against different versions of Active Record.
+
+See the doc/README_FOR_APP files that are included in the various Rails
+applications. Those applications can be found at in the ‘test’ branch of this
+repository.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: markcatley-validates-constancy-rails-plugin
 version: !ruby/object:Gem::Version 
-  version: 1.0.20090327
+  version: 1.0.20090923
 platform: ruby
 authors: 
 - Nils Jonsson
@@ -9,7 +9,7 @@ autorequire: validates_constancy
 bindir: bin
 cert_chain: []
 
-date: 2009-03-21 00:00:00 -07:00
+date: 2009-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,24 +30,27 @@ extensions: []
 
 extra_rdoc_files: 
 - MIT-LICENSE
-- README
+- README.rdoc
 files: 
 - CHANGELOG
-- Rakefile
 - MIT-LICENSE
-- README
+- README.rdoc
+- Rakefile
 - init.rb
+- config/locales/en.yml
+- config/locales/ru.yml
 - lib/validates_constancy.rb
 - lib/validates_constancy/constancy_validation.rb
-- test/README
+- test/README.rdoc
 has_rdoc: true
 homepage: http://constancy.rubyforge.org/
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --title
 - Validates Constancy for Active Record
 - --main
-- README
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -65,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: constancy
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 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."