validates_immutability 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.rspec
+.rvmrc
+Gemfile.lock
+pkg/*

data/CHANGELOG

@@ -0,0 +1,3 @@
+1.0.0
+  * can make attributes immutable
+  * can make record as a whole immutable

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in validates_immutability.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Austin Schneider
+
+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
+NON-INFRINGEMENT. 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.rdoc

@@ -0,0 +1,54 @@
+= ValidatesImmutability
+
+Validations for making ActiveRecord objects immutable.
+
+== Examples
+
+    class Person < ActiveRecord::Base
+      immutable :unless => :can_change?, :message => "I don't like being changed."
+
+      def can_change?
+        true
+      end
+    end
+
+    > p = Person.first
+    > p.plays = "soccer"
+    > p.valid?
+    => false
+    > p.errors
+    => {:base=>["I don't like being changed."]}
+
+
+
+    class Car < ActiveRecord::Base
+      validates :color, :immutable => {
+        :if => lambda { !color_can_change? },
+        :message => "is beautiful already."
+      }
+
+      def color_can_change?
+        true
+      end
+    end
+
+    > c = Car.first
+    > c.color = "red"
+    > c.valid?
+    => false
+    > c.errors
+    => {:color=>["is beautiful already."]}
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or changelog.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/validates_immutability.rb

@@ -0,0 +1,25 @@
+require "active_support"
+
+module ValidatesImmutability
+  extend ActiveSupport::Concern
+  
+  module ClassMethods
+    def immutable(options = {})
+      if options.key?(:on)
+        raise ArgumentError, "Unknown option :on"
+      end
+      options.merge!(:on => :update)
+      error_msg = options.delete(:message) || "Updates are not allowed."
+      validate options do
+        errors[:base] << error_msg if changed?
+      end
+    end
+  end
+end
+
+require "validates_immutability/version"
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::Base.send(:include, ValidatesImmutability)
+  require "validates_immutability/immutable_validator"
+end

data/lib/validates_immutability/immutable_validator.rb

@@ -0,0 +1,17 @@
+module ValidatesImmutability
+  class ImmutableValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      if options.key?(:on)
+        raise ArgumentError, "Unknown option :on"
+      end
+      return if record.new_record?
+      if record.send("#{attribute}_changed?")
+        record.errors.add(attribute, (options[:message] || "can't be modified"))
+      end
+    end
+  end
+end
+
+# ImmutableValidator needs to be in global scope to be recognized up by AR
+class ImmutableValidator < ValidatesImmutability::ImmutableValidator
+end

data/lib/validates_immutability/version.rb

@@ -0,0 +1,3 @@
+module ValidatesImmutability
+  VERSION = "1.0.0"
+end

data/spec/lib/validates_immutability/immutable_validator_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+class Widget4 < ActiveRecord::Base
+  set_table_name :widgets
+  validates :attr1, :immutable => true
+end
+
+describe Widget4, "validations" do
+  context "when persisted" do
+    subject { Widget4.create! }
+  
+    context "when attr1 is changed" do
+      before do
+        subject.attr1 = "changed"
+        subject.valid?
+        p subject.errors
+      end
+    
+      it { should be_invalid }
+      it { subject.errors.full_messages.should == ["Attr1 can't be modified"] }
+    end
+    
+    context "when attr1 is not changed" do
+      it { should be_valid }
+    end
+  end
+  
+  context "when new" do
+    subject { Widget4.new }
+    ["change", nil].each do |value|
+      context "when attr1 is #{value ? 'changed' : 'not changed'}" do
+        before { subject.attr1 = value if value }
+        it { should be_valid }
+      end
+    end
+  end
+end
+
+##################################################
+
+class Widget5 < ActiveRecord::Base
+  set_table_name :widgets
+  validates :attr1, :immutable => {:if => :validate_immutability}
+  attr_accessor :validate_immutability
+end
+
+describe Widget5, "validations" do
+  context "when persisted" do
+    subject { Widget5.create! }
+  
+    context "when attr1 is changed" do
+      before { subject.attr1 = "changed" }
+      
+      context "validate_immutability is true" do
+        before do
+          subject.validate_immutability = true
+          subject.valid?
+        end
+        it { should be_invalid }
+        it { subject.errors.full_messages.should == ["Attr1 can't be modified"] }
+      end
+      
+      context "validate_immutability is not true" do
+        before { subject.validate_immutability = false }
+        it { should be_valid }
+      end
+    end
+    
+    context "when attr1 is not changed" do
+      [true, false, nil].each do |value|
+        context "validate_immutability is #{value}" do
+          before { subject.validate_immutability = value }
+          it { should be_valid }
+        end
+      end
+    end
+  end
+  
+  context "when new" do
+    subject { Widget5.new }
+    
+    ["changed", nil].each do |value|
+      context "when attr1 is #{value ? 'changed' : 'not changed'}" do
+        before { subject.attr1 = value }
+        [true, false, nil].each do |value|
+          context "validate_immutability is #{value}" do
+            before { subject.validate_immutability = value }
+            it { should be_valid }
+          end
+        end
+      end
+    end
+  end
+end
+
+##################################################
+
+class Widget6 < ActiveRecord::Base
+  set_table_name :widgets
+  validates :attr1, :immutable => {:message => "is frozen!"}
+end
+
+describe Widget6, "validations" do
+  context "when persisted" do
+    subject { Widget6.create! }
+  
+    context "when attr1 is changed" do
+      before do
+        subject.attr1 = "changed"
+        subject.valid?
+      end
+    
+      it { should be_invalid }
+      it { subject.errors.full_messages.should == ["Attr1 is frozen!"] }
+    end
+    
+    context "when attr1 is not changed" do
+      it { should be_valid }
+    end
+  end
+  
+  context "when new" do
+    subject { Widget6.new }
+    ["change", nil].each do |value|
+      context "when attr1 is #{value ? 'changed' : 'not changed'}" do
+        before { subject.attr1 = value if value }
+        it { should be_valid }
+      end
+    end
+  end
+end

data/spec/lib/validates_immutability_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+class Widget1 < ActiveRecord::Base
+  set_table_name :widgets
+end
+
+describe Widget1, ".immutable" do
+  it "calls .validate" do
+    Widget1.should_receive(:validate).with(:a => 1, :b => 2, :on => :update)
+    Widget1.immutable(:a => 1, :b => 2, :message => 'some message')
+  end
+  
+  context "when :on is given" do
+    it "raises an ArgumentError" do
+      lambda do
+        Widget1.immutable(:on => :create)
+      end.should raise_error(ArgumentError, "Unknown option :on")
+    end
+  end
+end
+
+##################################################
+
+class Widget2 < ActiveRecord::Base
+  set_table_name :widgets
+  immutable :message => 'My message'
+end
+
+describe Widget2, "validations" do
+  context "when persisted" do
+    subject { Widget2.create! }
+  
+    context "when changed" do
+      before do
+        subject.attr1 = "changed"
+        subject.valid?
+      end
+    
+      it { should be_invalid }
+      it { subject.errors.full_messages.should == ['My message'] }
+    end
+    
+    context "when not changed" do
+      before { subject.valid? }
+      it { should be_valid }
+    end
+  end
+  
+  context "when new" do
+    subject { Widget2.new }
+    
+    context "when changed" do
+      before do
+        subject.attr1 = "changed"
+        subject.valid?
+      end      
+      it { should be_valid }
+    end
+    
+    context "when not changed" do
+      before { subject.valid? }
+      it { should be_valid }
+    end
+  end
+end
+
+##################################################
+
+class Widget3 < ActiveRecord::Base
+  set_table_name :widgets
+  immutable
+end
+
+describe Widget3, "validations" do
+  context "when persisted and changed" do
+    subject { Widget3.create! }
+    before do
+      subject.attr1 = "changed"
+      subject.valid?
+    end
+    
+    it { should_not be_valid }
+    it { subject.errors.full_messages.should == ["Updates are not allowed."] }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'validates_immutability'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :widgets, :force => true do |t|
+    t.string :attr1
+    t.string :attr2
+    t.string :attr3
+  end
+end

data/validates_immutability.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "validates_immutability/version"
+
+Gem::Specification.new do |s|
+  s.name        = "validates_immutability"
+  s.version     = ValidatesImmutability::VERSION
+  s.authors     = ["Austin Schneider"]
+  s.email       = ["soccer022483@gmail.com"]
+  s.homepage    = ""
+  s.summary     = "Validations for making ActiveRecord objects immutable."
+  s.description = "Validations for making ActiveRecord objects immutable."
+
+  s.rubyforge_project = "validates_immutability"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency "rspec", "~> 2.6.0"
+  s.add_development_dependency "sqlite3", "~> 1.3.3"
+  s.add_development_dependency "activerecord", "~> 3.0.0"
+  
+  s.add_dependency "activesupport", "~> 3.0.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: validates_immutability
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Austin Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id004
+description: Validations for making ActiveRecord objects immutable.
+email: 
+- soccer022483@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/validates_immutability.rb
+- lib/validates_immutability/immutable_validator.rb
+- lib/validates_immutability/version.rb
+- spec/lib/validates_immutability/immutable_validator_spec.rb
+- spec/lib/validates_immutability_spec.rb
+- spec/spec_helper.rb
+- validates_immutability.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: validates_immutability
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Validations for making ActiveRecord objects immutable.
+test_files: 
+- spec/lib/validates_immutability/immutable_validator_spec.rb
+- spec/lib/validates_immutability_spec.rb
+- spec/spec_helper.rb