state_machines-audit_trail 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa9c1aad624d9dad005c50ab44eb5522908b1790490f6e8b1eacc1b05261a7e3
-  data.tar.gz: 9bcb723941ab88d56534181ad6be0c147de7262ee408c2a5607a77bd146b94e2
+  metadata.gz: 9763326e11e39a7a8876a9fa2235cb93a5bb9d8abc8dbdce4cee04fa7d47437e
+  data.tar.gz: 78a8f897991391f2e590858315c9970aa2e3d8de1c5a5a6af3772911611cf2a3
 SHA512:
-  metadata.gz: ffaacbb29036d844d7a25d72da512906bee8d7a646e63b42b68f3f99bfcd7ff572e33177b84cf85ef079cb284dc2667611ce22b40835d524f065fdfb76f7926f
-  data.tar.gz: 15cf000aea32b80c3f0cf675fe9cad34574ce127d4328c3faea9f70b62e7d35550b67ef62ed9209000bf46c84e949ccec27821ba2d90861cfb075c43ae616a76
+  metadata.gz: 95b780a557c38b332fe4050773474cca8534b4d37b4e89bba7066a7296d3a224f269617eba253a96412d34617dc99b9d9a2f0089b38a95638ee61b8e74d6dfd7
+  data.tar.gz: 692efbe5208fb4437d4c18c290b2c7082551b967f799cc7384f1771280d576bd4ac1853e86508cc845484660cd0dc482b7a2b3c2fbd2a87bb1a6a337b19e8c7d

data/README.md

