iry 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f0f9f174fd7d9539076fe6c50be05824c8055cd3a37cdfbfd8444be73227742
-  data.tar.gz: 7be7e62f6e803ba1179e0b074dbdf9f4b9f69fcfde189b291d2aaf9a94dc5a12
+  metadata.gz: 9042962f657c4d8500afe884c991d739d3242260886af48f2b44cd2a5404465c
+  data.tar.gz: 991b8d4fe5745a532f9dd8dcd84a3474b731b17f933c2eceda81c3cdad9f1d17
 SHA512:
-  metadata.gz: 9f5790093d7a9ff0d5268ed03921817c45927d5e4741c3ccd741e4fcae94f5173deff1454967627e34a61b177420a3989568776bfe962c47654e97a663054590
-  data.tar.gz: 44a571a3c63cd105bf3c0f3d8866247c91c064c1b1558a1028dbfca5617e0b210a64d621574c290f98213e7c2ba011cdfc500d2e78e389c9cd43b757a4b419d7
+  metadata.gz: 921c64359cfb033b4b218c0e686286e1dc7af58381915a6eba6921ca2d724d49ae3ec6e1942100137e3cc8e677f06a7d8fd000a1c9e998457a68a319e9a98e63
+  data.tar.gz: 344f1ad7142f2e53c5b331fdfb027f27e2507c51ea15567ae38bd1bd359988990f318cca95f919c7b5459985c0b4b01c196b2affaee3094796aa98e9f0fddb2b

data/.envrc.example

@@ -4,3 +4,4 @@ export PGDATABASE=iry_development
 export PGHOST=localhost
 export PGPORT=5432
 export PGUSER=postgres
+export PATH="$PWD/exe:$PATH"

data/README.md

@@ -58,10 +58,23 @@ Multiple constraints of the same or different types can be present on the model,
 
 The following constraint types are available:
 
