Initial commit, 1.0.0 version

.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.11.2

CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kiril Dokh
+
+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.

README.md

@@ -0,0 +1,48 @@
+# ImmutabilityValidator
+
+This gem brings immutability validation to your `Rails` project. Let's say you want to describe your model from business
+perspective when you really don't want to allow to change the persisted state of some field during mutation methods like
+(`save`, `update`, `update!` etc). This is kind of different from `readony: true` option which silently ignore the
+updating process, the main goal of this gem is to let end user know about such a stuff with provided error message.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'immutability_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install immutability_validator
+
+## Usage
+
+Just add the next line in your model:
+
+`validates :my_field, immutability: true`
+
+Or use a shorthand:
+
+`validates_immutability_of :my_field`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/immutability_validator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'immutability_validator'
+
+require 'irb'
+IRB.start

bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

immutability_validator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'immutability_validator'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Kiril Dokh']
+  spec.email         = ['[email protected]']
+
+  spec.summary       = 'Immutability validation'
+  spec.description   = 'This gem provides immutability validation. This is different from `readonly: true` stuff' \
+                       ' because it sets the error.'
+  spec.homepage      = 'https://github.com/dsounded/immutability_validator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('activemodel', '>= 0')
+  spec.add_dependency('i18n', '>= 0.1.0')
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+end

lib/immutability_validator.rb

@@ -0,0 +1,16 @@
+require 'active_model'
+require 'i18n'
+
+class ImmutabilityValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, _)
+    return if record.new_record?
+
+    record.errors.add(attribute, options[:message] || I18n.t('.activerecord.errors.base.immutability')) if record.attribute_changed?(attribute)
+  end
+end
+
+module ClassMethods
+  def validates_immutability_of(*attr_names)
+    validates_with ImmutabilityValidator, _merge_attributes(attr_names)
+  end
+end

spec/immutability_validator_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe ImmutabilityValidator do
+  let(:immutableNameClass) do
+    Class.new(TestModel) do
+      validates :name, immutability: true
+    end
+  end
+
+  let(:immutableNameClassWithMessage) do
+    Class.new(TestModel) do
+      validates :name, immutability: { message: 'dont change!' }
+    end
+  end
+
+  describe 'immutability: true' do
+    let(:object) { immutableNameClass.new(name: 'old_name') }
+
+    context 'already persisted' do
+      before do
+        allow(object).to receive(:new_record?).and_return false
+        allow(I18n).to receive(:t).with('.activerecord.errors.base.immutability').and_return 'cannot be changed'
+      end
+
+      it 'does not allow to change the name' do
+        object.name = 'new_name'
+
+        expect(object).to be_invalid
+        expect(object.errors[:name]).to include 'cannot be changed'
+      end
+
+      context 'with custom message' do
+        let(:object) { immutableNameClassWithMessage.new(name: 'old_name') }
+
+        it 'does not allow to change the name' do
+          object.name = 'new_name'
+
+          expect(object).to be_invalid
+          expect(object.errors[:name]).to include 'dont change!'
+        end
+      end
+
+      context 'same new_name' do
+        it 'allows to change the name' do
+          object.name = 'old_name'
+
+          expect(object).to be_valid
+        end
+      end
+    end
+
+    context 'not persisted' do
+      before { allow(object).to receive(:new_record?).and_return true }
+
+      it 'allows to change the name' do
+        object.name = 'new_name'
+
+        expect(object).to be_valid
+      end
+    end
+  end
+
+  describe 'validates_immutability_of' do
+    let(:immutableNameClassViaShorthand) do
+      Class.new(TestModel) do
+        validates_immutability_of :name
+      end
+    end
+
+    describe 'immutability: true' do
+      let(:object) { immutableNameClassViaShorthand.new(name: 'old_name') }
+
+      context 'already persisted' do
+        before do
+          allow(object).to receive(:new_record?).and_return false
+          allow(I18n).to receive(:t).with('.activerecord.errors.base.immutability').and_return 'cannot be changed'
+        end
+
+        it 'does not allow to change the name(works with shorthand)' do
+          object.name = 'new_name'
+
+          expect(object).to be_invalid
+          expect(object.errors[:name]).to include 'cannot be changed'
+        end
+      end
+    end
+  end
+end

spec/spec_helper.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'immutability_validator'
+
+require 'rubygems'
+require 'rspec'
+require 'active_model'
+
+class TestModel
+  include ActiveModel::Validations
+  include ActiveModel::Dirty
+
+  define_attribute_methods :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, 'test')
+  end
+
+  attr_reader :name
+
+  def initialize(attributes = {})
+    @attributes = attributes
+    @name = attributes.fetch(:name)
+  end
+
+  def name=(val)
+    name_will_change! unless val == @name
+    @name = val
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+
+  def save
+    changes_applied
+  end
+
+  def reload!
+    clear_changes_information
+  end
+
+  def rollback!
+    restore_attributes
+  end
+end