iry 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e4fc1d3dfa1e63a0ac7c38443301f2635ac7d60866d5799a1a6a78b5cdb9326
-  data.tar.gz: 7b4a3e8b2118dfb0788f15579e61ca35b1e32277cd571fb53e83c2905e23cc49
+  metadata.gz: 5ca6d5b931545ba2bb0b9f1e9e7ad77da308e7d0ffe8a64d1df2c1e6378cd1a7
+  data.tar.gz: 4747d18e4a249735907597277bad301e9177dffa5aa00e3410355be13d523683
 SHA512:
-  metadata.gz: 27cc273db8893f605a6d3480305a0e575f214a4c88562a701b0ba1b00b4a98b004735f7f776428b246722c0a26706ba2681405028f0454658085cf562e94fd7b
-  data.tar.gz: 01b82838cf8c8e02432fe038086fa3a96db7ff83a128e5e3ac1aacc5524e2e9a76c908f0af72e85eac19bbed6ccc0972718ba9f49e69ab5d81775fc508a946e6
+  metadata.gz: c2b72c6a64b044c606b3940181971a28fd90fdb1ba7859566adb9f5b7ac17f58aa46544908d06715dbc15105972ee0b272ac65d608dd06ee42fd829799c3ff95
+  data.tar.gz: 2f5c703a19785a8e7fc5689354c80b91d3d3658f00a031edbddad7ca06c36094959f494bbc157c8b40bce4fd3655fd37fa5769ec1fc02e6b7c74524118ebc37b

data/.yardopts

@@ -1 +1 @@
---no-private 'lib/**/*.rb' - 'README.md' 'CHANGELOG.md' VERSION LICENSE '.envrc.example' Gemfile 'Gemfile.lock' 'db/schema.pgsql' 'iry.gemspec'
+--no-private 'lib/**/*.rb' - 'README.md' VERSION LICENSE '.envrc.example' Gemfile 'Gemfile.lock' 'db/schema.pgsql' 'iry.gemspec'

data/README.md

@@ -39,6 +39,7 @@ Now one of the saving mechanisms can be used:
 - [`handle_constraints`](#handle_constraints)
 - [`save`](#save)
 - [`save!`](#save!)
+- [`destroy`](#destroy)
 
 When saving a new `User` record or updating it, in case constraint exceptions are raised, these will be rescued and
 validation errors will be applied to the record, like in the following example:
@@ -139,6 +140,12 @@ errors will be added to `errors`.
 Acts the same as `ActiveRecord::Base#save!`, accepting the same arguments and returning the same values.
 In addition, it will raise `Iry::ConstraintViolation` when constraint violations are detected.
 
+### [`destroy`](https://rubydoc.info/gems/iry/Iry.destroy)
+
+Acts the same as `ActiveRecord::Base#destroy`.
+In addition, it will return `false` if a constraint violation of the tracked constraints is detected and validation
+errors will be added to `errors`.
+
 ## Limitations
 
 - `valid?` will not check for constraints. If calling `valid?` right after a `save` operation, keep in mind `errors`

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.1

data/lib/iry/handlers/pg.rb

@@ -13,7 +13,7 @@ module Iry
           exclusion\sconstraint|
           foreign\skey\sconstraint
         )
-        \s"(.+)"
+        \s"([^"]+)"
       }x
 
       # When true, the handler is able to handle this exception, representing a constraint error in PostgreSQL.

data/lib/iry/patch.rb

@@ -0,0 +1,13 @@
+module Iry
+  # Overrides private API method {ActiveRecord#create_or_update} to handle
+  # constraints and attach errors to the including model
+  module Patch
+    # Takes attributes as named arguments
+    # @return [Boolean] true if successful
+    def create_or_update(...)
+      result = false
+      Iry.handle_constraints!(self) { result = super }
+      result
+    end
+  end
+end

data/lib/iry.rb

@@ -11,6 +11,7 @@ require_relative "iry/constraint/check"
 require_relative "iry/constraint/exclusion"
 require_relative "iry/constraint/foreign_key"
 require_relative "iry/constraint/unique"
+require_relative "iry/patch"
 
 # Entrypoint of constraint validation, include in a class inheriting {ActiveRecord::Base} and the following class-level
 # methods will be available:
@@ -49,6 +50,10 @@ module Iry
     #   @return [Handlers::Model]
   end
 
