marginalia-resque 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Burke Libbey
+
+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,32 @@
+# Marginalia::Resque
+
+Marginalia-Resque is an addition to Marginalia that adds useful margin
+notes for queries generated from Resque jobs. This is useful because
+marginalia only annotates queries generated from web requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'marginalia-resque'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install marginalia-resque
+
+## Usage
+
+1. There is no step 1.
+2. It's already working.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/marginalia-resque.rb

@@ -0,0 +1,48 @@
+require 'marginalia'
+require 'marginalia/comment'
+require 'resque'
+require 'json'
+
+require 'marginalia-resque/version'
+
+module Marginalia::Resque
+  mattr_accessor :previous_comment
+
+  def self.update_with_job!(job_klass, params)
+    if Array === params && params.size == 1 && Hash === params[0]
+      params = params[0]
+    end
+    Marginalia::Resque.previous_comment = Marginalia::Comment.comment
+    Marginalia::Comment.comment = "job:#{job_klass.name},params:#{params.to_json}"
+  end
+
+  def self.clear_after_job!
+    Marginalia::Comment.comment = Marginalia::Resque.previous_comment
+    Marginalia::Resque.previous_comment = nil
+  end
+end
+
+class Resque::Job
+  class << self
+    def create_with_marginalia(queue, klass, *args)
+      if Resque.inline?
+        Marginalia::Resque.update_with_job!(klass, args)
+        ret = create_without_marginalia(queue, klass, *args)
+        Marginalia::Resque.clear_after_job!
+        ret
+      else
+        create_without_marginalia(queue, klass, *args)
+      end
+    end
+    alias_method_chain :create, :marginalia
+  end
+end
+
+class Resque::Worker
+  def perform_with_marginalia(job)
+    Marginalia::Resque.update_with_job!(job.payload_class, job.args)
+    perform_without_marginalia(job)
+    Marginalia::Resque.clear_after_job!
+  end
+  alias_method_chain :perform, :marginalia
+end

data/lib/marginalia-resque/version.rb

@@ -0,0 +1,5 @@
+module Marginalia
+  module Resque
+    VERSION = "0.0.1"
+  end
+end

data/marginalia-resque.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/marginalia-resque/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Burke Libbey"]
+  gem.email         = ["burke@burkelibbey.org"]
+  gem.description   = %q{Extends Marginaila to log Job class names and parameters when running queries from a Resque job.}
+  gem.summary       = %q{Extends Marginalia to report on Resque jobs}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "marginalia-resque"
+  gem.require_paths = ["lib"]
+  gem.version       = Marginalia::Resque::VERSION
+
+  gem.add_dependency 'marginalia', '>= 1.1.0'
+  gem.add_dependency 'resque'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: marginalia-resque
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Burke Libbey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: marginalia
+  requirement: &70160860781460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70160860781460
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &70160860780940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70160860780940
+description: Extends Marginaila to log Job class names and parameters when running
+  queries from a Resque job.
+email:
+- burke@burkelibbey.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/marginalia-resque.rb
+- lib/marginalia-resque/version.rb
+- marginalia-resque.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Extends Marginalia to report on Resque jobs
+test_files: []
+has_rdoc: