rails_state_machine 2.1.1 → 3.0.0

data/Gemfile.7.0.pg.lock

@@ -1,75 +1,80 @@
 PATH
   remote: .
   specs:
-    rails_state_machine (2.1.1)
+    rails_state_machine (3.0.0)
       activerecord
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.0)
-      actionpack (= 7.0.0)
-      activesupport (= 7.0.0)
+    actioncable (7.0.1)
+      actionpack (= 7.0.1)
+      activesupport (= 7.0.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.0)
-      actionpack (= 7.0.0)
-      activejob (= 7.0.0)
-      activerecord (= 7.0.0)
-      activestorage (= 7.0.0)
-      activesupport (= 7.0.0)
+    actionmailbox (7.0.1)
+      actionpack (= 7.0.1)
+      activejob (= 7.0.1)
+      activerecord (= 7.0.1)
+      activestorage (= 7.0.1)
+      activesupport (= 7.0.1)
       mail (>= 2.7.1)
-    actionmailer (7.0.0)
-      actionpack (= 7.0.0)
-      actionview (= 7.0.0)
-      activejob (= 7.0.0)
-      activesupport (= 7.0.0)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.1)
+      actionpack (= 7.0.1)
+      actionview (= 7.0.1)
+      activejob (= 7.0.1)
+      activesupport (= 7.0.1)
       mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.0)
-      actionview (= 7.0.0)
-      activesupport (= 7.0.0)
+    actionpack (7.0.1)
+      actionview (= 7.0.1)
+      activesupport (= 7.0.1)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.0)
-      actionpack (= 7.0.0)
-      activerecord (= 7.0.0)
-      activestorage (= 7.0.0)
-      activesupport (= 7.0.0)
+    actiontext (7.0.1)
+      actionpack (= 7.0.1)
+      activerecord (= 7.0.1)
+      activestorage (= 7.0.1)
+      activesupport (= 7.0.1)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.0)
-      activesupport (= 7.0.0)
+    actionview (7.0.1)
+      activesupport (= 7.0.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.0)
-      activesupport (= 7.0.0)
+    activejob (7.0.1)
+      activesupport (= 7.0.1)
       globalid (>= 0.3.6)
-    activemodel (7.0.0)
-      activesupport (= 7.0.0)
-    activerecord (7.0.0)
-      activemodel (= 7.0.0)
-      activesupport (= 7.0.0)
-    activestorage (7.0.0)
-      actionpack (= 7.0.0)
-      activejob (= 7.0.0)
-      activerecord (= 7.0.0)
-      activesupport (= 7.0.0)
+    activemodel (7.0.1)
+      activesupport (= 7.0.1)
+    activerecord (7.0.1)
+      activemodel (= 7.0.1)
+      activesupport (= 7.0.1)
+    activestorage (7.0.1)
+      actionpack (= 7.0.1)
+      activejob (= 7.0.1)
+      activerecord (= 7.0.1)
+      activesupport (= 7.0.1)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.0)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     builder (3.2.4)
-    byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.2.2)
     crass (1.0.6)
     database_cleaner (2.0.1)
       database_cleaner-active_record (~> 2.0.0)
@@ -77,58 +82,74 @@ GEM
       activerecord (>= 5.a)
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
+    date (3.3.4)
     diff-lcs (1.4.4)
-    erubi (1.10.0)
-    gemika (0.6.1)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.8.11)
+    erubi (1.12.0)
+    gemika (0.8.2)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    loofah (2.13.0)
+    loofah (2.22.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
     marcel (1.0.2)
     method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.15.0)
