readymade 0.3.9 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37150c92279da3c7ecb29441fccbf188572039fe69712cf99824121c8ebeb889
-  data.tar.gz: f94ab00a9af6b37097958c1a386932f8667e7e37ea55ec30530a2e92a423738d
+  metadata.gz: 8f3a8c90117d3207e0e228fdc410d1799955f07bacd3753ab4b721916bd9c6a3
+  data.tar.gz: 53c6a9b974ab6b3a70d7df5ad60031855bb1228d9a53b1b7f8915b9c28a9df24
 SHA512:
-  metadata.gz: b7b562dd8614ca64c8821d71c89ecff73c9556d8c8b5ea4ed95046ba8841354e193ae5e6d61ce05e673cdf8c8ef3946322165761862ca1aee7d8cdc44ecc6b99
-  data.tar.gz: 2608dd0e7def9ea166ec4c0edb391a748d02602e4c8a2e6fd3f0a536397fae5c0e286330fdd07901196f4316bdcf578630f14c5ff985e32896fee35a8f284cb1
+  metadata.gz: c0907befa7f6054fab2c7cbb899741fd02c4c357f2cf959c248af99c06b78666462dbb22a5aca201f0761471624847ada443187c1520c803243e0a75c38ec458
+  data.tar.gz: 0cc7164cab6a23ef602a283ff27cd0bcc68a4c7053fa0469b52e499cbdf5ca0d5106dc1b6bd64ba79539b3862bd80c84a18763937e8feb1d2ea9ebc99dbafcfd

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 All notable changes to this project will be documented in this file.
 
+## [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
+
 ## [0.3.9] - 2024-01-04
 
 * Update `Readymade::Model::Filterable` to support and/or joins

data/Gemfile.lock

@@ -1,31 +1,42 @@
 PATH
   remote: .
   specs:
-    readymade (0.3.9)
+    readymade (0.4.1)
       activejob
       activemodel
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (7.0.8)
-      activesupport (= 7.0.8)
+    activejob (7.1.3)
+      activesupport (= 7.1.3)
       globalid (>= 0.3.6)
-    activemodel (7.0.8)
-      activesupport (= 7.0.8)
-    activesupport (7.0.8)
+    activemodel (7.1.3)
+      activesupport (= 7.1.3)
+    activesupport (7.1.3)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
     byebug (11.1.3)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
     diff-lcs (1.4.4)
+    drb (2.2.0)
+      ruby2_keywords
     globalid (1.2.1)
       activesupport (>= 6.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    minitest (5.20.0)
+    minitest (5.22.1)
+    mutex_m (0.2.0)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -40,6 +51,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
+    ruby2_keywords (0.0.5)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
 

data/README.md

@@ -287,6 +287,26 @@ 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
+
+```ruby
+class User < ApplicationRecord
+  include Readymade::Model::ValidatableEnum
+
+  enum status: { inactive: 0, active: 10 }
+  enum role: { customer: 0, admin: 10 }
+  validatable_enum :status, :role
+end
+```
+
+```ruby
+user = User.new(status: 'archived', role: 'superadmin')
+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/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/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/filterable.rb

@@ -2,8 +2,6 @@ require 'active_support/concern'
 
 module Readymade
   module Model
-    # frozen_string_literal: true
-
     module Filterable
       extend ActiveSupport::Concern
 

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.3.9'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readymade
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.1
 platform: ruby
 authors:
 - OrestF
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -108,6 +108,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