rails_state_machine 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d01a1094865abf2d8451c41a75bb4da8b5c1f457d46c88580045cf13ac5af2ea
-  data.tar.gz: f7575ce50426110e387c438974a30ed4b3511413506243f50537e15abd1baef6
+  metadata.gz: f07991f6a0bc2dab134bc8518199885d79d0ee49d1865043a5e805e71c04b2b8
+  data.tar.gz: b4d3ba7b43eaed7a95522df3b385147f6feefbfac8a7b9dd7c49c6089731d037
 SHA512:
-  metadata.gz: 50ebcbd93b785b373721dc3d5ae6d84108c2a7d7942ce573f454c17198a63654a0782ea5bd4a797fb5220276af17addee8788d240ec4314df505aeced00dee1a
-  data.tar.gz: d28ec9396d3b28a2ba7b4741039e4ff2b9936fec67d0b7f7d3be89e62c4ac68f739871ed422b1b2a1f260f0fb422e55b0bd8b5da8d7cfc6073d973e70a293a90
+  metadata.gz: 1a5c81c9136fc6181974e7de5cd4a664f481c965098f39af45a3998b5cc3f29c9a46e0e983d5ca2cb724915505143c09643b93ade5a6bf3d47590af6ab716147
+  data.tar.gz: af45d14e32f278bc0a4e1d1dc76b9f7863300e178d87b032f7217c7aa4df1987740a5fb895b055058b6fb7fb1ca4e08cc3021c2d6b2bafc62c44ac1f15f23d94

data/.github/workflows/test.yml

@@ -23,26 +23,27 @@ jobs:
       fail-fast: false
       matrix:
         include:
-        - ruby: 2.3.8
-          gemfile: Gemfile.5.1.pg
-        - ruby: 2.4.6
-          gemfile: Gemfile.5.1.pg
-        - ruby: 2.3.8
-          gemfile: Gemfile.5.2.pg
-        - ruby: 2.4.6
-          gemfile: Gemfile.5.2.pg
         - ruby: 2.5.6
           gemfile: Gemfile.5.2.pg
         - ruby: 2.5.6
           gemfile: Gemfile.6.0.pg
+
+        - ruby: 2.6.6
+          gemfile: Gemfile.5.2.pg
         - ruby: 2.6.6
           gemfile: Gemfile.6.0.pg
+
         - ruby: 2.7.2
           gemfile: Gemfile.6.0.pg
         - ruby: 2.7.2
           gemfile: Gemfile.6.1.pg
+        - ruby: 2.7.2
+          gemfile: Gemfile.7.0.pg
+
         - ruby: 3.0.0
           gemfile: Gemfile.6.1.pg
+        - ruby: 3.0.0
+          gemfile: Gemfile.7.0.pg
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
     steps:

data/CHANGELOG.md

@@ -10,6 +10,20 @@ 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
+
+- Enabled MFA for RubyGems
+
 ## 2.1.0 2021-03-30
 
 ### Compatible changes

data/Gemfile.5.1.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_state_machine (2.1.0)
+    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.0)
+    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.0)
+    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.0)
+    rails_state_machine (2.2.0)
       activerecord
 
 GEM

data/Gemfile.7.0.pg

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Runtime dependencies
+gem 'rails', '~>7.0.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 => '.'

data/Gemfile.7.0.pg.lock

@@ -0,0 +1,177 @@
+PATH
+  remote: .
+  specs:
+    rails_state_machine (2.2.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.0)
+      actionpack (= 7.0.0)
+      activesupport (= 7.0.0)
+      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)
+      mail (>= 2.7.1)
+    actionmailer (7.0.0)
+      actionpack (= 7.0.0)
+      actionview (= 7.0.0)
+      activejob (= 7.0.0)
+      activesupport (= 7.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.0)
+      actionview (= 7.0.0)
+      activesupport (= 7.0.0)
+      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)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.0)
+      activesupport (= 7.0.0)
+      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)
+      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)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.0)
+      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)
+    crass (1.0.6)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    gemika (0.6.1)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.13.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    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)
+    pry (0.13.1)
+      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)
+      bundler (>= 1.15.0)
+      railties (= 7.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.0)
+      actionpack (= 7.0.0)
+      activesupport (= 7.0.0)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      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)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  database_cleaner
+  gemika
+  pg
+  pry-byebug
+  rails (~> 7.0.0)
+  rails_state_machine!
+  rake
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   2.3.0

data/README.md

@@ -59,7 +59,7 @@ A model instance offers these state machine methods:
 - `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
 
-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. This is mostly helpful in tests.
+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.
 
 If you want an event to be available for a different edge in your graph, you may define multiple `transitions` per event:
 
@@ -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.0'
+  VERSION = '2.2.0'
 end

data/rails_state_machine.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/makandra/rails_state_machine'
   spec.license       = 'MIT'
+  spec.metadata      = { 'rubygems_mfa_required' => 'true' }
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_state_machine
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Arne Hartherz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -88,6 +88,8 @@ files:
 - Gemfile.6.0.pg.lock
 - Gemfile.6.1.pg
 - Gemfile.6.1.pg.lock
+- Gemfile.7.0.pg
+- Gemfile.7.0.pg.lock
 - Gemfile.lock
 - LICENSE
 - LICENSE.txt
@@ -107,7 +109,8 @@ files:
 homepage: https://github.com/makandra/rails_state_machine
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -123,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: ActiveRecord-bound state machine