readymade 0.3.0 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4e8e02d585f7ebcd9b83ddaef817e0116b8b06c80d543a46fbfb2df1adf99ca
-  data.tar.gz: 333b90782eb4e24733f9073132f667f540b2f81c5b62d3dd92372ee434b0b9f3
+  metadata.gz: 90f0eb0091bea1e29078e83958d77aedfa989c39af4d21213bec81347f4d73df
+  data.tar.gz: b96a07f92350bee6be041456b979dc781ad1324ad8ef38e95547f9af34a250a8
 SHA512:
-  metadata.gz: 202033d59da56afbc9a17b0eaf8659ed3fcd1fd4ff9c89d9687d429d636dbe61d22c450dc03ba15251b9d282ae6f7aa943caece163a23d8866f95d3798f58db5
-  data.tar.gz: 3d02a2c554e9d4de2db20bbd598fa4c0d8da2757003358142cb61e7e71abf47b728a880b8f08c28824c8214c10711973376ed93550e2439ef98bb3d48c51ed34
+  metadata.gz: 82b0f5dbc204ea624d84c48edc4b6619216c300d447f1cae69a1828b88d4533b2048960757f2e354f5adf15400b993b2efff92e0e44f4e2c6e8e38a50a7a8221
+  data.tar.gz: 21b076ad062a65ed5afde67521ee433f99228cedf0d0b229079270e6f3793b7e4097a48ba02c9c81e7f5f84eedef8b0fc565f1ade7dbdfd518c91cbfb346227c

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.3.6] - 2023-07-21
+
+* Add `queue_as: :name` argument to `Readymade::BackgroundJob` to select queue name when using `.call_async(args.merge(queue_as: :my_queue))`
+
+## [0.3.5] - 2023-06-23
+
+* Add `.call!` method to `Readymade::Action` to raise an error if not success
+* Add `.call_async!` method to `Readymade::Action` to raise an error in background if not success
+
 ## [0.3.0] - 2023-03-14
 
 * Add `.call_async` method to `Readymade::Action` to run service in background

data/Gemfile.lock

@@ -1,32 +1,31 @@
 PATH
   remote: .
   specs:
-    readymade (0.3.0)
+    readymade (0.3.6)
       activejob
       activemodel
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (6.1.4.1)
-      activesupport (= 6.1.4.1)
+    activejob (7.0.5)
+      activesupport (= 7.0.5)
       globalid (>= 0.3.6)
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activesupport (6.1.4.1)
+    activemodel (7.0.5)
+      activesupport (= 7.0.5)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     byebug (11.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.4.4)
     globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.8.11)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
+    minitest (5.18.1)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -41,9 +40,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -146,6 +146,47 @@ class Orders::Actions::SendNotifications < Readymade::Action
 end
 
 Orders::Actions::SendNotifications.call_async(order: order)
+Orders::Actions::SendNotifications.call_async!(order: order, queue_as: :my_queue) # job will be executed in 'my_queue'
+# Important! Make sure your sidekiq configuration has 'my_queue' queue
+```
+
+
+### `.call!` - raise error unless response is success
+(action must return Readymade::Response.new(:success))
+
+```ruby
+class Orders::Actions::SendNotifications < Readymade::Action
+  def call!
+    send_email
+    return response(:fail, errors: errors) unless email_sent?
+    send_push
+    send_slack
+
+    response(:success, record: record, any_other_data: data)
+  end
+  ...
+end
+
+Orders::Actions::SendNotifications.call!(order: order) # raise error if response is fail
+```
+### `.call_async!` - runs in background and raise error unless response is success
+(action must return Readymade::Response.new(:success))
+
+```ruby
+class Orders::Actions::SendNotifications < Readymade::Action
+  def call!
+    send_email
+    return response(:fail, errors: errors) unless email_sent?
+    send_push
+    send_slack
+
+    response(:success, record: record, any_other_data: data)
+  end
+  ...
+end
+
+Orders::Actions::SendNotifications.call_async!(order: order) # job will be failed
+
 ```
 
 ### Readymade::Operation

data/lib/readymade/action.rb

@@ -2,19 +2,33 @@
 
 require 'readymade/response'
 require 'readymade/background_job'
+require 'readymade/background_bang_job'
 
 module Readymade
   class Action
     class NonKeywordArgumentsError < StandardError; end
+    class UnSuccessError < StandardError; end
 
     def self.call(*args, &block)
       new(*args, &block).call
     end
 
+    def self.call!(*args, &block)
+      new(*args, &block).call!.then do |res|
+        raise UnSuccessError unless res.try(:success?)
+
+        res
+      end
+    end
+
     def self.call_async(*args, &block)
       new(*args, &block).call_async
     end
 
+    def self.call_async!(*args, &block)
+      new(*args, &block).call_async!
+    end
+
     attr_reader :args, :data
 
     def initialize(args = {})
@@ -28,10 +42,16 @@ module Readymade
 
     def call; end
 
+    def call!; end
+
     def call_async
       ::Readymade::BackgroundJob.perform_later(class_name: self.class.name, **args)
     end
 
+    def call_async!
+      ::Readymade::BackgroundBangJob.perform_later(class_name: self.class.name, **args)
+    end
+
     def response(status, *args)
       Response.new(status, *args)
     end

data/lib/readymade/background_bang_job.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'active_job' unless defined?(::ActiveJob)
+
+module Readymade
+  class BackgroundBangJob < ::ActiveJob::Base
+    queue_as { self.arguments[0].fetch(:queue_as, :default) }
+
+    def perform(**args)
+      args.delete(:class_name).to_s.constantize.send(:call!, **args)
+    end
+  end
+end

data/lib/readymade/background_job.rb

@@ -4,7 +4,7 @@ require 'active_job' unless defined?(::ActiveJob)
 
 module Readymade
   class BackgroundJob < ::ActiveJob::Base
-    # queue_as :default
+    queue_as { self.arguments[0].fetch(:queue_as, :default) }
 
     def perform(**args)
       args.delete(:class_name).to_s.constantize.send(:call, **args)

data/lib/readymade/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Readymade
-  VERSION = '0.3.0'
+  VERSION = '0.3.6'
 end

data/lib/readymade.rb

@@ -4,6 +4,7 @@ require 'readymade/model/api_attachable'
 require 'readymade/model/filterable'
 require 'readymade/controller/serialization'
 require 'readymade/background_job'
+require 'readymade/background_bang_job'
 require 'readymade/action'
 require 'readymade/form'
 require 'readymade/instant_form'

data/readymade.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readymade
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.6
 platform: ruby
 authors:
 - OrestF
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -101,6 +101,7 @@ files:
 - bin/setup
 - lib/readymade.rb
 - lib/readymade/action.rb
+- lib/readymade/background_bang_job.rb
 - lib/readymade/background_job.rb
 - lib/readymade/controller/serialization.rb
 - lib/readymade/form.rb
@@ -117,7 +118,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/OrestF/readymade
   source_code_uri: https://github.com/OrestF/readymade
-  changelog_uri: https://github.com/OrestF/readymade/CHANGELOG.md
+  changelog_uri: https://github.com/OrestF/readymade/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: