aircts_as_state_machine 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8da8aad591951b2ca414d1c7b80cb7f1d6bc75458fe7ba0d97e93f08263ff9b6
+  data.tar.gz: da18e4691c0c99ef55a394282ac1ae0c2a0f82d1741cf40e51569b134ed3278e
+SHA512:
+  metadata.gz: af0e144cd79e23ef9e3ee8eb1e5b78595b471c983a014c750cc02bc602ffaef44392ea63e50844da619d0ccd96e1686b2aca8e785f242ac13cb46b3c96d262a1
+  data.tar.gz: '0941d1d0cdb87d13553eefecb20d494be95852267e6c1d77f50f5db8470e13cf19081774f4a4332867ac946daf945197cd1d39ba3093f34130f871da4916b927'

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/README.md

@@ -0,0 +1,58 @@
+# aircts_as_state_machine
+[aasm](https://github.com/aasm/aasm) support for Airrecord tables.
+
+currently only works with my [airrecord fork](https://github.com/24c02/airrecord)
+
+## usage:
+don't
+
+but if you must:
+```ruby
+require "aircts_as_state_machine"
+
+Airrecord.api_key = "pat3verysoftcats"
+
+class Shipment < AirctsAsStateMachine; # instead of Airrecord::Table
+  self.base_key = 'appsomething'
+  self.table_name = 'tblsomething'
+  
+  aasm column: "Status" do # Status should be a single-select field in your base
+    state :ready, :mailed
+    
+    event mark_mailed do
+      transitions from: :ready, to: :mailed
+      before do |postage_cost|
+        self["Postage Cost"] = postage_cost
+      end
+    end
+  end
+end
+
+x = Shipment.find "recYaself"
+
+# this sets State to "mailed" and Postage Cost to 3.50
+x.mark_mailed 3.50
+# but nothing persists to the cloud until
+x.save
+
+# or...
+x["Recipient"] = "nora"
+x.mark_mailed! 3.50
+
+# with the !, the transition gets fired in a transaction, so the AASM column 
+# and any fields modified in the callbacks are immediately persisted in a single
+# PATCH request, but anything modified outside (like Recipient) waits for save.
+```
+
+# caveats
+i'm trusting this in prod but you probably shouldn't
+
+i wrote this code but i do not understand it
+
+the real horrors are in the """"""[transaction support](https://github.com/24c02/airrecord/blob/5ae56c166b29f4ae2723edce99970e9c8e0d59a3/lib/airrecord/table.rb#L237)"""""" this needed airrecord to have
+
+it's not very good
+
+...
+
+k cya

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/aircts_as_state_machine.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "norairrecord"
+require "aasm"
+
+module AASM
+  module Persistence
+    # mix this in to taste
+    module AirrecordPersistence
+      def self.included(base)
+        base.extend AASM::Persistence::Base::ClassMethods
+        base.extend ClassMethods
+
+        base.class_eval do
+          attr_accessor :_transition_changes
+        end
+      end
+
+      def aasm_read_state(name = :default)
+        state = self[self.class.aasm(name).attribute_name.to_s]
+        state&.to_sym
+      end
+
+      def aasm_write_state_without_persistence(state, name = :default)
+        self[self.class.aasm(name).attribute_name.to_s] = state.to_s
+      end
+
+      def aasm_fire_event(state_machine_name, name, options, *args, &block)
+        return super unless options[:persist]
+
+        transaction do
+          super
+        end
+      end
+    end
+  end
+end
+
+# inherit from this as you would Airrecord::Table
+class AirctsAsStateMachine < Norairrecord::Table
+  include AASM
+  include AASM::Persistence::AirrecordPersistence
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: aircts_as_state_machine
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- 24c02
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: norairrecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: don't
+email:
+- nora@hcb.pizza
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- lib/aircts_as_state_machine.rb
+homepage: https://github.com/24c02/aircts_as_state_machine
+licenses: []
+metadata:
+  homepage_uri: https://github.com/24c02/aircts_as_state_machine
+  source_code_uri: https://github.com/24c02/aircts_as_state_machine
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: aasm persistence for airrecord tables
+test_files: []