Merge pull request #39 from state-machines/remove_outdated

seuros · web-flow · commit 865e3e2e42ef · 2025-03-19T15:12:33.000Z
feat: remove EOL version of ruby and rails
diff --git a/.github/workflows/engines.yml b/.github/workflows/engines.yml
@@ -13,9 +13,6 @@ jobs:
       matrix:
         ruby-version: ['jruby', 'truffleruby']
         gemfiles:
-          - gemfiles/active_model_6.0.gemfile
-          - gemfiles/active_model_6.1.gemfile
-          - gemfiles/active_model_7.0.gemfile
           - gemfiles/active_model_7.1.gemfile
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfiles }}
diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
@@ -11,16 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+        ruby-version: ['3.2', '3.3', '3.4']
         gemfiles:
-          - gemfiles/active_model_6.0.gemfile
-          - gemfiles/active_model_6.1.gemfile
-          - gemfiles/active_model_7.0.gemfile
           - gemfiles/active_model_7.1.gemfile
+          - gemfiles/active_model_7.2.gemfile
+          - gemfiles/active_model_8.0.gemfile
           - gemfiles/active_model_edge.gemfile
-        exclude:
-          - ruby-version: '3.0'
-            gemfiles: gemfiles/active_model_edge.gemfile
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfiles }}
     steps:
diff --git a/Appraisals b/Appraisals
@@ -1,18 +1,14 @@
 # ActiveModel integrations
-appraise 'active_model_6.0' do
-  gem 'activemodel', '~> 6.0.3'
-end
-
-appraise 'active_model_6.1' do
-  gem 'activemodel', '~> 6.1.3'
+appraise 'active_model_7.1' do
+  gem 'activemodel', '~> 7.1.0'
 end
 
-appraise 'active_model_7.0' do
-  gem 'activemodel', '~> 7.0.0'
+appraise 'active_model_7.2' do
+  gem 'activemodel', '~> 7.2.0'
 end
 
-appraise 'active_model_7.1' do
-  gem 'activemodel', '~> 7.1.0'
+appraise 'active_model_8.0' do
+  gem 'activemodel', '~> 8.0.0'
 end
 
 appraise 'active_model_edge' do
diff --git a/Gemfile b/Gemfile
@@ -4,5 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 platforms :mri do
-  gem 'pry-byebug'
+  gem 'debug'
 end
+
+gem 'mutex_m'
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Or install it yourself as:
 
 ## Dependencies
 
-Active Model 6.0+
+Active Model 7.1+
 
 ## Usage
 
diff --git a/gemfiles/active_model_7.0.gemfile b/gemfiles/active_model_7.0.gemfile
diff --git a/gemfiles/active_model_7.1.gemfile b/gemfiles/active_model_7.1.gemfile
@@ -5,7 +5,7 @@ source "https://rubygems.org"
 gem "activemodel", "~> 7.1.0"
 
 platforms :mri do
-  gem "pry-byebug"
+  gem "debug"
 end
 
 gemspec path: "../"
diff --git a/gemfiles/active_model_7.2.gemfile b/gemfiles/active_model_7.2.gemfile
@@ -2,10 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "activemodel", "~> 6.0.3"
+gem "activemodel", "~> 7.2.0"
 
 platforms :mri do
-  gem "pry-byebug"
+  gem "debug"
 end
 
 gemspec path: "../"
diff --git a/gemfiles/active_model_8.0.gemfile b/gemfiles/active_model_8.0.gemfile
@@ -2,10 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "activemodel", "~> 6.1.3"
+gem "activemodel", "~> 8.0.0"
 
 platforms :mri do
-  gem "pry-byebug"
+  gem "debug"
 end
 
 gemspec path: "../"
diff --git a/gemfiles/active_model_edge.gemfile b/gemfiles/active_model_edge.gemfile
@@ -5,7 +5,7 @@ source "https://rubygems.org"
 gem "activemodel", github: "rails/rails", branch: "main"
 
 platforms :mri do
-  gem "pry-byebug"
+  gem "debug"
 end
 
 gemspec path: "../"
diff --git a/lib/state_machines/integrations/active_model.rb b/lib/state_machines/integrations/active_model.rb
@@ -25,9 +25,9 @@ module Integrations #:nodoc:
     #     attr_accessor :state
     #     define_attribute_methods [:state]
     #
-    #     state_machine :initial => :parked do
+    #     state_machine initial: :parked do
     #       event :ignite do
-    #         transition :parked => :idling
+    #         transition parked: :idling
     #       end
     #     end
     #   end
@@ -45,7 +45,7 @@ module Integrations #:nodoc:
     #     include ActiveModel::Validations
     #     attr_accessor :state
     #
-    #     state_machine :action => :save do
+    #     state_machine action: :save do
     #       ...
     #     end
     #
@@ -115,38 +115,44 @@ module Integrations #:nodoc:
     # Beware that public event attributes mean that events can be fired
     # whenever mass-assignment is being used.  If you want to prevent malicious
     # users from tampering with events through URLs / forms, the attribute
-    # should be protected like so:
+    # should be protected using Strong Parameters in your controllers:
     #
     #   class Vehicle
-    #     include ActiveModel::MassAssignmentSecurity
     #     attr_accessor :state
     #
-    #     attr_protected :state_event
-    #     # attr_accessible ... # Alternative technique
-    #
     #     state_machine do
     #       ...
     #     end
     #   end
     #
+    #   # In your controller
+    #   def vehicle_params
+    #     params.require(:vehicle).permit(:attribute1, :attribute2) # Exclude :state_event
+    #   end
+    #
     # If you want to only have *some* events be able to fire via mass-assignment,
-    # you can build two state machines (one public and one protected) like so:
+    # you can build two state machines (one private and one public) like so:
     #
     #   class Vehicle
     #     attr_accessor :state
     #
-    #     attr_protected :state_event # Prevent access to events in the first machine
-    #
     #     state_machine do
     #       # Define private events here
     #     end
     #
     #     # Public machine targets the same state as the private machine
-    #     state_machine :public_state, :attribute => :state do
+    #     state_machine :public_state, attribute: :state do
     #       # Define public events here
     #     end
     #   end
     #
+    #   # In your controller
+    #   def vehicle_params
+    #     # Only permit events from the public state machine
+    #     params.require(:vehicle).permit(:attribute1, :attribute2, :public_state_event)
+    #     # The private state_event is not permitted
+    #   end
+    #
     # == Callbacks
     #
     # All before/after transition callbacks defined for ActiveModel models
@@ -159,7 +165,7 @@ module Integrations #:nodoc:
     #     include ActiveModel::Validations
     #     attr_accessor :state
     #
-    #     state_machine :initial => :parked do
+    #     state_machine initial: :parked do
     #       before_transition any => :idling do |vehicle|
     #         vehicle.put_on_seatbelt
     #       end
@@ -169,7 +175,7 @@ module Integrations #:nodoc:
     #       end
     #
     #       event :ignite do
-    #         transition :parked => :idling
+    #         transition parked: :idling
     #       end
     #     end
     #
@@ -181,64 +187,6 @@ module Integrations #:nodoc:
     # Note, also, that the transition can be accessed by simply defining
     # additional arguments in the callback block.
     #
