statesman-multi_state 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e46de0c69e16445bf06a31f55dd04be09853dcb41773cc61252e45f17cc84fdb
-  data.tar.gz: 05b43b0794b37be03bd9d97b45b5660a3ffa8e095b0c903754d7f478d0d48dd1
+  metadata.gz: 35f6636a6f4af3bf83393099ff9da9cce30e4cc8063a88e1c7ec24ea568ff2bb
+  data.tar.gz: c6064ca504b13bafe10e4c173b557c0fa27b5697603af0a9ed626946de9811d3
 SHA512:
-  metadata.gz: 8cdfde1e0826666e57cb82d6be2eff7649675ba8d170520b40c22a139c3fc981030b07b072f454148d446ba7cc71121e09644a03709d2ba618307153bb6558a3
-  data.tar.gz: 76efdb5cc4e0217f2f6543aef1b5689d0c5375420d34970da6f29b1b995593ef6045b71bb32bb6741bc3157e41870ab56d2006ba228f708d7e3dac6923cc9b21
+  metadata.gz: 711439772df22c7cb28c5dafc634fe0e3938aaf4ccaa22c499e0fc214a23e794ab3d17287e4eedad57853cec0e5445160381a93df893192168f2699b48f7d464
+  data.tar.gz: c04a23f23852d80a3636dff62b0880d7f9c7da52ed55c7055429ce35b86655c4b57ec79eba84faacccb2ab8421e55276510ff4e10cc5f756891c47a807367c0c

data/README.md

@@ -27,6 +27,7 @@ gem "statesman-multi_state"
 class Order < ActiveRecord::Base
   has_one_state_machine :business_status, state_machine_klass: 'OrderBusinessStatusStateMachine', transition_klass: 'OrderBusinessStatus'
   has_one_state_machine :admin_status, state_machine_klass: 'StateMachineKlass', transition_klass: 'MyTransitionKlass'
+  has_one_state_machine :custom_status, state_machine_klass: 'StateMachineKlass', transition_klass: 'MyTransitionKlass', transition_foreign_key: 'my_custom_fk_id'
 end
 ```
 
@@ -34,7 +35,11 @@ Calling `has_one_state_machine` on `business_status` adds the following:
 - A has_many association with the transition table
 ```ruby
  has_many :order_business_status_transitions, dependent: :destroy
+
+ # with custom foreign key if `transition_foreign_key` is set on `has_one_state_machine`
+ has_many :order_business_status_transitions, dependent: :destroy, foreign_key: 'my_custom_fk_id'
  ```
+
  - a virtual attribute `#business_status_state_form` (using the `ActiveRecord::Attributes` API ) to represent the actual current value of the state machine on the transition table.
  This also allows to be used in forms directly without the need for nested attributes. Using this API instead of a regular `attr_accessor` allows us to get all the benefits of dirty tracking, so we can track when changes were made, and perform the appropriate transitions.
 It default to `business_status` current state on the state machine

data/lib/statesman/multi_state/active_record_macro.rb

@@ -9,13 +9,15 @@ module Statesman
 
       class_methods do
         def has_one_state_machine(field_name, state_machine_klass:, transition_klass:,
-                                  transition_name: transition_klass.to_s.underscore.pluralize.to_sym, virtual_attribute_name: "#{field_name}_state_form")
+                                  transition_name: transition_klass.to_s.underscore.pluralize.to_sym, virtual_attribute_name: "#{field_name}_state_form",
+                                  transition_foreign_key: nil)
           state_machine_name = "#{field_name}_state_machine"
 
           # To handle STI, this needs to be done to get the base klass
           base_klass = caller_locations.first.label.split(':').last[...-1]
 
-          has_many transition_name, class_name: transition_klass.to_s, autosave: false, dependent: :destroy
+          association_options = { class_name: transition_klass.to_s, autosave: false, dependent: :destroy }.merge(transition_foreign_key ? { foreign_key: transition_foreign_key.to_s } : {} )
+          has_many transition_name, **association_options
 
           include Statesman::Adapters::CustomActiveRecordQueries[
             transition_class: transition_klass.constantize,
@@ -94,7 +96,8 @@ module Statesman
             field_name,
             nil,
             { state_machine_klass: state_machine_klass, transition_klass: transition_klass,
-              transition_name: transition_name, virtual_attribute_name: virtual_attribute_name },
+              transition_name: transition_name, virtual_attribute_name: virtual_attribute_name,
+              transition_foreign_key: transition_foreign_key },
             self
           )
 

data/lib/statesman/multi_state/version.rb

@@ -2,6 +2,6 @@
 
 module Statesman
   module MultiState
-    VERSION = '0.1.3'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman-multi_state
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Chedli Bourguiba
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,7 +63,7 @@ metadata:
   homepage_uri: https://github.com/chaadow/statesman-multi_state
   source_code_uri: https://github.com/chaadow/statesman-multi_state
   changelog_uri: https://github.com/chaadow/statesman-multi_state/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,8 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Rails/Statesman plugin that handle multiple state machines on the same model
   through `has_one_state_machine` ActiveRecord macro