attribute_guard 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a485b9e0bc322539e0ac6b7014eb40824c4d94227fc216fab8add8a4f7a201fe
-  data.tar.gz: 792be937f2a9c6a611773d99c7e9f42c84546e3d1693046a4b7d3ab7b06d7097
+  metadata.gz: fa71cf702b0f01ded796adf8ba3f215d024cf7a7947d633450213266df33cd74
+  data.tar.gz: 96bb1d220b952c302e9c749378be645c47fa66f49a0860d8b110ce49d2d1f0cb
 SHA512:
-  metadata.gz: 36e1b736350dba0238b811205629d6dd4e3b15ef12a60084cb56f78104d90e0cf1b2df797ef555e352e023678d7f838302a583769e876f967a4e9fa5d5306452
-  data.tar.gz: d961953fc003bfcbada924c84a07b24aaacbca72d1d14c06d1d148ef76d5fb0926a4ecac6999758a63761c85873bdabcf5d76c1eebfda1285cd299ef3ecf6a69
+  metadata.gz: 574fcacc35b3a9c4029999e6e9a8c89ae8d35c1f22e6187ebafbea27079e0f812a23bbf93fb42ccd667f570fa3060fba6f3bdc6e2fc1a3411bccb4066345710e
+  data.tar.gz: f3b1df97332fdfeed565332fb0be50a53811e95d3661ee0ca1988406ffe690e9cca734a2b6a136d4eacaddf2b995cf9d6c8eaa18d1647aa52ce39e6d96606c49

data/CHANGELOG.md

@@ -4,7 +4,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 1.0.0 (unreleased)
+## 1.1.0
+
+### Added
+
+- Added :raise mode that raises an error if a locked attribute has been changed instead of adding a validation error.
+
+### Changed
+
+- Changed gem dependency from `activerecord` to `activemodel`. You can now use locked attributes with ActiveModel classes that include `ActiveModel::Validations` and `ActiveModel::Dirty and implement a `new_record?` method.
+
+## 1.0.1
+
+### Added
+- Optimize object shapes for the Ruby interpreter by declaring instance variables in constructors.
+
+## 1.0.0
 
 ### Added
 - Initial release.

data/README.md

@@ -1,9 +1,11 @@
 # Active Record Attribute Guard
 
 [![Continuous Integration](https://github.com/bdurand/attribute_guard/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/attribute_guard/actions/workflows/continuous_integration.yml)
+[![Regression Test](https://github.com/bdurand/attribute_guard/actions/workflows/regression_test.yml/badge.svg)](https://github.com/bdurand/attribute_guard/actions/workflows/regression_test.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/attribute_guard.svg)](https://badge.fury.io/rb/attribute_guard)
 
-This Ruby gem provides an extension for ActiveRecord allowing you to declare certain attributes in a model to be locked. Locked attributes cannot be changed once a record is created unless you explicitly allow changes.
+This Ruby gem provides an extension for ActiveRecord/ActiveModel allowing you to declare certain attributes in a model to be locked. Locked attributes cannot be changed once a record is created unless you explicitly allow changes.
 
 This feature can be used for a couple of different purposes.
 
@@ -117,7 +119,7 @@ record.update!(status: "canceled") # raises ActiveRecord::RecordInvalid error
 
 ### Modes
 
-The default behavior when a locked attribute is changed is to add a validation error to the record. You can change this behavior with the `mode` option when locking attributes.
+The default behavior when a locked attribute is changed is to add a validation error to the record. You can change this behavior with the `mode` option when locking attributes. You still need to validate the record to trigger the locked attribute check, regardless of the mode.
 
 ```ruby
 class MyModel
@@ -125,16 +127,23 @@ class MyModel
 
   lock_attributes :email, mode: :error
   lock_attributes :name: mode: :warn
