activejob-multiq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05ca73c99c20fbb9af77bd31b8ff13942f524d61
+  data.tar.gz: 56c281db05923f7dd6e12e9799cde8cc02a52a7a
+SHA512:
+  metadata.gz: 63f9b94c571e8953af16dcadae2c48e738cd51ece9b9931927612a392868e856bda92e3da2db13f6cfba143848c7698255d1ae8840fed74cbc22bf6afef30618
+  data.tar.gz: 31ef57327cde3c881d0875c90983b97959d22dfe2e0a415ca1a7d5742ed58741a6540c20188f3c716fd2a2258b31481d73aa688fd7f40c38d28ab345ab7da842

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activejob-multiq.gemspec
+gemspec
+
+
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Isaac Seymour
+
+MIT License
+
+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,51 @@
+# ActiveJob::Multiq
+
+Use different queue adapters for different jobs.
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'activejob-multiq'
+```
+
+```bash
+bundle install
+```
+
+## Usage
+
+```ruby
+ActiveJob::Base.queue_adapter = :que
+
+# Something important to enqueue with Que
+class ChargeCard < ActiveJob::Base
+  queue_as :money_things
+
+  def perform(card, amount)
+    card.charge(amount)
+  end
+end
+
+# Something unimportant, to enqueue with Sucker Punch, unless we're in the test
+# environment (in which case you'll probably want to use :test or :inline for
+# everything)
+class RecordAnalytics < ActiveJob::Base
+  include ActiveJob::Multiq
+
+  queue_as :noone_cares
+  queue_with :sucker_punch, unless: -> { Rails.env.test? }
+
+  def perform(event)
+    AnalyticsService.record(event)
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/gocardless/activejob-multiq/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/activejob-multiq.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activejob/multiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activejob-multiq"
+  spec.version       = ActiveJob::Multiq::VERSION
+  spec.authors       = ["Isaac Seymour"]
+  spec.email         = ["i.seymour@oxon.org"]
+  spec.summary       = %q{Use different ActiveJob adapters for different jobs.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/gocardless/activejob-multiq"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("activejob", "~> 4.2")
+  spec.add_dependency("activesupport", "~> 4.2")
+
+  spec.add_development_dependency("bundler", "~> 1.7")
+  spec.add_development_dependency("rspec", "~> 3.1")
+  spec.add_development_dependency("rspec-its", "~> 1.1")
+  spec.add_development_dependency("que")
+end

data/lib/activejob/multiq.rb

@@ -0,0 +1,56 @@
+require "active_support/inflector"
+require "activejob/multiq/version"
+
+module ActiveJob
+  module Multiq
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      @multiq_queue_adapter = nil
+
+      # ActiveJob delegates to this method when enqueueing a job
+      def queue_adapter
+        case @multiq_queue_adapter
+        when nil then ActiveJob::Base.queue_adapter
+        when Proc then @multiq_queue_adapter.call
+        else @multiq_queue_adapter
+        end
+      end
+
+      def queue_with(adapter_or_name = nil, options = {}, &block)
+        if adapter_or_name.nil? && !block_given?
+          raise ArgumentError, "Must provide adapter or block"
+        end
+
+        return if options[:unless] && options[:unless].call
+        return if options[:if] && !options[:if].call
+
+        if block_given?
+          @multiq_queue_adapter = block
+          return
+        end
+
+        @multiq_queue_adapter = convert_adapter_name(adapter_or_name)
+
+        if @multiq_queue_adapter.nil?
+          raise ArgumentError, "#{adapter_or_name} is not a valid adapter"
+        end
+      end
+
+      private
+
+      def convert_adapter_name(adapter_or_name)
+        case adapter_or_name
+        when :test
+          ActiveJob::QueueAdapters::TestAdapter.new
+        when Symbol, String
+          "ActiveJob::QueueAdapters::#{adapter_or_name.to_s.camelize}Adapter".constantize
+        else
+          adapter_or_name if adapter_or_name.respond_to?(:enqueue)
+        end
+      end
+    end
+  end
+end

data/lib/activejob/multiq/version.rb

@@ -0,0 +1,5 @@
+module ActiveJob
+  module Multiq
+    VERSION = "0.0.1"
+  end
+end

data/spec/multiq/multiq_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+RSpec.describe ActiveJob::Multiq do
+  subject(:job) do
+    Thread.current[:adapter_or_name] = adapter_or_name
+
+    Class.new(ActiveJob::Base) do
+      include ActiveJob::Multiq
+
+      queue_with(Thread.current[:adapter_or_name])
+    end
+  end
+
+  context 'when not calling queue_with' do
+    subject(:job) do
+      Class.new(ActiveJob::Base) do
+        include ActiveJob::Multiq
+      end
+    end
+
+    its(:queue_adapter) { is_expected.to eq(ActiveJob::QueueAdapters::InlineAdapter) }
+  end
+
+  context 'with :test' do
+    let(:adapter_or_name) { :test }
+    its(:queue_adapter) { is_expected.to be_a(ActiveJob::QueueAdapters::TestAdapter) }
+  end
+
+  context 'with a custom class' do
+    let(:adapter_or_name) do
+      Class.new do
+        def self.enqueue
+          'lol queues, who needs them?'
+        end
+      end
+    end
+
+    its(:queue_adapter) { is_expected.to eq(adapter_or_name) }
+  end
+
+  context 'with an object which does not respond to enqueue' do
+    let(:adapter_or_name) do
+      class MyAdapter
+      end
+    end
+
+    specify { expect { job }.to raise_error(ArgumentError) }
+  end
+
+  context 'with nil' do
+    let(:adapter_or_name) { nil }
+    specify { expect { job }.to raise_error(ArgumentError) }
+  end
+
+  context 'with :que' do
+    let(:adapter_or_name) { :que }
+    its(:queue_adapter) { is_expected.to eq(ActiveJob::QueueAdapters::QueAdapter)}
+
+    context 'with an unless proc' do
+      context 'that returns true' do
+        subject(:job) do
+          Class.new(ActiveJob::Base) do
+            include ActiveJob::Multiq
+
+            queue_with :que, unless: -> { true }
+          end
+        end
+
+        its(:queue_adapter) { is_expected.to eq(ActiveJob::Base.queue_adapter) }
+      end
+
+      context 'that returns false' do
+        subject(:job) do
+          Class.new(ActiveJob::Base) do
+            include ActiveJob::Multiq
+
+            queue_with :que, unless: -> { false }
+          end
+        end
+
+        its(:queue_adapter) { is_expected.to eq(ActiveJob::QueueAdapters::QueAdapter) }
+      end
+    end
+
+    context 'with an if proc' do
+      context 'that returns true' do
+        subject(:job) do
+          Class.new(ActiveJob::Base) do
+            include ActiveJob::Multiq
+
+            queue_with :que, if: -> { true }
+          end
+        end
+
+        its(:queue_adapter) { is_expected.to eq(ActiveJob::QueueAdapters::QueAdapter) }
+      end
+
+      context 'that returns false' do
+        subject(:job) do
+          Class.new(ActiveJob::Base) do
+            include ActiveJob::Multiq
+
+            queue_with :que, if: -> { false }
+          end
+        end
+
+        its(:queue_adapter) { is_expected.to eq(ActiveJob::Base.queue_adapter) }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'active_job'
+require 'activejob/multiq'
+require 'rspec/its'
+
+require 'pry'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: activejob-multiq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Isaac Seymour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: que
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- i.seymour@oxon.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- activejob-multiq.gemspec
+- lib/activejob/multiq.rb
+- lib/activejob/multiq/version.rb
+- spec/multiq/multiq_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gocardless/activejob-multiq
+licenses:
+- MIT
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Use different ActiveJob adapters for different jobs.
+test_files:
+- spec/multiq/multiq_spec.rb
+- spec/spec_helper.rb
+has_rdoc: