operationable 0.5.3 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91bbd789046a4a209af2f97ec1334a943062b8b35d25e15a1a7dbe4383d67740
-  data.tar.gz: 5870ada65a65e8fc32d445d671585ae8758bac55b6048db07cda8fc560cd4b1d
+  metadata.gz: b4e8fb2869237f5b4659aec5a8249112f34385a20f6d28366fa1e77d734a13ea
+  data.tar.gz: a9ce3ee3d30dbbf0bfe1cc8ba8fc12f1def3177a1edaa12435ab0e95710636c9
 SHA512:
-  metadata.gz: 1a8a5e93c0104de1f1aa50d6fc5d42bbc2cca845e2b85f1a3e1e66ce34b09590ab68c6eff5af1458039377c89d95f18fb06fe8ba659fec79a3e38af96f6caa5b
-  data.tar.gz: c8cfd9ba6ff3a6d0daaa42a8779028b3966d0159e334952cbe72c47488570c691893366a2bda15f9ae0e93cbabbdf398a42786af06e1d4351cbcddf0c9c9f93c
+  metadata.gz: 27aa66d3e45608c1e27934b12aa8bb290f76606703480e3770d72e2d5d05c299f7ac1f430a56fea9a6c1d108ce3d50941c05f2fd4360796bc3b4c09d6416b4dd
+  data.tar.gz: 635f36ae4ac796175c9a8c48d7b7db7fd63071788178307ea4a86839339a81220ec94290df5a656e0e4aa850c2c381cfec215b783b36d129571d8175cb7e9e20

data/README.md

@@ -59,11 +59,23 @@ module EntityOperation
       end
     end
 
+    class Delayer < Operationable::Delayer
+      def delay_callback_one
+        { wait_until: Date.tomorrow.noon } # or wait
+      end
+    end
+
     class Runner < Operationable::Runners::Separate
       def initialize_callbacks
         push_to_queue(:callback_one)
-        push_to_queue(:callback_two, :low)
-        push_to_queue(:callback_three, :high)
+        push_to_queue(:callback_two, queue: :low)
+        push_to_queue(:callback_three, queue: :high, job_class_name: MySpecialJob)
+        push_to_queue(:callback_four, queue: :high, params: {hello: 123})
+      end
+
+      # This is default behaviour, but you can redefine it, to use with other adapter for example
+      def perform(job_class_name, args, delayed_params)
+        job_class_name.to_s.constantize.set(delayed_params).method(perform_method).call(args)
       end
     end
 
@@ -101,6 +113,41 @@ push_to_queue(callback_name, queue_name) if queue_name not passed, callback will
 
 Operations work via ActiveJob, so you can use any adapter that you want.
 
+### Delayer
+
+This class process when process job
+
+### Job
+
+I get rid of ActiveJob dependency. So, extend you exting job class with code below
+
+```ruby
+class OpJob < ActiveJob::Base
+  queue_as do
+    arguments.first[:q_options][:queue]
+  end
+
+  def perform(q_options:, props:)
+    "Operationable::Runners::#{q_options[:type].capitalize}".constantize.call(q_options: q_options, props: props)
+  end
+end
+
+```
+
+Define global job class name at your initializers (config/initializers/operationable.rb)
+
+```ruby
+module Operationable
+  module Runners
+    class Base
+      def job_class
+        'OpJob'
+      end
+    end
+  end
+end
+```
+
 ### Serializer
 
 Serializer used to define what values should be passed to job(redis do not accept AR instances or other complex structures).

data/lib/operationable.rb

@@ -9,14 +9,12 @@ require 'operationable/callback'
 require 'operationable/operation'
 require 'operationable/serializer'
 require 'operationable/specification'
-require 'operationable/operationable_job'
+require 'operationable/delayer'
 
 require 'operationable/runners/base'
 require 'operationable/runners/serial'
 require 'operationable/runners/separate'
 
-require 'jobs/operation_job'
-
 require 'operations/create'
 require 'operations/destroy'
 require 'operations/update'

data/lib/operationable/delayer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Operationable
+  class Delayer
+    attr_reader :record, :user, :params, :result, :activity, :action_name
+
+    def initialize(record, user, params={}, result=nil, activity='', action_name='')
+      @record = record
+      @user = user
+      @params = params
+      @result = result
+      @activity = activity
+      @action_name = action_name
+    end
+  end
+end

data/lib/operationable/runners/base.rb

@@ -54,8 +54,8 @@ module Operationable
       def initialize_callbacks
       end
 
