readymade 0.4.2 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9a882e1827fc02ccf9591bd9b553a3125400b613896043759e8d6b67583f1a6
-  data.tar.gz: 6cd288e19b31eaf1584da299a72b8ba80dd9bf5eb89f8f8adeac0b161d68ff7b
+  metadata.gz: 7b3d5fedc87f2028115618494f4b1e4af9cb79fe9f82f7059bb9bb4d1705b3da
+  data.tar.gz: 841cbdc4364c34a52706011db59158a041a5edd575db5083133b1eb2faffb6ee
 SHA512:
-  metadata.gz: 18db5112a9b9d07f7a344fa9213cac219ffc99c82d6c74fa645839c9c3e25f1402c29d4d05aacf8baaafd2d67cde6d6e748708f73a486625b375ab32bad25db7
-  data.tar.gz: bca496b18a8a38f5d1298aa379f11a6ff713fcb59d44ad34a31a753b518569186734c08032f94be8c407dd75dfd4e9c3709cc7b73d82fb969912515cfc4813d5
+  metadata.gz: 6251e1a6304385b8bdd5d421d300c4d92ff24d21d374b18430938f6ebbf65c59cef58d3709da984b3f3e71945cb13fc6e6cedd0fa7235083d70e20dfb6cef095
+  data.tar.gz: 2bbdb741c5b1bef74ad7e56efb946cf24675b25a17490fcee416ec7f49bd8ee4fdf3f601f9d44d345f1ad55f452f929114ff2df2d80aa34cfe299e162dab6cdb

data/.gitignore

@@ -6,7 +6,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea/
+.byebug_history
 
 # rspec failure tracking
 .rspec_status
 spec/.DS_Store
+

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 All notable changes to this project will be documented in this file.
 
+
+## [0.4.4] - 2025-09-22
+
+* Add initializer generator
+* Add `ActiveJob::Uniqueness` support
+
+## [0.4.3] - 2025-07-31
+
+* Remove job_options.discard_on` argument to `Readymade::BackgroundJob` to discard job on specific exceptions due to incorrect behaviour on different Rails versions
+
 ## [0.4.2] - 2025-05-26
 
 * Add `job_options.discard_on` argument to `Readymade::BackgroundJob` to discard job on specific exceptions

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    readymade (0.4.2)
+    readymade (0.4.4)
       activejob
       activemodel
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (8.0.2)
-      activesupport (= 8.0.2)
+    activejob (8.0.2.1)
+      activesupport (= 8.0.2.1)
       globalid (>= 0.3.6)
-    activemodel (8.0.2)
-      activesupport (= 8.0.2)
-    activesupport (8.0.2)
+    activemodel (8.0.2.1)
+      activesupport (= 8.0.2.1)
+    activesupport (8.0.2.1)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -26,12 +26,12 @@ GEM
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.3)
     byebug (11.1.3)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.3)
+    connection_pool (2.5.4)
     diff-lcs (1.4.4)
     drb (2.2.3)
     globalid (1.2.1)

data/README.md

@@ -6,6 +6,7 @@ This gems contains basic components to follow [ABDI architecture](https://github
 
 ### Tested with ruby:
 
+- 3.3
 - 3.1
 - 3.0
 - 2.7
@@ -35,6 +36,8 @@ Inherit your components from:
 * `Readymade::Action`
 * `Readymade::Operation`
 
+---
+
 ### Readymade::Response
 
 ```ruby
@@ -47,6 +50,8 @@ response.status # 'fail'
 response.data # { errors: { some: 'errors' } }
 ```
 
+---
+
 ### Readymade::Form
 
 Check more form features examples in `lib/readymade/form.rb`
@@ -73,7 +78,7 @@ order_form.valid? # true
 class MyForm < Readymade::Form
   PERMITTED_ATTRIBUTES = %i[email name category country]
   REQUIRED_ATTRIBUTES = %i[email]
-  
+
   def form_options
     {
       categories: args[:company].categories,
@@ -100,6 +105,8 @@ end
 = f.text_field :name, required: @form.required?(:name) # false
 ```
 
+---
+
 ### Readymade::InstantForm
 
 Permit params and validates presence inline
@@ -108,6 +115,8 @@ Permit params and validates presence inline
 Readymade::InstantForm.new(my_params, permitted: %i[name phone], required: %i[email]) # permits: name, phone, email; validates on presence: email
 ```
 
+---
+
 ### Readymade::Action
 
 ```ruby
@@ -146,7 +155,7 @@ class Orders::Actions::SendNotifications < Readymade::Action
 end
 
 Orders::Actions::SendNotifications.call_async(order: order)
-Orders::Actions::SendNotifications.call_async!(order: order, job_options: { queue_as: :my_queue, discard_on: ActiveJob::DeserializationError})
+Orders::Actions::SendNotifications.call_async!(order: order, job_options: { queue_as: :my_queue })
 ```
 
 ```ruby
@@ -210,6 +219,53 @@ Orders::Actions::SendNotifications.call_async!(order: order) # job will be faile
 
 ```
 
+
+---
+
+### Locking Duplicate Jobs (triggered by `call_async`)
+
+To enable job locking, first generate the initializer:
+
+```bash
+rails generate readymade:install
+```
+
+Add `gem 'activejob-uniqueness', '~> 0.4.0'` to your Gemfile. (not included by default to reduce dependencies)
+
+Then follow the instructions inside the generated file.
+
+
+
+####  Default behavior
+
+* All `call_async` actions run in the `:default` queue.
+* By default, you can configure Readymade to **lock all jobs in `:default`** so that duplicate jobs won’t be enqueued.
+
+
+#### Customizing which jobs are locked
+
+You have two main strategies:
+
+1. **Use `job_options` in your call**
+   If you don’t want a job to be locked, run it in a different queue:
+
+   ```ruby
+   MyAction.call_async(user_id: 42, job_options: { queue_as: :critical })
+   ```
+
+2. **Configure specific queues to lock**
+   In your initializer, define which queues should enforce locking:
+
+   ```ruby
+   Readymade.configure do |config|
+     config.lock_jobs = true
+     config.locked_queues = [:mailers, :anatytics] # only these queues will lock duplicates
+   end
+   ```
+
+---
+
+
 ### Readymade::Operation
 
 Provides set of help methods like: `build_form`, `form_valid?`, `validation_fail`, `save_record`, etc.
@@ -230,6 +286,8 @@ class Orders::Operations::Create < Readymade::Operation
 end
 ```
 
+---
+
 ### Readymade::Controller::Serialization
 
 ```ruby
@@ -244,6 +302,8 @@ Dependencies that must be installed on your own:
 - [pagy](https://rubygems.org/gems/pagy)
 - [api-pagination](https://rubygems.org/gems/api-pagination)
 
+---
+
 ### Readymade::Model::ApiAttachable
 
 Add base64 attachments format for your models
@@ -274,12 +334,14 @@ let(:avatar) { Rack::Test::UploadedFile.new(Rails.root.join('spec/support/assets
 let(:params) { { user: attributes_for(:user).merge!(avatar: to_api_file(avatar)) } }
 ```
 
+---
+
 ### Readymade::Model::Filterable
 
 ```ruby
 class User < ApplicationRecord
   include Readyamde::Model::Filterable
-  
+
   scope :by_status, ->(status) { where(status: status) }
   scope :by_role, ->(role) { where(role: role) }
 end
@@ -290,6 +352,8 @@ User.all.filter_collection({ by_status: 'active', by_role: 'manager' })
 User.all.filter_collection({ by_status: 'active', by_role: 'manager' }, chain_with: :or) # active OR manager
 ```
 
+---
+
 ### Readymade::Model::ValidatableEnum
 
 Instead of raised error when enum value is not valid, it adds error to the record
