sidekiq_lifecycle_hooks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c808c622f93fbfe6d9d61ae9113ad611528b50a472d6712ac91a8a74b1ccb30
+  data.tar.gz: cb6344d7529e6972c7012fee6ace78372f3e3f98d66d02941bbc7a911dd359f8
+SHA512:
+  metadata.gz: e6a55ba37e8204b54e9de3bb1f69f8c6a8a2d1f038d52bdea79076454ee7528933b913f8a5c63943e59ae940361e7db911ca1458a45678d0ae779ae910bb77f7
+  data.tar.gz: 0c937985feab1f1a220dd419840e0534855da25797dbd01c0768720958a154251d8d33206d32f79aa5a8c31bdc7cccc97247416dfe098909060377290ab81963

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.9.0
+
+- Set up Gem

data/README.md

@@ -0,0 +1,104 @@
+# Sidekiq Lifecycle Hooks
+
+[![Gem Version](https://badge.fury.io/rb/sidekiq_lifecycle_hooks.svg)](https://badge.fury.io/rb/sidekiq_lifecycle_hooks)
+
+Async model lifecycle hooks for Rails, using Sidekiq.
+
+This Ruby on Rails gem lets you replace `after_create`, `after_update`, and `after_destroy` with asynchronous equivelants, improving the performance and decreasing the memory usage of your web server.
+
+Ideal for offloading notifications, analytics, webhooks, large DB writes and anything else that doesn't *need* to delay your response.
+
+This approach is generally easier to write and maintain than creating a whole sidekiq job for every little task. The ease of use also encourages good async hygiene.
+
+
+## Installation
+
+Setup [Sidekiq](https://github.com/sidekiq/sidekiq) as your background task runner.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq_lifecycle_hooks'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Include `SidekiqLifecycleHooks` in your ApplicationRecord
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include SidekiqLifecycleHooks
+end
+```
+
+## Usage
+
+In each model, replace any synchronous lifecycle hooks with the following:
+
+```ruby
+class MyModel < ApplicationRecord
+
+  # Replace these:
+  after_create :report_to_analytics
+  after_update :something_else
+  after_destroy :another_thing
+
+  # With these:
+  def async_after_create_actions
+    report_to_analytics
+    # and_you_can_add_more_than_one ...
+  end
+
+  def async_after_update_actions
+    something_else
+  end
+
+  def async_after_destroy_actions # READ NOTE BELOW
+    another_thing
+  end
+
+end
+```
+
+## How it works
+
+These methods enqueue a Sidekiq job called `LifecycleJob` which loads your model (or a shallow clone, if after deleting), then runs any methods required.
+
+
+## Usage notes
+
+### after_destroy creates a shallow clone
+
+async_after_destroy_actions instantiates
+`YourObject.new(previous_object_attributes)`
+and then runs the methods from this new model.
+
+Any child models of the original will already have been destroyed or rendered inaccessible. If you require those, use a regular before_destroy hook.
+
+
+### Separate mission critical actions
+
+Errors prevent subsequent methods from running.
+
+```
+  def async_after_create_actions
+    report_to_analytics
+    raise # Oops
+    create_slack_notification # Will not run
+  end
+```
+
+Enqueue mission critical tasks in seperate Sidekiq jobs.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WillTaylor22/sidekiq_lifecycle_hooks. This project is intended to be a safe, welcoming space for collaboration. Please be chill in this project's codebase and issue tracker.
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/lifecycle_job.rb

@@ -0,0 +1,21 @@
+class LifecycleJob
+  include Sidekiq::Job
+  sidekiq_options queue: :default, retry: 1
+
+  def perform(class_name, record_id, action, previous_attrs = '{}')
+    record = if action == 'destroy'
+               class_name.constantize.new(JSON.parse(previous_attrs))
+             else
+               class_name.constantize.find_by(id: record_id)
+             end
+
+    case action
+    when 'create'
+      record.async_after_create_actions
+    when 'update'
+      record.async_after_update_actions
+    when 'destroy'
+      record.async_after_destroy_actions
+    end
+  end
+end

data/lib/sidekiq_lifecycle_hooks/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SidekiqLifecycleHooks
+  VERSION = "1.0.0"
+end

data/lib/sidekiq_lifecycle_hooks.rb

@@ -0,0 +1,25 @@
+require 'lifecycle_job'
+
+module SidekiqLifecycleHooks
+  extend ActiveSupport::Concern
+
+  included do
+    after_create :enqueue_async_after_create_actions, if: -> { self.class.method_defined?(:async_after_create_actions) }
+    after_update :enqueue_async_after_update_actions, if: -> { self.class.method_defined?(:async_after_update_actions) }
+    after_destroy :enqueue_async_after_destroy_actions, if: -> { self.class.method_defined?(:async_after_destroy_actions) }
+  end
+
+  private
+
+  def enqueue_async_after_create_actions
+    LifecycleJob.perform_in(1.second, self.class.name, id, 'create')
+  end
+
+  def enqueue_async_after_update_actions
+    LifecycleJob.perform_in(1.second, self.class.name, id, 'update')
+  end
+
+  def enqueue_async_after_destroy_actions
+    LifecycleJob.perform_in(1.second, self.class.name, id, 'destroy', attributes.to_json)
+  end
+end

data/sidekiq_lifecycle_hooks.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/sidekiq_lifecycle_hooks/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sidekiq_lifecycle_hooks"
+  spec.version = SidekiqLifecycleHooks::VERSION
+  spec.authors = ["Will Taylor"]
+  spec.email = ["wrftaylor@gmail.com"]
+
+  spec.summary = "Asynchronous lifecycle hooks for rails apps using sidekiq."
+  spec.homepage = "https://github.com/WillTaylor22/sidekiq_lifecycle_hooks."
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/WillTaylor22/sidekiq_lifecycle_hooks"
+  spec.metadata["changelog_uri"] = "https://raw.githubusercontent.com/WillTaylor22/sidekiq_lifecycle_hooks/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/sig/sidekiq_lifecycle_hooks.rbs

@@ -0,0 +1,3 @@
+module SidekiqLifecycleHooks
+  VERSION: 0.9.0
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_lifecycle_hooks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Will Taylor
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-02 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- wrftaylor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/lifecycle_job.rb
+- lib/sidekiq_lifecycle_hooks.rb
+- lib/sidekiq_lifecycle_hooks/version.rb
+- sidekiq_lifecycle_hooks.gemspec
+- sig/sidekiq_lifecycle_hooks.rbs
+homepage: https://github.com/WillTaylor22/sidekiq_lifecycle_hooks.
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/WillTaylor22/sidekiq_lifecycle_hooks.
+  source_code_uri: https://github.com/WillTaylor22/sidekiq_lifecycle_hooks
+  changelog_uri: https://raw.githubusercontent.com/WillTaylor22/sidekiq_lifecycle_hooks/main/CHANGELOG.md
+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.4.20
+signing_key:
+specification_version: 4
+summary: Asynchronous lifecycle hooks for rails apps using sidekiq.
+test_files: []