+  class StatementInvalid < ActiveRecord::StatementInvalid
+    include Error
+  end
+
   # @param klass [Module]
   # @return [void]
   # @private
@@ -58,6 +63,7 @@ module Iry
       class_attribute(:constraints)
       self.constraints = {}
       extend(Iry::Macros)
+      include(Iry::Patch)
     end
   end
 
@@ -82,6 +88,18 @@ module Iry
   #   result #=> nil
   #   fail_user.errors.details.fetch(:email) #=> [{error: :taken}]
   def self.handle_constraints(model, &block)
+    handle_constraints!(model, &block)
+  rescue StatementInvalid
+    return nil
+  end
+
+  # Executes block and in case of constraints violations on `model`, block is
+  # halted, errors are appended to `model` and {StatementInvalid} is raised
+  # @param model [Handlers::Model] model object for which constraints should be
+  #   monitored and for which errors should be added to
+  # @yield block must perform the save operation, usually with `save`
+  # @return [Handlers::Model] returns `model` parameter
+  def self.handle_constraints!(model, &block)
     raise ArgumentError, "Block required" if block.nil?
 
     block.()
@@ -101,7 +119,7 @@ module Iry
       raise
     end
 
-    return nil
+    raise StatementInvalid.new(err.message, sql: err.sql, binds: err.binds)
   end
 
   # Similar to {ActiveRecord::Base#save} but in case of constraint violations,
@@ -141,4 +159,18 @@ module Iry
 
     raise ConstraintViolation.new(model)
   end
+
+  # Similar to {ActiveRecord::Base#destroy} but in case of constraint
+  # violations, `false` is returned and `errors` are populated.
+  # @param model [Handlers::Model] model to destroy
+  # @return [Handlers::Model] the destroyed model
+  def self.destroy(model)
+    constraint_result = handle_constraints(model) { model.destroy }
+
+    if constraint_result.nil?
+      return false
+    end
+
+    return constraint_result
+  end
 end

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "iry",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "iry",
-      "version": "0.4.0",
+      "version": "0.5.1",
       "license": "MIT",
       "devDependencies": {
         "conventional-changelog-cli": ">= 3.0.0",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iry",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "description": "Transform database constraint errors into activerecord validation errors",
   "private": true,
   "main": "index.js",

data/rbi/iry.rbi

@@ -57,6 +57,15 @@ module Iry
   sig { params(model: Handlers::Model, block: T.untyped).void }
   def self.handle_constraints(model, &block); end
 
+  # Executes block and in case of constraints violations on `model`, block is
+  # halted, errors are appended to `model` and {StatementInvalid} is raised
+  # 
+  # _@param_ `model` — model object for which constraints should be monitored and for which errors should be added to
+  # 
+  # _@return_ — returns `model` parameter
+  sig { params(model: Handlers::Model, block: T.untyped).returns(Handlers::Model) }
+  def self.handle_constraints!(model, &block); end
+
   # Similar to {ActiveRecord::Base#save} but in case of constraint violations,
   # `false` is returned and `errors` are populated.
   # Aside from `model`, it takes the same arguments as
@@ -77,6 +86,15 @@ module Iry
   sig { params(model: Handlers::Model).returns(T::Boolean) }
   def self.save!(model); end
 
+  # Similar to {ActiveRecord::Base#destroy} but in case of constraint
+  # violations, `false` is returned and `errors` are populated.
+  # 
+  # _@param_ `model` — model to destroy
+  # 
+  # _@return_ — the destroyed model
+  sig { params(model: Handlers::Model).returns(Handlers::Model) }
+  def self.destroy(model); end
+
   # Included in all exceptions triggered by Iry, this allows to rescue any
   # gem-related exception by rescuing {Iry::Error}
   module Error
@@ -88,6 +106,20 @@ module Iry
     include Iry::Error
   end
 
+  class StatementInvalid < ActiveRecord::StatementInvalid
+    include Iry::Error
+  end
+
+  # Overrides private API method {ActiveRecord#create_or_update} to handle
+  # constraints and attach errors to the including model
+  module Patch
+    # Takes attributes as named arguments
+    # 
+    # _@return_ — true if successful
+    sig { returns(T::Boolean) }
+    def create_or_update; end
+  end
+
   # Class-level methods available to classes executing `include Iry`
   module Macros
     # Constraints by name
@@ -207,7 +239,7 @@ module Iry
     exclusion\sconstraint|
     foreign\skey\sconstraint
   )