@@ -310,6 +374,8 @@ user.validate # false
 user.errors.full_messages  # ["Role 'superadmin' is not a valid role", "Status 'archived' is not a valid status"]
 ```
 
+---
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/generators/readymade/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+  module Readymade
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc 'Copy Readymade default files'
+        source_root File.expand_path('templates', __dir__)
+
+        def copy_config
+          template 'config/initializers/readymade.rb'
+        end
+      end
+    end
+  end

data/lib/generators/readymade/templates/config/initializers/readymade.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Readymade.configure do |config|
+  # Change to true to enable job locking
+  config.lock_jobs = false
+
+  # Define lock strategy
+  # Strategy	                    The job is locked	              The job is unlocked
+  #
+  # until_executing	              when pushed to the queue      	when processing starts
+  # until_executed	              when pushed to the queue      	when the job is processed successfully
+  # until_expired	                when pushed to the queue      	when the lock is expired
+  # until_and_while_executing	    when pushed to the queue      	when processing starts a runtime lock is acquired to prevent simultaneous jobs
+  # while_executing	              when processing starts        	when the job is processed with any result including an error
+
+  # config.lock_type = :until_executed
+
+  # new jobs with the same args will be logged within 1.day or until existing one is being executing
+  # config.lock_ttl = 1.day
+
+  # Array of queues to apply job locking to
+  # config.locked_queues = [:default]
+end

data/lib/readymade/background_bang_job.rb

@@ -4,8 +4,12 @@ require 'active_job' unless defined?(::ActiveJob)
 
 module Readymade
   class BackgroundBangJob < ::Readymade::BackgroundJob
-    def perform(**args)
-      args.delete(:class_name).to_s.constantize.send(:call!, **args)
+    queue_as { self.arguments[0].dig(:queue_as) || self.arguments[0].dig(:job_options, :queue_as) || :default }
+
+    private
+
+    def callable_method
+      :call!
     end
   end
-end
+end

data/lib/readymade/background_job.rb

@@ -4,39 +4,60 @@ require 'active_job' unless defined?(::ActiveJob)
 
 module Readymade
   class BackgroundJob < ::ActiveJob::Base
-    queue_as do
-      if (q = self.arguments[0][:queue_as]).present?
-        logger.warn "DEPRECATED: `queue_as` is deprecated. Use `job_options.queue_as` instead."
+    queue_as { self.arguments[0].dig(:queue_as) || self.arguments[0].dig(:job_options, :queue_as) || :default }
+
+    class << self
+      def apply_uniqueness!
+        return unless Readymade.config&.lock_jobs?
+
+        begin
+          require "active_job/uniqueness"
+
+          unique Readymade.config.lock_type,
+                 lock_ttl: Readymade.config.lock_ttl,
+                 on_conflict: ->(job) { handle_duplication(job) }
+        rescue LoadError
+          warn uniqueness_not_loaded_warning
+        end
       end
 
-      self.arguments[0].dig(:job_options, :queue_as).presence || q || 'default'
-    end
-    rescue_from StandardError, with: :handle_rescue_from
+      def handle_duplication(job)
+        return if Readymade.config.locked_queues.include?(job.queue_name.to_sym)
 
-    def perform(**args)
-      args.delete(:class_name).to_s.constantize.send(:call, **args)
-    end
+        ActiveJob::Uniqueness.unlock!(job_class_name: job.class.name)
+      end
 
-    private
+      def uniqueness_not_loaded_warning
+        <<~MSG
+
+          ======== READYMADE WARNING ========
 
-    def handle_rescue_from(exception)
-      raise exception if job_options.blank? || job_options['discard_on'].blank?
+          The `activejob-uniqueness` gem is not installed, but `lock_jobs` is enabled.
+          Please add the following to your Gemfile:
 
-      discard_on = job_options['discard_on'].map { |d| d['value'] }
+              gem "activejob-uniqueness", "~> 0.4.0"
 
-      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
+          ===================================
+
+        MSG
       end
+
+    end
+
+    def perform(**args)
+      args.delete(:class_name).to_s.constantize.send(callable_method, **args)
     end
 
     private
 
-    def job_options
-      @job_options ||= self.instance_variable_get('@serialized_arguments')[0]['job_options'] || {}
+    def callable_method
+      :call
     end
   end
 end
+
+if defined?(::ActiveSupport)
+  ActiveSupport.on_load(:after_initialize) do
+    Readymade::BackgroundJob.apply_uniqueness!
+  end
+end

data/lib/readymade/version.rb

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

data/lib/readymade.rb

@@ -14,5 +14,56 @@ require 'readymade/version'
 
 module Readymade
   class Error < StandardError; end
-  # Your code goes here...
+
+  class << self
+    attr_accessor :config
+
+    def configure
+      self.config ||= Config.new
+      yield(config)
+    end
+  end
+
+  class Config
+    attr_reader :lock_jobs, :lock_type, :lock_ttl, :locked_queues
+
+    ALLOWED_LOCK_TYPES = %i[until_executing until_executed until_expired until_and_while_executing while_executing].freeze
+
+    def initialize
+      @lock_jobs = false
+      @lock_type = :until_executed
+      @lock_ttl = 1.days
+      @locked_queues = [:default]
+    end
+
+    def lock_jobs=(bool)
+      raise ArgumentError, 'Lock jobs must be a boolean' unless [TrueClass, FalseClass, NilClass].include?(bool.class)
+
+      @lock_jobs = bool
+    end
+
+    def lock_type=(lock_type)
+      raise ArgumentError, 'Lock type must be a symbol' unless lock_type.is_a?(Symbol)
+      raise ArgumentError, "Lock type must be one of: #{ALLOWED_LOCK_TYPES}" unless ALLOWED_LOCK_TYPES.include?(lock_type)
+
+      @lock_type = lock_type
+    end
+
+    def lock_ttl=(ttl)
+      raise ArgumentError, 'Lock ttl must be an integer' unless ttl.is_a?(Integer)
+
+      @lock_ttl = ttl
+    end
+
+    def locked_queues=(queues)
+      raise ArgumentError, 'Locked queues must be an array' unless queues.is_a?(Array)
+
+      @locked_queues = queues
+    end
+
+    def lock_jobs?
+      lock_jobs
+    end
+  end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readymade
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.4
 platform: ruby
 authors:
 - OrestF
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-26 00:00:00.000000000 Z
+date: 2025-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -99,7 +99,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/.DS_Store
+- lib/generators/readymade/install_generator.rb
+- lib/generators/readymade/templates/config/initializers/readymade.rb
 - lib/readymade.rb
 - lib/readymade/action.rb
 - lib/readymade/background_bang_job.rb