state_machines_transactions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0df940ae92db6dac8d0cdcbda69b06ac91748ee9db4ec136a11e96779f98ed3
+  data.tar.gz: 6224e37b1ca28eeff4c42c1b90a20b546e1c8b26255a34d0f86b01cc9cd55c0f
+SHA512:
+  metadata.gz: 43396d8b274822694745257268621cbc8e49e6afc1f1d539ed3c2c07c247f46b01d10aafbe7ba742c34b6af01eacc3983dc4b23685bd51d983be46559d68f366
+  data.tar.gz: b5c4db4df5d99d88a4e3f16ec5171fa5613bde6c81f77a9fff6d2a602a24b41f541b78b4aee0fbf163cf6747635c793e82d567a64fa4e3b17c657d5c4e0165ad

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Abhilash Achuthan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# StateMachinesTransactions
+This gem persists the state transitions of state_machines gem. The transactions (transition data) can be used to represent the path a stateful object took to reach the current state.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "state_machines_transactions"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install state_machines_transactions
+```
+
+## Usage
+Generate the database migration for state_machines_transactions table using:
+```bash
+$ rails generate state_machine_transactions
+```
+
+And then execute:
+```bash
+$ rails db:migrate
+```
+
+Add `audit_transition` inside your state machine to persist the state transitions.
+```ruby
+state_machine :state, initial: :parked do
+    audit_transition
+
+    state :parked
+    state :idling
+end
+```
+
+Use `StateMachinesTransaction` model to fetch the transactions. The schema is:
+```ruby
+  create_table "state_machines_transactions", force: :cascade do |t|
+    t.string "object_type"
+    t.integer "object_id"
+    t.string "state_field"
+    t.string "event"
+    t.string "from_state"
+    t.string "to_state"
+    t.string "status"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+```
+
+## Contributing
+1. Fork it ( https://github.com/infraspecdev/state_machines_transactions/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/generators/state_machine_transactions_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators/migration'
+
+class StateMachineTransactionsGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  class << self
+    def source_root
+      @_state_machine_transactions_source_root ||= File.expand_path('../templates', __FILE__)
+    end
+
+    def next_migration_number path
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+  end
+
+  def create_model_file
+    migration_template 'create_state_machines_transactions.rb', 'db/migrate/create_state_machines_transactions.rb'
+  end
+end

data/lib/generators/templates/create_state_machines_transactions.rb

@@ -0,0 +1,15 @@
+class CreateStateMachinesTransactions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :state_machines_transactions do |t|
+      t.string :object_type
+      t.integer :object_id
+      t.string :state_field
+      t.string :event
+      t.string :from_state
+      t.string :to_state
+      t.string :status
+
+      t.timestamps
+    end
+  end
+end

data/lib/state_machines_transactions/create_transaction_job.rb

@@ -0,0 +1,7 @@
+class CreateTransactionJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(attributes)
+    StateMachinesTransaction.create(attributes)
+  end
+end

data/lib/state_machines_transactions/state_machines_transaction.rb

@@ -0,0 +1,8 @@
+class StateMachinesTransaction < ActiveRecord::Base
+  enum status: { success: 'success', failure: 'failure' }
+  STATUS_COLOR = OpenStruct.new(success: 'green', failure: 'red')
+
+  def status_color
+    @_status_color ||= self.success? ? STATUS_COLOR.success : STATUS_COLOR.failure
+  end
+end

data/lib/state_machines_transactions/version.rb

@@ -0,0 +1,3 @@
+module StateMachinesTransactions
+  VERSION = "0.1.0"
+end

data/lib/state_machines_transactions.rb

@@ -0,0 +1,36 @@
+require "state_machines"
+require "state_machines-activerecord"
+require "state_machines_transactions/state_machines_transaction"
+require "state_machines_transactions/create_transaction_job"
+
+module StateMachinesTransactions
+  def audit_transition
+    state_machine = self
+    state_machine.after_transition(any => any) do |object, _transition|
+      state_transaction = StateMachinesTransaction.create(
+        object_type: object.class.name,
+        object_id: object.id,
+        state_field: state_machine.attribute,
+        event: _transition.event,
+        from_state: _transition.from,
+        to_state: _transition.to,
+        status: 'success'
+      )
+    end
+
+    state_machine.after_failure do |object, _transition|
+      state_transaction = StateMachinesTransaction.new(
+        object_type: object.class.name,
+        object_id: object.id,
+        state_field: state_machine.attribute,
+        event: _transition.event,
+        from_state: _transition.from,
+        to_state: _transition.to,
+        status: 'failure'
+      )
+      CreateTransactionJob.perform_later(state_transaction.attributes)
+    end
+  end
+end
+
+StateMachines::Machine.include StateMachinesTransactions

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: state_machines_transactions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abhilash Achuthan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.6
+- !ruby/object:Gem::Dependency
+  name: state_machines
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: state_machines-activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Description of StateMachinesTransactions.
+email:
+- abhilash@infraspec.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/state_machine_transactions_generator.rb
+- lib/generators/templates/create_state_machines_transactions.rb
+- lib/state_machines_transactions.rb
+- lib/state_machines_transactions/create_transaction_job.rb
+- lib/state_machines_transactions/state_machines_transaction.rb
+- lib/state_machines_transactions/version.rb
+homepage: https://github.com/infraspecdev/state_machines_transactions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/infraspecdev/state_machines_transactions
+  source_code_uri: https://github.com/infraspecdev/state_machines_transactions
+  changelog_uri: https://github.com/infraspecdev/state_machines_transactions
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.15
+signing_key:
+specification_version: 4
+summary: Summary of StateMachinesTransactions.
+test_files: []