active_job-inlined 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89782b40c03fd934069853898a20d23838c3d7c9a1c04a35d43a66ed5f681952
+  data.tar.gz: fd51b2a53836b3fb1edd122cbce929940aaa47b4adbc213e2932d4ce193cfc87
+SHA512:
+  metadata.gz: 1942d43ec4559b193cbae3a22d5771532c80b14e4a2c8df7e0819c50fc7a64f17db9699f0d565c8978876b170d5be9eceaea68bc5b137c7acc447c77f1a944af
+  data.tar.gz: d2b8bdd83c8b0b78e1209011cb958ad4d11239cc7bcd170a70d80c33501476f200a11478ae431d31e71120feff9d1a358e53faeadce1a37f83667805942e3586

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_job-inlined.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-inlined (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-inlined!
+  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,78 @@
+# ActiveJob::Inlined
+
+`ActiveJob::Inlined` lets you run jobs inline within other jobs.
+
+Set this up in your app:
+
+```ruby
+class ApplicationJob < ActiveJob::Base
+  extend ActiveJob::Inlined
+end
+```
+
+Then use it:
+
+```ruby
+class Post < ActiveRecord::Base
+  def release_later
+    Release::SequenceJob.perform_later self
+  end
+
+  def release
+    prep_marketing_department pizzazz_required: "✨✨✨✨"
+    some_other_step
+    # …then more stuff in the sequence, but at one point we run:
+    publish_later
+  end
+
+  def publish_later
+    # Now, we mark the job as `inlined`, i.e. we'll really call `perform_now`
+    # if we're within another job (or do the usual `perform_later` if not).
+    PublishJob.inlined.perform_later self
+  end
+
+  def publish
+    puts "lol"
+  end
+end
+
+class Post::Release::SequenceJob < ApplicationJob
+  def perform(post)
+    post.release
+  end
+end
+
+class Post::PublishJob < ApplicationJob
+  def perform(post)
+    post.publish
+  end
+end
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add active_job-inlined
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install active_job-inlined
+
+## 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/kaspth/active_job-inlined.
+
+## 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-inlined.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_job/inlined/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "active_job-inlined"
+  spec.version = ActiveJob::Inlined::VERSION
+  spec.authors = ["Kasper Timm Hansen"]
+  spec.email = ["hey@kaspth.com"]
+
+  spec.summary = "ActiveJob::Inlined lets you run jobs inline within other jobs."
+  spec.homepage = "https://github.com/kaspth/active_job-inlined"
+  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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activejob", ">= 6.1"
+end

data/lib/active_job/execution_context.rb

@@ -0,0 +1,25 @@
+require "active_support"
+require "active_support/current_attributes"
+
+class ActiveJob::ExecutionContext < ActiveSupport::CurrentAttributes
+  module Integration
+    def self.included(job)
+      job.before_perform :set_context_job
+      job.singleton_class.delegate :executing?, to: ActiveJob::ExecutionContext
+    end
+
+    def set_context_job
+      ActiveJob::ExecutionContext.job = self
+    end
+  end
+
+  attribute :job
+
+  def executing?
+    job.present?
+  end
+
+  def in_job?(object)
+    executing? && job.arguments.include?(object)
+  end
+end

data/lib/active_job/inlined/version.rb

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

data/lib/active_job/inlined.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "inlined/version"
+
+module ActiveJob; end
+require_relative "execution_context"
+
+module ActiveJob::Inlined
+  using Module.new {
+    refine Module do
+      def invert_method(invert_method, original_method)
+        class_eval "def #{invert_method}; !#{original_method}; end", __FILE__, __LINE__ + 1
+      end
+    end
+  }
+
+  def self.extended(klass)
+    klass.include ActiveJob::ExecutionContext::Integration
+  end
+
+  def inlined
+    inlineable? ? Proxy.new(self) : self
+  end
+
+  def inlineable?
+    executing? && inline_enrolled?
+  end
+
+  def inline_exempt?
+    @inline_exemption&.call(self)
+  end
+  invert_method :inline_enrolled?, :inline_exempt?
+
+  # By default, jobs are considered inlineable. But they can declare themselves
+  # exempt by calling `inline_exempt`, like this:
+  #
+  #   class Post::PublishJob < ApplicationJob
+  #     inline_exempt
+  #     inline_exempt -> job { job.arguments.size.even? }
+  #     inline_exempt { |job| job.arguments.size.even? }
+  #   end
+  def inline_exempt(context = nil, &block)
+    @inline_exemption = context || block || -> { true }
+  end
+
+  class Proxy
+    def initialize(job)
+      @job = job
+    end
+
+    def perform_later(...)
+      @job.perform_now(...)
+      nil
+    end
+
+    def self.chains_on(method)
+      class_eval "def #{method}(...); self.class.new @job.#{method}(...); end", __FILE__, __LINE__ + 1
+    end
+    chains_on :set
+    chains_on :with
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: active_job-inlined
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kasper Timm Hansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-26 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-inlined.gemspec
+- lib/active_job/execution_context.rb
+- lib/active_job/inlined.rb
+- lib/active_job/inlined/version.rb
+homepage: https://github.com/kaspth/active_job-inlined
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspth/active_job-inlined
+  source_code_uri: https://github.com/kaspth/active_job-inlined
+  changelog_uri: https://github.com/kaspth/active_job-inlined/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::Inlined lets you run jobs inline within other jobs.
+test_files: []