resque-kawai 0.1

data/.gitignore

@@ -0,0 +1,5 @@
+log
+TODO
+locks
+*.gem
+*.log

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Will automatically pull in this gem and all its
+# dependencies specified in the gemspec
+gem "resque-kawai", :path => File.expand_path("..", __FILE__)
+
+gem 'activesupport'
+# These are development dependencies 
+gem "rspec"
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    resque-kawai (0.1)
+      activesupport
+      resque
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.2)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rake (0.9.2.2)
+    redis (2.2.2)
+    redis-namespace (1.0.3)
+      redis (< 3.0.0)
+    resque (1.20.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.0.2)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  rake
+  resque-kawai!
+  rspec

data/README.md

@@ -0,0 +1,69 @@
+Resque Kawai
+============
+
+Syntax sugar for Resque consumers. Each consumer is a class, with clean interface, and custom logger.
+
+``` ruby
+gem 'resque-kawai'
+```
+
+    rails generate rq:add bla
+
+And add to config/application.rb
+
+    config.autoload_paths += %W( #{config.root}/app/models/resque )
+    
+Consumer
+--------
+app/models/resque/rq_bla.rb
+
+``` ruby
+class RqBla < RqQueue
+
+  def some_method1(a, b, c)
+    logger.info "async called some_method1 with #{[a, b, c].inspect}"
+  end
+  
+  def some_method2(x)
+    logger.info "async called some_method2 with #{x.inspect}"
+  end
+  
+end
+```
+
+Insert event into queue like this:
+
+    RqBla.some_method1(1, 2, 3)
+    
+    or
+    
+    RqBla.add_event(:some_method2, some_x)
+    
+
+Logger for this consumer: Rails.root/log/resque/bla.log
+
+
+ 
+### Options
+
+``` ruby
+class RqBla < RqQueue
+
+  # specify custom logger
+  self.logger_path = "#{Rails.root}/log/bla.log"
+  
+  # enables benchmark for each event (into logger)
+  self.benchmark = true
+  
+end
+```
+
+
+### Proxy method to consumer
+Usefull in specs
+
+``` ruby
+  RqBla.proxy(:some_method1)
+```
+
+When code call RqBla.some_method1(a,b,c) this would be convert into RqBla.new.some_method1(a,b,c)

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require "bundler/setup"
+
+require 'rspec/core/rake_task'
+
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubygems/package_task'
+require 'rubygems/specification'
+
+spec = eval(File.read('resque-kawai.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/lib/generators/rq/add_generator.rb

@@ -0,0 +1,29 @@
+# for Rails 3
+if Rails::VERSION::MAJOR >= 3
+
+  module Rq
+    class AddGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def add_files
+        template "consumer.rb", "app/models/resque/rq_#{file_path}.rb"
+        template "spec.rb", "spec/models/resque/rq_#{file_path}_spec.rb"
+      end
+    end
+  end
+
+end
+
+# for Rails 2.3
+if Rails::VERSION::MAJOR == 2
+
+  class RqAddGenerator < Rails::Generator::NamedBase
+    def manifest
+      record do |m|
+        m.template "consumer.rb", "app/models/bin/rq_#{file_path}.rb"
+        m.template "spec.rb", "spec/models/bin/rq_#{file_path}_spec.rb"
+      end
+    end
+  end
+
+end

data/lib/generators/rq/templates/consumer.rb

@@ -0,0 +1,9 @@
+class Rq<%= class_name %> < RqQueue
+
+  # insert event like: Rg<%= class_name %>.some_event("haha")
+
+  def some_event(h)
+    logger.info "async called event with #{h.inspect}"
+  end
+ 
+end

data/lib/generators/rq/templates/spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Rq<%= class_name %> do
+  before :each do
+    @rq = Rq<%= class_name %>.instance
+  end
+  
+  it "should not raise" do
+    @rq.some_event(1)
+  end
+    
+end

data/lib/resque-kawai.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/rq_queue'

data/lib/rq_queue.rb

@@ -0,0 +1,74 @@
+# -*- encoding : utf-8 -*-
+require 'active_support/inflector'
+require 'resque'
+require 'logger'
+
+class RqQueue
+  @queue = :default
+  
+  attr_accessor :logger
+  
+  def self.inherited(subclass)
+    subclass.instance_variable_set('@queue', subclass.extract_queue_name)
+  end
+  
+  def self.extract_queue_name
+    name.gsub(/Rq/, '').underscore.to_sym
+  end
+  
+  def self.add_event(method_name, *args)
+    Resque.enqueue(self, method_name.to_s, args)
+  end
+  
+  def self.method_missing(method, *args)
+    add_event(method, *args)
+  end
+  
+  def self.logger
+    @logger ||= Logger.new(logger_path).tap do |logger|
+      logger.formatter = lambda { |s, d, p, m| "#{d.strftime("%d.%m.%Y %H:%M:%S")} #{m}\n" }
+    end
+  end
+  
+  def self.instance
+    @instance ||= self.new
+  end
+  
+  def self.perform(method_name, args)
+    start_time = benchmark ? Time.now : nil
+    
+    instance.send(method_name, *args)
+    
+    logger.info "done #{method_name}, #{"%.6f" % (Time.now - start_time)} s" if benchmark
+   
+  rescue => ex
+    logger.error "Failed event: #{ex.message}"
+    raise ex
+  end
+
+  # proxing method for tests  
+  def self.proxy(method_name)
+    self.should_receive(method_name) do |*data|
+      self.instance.send(method_name, *data)
+    end.any_number_of_times
+  end
+  
+  class << self
+    def logger_path=(_logger_path)
+      @logger_path = _logger_path
+    end
+    
+    def logger_path 
+      @logger_path ||= begin        
+        "#{Rails.root}/log/resque/#{extract_queue_name}.log"
+      end
+    end
+    
+    attr_accessor :benchmark
+  end
+  
+  def initialize
+    self.logger = self.class.logger
+  end
+  
+end

data/lib/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+module Rq
+  VERSION = "0.1" 
+end

data/resque-kawai.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.dirname(__FILE__) + "/lib/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{resque-kawai}
+  s.version = Rq::VERSION
+
+  s.authors = ["Makarchev Konstantin"]
+  s.autorequire = %q{resque-kawai.rb}
+  
+  s.description = %q{Syntax sugar for Resque consumers. Each consumer is a class, with clean interface, and custom logger.}
+  s.summary = %q{Syntax sugar for Resque consumers. Each consumer is a class, with clean interface, and custom logger.}
+
+  s.email = %q{kostya27@gmail.com}
+  s.homepage = %q{http://github.com/kostya/resque-kawai}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activesupport'
+  s.add_dependency 'resque'
+  s.add_development_dependency "rspec"
+  
+end

data/spec/rq_queue_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/test_class'
+
+describe RqQueue do
+  it "should enqueue defined event" do
+    Resque.should_receive(:enqueue).with(RqTest, 'bla', [1, 'a', []])
+    RqTest.bla(1, 'a', [])
+  end
+  
+  it "insert empty event" do
+    Resque.should_receive(:enqueue).with(RqTest, 'bl', [])
+    RqTest.bl
+  end
+  
+  it "should enqueue undefined event" do
+    Resque.should_receive(:enqueue).with(RqTest, 'bl', [1])
+    RqTest.bl(1)
+  end
+  
+  it "should enqueue undefined event" do
+    Resque.should_receive(:enqueue).with(RqTest, 'bl2', [{}])
+    RqTest.bl2({})
+  end              
+  
+  it "should insert event with custom method" do
+    Resque.should_receive(:enqueue).with(RqTest, 'super', [1, 2, 3])
+    RqTest.add_event(:super, 1, 2, 3)
+  end
+  
+  it "should insert event with custom method" do
+    Resque.should_receive(:enqueue).with(RqTest, 'super', [[1, 2, 3]])
+    RqTest.add_event(:super, [1, 2, 3])
+  end              
+  
+  describe "consume" do
+    before :each do
+      @bla = RqTest.new
+      RqTest.stub!(:instance).and_return(@bla)
+    end
+    
+    it "should call our event" do
+      @bla.should_receive(:bla).with(1, 'a', [])
+      RqTest.perform('bla', [1, 'a', []])
+    end
+    
+    it "should call our another event" do
+      @bla.should_receive(:bl).with(1)
+      RqTest.perform('bl', [1])
+    end
+    
+    it "should call our another event" do
+      @bla.should_receive(:bl2).with({})
+      RqTest.perform('bl2', [{}])
+    end                        
+    
+    it "should call our another event" do
+      @bla.should_receive(:bl2).with([1,2,3])
+      RqTest.perform('bl2', [[1,2,3]])
+    end
+      
+    it "raised when method undefined" do
+      lambda do
+        RqTest.perform('blasdfds', [1])
+      end.should raise_error
+    end
+  end
+  
+  it "should proxy consumer" do
+    RqTest.proxy(:ptest)
+    RqTest.ptest(111)
+    $a.should == 111
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require "bundler/setup"
+
+ENV['RAILS_ENV'] ||= 'test'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rq_queue'

data/spec/test_class.rb

@@ -0,0 +1,15 @@
+class RqTest < RqQueue
+
+  self.logger_path = "test.log"
+  self.benchmark = true
+
+  def bla(a, b, c)
+    @hah = [a, b, c]
+    logger.info "bla #{@hah.inspect}"
+  end
+  
+  def ptest(a)
+    $a = a
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: resque-kawai
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Makarchev Konstantin
+autorequire: resque-kawai.rb
+bindir: bin
+cert_chain: []
+date: 2012-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &75846280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75846280
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &75846060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75846060
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &75845850 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *75845850
+description: Syntax sugar for Resque consumers. Each consumer is a class, with clean
+  interface, and custom logger.
+email: kostya27@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/generators/rq/add_generator.rb
+- lib/generators/rq/templates/consumer.rb
+- lib/generators/rq/templates/spec.rb
+- lib/resque-kawai.rb
+- lib/rq_queue.rb
+- lib/version.rb
+- resque-kawai.gemspec
+- spec/rq_queue_spec.rb
+- spec/spec_helper.rb
+- spec/test_class.rb
+homepage: http://github.com/kostya/resque-kawai
+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.16
+signing_key: 
+specification_version: 3
+summary: Syntax sugar for Resque consumers. Each consumer is a class, with clean interface,
+  and custom logger.
+test_files: []