-    nio4r (2.5.8)
-    nokogiri (1.12.5-x86_64-linux)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.20.0)
+    net-imap (0.3.7)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.15.5)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    pg (1.2.3)
-    pry (0.13.1)
+    nokogiri (1.15.5-x86_64-linux)
+      racc (~> 1.4)
+    pg (1.5.4)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (7.0.0)
-      actioncable (= 7.0.0)
-      actionmailbox (= 7.0.0)
-      actionmailer (= 7.0.0)
-      actionpack (= 7.0.0)
-      actiontext (= 7.0.0)
-      actionview (= 7.0.0)
-      activejob (= 7.0.0)
-      activemodel (= 7.0.0)
-      activerecord (= 7.0.0)
-      activestorage (= 7.0.0)
-      activesupport (= 7.0.0)
+    racc (1.7.3)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.1)
+      actioncable (= 7.0.1)
+      actionmailbox (= 7.0.1)
+      actionmailer (= 7.0.1)
+      actionpack (= 7.0.1)
+      actiontext (= 7.0.1)
+      actionview (= 7.0.1)
+      activejob (= 7.0.1)
+      activemodel (= 7.0.1)
+      activerecord (= 7.0.1)
+      activestorage (= 7.0.1)
+      activesupport (= 7.0.1)
       bundler (>= 1.15.0)
-      railties (= 7.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 7.0.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (7.0.0)
-      actionpack (= 7.0.0)
-      activesupport (= 7.0.0)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.1)
+      actionpack (= 7.0.1)
+      activesupport (= 7.0.1)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
@@ -147,25 +168,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    thor (1.1.0)
-    tzinfo (2.0.4)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.5)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.5.1)
+    zeitwerk (2.6.12)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
+  activerecord (= 7.0.1)
   database_cleaner
-  gemika
-  pg
-  pry-byebug
-  rails (~> 7.0.0)
+  gemika (>= 0.8.1)
+  pg (> 1.2.3)
+  pry
+  rails (= 7.0.1)
   rails_state_machine!
-  rake
+  rake (> 10.0)
   rspec (~> 3.5)
 
 BUNDLED WITH

data/Gemfile.lock

@@ -1 +1 @@
-Gemfile.5.1.pg.lock
+Gemfile.7.0.pg.lock

data/README.md

@@ -56,8 +56,8 @@ A model instance offers these state machine methods:
 - `<event_name>` call an event and transition into a new state. The record will be `save`d, if valid.
 - `<event_name>!` call an event and transition into a new state. Calls `save!` to save the record.
 - `may_<event_name>?` to find out if an event transition could be taken. Note that this will not validate if the model is valid afterwards.
