lazy_resque 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 932955e116273e9815105f8a31183ff6663ee69f
+  data.tar.gz: 32cdfc108e4184e3b17ebb3f3668c698f943843c
+SHA512:
+  metadata.gz: 908d279cadc2a913d07b4ba50c7852a3333910035604c3130e55641ac1aea48ba1a6eefa45df12315eef39668189d47b3d6a694af14e33c2a0fb9a476b659e50
+  data.tar.gz: 744b9cb891525c0a9edee361aa1beee98219048a093d32550a243e1f4dc980ad01d2a62db0c391c5a5172bddcf5f35fa34cb8eba6436d238122a6a7b1d199c2f

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.0.1
+
+  * Initial release

data/Gemfile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lazy_resque.gemspec
+gemspec
+
+group :development, :test do
+  gem 'activesupport'
+  gem 'guard-livereload', require: false
+  gem 'guard-rspec'
+  gem 'pry-byebug'
+  gem 'rb-fsevent', require: false
+  gem 'rb-readline'
+  gem 'reek'
+  gem 'request_store_rails'
+  gem 'resque'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'rubocop-rspec'
+end
+
+group :development do
+  gem 'spring'
+  gem 'spring-watcher-listen'
+end
+
+group :test do
+  gem 'simplecov'
+  gem 'spring-commands-rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,193 @@
+PATH
+  remote: .
+  specs:
+    lazy_resque (0.0.1)
+      activesupport (>= 5.0.0)
+      request_store_rails (>= 1.0.3)
+      resque
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    byebug (10.0.2)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    equalizer (0.0.11)
+    eventmachine (1.2.5)
+    ffi (1.9.23)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-livereload (2.5.2)
+      em-websocket (~> 0.5)
+      guard (~> 2.8)
+      guard-compat (~> 1.0)
+      multi_json (~> 1.8)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    http_parser.rb (0.6.0)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    mono_logger (1.1.0)
+    multi_json (1.13.1)
+    mustermann (1.0.1)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.0.5)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rack (2.0.4)
+    rack-protection (2.0.0)
+      rack
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rb-readline (0.5.5)
+    redis (3.3.5)
+    redis-namespace (1.5.3)
+      redis (~> 3.0, >= 3.0.4)
+    reek (4.8.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.5.0.0, < 2.6)
+      rainbow (~> 3.0)
+    request_store_rails (1.0.3)
+      concurrent-ruby (~> 1.0)
+    resque (1.27.4)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.3)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.25.0)
+      rubocop (>= 0.53.0)
+    ruby-progressbar (1.9.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sinatra (2.0.0)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.0)
+      tilt (~> 2.0)
+    spring (2.0.2)
+      activesupport (>= 4.2)
+    spring-commands-rspec (1.0.4)
+      spring (>= 0.9.1)
+    spring-watcher-listen (2.0.1)
+      listen (>= 2.7, < 4.0)
+      spring (>= 1.2, < 3.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (>= 1.13)
+  guard-livereload
+  guard-rspec
+  lazy_resque!
+  pry-byebug
+  rake (>= 10.0)
+  rb-fsevent
+  rb-readline
+  reek
+  request_store_rails
+  resque
+  rspec
+  rubocop
+  rubocop-rspec
+  simplecov
+  spring
+  spring-commands-rspec
+  spring-watcher-listen
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'livereload' do
+  extensions = {
+    css: :css,
+    scss: :css,
+    sass: :css,
+    js: :js,
+    coffee: :js,
+    html: :html,
+    png: :png,
+    gif: :gif,
+    jpg: :jpg,
+    jpeg: :jpeg,
+    # less: :less, # uncomment if you want LESS stylesheets done in browser
+  }
+
+  rails_view_exts = %w[erb haml slim]
+
+  # file types LiveReload may optimize refresh for
+  compiled_exts = extensions.values.uniq
+  watch(%r{public/.+\.(#{compiled_exts * '|'})})
+
+  extensions.each do |ext, type|
+    watch(%r{
+          (?:app|vendor)
+          (?:/assets/\w+/(?<path>[^.]+) # path+base without extension
+           (?<ext>\.#{ext})) # matching extension (must be first encountered)
+          (?:\.\w+|$) # other extensions
+          }x) do |m|
+      path = m[1]
+      "/assets/#{path}.#{type}"
+    end
+  end
+
+  # file needing a full reload of the page anyway
+  watch(%r{app/views/.+\.(#{rails_view_exts * '|'})$})
+  watch(%r{app/helpers/.+\.rb})
+  watch(%r{config/locales/.+\.yml})
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+  end
+end

data/README.md

@@ -0,0 +1,45 @@
+![lazyresque](https://user-images.githubusercontent.com/2643026/41417090-4bbacb40-6fe4-11e8-809e-3951e3dcd3a5.jpg)
+
+# Lazy Resque
+
+Move Resque enqueues out of the Rails request cycle to help decrease time to first byte.
+
+## Install
+
+From gem:
+```
+gem 'lazy_resque'
+```
+
+From source:
+```
+gem 'lazy_resque', git: 'git@github.com:samuelgiles/lazy_resque.git'
+```
+
+## Use
+
+Trigger the actual enqueue of the jobs after the request in an `after_action` block, this can be done
+by including `LazyResque::ControllerEnqueue` which will automatically add the `after_action` for you.
+
+```ruby
+class ApplicationController < ActionController::Base
+  include LazyResque::ControllerEnqueue
+
+  def index
+    Resque.lazy_enqueue(MyResqueJob, 1234, 'some_job_data')
+  end
+end
+```
+
+## Why?
+
+Though moving a long running task to a Resque job is beneficial the actual enqueuing process isn't free:
+
+- Any `before_enqueue` hooks are run
+- A new job instance is initialized and validated
+- Arguments are dumped/encoded into JSON
+- Redis `rpush` takes places requiring communication with the Redis server
+
+This is fine for 1-2 enqueues in a request cycle but can add up to a measurable amount of time if your enqueuing several jobs.
+
+You don't lose anything by moving the actual enqueuing outside  the request cycle and it saves precious milliseconds.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lazy_resque'
+
+# 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

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/lazy_resque.gemspec

@@ -0,0 +1,29 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lazy_resque/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lazy_resque'
+  spec.version       = LazyResque::VERSION
+  spec.authors       = ['Bellroy Tech Team']
+  spec.email         = ['tech@bellroy.com']
+
+  spec.summary       = 'Lazy Resque'
+  spec.description   = 'Moves Resque enqueues out of the request cycle in a Rails application.'
+  spec.homepage      = 'https://github.com/samuelgiles/lazy_resque'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 1.13'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_runtime_dependency 'activesupport', '>= 5.0.0'
+  spec.add_runtime_dependency 'request_store_rails', '>= 1.0.3'
+  spec.add_runtime_dependency 'resque'
+end

data/lib/lazy_resque.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'lazy_resque/version'
+require 'lazy_resque/lazy_enqueue'
+require 'lazy_resque/resque_extensions'
+require 'lazy_resque/controller_enqueue'
+
+Resque.extend(LazyResque::ResqueExtensions)

data/lib/lazy_resque/controller_enqueue.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'resque'
+require 'active_support/all'
+
+module LazyResque
+  # A controller concern that appends an after_action to ensure the
+  # lazily enqueued Resque enqueues during the request cycle are actually
+  # enqueued at the end of the request.
+  module ControllerEnqueue
+    extend ActiveSupport::Concern
+
+    included do
+      append_after_action :process_lazy_enqueues
+    end
+
+    def process_lazy_enqueues
+      Resque.process_lazy_enqueues
+    end
+  end
+end

data/lib/lazy_resque/lazy_enqueue.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'resque'
+
+module LazyResque
+  # Wrap up the original klass/args ready to be placed into Store.enqueues
+  class LazyEnqueue
+    def initialize(klass, *args)
+      @klass = klass
+      @args = args
+    end
+
+    def enqueue
+      Resque.enqueue(@klass, *@args)
+    end
+  end
+end

data/lib/lazy_resque/resque_extensions.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'lazy_resque/store'
+require 'lazy_resque/lazy_enqueue'
+
+module LazyResque
+  # Extensions to append to the main Resque module to add
+  # Resque.lazy_enqueue and Resque.process_lazy_enqueues
+  module ResqueExtensions
+    def lazy_enqueue(klass, *args)
+      LazyResque::Store.queue_up(LazyResque::LazyEnqueue.new(klass, *args))
+    end
+
+    def process_lazy_enqueues
+      current_queue = LazyResque::Store.queue
+      return if current_queue.empty?
+      Thread.new(current_queue) do |jobs_to_be_enqueued|
+        jobs_to_be_enqueued.each(&:enqueue)
+      end
+    end
+  end
+end

data/lib/lazy_resque/store.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'request_store_rails'
+
+module LazyResque
+  # Per thread store that uses RequestLocals to store all the enqueues
+  # we want to run
+  module Store
+    def self.queue
+      RequestLocals.fetch(:lazy_resque_queue) { [] } || []
+    end
+
+    def self.queue_up(lazy_enqueue)
+      RequestLocals.store[:lazy_resque_queue] = queue.concat([lazy_enqueue])
+    end
+  end
+end

data/lib/lazy_resque/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LazyResque
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: lazy_resque
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bellroy Tech Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: request_store_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: resque
+  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: Moves Resque enqueues out of the request cycle in a Rails application.
+email:
+- tech@bellroy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lazy_resque.gemspec
+- lib/lazy_resque.rb
+- lib/lazy_resque/controller_enqueue.rb
+- lib/lazy_resque/lazy_enqueue.rb
+- lib/lazy_resque/resque_extensions.rb
+- lib/lazy_resque/store.rb
+- lib/lazy_resque/version.rb
+homepage: https://github.com/samuelgiles/lazy_resque
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Lazy Resque
+test_files: []