sidekiq-sequence 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c624a6fd72d24ee9e41f0efc66acbab3ae57fc99ddc38121c76b25f34b2dbf95
+  data.tar.gz: 7af58740782a790349cfcb31416eda672310782887270e5709c905b6f3d5f518
+SHA512:
+  metadata.gz: 98b0ec2a669b2b8b632f00494b48aa5e3a953e297b4ca09fd5f5402c763f96c1ae441e9276ab37d139bbbd71fb4b937a0e546ca92bafadfe0dd00f6c25e841e0
+  data.tar.gz: 295b926a199219d4b9a0f8df2e877ab0a9aedd658fe4afc40bc1d9c01055d8fd6a04cdf0461fb3a0e8dcd476a8ad3f7e19e4ea7288eb3a8b58ae28e06829bbde

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joel@developwithstyle.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-sequence.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Joel Moss
+
+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,99 @@
+# Sidekiq::Sequence - Sequential Sidekiq jobs.
+
+Sidekiq is awesome, but it doesn't provide any support for sequential jobs, where a sequence of jobs must be run in a set order. Sidekiq::Sequence provides a simple but powerful framework to run a sequence of Sidekiq jobs.
+
+Sidekiq::Sequence is currently only intended for use in Rails applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-sequence'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sidekiq-sequence
+
+Run the Rails generator to install the database migration:
+
+    $ rails g sidekiq_sequence:install
+    $ rails db:migrate
+
+## Usage
+
+Start with a Sequence class which inherits from `Sidekiq::Sequence::Base`, and define each step of the sequence:
+
+```ruby
+class ContactFormSequence < Sidekiq::Sequence::Base
+  step CreateMessage
+  step AssignMessage
+end
+```
+
+Each step should be a class that includes `Sidekiq::Sequence::Worker`, and behaves just like a regular Sidekiq Worker:
+
+```ruby
+class ContactFormSequence::CreateMessage
+  include Sidekiq::Sequence::Worker
+
+  def perform
+    # Perform your job
+  end
+end
+```
+
+Each Step is run in the order they are defined, and each is a Sidekiq worker. If a worker fails, subsequent steps will not be run, and the worker will be placed in the Sidekiq retry queue. Once it succeeds, the next stepo will be run, and so on.
+
+Start a Sequence by simply initializing the Sequence class you created:
+
+```ruby
+ContactFormSequence.new name: 'Joel', github: 'joelmoss'
+```
+
+You can pass named arguments, and these will be persisted and available in the Sequence and its workers:
+
+```ruby
+class ContactFormSequence::AssignMessage
+  include Sidekiq::Sequence::Worker
+
+  def perform
+    @data # -> { name: 'Joel', github: 'joelmoss' }
+  end
+end
+```
+
+You can also modify Sequence `data` in any worker, which is great for passing data to subsequent steps:
+
+```ruby
+class ContactFormSequence::CreateMessage
+  include Sidekiq::Sequence::Worker
+
+  def perform
+    @data[:message] = 'my message' # @data is now { name: 'Joel', github: 'joelmoss', message: 'my message' }
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/sidekiq-sequence. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joelmoss/sidekiq-sequence/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sidekiq::Sequence project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joelmoss/sidekiq-sequence/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/app/models/sidekiq/sequence/record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Sidekiq::Sequence::Record < ApplicationRecord
+  def self.table_name_prefix
+    'sidekiq_sequence_'
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/sequence"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/sidekiq_sequence/install_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module SidekiqSequence
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.join(__dir__, 'templates')
+
+      desc 'Install Sidekiq::Sequence, including a database migration.'
+
+      def copy_migration
+        migration_template 'migration.rb', 'db/migrate/create_sidekiq_sequence_record.rb',
+                           migration_version: migration_version
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/sidekiq_sequence/templates/migration.rb.tt

@@ -0,0 +1,9 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :sidekiq_sequence_records do |t|
+      t.jsonb :data, default: {}
+      t.integer :current_step, default: 0
+      t.timestamps
+    end
+  end
+end

data/lib/sidekiq/sequence.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'sidekiq/sequence/version'
+require 'sidekiq/sequence/engine'
+require 'sidekiq/sequence/base'
+require 'sidekiq/sequence/worker'
+
+module Sidekiq
+  module Sequence
+  end
+end

data/lib/sidekiq/sequence/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Sequence
+    # rubocop:disable Style/ClassVars
+    class Base
+      @@steps = []
+
+      def self.step(worker_class)
+        @@steps << worker_class
+      end
+
+      def self.perform_step(index, id)
+        if index >= @@steps.size
+          # No more steps in the sequence, so delete the record.
+          Record.destroy id
+        else
+          @@steps[index].perform_async id
+        end
+      end
+
+      def initialize(data = {})
+        record = Record.create(data: data)
+
+        # Start first job in the sequence.
+        @@steps.first.perform_async record.id
+      end
+    end
+    # rubocop:enable Style/ClassVars
+  end
+end

data/lib/sidekiq/sequence/engine.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Sequence
+    class Engine < ::Rails::Engine
+      isolate_namespace Sidekiq::Sequence
+    end
+  end
+end

data/lib/sidekiq/sequence/perform.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Sequence
+    module Perform
+      def perform(id, *args)
+        @record = Record.find(id)
+        @data = @record.data.with_indifferent_access
+
+        super(*args)
+
+        @record.increment(:current_step).save!
+
+        # Perform the next in sequence.
+        self.class.parent.perform_step @record.current_step, @record.id
+      end
+    end
+  end
+end

data/lib/sidekiq/sequence/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Sequence
+    VERSION = '0.1.0'
+  end
+end

data/lib/sidekiq/sequence/worker.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'sidekiq/sequence/perform'
+
+module Sidekiq
+  module Sequence
+    module Worker
+      extend ActiveSupport::Concern
+
+      included do
+        include Sidekiq::Worker
+        prepend Perform
+      end
+    end
+  end
+end

data/sidekiq-sequence.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'lib/sidekiq/sequence/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-sequence'
+  spec.version       = Sidekiq::Sequence::VERSION
+  spec.authors       = ['Joel Moss']
+  spec.email         = ['joel@developwithstyle.com']
+
+  spec.summary       = 'Sequential Sidekiq jobs'
+  spec.description   = 'Create and manage sequential jobs in Sidekiq'
+  spec.homepage      = 'https://github.com/joelmoss/sidekiq-sequence'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/releases"
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-sequence
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Moss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-12 00:00:00.000000000 Z
+dependencies: []
+description: Create and manage sequential jobs in Sidekiq
+email:
+- joel@developwithstyle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/sidekiq/sequence/record.rb
+- bin/console
+- bin/setup
+- lib/generators/sidekiq_sequence/install_generator.rb
+- lib/generators/sidekiq_sequence/templates/migration.rb.tt
+- lib/sidekiq/sequence.rb
+- lib/sidekiq/sequence/base.rb
+- lib/sidekiq/sequence/engine.rb
+- lib/sidekiq/sequence/perform.rb
+- lib/sidekiq/sequence/version.rb
+- lib/sidekiq/sequence/worker.rb
+- sidekiq-sequence.gemspec
+homepage: https://github.com/joelmoss/sidekiq-sequence
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joelmoss/sidekiq-sequence
+  source_code_uri: https://github.com/joelmoss/sidekiq-sequence
+  changelog_uri: https://github.com/joelmoss/sidekiq-sequence/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Sequential Sidekiq jobs
+test_files: []