resque-unique_by_arity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f9ce19b6bc1fb732d1e65041619ab23e3ec260e
+  data.tar.gz: 8378dafafc81c1fbc4f8cb8accc4ae21b9833604
+SHA512:
+  metadata.gz: 354198da378d793f142af7ce1d4938af08544f8208cff62bca8af90460005a773f5205b212afdb7454aac20ebedf840588005ea3679f1ba8ebed05dc106de2b3
+  data.tar.gz: b61e3cb714f9b19d8a52d8bd3285d0d47de32439858cf44e256758ef633378a2dfb06d153fe9b21469da0858a07b389f8d49501dcb9aa2fbd36e576442b56e97

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque-unique_by_arity.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# Resque::UniqueByArity
+
+Usage:
+
+```ruby
+class MyJob
+  include UniqueByArity::Cop.new(
+    arity_for_uniqueness: 1,
+    unique_at_runtime: true,
+    unique_in_queue: true
+  )
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-unique_by_arity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-unique_by_arity
+
+## Usage
+
+```ruby
+class MyJob
+  include UniqueByArity::Cop.new(
+    arity_for_uniqueness: 1,
+    unique_at_runtime: true,
+    unique_in_queue: true
+  )
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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/pboling/resque-unique_by_arity.
+

data/Rakefile

@@ -0,0 +1,6 @@
+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 "resque/unique_by_arity"
+
+# 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(__FILE__)

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/lib/resque/unique_by_arity.rb

@@ -0,0 +1,77 @@
+require "resque-lonely_job"
+require "resque_solo"
+
+require "resque/unique_by_arity/version"
+require "resque/unique_by_arity/configuration"
+require "resque/unique_by_arity/cop"
+require "resque/unique_by_arity/cop_modulizer"
+
+# Usage:
+#
+# class MyJob
+#   include UniqueByArity::Cop.new(
+#     arity_for_uniqueness: 1,
+#     unique_at_runtime: true,
+#     unique_in_queue: true
+#   )
+# end
+#
+module Resque
+  module UniqueByArity
+    def unique_log(message, config_proxy = nil)
+      config_proxy ||= self
+      config_proxy.unique_logger.send(config_proxy.unique_log_level, message) if config_proxy.unique_logger
+    end
+
+    # There are times when the class will need access to the configuration object,
+    #   such as to override it per instance method
+    def uniq_config
+      @uniqueness_configuration
+    end
+
+    # For per-class config with a block
+    def uniqueness_configure
+      @uniqueness_configuration ||= Configuration.new
+      yield(@uniqueness_configuration)
+    end
+
+    #### CONFIG ####
+    class << self
+      attr_accessor :uniqueness_configuration
+    end
+    def uniqueness_config_reset(config = Configuration.new)
+      @uniqueness_configuration = config
+    end
+    def uniqueness_log_level
+      @uniqueness_configuration.log_level
+    end
+    def uniqueness_log_level=(log_level)
+      @uniqueness_configuration.log_level = log_level
+    end
+    def uniqueness_arity_for_uniqueness
+      @uniqueness_configuration.arity_for_uniqueness
+    end
+    def uniqueness_arity_for_uniqueness=(arity_for_uniqueness)
+      @uniqueness_configuration.arity_for_uniqueness = arity_for_uniqueness
+    end
+    def uniqueness_lock_after_execution_period
+      @uniqueness_configuration.lock_after_execution_period
+    end
+    def uniqueness_lock_after_execution_period=(lock_after_execution_period)
+      @uniqueness_configuration.lock_after_execution_period = lock_after_execution_period
+    end
+    def uniqueness_unique_at_runtime
+      @uniqueness_configuration.unique_at_runtime
+    end
+    def uniqueness_unique_at_runtime=(unique_at_runtime)
+      @uniqueness_configuration.unique_at_runtime = unique_at_runtime
+    end
+    def uniqueness_unique_in_queue
+      @uniqueness_configuration.unique_in_queue
+    end
+    def uniqueness_unique_in_queue=(unique_in_queue)
+      @uniqueness_configuration.unique_in_queue = unique_in_queue
+    end
+    self.uniqueness_configuration = Configuration.new # setup defaults
+  end
+end

data/lib/resque/unique_by_arity/configuration.rb

@@ -0,0 +1,37 @@
+require 'logger'
+module Resque
+  module UniqueByArity
+    class Configuration
+      attr_accessor :logger
+      attr_accessor :log_level
+      attr_accessor :arity_for_uniqueness
+      attr_accessor :lock_after_execution_period
+      attr_accessor :unique_at_runtime
+      attr_accessor :unique_in_queue
+      alias :debug_logger :logger
+      alias :debug_log_level :log_level
+      alias :debug_arity_for_uniqueness :arity_for_uniqueness
+      alias :debug_lock_after_execution_period :lock_after_execution_period
+      alias :debug_unique_at_runtime :unique_at_runtime
+      alias :debug_unique_in_queue :unique_in_queue
+      def initialize(**options)
+        @logger = options.key?(:logger) ? options[:logger] : Logger.new(STDOUT)
+        @log_level = options.key?(:log_level) ? options[:log_level] : :debug
+        @arity_for_uniqueness = options.key?(:arity_for_uniqueness) ? options[:arity_for_uniqueness] : 1
+        @lock_after_execution_period = options.key?(:lock_after_execution_period) ? options[:lock_after_execution_period] : nil
+        @unique_at_runtime = options.key?(:unique_at_runtime) ? options[:unique_at_runtime] : false
+        @unique_in_queue = options.key?(:unique_in_queue) ? options[:unique_in_queue] : false
+      end
+      def to_hash
+        {
+            logger: logger,
+            log_level: log_level,
+            arity_for_uniqueness: arity_for_uniqueness,
+            lock_after_execution_period: lock_after_execution_period,
+            unique_at_runtime: unique_at_runtime,
+            unique_in_queue: unique_in_queue
+        }
+      end
+    end
+  end
+end

