can_has_state 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2d2008ba870961e06cebe22f027b133b46c5f078315938c9338edfd99678f5
-  data.tar.gz: 2d4e7dbfd0bb896e01dfdaf66933b3b483f71915579f5d66d42fde1cbd0416de
+  metadata.gz: c5f5601e8f5a886f204c95bfab44e0f2331d48d1ddf1593915518a4506176731
+  data.tar.gz: 7dfb7c2a3f9601bbe495010f116051ebd5731f5425725204e1ff4c5aa7e3413b
 SHA512:
-  metadata.gz: 9e18bb675dd1acc0b84bb8539f67ca9c483f7ff618927b9baef5cdc738ba7a723cac0cccbaed68dfd0291925a2af5a8cda4ebf22b250ead0d39d813e389ecd86
-  data.tar.gz: 2cc03d656532de9061758242d7daaab074f979665323a071d432b1c220e050951da7750ca6f38c5ef1c8e1e4633f76ce16bd8f404fbe9e5e31ba8fe0a6426f17
+  metadata.gz: aa57e7f886fd54770f5b1031ff139346b616d7cc9445752fa20638c98b00530457f182973535710cf4db5effdebfd5bc4fb516fce195c7f84d0cca2ab8955b1a
+  data.tar.gz: 41adfafeecb3729facfa0f5a293219ca524382d2245af981674045d1a62a83482b78e371b0df89ff01fabeecb14a1c3a9c82337919d07aa9be1e6f7ea7feaeee

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright 2012-2023 thomas morgan
+Copyright 2012-2024 thomas morgan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/can_has_state/machine.rb

@@ -92,11 +92,7 @@ module CanHasState
         # copy that won't be reset.
 
       state_machines.each do |column, sm|
-        if respond_to?("#{column}_before_last_save") # rails 5.1+
-          from, to = send("#{column}_before_last_save"), send(column)
-        else
-          from, to = send("#{column}_was"), send(column)
-        end
+        from, to = send("#{column}_before_last_save"), send(column)
         next if from == to
 
         tg[column] ||= []
@@ -111,23 +107,23 @@ module CanHasState
       end
     end
 
-    def can_has_state_errors
-      err = {}
+    def can_has_state_errors(reset: true)
+      @can_has_state_errors = {} if reset || !@can_has_state_errors
       state_machines.each do |column, sm|
         from, to = send("#{column}_was"), send(column)
         if !sm.known?(to)
-          err[column] = [:invalid_state]
+          @can_has_state_errors[column] = [:invalid_state]
         elsif from == to
           next
         elsif !sm.allow?(self, to) #state_machine_allow?(column, to)
-          err[column] = [sm.message(to), {from: "'#{from}'", to: "'#{to}'"}]
+          @can_has_state_errors[column] = [sm.message(to), {from: "'#{from}'", to: "'#{to}'"}]
         end
       end
-      err
+      @can_has_state_errors
     end
 
     def validate_state_machines
-      can_has_state_errors.each do |column, (msg, opts)|
+      can_has_state_errors(reset: false).each do |column, (msg, opts)|
         errors.add column, msg, **(opts||{})
       end
     end

data/lib/can_has_state/version.rb

@@ -1,3 +1,3 @@
 module CanHasState
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
 end

data/test/can_has_state_test.rb

@@ -406,6 +406,74 @@ class CanHasStateTest < Minitest::Test
   end
 
 
+  def test_errors_resolved_in_later_callback_are_kept
+    # Triggers are skipped when the state_machine has validation errors.
+    # Whether or not to skip is decided in an early before_validation callback.
+    # Even if a later callback resolves the validation error, it's important to
+    # still bubble up the errors since triggers did not run.
+    kl = build_from_skeleton do
+      attr_accessor :have_beans, :coffee_in_hand
+      extend_state_machine :state do
+        state :incredible,
+          require: proc{ coffee_in_hand > 0 }
+      end
+      before_validation { self.coffee_in_hand += 1 if have_beans }
+      def initialize
+        @coffee_in_hand = 0
+      end
+    end
+    m = kl.new
+    m.state = 'incredible'
+    refute m.valid?
+    assert m.errors.of_kind?(:state, :invalid_transition)
+    assert_equal 0, m.coffee_in_hand
+
+    m = kl.new
+    m.have_beans = true
+    m.state = 'incredible'
+    refute m.valid?
+    assert m.errors.of_kind?(:state, :invalid_transition)
+    assert_equal 1, m.coffee_in_hand
+  end
+
+  def test_rerunning_triggers_clears_pre_callback_errors
+    # To resolve the issue above, it is possible to re-eval the state_machine
+    # and run triggers if validations now pass. This is highly discouraged as
+    # complex callback callback interactions like this should be refactored out
+    # if at all possible.
+    # Not an officially supported solution and subject to change, but
+    # documented here to show that it is (presently) possible.
+    kl = build_from_skeleton do
+      attr_accessor :have_beans, :coffee_in_hand, :we_are_incredible
+      extend_state_machine :state do
+        state :incredible,
+          require: proc{ coffee_in_hand > 0 },
+          on_enter: proc{ self.we_are_incredible = true }
+      end
+      before_validation do
+        self.coffee_in_hand += 1 if have_beans
+        run_state_triggers
+      end
+      def initialize
+        @coffee_in_hand = 0
+      end
+    end
+    m = kl.new
+    m.state = 'incredible'
+    refute m.valid?
+    assert m.errors.of_kind?(:state, :invalid_transition)
+    assert_equal 0, m.coffee_in_hand
+    refute m.we_are_incredible
+
+    m = kl.new
+    m.have_beans = true
+    m.state = 'incredible'
+    assert m.valid?
+    assert_equal 1, m.coffee_in_hand
+    assert m.we_are_incredible
+  end
+
+
 
   def build_from_skeleton(&block)
     Class.new(Skeleton).tap do |kl|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: can_has_state
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-25 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/can_has_state.rb
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Super simple state machine for ActiveModel