@@ -1,5 +1,4 @@
-[![Build Status](https://travis-ci.org/state-machines/state_machines-audit_trail.svg?branch=master)](https://travis-ci.org/state-machines/state_machines-audit_trail)
-[![Code Climate](https://codeclimate.com/github/state-machines/state_machines-audit_trail.svg)](https://codeclimate.com/github/state-machines/state_machines-audit_trail)
+![Build Status](https://github.com/state-machines/state_machines-audit_trail/actions/workflows/ruby.yml/badge.svg)
 
 # state_machines-audit_trail
 Log transitions on a [state_machines gem](https://github.com/state-machines/state_machines) to support auditing and business process analytics.
@@ -12,7 +11,7 @@ for any state machine. Having an audit trail gives you a complete history of the
 to investigate incidents or perform analytics, like: _"How long does it take on average to go from state a to state b?"_,
 or _"What percentage of cases goes from state a to b via state c?"_
 
-For more information read [Why developers should be force-fed state machines](https://engineering.shopify.com/blogs/engineering/17488160-why-developers-should-be-force-fed-state-machines).
+For more information read [Why developers should be force-fed state machines](https://engineering.shopify.com/17488160-why-developers-should-be-force-fed-state-machines).
 
 ## ORM support
 

data/Rakefile

@@ -6,10 +6,4 @@ RSpec::Core::RakeTask.new(:spec) do |task|
   task.rspec_opts = ['--color']
 end
 
-if ENV['APPRAISAL_INITIALIZED'] || ENV['TRAVIS']
-  task :default => :spec
-else
-  require 'appraisal'
-  Appraisal::Task.new
-  task :default => :appraisal
-end
+task :default => :spec

data/lib/state_machines/audit_trail/transition_auditing.rb

@@ -1,4 +1,3 @@
-require 'ostruct'
 #
 # This module inserts hooks into the state machine.
 # The transition_class is the class (optionally specified with the :class option) for the model which
@@ -7,6 +6,30 @@ require 'ostruct'
 # Multiple `SubscriptionStateTransition`s compose the 'audit_trail'.
 #
 module StateMachines::AuditTrail::TransitionAuditing
+  class InitialTransition
+    attr_reader :namespace, :to
+
+    def initialize(namespace:, to:)
+      @namespace = namespace
+      @to = to
+    end
+
+    def from
+      nil
+    end
+
+    def event
+      nil
+    end
+
+    def machine
+      nil
+    end
+
+    def args
+      nil
+    end
+  end
 
   # Hook for audit_trail inside a a state_machine declaration.
   #
@@ -35,7 +58,7 @@ module StateMachines::AuditTrail::TransitionAuditing
           if state_machine.backend.new_record? object
             current_state = object.send(state_machine.attribute)
             if !current_state.nil?
-              state_machine.backend.log(object, OpenStruct.new(namespace: state_machine.namespace, to: current_state))
+              state_machine.backend.log(object, InitialTransition.new(namespace: state_machine.namespace, to: current_state))
             end
           end
         end

data/lib/state_machines/audit_trail/version.rb

@@ -1,5 +1,5 @@
 module StateMachines
   module AuditTrail
-    VERSION = '2.0.2'
+    VERSION = '3.0.0'
   end
 end

data/spec/helpers/active_record.rb

@@ -3,39 +3,43 @@ require 'active_record'
 ### Setup test database
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
 
-class ARModelStateTransition < ActiveRecord::Base
-  belongs_to :ar_model
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
 end
 
-class ARModelWithNamespaceFooStateTransition < ActiveRecord::Base
-  belongs_to :ar_model_with_namespace
+class ARModelStateTransition < ApplicationRecord
+  belongs_to :ar_model, class_name: 'ARModel'
 end
 
-class ARModelNoInitialStateTransition < ActiveRecord::Base
-  belongs_to :ar_model_no_initial
+class ARModelWithNamespaceFooStateTransition < ApplicationRecord
+  belongs_to :ar_model_with_namespace, class_name: 'ARModelWithNamespace'
 end
 
-class ARModelWithContextStateTransition < ActiveRecord::Base
-  belongs_to :ar_model_with_context
+class ARModelNoInitialStateTransition < ApplicationRecord
+  belongs_to :ar_model_no_initial, class_name: 'ARModelNoInitial'
 end
 
-class ARModelWithMultipleContextStateTransition < ActiveRecord::Base
-  belongs_to :ar_model_with_multiple_context
+class ARModelWithContextStateTransition < ApplicationRecord
+  belongs_to :ar_model_with_context, class_name: 'ARModelWithContext'
 end
 
-class ARModelWithMultipleStateMachinesFirstTransition < ActiveRecord::Base
-  belongs_to :ar_model_with_multiple_state_machines
+class ARModelWithMultipleContextStateTransition < ApplicationRecord
+  belongs_to :ar_model_with_multiple_context, class_name: 'ARModelWithMultipleContext'
 end
 
-class ARModelWithMultipleStateMachinesSecondTransition < ActiveRecord::Base
-  belongs_to :ar_model_with_multiple_state_machines
+class ARModelWithMultipleStateMachinesFirstTransition < ApplicationRecord
+  belongs_to :ar_model_with_multiple_state_machines, class_name: 'ARModelWithMultipleStateMachines'
 end
 
-class ARModelWithMultipleStateMachinesThirdTransition < ActiveRecord::Base
-  belongs_to :ar_model_with_multiple_state_machines
+class ARModelWithMultipleStateMachinesSecondTransition < ApplicationRecord
+  belongs_to :ar_model_with_multiple_state_machines, class_name: 'ARModelWithMultipleStateMachines'
 end
 
-class ARModel < ActiveRecord::Base
+class ARModelWithMultipleStateMachinesThirdTransition < ApplicationRecord
+  belongs_to :ar_model_with_multiple_state_machines, class_name: 'ARModelWithMultipleStateMachines'
+end
+
+class ARModel < ApplicationRecord
 
   state_machine :state, initial: :waiting do
     audit_trail
@@ -50,7 +54,7 @@ class ARModel < ActiveRecord::Base
   end
 end
 
-class ARModelNoInitial < ActiveRecord::Base
+class ARModelNoInitial < ApplicationRecord
 
   state_machine :state, initial: :waiting do
     audit_trail initial: false
@@ -65,7 +69,7 @@ class ARModelNoInitial < ActiveRecord::Base
   end
 end
 
-class ARModelWithNamespace < ActiveRecord::Base
+class ARModelWithNamespace < ApplicationRecord
 
   state_machine :foo_state, initial: :waiting, namespace: :foo do
     audit_trail
@@ -81,7 +85,7 @@ class ARModelWithNamespace < ActiveRecord::Base
 end
 
 #
-class ARModelWithContext < ActiveRecord::Base
+class ARModelWithContext < ApplicationRecord
   state_machine :state, initial: :waiting do
     audit_trail context: :context
 
@@ -99,7 +103,7 @@ class ARModelWithContext < ActiveRecord::Base
   end
 end
 
-class ARModelWithMultipleContext < ActiveRecord::Base
+class ARModelWithMultipleContext < ApplicationRecord
   state_machine :state, initial: :waiting do
     audit_trail context: [:context, :second_context, :context_with_args]
 
@@ -140,7 +144,7 @@ class ARModelDescendantWithOwnStateMachines < ARModel
   end
 end
 
-class ARModelWithMultipleStateMachines < ActiveRecord::Base
+class ARModelWithMultipleStateMachines < ApplicationRecord
 
   state_machine :first, :initial => :beginning do
     audit_trail
@@ -171,11 +175,11 @@ class ARModelWithMultipleStateMachines < ActiveRecord::Base
   end
 end
 
-class ARResourceStateTransition < ActiveRecord::Base
+class ARResourceStateTransition < ApplicationRecord
   belongs_to :resource, polymorphic: true
 end
 
-class ARFirstModelWithPolymorphicStateTransition < ActiveRecord::Base
+class ARFirstModelWithPolymorphicStateTransition < ApplicationRecord
   state_machine :state, :initial => :pending do
     audit_trail class: ARResourceStateTransition, as: :ar_resource
 
@@ -189,7 +193,7 @@ class ARFirstModelWithPolymorphicStateTransition < ActiveRecord::Base
   end
 end
 
-class ARSecondModelWithPolymorphicStateTransition < ActiveRecord::Base
+class ARSecondModelWithPolymorphicStateTransition < ApplicationRecord
   state_machine :state, :initial => :pending do
     audit_trail class: ARResourceStateTransition, as: :ar_resource
 
@@ -204,11 +208,11 @@ class ARSecondModelWithPolymorphicStateTransition < ActiveRecord::Base
 end
 
 module SomeModule
-  class ARModelStateTransition < ActiveRecord::Base
-    belongs_to :ar_model
+  class ARModelStateTransition < ApplicationRecord
+    belongs_to :ar_model, class_name: 'SomeModule::ARModel'
   end
 
-  class ARModel < ActiveRecord::Base
+  class ARModel < ApplicationRecord
 
     state_machine :state, initial: :waiting do
       audit_trail

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-audit_trail
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Kevin Ross
 - Willem van Bergen
 - Jesse Storimer
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machines
@@ -18,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: state_machines-activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -40,20 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: state_machines-mongoid
-  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -83,21 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,21 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mongoid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.0.beta
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.0.beta
-- !ruby/object:Gem::Dependency
-  name: bson
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -139,47 +96,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '7.1'
 description: Log transitions on a state_machines to support auditing and business
   process analytics.
 email:
@@ -190,21 +133,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
-- Appraisals
-- Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
-- gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.gemfile
-- gemfiles/rails_edge.gemfile
 - lib/state_machines-audit_trail.rb
 - lib/state_machines/audit_trail.rb
 - lib/state_machines/audit_trail/backend.rb
@@ -222,12 +153,10 @@ files:
 - spec/lib/state_machines/audit_trail_generator_spec.rb
 - spec/lib/state_machines/audit_trail_spec.rb
 - spec/spec_helper.rb
-- state_machines-audit_trail.gemspec
 homepage: https://github.com/state-machines/state_machines-audit_trail
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -242,8 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Log transitions on a state_machines to support auditing and business process
   analytics.

data/.gitignore

@@ -1,10 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-*.gemfile.lock
-pkg/*
-.DS_Store
-*.rbc
-/doc
-.yardoc
-.idea

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.ruby-gemset

@@ -1 +0,0 @@
-state_machines-audit_trail

data/.ruby-version

@@ -1 +0,0 @@
-2.3.1

data/.travis.yml

@@ -1,43 +0,0 @@
-language: ruby
-cache: bundler
-
-script: "bundle exec rake"
-
-services: mongodb
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - ruby-head
-  - jruby-head
-  - jruby
-  - rbx-2
-gemfile:
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
-  - gemfiles/rails_edge.gemfile
-matrix:
-  exclude:
-    - rvm: 2.2
-      gemfile: gemfiles/rails_6.0.gemfile
-    - rvm: 2.3
-      gemfile: gemfiles/rails_6.0.gemfile
-    - rvm: 2.4
-      gemfile: gemfiles/rails_6.0.gemfile
-    - rvm: 2.2
-      gemfile: gemfiles/rails_edge.gemfile
-    - rvm: 2.3
-      gemfile: gemfiles/rails_edge.gemfile
-    - rvm: 2.4
-      gemfile: gemfiles/rails_edge.gemfile
-  allow_failures:
-    - rvm: rbx-2
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - gemfile: gemfiles/rails_edge.gemfile
-

data/Appraisals

@@ -1,16 +0,0 @@
-appraise 'rails_5.0' do
-  gem 'activerecord', '~> 5.0'
-  gem 'activemodel', '~> 5.0'
-end
-
-appraise 'rails_5.1' do
-  gem 'activerecord', '~> 5.1'
-  gem 'activemodel', '~> 5.1'
-end
-
-appraise 'rails_edge' do
-  gem 'rails', github: 'rails/rails', branch: 'master'
-  gem 'activerecord', github: 'rails/rails', branch: 'master'
-  gem 'activemodel', github: 'rails/rails', branch: 'master'
-  gem 'arel', github: 'rails/arel', branch: 'master'
-end

data/Gemfile

@@ -1,2 +0,0 @@
-source 'https://rubygems.org'
-gemspec

data/gemfiles/rails_5.0.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 5.0.0"
-gem "activemodel", "~> 5.0.0"
-gem "sqlite3", "~> 1.3.6"
-
-gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 5.1.0"
-gem "activemodel", "~> 5.1.0"
-
-gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 5.2.0"
-gem "activemodel", "~> 5.2.0"
-
-gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 6.0.0"
-gem "activemodel", "~> 6.0.0"
-
-gemspec path: "../"

data/gemfiles/rails_edge.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", github: "rails/rails", branch: "master"
-gem "activerecord", github: "rails/rails", branch: "master"
-gem "activemodel", github: "rails/rails", branch: "master"
-gem "arel", github: "rails/arel", branch: "master"
-
-gemspec path: "../"

data/state_machines-audit_trail.gemspec

@@ -1,41 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'state_machines/audit_trail/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'state_machines-audit_trail'
-  s.version     = StateMachines::AuditTrail::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Kevin Ross', 'Willem van Bergen', 'Jesse Storimer']
-  s.email       = ['kevin.ross@alienfast.com', 'willem@shopify.com', 'jesse@shopify.com']
-
-  s.homepage    = 'https://github.com/state-machines/state_machines-audit_trail'
-  s.summary     = %q{Log transitions on a state_machines to support auditing and business process analytics.}
-  s.description = %q{Log transitions on a state_machines to support auditing and business process analytics.}
-  s.license     = 'MIT'
-
-  s.add_runtime_dependency('state_machines')
-
-  s.add_development_dependency('state_machines-activerecord')
-  s.add_development_dependency('state_machines-mongoid')
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec', '>= 3.0.0')
-  s.add_development_dependency('activerecord', '>= 5.0.0')
-  if(defined?(JRUBY_VERSION))
-    s.add_development_dependency('activerecord-jdbcsqlite3-adapter')
-  else
-    s.add_development_dependency('sqlite3')
-  end
-  s.add_development_dependency('mongoid', '>= 6.0.0.beta')
-  s.add_development_dependency('bson')
-  s.add_development_dependency('generator_spec')
-  s.add_development_dependency('rails', '>= 5.0.0')
-  s.add_development_dependency('appraisal', '~> 2.2.0')
-
-  s.files = `git ls-files`.split($/).reject { |f| f =~ /^samples\// }
-  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ['lib']
-end