async_block 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 980162aac88aba7f5243484afe563360d0b0ca7f36c4791e67b53b74bfaa9eed
-  data.tar.gz: d1b41a0d31b594b53ebf804851baf79a17396650e4c9c85393d2345c3dfb29c3
+  metadata.gz: f4bffa0f5cc7922087739ef5df009ad311aaa33fb259bd277f62b5cf8ed6666b
+  data.tar.gz: 1e1f2af060baf563bd6402d5b3b8f49b9b3791156fc3549f2471ec8ba5c1e397
 SHA512:
-  metadata.gz: 1b740ff8cd0f0a97114d6cb7e2bd1a64614aebf484a46edf08cd329d2f5162efe77c874642314823e93268002825902c435c6eb7c50a34e6ab4b107280a99c10
-  data.tar.gz: 77a1af646a875c7913913f31e8d2c98301405327b0135de34a7edd4170ab6dbba32e03cf3a7f7fe91b07f19c1d55826db35e38197586e5392a0df9432d2284c5
+  metadata.gz: 7beb4c8fdea5aaeba84aea747932707beba14c7a7e6f610d2feddacb14feb18612c5d782802e109226abd745a72b6fa30ef32333de51c40db745148d0b3d1004
+  data.tar.gz: 22f23aeb80243b8c3f378cc551eb133f4e2a2a6c74b624f42589b3182c2ad70404bd8ce7baf42995ec289ba3b6c5823b94834487b398fea22de9f16b0ef5aa7d

data/README.md

@@ -1,8 +1,6 @@
 # AsyncBlock
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/async_block`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+AsyncBlock - A usable code block for rails to run your code asynchronously, this will help in preventing writing of new jobs to run smaller pieces of code
 
 ## Installation
 
@@ -16,6 +14,9 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+Add your code in wrapped inside AsyncBlock as described below.
+\*\* NOTE - AsyncBlock cannot be executed from irb/console
+
 ```
 AsyncBlock.perform_async do
   puts('This is running in a temporary job')
@@ -24,8 +25,18 @@ end
 ```
 
 To put some delay on the async execution (say 5 minutes):
+
+```
+AsyncBlock.perform(delay: 5.minutes) do
+  puts('This is running in a temporary job')
+  puts('Put your code below')
+end
+```
+
+To explicitly mention a queue for the async execution:
+
 ```
-AsyncBlock.perform_with_delay(5.minutes) do
+AsyncBlock.perform(delay: 1.minute, queue: 'p3') do
   puts('This is running in a temporary job')
   puts('Put your code below')
 end

data/async_block.gemspec

@@ -36,8 +36,6 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency 'activesupport', ['>= 3.0', '< 8.0']
-  # spec.add_dependency 'ParseTree', '~> 3.0'
-  # spec.add_dependency 'ruby2ruby', '~> 2.5.0'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/async_block/async_wrapper_job.rb

@@ -7,15 +7,15 @@ module AsyncBlock
   class AsyncWrapperJob < ActiveJob::Base
     queue_as :async_wrapper_job
 
-    def perform(block_string)
-      block = str_to_block(block_string)
+    def perform(source)
+      block = str_to_block(source)
       execute_block!(block)
     end
 
     private
 
-    def str_to_block(block_string)
-      SourceToBlock.new(block_string).convert
+    def str_to_block(source)
+      SourceToBlock.new(source).convert
     end
 
     def execute_block!(block)

data/lib/async_block/block_source_service.rb

@@ -13,12 +13,12 @@ module AsyncBlock
     end
 
     def convert
-      block_to_str
+      block_to_source
     end
 
     private
 
-    def block_to_str
+    def block_to_source
       @block&.source
     end
   end
@@ -31,18 +31,18 @@ module AsyncBlock
   # block = BlockToSource.new(block_string).convert
   # block&.call
   class SourceToBlock
-    def initialize(block_string)
-      @block_string = block_string
+    def initialize(source)
+      @source = source
     end
 
     def convert
-      str_to_block
+      source_to_block
     end
 
     private
 
-    def str_to_block
-      instance_eval("lambda { #{@block_string}  }", __FILE__, __LINE__)
+    def source_to_block
+      instance_eval("lambda { #{@source}  }", __FILE__, __LINE__)
     end
   end
 end

data/lib/async_block/constants.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module AsyncBlock
+  DEFAULT_QUEUE_NAME = 'async_wrapper_job'
+  DEFAULT_DELAY = 1.second
+end

data/lib/async_block/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AsyncBlock
-  VERSION = '0.1.9'
+  VERSION = '0.2.0'
 end

data/lib/async_block.rb

@@ -1,34 +1,19 @@
 # frozen_string_literal: true
 
 require_relative 'async_block/version'
+require_relative 'async_block/constants'
 require_relative 'async_block/block_source_service'
 require_relative 'async_block/async_wrapper_job'
 
 # AsyncBlock - A usable code block for rails to run your code asynchronusly,
 # this will help in preventing writing of new jobs to run smaller pieces of code
-#
-# The following full app-like example demonstrates how to use the AsyncBlock
-#
-# AsyncBlock.perform_async do
-#   puts('This is running in a temporary job')
-#   puts('Put your code below')
-# end
-#
-# To put some delay on the async execution (say 5 minutes):
-# AsyncBlock.perform_with_delay(5.minutes) do
-#   puts('This is running in a temporary job')
-#   puts('Put your code below')
-# end
 module AsyncBlock
   class Error < StandardError; end
 
-  def self.perform_async(&block)
-    block_string = BlockToSource.new(block).convert
-    AsyncWrapperJob.perform_later(block_string)
-  end
-
-  def self.perform_with_delay(delay, &block)
-    block_string = BlockToSource.new(block).convert
-    AsyncWrapperJob.set(wait: delay).perform_later(block_string)
+  def self.perform_async(queue: nil, delay: nil, &block)
+    source = BlockToSource.new(block).convert
+    queue ||= DEFAULT_QUEUE_NAME
+    delay ||= DEFAULT_DELAY
+    AsyncWrapperJob.set(wait: delay, queue: queue.to_sym).perform_later(source)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async_block
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Adittya Dey
@@ -50,6 +50,7 @@ files:
 - lib/async_block.rb
 - lib/async_block/async_wrapper_job.rb
 - lib/async_block/block_source_service.rb
+- lib/async_block/constants.rb
 - lib/async_block/version.rb
 - sig/async_block.rbs
 homepage: https://github.com/Velocity-Engineering/async-block