-  \s"(.+)"
+  \s"([^"]+)"
 }x, T.untyped)
 
       # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project

data/sig/iry.rbs

@@ -53,6 +53,14 @@ module Iry
   # ```
   def self.handle_constraints: (Handlers::Model model) -> void
 
+  # Executes block and in case of constraints violations on `model`, block is
+  # halted, errors are appended to `model` and {StatementInvalid} is raised
+  # 
+  # _@param_ `model` — model object for which constraints should be monitored and for which errors should be added to
+  # 
+  # _@return_ — returns `model` parameter
+  def self.handle_constraints!: (Handlers::Model model) -> Handlers::Model
+
   # Similar to {ActiveRecord::Base#save} but in case of constraint violations,
   # `false` is returned and `errors` are populated.
   # Aside from `model`, it takes the same arguments as
@@ -71,6 +79,14 @@ module Iry
   # _@param_ `model` — model to save
   def self.save!: (Handlers::Model model) -> bool
 
+  # Similar to {ActiveRecord::Base#destroy} but in case of constraint
+  # violations, `false` is returned and `errors` are populated.
+  # 
+  # _@param_ `model` — model to destroy
+  # 
+  # _@return_ — the destroyed model
+  def self.destroy: (Handlers::Model model) -> Handlers::Model
+
   # Included in all exceptions triggered by Iry, this allows to rescue any
   # gem-related exception by rescuing {Iry::Error}
   module Error
@@ -82,6 +98,19 @@ module Iry
     include Iry::Error
   end
 
+  class StatementInvalid < ActiveRecord::StatementInvalid
+    include Iry::Error
+  end
+
+  # Overrides private API method {ActiveRecord#create_or_update} to handle
+  # constraints and attach errors to the including model
+  module Patch
+    # Takes attributes as named arguments
+    # 
+    # _@return_ — true if successful
+    def create_or_update: () -> bool
+  end
+
   # Class-level methods available to classes executing `include Iry`
   module Macros
     # Constraints by name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iry
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Francesco Belladonna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-09 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -89,7 +89,6 @@ extra_rdoc_files: []
 files:
 - ".envrc.example"
 - ".yardopts"
-- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile
@@ -107,6 +106,7 @@ files:
 - lib/iry/handlers/null.rb
 - lib/iry/handlers/pg.rb
 - lib/iry/macros.rb
+- lib/iry/patch.rb
 - lib/iry/version.rb
 - package-lock.json
 - package.json
@@ -122,7 +122,6 @@ metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/Fire-Dragon-DoL/iry
   source_code_uri: https://github.com/Fire-Dragon-DoL/iry
-  changelog_uri: https://github.com/Fire-Dragon-DoL/iry/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/CHANGELOG.md

@@ -1,15 +0,0 @@
-# [0.2.0](https://github.com/Fire-Dragon-DoL/iry/compare/8a133c2c19b99881619a9e1c7c11076030755f66...v0.2.0) (2023-07-08)
-
-
-### Features
-
-* **constraints:** check constraint is present ([d0cc380](https://github.com/Fire-Dragon-DoL/iry/commit/d0cc3803fdcda45df964f6431890f8831d3641e5))
-* **constraints:** exclusion constraint is present ([1894e85](https://github.com/Fire-Dragon-DoL/iry/commit/1894e85bfa11e272be9b5f0f8efc170f7ce57a48))
-* **constraints:** foreign key constraint is present ([e637b06](https://github.com/Fire-Dragon-DoL/iry/commit/e637b0603bb6fd34e2732426544fc31904bb5409))
-* **deps:** dependency surface is reduced ([2dfc595](https://github.com/Fire-Dragon-DoL/iry/commit/2dfc595ebd221aedb072398e1ace8460208d06ac))
-* **project:** setup ([8a133c2](https://github.com/Fire-Dragon-DoL/iry/commit/8a133c2c19b99881619a9e1c7c11076030755f66))
-* **ruby:** version is forced to >= 2.7 ([9b20ed8](https://github.com/Fire-Dragon-DoL/iry/commit/9b20ed8ec0ae2a9906bdefe28cf674d4700f4d67))
-* **unique-constraint:** test is implemented ([c4266b9](https://github.com/Fire-Dragon-DoL/iry/commit/c4266b910757b6adef18db41dfa5dfd9353c1037))
-
-
-