-- `state_event=` to take a state event, but not save yet. Commonly used for forms where the controller takes a "state_event" param and saves.
-- `state_event` to get the name of the event that will be called
+- `<state_name>_event=` to set the event the record tries to call on save. If the event is invalid, an `:invalid` error on the `<state_name>_event` is set. Commonly used for forms where the controller takes a "<state_name>_event" param and saves.
+- `<state_name>_event` to get the name of the event that will be called
 
 Should you ever need to query the state machine for its states or events, it is accessible via `state_machine` class or instance methods on the model. See [`state_machine.rb`](https://github.com/makandra/rails_state_machine/blob/master/lib/rails_state_machine/state_machine.rb) for a list of available methods. This is mostly helpful in tests.
 
@@ -107,7 +107,7 @@ end
 
 To use a state attribute other than the default `state`, pass it to the `.state_machine` method:
 
-```
+```ruby
 state_machine :review_state do
   # ...
 end
@@ -116,13 +116,29 @@ end
 This also allows you to define multiple state machines on the same model. Note that event
 and state names still have to be unique for the whole model.
 
+If you define multiple state machines on the same model, and use state names more than once,
+you must use a prefix to avoid name collisions.
+
+A prefix may be specified by passing the `:prefix` option when declaring your state machine:
+
+```ruby
+state_machine :review_state, prefix: 'some_prefix' do
+  # ...
+end
+```
+
+Note: The `prefix` option is designed to apply only to constants and state methods **defined by the gem**.
+
+**State event names** are manually defined by the developer and thus not altered even if the `prefix` 
+option is used. It's advised to review them regarding potential naming collision and clarity when
+ introducing the `prefix` method.
 
 ## Taking multiple transitions
 
 You can safely take a second transition inside an after_save callback. All relevant
 callbacks will be run.
 
-```
+```ruby
 state_machine do
   state :draft, initial: true
   state :review_pending

data/bin/console

@@ -2,7 +2,7 @@
 
 require 'bundler/setup'
 require 'rails_state_machine'
-require 'pry-byebug'
+require 'pry'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/rails_state_machine/callbacks.rb

@@ -10,6 +10,7 @@ module RailsStateMachine
 
       def register_callbacks(model)
         model.class_eval do
+          before_validation :set_state_from_state_event, prepend: true
           before_validation :run_state_events_before_validation
           before_save :register_state_events_for_callbacks
           before_save { flush_state_event_callbacks(:before_save) }
@@ -25,6 +26,16 @@ module RailsStateMachine
       end
     end
 
+    def set_state_from_state_event
+      state_machine_state_managers.each do |state_manager|
+        next if state_manager.state_event.blank?
+
+        unless state_manager.transition_to(state_manager.state_event)
+          errors.add(:"#{state_manager.state_attribute}_event", :invalid)
+        end
+      end
+    end
+
     def run_state_events_before_validation
       # Since validations may be skipped, we will not register validation callbacks in @state_event_callbacks,
       # but call them explicitly when before_validation callbacks are triggered.

data/lib/rails_state_machine/model.rb

@@ -7,15 +7,15 @@ module RailsStateMachine
         extend ClassMethods
 
         cattr_accessor :state_machines
-        self.state_machines = {}
+        self.state_machines ||= {}
 
         delegate :state_machine, to: :class
       end
     end
 
     module ClassMethods
-      def state_machine(state_attribute = DEFAULT_STATE_ATTRIBUTE, &block)
-        state_machine = state_machines[state_attribute] ||= StateMachine.new(self, state_attribute)
+      def state_machine(state_attribute = DEFAULT_STATE_ATTRIBUTE, prefix: '', &block)
+        state_machine = state_machines[state_attribute] ||= StateMachine.new(self, state_attribute, prefix: prefix)
         if block
           include(Callbacks) unless self < Callbacks
           state_machine.configure(&block)

data/lib/rails_state_machine/state_machine.rb

@@ -1,24 +1,32 @@
 module RailsStateMachine
   class StateMachine
-    attr_reader :model
 
-    def initialize(model, state_attribute)
+    StateAlreadyDefinedError = Class.new(StandardError)
+
+    def initialize(model, state_attribute, prefix: '')
       @model = model
       @state_attribute = state_attribute
+      @prefix = prefix
+      @prefix_for_constant_definition = "#{@prefix.upcase}_" if @prefix.present?
+      @prefix_for_method_definition = "#{@prefix.downcase}_" if @prefix.present?
       @states_by_name = {}
       @events_by_name = {}
       build_model_module
     end
 
+    attr_reader :model, :prefix, :prefix_for_constant_definition, :prefix_for_method_definition, :state_attribute
+
     def configure(&block)
       instance_eval(&block)
 
+      check_if_states_already_defined
+
       define_state_methods
       define_state_constants
       register_initial_state
 
       define_event_methods
-      define_model_methods
+      define_attributes
     end
 
     def states
@@ -38,7 +46,7 @@ module RailsStateMachine
     end
 
     def find_event(name)
-      @events_by_name.fetch(name.to_sym)
+      @events_by_name[name.to_sym]
     end
 
     def has_state?(name)
@@ -74,11 +82,26 @@ module RailsStateMachine
       @model_module.module_eval(&block)
     end
 
+    def check_if_states_already_defined
+      @states_by_name.each do |state_name, _|
+        other_state_machines.each do |state_machine|
+          if state_machine.has_state?(state_name) && state_machine.prefix == prefix
+            raise StateAlreadyDefinedError, "State #{state_name.inspect} has already been defined in the #{state_machine.state_attribute.inspect} state machine. You may use the :prefix option when defining a state machine to avoid that."
+          end
+        end
+      end
+    end
+
+    def other_state_machines
+      model.state_machines.except(@state_attribute).values
+    end
+
     def define_state_methods
       state_attribute = @state_attribute
+      prefix = prefix_for_method_definition
       state_names.each do |state_name|
         model_module_eval do
-          define_method "#{state_name}?" do
+          define_method "#{prefix}#{state_name}?" do
             state_machine_state_manager(state_attribute).state == state_name.to_s
           end
         end
@@ -87,7 +110,7 @@ module RailsStateMachine
 
     def define_state_constants
       state_names.each do |state_name|
-        model_constant("STATE_#{state_name.upcase}", state_name)
+        model_constant("#{@prefix_for_constant_definition}STATE_#{state_name.upcase}", state_name)
       end
     end
 
@@ -125,17 +148,11 @@ module RailsStateMachine
       end
     end
 
-    def define_model_methods
+    def define_attributes
       state_attribute = @state_attribute
 
-      model_module_eval do
-        define_method :"#{state_attribute}_event=" do |event_name|
-          state_machine_state_manager(state_attribute).transition_to(event_name)
-        end
-
-        define_method :"#{state_attribute}_event" do
-          state_machine_state_manager(state_attribute).next_event&.name
-        end
+      @model.instance_eval do
+        attribute :"#{state_attribute}_event", :string
       end
     end
   end

data/lib/rails_state_machine/state_manager.rb

@@ -1,6 +1,7 @@
 module RailsStateMachine
   class StateManager
     attr_accessor :next_event, :state_before_state_event
+    attr_reader :state_attribute
 
     def initialize(record, state_machine, state_attribute)
       @record = record
@@ -21,7 +22,10 @@ module RailsStateMachine
     end
 
     def revert
-      self.state = @state_before_state_event if @next_event
+      if @next_event
+        self.state = @state_before_state_event
+        self.state_event = @next_event.name
+      end
     end
 
     def source_state
@@ -32,16 +36,30 @@ module RailsStateMachine
       end
     end
 
-    def transition_to(event_name)
-      @next_event = @state_machine.find_event(event_name)
-      @state_before_state_event = source_state
+    def state_event
+      @record.public_send(:"#{@state_machine.state_attribute}_event")
+    end
 
-      # If the event can not transition from source_state, a TransitionNotFoundError will be raised
-      self.state = @next_event.future_state_name(source_state).to_s
+    def state_event=(value)
+      @record.public_send(:"#{@state_machine.state_attribute}_event=", value)
     end
 
     def transition_allowed_for?(event_name)
-      @state_machine.find_event(event_name).allowed_from?(source_state)
+      !!@state_machine.find_event(event_name)&.allowed_from?(state)
+    end
+
+    def transition_to(event_name)
+      if transition_allowed_for?(event_name)
+        self.state_before_state_event = source_state
+        event = @state_machine.find_event(event_name)
+        self.state = event.future_state_name(state).to_s
+        self.state_event = nil
+        @next_event = event
+
+        true
+      else
+        false
+      end
     end
   end
 end

data/lib/rails_state_machine/version.rb

@@ -1,3 +1,3 @@
 module RailsStateMachine
-  VERSION = '2.1.1'
+  VERSION = '3.0.0'
 end

data/rails_state_machine.gemspec

@@ -26,5 +26,4 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'pry-byebug', '~> 3.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_state_machine
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Arne Hartherz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -53,20 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
 description: ActiveRecord-bound state machine
 email:
 - arne.hartherz@makandra.de
@@ -80,8 +66,6 @@ files:
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.5.1.pg
-- Gemfile.5.1.pg.lock
 - Gemfile.5.2.pg
 - Gemfile.5.2.pg.lock
 - Gemfile.6.0.pg
@@ -126,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.4.14
 signing_key: 
 specification_version: 4
 summary: ActiveRecord-bound state machine

data/Gemfile.5.1.pg

@@ -1,15 +0,0 @@
-source 'https://rubygems.org'
-
-# Runtime dependencies
-gem 'rails', '~>5.1.0'
-gem 'pg'
-
-# Development dependencies
-gem 'rspec', '~>3.5'
-gem 'rake'
-gem 'pry-byebug'
-gem 'gemika'
-gem 'database_cleaner'
-
-# Gem under test
-gem 'rails_state_machine', :path => '.'