-- [`check_constraint`](#check_constraint)
-- [`exclusion_constraint`](#exclusion_constraint)
-- [`foreign_key_constraint`](#foreign_key_constraint)
-- [`unique_constraint`](#unique_constraint)
+- [Iry](#iry)
+  - [Documentation](#documentation)
+  - [Usage](#usage)
+  - [Constraints](#constraints)
+    - [`check_constraint`](#check_constraint)
+    - [`exclusion_constraint`](#exclusion_constraint)
+    - [`foreign_key_constraint`](#foreign_key_constraint)
+    - [`unique_constraint`](#unique_constraint)
+  - [Advanced Usage](#advanced-usage)
+    - [`handle_constraints!`](#handle_constraints)
+    - [`save`](#save)
+    - [`save!`](#save-1)
+    - [`destroy`](#destroy)
+  - [Limitations](#limitations)
+  - [Installation](#installation)
+  - [Development](#development)
+  - [Contributing](#contributing)
 
 The class method `.constraints` is also available, that returns all the constraints applied to a model.
 
@@ -153,7 +166,8 @@ errors will be added to `errors`.
 - It is recommended to avoid transactions when using `Iry`, because if a violation is detected, anything after
     `Iry.save/save!/handle_constraints` will result in `ActiveRecord::StatementInvalid`, since the transaction is
     aborted
-- Currently only PostgreSQL is supported with the `pg` gem, but it should be simple to add support for other databases.
+- Currently PostgreSQL and SQLite are supported with the `pg` and `sqlite3` gem
+- SQLite support is limited to unique constraints and check constraints, with no support for the `name` field on the unique constraints
 
 ## Installation
 
@@ -169,7 +183,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 **Requirements:**
 - PostgreSQL with `psql`, `createdb`, `dropdb`
-- NodeJS 18 with `npm`
+- Sqlite3
+- NodeJS 22 with `npm`
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/Rakefile

@@ -3,12 +3,26 @@ require "bundler/setup"
 require "bundler/gem_tasks"
 require "minitest/test_task"
 
-Minitest::TestTask.create(:test) do |t|
-  t.libs << "test"
+# Minitest::TestTask.create(:test) do |t|
+#   t.libs << "test"
+#   t.libs << "lib"
+#   t.test_prelude = "require \"test/test_helper\""
+#   t.warning = false
+#   t.test_globs = ["test/**/*_test.rb"]
+# end
+Minitest::TestTask.create(:"test:pg") do |t|
+  t.libs << "test/pg"
   t.libs << "lib"
-  t.test_prelude = "require \"test/test_helper\""
+  t.test_prelude = "require \"test/pg/test_helper\""
   t.warning = false
-  t.test_globs = ["test/**/*_test.rb"]
+  t.test_globs = ["test/pg/**/*_test.rb"]
+end
+Minitest::TestTask.create(:"test:sqlite") do |t|
+  t.libs << "test/sqlite"
+  t.libs << "lib"
+  t.test_prelude = "require \"test/sqlite/test_helper\""
+  t.warning = false
+  t.test_globs = ["test/sqlite/**/*_test.rb"]
 end
 
-task(default: :test)
+task(default: [:"test:pg", :"test:sqlite"])

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/db/schema-sqlite.sql

@@ -0,0 +1,25 @@
+create table users (
+	id integer primary key,
+  unique_text text not null default CURRENT_TIMESTAMP,
+  exclude_text text not null default CURRENT_TIMESTAMP,
+	user_id integer,
+  untracked_text text not null default CURRENT_TIMESTAMP,
+  free_text text not null default '',
+	friend_user_id integer,
+	created_at datetime(6) not null,
+	updated_at datetime(6) not null,
+
+  constraint chk_rails_15df0d7772
+    check (unique_text != 'invalid'),
+
+  foreign key(user_id) references users(id),
+  foreign key(friend_user_id) references users(id)
+);
+
+create unique index
+	index_users_on_unique_text on users(unique_text);
+create unique index
+	index_users_on_untracked_text on users(untracked_text);
+
+create unique index
+	index_users_on_unique_text_and_untracked_text on users(unique_text, untracked_text);

data/lib/iry/constraint/unique.rb

@@ -23,10 +23,10 @@ module Iry
         hashed_id = "_#{digest}"
         name = "idx_on_#{keys.join("_")}"
 
-        short_limit = max_index_name_size - hashed_identifier.bytesize
+        short_limit = max_index_name_size - hashed_id.bytesize
         short_name = name.mb_chars.limit(short_limit).to_s
 
-        "#{short_name}#{hashed_identifier}"
+        "#{short_name}#{hashed_id}"
       end
 
       # @return [<Symbol>]

data/lib/iry/handlers/sqlite.rb

@@ -0,0 +1,85 @@
+module Iry
+  module Handlers
+    # Sqlite handler through `sqlite3` gem
+    # @private
+    module Sqlite
+      extend self
+
+      # @return [Regexp]
+      REGEX = %r{
+        (?:
+          UNIQUE\sconstraint|
+          CHECK\sconstraint
+        )
+        \sfailed(.+)?
+      }x
+
+      REGEX_CONSTRAINT_TYPE = /(UNIQUE|CHECK)\sconstraint/x
+
+      # @return [Regexp]
+      REGEX_CONSTRAINT_NAME = /(?:\:\sindex\s\'|\:\s)([^']+)\'?(?:\s\(\d+\))?$/x
+
+      # When true, the handler is able to handle this exception, representing a constraint error in Sqlite.
+      # This method must ensure not to raise exception in case the sqlite adapter is missing and as such, the
+      # sqlite constant is undefined
+      # @param err [ActiveRecord::StatementInvalid]
+      # @return [Boolean]
+      def handle?(err)
+        return false if !Object.const_defined?("::SQLite3::ConstraintException")
+
+        return true if err.cause.is_a?(::SQLite3::ConstraintException)
+
+        return false
+      end
+
+      # Appends constraint errors as model errors
+      # @param err [ActiveRecord::StatementInvalid]
+      # @param model [Model] should inherit {ActiveRecord::Base} and`include Iry` to match the interface
+      # @return [nil, ActiveModel::Error] if handled constraint, returns the
+      #   error attached to the model. If constraint wasn't handled or handling
+      #   failed, `nil` is returned
+      def handle(err, model)
+        sqliterr = err.cause
+        constraint_name_msg = sqliterr.message
+        constraint_type_match = REGEX_CONSTRAINT_TYPE.match(constraint_name_msg)
+        if constraint_type_match.nil?
+          return nil
+        end
+
+        constraint_type = constraint_type_match[1]
+        match_constraint = REGEX.match(constraint_name_msg)
+        if match_constraint.nil?
+          return nil
+        end
+
+        match = REGEX_CONSTRAINT_NAME.match(match_constraint[1])
+        if match.nil?
+          return nil
+        end
+
+        constraint_name = nil
+        case constraint_type
+        in "UNIQUE"
+          columns = match[1].
+            split(", ").
+            map { |full_col| full_col.delete_prefix("#{model.class.table_name}.") }
+          constraint_name = Constraint::Unique.infer_name(
+            columns,
+            model.class.table_name
+          )
+        in "CHECK"
+          constraint_name = match[1]
+        else
+          return nil
+        end
+
+        constraint = model.class.constraints[constraint_name]
+        if constraint.nil?
+          return nil
+        end
+
+        return constraint.apply(model)
+      end
+    end
+  end
+end

data/lib/iry/transform_constraints.rb

@@ -77,6 +77,8 @@ module Iry
       case
       when Handlers::PG.handle?(err)
         handler = Handlers::PG
+      when Handlers::Sqlite.handle?(err)
+        handler = Handlers::Sqlite
       end
 
       model_error = handler.handle(err, model)

data/lib/iry.rb

@@ -5,7 +5,7 @@ require_relative "iry/version"
 require_relative "iry/handlers"
 require_relative "iry/handlers/null"
 require_relative "iry/handlers/pg"
-require_relative "iry/callbacks"
+require_relative "iry/handlers/sqlite"
 require_relative "iry/macros"
 require_relative "iry/constraint"
 require_relative "iry/constraint/check"

data/package-lock.json

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

data/package.json

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

data/sorbet/tapioca/require.rb

@@ -2,4 +2,6 @@
 # frozen_string_literal: true
 
 require "active_record"
+require "openssl"
 require "securerandom"
+require "set"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: iry
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Francesco Belladonna
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +79,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '13'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Transform database constraint errors into activerecord validation errors
 email:
 - francesco@fc5.me
@@ -94,9 +107,9 @@ files:
 - Rakefile
 - Steepfile
 - VERSION
+- db/schema-sqlite.sql
 - db/schema.pgsql
 - lib/iry.rb
-- lib/iry/callbacks.rb
 - lib/iry/constraint.rb
 - lib/iry/constraint/check.rb
 - lib/iry/constraint/exclusion.rb
@@ -105,14 +118,13 @@ files:
 - lib/iry/handlers.rb
 - lib/iry/handlers/null.rb
 - lib/iry/handlers/pg.rb
+- lib/iry/handlers/sqlite.rb
 - lib/iry/macros.rb
 - lib/iry/patch.rb
 - lib/iry/transform_constraints.rb
 - lib/iry/version.rb
 - package-lock.json
 - package.json
-- rbi/iry.rbi
-- sig/iry.rbs
 - sorbet/config
 - sorbet/tapioca/config.yml
 - sorbet/tapioca/require.rb
@@ -123,7 +135,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
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Transform database constraint errors into activerecord validation errors
 test_files: []

data/lib/iry/callbacks.rb

@@ -1,31 +0,0 @@
-module Iry
-  # Main function to kick-off **Iry** constraint-checking mechanism
-  # If interested in adding support for other databases beside Postgres, modify this file.
-  # @private
-  module Callbacks
-    extend self
-
-    # @param model [Handlers::Model]
-    # @yield
-    # @return [void]
-    def around_save(model)
-      yield
-    rescue ActiveRecord::StatementInvalid => err
-      handler = Handlers::Null
-      case
-      when Handlers::PG.handle?(err)
-        handler = Handlers::PG
-      end
-
-      is_handled = handler.handle(err, model)
-
-      if is_handled
-        # Rolling back allows to keep using SQL in other callbacks, which
-        # otherwise would raise PG::InFailedSqlTransaction
-        raise ActiveRecord::Rollback
-      else
-        raise
-      end
-    end
-  end
-end