resque-fairly 1.0.0 → 1.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ce973bff34f5c4c1e5213ada0bab47e012cba6e
+  data.tar.gz: e92698b7cc17c8e50df5ed0a002fe9cff1c0bf98
+SHA512:
+  metadata.gz: 1b93c49dcd73b9f21f00082a0885bb05b4559dc1912b67b2c60868e464cf505415ae915688d00fc519d70c5dac194bf5afaf5ce5037a984cb9bc206d7a5d9c1d
+  data.tar.gz: 408037f85ab7196707b6d39e6e0d7278a4968800eaf038df9e58bb79b4535c0365aeec13fe20137ffabdca66d1f8ee194c417a1e31ac3a8989f701cdf1997c78

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem "resque", "~> 1.0"
+
+group :development do
+  gem "rspec", "~> 1.0"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0"
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.2)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (1.2.0)
+    mini_portile (0.6.2)
+    mono_logger (1.1.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.0)
+    rack-protection (1.5.3)
+      rack
+    rake (10.4.2)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    redis (3.2.0)
+    redis-namespace (1.5.1)
+      redis (~> 3.0, >= 3.0.4)
+    resque (1.25.2)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.3)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (1.3.2)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0)
+  resque (~> 1.0)
+  rspec (~> 1.0)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Peter Williams
+Copyright (c) 2009 OpenLogic, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -8,6 +8,44 @@ distributed across the set of queues with pending jobs fairly.  This
 results in a much more predictable mean time to handling for jobs in
 queues that are not the first in the list.
 
+Weighted Priorites
+----
+
+resque-fairly works by sorting the queues randomly before assigning
+the next queue on the list to a worker. You can add weights to 
+your various queues to alter their likelihood of being selected, by 
+using /priorities/. The priorities select queues by regular expression.
+
+Example:
+
+    Resque::Plugins::Fairly.prioritize(/^a/, 2)
+
+The above will prioritize queues whose names start with 'a' to
+be selected twice as often as the default.
+
+You can use any floating point number as the multiplier. If a queue is
+matched by more than one priority, the final weight will be the product
+of all the matching weights.
+
+Only and Except filters
+----
+
+Also filters the queues based on one or more regular expressions to
+include and/or exclude the matching queues.  Note:  All these methods
+are also chainable.
+
+Examples:
+
+    Resque::Plugins::Fairly.only(/foo/).except(/foobar/)
+
+The above will return a randomized list of queues which contain the
+text 'foo', but not the text 'foobar'
+
+Reset
+----
+
+Clears all priorities and only and except filters.
+
 Note on Patches/Pull Requests
 ----
  
@@ -23,4 +61,4 @@ Note on Patches/Pull Requests
 Copyright
 ----
 
-Copyright (c) 2010 Peter Williams. See LICENSE for details.
+Copyright (c) 2009 OpenLogic, Inc. See LICENSE for details.

data/Rakefile

@@ -9,10 +9,9 @@ begin
     gem.description = <<DESC
 Normally resque processes queues in a fixed order.  This can lead to jobs in queues at the end of the list not getting process for very long periods.  resque-fairly provides a mechanism where by workers are distributed across the set of queues with pending jobs fairly.  This results in a much more predictable mean time to handling for jobs in queues that are not the first in the list.
 DESC
