readymade 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8483000673ca7a63fffc4b90f4daa53b22888b868e4c1cd4bf5777d1a343971f
-  data.tar.gz: bb4439b66aa4aa72b31ccba62ae4c79a79506e91ce20499091c5971beac915b9
+  metadata.gz: b9a882e1827fc02ccf9591bd9b553a3125400b613896043759e8d6b67583f1a6
+  data.tar.gz: 6cd288e19b31eaf1584da299a72b8ba80dd9bf5eb89f8f8adeac0b161d68ff7b
 SHA512:
-  metadata.gz: e021c22b31b459638c2cdc4fafeb40b6eb0743f3164894f67ff5781f5108a52b524f297b08f6a4b9ec339552874e033af511076160cda43050b0d65913e77f20
-  data.tar.gz: 511da71335a13117bc9b9c7e12a05ef868e2e0c48405a9ae70d24fe791067a73a123891d324a5c1ef9c119e173bbfc211fd62fc1e89820b5fc67a4d8be86268f
+  metadata.gz: 18db5112a9b9d07f7a344fa9213cac219ffc99c82d6c74fa645839c9c3e25f1402c29d4d05aacf8baaafd2d67cde6d6e748708f73a486625b375ab32bad25db7
+  data.tar.gz: bca496b18a8a38f5d1298aa379f11a6ff713fcb59d44ad34a31a753b518569186734c08032f94be8c407dd75dfd4e9c3709cc7b73d82fb969912515cfc4813d5

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.4.2] - 2025-05-26
+
+* Add `job_options.discard_on` argument to `Readymade::BackgroundJob` to discard job on specific exceptions
+* Deprecated `queue_as` argument in `Readymade::BackgroundJob` in favor of `job_options.queue_as`
+
+## [0.4.1] - 2024-07-15
+
+* Add `message` to `Reaymade::UnSuccessError` exception
+
 ## [0.4.0] - 2024-02-23
 
 * Add `Reaymade::Model::ValidatableEnum` to validate enum values

data/Gemfile.lock

@@ -1,42 +1,45 @@
 PATH
   remote: .
   specs:
-    readymade (0.4.0)
+    readymade (0.4.2)
       activejob
       activemodel
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (7.1.3)
-      activesupport (= 7.1.3)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
       globalid (>= 0.3.6)
-    activemodel (7.1.3)
-      activesupport (= 7.1.3)
-    activesupport (7.1.3)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activesupport (8.0.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     byebug (11.1.3)
-    concurrent-ruby (1.2.3)
-    connection_pool (2.4.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
     diff-lcs (1.4.4)
-    drb (2.2.0)
-      ruby2_keywords
+    drb (2.2.3)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    i18n (1.14.1)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    minitest (5.22.1)
-    mutex_m (0.2.0)
+    logger (1.7.0)
+    minitest (5.25.5)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -51,9 +54,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    ruby2_keywords (0.0.5)
+    securerandom (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.0.3)
 
 PLATFORMS
   ruby

data/README.md

@@ -146,7 +146,10 @@ 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'
+Orders::Actions::SendNotifications.call_async!(order: order, job_options: { queue_as: :my_queue, discard_on: ActiveJob::DeserializationError})
+```
+
+```ruby
 # Important! Make sure your sidekiq configuration has 'my_queue' queue
 ```
 

data/lib/readymade/action.rb

@@ -17,7 +17,7 @@ module Readymade
       new(*args, &block).call!.then do |res|
         return res if res.try(:success?) || res.try(:consider_success?)
 
-        raise UnSuccessError
+        raise UnSuccessError.new(res.humanized_errors)
       end
     end
 

data/lib/readymade/background_bang_job.rb

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

data/lib/readymade/background_job.rb

@@ -4,10 +4,39 @@ require 'active_job' unless defined?(::ActiveJob)
 
 module Readymade
   class BackgroundJob < ::ActiveJob::Base
-    queue_as { self.arguments[0].fetch(:queue_as, :default) }
+    queue_as do
+      if (q = self.arguments[0][:queue_as]).present?
+        logger.warn "DEPRECATED: `queue_as` is deprecated. Use `job_options.queue_as` instead."
+      end
+
+      self.arguments[0].dig(:job_options, :queue_as).presence || q || 'default'
+    end
+    rescue_from StandardError, with: :handle_rescue_from
 
     def perform(**args)
       args.delete(:class_name).to_s.constantize.send(:call, **args)
     end
+
+    private
+
+    def handle_rescue_from(exception)
+      raise exception if job_options.blank? || job_options['discard_on'].blank?
+
+      discard_on = job_options['discard_on'].map { |d| d['value'] }
+
+      if discard_on.include?(exception.class.name)
+        logger.warn "Discarding job due to deserialization error: #{exception.message}"
+        # Discard the job without raising an error
+      else
+        logger.error "Job failed with deserialization error: #{exception.message}"
+        raise exception
+      end
+    end
+
+    private
+
+    def job_options
+      @job_options ||= self.instance_variable_get('@serialized_arguments')[0]['job_options'] || {}
+    end
   end
 end

data/lib/readymade/controller/serialization.rb

@@ -55,7 +55,7 @@ module Readymade
                               end,
                               :ok
                             ]
-                          when :validation_fail, :bad_request
+                          when :validation_fail, :bad_request, :fail
                             [{ errors: response_obj.data[:errors] }, :bad_request]
                           else
                             [response_obj.status.to_sym, {}]

data/lib/readymade/model/validatable_enum.rb

@@ -0,0 +1,32 @@
+require 'active_support/concern'
+
+module Readymade
+  module Model
+    module ValidatableEnum
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def validatable_enum(*enums_to_fix)
+          enums_to_fix.each do |enum_name|
+            define_method(:"#{enum_name}=") do |value|
+              super(value)
+            rescue StandardError
+              instance_variable_set(:"@__bad_#{enum_name}", value)
+              super(nil)
+            end
+
+            validates enum_name, inclusion: {
+              in: send(enum_name.to_s.pluralize).keys,
+              message: lambda { |record, error|
+                val = record.instance_variable_get(:"@__bad_#{enum_name}")
+                return "#{error[:attribute]} is required" if val.nil?
+
+                "#{val.inspect} is not a valid #{error[:attribute]}"
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/readymade/response.rb

@@ -28,9 +28,23 @@ module Readymade
     end
 
     def errors
+      return {} unless args.is_a?(Hash)
+
       args[:errors].presence || {}
     end
 
+    def humanized_errors
+      humanize_errors(errors)
+    end
+
+    def humanize_errors(errors)
+      if errors.is_a?(ActiveModel::Errors)
+        errors.full_messages.join('. ')
+      else
+        errors.map { |k, values| "#{k.to_s.humanize}: #{values.join(', ')}" }.join('. ')
+      end
+    end
+
     def consider_success?
       @consider_success
     end

data/lib/readymade/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readymade
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - OrestF
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2025-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -99,6 +99,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/.DS_Store
 - lib/readymade.rb
 - lib/readymade/action.rb
 - lib/readymade/background_bang_job.rb
@@ -108,6 +109,7 @@ files:
 - lib/readymade/instant_form.rb
 - lib/readymade/model/api_attachable.rb
 - lib/readymade/model/filterable.rb
+- lib/readymade/model/validatable_enum.rb
 - lib/readymade/operation.rb
 - lib/readymade/response.rb
 - lib/readymade/version.rb
@@ -134,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Set of base classes for ABDI architecture