jobify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa64c39d98c548e4f10f34c979871bf027a20f551b9b17d4c6961ea4288a7896
+  data.tar.gz: 784be3e225ff0a7405d315d799bb8b8d30e612fd5bc8a8b0fb765302c6099cd0
+SHA512:
+  metadata.gz: f04966afa10e6d96dd9dbf6cb728d654c46bf3041bfbca4048dde85eb134894288b5e57a3642ff114f67a820fa8189853b97f692bc22a6ce4b7901a8d43ea84e
+  data.tar.gz: a6a86a55a01e7c465722ae779b9e6466c579a4731c074635d821b73ebbde7dc2ed453e0d52269149aa8d79561a08e8c3143905ff6e900986681913d7348fbaef

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'test/*'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 150

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2022-10-25
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jobify.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    jobify (0.1.0)
+      activejob
+      activesupport
+
+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)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rubocop (1.37.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.22.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  jobify!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Søren Houen
+
+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,133 @@
+# Jobify
+
+Run any method as a background job with `perform_my_method_later`. Works with both instance and class methods.
+
+## Why?
+
+I think we as Rails developers are not using background processing as much as we could / should.
+
+I believe this is largely because of 3 things:
+
+- The extra work required to create a new MyTinyJob class
+- The added complexity from moving code away from its natural and cohesive location in the project and into app/jobs
+- The extra work required to _maintain_ a tiny MyTinyJob class
+
+In short, the activation energy to use background jobs is too high.
+
+Jobify lowers the activation energy to `jobify :my_method` to generate an activejob job class, and calling `perform_my_method_later`
+
+## Usage
+
+```
+class SomeClass
+  include Jobify
+  
+  def self.my_method(arg1, kw_arg:) 
+    puts "...#{arg1} #{kw_arg}'s which would be handy to do async..."
+  end
+  jobify :my_method
+end
+
+SomeClass.perform_my_method_later(42, kw_arg: 'flum')
+```
+
+Output:
+
+```
+[ActiveJob] Enqueued SomeClass::JobifyClassMethod_my_method_Job (Job ID: 8fc2ca69-cb31-4f73-a908-e98acb8a2832) to Async(default) with arguments: 42, {:kw_arg=>"flum"}
+[ActiveJob] [SomeClass::JobifyClassMethod_my_method_Job] [8fc2ca69-cb31-4f73-a908-e98acb8a2832] Performing SomeClass::JobifyClassMethod_my_method_Job (Job ID: 8fc2ca69-cb31-4f73-a908-e98acb8a2832) from Async(default) enqueued at 2022-10-25T19:11:46Z with arguments: 42, {:kw_arg=>"flum"}
+=>
+#<SomeClass::JobifyClassMethod_my_method_Job:0x00007fee638d9cb8
+ @arguments=[42, {:kw_arg=>"flum"}],
+ @exception_executions={},
+ @executions=0,
+ @job_id="8fc2ca69-cb31-4f73-a908-e98acb8a2832",
+ @priority=nil,
+ @provider_job_id="8dc0614f-a229-4648-9308-4e6add9f666c",
+ @queue_name="default",
+ @successfully_enqueued=true,
+ @timezone=nil>
+...42 flum's which would be handy to do async...
+[ActiveJob] [SomeClass::JobifyClassMethod_my_method_Job] [8fc2ca69-cb31-4f73-a908-e98acb8a2832] Performed SomeClass::JobifyClassMethod_my_method_Job (Job ID: 8fc2ca69-cb31-4f73-a908-e98acb8a2832) from Async(default) in 4.57ms
+```
+
+### Features
+
+- Jobifies class methods
+- Jobifies instance methods
+- Verifies correct arguments are given when enqueing a job
+- Small overhead added: 0.06 ms boot and 0.1ms on perform
+- Override perform_xyz_later method with whatever name you prefer (eg. `jobify :my_method, name: :my_method_async`)
+
+### Instance methods
+
+Instance methods work out of the box if your class inherits from `ApplicationRecord` or `ActiveRecord::Base`
+
+If your class does not inherit from these it must supply `#id` and `.find(id)` methods to use `jobify` on
+instance methods.
+
+### How it works
+Calling `jobify :my_method` will declare two things:
+- A new activejob job class as subclass of the class where it is called. This class `#perform` method will call the original method using `public_send`. 
+- A `perform_my_method_later` method, which will perform the job later. 
+  - `perform_my_method_later` will raise unless given the same arguments as `my_method`.
+
+#### Instance methods
+Jobifying instance methods work by adding a special id keyword argument to `JobifyInstanceMethod_xyz_Job#perform`:
+
+- When called, `#perform_xyz_later` gets the id of the instance via `instance#id`.
+- The id is passed to the jobs `#perform` method as extra argument (`:__jobify__record_id`).
+- `#perform` method uses this to find the record and then run the instance method on the record.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add jobify
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install jobify
+
+### Overhead
+
+Benchmarks from running on a 2020 i7 Macbook Pro:
+
+(Generate benchmarks by running `BENCHMARK=10_000 rake test` where env BENCHMARK is the number of iterations to run)
+```
+Benchmark boot: 0.058 ms on avg of 100000 iterations
+Benchmark perform: 0.228 ms on avg of 100000 iterations
+Benchmark perform_control: 0.128 ms on avg of 100000 iterations
+```
+
+**Boot overhead:**
+
+Jobify adds ~ 0.06 ms avg overhead per call.
+So if you used `jobify :something` 100 times in your code, you would add ~ 6 ms overhead to boot time.
+
+**Run job overhead**
+
+Jobify adds ~ 0.1 ms overhead to running a job. Performing via jobify takes ~ 0.23 ms versus ~ 0.13 ms for normal
+ActiveJob execution.
+For all but the most massively-scheduled-all-the-time jobs, this should be fine.
+
+## 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).
+
+### TODO
+- Allow to add options to `jobify`, eg. `queue_as: :default`
+- Allow to add global options, eg queue_as, prefix:, suffix:
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/houen/jobify.
+
+## 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,16 @@
+# frozen_string_literal: true
+
+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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/jobify/version.rb

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

data/lib/jobify.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require_relative "jobify/version"
+
+require "active_support"
+require "active_job"
+
+class MissingArgument < ArgumentError; end
+
+class MissingKeywordArgument < ArgumentError; end
+
+# Include to allow running any method as a background job automatically
+module Jobify
+  extend ActiveSupport::Concern
+
+  ID_ARG_NAME = :__jobify__record_id
+
+  included do
+    @jobified_methods = {
+      instance: {},
+      singleton: {}
+    }
+
+    def self.jobify(method_name, job_method_name: "perform_#{method_name}_later")
+      raise "method name cannot be blank" if method_name.blank?
+
+      method_name = method_name.to_s
+
+      if method_defined?(method_name) && !@jobified_methods[:instance][method_name]
+        # Instance method
+        params = instance_method(method_name).parameters
+        _define_job_class(method_name, job_method_name, params, false)
+        @jobified_methods[:instance][method_name] = true
+      elsif respond_to?(method_name) && !@jobified_methods[:singleton][method_name]
+        # Singleton method (Class method)
+        params = method(method_name).parameters
+        _define_job_class(method_name, job_method_name, params, true)
+        @jobified_methods[:singleton][method_name] = true
+      end
+    end
+
+    def self._define_job_class(method_name, job_method_name, params, singleton_method)
+      job_class_name = singleton_method ? "JobifyClassMethod_#{method_name}_Job" : "JobifyInstanceMethod_#{method_name}_Job"
+      parent_class = defined?(ApplicationJob) ? ApplicationJob : ActiveJob::Base
+      job_class    = Class.new(parent_class)
+      caller_class = self
+      const_set(job_class_name, job_class)
+
+      # Define perform method on job class
+      if singleton_method
+        singleton__define_job_perform_method(job_class, caller_class, method_name)
+        singleton__define_job_enqueue_method(job_class, job_method_name, params)
+      else
+        instance__define_job_perform_method(job_class, caller_class, method_name)
+        instance__define_job_enqueue_method(job_class, job_method_name, params)
+      end
+    end
+
+    def self.singleton__define_job_perform_method(job_class, caller_class, method_name)
+      job_class.define_method(:perform) do |*args, **kw_args|
+        if kw_args.empty?
+          caller_class.public_send(method_name, *args)
+        else
+          caller_class.public_send(method_name, *args, **kw_args)
+        end
+      end
+    end
+
+    def self.singleton__define_job_enqueue_method(job_class, job_method_name, params)
+      define_singleton_method(job_method_name) do |*args, **kw_args|
+        req_args    = params.filter_map { _1[0] == :req ? _1[1] : nil }
+        req_kw_args = params.filter_map { _1[0] == :keyreq ? _1[1] : nil }
+
+        ensure_required_kw_args_present!(req_kw_args, kw_args)
+        ensure_all_args_present!(req_args, args)
+
+        if kw_args.empty?
+          job_class.perform_later(*args)
+        else
+          job_class.perform_later(*args, **kw_args)
+        end
+      end
+    end
+
+    def self.instance__define_job_perform_method(job_class, caller_class, method_name)
+      job_class.define_method(:perform) do |*args, **kw_args|
+        id = kw_args.delete(ID_ARG_NAME)
+        raise "Something has gone wrong. Record id is required" unless id
+
+        record = caller_class.find(id)
+        record.public_send(method_name, *args, **kw_args)
+      end
+    end
+
+    def self.instance__define_job_enqueue_method(job_class, job_method_name, params)
+      define_method(job_method_name) do |*args, **kw_args|
+        req_args    = params.filter_map { _1[0] == :req ? _1[1] : nil }
+        req_kw_args = params.filter_map { _1[0] == :keyreq ? _1[1] : nil }
+        self.class.ensure_required_kw_args_present!(req_kw_args, kw_args)
+        self.class.ensure_all_args_present!(req_args, args)
+
+        # Instance method adds
+        kw_args[ID_ARG_NAME] = id
+        job_class.perform_later(*args, **kw_args)
+      end
+    end
+
+    def self.ensure_required_kw_args_present!(req_kw_args, kw_args)
+      req_kw_args.each do |key|
+        next if kw_args.key?(key)
+
+        raise ::MissingKeywordArgument, "Missing require keyword argument `#{key}`"
+      end
+    end
+
+    def self.ensure_all_args_present!(req_args, args)
+      num_args_required = req_args.size
+      num_args_given    = args.size
+
+      return if num_args_given >= num_args_required
+
+      raise ::MissingArgument, "Not enough arguments. Method expects #{num_args_required}. Got #{num_args_given}"
+    end
+
+    def ensure_required_kw_args_present!(req_kw_args, kw_args)
+      self.class.ensure_required_kw_args_present!(req_kw_args, kw_args)
+    end
+
+    def ensure_all_args_present!(req_args, args)
+      self.class.ensure_all_args_present!(req_args, args)
+    end
+  end
+end

data/sig/jobify.rbs

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

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: jobify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Søren Houen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- s@houen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jobify.rb
+- lib/jobify/version.rb
+- sig/jobify.rbs
+homepage: https://github.com/houen/jobify
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/houen/jobify
+  source_code_uri: https://github.com/houen/jobify
+  changelog_uri: https://github.com/houen/jobify/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.2.32
+signing_key:
+specification_version: 4
+summary: Turn any method into a background job (`jobify :hello_world` generates `def
+  hello_world_job`
+test_files: []