iry 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21ffff3b3300f8b100bbe0af995b5d0736260f8c17ca93c9f6e66b44b9fd3088
-  data.tar.gz: 5df2033893b5f5d8e8bdf7c97061f8bacc185620daa9a42b87167e945cf534ae
+  metadata.gz: e650372034f89b6bd6d8187f83f7e54ec43a9fa9cf69f4c1ec07ee091b07063c
+  data.tar.gz: 0dad363e7219745a1f92a0af6fe2348a98029f3740cd6031d46535a39c742dd2
 SHA512:
-  metadata.gz: dbc9d0e8a465a34834007308bce3955ed5248c8a93699f81a346c6472cf153dc3df982217868a0392b510f32a0d3fc7ead3c6e9474bc55a508fd976a03e64be4
-  data.tar.gz: 3810fa311f0c09b51dd681eeaa31d6e36eb6a9ee3c131042e43cc525a0231a8df8cbe6f4ae2a55588de95ca3c7e950bf4ef36bc56410214c9adc71f1ceea1ab7
+  metadata.gz: 460f2ebab05bbe7271634f5a7d5cb0ae6644d5f53982e3bec6ac0f8c9f6745ca5c8e3aea3f931649112a2b1641d411c788f9fc3aba643ae03c9e4f50b85784b7
+  data.tar.gz: 17a3e4033f3a731e110706db24b6b71f95b3059b7b113299cf6c651001e7f309b2402b867b7a974f9532ba89a7f499cb7533a2eebc8217bb693513923e8713af

data/CHANGELOG.md

@@ -1,5 +1,16 @@
-## [Unreleased]
+## [0.1.1](https://github.com/Fire-Dragon-DoL/iry/compare/v0.1.0...v0.1.1) (2023-07-07)
 
-## [0.1.0] - 2023-07-04
 