-      def push_to_queue(*callback_method_names, queue: nil, params: {})
-        callback_method_names.each do |callback_method_name, job_class_name|
+      def push_to_queue(*callback_method_names, job_class_name: nil, queue: nil, params: {})
+        callback_method_names.each do |callback_method_name|
           callbacks << {
             callback_method_name: callback_method_name.to_s,
             job_class_name: job_class_name.nil? ? job_class.to_s : job_class_name.to_s,
@@ -65,10 +65,6 @@ module Operationable
         end
       end
 
-      def callback_names
-        check_callbacks.map { |callback| callback[:callback_method_name] }
-      end
-
       def check_callbacks
         callbacks.find_all do |callback|
           satisfy = specification&.try("should_#{callback[:callback_method_name]}".to_sym)
@@ -77,11 +73,15 @@ module Operationable
       end
 
       def serializer_instance
-        serializer_class_name.constantize.new(record, user, params, result, activity, action_name)
+        @serializer_instance ||= serializer_class_name.constantize.new(record, user, params, result, activity, action_name)
+      end
+
+      def delayer
+        @delayer ||= delayer_class_name.constantize.new(record, user, params, result, activity, action_name)
       end
 
       def specification
-        @specification ||= specification_class_name.constantize.new(record, user, params, activity, action_name)
+        @specification ||= specification_class_name.constantize.new(record, user, params, result, activity, action_name)
       end
 
       def callback_class_name
@@ -96,6 +96,10 @@ module Operationable
         "#{operation_class_name}::Specification"
       end
 
+      def delayer_class_name
+        "#{operation_class_name}::Delayer"
+      end
+
       def operation_class_name
         self.class.name.chomp('::Runner')
       end
@@ -116,8 +120,8 @@ module Operationable
         sync? ? job_sync_execute_method : job_async_execute_method
       end
 
-      def perform(job_class_name, args)
-        job_class_name.to_s.constantize.method(perform_method).call(args)
+      def perform(job_class_name, args, delayed_params)
+        job_class_name.to_s.constantize.set(delayed_params).method(perform_method).call(args)
       end
 
       def sync?

data/lib/operationable/runners/separate.rb

@@ -15,7 +15,12 @@ module Operationable
           props: props.merge(params)
         }
 
-        queue.blank? ? self.class.call(args) : perform(job_class_name, args)
+        queue.blank? ? self.class.call(args) : perform(job_class_name, args, get_delayed_params(callback_method_name))
+      end
+
+      def get_delayed_params(callback_method_name)
+        delay = delayer&.try("delay_#{callback_method_name}".to_sym)
+        delay.nil? ? {} : delay
       end
 
       def q_options(callback_method_name, queue)

data/lib/operationable/runners/serial.rb

@@ -26,6 +26,10 @@ module Operationable
           queue: queue })
       end
 
+      def callback_names
+        check_callbacks.map { |callback| callback[:callback_method_name] }
+      end
+
       private
 
       def queue

data/lib/operationable/specification.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 module Operationable
   class Specification
-    attr_reader :record, :user, :params, :activity, :action_name
+    attr_reader :record, :user, :params, :result, :activity, :action_name
 
-    def initialize(record, user, params={}, activity='', action_name='')
+    def initialize(record, user, params={}, result=nil, activity='', action_name='')
       @record = record
       @user = user
       @params = params
+      @result = result
       @activity = activity
       @action_name = action_name
     end

data/lib/operationable/version.rb

@@ -1,3 +1,3 @@
 module Operationable
-  VERSION = "0.5.3"
+  VERSION = "0.5.8"
 end

data/operationable.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.1.0'
 
-  spec.add_dependency             'activejob', '>= 4.2.0'
+  # spec.add_dependency             'activejob', '>= 4.2.0'
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: operationable
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.8
 platform: ruby
 authors:
 - Kirill Suhodolov
@@ -11,20 +11,6 @@ bindir: bin
 cert_chain: []
 date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activejob
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -85,10 +71,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/jobs/operation_job.rb
 - lib/operationable.rb
 - lib/operationable/builder.rb
 - lib/operationable/callback.rb
+- lib/operationable/delayer.rb
 - lib/operationable/operation.rb
 - lib/operationable/runners/base.rb
 - lib/operationable/runners/separate.rb

data/lib/jobs/operation_job.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-# TODO: use module instead
-class OperationJob < ActiveJob::Base
-  queue_as do
-    arguments.first[:q_options][:queue]
-  end
-
-  def perform(q_options:, props:)
-    "Operationable::Runners::#{q_options[:type].capitalize}".constantize.call(q_options: q_options, props: props)
-  end
-end