state_transitions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ef2f65947ee5d807bdb938c6938eb419464640429d37003e357482d15226b8c
+  data.tar.gz: 64b5b628b9cafa63434b76e9fbc1fe4231a49a6d83e84db7283075812350e021
+SHA512:
+  metadata.gz: 5cd733d4d500d471d08346bffd84856c8a95357f1d9793b679d08cdc171e0d1a780774d530ed4aa5ff70b19d7594ebc6fff547b7a00b2626994e79a5e45d6139
+  data.tar.gz: 7555504b497d804229ca92f1196f9768c8227b8e3ea9ce6e304d4148cd981912a1fe5a1fee63f7c58907f69d0afc0553388ac5aac0703c5fbb6c42268263780e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 kaspernj
+
+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,56 @@
+# StateTransitions
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "state_transitions"
+```
+
+And then execute:
+```bash
+bundle
+```
+
+Install migrations:
+```bash
+rails state_transitions:install:migrations
+```
+
+Run migrations:
+```bash
+rails db:migrate
+```
+
+Include the module in a model:
+```ruby
+class Project < ApplicationRecord
+  include StateTransitions
+end
+```
+
+Track current user on state transitions from requests:
+```ruby
+class ApplicationController
+  around_action :set_state_transitions_current
+
+private
+
+  def set_state_transitions_current
+    StateTransitions::Current.user = current_user
+    yield
+  ensure
+    StateTransitions::Current.user = nil
+  end
+end
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/models/state_transitions/application_record.rb

@@ -0,0 +1,5 @@
+module StateTransitions
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/state_transitions/current.rb

@@ -0,0 +1,3 @@
+class StateTransitions::Current < ActiveSupport::CurrentAttributes
+  attribute :user
+end

data/app/models/state_transitions/state_transition.rb

@@ -0,0 +1,9 @@
+class StateTransitions::StateTransition < ApplicationRecord
+  self.table_name = "state_transitions"
+
+  belongs_to :resource, polymorphic: true
+  belongs_to :user, optional: true, polymorphic: true
+
+  validates :state_from, presence: true, if: :persisted?
+  validates :state_to, presence: true
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+StateTransitions::Engine.routes.draw do
+end

data/db/migrate/20221017084844_create_state_transitions.rb

@@ -0,0 +1,11 @@
+class CreateStateTransitions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :state_transitions do |t|
+      t.references :resource, polymorphic: true, null: false
+      t.references :user, polymorphic: true
+      t.string :state_from, null: false
+      t.string :state_to, null: false
+      t.timestamps
+    end
+  end
+end

data/lib/state_transitions/engine.rb

@@ -0,0 +1,5 @@
+module StateTransitions
+  class Engine < ::Rails::Engine
+    isolate_namespace StateTransitions
+  end
+end

data/lib/state_transitions/version.rb

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

data/lib/state_transitions.rb

@@ -0,0 +1,69 @@
+require "state_transitions/version"
+require "state_transitions/engine"
+
+module StateTransitions
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def track_state_transitions
+      model_class = self
+
+      has_one :current_state_transition,
+        lambda {
+          where(
+            <<~SQL.squish
+              #{current_table_name}.id = (
+                SELECT current_state_transition.id
+                FROM state_transitions AS current_state_transition
+                WHERE
+                  current_state_transition.resource_type = #{current_table_name}.resource_type AND
+                  current_state_transition.resource_id = #{current_table_name}.resource_id
+                ORDER BY current_state_transition.created_at DESC
+                LIMIT 1
+              )
+            SQL
+          )
+        },
+        as: :resource,
+        class_name: "StateTransitions::StateTransition"
+
+      has_many :state_transitions,
+        as: :resource,
+        class_name: "StateTransitions::StateTransition",
+        dependent: :destroy
+
+      after_save :save_state_transition, if: :saved_change_to_state?
+    end
+
+    def define_first_state_transition_scope(state)
+      sql = <<~SQL.squish
+        #{current_table_name}.id = (
+          SELECT first_state_transition.id
+          FROM state_transitions AS first_state_transition
+          WHERE
+            first_state_transition.resource_type = #{current_table_name}.resource_type AND
+            first_state_transition.resource_id = #{current_table_name}.resource_id AND
+            first_state_transition.state_to = ?
+          ORDER BY first_state_transition.created_at
+          LIMIT 1
+        )
+      SQL
+
+      has_one :"first_#{state}_state_transition",
+        -> { where(sql, state) },
+        as: :resource,
+        class_name: "StateTransitions::StateTransition"
+    end
+  end
+
+  def save_state_transition
+    StateTransitions::StateTransition.create!(
+      resource: self,
+      state_from: saved_change_to_state.fetch(0),
+      state_to: saved_change_to_state.fetch(1),
+      user: StateTransitions::Current.user
+    )
+  end
+end

data/lib/tasks/state_transitions_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :state_transitions do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: state_transitions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kaspernj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-01-29 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.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: Tracks state transitions with AASM.
+email:
+- kasper@diestoeckels.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/state_transitions/application_record.rb
+- app/models/state_transitions/current.rb
+- app/models/state_transitions/state_transition.rb
+- config/routes.rb
+- db/migrate/20221017084844_create_state_transitions.rb
+- lib/state_transitions.rb
+- lib/state_transitions/engine.rb
+- lib/state_transitions/version.rb
+- lib/tasks/state_transitions_tasks.rake
+homepage: https://github.com/kaspernj/state_transitions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspernj/state_transitions
+  source_code_uri: https://github.com/kaspernj/state_transitions
+  changelog_uri: https://github.com/kaspernj/state_transitions
+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.5.22
+signing_key: 
+specification_version: 4
+summary: Tracks state transitions with AASM.
+test_files: []