acts_as_immutable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22f871d40f67984cf982e43abc6c47fa14a9deb57c68da8ecb811b0d78a8b9c9
+  data.tar.gz: 035126052b57c775b7826df690acbf195cde7c2e17bec7eb9aede1d5865e8f2a
+SHA512:
+  metadata.gz: b531bae10612dbb5e84be6ca6a4bb4d20dbf0345c5e543174bd0cbe3a181c24166a7b943f802137a68448b8789a26361279d394ff20ecec1f443a45a674375ba
+  data.tar.gz: 2a5aa95e5ad2844947ea45d6837b43b4bd4fcec3a5224cc44561b8383075bcd73d4535741c79f1143ad79238038da3dbe5b3b05301b266cf20277b4221d918e5

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tags
+*.swp

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - jruby-19mode
+  - rbx
+gemfile:
+  - gemfiles/active_record_32.gemfile
+  - gemfiles/active_record_42.gemfile
+# use Travis containers for faster builds
+sudo: false

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'sqlite3', :platforms => [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', :platforms => [:jruby]
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/README.md

@@ -0,0 +1,99 @@
+Acts As Immutable
+=================
+
+A Rails plugin that will ensure an ActiveRecord object is immutable once
+saved. Optionally, you can specify attributes to be mutable if the object
+is in a particular state (block evaluates to true).
+
+Authored by: NuLayer Inc. / www.nulayer.com
+
+
+Install
+-------
+```ruby
+gem 'acts_as_immutable', github:'Dealermade/acts_as_immutable'
+```
+
+Usage examples
+--------------
+
+Ex. 1 All attributes will be immutable
+```ruby
+class PaymentTransaction < ActiveRecord::Base
+	acts_as_immutable
+end
+```
+
+Ex. 2
+All attributes will be immutable except 'paid',
+ie. if the invoice is still outstanding
+```ruby
+class Invoice < ActiveRecord::Base
+	acts_as_immutable :paid do
+		paid == false
+	end
+end
+```
+
+Ex. 3
+Objects are immutable unless the subscription is
+active or free in which case changes can be made
+to: status, free and updated_at
+```ruby
+class Subscription < ActiveRecord::Base
+	acts_as_immutable :status, :free, :updated_at do
+		free? || active?
+	end
+
+	def active?
+		status == "active"
+	end
+end
+```
+
+```bash
+> sub = Subscription.new
+> sub.status = "active"
+> sub.free = false
+> sub.start_date = Time.now
+> sub.end_date = Time.now + 1.year
+> sub.save
+=> true
+> sub.start_date = Time.now + 1.week
+=> ActiveRecord::ActsAsImmutableError: start_date is an immutable attribute
+
+> sub.update_attributes({ :start_date => Time.now + 1.week })
+=> ActiveRecord::ActsAsImmutableError: start_date is an immutable attribute
+
+> sub.status = "cancelled"
+> sub.save
+=> true
+```
+
+Testing
+-------
+
+Tested on Rails 4.2.0. To run the tests, invoke `rake` or `guard`.
+
+
+License (MIT)
+-------------
+Copyright (c) 2009 NuLayer Inc.
+
+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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = true
+end
+
+task default: [:test]

data/acts_as_immutable.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_immutable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_immutable"
+  s.version     = ActsAsImmutable::VERSION
+  s.authors     = ["Simon Mathieu", "NuLayer Inc."]
+  s.email       = ["simon@pagerduty.com"]
+  s.homepage    = ""
+  s.summary     = %q{Immutable ActiveRecord models}
+  s.description = %q{A Rails plugin that will ensure an ActiveRecord object is immutable once
+saved. Optionally, you can specify attributes to be mutable if the object
+is in a particular state (block evaluates to true).}
+
+  s.rubyforge_project = "acts_as_immutable"
+
+  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 "rake"
+  s.add_development_dependency "activerecord", '4.2.0'
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-minitest"
+end

data/gemfiles/active_record_32.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.2.22', :require => 'active_record'
+
+gem 'sqlite3', :platforms => [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', :platforms => [:jruby]
+
+gemspec :path => '../'

data/gemfiles/active_record_42.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.2.5', :require => 'active_record'
+
+gem 'sqlite3', :platforms => [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', :platforms => [:jruby]
+
+gemspec :path => '../'

data/lib/acts_as_immutable.rb

@@ -0,0 +1,73 @@
+# +---------------------------------------------------------------------------+
+# | Acts As Immutable                                                         |
+# +---------------------------------------------------------------------------+
+# | A Rails plugin that will ensure an ActiveRecord object is immutable once  |
+# | saved. Optionally, you can specify attributes to be mutable if the object |
+# | is in a particular state (block evaluates to true).                       |
+# +---------------------------------------------------------------------------+
+# | Author: NuLayer Inc. / www.nulayer.com                                    |
+# +---------------------------------------------------------------------------+
+
+module ActsAsImmutable
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+    def mutable?
+      cond = self.class.mutable_condition
+      options = self.class.mutable_options
+      (options[:new_records_mutable] && new_record?) || (cond && instance_eval(&cond))
+    end
+
+    def immutable?
+      !mutable?
+    end
+
+  protected
+
+    def validate_immutability
+      changed_attrs = self.changes.keys.map(&:to_sym)
+      (changed_attrs - self.class.mutable_attributes).each do |attr|
+        if immutable?
+          self.errors.add(attr, "is immutable")
+        end
+      end
+    end
+
+    def validate_immutability_destroy
+      if immutable?
+        errors.add(:base, "Record is immutable")
+        false
+      else
+        true
+      end
+    end
+  end
+
+  module ClassMethods
+    def self.extended(base)
+      base.class_attribute :mutable_attributes
+      base.class_attribute :mutable_condition
+      base.class_attribute :mutable_options
+    end
+
+    def acts_as_immutable(*mutable_attributes, &condition)
+      options = {:new_records_mutable => true}
+      options.merge!(mutable_attributes.pop) if mutable_attributes.last.is_a?(Hash)
+      self.mutable_attributes = mutable_attributes
+      self.mutable_condition  = condition
+      self.mutable_options    = options
+
+      self.validate :validate_immutability
+      self.before_destroy :validate_immutability_destroy
+    end
+
+    def mutable_attributes
+      self.mutable_attributes || []
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsImmutable

data/lib/acts_as_immutable/version.rb

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

data/test/lib/test_acts_as_immutable.rb

@@ -0,0 +1,130 @@
+require 'test_helper'
+
+class ActsAsImmutableUsingVirtualField < MiniTest::Test
+  class Payment < ActiveRecord::Base
+    attr_accessor :record_locked
+
+    after_initialize :lock
+
+    acts_as_immutable(:status, :amount) do
+      !record_locked
+    end
+
+    def lock
+      self.record_locked = true
+    end
+  end
+
+  class Payment2 < ActiveRecord::Base
+    self.table_name = :payments
+
+    attr_accessor :record_locked
+
+    after_initialize :lock
+
+    acts_as_immutable do
+      !record_locked
+    end
+
+    def lock
+      self.record_locked = true
+    end
+  end
+
+  class PaymentLockOnNew < ActiveRecord::Base
+    self.table_name = :payments
+
+    attr_accessor :record_locked
+
+    after_initialize :lock
+
+    acts_as_immutable :new_records_mutable => false do
+      !record_locked
+    end
+
+    def lock
+      self.record_locked = true
+    end
+  end
+
+  def test_is_mutable
+    p = Payment.create!(:customer => "Valentin", :status => "success", :amount => 5.00)
+    refute p.mutable?
+    p.record_locked = false
+    assert p.mutable?
+  end
+
+  def test_is_immutable
+    p = Payment.create!(:customer => "Valentin", :status => "success", :amount => 5.00)
+    assert p.immutable?
+    p.record_locked = false
+    refute p.immutable?
+  end
+
+  def test_writing_attributes_without_white_list
+    p = Payment2.create!(:customer => "Valentin", :status => "success", :amount => 5.00)
+    p.customer = 'test'
+    assert_error_on p, :customer
+
+    p.record_locked = false
+    assert_no_error_on p, :customer
+  end
+
+  def test_writing_mutable_attributes
+    p = Payment.create!(:customer => "Valentin", :status => "success", :amount => 5.00)
+    p.status = 'fail'
+    assert_valid p
+  end
+
+  def test_destroy
+    p = Payment2.create!(:customer => "Valentin", :status => "success", :amount => 5.00)
+    assert_valid p
+    p.destroy
+    assert_not_nil p.errors.get(:base)
+    assert_not_nil Payment2.find_by_id(p.id)
+
+    p.record_locked = false
+    p.destroy
+    assert_nil Payment2.find_by_id(p.id)
+
+    p = Payment2.new(:customer => "Valentin", :status => "success", :amount => 5.00)
+    p.destroy
+  end
+
+  def test_new_records_should_be_mutable
+    assert Payment.new.mutable?
+  end
+
+  def test_new_records_with_lock_on_new_should_not_be_mutable
+    refute PaymentLockOnNew.new.mutable?
+    p = PaymentLockOnNew.new(:customer => "Valentin", :status => "success", :amount => 5.00)
+    refute p.valid?
+  end
+
+  def test_new_records_with_lock_on_new_should_be_mutable_if_condition_is_met
+    p = PaymentLockOnNew.new
+    p.record_locked = false
+    assert p.mutable?
+  end
+
+private
+
+  def assert_error_on(object, association)
+    object.valid?
+    assert_not_nil object.errors.get(association)
+  end
+
+  def assert_no_error_on(object, association)
+    object.valid?
+    assert_nil object.errors.get(association)
+  end
+
+  def assert_valid(object)
+    assert object.valid?, "#{object.errors.full_messages.to_sentence}"
+  end
+
+  def assert_not_nil(exp, msg = nil)
+    msg = message(msg) { "<#{mu_pp(exp)}> expected to not be nil" }
+    refute exp.nil?, msg
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+# require 'rails'
+# require 'rails/test_help'
+require 'active_record'
+require 'minitest/autorun'
+
+$: << 'lib'
+
+require 'acts_as_immutable'
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:")
+
+silence_stream(STDOUT) do
+  ActiveRecord::Schema.define do
+    create_table :payments, :force => true do |t|
+      t.string :customer
+      t.decimal :amount
+      t.string :status
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_immutable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Simon Mathieu
+- NuLayer Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  A Rails plugin that will ensure an ActiveRecord object is immutable once
+  saved. Optionally, you can specify attributes to be mutable if the object
+  is in a particular state (block evaluates to true).
+email:
+- simon@pagerduty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- acts_as_immutable.gemspec
+- gemfiles/active_record_32.gemfile
+- gemfiles/active_record_42.gemfile
+- lib/acts_as_immutable.rb
+- lib/acts_as_immutable/version.rb
+- test/lib/test_acts_as_immutable.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: acts_as_immutable
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Immutable ActiveRecord models
+test_files:
+- test/lib/test_acts_as_immutable.rb
+- test/test_helper.rb