data/lib/resque/unique_by_arity/cop.rb

@@ -0,0 +1,27 @@
+module Resque
+  module UniqueByArity
+    class Cop < Module
+      def initialize(**config)
+        @configuration = Resque::UniqueByArity::Configuration.new(**config)
+      end
+      def included(base)
+        return unless @configuration
+        base.send(:extend, Resque::UniqueByArity)
+        base.uniqueness_config_reset(@configuration.dup)
+
+        # gem is resque_solo, which is a rewrite of resque-loner
+        # see: https://github.com/neighborland/resque_solo
+        # defines a redis_key method, which if we are not careful, conflicts with a custom redis_key we set here
+        base.send(:include, Resque::Plugins::UniqueJob) if @configuration.unique_in_queue
+
+        # gem is resque-lonely_job
+        # see: https://github.com/wallace/resque-lonely_job
+        base.send(:extend, Resque::Plugins::LonelyJob) if @configuration.unique_at_runtime
+
+        uniqueness_cop_module = Resque::UniqueByArity::CopModulizer.to_mod(@configuration)
+        # This will override methods from both plugins above, if configured for both
+        base.send(:extend, uniqueness_cop_module)
+      end
+    end
+  end
+end

data/lib/resque/unique_by_arity/cop_modulizer.rb

@@ -0,0 +1,52 @@
+module Resque
+  module UniqueByArity
+    module CopModulizer
+      def self.to_mod(configuration)
+        Module.new do
+          if configuration.unique_in_queue
+            # Returns a string, used by LonelyJob, that will be used as the redis key
+            # The example in the readme is bad.  The args passed to this method are like:
+            # [{:class=>"MakeCompanyReport", :args=>[1]}]
+            # This is identical to the version from Resque::Plugins::UniqueJob
+            # and we do not want the version from Resque::Plugins::LonelyJob to be used.
+            # Payload is what Resque stored for this job along with the job's class name:
+            # a hash containing :class and :args
+            define_method(:redis_key) do |payload|
+              puts "overriding redis_key in #{self}"
+              begin
+                payload = Resque.decode(Resque.encode(payload))
+                job  = payload["class"]
+                args = payload["args"]
+                args.map! do |arg|
+                  arg.is_a?(Hash) ? arg.sort : arg
+                end
+                # what is the configured arity for uniqueness?
+                # minus one because zero indexed
+                uniqueness_args = args[0..(configuration.arity_for_uniqueness - 1)]
+                args = { class: job, args: uniqueness_args }
+                key = Digest::MD5.hexdigest Resque.encode(args)
+                puts "redis key for uniqueness for #{args} is: #{key.green}"
+                key
+              rescue => e
+                Raven.captureMessage("redis_key error", extra: { signature: payload, error: e.class.to_s, message: e.message })
+                raise e
+              end
+            end
+          end
+          if configuration.unique_at_runtime
+            # The versions of redis_key from resque_solo and resque-lonely_job are incompatible.
+            # So we forked resque-lonely_job, change the name of the method so it would not conflict,
+            #   and now we can override it, and fix the params to be compatible with the redis_key
+            #   from resque_solo
+            # Does not need any customization for arity, because it funnels down to redis_key,
+            #   and we handle the arity option there
+            define_method(:lonely_job_redis_key) do |*args|
+              puts "overriding lonely_job_redis_key in #{self}"
+              "lonely_job:#{redis_key({"class" => self.to_s, "args" => args})}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/resque/unique_by_arity/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module UniqueByArity
+    VERSION = "0.1.0"
+  end
+end

data/resque-unique_by_arity.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/unique_by_arity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-unique_by_arity"
+  spec.version       = Resque::UniqueByArity::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["peter.boling@gmail.com"]
+
+  spec.summary       = %q{Magic hacks which allow integration of resque_solo  and resque-lonely_simlutaneously into Resque jobs}
+  spec.description   = %q{resque_solo  and resque-lonely are incompatible - fixes that}
+  spec.homepage      = "https://github.com/pboling/resque-unique_by_arity"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "resque-lonely_job"
+  spec.add_runtime_dependency "resque_solo"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: resque-unique_by_arity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Boling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque-lonely_job
+  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: resque_solo
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: resque_solo  and resque-lonely are incompatible - fixes that
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resque/unique_by_arity.rb
+- lib/resque/unique_by_arity/configuration.rb
+- lib/resque/unique_by_arity/cop.rb
+- lib/resque/unique_by_arity/cop_modulizer.rb
+- lib/resque/unique_by_arity/version.rb
+- resque-unique_by_arity.gemspec
+homepage: https://github.com/pboling/resque-unique_by_arity
+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.8
+signing_key: 
+specification_version: 4
+summary: Magic hacks which allow integration of resque_solo  and resque-lonely_simlutaneously
+  into Resque jobs
+test_files: []