sequel-state-machine 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eb11cc183e1cfcfc7917f505b02b0f801888492fcf73ac6538e5915972cc799
-  data.tar.gz: 355f305b70481b88cd306aed45e4bd6ec8b8706ecd921f17fb18e872e85ea36c
+  metadata.gz: 32bf94c0e52e6d2fcaf7593f02f4834f689ee462a378dfc7d561e3e29db79258
+  data.tar.gz: a99a5e2ccd052cecd228ccc7c702bde70b675b86afac2fbf2b69d95432a9b8b5
 SHA512:
-  metadata.gz: e26ed08fbc26ece33859b8b68b1ce95573060437054ed1c2e7f69e751c80c5a9d0e29c0ad81ab2c2ec1985c54bcc0fd8327d940329868e7c0937b1baa0f4f64f
-  data.tar.gz: 32164513eb750973c18e54b73defeb9aa3e45635653725733ff4c1f0f1665693a2eecb569b2d749d04010c586c86bf44f20b8558e6c44f5df85ce9c73b47c8de
+  metadata.gz: 10d259cf6ff25cdabe78ef6699ff6fa9be62de332cd9c45901b5295be687159cbf10e7738426ab94c0f2f4f2c0af3cccf44d3ba371c026f30e00bb6677910747
+  data.tar.gz: 349b9378af67e386b705d9d1d6e26ca2a48ff953b322f1a47dc40da308ab240e289d1042b53acbaaf2525df408a9c05be5fd62c33b4986b28452a4d51351ced5

data/lib/sequel/plugins/state_machine.rb

@@ -7,7 +7,53 @@ require "state_machines/sequel"
 module Sequel
   module Plugins
     module StateMachine
+      class InvalidConfiguration < RuntimeError; end
+
+      def self.apply(_model, _opts={})
+        nil
+      end
+
+      def self.configure(model, opts={})
+        col = opts.is_a?(Symbol) ? opts : nil
+        model.instance_eval do
+          # See state_machine_status_column.
+          # We must defer defaulting the value in case the plugin
+          # comes ahead of the state  machine (we can see a valid state machine,
+          # but the attribute/name will always be :state, due to some configuration
+          # order of operations).
+          @sequel_state_machine_status_column = col if col
+        end
+      end
+
       module InstanceMethods
+        private def state_machine_status_column
+          col = self.class.instance_variable_get(:@sequel_state_machine_status_column)
+          return col unless col.nil?
+          if self.respond_to?(:_state_value_attr)
+            self.class.instance_variable_set(:@sequel_state_machine_status_column, self._state_value_attr)
+            return self._state_value_attr
+          end
+          if !self.class.respond_to?(:state_machines) || self.class.state_machines.empty?
+            msg = "Model must extend StateMachines::MacroMethods and have one state_machine."
+            raise InvalidConfiguration, msg
+          end
+          if self.class.state_machines.length > 1
+            msg = "Cannot use sequel-state-machine with multiple state machines. " \
+                  "Please file an issue at https://github.com/lithictech/sequel-state-machine/issues " \
+                  "if you need this capability."
+            raise InvalidConfiguration, msg
+          end
+          self.class.instance_variable_set(:@sequel_state_machine_status_column, self.class.state_machine.attribute)
+        end
+
+        private def state_machine_status
+          return self.send(self.state_machine_status_column)
+        end
+
+        def sequel_state_machine_status
+          return state_machine_status
+        end
+
         def new_audit_log
           audit_log_assoc = self.class.association_reflections[:audit_logs]
           model = Kernel.const_get(audit_log_assoc[:class_name])
@@ -72,8 +118,8 @@ module Sequel
           audlog.set(
             at: Time.now,
             event: event,
-            from_state: self.status,
-            to_state: self.status,
+            from_state: self.state_machine_status,
+            to_state: self.state_machine_status,
             messages: audlog.class.state_machine_messages_supports_array ? messages : messages.join("\n"),
             reason: reason || "",
             actor: StateMachines::Sequel.current_actor,
@@ -114,25 +160,24 @@ module Sequel
 
         # Return true if the given event can be transitioned into by the current state.
         def valid_state_path_through?(event)
-          current_state = self.send(self._state_value_attr).to_sym
+          current_state_str = self.state_machine_status.to_s
+          current_state_sym = current_state_str.to_sym
           event_obj = self.class.state_machine.events[event] or raise "Invalid event #{event}"
           event_obj.branches.each do |branch|
             branch.state_requirements.each do |state_req|
-              return true if state_req[:from]&.matches?(current_state)
+              next unless (from = state_req[:from])
+              return true if from.matches?(current_state_str) || from.matches?(current_state_sym)
             end
           end
           return false
         end
 
-        def _state_value_attr
-          return @_state_value_attr ||= self.class.state_machine.attribute
-        end
-
         def validates_state_machine
           states = self.class.state_machine.states.map(&:value)
-          state = self[self._state_value_attr]
+          state = self.state_machine_status
           return if states.include?(state)
-          self.errors.add(self._state_value_attr, "status '#{state}' must be one of (#{states.sort.join(', ')})")
+          self.errors.add(self.state_machine_status_column,
+                          "state '#{state}' must be one of (#{states.sort.join(', ')})",)
         end
       end
 

data/lib/sequel/plugins/state_machine_audit_log.rb

@@ -36,14 +36,14 @@ module Sequel
 
       module DatasetMethods
         def failed
-          colmap = self.state_machine_column_mappings
+          colmap = self.model.state_machine_column_mappings
           tostate_col = colmap[:to_state]
           fromstate_col = colmap[:from_state]
           return self.where(tostate_col => fromstate_col)
         end
 
         def succeeded
-          colmap = self.state_machine_column_mappings
+          colmap = self.model.state_machine_column_mappings
           tostate_col = colmap[:to_state]
           fromstate_col = colmap[:from_state]
           return self.exclude(tostate_col => fromstate_col)

data/lib/state_machines/sequel/spec_helpers.rb

@@ -6,7 +6,7 @@ RSpec::Matchers.define :transition_on do |event|
   match do |receiver|
     raise 'must provide a "to" state' if (@to || "").to_s.empty?
     receiver.send(event, *@args)
-    @to == receiver.status
+    @to == receiver.send(:state_machine_status)
   end
 
   chain :to do |to_state|
@@ -23,10 +23,10 @@ RSpec::Matchers.define :transition_on do |event|
 
   failure_message do |receiver|
     msg =
-      if @to == receiver.status
+      if @to == receiver.state_machine_status
         "expected that event #{event} would transition, but did not"
       else
-        "expected that event #{event} would transition to #{@to} but is #{receiver.status}"
+        "expected that event #{event} would transition to #{@to} but is #{receiver.state_machine_status}"
       end
     (msg += "\n#{receiver.audit_logs.map(&:inspect).join("\n")}") if @audit
     msg
@@ -43,11 +43,12 @@ RSpec::Matchers.define :not_transition_on do |event|
   end
 
   failure_message do |receiver|
-    "expected that event #{event} would not transition, but did and is now #{receiver.status}"
+    "expected that event #{event} would not transition, but did and is now #{receiver.state_machine_status}"
   end
 end
 
 RSpec.shared_examples "a state machine with audit logging" do |event, to_state|
+  let(:machine) { raise NotImplementedError, "must override let(:machine)" }
   it "logs transitions" do
     expect(machine).to transition_on(event).to(to_state)
     expect(machine.audit_logs).to contain_exactly(

data/lib/state_machines/sequel/version.rb

@@ -2,6 +2,6 @@
 
 module StateMachines
   module Sequel
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-state-machine
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Lithic Tech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   sequel-state-machine hooks together the excellent Ruby Sequel ORM to
   the state-machines library, with auditing and other tools.