get_back 0.0.1-java

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Joe Kutner
+
+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,60 @@
+get_back
+==========
+
+Get_Back is a library for making a Ruby method run in the background.  But it only works with JRuby.
+
+Examples
+---------
+
+Lets say you want to send an email as part of your sign up process.  But you don't want that to run synchronously cause
+it could take too long.  Make it get back!
+
+    require 'get_back'
+
+    class User
+      extend GetBack::JoJo
+
+      def send_email(action)
+        puts "Thanks for #{action} my website"
+      end
+
+      get_back :send_email
+
+    end
+
+Now the send_email method will *always* run in a separate thread.
+
+The background methods are run in a separate thread.  The threads a pulled from a pool.  If you need to limit the
+concurrency of a method, you can fix the pool size:
+
+    get_back :send_email, :pool => 10
+
+You can also specify callbacks for success, rescue, and ensure.  The success callback is just a block thats passed to
+the get_back call:
+
+    get_back :send_email do
+      log.info "email send successfully
+    end
+
+The rescue and ensure callbacks reference other methods
+
+    get_back :send_email, :rescue => :log_bad_email
+
+    def log_bad_email(e) do
+      log.error "something bad happened when we sent an email!"
+    end
+
+Or you can send more email:
+
+    get_back :send_mail, :ensure => :send_spam
+
+    def send_spam
+      send_email("spamming")
+    end
+
+Copyright
+----------
+
+Copyright © 2011 Joe Kutner. Released under the MIT License.
+
+See LICENSE for details.

data/get_back.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{get_back}
+  s.version = "0.0.1"
+  s.authors = ["Joe Kutner"]
+  s.date = Time.now
+  s.description = "Easy Background Jobs for JRuby"
+  s.email = ["jpkutner@gmail.com"]
+  s.files = Dir['{lib,spec}/**/*'] + Dir['{*.md,*.txt,*.gemspec}']
+  s.homepage = "http://github.com/jkutner/get_back"
+  s.require_paths = ["lib"]
+  s.summary = "Easy Background Jobs for JRuby"
+  s.test_files = Dir["spec/*_spec.rb"]
+  s.platform = "java"
+end

data/lib/get_back/jojo.rb

@@ -0,0 +1,56 @@
+require 'java'
+
+module GetBack
+  module JoJo
+    @@executors = java.util.Collections.synchronizedList([])
+
+    at_exit { @@executors.each {|e| e.shutdown} }
+
+    def get_back(method, config={}, &block)
+      with_executor_service(config[:pool]) do |e|
+
+        # give the new method a name
+        gb_method_name = "_get_back_#{method}_".to_sym
+
+        # create a new proxy
+        old_method = instance_method(method)
+        define_method(gb_method_name) do |*args|
+          old_method.bind(self).call(*args)
+        end
+
+        # redefine the method
+        define_method(method) do |*args|
+          e.submit do
+            begin
+              r = send(gb_method_name, *args)
+              if block_given?
+                if block.arity == 1
+                  yield self
+                else
+                  yield self, r
+                end
+              end
+            rescue Exception => ex
+              send(config[:rescue], ex) if config[:rescue]
+              raise
+            ensure
+              send(config[:ensure]) if config[:ensure]
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def with_executor_service(pool_size=nil)
+      if pool_size.nil? 
+        e = java.util.concurrent.Executors.newCachedThreadPool
+      else
+        e = java.util.concurrent.Executors.newFixedThreadPool(pool_size.to_i)
+      end
+      @@executors << e
+      yield e
+    end
+  end
+end

data/lib/get_back.rb

@@ -0,0 +1 @@
+require 'get_back/jojo'

data/spec/happy_path_spec.rb