-    gem.email = "pezra@barelyenough.org"
-    gem.homepage = "http://github.com/pezra/resque-fairly"
-    gem.authors = ["Peter Williams"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.email = "cameron.mauch@roguewave.com"
+    gem.homepage = "http://github.com/openlogic/resque-fairly"
+    gem.authors = ["D Cameron Mauch", "Peter Williams"]
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -35,13 +34,3 @@ end
 task :spec => :check_dependencies
 
 task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "resque-fairly #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.4.1

data/lib/resque/plugins/fairly.rb

@@ -2,6 +2,41 @@ require 'resque/worker'
 
 module Resque::Plugins
   module Fairly
+    # Define an 'unfair' priority multiplier to queues whose name
+    # matches the specified regex
+    def self.prioritize(regex, weight)
+      raise ArgumentError, '`regex` must be a regular expression' unless Regexp === regex
+      options[:priority] << {regex: regex, weight: weight}
+      self
+    end
+
+    def self.only(regex)
+      raise ArgumentError, '`regex` must be a regular expression' unless Regexp === regex
+      options[:only] << regex
+      self
+    end
+    
+    def self.except(regex)
+      raise ArgumentError, '`regex` must be a regular expression' unless Regexp === regex
+      options[:except] << regex
+      self
+    end
+
+    def self.reset(list = [:priority, :only, :except])
+      list.each do |option|
+        options[option] = []
+      end
+      self
+    end
+    
+    def self.options
+      @options ||= {
+        priority: [],
+        only:     [],
+        except:   []
+      }
+    end
+
     # Returns a list of queues to use when searching for a job.  A
     # splat ("*") means you want every queue 
     #
@@ -9,8 +44,20 @@ module Resque::Plugins
     # with every call.  This prevents any particular queue for being
     # starved.  Workers will process queues in a random order each
     # time the poll for new work.
+    #
+    # If priorities have been established, the randomness of the order
+    # will be weighted according to the multipliers
     def queues_randomly_ordered
-      queues_alpha_ordered.sort_by{rand}
+      list = queues_alpha_ordered
+
+      list = select_only_queues(list)   if Fairly.options[:only].any?
+      list = reject_except_queues(list) if Fairly.options[:except].any?
+
+      list = list.sort_by do |item|
+        weights = [rand] + priority_weights(item)
+        weight = weights.reduce(&:*)
+      end
+      list = list.reverse
     end
 
     def self.included(klass)
@@ -19,9 +66,35 @@ module Resque::Plugins
         alias_method :queues, :queues_randomly_ordered
       end
     end
-  end
 
-  Resque::Worker.send(:include, Fairly)
-end
+    private
 
+    def select_only_queues(list)
+      list.select do |item|
+        Fairly.options[:only].any? do |regex|
+          regex === item
+        end
+      end
+    end
 
+    def reject_except_queues(list)
+      list.reject do |item|
+        Fairly.options[:except].any? do |regex|
+          regex === item
+        end
+      end
+    end
+
+    def priority_weights(item)
+      priorities = Fairly.options[:priority].select do |priority|
+        priority[:regex] === item
+      end
+
+      weights = priorities.map do |priority|
+        priority[:weight]
+      end
+    end
+ end
+
+  Resque::Worker.send(:include, Fairly)
+end

data/lib/resque-fairly.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+gem 'resque', :version => '~> 1.0'
 require 'resque'
 
 require File.expand_path('resque/plugins/fairly', File.dirname(__FILE__))

data/resque-fairly.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: resque-fairly 1.4.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "resque-fairly"
+  s.version = "1.4.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["D Cameron Mauch", "Peter Williams"]
+  s.date = "2015-01-19"
+  s.description = "Normally resque processes queues in a fixed order.  This can lead to jobs in queues at the end of the list not getting process for very long periods.  resque-fairly provides a mechanism where by workers are distributed across the set of queues with pending jobs fairly.  This results in a much more predictable mean time to handling for jobs in queues that are not the first in the list.\n"
+  s.email = "cameron.mauch@roguewave.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/resque-fairly.rb",
+    "lib/resque/plugins/fairly.rb",
+    "resque-fairly.gemspec",
+    "spec/resque-fairly_spec.rb",
+    "spec/resque/plugins/fairly_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/openlogic/resque-fairly"
+  s.rubygems_version = "2.2.2"
+  s.summary = "Fair queue processing for Resque"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<resque>, ["~> 1.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+    else
+      s.add_dependency(%q<resque>, ["~> 1.0"])
+      s.add_dependency(%q<rspec>, ["~> 1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    end
+  else
+    s.add_dependency(%q<resque>, ["~> 1.0"])
+    s.add_dependency(%q<rspec>, ["~> 1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
+  end
+end
+

data/spec/resque/plugins/fairly_spec.rb

@@ -5,14 +5,42 @@ describe Resque::Plugins::Fairly do
     worker = Resque::Worker.new('a','b')
 
     srand(2) 
-    worker.queues.should == ['b', 'a']
+    worker.queues.should == ['a', 'b']
   end
 
   it "changes Resque::Worker#queues to return queues in a random order (rand seeded w/ 1)" do
     worker = Resque::Worker.new('a','b')
 
     srand(1)
-    worker.queues.should == ['a', 'b']
+    worker.queues.should == ['b', 'a']
+  end
+
+  it "changes Resque::Worker#queues to return queues in a weighted random order" do
+    worker = Resque::Worker.new('a','b')
+    Resque::Plugins::Fairly.reset.prioritize(/a/, 2)
+
+    as, bs = [], []
+    1.upto 100 do
+      arr = worker.queues
+      as << arr if arr.first == 'a'
+      bs << arr if arr.first == 'b'
+    end
+
+    as.size.should == 66
+    bs.size.should == 34
   end
 
+  it "changes Resque::Worker#queues to return queues with only queues only" do
+    worker = Resque::Worker.new('d','e','f')
+    Resque::Plugins::Fairly.reset.only(/e/)
+
+    worker.queues.should == ['e']
+  end
+
+  it "changes Resque::Worker#queues to return queues without except queues" do
+    worker = Resque::Worker.new('g','h','i')
+    Resque::Plugins::Fairly.reset.except(/h/)
+
+    worker.queues.should =~ ['g', 'i']
+  end
 end

data/spec/resque-fairly_spec.rb

@@ -1,7 +1,4 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "ResqueFairly" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
 end

metadata

@@ -1,91 +1,116 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: resque-fairly
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.4.1
 platform: ruby
-authors: 
+authors:
+- D Cameron Mauch
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-08-22 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: |
   Normally resque processes queues in a fixed order.  This can lead to jobs in queues at the end of the list not getting process for very long periods.  resque-fairly provides a mechanism where by workers are distributed across the set of queues with pending jobs fairly.  This results in a much more predictable mean time to handling for jobs in queues that are not the first in the list.
-
-email: pezra@barelyenough.org
+email: cameron.mauch@roguewave.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
-files: 
-- .document
-- .gitignore
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - lib/resque-fairly.rb
 - lib/resque/plugins/fairly.rb
+- resque-fairly.gemspec
 - spec/resque-fairly_spec.rb
 - spec/resque/plugins/fairly_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/pezra/resque-fairly
+homepage: http://github.com/openlogic/resque-fairly
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fair queue processing for Resque
-test_files: 
-- spec/resque/plugins/fairly_spec.rb
-- spec/resque-fairly_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC