attribute_guard 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa71cf702b0f01ded796adf8ba3f215d024cf7a7947d633450213266df33cd74
-  data.tar.gz: 96bb1d220b952c302e9c749378be645c47fa66f49a0860d8b110ce49d2d1f0cb
+  metadata.gz: 88ec907e7391560c5a2690875407a3caa1ba387c6b52896d222d17964babcec9
+  data.tar.gz: 909244a8bc6e31c80574f27923e88f76b94e7a16720c75878b1ab83bf2b560f0
 SHA512:
-  metadata.gz: 574fcacc35b3a9c4029999e6e9a8c89ae8d35c1f22e6187ebafbea27079e0f812a23bbf93fb42ccd667f570fa3060fba6f3bdc6e2fc1a3411bccb4066345710e
-  data.tar.gz: f3b1df97332fdfeed565332fb0be50a53811e95d3661ee0ca1988406ffe690e9cca734a2b6a136d4eacaddf2b995cf9d6c8eaa18d1647aa52ce39e6d96606c49
+  metadata.gz: d00b0a3d6cee7b7cf3aa246129214dad28218536284a6d411aebd718711aed7f381921a6d5db196e02a89e9377f902fc096440efef218d93f3e94ed99f0e09bb
+  data.tar.gz: 0a378c08a53d9b858581739ccdcec49a06d75ec1df1dd49681ea50a979d848abebe16a6087cbe669048c69dd714ba665e50fd835978b6c6b974943b217cf0756

data/CHANGELOG.md

@@ -4,6 +4,19 @@ 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

data/README.md

@@ -126,7 +126,7 @@ 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
@@ -140,6 +140,10 @@ end
 
 * `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.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/attribute_guard.gemspec

@@ -9,6 +9,12 @@ Gem::Specification.new do |spec|
   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,7 +35,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.6"
 
   spec.add_dependency "activemodel", ">= 5.2"
 

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"
@@ -50,7 +52,7 @@ module AttributeGuard
   end
 
   module Initializer
-    def initialize(*)
+    def initialize(*args, **kwargs)
       @unlocked_attributes = nil
       super
     end
@@ -65,8 +67,9 @@ module AttributeGuard
 
       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
             log_warning(record, attribute)
@@ -110,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)
 
@@ -140,7 +147,7 @@ module AttributeGuard
   # @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
 
@@ -154,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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: attribute_guard
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -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,15 +64,14 @@ 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/ActiveModel extension that allows locking attributes to prevent
   unintended updates.