mandate-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 555c90a9d4bb24a987ce7c525393d171291945e96469c26b10b6bc506ea83029
+  data.tar.gz: 07f8b6e0c6d04e19a4ecc9b0e7997ed1c290af31204e229887092513c4a2ff54
+SHA512:
+  metadata.gz: 2a69a1a821353a7da03b26d442e5e060719785c1098c221795e4d3bbd4996c382d9491800443a58dff40769531422c2f84b6ebd190d440521b3e5d1cdd1cce84
+  data.tar.gz: 071f3b01a9d8f80e5ddb1a737f650bcf8259abfe395fb1c6bb075623a3e6cbc18b47d3ed690f3ddc8c4e583f5861f725ba3755b94c80b796e31870cfc4266f92

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jeremy Walker
+
+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,35 @@
+# Mandate::Rails
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mandate/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/[USERNAME]/mandate-rails.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/mandate/rails/active_job_queuer.rb

@@ -0,0 +1,45 @@
+require_relative "./mandate_job"
+  module Mandate
+    module ActiveJobQueuer
+      def self.extended(base)
+        class << base
+          def queue_as(queue)
+            @active_job_queue = queue
+          end
+  
+          def active_job_queue
+            @active_job_queue || :default
+          end
+        end
+      end
+  
+      def defer(*args, wait: nil, **kwargs)
+        # We need to convert the jobs to a hash before we serialize as there's no serialization
+        # format for a job. We do this here to avoid cluttering the codebase with this logic.
+        if (prereqs = kwargs.delete(:prereq_jobs))
+          prereqs.map! do |job|
+            {
+              job_id: job.provider_job_id,
+              queue_name: job.queue_name
+            }
+          end
+          kwargs[:prereq_jobs] = prereqs if prereqs.present?
+        end
+  
+        MandateJob.set(
+          queue: active_job_queue,
+          wait:
+        ).perform_later(self.name, *args, **kwargs)
+      end
+    end
+  
+    def self.included(base)
+      # Upstream
+      base.extend(Memoize)
+      base.extend(CallInjector)
+      base.extend(InitializerInjector)
+  
+      # New
+      base.extend(ActiveJobQueuer)
+    end
+  end

data/lib/mandate/rails/mandate_job.rb

@@ -0,0 +1,60 @@
+require 'application_job'
+
+class MandateJob < ApplicationJob
+  class MandateJobNeedsRequeuing < RuntimeError
+    attr_reader :wait
+
+    def initialize(wait)
+      @wait = wait
+      super(nil)
+    end
+  end
+
+  class PreqJobNotFinishedError < RuntimeError
+    def initialize(job_id)
+      @job_id = job_id
+      super(nil)
+    end
+
+    def to_s
+      "Unfinished job: #{job_id}"
+    end
+
+    private
+    attr_reader :job_id
+  end
+
+  def perform(cmd, *args, **kwargs)
+    __guard_prereq_jobs__!(kwargs.delete(:prereq_jobs))
+
+    instance = cmd.constantize.new(*args, **kwargs)
+    instance.define_singleton_method(:requeue_job!) { |wait| raise MandateJobNeedsRequeuing, wait }
+    self.define_singleton_method :guard_against_deserialization_errors? do
+      return true unless instance.respond_to?(:guard_against_deserialization_errors?)
+
+      instance.guard_against_deserialization_errors?
+    end
+
+    instance.()
+  rescue MandateJobNeedsRequeuing => e
+    cmd.constantize.defer(
+      *args,
+      **kwargs.merge(wait: e.wait)
+    )
+  end
+
+  def __guard_prereq_jobs__!(prereq_jobs)
+    return unless prereq_jobs.present?
+
+    prereq_jobs.each do |job|
+      jid = job[:job_id]
+
+      # If the job is either in its queue, or in the retry queue
+      # then we raise an exception to abort the job and retry later.
+      if Sidekiq::Queue.new(job[:queue_name]).find_job(jid) ||
+         Sidekiq::RetrySet.new.find_job(jid)
+        raise PreqJobNotFinishedError, jid
+      end
+    end
+  end
+end

data/lib/mandate/rails/railtie.rb

@@ -0,0 +1,7 @@
+module MandateRails
+  class Railtie < Rails::Railtie
+    initializer "mandate_rails.configure_rails_initialization" do
+      require_relative './active_job_queuer'
+    end
+  end
+end

data/lib/mandate/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mandate
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/mandate/rails.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "mandate"
+require_relative "rails/version"
+
+module Mandate
+  module Rails
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end
+
+require_relative "./rails/railtie" if defined?(Rails::Railtie)

data/mandate-rails.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/mandate/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mandate-rails"
+  spec.version = Mandate::Rails::VERSION
+  spec.authors = ["Jeremy Walker"]
+  spec.email = ["jez.walker@gmail.com"]
+
+  spec.summary = "Rails integration for Mandate"
+  # spec.description = "TODO: Write a longer description or delete this line."
+  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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 .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/mandate/rails.rbs

@@ -0,0 +1,6 @@
+module Mandate
+  module Rails
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: mandate-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Walker
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-01 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- jez.walker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mandate/rails.rb
+- lib/mandate/rails/active_job_queuer.rb
+- lib/mandate/rails/mandate_job.rb
+- lib/mandate/rails/railtie.rb
+- lib/mandate/rails/version.rb
+- mandate-rails.gemspec
+- sig/mandate/rails.rbs
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Rails integration for Mandate
+test_files: []