-    # == Observers
-    #
-    # In order to hook in observer support for your application, the
-    # ActiveModel::Observing feature must be included.  This can be added by including the
-    # https://github.com/state-machines/state_machines-activemodel-observers gem in your 
-    # Gemfile. Because of the way
-    # ActiveModel observers are designed, there is less flexibility around the
-    # specific transitions that can be hooked in.  However, a large number of
-    # hooks *are* supported.  For example, if a transition for a object's
-    # +state+ attribute changes the state from +parked+ to +idling+ via the
-    # +ignite+ event, the following observer methods are supported:
-    # * before/after/after_failure_to-_ignite_from_parked_to_idling
-    # * before/after/after_failure_to-_ignite_from_parked
-    # * before/after/after_failure_to-_ignite_to_idling
-    # * before/after/after_failure_to-_ignite
-    # * before/after/after_failure_to-_transition_state_from_parked_to_idling
-    # * before/after/after_failure_to-_transition_state_from_parked
-    # * before/after/after_failure_to-_transition_state_to_idling
-    # * before/after/after_failure_to-_transition_state
-    # * before/after/after_failure_to-_transition
-    #
-    # The following class shows an example of some of these hooks:
-    #
-    #   class VehicleObserver < ActiveModel::Observer
-    #     # Callback for :ignite event *before* the transition is performed
-    #     def before_ignite(vehicle, transition)
-    #       # log message
-    #     end
-    #
-    #     # Callback for :ignite event *after* the transition has been performed
-    #     def after_ignite(vehicle, transition)
-    #       # put on seatbelt
-    #     end
-    #
-    #     # Generic transition callback *before* the transition is performed
-    #     def after_transition(vehicle, transition)
-    #       Audit.log(vehicle, transition)
-    #     end
-    #
-    #     def after_failure_to_transition(vehicle, transition)
-    #       Audit.error(vehicle, transition)
-    #     end
-    #   end
-    #
-    # More flexible transition callbacks can be defined directly within the
-    # model as described in StateMachine::Machine#before_transition
-    # and StateMachine::Machine#after_transition.
-    #
-    # To define a single observer for multiple state machines:
-    #
-    #   class StateMachineObserver < ActiveModel::Observer
-    #     observe Vehicle, Switch, Project
-    #
-    #     def after_transition(object, transition)
-    #       Audit.log(object, transition)
-    #     end
-    #   end
-    #
     # == Internationalization
     #
     # Any error message that is generated from performing invalid transitions
@@ -308,9 +256,9 @@ module Integrations #:nodoc:
     #     include ActiveModel::Dirty
     #     attr_accessor :state
     #
-    #     state_machine :initial => :parked do
+    #     state_machine initial: :parked do
     #       event :park do
-    #         transition :parked => :parked, ...
+    #         transition parked: :parked, ...
     #       end
     #     end
     #   end
@@ -322,7 +270,7 @@ module Integrations #:nodoc:
     #
     #   class Vehicle
     #     ...
-    #     state_machine :initial => :parked do
+    #     state_machine initial: :parked do
     #       before_transition all => same do |vehicle|
     #         vehicle.state_will_change!
     #
@@ -344,7 +292,7 @@ module Integrations #:nodoc:
     #   module StateMachine::Integrations::MyORM
     #     include ActiveModel
     #
-    #     mattr_accessor(:defaults) { :action => :persist }
+    #     mattr_accessor(:defaults) { action: :persist }
     #
     #     def self.matches?(klass)
     #       defined?(::MyORM::Base) && klass <= ::MyORM::Base
diff --git a/state_machines-activemodel.gemspec b/state_machines-activemodel.gemspec
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.glob('{lib}/**/*') + %w(LICENSE.txt README.md)
   spec.test_files    = Dir.glob('test/**/{*_test,test_*}.rb')
   spec.require_paths = ['lib']
-  spec.required_ruby_version     = '>= 3.0.0'
+  spec.required_ruby_version     = '>= 3.1.0' # jruby is still outdated
   spec.add_dependency 'state_machines', '>= 0.6.0'
   spec.add_dependency 'activemodel', '>= 6.0'
 
diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -1,7 +1,4 @@
-begin
-  require 'pry-byebug'
-rescue LoadError
-end
+require 'debug'
 
 require 'state_machines-activemodel'
 require 'minitest/autorun'
@@ -17,9 +14,9 @@ def new_model(&block)
     # Simple ActiveModel superclass
     parent = Class.new do
       def self.model_attribute(name)
-        define_method(name) { instance_variable_defined?("@#{name}") ? instance_variable_get("@#{name}") : nil }
+        define_method(name) { instance_variable_defined?(:"@#{name}") ? instance_variable_get(:"@#{name}") : nil }
         define_method("#{name}=") do |value|
-          send("#{name}_will_change!") if self.class <= ActiveModel::Dirty && value != send(name)
+          send(:"#{name}_will_change!") if self.class <= ActiveModel::Dirty && value != send(name)
           instance_variable_set("@#{name}", value)
         end
       end
