attribute_guard 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00ca78d9fb2f442ce8c5d58b0950e6ae2406e7317cc0060b572083d85705b247
-  data.tar.gz: 447523ace443fcdeeb1312ea118e2c39dc0e8195cecb5e647aed1f70f4cb0c41
+  metadata.gz: 88ec907e7391560c5a2690875407a3caa1ba387c6b52896d222d17964babcec9
+  data.tar.gz: 909244a8bc6e31c80574f27923e88f76b94e7a16720c75878b1ab83bf2b560f0
 SHA512:
-  metadata.gz: d4c1f7e90bb839de650cf4f272c6269106136bd03e91f86674bd73b9d00c3da76ec43741b8389c57d4fc9cef5d505e27ced1e548e823941b34e89048a583fee6
-  data.tar.gz: 11a93fe37a9db10b1de8e41e511f06d80abbc4cbe2670f193f6d7208cd9247218f6245c9d696aef716da9e55e5a26fd24e1a4a4112cb4f634620df66972d3413
+  metadata.gz: d00b0a3d6cee7b7cf3aa246129214dad28218536284a6d411aebd718711aed7f381921a6d5db196e02a89e9377f902fc096440efef218d93f3e94ed99f0e09bb
+  data.tar.gz: 0a378c08a53d9b858581739ccdcec49a06d75ec1df1dd49681ea50a979d848abebe16a6087cbe669048c69dd714ba665e50fd835978b6c6b974943b217cf0756

data/CHANGELOG.md

@@ -4,6 +4,29 @@ 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.1.1
+
+### Fixed
+
+- Fixed keyword arguments not being forwarded through the prepended constructor, which raised an `ArgumentError` when including `AttributeGuard` in a class whose `initialize` method takes keyword arguments.
+- `unlock_attributes` now returns the record when called with an empty attribute list instead of `nil` so method chaining works as documented.
+- Unlocked attributes are no longer shared between a record and its `dup` or `clone`; unlocking attributes on a copy no longer unlocks them on the original.
+- `lock_attributes` now raises an `ArgumentError` if an invalid mode is specified instead of silently treating it as `:error`.
+
+### Changed
+
+- Minimum required Ruby version is now 2.6.
+
+## 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

data/README.md

@@ -3,8 +3,9 @@
 [![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.
 
@@ -118,24 +119,35 @@ 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
   include AttributeGuard
 
   lock_attributes :email, mode: :error
-  lock_attributes :name: mode: :warn
+  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.
 
+### Thread Safety
+
+Unlocked attributes are tracked per model instance. Like ActiveRecord models in general, individual record instances are not thread safe, so you should not share a record between threads while unlocking attributes on it.
+
+### 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.1
+1.1.1

data/attribute_guard.gemspec

@@ -4,11 +4,17 @@ 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"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # 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.
   ignore_files = %w[
@@ -29,9 +35,9 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.6"
 
-  spec.add_dependency "activerecord", ">= 5.0"
+  spec.add_dependency "activemodel", ">= 5.2"
 
   spec.add_development_dependency "bundler"
 end

data/lib/attribute_guard.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "set"
+
 require "active_support/concern"
 require "active_support/lazy_load_hooks"
 require "active_model/validator"
@@ -36,6 +38,9 @@ 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=
@@ -47,7 +52,7 @@ module AttributeGuard
   end
 
   module Initializer
-    def initialize(*)
+    def initialize(*args, **kwargs)
       @unlocked_attributes = nil
       super
     end
@@ -56,13 +61,20 @@ module AttributeGuard
   # 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?
 
+      changes = record.changes
       record.class.send(:locked_attributes).each do |attribute, params|
-        if record.changes.include?(attribute) && record.attribute_locked?(attribute)
+        if 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
@@ -71,6 +83,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
@@ -86,6 +113,10 @@ module AttributeGuard
     # @param mode [Symbol, Proc] mode to use when a locked attribute is changed
     # @return [void]
     def lock_attributes(*attributes, error: :locked, mode: :error)
+      unless mode == :error || mode == :warn || mode == :raise || mode.respond_to?(:call)
+        raise ArgumentError.new("Invalid mode: #{mode.inspect}")
+      end
+
       locked = locked_attributes.dup
       error = error.dup.freeze if error.is_a?(String)
 
@@ -113,10 +144,10 @@ 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?
+    return self if attributes.empty?
 
     @unlocked_attributes ||= Set.new
 
@@ -130,7 +161,7 @@ module AttributeGuard
         clear_unlocked_attributes if @unlocked_attributes.empty?
       end
     else
-      @unlocked_attributes.merge(attributes)
+      @unlocked_attributes = @unlocked_attributes.dup.merge(attributes)
     end
 
     self

metadata

@@ -1,29 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: attribute_guard
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-11 00:00:00.000000000 Z
+date: 1980-01-02 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
@@ -38,7 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -55,8 +53,10 @@ files:
 homepage: https://github.com/bdurand/attribute_guard
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/bdurand/attribute_guard
+  source_code_uri: https://github.com/bdurand/attribute_guard
+  changelog_uri: https://github.com/bdurand/attribute_guard/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -64,16 +64,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
-signing_key:
+rubygems_version: 4.0.3
 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: []