JackDanger-immutable_attributes 1.0.3

data/Manifest.txt

@@ -0,0 +1,10 @@
+Manifest.txt
+README
+Rakefile
+immutable_attributes.gemspec
+init.rb
+install.rb
+lib/immutable_attributes.rb
+rails/init.rb
+test/immutable_attributes_test.rb
+uninstall.rb

data/README

@@ -0,0 +1,26 @@
+
+
+ImmutableAttributes
+===================
+
+When you want to prevent certain attributes from being changed once set you can declare them as immutable:
+
+class MyModel < ActiveRecord::Base
+  attr_immutable :permalink, :param_identifier
+end
+
+When MyModel.find(:first).permalink = 'anything' is called it will raise an ImmutableAttributeError
+MyModel.new.permalink = 'works!' will properly set the value because the record is unsaved.
+
+If you'd only like this to happen for certain conditions, and want to handle other attribute-writers, too (like update_attribute), you can use the validation.
+
+validates_immutable :permalink
+
+Configuration options for the validation:
+* :message - A customer error message (default is: "can't be changed")
+* :if - Specifies a method, proc, or string to call to determine if the validation should occure (e.g., :if => :allow_validation or :if => Proc.new{|user| user.signup_step > 2}. The method, proc or string should return or evaluate to a true or false value.
+* :unless - Specifies a method, proc, or string to call to determine if the validation should not occure (e.g., :unless => :skip_validation or :unless => Proc.new{|user| user.signup_step <= 2}. The method, proc or string should return or evaluate to a true or false value.
+
+Created by Jack Danger Canty @ http://6brand.com
+Released under the same licence as Rails (MIT)
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'hoe'
+require './lib/immutable_attributes.rb'
+
+Hoe.new('immutable_attributes', ImmutableAttributes::VERSION) do |p|
+  p.developer('Jack Danger Canty', 'rubygems@6brand.com')
+  p.summary = "Immutable Attributes is an ActiveRecord extension that prevents existing data from changing"
+end
+

data/immutable_attributes.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = %q{immutable_attributes}
+  s.version = "1.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jack Danger Canty"]
+  s.date = %q{2009-03-19}
+  s.email = ["rubygems@6brand.com"]
+  s.extra_rdoc_files = ["Manifest.txt"]
+  s.files = ["Manifest.txt", "README", "Rakefile", "immutable_attributes.gemspec", "init.rb", "install.rb", "lib/immutable_attributes.rb", "rails/init.rb", "test/immutable_attributes_test.rb", "uninstall.rb"]
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{immutable_attributes}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Immutable Attributes is an ActiveRecord extension that prevents existing data from changing}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe>, [">= 1.11.0"])
+    else
+      s.add_dependency(%q<hoe>, [">= 1.11.0"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 1.11.0"])
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'immutable_attributes'

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/lib/immutable_attributes.rb

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'activerecord'
+
+module ImmutableErrors
+  class ImmutableAttributeError < ActiveRecord::ActiveRecordError
+  end
+end
+
+module ImmutableAttributes
+  VERSION = "1.0.3"
+  def attr_immutable(*args)
+    args.each do |meth|
+      class_eval do
+        define_method("#{meth}=") do |value|
+          new_record? || read_attribute(meth).nil? ?
+            write_attribute(meth, value) :
+            raise(ActiveRecord::ImmutableAttributeError, "#{meth} is immutable!")
+        end
+      end
+    end
+  end
+
+  def validates_immutable(*attr_names)
+    config = { :on => :update, :if => lambda {|x| true}, :message => "can't be changed" }
+    config.update(attr_names.extract_options!)
+
+    @immutables = attr_names
+
+    attr_names.each do |meth|
+      class_eval do
+        define_method("original_#{meth}") do
+          instance_variable_get("@original_#{meth}")
+        end
+      end
+    end
+
+    class_eval do
+      def self.immutables
+        @immutables
+      end
+
+      def after_initialize; end;
+
+      def setup_originals
+        self.class.immutables.each do |attr_name|
+          instance_variable_set("@original_#{attr_name}", send(attr_name.to_s))
+        end
+      end
+      
+      after_initialize :setup_originals
+    end
+
+    validates_each(attr_names, config) do |record, attr_name, value|
+      next if record.send("original_#{attr_name.to_s}").nil?
+      record.errors.add(attr_name, config[:message]) if record.send("original_#{attr_name.to_s}") != record.send(attr_name.to_s)
+    end
+  end
+end
+
+ActiveRecord.send :include, ImmutableErrors
+ActiveRecord::Base.extend ImmutableAttributes

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'immutable_attributes'

data/test/immutable_attributes_test.rb

@@ -0,0 +1,31 @@
+require 'test/unit'
+require 'rubygems'
+require 'activerecord'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'immutable_attributes')
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :dbfile  => ":memory:"
+)
+ActiveRecord::Schema.define do
+  create_table :records do |table|
+    table.column :name, :string
+    table.column :body, :string
+  end
+end
+
+class Record < ActiveRecord::Base
+  attr_immutable :name
+end
+
+class ImmutableAttributesTest < Test::Unit::TestCase
+
+  def test_immutable_attribute_can_be_set
+    assert Record.new(:name => 'record name')
+  end
+
+  def test_immutable_attribute_cannot_be_changed
+    record = Record.create!(:name => 'record name')
+    assert_raises(ActiveRecord::ImmutableAttributeError) { record.update_attributes(:name => 'new name') }
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: JackDanger-immutable_attributes
+version: !ruby/object:Gem::Version 
+  version: 1.0.3
+platform: ruby
+authors: 
+- Jack Danger Canty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.11.0
+    version: 
+description: 
+email: 
+- rubygems@6brand.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+files: 
+- Manifest.txt
+- README
+- Rakefile
+- immutable_attributes.gemspec
+- init.rb
+- install.rb
+- lib/immutable_attributes.rb
+- rails/init.rb
+- test/immutable_attributes_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: immutable_attributes
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Immutable Attributes is an ActiveRecord extension that prevents existing data from changing
+test_files: []
+