ae_active_job_state 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06a4c9233311e99e2aa3f14bcf7310c36ab0221ed9fe8cd01d0c9b660c9cd6f1
+  data.tar.gz: 4d15d5d24db0a18f773a05695e6139d3acfdbabdbdee91080b218e0eb31d00e1
+SHA512:
+  metadata.gz: afcf025d29e44a480b902a15e861821b2a93c2f1cb2f266a22783e036cdffa000c24f5f48942bd6b292f051cd7ad605d87e3a1cc3a40079de4f0562444735f9f
+  data.tar.gz: b0258ee0af5d7e4232e6a2e720789c43a8067dd0048d918f97ae031c5b85d11ac2f7af4efb36f6843ae3f2199d6d2b873447f60c8c531ab978a68268448ba0f6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2020-2020 AppFolio inc
+
+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/ae_active_job_state.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ae_active_job_state/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ae_active_job_state'
+  spec.version       = AeActiveJobState::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.author        = 'AppFolio'
+  spec.email         = 'opensource@appfolio.com'
+  spec.description   = 'Store ActiveJob status in ActiveRecord'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/appfolio/ae_active_job_state'
+  spec.license       = 'MIT'
+  spec.files         = Dir['**/*'].select { |f| f[%r{^(lib/|LICENSE.txt|.*gemspec)}] }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'aasm', '~> 5.1'
+  spec.add_dependency 'activejob', '>= 6', '< 7'
+  spec.add_dependency 'activerecord', '>= 6', '< 7'
+  spec.add_dependency 'activesupport', '>= 6', '< 7'
+end

data/lib/ae_active_job_state.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'ae_active_job_state/version'
+require 'active_support'
+require 'active_job'
+require 'active_record'
+require 'aasm'
+
+module AeActiveJobState
+end
+
+require 'ae_active_job_state/job_state'
+require 'ae_active_job_state/has_job_state'
+require 'ae_active_job_state/delete_old_job_states_job'

data/lib/ae_active_job_state/delete_old_job_states_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AeActiveJobState
+  class DeleteOldJobStatesJob < ActiveJob::Base
+    def perform(older_than_days: 30)
+      JobState.where('updated_at < ?', older_than_days.days.ago).destroy_all
+    end
+  end
+end

data/lib/ae_active_job_state/has_job_state.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AeActiveJobState
+  module HasJobState
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :job_state
+
+      delegate :id, :progress, :result, to: :job_state
+
+      # before_enqueue is only triggered on `perform_later`
+      # `perform_now` would go directly to around_perform
+      before_enqueue do |job|
+        @job_state = AeActiveJobState::JobState.create!(status: 'pending', active_job_id: job.job_id,
+                                                        args: job.arguments)
+      end
+
+      around_perform do |job, block|
+        @job_state = AeActiveJobState::JobState.find_by(active_job_id: job.job_id) ||
+                     AeActiveJobState::JobState.create!(status: 'pending', active_job_id: job.job_id,
+                                                        args: job.arguments)
+        job_state.run!
+        job_state.reload
+        block.call
+        job_state.finish!
+      rescue StandardError => e
+        @job_state.fail!
+        raise e
+      end
+    end
+
+    def set_job_progress!(progress)
+      job_state.update!(progress: progress)
+    end
+
+    def set_job_result!(result)
+      job_state.update!(result: result)
+    end
+  end
+end

data/lib/ae_active_job_state/job_state.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module AeActiveJobState
+  class JobState < ActiveRecord::Base
+    self.table_name = 'ae_active_job_state_job_states'
+
+    validates :status, presence: true
+    validates :active_job_id, presence: true, uniqueness: { case_sensitive: false }
+
+    include AASM
+    aasm(column: 'status') do
+      state :pending, initial: true
+      state :running
+      state :finished
+      state :failed
+
+      event :run do
+        transitions from: :pending, to: :running
+        after { update!(started_at: Time.now) }
+      end
+
+      event :fail do
+        transitions from: :running, to: :failed
+        after { update!(failed_at: Time.now) }
+      end
+
+      event :finish do
+        transitions from: :running, to: :finished
+        after { update!(finished_at: Time.now) }
+      end
+    end
+  end
+end

data/lib/ae_active_job_state/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AeActiveJobState
+  VERSION = '0.1.0'
+end

data/lib/generators/ae_active_job_state/templates/create_ae_active_job_state_tables.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class CreateAeActiveJobStateTables < ActiveRecord::Migration[6.0]
+  def change
+    create_table :ae_active_job_state_job_states do |t|
+      t.timestamps null: false
+
+      t.string :status, null: false
+      t.json :args
+      t.json :result
+      t.json :progress
+
+      t.datetime :started_at
+      t.datetime :finished_at
+      t.datetime :failed_at
+
+      t.string :active_job_id, null: false, index: { unique: true }
+    end
+  end
+end

data/lib/generators/ae_active_job_state_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record/migration'
+
+class AeActiveJobStateGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+
+  source_root File.expand_path('./ae_active_job_state/templates', __dir__)
+
+  def copy_migrations
+    migration_template 'create_ae_active_job_state_tables.rb', 'db/migrate/create_ae_active_job_state_tables.rb'
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: ae_active_job_state
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AppFolio
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: Store ActiveJob status in ActiveRecord
+email: opensource@appfolio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- ae_active_job_state.gemspec
+- lib/ae_active_job_state.rb
+- lib/ae_active_job_state/delete_old_job_states_job.rb
+- lib/ae_active_job_state/has_job_state.rb
+- lib/ae_active_job_state/job_state.rb
+- lib/ae_active_job_state/version.rb
+- lib/generators/ae_active_job_state/templates/create_ae_active_job_state_tables.rb
+- lib/generators/ae_active_job_state_generator.rb
+homepage: https://github.com/appfolio/ae_active_job_state
+licenses:
+- MIT
+metadata: {}
+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.0.8
+signing_key:
+specification_version: 4
+summary: Store ActiveJob status in ActiveRecord
+test_files: []