rails_state_machine 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f378f574778d4689103d41b8b77a264ae1480ace89753c5cf33015dda494f296
-  data.tar.gz: 0dec14e494125c3a7282e5629849c6322cc5404fa744ee5a6847256b1c00bc63
+  metadata.gz: f07991f6a0bc2dab134bc8518199885d79d0ee49d1865043a5e805e71c04b2b8
+  data.tar.gz: b4d3ba7b43eaed7a95522df3b385147f6feefbfac8a7b9dd7c49c6089731d037
 SHA512:
-  metadata.gz: 0b6b13a387e5ecebd6a9b6d301652df68b2bd5e95514491729e521e7efbc28ecce1752aacc667395974a211bf2aa2e3f0883126eea8dc1bbcd3b827e5d13e442
-  data.tar.gz: ed790b2722a425566cc9d02d074cf3b20d296b1524579839af8678519b8e59c2fdb7ddd1546d225258d843b96f0a0dcfa443d09fca0cb400cd0f35c3e644f184
+  metadata.gz: 1a5c81c9136fc6181974e7de5cd4a664f481c965098f39af45a3998b5cc3f29c9a46e0e983d5ca2cb724915505143c09643b93ade5a6bf3d47590af6ab716147
+  data.tar.gz: af45d14e32f278bc0a4e1d1dc76b9f7863300e178d87b032f7217c7aa4df1987740a5fb895b055058b6fb7fb1ca4e08cc3021c2d6b2bafc62c44ac1f15f23d94

data/CHANGELOG.md

@@ -10,6 +10,14 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ### Breaking changes
 
 
+## 2.2.0 2023-12-06
+
+### Compatible changes
+
+- Added: State machine can now use the `:prefix` option to avoid name collision if you define multiple state machines
+  on the same model, and use state names more than once
+- Fix bug where additional inclusions of `RailsStateMachine::Model` would reset previous defined state machines
+
 ## 2.1.1 2022-03-16
 
 ### Compatible changes

data/Gemfile

@@ -1 +1 @@
-Gemfile.5.1.pg
+./Gemfile.5.1.pg

data/Gemfile.5.1.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_state_machine (2.1.1)
+    rails_state_machine (2.2.0)
       activerecord
 
 GEM
@@ -146,4 +146,4 @@ DEPENDENCIES
   rspec (~> 3.5)
 
 BUNDLED WITH
-   2.2.3
+   2.3.0

data/Gemfile.5.2.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_state_machine (2.1.1)
+    rails_state_machine (2.2.0)
       activerecord
 
 GEM
@@ -156,4 +156,4 @@ DEPENDENCIES
   rspec (~> 3.5)
 
 BUNDLED WITH
-   2.2.15
+   2.3.0

data/Gemfile.6.0.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_state_machine (2.1.1)
+    rails_state_machine (2.2.0)
       activerecord
 
 GEM
@@ -172,4 +172,4 @@ DEPENDENCIES
   rspec (~> 3.5)
 
 BUNDLED WITH
-   2.1.4
+   2.3.0

data/Gemfile.6.1.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_state_machine (2.1.1)
+    rails_state_machine (2.2.0)
       activerecord
 
 GEM

data/Gemfile.7.0.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_state_machine (2.1.1)
+    rails_state_machine (2.2.0)
       activerecord
 
 GEM
@@ -92,8 +92,12 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
+    mini_portile2 (2.6.1)
     minitest (5.15.0)
     nio4r (2.5.8)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
     nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     pg (1.2.3)
@@ -156,6 +160,7 @@ GEM
     zeitwerk (2.5.1)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/Gemfile.lock

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

data/README.md

@@ -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,24 @@ 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
+```
+
 
 ## 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/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,18 +1,26 @@
 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
@@ -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
 

data/lib/rails_state_machine/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_state_machine
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.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: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: ActiveRecord-bound state machine