-- Initial release
+
+# [0.1.0](https://github.com/Fire-Dragon-DoL/iry/compare/8a133c2c19b99881619a9e1c7c11076030755f66...v0.1.0) (2023-07-07)
+
+
+### Features
+
+* **constraints:** check constraint is present ([2723ad7](https://github.com/Fire-Dragon-DoL/iry/commit/2723ad70d7dbb4cea4b4c6e92ce59627fae64c27))
+* **constraints:** exclusion constraint is present ([bdb904a](https://github.com/Fire-Dragon-DoL/iry/commit/bdb904a80dd1f6b1960f2b8378490cc192deb83e))
+* **constraints:** foreign key constraint is present ([efed498](https://github.com/Fire-Dragon-DoL/iry/commit/efed4986a10b40c77dcd063d8801eb77d605d807))
+* **deps:** dependency surface is reduced ([ff4af7e](https://github.com/Fire-Dragon-DoL/iry/commit/ff4af7e365537e30a0d95bfdee84e681f54c155a))
+* **project:** setup ([8a133c2](https://github.com/Fire-Dragon-DoL/iry/commit/8a133c2c19b99881619a9e1c7c11076030755f66))
+* **ruby:** version is forced to >= 2.7 ([f386ce6](https://github.com/Fire-Dragon-DoL/iry/commit/f386ce6db3aab7399b71a15bfed8228884a82f16))
+* **unique-constraint:** test is implemented ([c4266b9](https://github.com/Fire-Dragon-DoL/iry/commit/c4266b910757b6adef18db41dfa5dfd9353c1037))

data/README.md

@@ -1,7 +1,13 @@
+[![Iry](https://github.com/Fire-Dragon-DoL/iry/actions/workflows/main.yml/badge.svg)](https://github.com/Fire-Dragon-DoL/iry/actions/workflows/main.yml) [![Gem Version](https://badge.fury.io/rb/iry.svg)](https://badge.fury.io/rb/iry)
+
 # Iry
 
 Convert constraint errors into Rails model validation errors.
 
+## Documentation
+
+https://rubydoc.info/gems/iry/frames
+
 ## Usage
 
 Given the following database schema:
@@ -44,6 +50,7 @@ fail_user.errors.details.fetch(:unique_text) #=> [{error: :taken}]
 Multiple constraints of the same or different types can be present on the model, as long as the `:name` is different.
 
 The following constraint types are available:
+
 - [`check_constraint`](#check_constraint)
 - [`exclusion_constraint`](#exclusion_constraint)
 - [`foreign_key_constraint`](#foreign_key_constraint)
@@ -53,7 +60,11 @@ The class method `.constraints` is also available, that returns all the constrai
 
 ## Constraints
 
-### `check_constraint`
+### [`check_constraint`](https://rubydoc.info/gems/iry/Iry%2FMacros:check_constraint)
+
+```rbs
+check_constraint(key, name: nil, message: :invalid) ⇒ void
+```
 
 Catches a specific check constraint violation.
 
@@ -61,7 +72,11 @@ Catches a specific check constraint violation.
 - **name** (optional `String`) constraint name in the database, to detect constraint errors. Infferred if omitted
 - **message** (optional `String` or `Symbol`) error message, defaults to `:invalid`
 
-### `exclusion_constraint`
+### [`exclusion_constraint`](https://rubydoc.info/gems/iry/Iry%2FMacros:exclusion_constraint)
+
+```rbs
+exclusion_constraint(key, name: nil, message: :taken) ⇒ void
+```
 
 Catches a specific exclusion constraint violation.
 
@@ -69,7 +84,11 @@ Catches a specific exclusion constraint violation.
 - **name** (optional `String`) constraint name in the database, to detect constraint errors. Infferred if omitted
 - **message** (optional `String` or `Symbol`) error message, defaults to `:taken`
 
-### `foreign_key_constraint`
+### [`foreign_key_constraint`](https://rubydoc.info/gems/iry/Iry%2FMacros:foreign_key_constraint)
+
+```rbs
+foreign_key_constraint(key_or_keys, name: nil, message: :required, error_key: nil) ⇒ void
+```
 
 Catches a specific foreign key constraint violation.
 
@@ -78,7 +97,11 @@ Catches a specific foreign key constraint violation.
 - **message** (optional `String` or `Symbol`) error message, defaults to `:required`
 - **error_key** (optional `Symbol`) which key will have validation errors added to
 
-### `unique_constraint`
+### [`unique_constraint`](https://rubydoc.info/gems/iry/Iry%2FMacros:unique_constraint)
+
+```rbs
+unique_constraint(key_or_keys, name: nil, message: :taken, error_key: nil) ⇒ void
+```
 
 Catches a specific foreign key constraint violation.
 
@@ -93,7 +116,7 @@ Catches a specific foreign key constraint violation.
     are cleared
 - `create!` and `update!` will raise `ActiveRecord::RecordNotSaved` for constraints that are caught by `iry`, instead
     of `ActiveModel::ValidationError`
-- Currently only PostgreSQL is supported, with the `pg` gem, but it's easy to add support for other databases.
+- Currently only PostgreSQL is supported with the `pg` gem, but it should be simple to add support for other databases.
 
 ## Installation
 
@@ -109,6 +132,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 **Requirements:**
 - PostgreSQL with `psql`, `createdb`, `dropdb`
+- NodeJS 18 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/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/db/schema.pgsql

@@ -6,6 +6,7 @@ create table if not exists users (
   unique_text text unique not null default gen_random_uuid()::text check (unique_text != 'invalid'),
   exclude_text text not null default gen_random_uuid()::text,
 	user_id uuid references users (id),
+  untracked_text text unique not null default gen_random_uuid()::text,
 	friend_user_id uuid references users (id),
 	created_at timestamp(6) not null,
 	updated_at timestamp(6) not null,

data/lib/iry.rb

@@ -38,7 +38,9 @@ module Iry
   def self.included(klass)
     klass.class_eval do
       extend(Iry::Macros)
-      around_save(Iry::Callbacks)
+      # Prepend ensures around save happens before all around_save callbacks
+      # adding the errors as soon as possible
+      around_save(Iry::Callbacks, prepend: true)
     end
   end
 end