labor 0.1.2 → 0.1.3

data/README.md

@@ -1,6 +1,6 @@
 # Labor
 
-A wrapper for "gearman-ruby" which provides an easy mechanism for managing your jobs. Jobs are just Ruby classes/modules which respond to the `perform` method.
+A wrapper for "gearman-ruby" which provides an easy mechanism for managing your jobs. Jobs are just Ruby classes which respond to the `perform` method.
 
 ## Install
 
@@ -13,16 +13,16 @@ Basic `Rakefile`:
     require 'labor'
     require 'labor/tasks'
 
-    class TestJob
-      def self.perform
+    class TestJob < Labor::Ability
+      def perform
         puts "Hello, world!"
 
         true
       end
     end
 
-    class AnotherTest
-      def self.perform
+    class AnotherTest < Labor::Ability
+      def perform
         puts "Hello, world... again!"
 
         true
@@ -36,7 +36,9 @@ Let's run the worker:
     $ export ABILITIES=test-job,another-test
     $ rake labor:work
 
-The `ABILITIES` environment variable can accept multiple job names; each seperated by a comma.
+The `ABILITIES` environment variable can accept multiple job names; each seperated by a comma. 
+
+Job names can also carry meta data associated with that particular worker. Meta data is any information that shouldn't affect what you name the job class in your system, but indicate to Gearman that this worker is unique. You can do this by putting your meta data inside `[` and `]` in the ability name. For example: `email[123]`. Everything within and including the `[]` symbols will be removed when referencing your worker class' `perform` method.
 
 ## Configuration
 
@@ -61,8 +63,8 @@ The config file would then be loaded in like this:
 
 When the worker is started up, Labor will load this config into the `@config` instance variable of your job class/module. You'll then be able to retrieve keys from the config within your job.
 
-    class TestJob
-      def self.perform
+    class TestJob < Labor::Ability
+      def perform
         puts "Hey! I'm #{@config[:i_am]}"
         #=> "Hey! I'm at the bar"
 

data/lib/labor.rb

@@ -5,6 +5,7 @@ require 'labor/version'
 require 'labor/core_ext'
 require 'labor/helpers'
 require 'labor/worker'
+require 'labor/ability'
 require 'labor/config'
 
 module Labor

data/lib/labor/ability.rb

@@ -0,0 +1,12 @@
+module Labor
+  class Ability
+    include Helpers
+
+    def initialize(payload, job)
+      puts "Payload: #{payload.inspect}"
+      
+      @payload = payload.symbolize_keys!
+      @job = job
+    end
+  end
+end

data/lib/labor/core_ext/hash.rb

@@ -0,0 +1,10 @@
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    values.each{|h| h.symbolize_keys! if h.is_a?(Hash) }
+    self
+  end
+end
+

data/lib/labor/version.rb

@@ -1,3 +1,3 @@
 module Labor
-  VERSION = Version = "0.1.2"
+  VERSION = Version = "0.1.3"
 end

data/lib/labor/worker.rb

@@ -25,15 +25,19 @@ module Labor
     # Returns nothing.
     def add_abilities(abilities)
       abilities.each do |ability|
-        klass = constantize(classify(ability))
-        klass.instance_variable_set(:@config, Labor.config)
+        klass = constantize(classify(remove_meta_data(ability)))
+        config = Labor.config
 
         @worker.add_ability(ability) do |data, job|
           begin
             payload = JSON.parse data
-            klass.perform(payload, job)
+            instance = klass.new(payload, job)
+            instance.instance_variable_set(:@config, config)
+            instance.perform
           rescue Exception => e
+            backtrace = Array(e.backtrace)[0..500]
             log "Job failed: #{e.inspect}"
+            log backtrace.join("\n")
             return false
           end
         end
@@ -44,7 +48,9 @@ module Labor
             payload = JSON.parse data
             klass.after_perform(payload, result)
           rescue Exception => e
+            backtrace = Array(e.backtrace)[0..500]
             log "After job failed: #{e.inspect}"
+            log backtrace.join("\n")
           end
           end
         end
@@ -66,5 +72,18 @@ module Labor
       end
     end
 
+    private
+
+    # Removes the meta data from an ability name.
+    #
+    # name - The String name of the ability.
+    #
+    # Returns the String name of the ability with the
+    # meta data removed. (e.g. "ability_name[123]" => "ability_name")
+    def remove_meta_data(name)
+      matches = name.match(/(.*)\[.*\]/)
+      return matches[1] unless matches.nil?
+      name
+    end
   end
 end

data/spec/worker_spec.rb

@@ -15,4 +15,11 @@ describe Labor::Worker do
     real_worker = @worker.instance_variable_get(:@worker)
     real_worker.instance_variable_get(:@abilities).should have_key("test")
   end
+
+  describe "meta data removal" do
+    it "can strip the metadata from a ability name" do
+      name = @worker.send(:remove_meta_data, "ability_name[123]")
+      name.should == "ability_name"
+    end
+  end
 end

metadata

@@ -1,62 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: labor
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Brett Buddin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-29 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-05-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: gearman-ruby
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2164345000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2164345000
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2164344420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-description: Wrapper for gearman-ruby that provides a different, and more portable, way of defining jobs.
+  prerelease: false
+  version_requirements: *2164344420
+description: Wrapper for gearman-ruby that provides a different, and more portable,
+  way of defining jobs.
 email: brett@intraspirit.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
-files: 
+files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/labor/ability.rb
 - lib/labor/config.rb
+- lib/labor/core_ext/hash.rb
 - lib/labor/core_ext.rb
 - lib/labor/helpers.rb
 - lib/labor/tasks.rb
@@ -68,39 +59,31 @@ files:
 - spec/labor_spec.rb
 - spec/spec_helper.rb
 - spec/worker_spec.rb
-has_rdoc: true
 homepage: http://github.com/brettbuddin/labor
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  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
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: More portable jobs for Gearman workers.
-test_files: 
+test_files:
 - spec/config_spec.rb
 - spec/files/sample_config.rb
 - spec/labor_spec.rb