validates_unchangeable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12c950dd86c8a0f40865568800414af94ed6a4b09d0d38f422f4586640512156
+  data.tar.gz: fc6eaf7ac254fef11f412176c1b8582473bdec79d7f203dc8d990f591875e93b
+SHA512:
+  metadata.gz: 760409153dd7f2b49d46d0d26dfb4fe9ccd6697c3fb0c00705d9851ffba4a8c4c27f2dca5ece5fbb0bb771e1fb401dc8bf1eef736728b404fc13a4fa0748bb7d
+  data.tar.gz: 18eef940a95472ea9fa802385d91060b1b11dae3ab06b44e2bd6eeccaf89990286ec6aa38d9076c39453095eb4bfdacda787ab4d2f5a2cdc9fa53038edd45186

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+
+# rspec failure tracking
+.rspec_status
+.ruby-gemset
+.ruby-version
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in validates_unchangeable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    validates_unchangeable (0.1.0)
+      activemodel (>= 5.0, < 7.0)
+      i18n
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    regexp_parser (1.8.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.93.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 5.0, < 7.0)
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (> 0.90)
+  sqlite3 (> 0)
+  validates_unchangeable!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Vital Ryabchinskiy
+
+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/README.md

@@ -0,0 +1,86 @@
+# Validates Unchangeable
+
+This gem adds the capability of validating unchangeable attributes to ActiveRecord and ActiveModel.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validates_unchangeable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validates_unchangeable
+
+## Usage
+
+### With ActiveRecord
+
+```ruby
+class User < ActiveRecord::Base
+  validates :email, unchangeable: true
+end
+```
+
+### With ActiveModel
+```ruby
+class User
+  include ActiveModel::Dirty
+  include ActiveModel::Validations
+
+  define_attribute_methods :email
+  attr_reader :email
+
+  validates :email, unchangeable: true
+
+  def self.create(attributes = {})
+    new(attributes).tap(&:save)
+  end
+
+  def initialize(attributes = {})
+    @email = attributes[:email]
+  end
+
+  def value=(val)
+    value_will_change! unless val == @email
+    @email = val
+  end
+
+  def save
+    changes_applied
+  end
+end
+````
+
+### With RSpec
+Require the matcher in `spec_helper.rb` or `rails_helper.rb`:
+
+```ruby
+require 'validates_unchangeable/rspec_matcher'
+```
+
+In your spec:
+
+```ruby
+describe User
+  it { is_expected.to validate_unchangeable_of(:email) }
+end
+```
+
+### I18n
+The default error message `cannot be changed`.
+You can pass the `message: "my custom error"` option to your validation to define your own, custom message.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/validates_unchangeable. 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](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'validates_unchangeable'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/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

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      unchangeable: cannot be changed

data/lib/validates_unchangeable.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'active_support/i18n'
+require 'validates_unchangeable/version'
+require 'validates_unchangeable/active_model'
+
+I18n.load_path += Dir["#{File.dirname(__FILE__)}/../config/locales/*.yml"]
+
+module ValidatesUnchangeable
+end

data/lib/validates_unchangeable/active_model.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module ActiveModel
+  module Validations
+    class UnchangeableValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, _value)
+        return if !record.public_send("#{attribute}_changed?") || record.public_send("#{attribute}_was").nil?
+
+        record.errors.add(attribute, :unchangeable)
+      end
+    end
+  end
+end

data/lib/validates_unchangeable/rspec_matcher.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :validate_unchangeable_of do |attribute|
+  match do
+    actual = subject.is_a?(Class) ? subject.new : subject
+    actual.public_send(:"#{attribute}=", 'qwerty')
+    actual.save(validate: false)
+    actual.public_send(:"#{attribute}=", 'ytrewq')
+    expect(actual).to be_invalid
+    @expected_message ||= I18n.t('errors.messages.unchangeable')
+    expect(actual.errors.messages[attribute.to_sym]).to include(@expected_message)
+  end
+  chain :with_message do |message|
+    @expected_message = message
+  end
+end

data/lib/validates_unchangeable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ValidatesUnchangeable
+  VERSION = '0.1.0'
+end

data/validates_unchangeable.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validates_unchangeable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'validates_unchangeable'
+  spec.version       = ValidatesUnchangeable::VERSION
+  spec.authors       = ['Vital Ryabchinskiy']
+  spec.email         = ['vital.ryabchinskiy@gmail.com']
+
+  spec.summary       = 'Library for validating unchangeable attributes.'
+  spec.description   = 'Library for validating unchangeable attributes.'
+  spec.homepage      = 'https://github.com/vitalinfo/validates_unchangeable'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4')
+
+  spec.add_development_dependency 'activerecord', '>= 5.0', '< 7.0'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '> 0.90'
+  spec.add_development_dependency 'sqlite3', '> 0'
+  spec.add_dependency 'activemodel', '>= 5.0', '< 7.0'
+  spec.add_dependency 'i18n'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: validates_unchangeable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vital Ryabchinskiy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library for validating unchangeable attributes.
+email:
+- vital.ryabchinskiy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- lib/validates_unchangeable.rb
+- lib/validates_unchangeable/active_model.rb
+- lib/validates_unchangeable/rspec_matcher.rb
+- lib/validates_unchangeable/version.rb
+- validates_unchangeable.gemspec
+homepage: https://github.com/vitalinfo/validates_unchangeable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vitalinfo/validates_unchangeable
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Library for validating unchangeable attributes.
+test_files: []