+  lock_attributes :updated_at, mode: :raise
   lock_attributes :created_at, mode: ->(record, attribute) { raise "Created timestamp cannot be changed" }
 end
 ```
 
 * `:error` - Add a validation error to the record. This is the default.
 
-* `:warn` - Log a warning that the record was changed. This mode is useful to allow you soft deploy locked attributes to production on a mature project and give you information about where you may need to update code to unlock attributes.
+* `:warn` - Log a warning that the record was changed. This mode is useful to allow you soft deploy locked attributes to production on a mature project and give you information about where you may need to update code to unlock attributes. If the model does not have a `logger` method that returns a `Logger`-like object, then the output will be sent to `STDERR`.
+
+* `:raise` = Raise an `AttributeGuard::LockedAttributeError` error.
 
 * `Proc` - If you provide a `Proc` object, it will be called with the record and the attribute name when a locked attribute is changed.
 
+### Using with ActiveModel
+
+The gem works out of the box with ActiveRecord. You can also use it with ActiveModel classes as long as they include the `ActiveModel::Validations` and `ActiveModel::Dirty` modules. The model also needs to implement a `new_record?` method.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/attribute_guard.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Brian Durand"]
   spec.email = ["bbdurand@gmail.com"]
 
-  spec.summary = "ActiveRecord extension that allows locking attributes to prevent unintended updates."
+  spec.summary = "ActiveRecord/ActiveModel extension that allows locking attributes to prevent unintended updates."
 
   spec.homepage = "https://github.com/bdurand/attribute_guard"
   spec.license = "MIT"
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.5"
 
-  spec.add_dependency "activerecord", ">= 5.0"
+  spec.add_dependency "activemodel", ">= 5.2"
 
   spec.add_development_dependency "bundler"
 end

data/lib/attribute_guard.rb

@@ -36,24 +36,42 @@ end
 module AttributeGuard
   extend ActiveSupport::Concern
 
+  class LockedAttributeError < StandardError
+  end
+
   included do
     class_attribute :locked_attributes, default: {}, instance_accessor: false
     private_class_method :locked_attributes=
     private_class_method :locked_attributes
 
     validates_with LockedAttributesValidator
+
+    prepend Initializer
+  end
+
+  module Initializer
+    def initialize(*)
+      @unlocked_attributes = nil
+      super
+    end
   end
 
   # Validator that checks for changes to locked attributes.
   class LockedAttributesValidator < ActiveModel::Validator
     def validate(record)
+      unless record.respond_to?(:new_record?)
+        raise "AttributeGuard can only be used with models that respond to :new_record?"
+      end
+
       return if record.new_record?
 
       record.class.send(:locked_attributes).each do |attribute, params|
         if record.changes.include?(attribute) && record.attribute_locked?(attribute)
           message, mode = params
           if mode == :warn
-            record&.logger&.warn("Changed locked attribute #{attribute} on #{record.class.name} with id #{record.id}")
+            log_warning(record, attribute)
+          elsif mode == :raise
+            raise LockedAttributeError.new(error_message(record, attribute))
           elsif mode.is_a?(Proc)
             mode.call(record, attribute)
           else
@@ -62,6 +80,21 @@ module AttributeGuard
         end
       end
     end
+
+    private
+
+    def error_message(record, attribute)
+      "Changed locked attribute #{attribute} on #{record.class.name} with id #{record.id}"
+    end
+
+    def log_warning(record, attribute)
+      message = error_message(record, attribute)
+      if record.respond_to?(:logger) && record.logger.respond_to?(:warn)
+        record.logger.warn(message)
+      else
+        warn(message)
+      end
+    end
   end
 
   module ClassMethods
@@ -104,12 +137,13 @@ module AttributeGuard
   #   user.unlock_attributes(:email).update!(email: "user@example.com")
   #
   # @param attributes [Array<Symbol, String>] the attributes to unlock
-  # @return [ActiveRecord::Base] the object itself
+  # @return [Object] the object itself
   def unlock_attributes(*attributes)
     attributes = attributes.flatten.map(&:to_s)
     return if attributes.empty?
 
     @unlocked_attributes ||= Set.new
+
     if block_given?
       save_val = @unlocked_attributes
       begin
@@ -136,19 +170,15 @@ module AttributeGuard
     attribute = attribute.to_s
     return false unless self.class.send(:locked_attributes).include?(attribute)
 
-    if defined?(@unlocked_attributes)
-      !@unlocked_attributes.include?(attribute.to_s)
-    else
-      true
-    end
+    return true if @unlocked_attributes.nil?
+
+    !@unlocked_attributes.include?(attribute.to_s)
   end
 
   # Clears any unlocked attributes.
   #
   # @return [void]
   def clear_unlocked_attributes
-    if defined?(@unlocked_attributes)
-      remove_instance_variable(:@unlocked_attributes)
-    end
+    @unlocked_attributes = nil
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: attribute_guard
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-28 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,6 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: ActiveRecord extension that allows locking attributes to prevent unintended
-  updates.
+summary: ActiveRecord/ActiveModel extension that allows locking attributes to prevent
+  unintended updates.
 test_files: []