state_machines-activerecord 0.10.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5e8b447b65a1f99ad367425556a3e726b3f42be5056af03a2a48e741851ff72
-  data.tar.gz: 801a7943d18a71f506acefedb764cb8ed0a9caa1c459893df99f3b21419c78f7
+  metadata.gz: cc3a76fe2fa39848f7ae9b5fc71c1fed9fae206a6cc0b0e24184415cdb760f1f
+  data.tar.gz: c8152e14110e863e478ec0dde3bac1a15e3cf15578deaae94e5f44062f1f67e8
 SHA512:
-  metadata.gz: c6794e0f3d9e6835682f4a541bb8bde8210599749621c262ed164bae482c78f3ec40aa6cc4279db5ed62583bd5d2f30476f43f49f5adc149ac80eb9df20ee487
-  data.tar.gz: 0fc0b42cc6de4c17f4a844634647dd0e0245933c6a713cf51e68655b4354e03801b0a6b63e61c1e27298a1db56ae8559a605972e2a6ef3cc879f32f75691c3b6
+  metadata.gz: 982b654eb9d38edbe29bbaf2ca4f85980781575592813a4450e46cd4fbe1928f30ecc88e578aa4d879fcfb973109688fd90c942bb2a4e857420e5d94db14a602
+  data.tar.gz: ed2fae5f320b5f860beeca7c390e4674fd693b7ca171176a61f13e937039091cdd173a520438c1737e9ff4e2b936c91e89973ed64033635877cfcd04f4f13397

data/README.md

@@ -2,9 +2,14 @@
 
 # StateMachines Active Record Integration
 
-The Active Record 5.1+ integration adds support for database transactions, automatically
+The Active Record 7.2+ integration adds support for database transactions, automatically
 saving the record, named scopes, validation errors.
 
+## Requirements
+
+- Ruby 3.2+
+- Rails 7.2+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -63,6 +68,15 @@ Vehicle.with_state(:parked)                         # also plural #with_states
 Vehicle.without_states(:first_gear, :second_gear)   # also singular #without_state
 ```
 
+#### Transparent Scopes
+State scopes will return all records when `nil` is passed, making them perfect for search filters:
+
+```ruby
+Vehicle.with_state(nil)                            # Returns all vehicles
+Vehicle.with_state(params[:state])                 # Returns all vehicles if params[:state] is nil
+Vehicle.where(color: 'red').with_state(nil)        # Returns all red vehicles (chainable)
+```
+
 ### State driven validations
 
 As mentioned in `StateMachines::Machine#state`, you can define behaviors,

