readymade 0.2.8 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b21e8901b1feeed09d060f31d886d21041a3c13c000e4c6a90c11a0cd50de12
-  data.tar.gz: 2909b312ed7110ff519b67a203023389c45db97e00be314e599df9d1b8f60337
+  metadata.gz: f6af81b9c83a1dad8f64ead23ebe956ffe8341308c3acef6211a9c76fa5df5fb
+  data.tar.gz: d6cda3a6863ce1330df753de6e6fd51c8f0005e05b0aa8d10534b59eb5b6104f
 SHA512:
-  metadata.gz: 359f4a10a9afbcadfff88b655d27dc8f5d4e971cf812f5ab7bc74e27b48b81b273fb79678e0de057ddc3d70c44077420e7fd13da7b11e0a2225fed1c35432213
-  data.tar.gz: '08a127d29a24149dab9e1ac7d8eac89eb008c36f90c1fb569e83cc5ee7920f9ed3503bf2fac43b92e90c47a0fb4861a76bc308922fe61a6fd5098860bca24740'
+  metadata.gz: 7f05bc204146596fd641f742d6ee2738dfc8db887ddb35c1588f1a1aa1639f80fc334920333206e2392999ea7c01f9db42c585b356ec33cfa9ec528cec0249f2
+  data.tar.gz: 1d7196a1c79a79169bcf865406dca0aa8bdfcfb07d7e659616fe2563260b3dbfcc95ed8f19c3f43eca7242e7acd573648629a90cce803495474b2289cc408d19

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+spec/.DS_Store

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.4.0] - 2023-06-22
+
+* 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
+
 ## [0.2.8] - 2022-11-10
 
 ### Fixes

data/Gemfile

@@ -2,7 +2,8 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in lead.gemspec
+# Specify your gem's dependencies in readymade.gemspec
 gemspec
-
-gem 'activemodel'
+#
+# gem 'activemodel'
+# gem 'activejob'

data/Gemfile.lock

@@ -1,25 +1,31 @@
 PATH
   remote: .
   specs:
-    readymade (0.2.8)
+    readymade (0.3.5)
+      activejob
+      activemodel
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activesupport (6.1.4.1)
+    activejob (7.0.5)
+      activesupport (= 7.0.5)
+      globalid (>= 0.3.6)
+    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)
-    i18n (1.8.11)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    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)
@@ -34,15 +40,13 @@ 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
 
 DEPENDENCIES
-  activemodel
   byebug
   rake
   readymade!

data/README.md

@@ -131,6 +131,61 @@ response.data[:record]
 response.data[:any_other_data]
 ```
 
+### `.call_async` - any action could we call async (using ActiveJob)
+
+```ruby
+class Orders::Actions::SendNotifications < Readymade::Action
+  def call
+    send_email
+    send_push
+    send_slack
+
+    response(:success, record: record, any_other_data: data)
+  end
+  ...
+end
+
+Orders::Actions::SendNotifications.call_async(order: order)
+```
+
+
+### `.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
 
 Provides set of help methods like: `build_form`, `form_valid?`, `validation_fail`, `save_record`, etc.

data/lib/readymade/action.rb

@@ -1,15 +1,34 @@
 # frozen_string_literal: true
 
 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 = {})
@@ -23,6 +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 :default
+
+    def perform(**args)
+      args.delete(:class_name).to_s.constantize.send(:call!, **args)
+    end
+  end
+end

data/lib/readymade/background_job.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'active_job' unless defined?(::ActiveJob)
+
+module Readymade
+  class BackgroundJob < ::ActiveJob::Base
+    # queue_as :default
+
+    def perform(**args)
+      args.delete(:class_name).to_s.constantize.send(:call, **args)
+    end
+  end
+end

data/lib/readymade/version.rb

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

data/lib/readymade.rb

@@ -3,6 +3,8 @@
 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

@@ -35,4 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+
+  spec.add_dependency "activemodel"
+  spec.add_dependency "activejob"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readymade
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.5
 platform: ruby
 authors:
 - OrestF
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Set of base classes for ABDI architecture
 email:
 - falchuko@gmail.com
@@ -73,6 +101,8 @@ 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
 - lib/readymade/instant_form.rb