delayed_worker 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ae32e6e8aa2483e0b350a9b343bf0eddd775c5e
-  data.tar.gz: 81944b89caec11b4d239dd0bf948457b2b44904d
+  metadata.gz: fd73ac07e571bdb211e677b7c99126f3fdb54d28
+  data.tar.gz: 8094e9bac10b6bcf2e7e84627d32978eb2d03a3f
 SHA512:
-  metadata.gz: e98721ffbf9d812be9b752a246805d4f9fed7f9b37416fd911cd59cc03ec5ff377354443b8569652a2e0e8aebc182eb40cd5283ca5e3cc33f82c5183990a3b5e
-  data.tar.gz: 82eab53419ae9cd959a26f9b27d895cbda6f9cccd65f10ecd22b3477511a26aa4db1a00b88a8be43bc611b49dafd5acf7fb174fb118a9dba4f17fed3a21fd6c6
+  metadata.gz: 32f5152f43fe0346169c760274bfc6e36cbbaf1f62d8629d0b1cd94c785db664c8db60ace3c5e2266a001a6ae7524e000a2a52f5216fec8255362f9e02be0b4a
+  data.tar.gz: df7c6fefb9714115e84cd930651a1ec2d399f76afa9c8f2cb2543d0fe8fb5ac080394107dfdb688fbd5bb7065cff7413bf1285eda81a7a6caa5e202fe14b50bd

data/README.md

@@ -1,10 +1,11 @@
-# DelayedWorker [![Build Status](https://travis-ci.org/zw963/delayed_worker.svg?branch=master)](https://travis-ci.org/zw963/delayed_worker) [![Gem Version](https://badge.fury.io/rb/delayed_worker.svg)](http://badge.fury.io/rb/delayed_worker)
+e# DelayedWorker [![Build Status](https://travis-ci.org/zw963/delayed_worker.svg?branch=master)](https://travis-ci.org/zw963/delayed_worker) [![Gem Version](https://badge.fury.io/rb/delayed_worker.svg)](http://badge.fury.io/rb/delayed_worker)
 
-TODO: Write a gem description
+This gem is intend for write delayed job with easy and clean.
 
 ## Philosophy
 
-TODO: Write philosophy
+We hope to see delayed executed business logic clealy in where add it into, so, all we need to be done is 
+just use a `do ... end block` to wrap delayed job code, it will work as expected.
 
 ## Getting Started
 
@@ -20,18 +21,82 @@ Add to your Gemfile
 
 ## Usage
 
-TODO: Write usage instructions here
-
+### run worker in Rails model.
+
+```
+# == Schema Information
+
+# Table name: test_delayed_workers
+
+#  text :string(255)
+
+class TestDelayedWorker < ActiveRecord::Base
+  def update_column!
+    add_delayed_worker job_name: 'change text value' do
+      # ... do heavy task here in worker asynchronous.
+      # e.g. invoke exteral API or do heavy SQL query
+      
+      # when done, we update text column.
+      update(text: 'new_value')
+    end
+  end
+end
+
+
+class TestDelayedWorkerController < ActionController::Base
+  def update_column
+    record = TestDelayedWorker.find(params[:id])
+    # invoke delayed worker
+    record.update_column!
+  end
+end
+```
+
+### run worker in controller action
+ ```
+class TestDelayedWorkerController < ActionController::Base
+  def update_text_column
+    id = params[:id]
+    new_params = {
+      'text' => params[:text]
+    }
+    # we must use `params: new_params` to pass current context variable into block.
+    add_delayed_worker job_name: 'change text value use params in controller', subject_id: id, params: new_params do
+      record = TestDelayedWorker.find(subject_id)
+      record.update(text: params['text'])
+    end
+  end
+end
+```
+
+### Run in a simple class
+
+```
+class SimpleDelayedWorker
+  include DelayedWorker::Concern
+  
+  def some_method
+    add_delayed_worker job_name: 'simple delayed worker', time: 10 do
+      print 'run asynchronous after 10 seconds'
+    end
+  end
+end
+ ```
+ 
+ __IMPORTANT__ some trap you must to know:
+ 
+ 1. Only support `do ...end` block, and `do` must not same line as `end`!
+ 2. if need use variables defined in add_delayed_worker invoked, only support use `params` named parameter pass in.
+ 
 ## Support
 
-  * MRI 1.9.3+
-  * Rubinius 2.2+
+CRuby 2.2 2.3 2.4 2.5 is support.
+  
+## Dependency
 
-## Limitations
 
-No known limit.
 
-## History
+ ## History
 
   See [CHANGELOG](https://github.com/zw963/delayed_worker/blob/master/CHANGELOG) for details.
 
@@ -41,7 +106,7 @@ No known limit.
   * [Source](https://github.com/zw963/delayed_worker)
   * Patches:
     * Fork on Github.
-    * Run `gem install --dev delayed_worker` or `bundle`.
+    * Run `bundle install`.
     * Create your feature branch: `git checkout -b my-new-feature`.
     * Commit your changes: `git commit -am 'Add some feature'`.
     * Push to the branch: `git push origin my-new-feature`.

data/lib/delayed_worker/version.rb

@@ -1,5 +1,5 @@
 class DelayedWorker
-  VERSION = [0, 0, 2]
+  VERSION = [0, 1, 0]
 
   class << VERSION
     def to_s

data/lib/delayed_worker/workers/delayed_worker.rb

@@ -5,9 +5,20 @@ class DelayedWorker
   sidekiq_options backtrace: true, queue: 'default'
 
   def perform(job_name, subject_id, subject_type, callback, params)
-    type = Object.const_get(subject_type)
-    if defined? ::ActiveRecord::Base and type < ::ActiveRecord::Base
-      record = type.find(subject_id)
+    _type = Object.const_get(subject_type)
+    _params = Hash.new do |hash, key|
+      if hash.key? key.to_s and not hash[key.to_s].nil?
+        hash[key.to_s]
+      else
+        nil
+      end
+    end
+
+    _params = _params.merge(params)
+    params = _params
+
+    if defined? ::ActiveRecord::Base and _type < ::ActiveRecord::Base
+      record = _type.find(subject_id)
       delayed_worker_log "Delayed worker:\033[0;33m #{job_name} \033[0mis start!"
       record.instance_eval(callback, __FILE__, __LINE__)
     else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed_worker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Billy.Zheng
@@ -52,6 +52,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,7 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: ''
+description: A easy-use and clean wrapper for sidekiq worker.
 email:
 - vil963@gmail.com
 executables: []
@@ -105,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -116,5 +130,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Run delayed job easy!
 test_files: []