active_job-performs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7850f0de3bce1b5668903aa8d5144c3eb220fb4655013fc0ed4424357215627d
+  data.tar.gz: b13c325e25d4f470bed021bcf4d1bc302c04953d9bb287389d532d0df1327a5d
+SHA512:
+  metadata.gz: 9790fdd3cd0812abd555f46cd3f295be1a4ed9fd5843ed4b0563fd61cf5b8c069c881f1373dae8ac2d130f3f9bddb6bc4bdf46a0f95c88ab8b5da5a98829a391
+  data.tar.gz: 659b0e1cdb12cf76f91df7f158800c71573866b132db1ed215bdced87bf72e837da7b96c1e6641b39abb6c4db35e5450bab52a4e9f7d5d04e375b5a1e8c5272b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_job-performs.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+gem "minitest-sprint"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    active_job-performs (0.1.0)
+      activejob (>= 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.3.6)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.10)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.3)
+    minitest-sprint (1.2.2)
+      path_expander (~> 1.1)
+    path_expander (1.1.1)
+    rake (13.0.6)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  active_job-performs!
+  minitest (~> 5.0)
+  minitest-sprint
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.21

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kasper Timm Hansen
+
+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,164 @@
+# ActiveJob::Performs
+
+`ActiveJob::Performs` adds the `performs` macro to set up jobs by convention.
+
+## Usage with `include GlobalID::Identification` objects
+
+`ActiveJob::Performs` works with any object that has `include GlobalID::Identification` and responds to that interface.
+
+`ActiveRecord::Base` implements this, so here's how that looks:
+
+```ruby
+class Post < ActiveRecord::Base
+  extend ActiveJob::Performs # We technically auto-extend ActiveRecord::Base, but other object hierarchies need this.
+
+  # `performs` builds a `Post::PublishJob` and routes configs over to it.
+  performs :publish, queue_as: :important, discard_on: SomeError do
+    retry_on TimeoutError, wait: :exponentially_longer
+  end
+
+  def publish
+    …
+  end
+end
+```
+
+Here's what `performs` generates under the hood:
+
+```ruby
+class Post < ActiveRecord::Base
+  # We setup a general Job class that's shared between method jobs.
+  class Job < ApplicationJob; end
+
+  # Individual method jobs inherit from the `Post::Job` defined above.
+  class PublishJob < Job
+    queue_as :important
+    discard_on SomeError
+    retry_on TimeoutError, wait: :exponentially_longer
+
+    # We generate `perform` passing in the `post` and calling `publish` on it.
+    def perform(post, *arguments, **options)
+      post.publish(*arguments, **options)
+    end
+  end
+
+  # We generate `publish_later` to wrap the job execution.
+  def publish_later(*arguments, **options)
+    PublishJob.perform_later(self, *arguments, **options)
+  end
+
+  def publish
+    …
+  end
+end
+```
+
+We generate the `Post::Job` class above to share configuration between method level jobs. E.g. if you had a retract method that was setup very similar, you could do:
+
+```ruby
+class Post < ActiveRecord::Base
+  performs queue_as: :important
+  performs :publish
+  performs :retract
+
+  def publish
+    …
+  end
+
+  def retract(reason:)
+    …
+  end
+end
+```
+
+Which would then become:
+
+```ruby
+class Post < ActiveRecord::Base
+  class Job < ApplicationJob
+    queue_as :important
+  end
+
+  class PublishJob < Job
+    …
+  end
+
+  class RetractJob < Job
+    …
+  end
+
+  …
+end
+```
+
+### Usage with ActiveRecord::AssociatedObject
+
+The [`ActiveRecord::AssociatedObject`](https://github.com/kaspth/active_record-associated_object) gem also implements `GlobalID::Identification`, so you can do this too:
+
+```ruby
+class Post::Publisher < ActiveRecord::AssociatedObject
+  extend ActiveJob::Performs # We technically auto-extend ActiveRecord::AssociatedObject, but other object hierarchies need this.
+
+  performs queue_as: :important
+  performs :publish
+  performs :retract
+
+  def publish
+    …
+  end
+
+  def retract(reason:)
+    …
+  end
+end
+```
+
+### Passing `wait` to `performs`
+
+If there's a job you want to defer, `performs` can set it for each invocation:
+
+```ruby
+class Post < ActiveRecord::Base
+  mattr_reader :config, default: Rails.application.config_for(:posts)
+
+  performs :social_media_boost, wait: config.social_media_boost_after
+  performs :social_media_boost, wait: 5.minutes # Alternatively, this works too.
+
+  # Additionally, a block can be passed to have access to the `post`:
+  performs :social_media_boost, wait: -> post { post.social_media_boost_grace_period }
+end
+```
+
+Now, `social_media_boost_later` can be called immediately, but automatically run after the grace period.
+
+`wait_until` is also supported:
+
+```ruby
+class Post < ActiveRecord::Base
+  performs :publish, wait_until: -> post { Date.tomorrow.noon if post.graceful? }
+end
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add active_job-performs
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install active_job-performs
+
+## 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/kaspth/active_job-performs.
+
+## 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,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/active_job-performs.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_job/performs/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "active_job-performs"
+  spec.version = ActiveJob::Performs::VERSION
+  spec.authors = ["Kasper Timm Hansen"]
+  spec.email = ["hey@kaspth.com"]
+
+  spec.summary = "ActiveJob::Performs adds the `performs` macro to set up jobs by convention."
+  spec.homepage = "https://github.com/kaspth/active_job-performs"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = "#{spec.homepage}/blob/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|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activejob", ">= 6.1"
+end

data/lib/active_job/performs/version.rb

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

data/lib/active_job/performs.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "performs/version"
+
+module ActiveJob; end
+module ActiveJob::Performs
+  module Waiting
+    def Proc(value)
+      value.respond_to?(:call) ? value : proc { value }
+    end unless Kernel.respond_to?(:Proc) # Optimistically assume Ruby gets this and it'll work fine.
+
+    def wait(value = nil)
+      @wait = Proc(value) if value
+      @wait
+    end
+
+    def wait_until(value = nil)
+      @wait_until = Proc(value) if value
+      @wait_until
+    end
+
+    def scoped_by_wait(record)
+      if waits = { wait: wait&.call(record), wait_until: wait_until&.call(record) }.compact and waits.any?
+        set(waits)
+      else
+        self
+      end
+    end
+  end
+
+  def performs(method = nil, **configs, &block)
+    @job ||= safe_define("Job") { ApplicationJob }.tap { _1.extend Waiting }
+
+    if method.nil?
+      apply_performs_to(@job, **configs, &block)
+    else
+      job = safe_define("#{method}_job".classify) { @job }
+      apply_performs_to(job, **configs, &block)
+
+      job.class_eval <<~RUBY, __FILE__, __LINE__ + 1 unless job.instance_method(:perform).owner == job
+        def perform(object, *arguments, **options)
+          object.#{method}(*arguments, **options)
+        end
+      RUBY
+
+      class_eval <<~RUBY, __FILE__, __LINE__ + 1
+        def #{method}_later(*arguments, **options)
+          #{job}.scoped_by_wait(self).perform_later(self, *arguments, **options)
+        end
+      RUBY
+    end
+  end
+
+  private
+    def safe_define(name)
+      name.safe_constantize || const_set(name, Class.new(yield))
+    end
+
+    def apply_performs_to(job_class, **configs, &block)
+      configs.each { job_class.public_send(_1, _2) }
+      job_class.class_exec(&block) if block_given?
+    end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: active_job-performs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kasper Timm Hansen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description:
+email:
+- hey@kaspth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_job-performs.gemspec
+- lib/active_job/performs.rb
+- lib/active_job/performs/version.rb
+homepage: https://github.com/kaspth/active_job-performs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspth/active_job-performs
+  source_code_uri: https://github.com/kaspth/active_job-performs
+  changelog_uri: https://github.com/kaspth/active_job-performs/blob/main/CHANGELOG.md
+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.3.21
+signing_key:
+specification_version: 4
+summary: ActiveJob::Performs adds the `performs` macro to set up jobs by convention.
+test_files: []