@@ -0,0 +1,149 @@
+require '../lib/get_back'
+
+class Foo
+  extend GetBack::JoJo
+
+  attr_accessor :step1, :step2, :step3
+
+  def initialize
+    @step1 = false
+    @step2 = false
+    @step3 = false
+  end
+
+  def do_it
+    sleep(1) until @step1 == true
+    @step2 = true
+  end
+  get_back :do_it
+
+  def do_it_fixed
+    sleep(1) until @step1 == true
+    @step2 = true
+  end
+  get_back :do_it_fixed, :pool => 2
+
+  def do_it_success
+    sleep(1) until @step1 == true
+    @step2 = true
+  end
+  get_back :do_it_success do |f|
+    f.step3 = true
+  end
+
+  def do_it_rescue
+    sleep(1) until @step1 == true
+    @step2 = true
+    raise "Some Error"
+  end
+  get_back :do_it_rescue, :rescue => :callback1
+
+  def callback1(e)
+    @step3 = true
+  end
+
+  def do_it_ensure
+    sleep(1) until @step1 == true
+    @step2 = true
+    raise "Some Error"
+  end
+  get_back :do_it_ensure, :ensure => :callback0
+
+  def callback0
+    @step3 = true
+  end
+
+  def do_it_args(a, b, c)
+    sleep(1) until @step1 == true
+    @step2 = a && b && c
+  end
+  get_back :do_it_args
+end
+
+describe Foo do
+
+  context "#do_it" do
+    it "runs in the background" do
+      subject.do_it
+      sleep(2)
+      subject.step1.should be_false
+      subject.step2.should be_false
+      subject.step1 = true
+      sleep(1)
+      subject.step2.should be_true
+      subject.step1.should be_true
+    end
+  end
+
+  context "#do_it_args" do
+    it "runs in the background" do
+      subject.do_it_args(true, true, true)
+      sleep(2)
+      subject.step1.should be_false
+      subject.step2.should be_false
+      subject.step1 = true
+      sleep(1)
+      subject.step2.should be_true
+      subject.step1.should be_true
+    end
+  end
+
+  context "#do_it_fixed" do
+    it "runs in the background" do
+      subject.do_it_fixed
+      sleep(2)
+      subject.step1.should be_false
+      subject.step2.should be_false
+      subject.step1 = true
+      sleep(1)
+      subject.step2.should be_true
+      subject.step1.should be_true
+    end
+  end
+
+  context "#do_it_success" do
+    it "runs in the background" do
+      subject.do_it_success
+      sleep(2)
+      subject.step1.should be_false
+      subject.step2.should be_false
+      subject.step3.should be_false
+      subject.step1 = true
+      sleep(1)
+      subject.step2.should be_true
+      subject.step1.should be_true
+      subject.step3.should be_true
+    end
+  end
+
+  context "#do_it_rescue" do
+    it "runs in the background" do
+      subject.do_it_rescue
+      sleep(2)
+      subject.step1.should be_false
+      subject.step2.should be_false
+      subject.step3.should be_false
+      subject.step1 = true
+      sleep(1)
+      subject.step2.should be_true
+      subject.step1.should be_true
+      subject.step3.should be_true
+    end
+  end
+
+  context "#do_it_ensure" do
+    it "runs in the background" do
+      subject.do_it_ensure
+      sleep(2)
+      subject.step1.should be_false
+      subject.step2.should be_false
+      subject.step3.should be_false
+      subject.step1 = true
+      sleep(1)
+      subject.step2.should be_true
+      subject.step1.should be_true
+      subject.step3.should be_true
+    end
+  end
+end
+

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: get_back
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: java
+authors:
+- Joe Kutner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-10-11 00:00:00.000000000 -05:00
+default_executable:
+dependencies: []
+description: Easy Background Jobs for JRuby
+email:
+- jpkutner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/get_back.rb
+- lib/get_back/jojo.rb
+- spec/happy_path_spec.rb
+- README.md
+- LICENSE.txt
+- get_back.gemspec
+has_rdoc: true
+homepage: http://github.com/jkutner/get_back
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.5.1
+signing_key:
+specification_version: 3
+summary: Easy Background Jobs for JRuby
+test_files:
+- spec/happy_path_spec.rb
+...