data/lib/state_machines/integrations/active_record/locale.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
+# Use lazy evaluation to avoid circular dependencies with frozen default_messages
+# This ensures messages can be updated after gem loading while maintaining thread safety
 { en: {
-    activerecord: {
-        errors: {
-            messages: {
-                invalid: StateMachines::Machine.default_messages[:invalid],
-                invalid_event: StateMachines::Machine.default_messages[:invalid_event] % ['%{state}'],
-                invalid_transition: StateMachines::Machine.default_messages[:invalid_transition] % ['%{event}']
-            }
-        }
+  activerecord: {
+    errors: {
+      messages: {
+        invalid: ->(*) { StateMachines::Machine.default_messages[:invalid] },
+        invalid_event: ->(*) { format(StateMachines::Machine.default_messages[:invalid_event], '%<state>s') },
+        invalid_transition: ->(*) { format(StateMachines::Machine.default_messages[:invalid_transition], '%<event>s') }
+      }
     }
+  }
 } }
-

data/lib/state_machines/integrations/active_record/version.rb

@@ -3,7 +3,7 @@
 module StateMachines
   module Integrations
     module ActiveRecord
-      VERSION = '0.10.0'
+      VERSION = '0.40.0'
     end
   end
 end

data/lib/state_machines/integrations/active_record.rb

@@ -3,7 +3,7 @@ require 'active_record'
 require 'state_machines/integrations/active_record/version'
 
 module StateMachines
-  module Integrations #:nodoc:
+  module Integrations # :nodoc:
     # Adds support for integrating state machines with ActiveRecord models.
     #
     # == Examples
@@ -207,10 +207,10 @@ module StateMachines
     #
     #   class Vehicle < ApplicationRecord
     #     # with_states also aliased to with_state
-    #     scope :with_states, ->(states) { where(state: states) }
+    #     scope :with_states, ->(states) { states.present? ? where(state: states) : all }
     #
     #     # without_states also aliased to without_state
-    #     scope :without_states, ->(states) { where.not(state: states) }
+    #     scope :without_states, ->(states) { states.present? ? where.not(state: states) : all }
     #   end
     #
     # *Note*, however, that the states are converted to their stored values
@@ -226,6 +226,15 @@ module StateMachines
     #
     #   Vehicle.with_state('parked')
     #
+    # === Transparent Scopes
+    #
+    # When `nil` is passed to any of the state scopes, they return `all` records
+    # without applying any filters. This allows for more flexible scope chaining
+    # in search interfaces:
+    #
+    #   Vehicle.with_state(params[:state])  # Returns all vehicles if params[:state] is nil
+    #   Vehicle.where(color: 'red').with_state(nil)  # Returns all red vehicles
+    #
     # == Callbacks
     #
     # All before/after transition callbacks defined for ActiveRecord models
@@ -358,7 +367,7 @@ module StateMachines
       include ActiveModel
 
       # The default options to use for state machines using this integration
-      @defaults = {:action => :save, use_transactions: true}
+      @defaults = { action: :save, use_transactions: true }
       class << self
         # Classes that inherit from ActiveRecord::Base will automatically use
         # the ActiveRecord integration.
@@ -376,28 +385,29 @@ module StateMachines
 
       # Gets the db default for the machine's attribute
       def owner_class_attribute_default
-        if owner_class.connected? && owner_class.table_exists?
-          owner_class.column_defaults[attribute.to_s]
-        end
+        return unless owner_class.connected? && owner_class.table_exists?
+
+        owner_class.column_defaults[attribute.to_s]
       end
 
       def define_state_initializer
-        define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+        define_helper :instance, <<-END_EVAL, __FILE__, __LINE__ + 1
           def initialize(attributes = nil, *)
             super(attributes) do |*args|
-              scoped_attributes = (attributes || {}).merge(self.class.scope_attributes)
+              attributes = (attributes || {}).transform_keys { |key| self.class.attribute_aliases[key.to_s] || key }
+              scoped_attributes = attributes.merge(self.class.scope_attributes)
 
               self.class.state_machines.initialize_states(self, {}, scoped_attributes)
               yield(*args) if block_given?
             end
           end
-        end_eval
+        END_EVAL
       end
 
       # Uses around callbacks to run state events if using the :save hook
       def define_action_hook
         if action_hook == :save
-          define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+          define_helper :instance, <<-END_EVAL, __FILE__, __LINE__ + 1
               def save(*, **)
                 self.class.state_machine(#{name.inspect}).send(:around_save, self) { super }
               end
@@ -410,34 +420,43 @@ module StateMachines
               def changed_for_autosave?
                 super || self.class.state_machines.any? {|name, machine| machine.action == :save && machine.read(self, :event)}
               end
-          end_eval
+          END_EVAL
         else
           super
         end
       end
 
       # Runs state events around the machine's :save action
-      def around_save(object)
-        object.class.state_machines.transitions(object, action).perform { yield }
+      def around_save(object, &)
+        object.class.state_machines.transitions(object, action).perform(&)
       end
 
       # Creates a scope for finding records *with* a particular state or
       # states for the attribute
       def create_with_scope(name)
-        create_scope(name, ->(values) { ["#{attribute_column} IN (?)", values] })
+        attr_name = attribute
+        lambda do |klass, values|
+          if values.present?
+            klass.where(attr_name => values)
+          else
+            klass.all
+          end
+        end
       end
 
       # Creates a scope for finding records *without* a particular state or
       # states for the attribute
       def create_without_scope(name)
-        create_scope(name, ->(values) { ["#{attribute_column} NOT IN (?)", values] })
+        attr_name = attribute
+        lambda do |klass, values|
+          if values.present?
+            klass.where.not(attr_name => values)
+          else
+            klass.all
+          end
+        end
       end
 
-      # Generates the fully-qualifed column name for this machine's attribute
-      def attribute_column
-        connection = owner_class.connection
-        "#{connection.quote_table_name(owner_class.table_name)}.#{connection.quote_column_name(attribute)}"
-      end
 
       # Runs a new database transaction, rolling back any changes by raising
       # an ActiveRecord::Rollback exception if the yielded block fails
@@ -456,17 +475,19 @@ module StateMachines
 
       private
 
-        # Defines a new scope with the given name
-        def create_scope(name, scope)
-          lambda { |model, values| model.where(scope.call(values)) }
-        end
 
-        # ActiveModel's use of method_missing / respond_to for attribute methods
-        # breaks both ancestor lookups and defined?(super).  Need to special-case
-        # the existence of query attribute methods.
-        def owner_class_ancestor_has_method?(scope, method)
-          scope == :instance && method == "#{attribute}?" ? owner_class : super
-        end
+      # Generates the results for the given scope based on one or more states to filter by
+      def run_scope(scope, machine, klass, states)
+        values = states.flatten.compact.map { |state| machine.states.fetch(state).value }
+        scope.call(klass, values)
+      end
+
+      # ActiveModel's use of method_missing / respond_to for attribute methods
+      # breaks both ancestor lookups and defined?(super).  Need to special-case
+      # the existence of query attribute methods.
+      def owner_class_ancestor_has_method?(scope, method)
+        scope == :instance && method == "#{attribute}?" ? owner_class : super
+      end
     end
     register(ActiveRecord)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.40.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -11,103 +11,103 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: state_machines-activemodel
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '7.2'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: state_machines-activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 5.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 5.4.0
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 description: Adds support for creating state machines for attributes on ActiveRecord
 email:
 - terminale@gmail.com
@@ -122,62 +122,11 @@ files:
 - lib/state_machines/integrations/active_record.rb
 - lib/state_machines/integrations/active_record/locale.rb
 - lib/state_machines/integrations/active_record/version.rb
-- test/files/en.yml
-- test/files/models/post.rb
-- test/integration_test.rb
-- test/machine_by_default_test.rb
-- test/machine_errors_test.rb
-- test/machine_multiple_test.rb
-- test/machine_nested_action_test.rb
-- test/machine_unmigrated_test.rb
-- test/machine_with_aliased_attribute_test.rb
-- test/machine_with_callbacks_test.rb
-- test/machine_with_column_state_attribute_test.rb
-- test/machine_with_complex_pluralization_scopes_test.rb
-- test/machine_with_conflicting_predicate_test.rb
-- test/machine_with_conflicting_state_name_test.rb
-- test/machine_with_custom_attribute_test.rb
-- test/machine_with_default_scope_test.rb
-- test/machine_with_different_column_default_test.rb
-- test/machine_with_different_integer_column_default_test.rb
-- test/machine_with_dirty_attribute_and_custom_attributes_during_loopback_test.rb
-- test/machine_with_dirty_attribute_and_state_events_test.rb
-- test/machine_with_dirty_attributes_and_custom_attribute_test.rb
-- test/machine_with_dirty_attributes_during_loopback_test.rb
-- test/machine_with_dirty_attributes_test.rb
-- test/machine_with_dynamic_initial_state_test.rb
-- test/machine_with_event_attributes_on_autosave_test.rb
-- test/machine_with_event_attributes_on_custom_action_test.rb
-- test/machine_with_event_attributes_on_save_bang_test.rb
-- test/machine_with_event_attributes_on_save_test.rb
-- test/machine_with_event_attributes_on_validation_test.rb
-- test/machine_with_events_test.rb
-- test/machine_with_failed_action_test.rb
-- test/machine_with_failed_after_callbacks_test.rb
-- test/machine_with_failed_before_callbacks_test.rb
-- test/machine_with_initialized_state_test.rb
-- test/machine_with_internationalization_test.rb
-- test/machine_with_loopback_test.rb
-- test/machine_with_non_column_state_attribute_defined_test.rb
-- test/machine_with_same_column_default_test.rb
-- test/machine_with_same_integer_column_default_test.rb
-- test/machine_with_scopes_and_joins_test.rb
-- test/machine_with_scopes_and_owner_subclass_test.rb
-- test/machine_with_scopes_test.rb
-- test/machine_with_state_driven_validations_test.rb
-- test/machine_with_states_test.rb
-- test/machine_with_static_initial_state_test.rb
-- test/machine_with_transactions_test.rb
-- test/machine_with_validations_and_custom_attribute_test.rb
-- test/machine_with_validations_test.rb
-- test/machine_without_database_test.rb
-- test/machine_without_transactions_test.rb
-- test/model_test.rb
-- test/test_helper.rb
 homepage: https://github.com/state-machines/state_machines-activerecord/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -185,66 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: State machines Active Record Integration
-test_files:
-- test/files/en.yml
-- test/files/models/post.rb
-- test/integration_test.rb
-- test/machine_by_default_test.rb
-- test/machine_errors_test.rb
-- test/machine_multiple_test.rb
-- test/machine_nested_action_test.rb
-- test/machine_unmigrated_test.rb
-- test/machine_with_aliased_attribute_test.rb
-- test/machine_with_callbacks_test.rb
-- test/machine_with_column_state_attribute_test.rb
-- test/machine_with_complex_pluralization_scopes_test.rb
-- test/machine_with_conflicting_predicate_test.rb
-- test/machine_with_conflicting_state_name_test.rb
-- test/machine_with_custom_attribute_test.rb
-- test/machine_with_default_scope_test.rb
-- test/machine_with_different_column_default_test.rb
-- test/machine_with_different_integer_column_default_test.rb
-- test/machine_with_dirty_attribute_and_custom_attributes_during_loopback_test.rb
-- test/machine_with_dirty_attribute_and_state_events_test.rb
-- test/machine_with_dirty_attributes_and_custom_attribute_test.rb
-- test/machine_with_dirty_attributes_during_loopback_test.rb
-- test/machine_with_dirty_attributes_test.rb
-- test/machine_with_dynamic_initial_state_test.rb
-- test/machine_with_event_attributes_on_autosave_test.rb
-- test/machine_with_event_attributes_on_custom_action_test.rb
-- test/machine_with_event_attributes_on_save_bang_test.rb
-- test/machine_with_event_attributes_on_save_test.rb
-- test/machine_with_event_attributes_on_validation_test.rb
-- test/machine_with_events_test.rb
-- test/machine_with_failed_action_test.rb
-- test/machine_with_failed_after_callbacks_test.rb
-- test/machine_with_failed_before_callbacks_test.rb
-- test/machine_with_initialized_state_test.rb
-- test/machine_with_internationalization_test.rb
-- test/machine_with_loopback_test.rb
-- test/machine_with_non_column_state_attribute_defined_test.rb
-- test/machine_with_same_column_default_test.rb
-- test/machine_with_same_integer_column_default_test.rb
-- test/machine_with_scopes_and_joins_test.rb
-- test/machine_with_scopes_and_owner_subclass_test.rb
-- test/machine_with_scopes_test.rb
-- test/machine_with_state_driven_validations_test.rb
-- test/machine_with_states_test.rb
-- test/machine_with_static_initial_state_test.rb
-- test/machine_with_transactions_test.rb
-- test/machine_with_validations_and_custom_attribute_test.rb
-- test/machine_with_validations_test.rb
-- test/machine_without_database_test.rb
-- test/machine_without_transactions_test.rb
-- test/model_test.rb
-- test/test_helper.rb
+test_files: []

data/test/files/en.yml

@@ -1,5 +0,0 @@
-en:
-  activerecord:
-    errors:
-      messages:
-        invalid_transition: "cannot transition"

data/test/files/models/post.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-ActiveRecord::Base.connection.create_table(:posts, :force => true) do |t|
-  t.string :title
-  t.string :content
-  t.string :state
-end
-
-class Post < ActiveRecord::Base
-  state_machine initial: :draft do
-
-  end
-end

data/test/integration_test.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test_helper'
-
-class IntegrationTest < BaseTestCase
-  def test_should_have_an_integration_name
-    assert_equal :active_record, StateMachines::Integrations::ActiveRecord.integration_name
-  end
-
-  def test_should_be_before_activemodel
-    integrations = StateMachines::Integrations.list.to_a
-    assert StateMachines::Integrations::ActiveRecord, integrations.first
-    assert StateMachines::Integrations::ActiveModel, integrations.last
-  end
-
-  def test_should_match_if_class_inherits_from_active_record
-    assert StateMachines::Integrations::ActiveRecord.matches?(new_model)
-  end
-
-  def test_should_not_match_if_class_does_not_inherit_from_active_record
-    refute StateMachines::Integrations::ActiveRecord.matches?(Class.new)
-  end
-
-  def test_should_have_defaults
-    assert_equal({action: :save, use_transactions: true}, StateMachines::Integrations::ActiveRecord.defaults)
-  end
-end

data/test/machine_by_default_test.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test_helper'
-
-class MachineByDefaultTest < BaseTestCase
-  def setup
-    @model = new_model
-    @machine = StateMachines::Machine.new(@model)
-  end
-
-  def test_should_use_save_as_action
-    assert_equal :save, @machine.action
-  end
-
-  def test_should_use_transactions
-    assert_equal true, @machine.use_transactions
-  end
-end

data/test/machine_errors_test.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test_helper'
-
-class MachineErrorsTest < BaseTestCase
-  def setup
-    @model = new_model
-    @machine = StateMachines::Machine.new(@model)
-    @record = @model.new
-  end
-
-  def test_should_be_able_to_describe_current_errors
-    @record.errors.add(:id, 'cannot be blank')
-    @record.errors.add(:state, 'is invalid')
-    assert_equal ['Id cannot be blank', 'State is invalid'], @machine.errors_for(@record).split(', ').sort
-  end
-
-  def test_should_describe_as_halted_with_no_errors
-    assert_equal 'Transition halted', @machine.errors_for(@record)
-  end
-end

data/test/machine_multiple_test.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test_helper'
-
-class MachineMultipleTest < BaseTestCase
-  def setup
-    @model = new_model do
-      connection.add_column table_name, :status, :string
-    end
-    @state_machine = StateMachines::Machine.new(@model, :initial => :parked)
-    @status_machine = StateMachines::Machine.new(@model, :status, :initial => :idling)
-  end
-
-  def test_should_should_initialize_each_state
-    record = @model.new
-    assert_equal 'parked', record.state
-    assert_equal 'idling', record.status
-  end
-end

data/test/machine_nested_action_test.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'test_helper'
-
-class MachineNestedActionTest < BaseTestCase
-  def setup
-    @callbacks = []
-
-    @model = new_model
-    @machine = StateMachines::Machine.new(@model)
-    @machine.event :ignite do
-      transition :parked => :idling
-    end
-
-    @record = @model.new(:state => 'parked')
-  end
-
-  def test_should_allow_transition_prior_to_creation_if_skipping_action
-    record = @record
-    @model.before_create { record.ignite(false) }
-    result = @record.save
-
-    assert_equal true, result
-    assert_equal "idling", @record.state
-    @record.reload
-    assert_equal "idling", @record.state
-  end
-
-  def test_should_allow_transition_after_creation
-    record = @record
-    @model.after_create { record.ignite }
-    result = @record.save
-
-    assert_equal true, result
-    assert_equal "idling", @record.state
-    @record.reload
-    assert_equal "idling", @record.state
-  end
-end
-