iry 0.1.0

data/sig/iry.rbs

@@ -0,0 +1,340 @@
+# Entrypoint of constraint validation, include in a class inheriting {ActiveRecord::Base} and the following class-level
+# methods will be available:
+# - {Macros#constraints}
+# - {Macros#check_constraint}
+# - {Macros#exclusion_constraint}
+# - {Macros#foreign_key_constraint}
+# - {Macros#unique_constraint}
+# 
+# @example User unique constraint validation
+#   # The database schema has a unique constraint on email field
+#   class User < ActiveRecord::Base
+#     include Iry
+# 
+#     unique_constraint :email
+#   end
+# 
+#   user = User.create!(email: "user@example.com")
+#   fail_user = User.create(email: "user@example.com")
+#   fail_user.errors.details.fetch(:email) #=> [{error: :taken}]
+module Iry
+  VERSION: String
+
+  # _@param_ `klass`
+  def self.included: (Module klass) -> void
+
+  # Class-level methods available to classes executing `include Iry`
+  module Macros
+    # Constraints by name
+    def constraints: () -> ::Hash[String, Constraint]
+
+    # Tracks check constraint for the given key and convert constraint errors into validation errors
+    # 
+    # _@param_ `key` — key to apply validation errors to
+    # 
+    # _@param_ `message` — the validation error message
+    # 
+    # _@param_ `name` — constraint name. If omitted, it will be inferred using table name + key
+    def check_constraint: (Symbol key, ?name: String?, ?message: (Symbol | String)) -> void
+
+    # Tracks exclusion constraint for the given key and convert constraint errors into validation errors
+    # 
+    # _@param_ `key` — key to apply validation errors to
+    # 
+    # _@param_ `message` — the validation error message
+    # 
+    # _@param_ `name` — constraint name. If omitted, it will be inferred using table name + key
+    def exclusion_constraint: (Symbol key, ?name: String?, ?message: (Symbol | String)) -> void
+
+    # Tracks foreign key constraint for the given key (or keys) and convert constraint errors into validation errors
+    # 
+    # _@param_ `key_or_keys` — key or array of keys to track the foreign key constraint of
+    # 
+    # _@param_ `message` — the validation error message
+    # 
+    # _@param_ `name` — constraint name. If omitted, it will be inferred using table name + keys
+    # 
+    # _@param_ `error_key` — key to which the validation error will be applied to. If omitted, it will be applied to the first key
+    def foreign_key_constraint: (
+                                  (Symbol | ::Array[Symbol]) key_or_keys,
+                                  ?name: String?,
+                                  ?message: (Symbol | String),
+                                  ?error_key: Symbol?
+                                ) -> void
+
+    # Tracks uniqueness constraint for the given key (or keys) and convert constraint errors into validation errors
+    # 
+    # _@param_ `key_or_keys` — key or array of keys to track the uniqueness constraint of
+    # 
+    # _@param_ `message` — the validation error message
+    # 
+    # _@param_ `name` — constraint name. If omitted, it will be inferred using table name + keys
+    # 
+    # _@param_ `error_key` — key to which the validation error will be applied to. If omitted, it will be applied to the first key
+    def unique_constraint: (
+                             (Symbol | ::Array[Symbol]) key_or_keys,
+                             ?name: String?,
+                             ?message: (Symbol | String),
+                             ?error_key: Symbol?
+                           ) -> void
+  end
+
+  module Handlers
+    # Interface for handlers of different database types
+    # @abstract
+    module Handler
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # _@param_ `err` — possible constraint error to handle
+      # 
+      # _@return_ — true if this database handler is the correct one for this exception
+      def handle?: (ActiveRecord::StatementInvalid err) -> bool
+
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # _@param_ `err` — possible constraint error to handle
+      # 
+      # _@param_ `model`
+      # 
+      # _@return_ — true if this database handler handled the constraint error
+      def handle: (ActiveRecord::StatementInvalid err, Model model) -> bool
+    end
+
+    # Interface of the model class. This class is usually inherits from {ActiveRecord::Base}
+    # @abstract
+    module ModelClass
+      def table_name: () -> String
+
+      def constraints: () -> ::Hash[String, Constraint]
+    end
+
+    # Interface of the model that should be used to handle constraints.
+    # This object is an instance of {ActiveRecord::Base}
+    # @abstract
+    module Model
+      # sord warn - ActiveModel::Errors wasn't able to be resolved to a constant in this project
+      def errors: () -> ActiveModel::Errors
+
+      def class: () -> ModelClass
+    end
+
+    # PostgreSQL handler through `pg` gem
+    # @private
+    module PG
+      extend Iry::Handlers::PG
+      REGEX: Regexp
+
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # When true, the handler is able to handle this exception, representing a constraint error in PostgreSQL.
+      # This method must ensure not to raise exception in case the postgresql adapter is missing and as such, the
+      # postgres constant is undefined
+      # 
+      # _@param_ `err`
+      def handle?: (ActiveRecord::StatementInvalid err) -> bool
+
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # Appends constraint errors as model errors
+      # 
+      # _@param_ `err`
+      # 
+      # _@param_ `model` — should inherit {ActiveRecord::Base} and`include Iry` to match the interface
+      def handle: (ActiveRecord::StatementInvalid err, Model model) -> void
+
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # When true, the handler is able to handle this exception, representing a constraint error in PostgreSQL.
+      # This method must ensure not to raise exception in case the postgresql adapter is missing and as such, the
+      # postgres constant is undefined
+      # 
+      # _@param_ `err`
+      def self.handle?: (ActiveRecord::StatementInvalid err) -> bool
+
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # Appends constraint errors as model errors
+      # 
+      # _@param_ `err`
+      # 
+      # _@param_ `model` — should inherit {ActiveRecord::Base} and`include Iry` to match the interface
+      def self.handle: (ActiveRecord::StatementInvalid err, Model model) -> void
+    end
+
+    # Catch-all handler for unrecognized database adapters
+    # @private
+    module Null
+      extend Iry::Handlers::Null
+
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # Returns always true, catching any unhandled database exception
+      # 
+      # _@param_ `err`
+      def handle?: ((StandardError | ActiveRecord::StatementInvalid) err) -> bool
+
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # Return always false, failing to handle any constraint
+      # 
+      # _@param_ `err`
+      # 
+      # _@param_ `model` — should inherit {ActiveRecord::Base} and`include Iry` to match the interface
+      def handle: (ActiveRecord::StatementInvalid err, Model model) -> bool
+
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # Returns always true, catching any unhandled database exception
+      # 
+      # _@param_ `err`
+      def self.handle?: ((StandardError | ActiveRecord::StatementInvalid) err) -> bool
+
+      # sord warn - ActiveRecord::StatementInvalid wasn't able to be resolved to a constant in this project
+      # Return always false, failing to handle any constraint
+      # 
+      # _@param_ `err`
+      # 
+      # _@param_ `model` — should inherit {ActiveRecord::Base} and`include Iry` to match the interface
+      def self.handle: (ActiveRecord::StatementInvalid err, Model model) -> bool
+    end
+  end
+
+  # 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 Iry::Callbacks
+
+    # _@param_ `model`
+    def around_save: (Handlers::Model model) -> void
+
+    # _@param_ `model`
+    def self.around_save: (Handlers::Model model) -> void
+  end
+
+  # Interface representing a constraint.
+  # A constraint has a name and can apply errors to an object inheriting from {ActiveRecord::Base}
+  # @abstract
+  module Constraint
+    # Sets validation errors on the model
+    # 
+    # _@param_ `model`
+    def apply: (Handlers::Model model) -> void
+
+    # Name of the constraint to be caught from the database
+    def name: () -> String
+
+    # Message to be attached as validation error to the model
+    # (see Handlers::Model)
+    def message: () -> (Symbol | String)
+
+    class Check
+      # Infers the check constraint name based on key and table name
+      # 
+      # _@param_ `key`
+      # 
+      # _@param_ `table_name`
+      def self.infer_name: (Symbol key, String table_name) -> String
+
+      # _@param_ `key` — key to apply error message for check constraint to
+      # 
+      # _@param_ `message` — the validation error message
+      # 
+      # _@param_ `name` — constraint name
+      def initialize: (Symbol key, name: String, ?message: (Symbol | String)) -> void
+
+      # _@param_ `model`
+      def apply: (Handlers::Model model) -> void
+
+      attr_accessor key: Symbol
+
+      attr_accessor message: (Symbol | String)
+
+      attr_accessor name: String
+    end
+
+    class Unique
+      # Infers the unique constraint name based on keys and table name
+      # 
+      # _@param_ `keys`
+      # 
+      # _@param_ `table_name`
+      def self.infer_name: (::Array[Symbol] keys, String table_name) -> String
+
+      # _@param_ `keys` — array of keys to track the uniqueness constraint of
+      # 
+      # _@param_ `message` — the validation error message
+      # 
+      # _@param_ `name` — constraint name
+      # 
+      # _@param_ `error_key` — key to which the validation error will be applied to
+      def initialize: (
+                        ::Array[Symbol] keys,
+                        name: String,
+                        error_key: Symbol,
+                        ?message: (Symbol | String)
+                      ) -> void
+
+      # _@param_ `model`
+      def apply: (Handlers::Model model) -> void
+
+      attr_accessor keys: ::Array[Symbol]
+
+      attr_accessor message: (Symbol | String)
+
+      attr_accessor name: String
+
+      attr_accessor error_key: Symbol
+    end
+
+    class Exclusion
+      # Infers the exclusion constraint name based on key and table name
+      # 
+      # _@param_ `key`
+      # 
+      # _@param_ `table_name`
+      def self.infer_name: (Symbol key, String table_name) -> String
+
+      # _@param_ `key` — key to apply error message for exclusion constraint to
+      # 
+      # _@param_ `message` — the validation error message
+      # 
+      # _@param_ `name` — constraint name
+      def initialize: (Symbol key, name: String, ?message: (Symbol | String)) -> void
+
+      # _@param_ `model`
+      def apply: (Handlers::Model model) -> void
+
+      attr_accessor key: Symbol
+
+      attr_accessor message: (Symbol | String)
+
+      attr_accessor name: String
+    end
+
+    class ForeignKey
+      # Infers the unique constraint name based on keys and table name
+      # 
+      # _@param_ `keys`
+      # 
+      # _@param_ `table_name`
+      def self.infer_name: (::Array[Symbol] keys, String table_name) -> String
+
+      # _@param_ `keys` — array of keys to track the uniqueness constraint of
+      # 
+      # _@param_ `message` — the validation error message
+      # 
+      # _@param_ `name` — constraint name
+      # 
+      # _@param_ `error_key` — key to which the validation error will be applied to
+      def initialize: (
+                        ::Array[Symbol] keys,
+                        name: String,
+                        error_key: Symbol,
+                        ?message: (Symbol | String)
+                      ) -> void
+
+      # _@param_ `model`
+      def apply: (Handlers::Model model) -> void
+
+      attr_accessor keys: ::Array[Symbol]
+
+      attr_accessor message: (Symbol | String)
+
+      attr_accessor name: String
+
+      attr_accessor error_key: Symbol
+    end
+  end
+end

data/sorbet/config

@@ -0,0 +1,10 @@
+--dir
+.
+--ignore=tmp/
+--ignore=vendor/
+--ignore=bin/
+--ignore=binstubs/
+--ignore=doc/
+--ignore=Rakefile
+--ignore=Gemfile
+--ignore=iry.gemspec

data/sorbet/tapioca/config.yml

@@ -0,0 +1,64 @@
+gem:
+  all: false
+  exclude:
+    # annotated
+    # - activemodel
+    # annotated
+    # - activerecord
+    # annotated
+    # - activesupport
+    - ast
+    - byebug
+    - coderay
+    - commander
+    # - concurrent-ruby
+    # - csv
+    - diff-lcs
+    - erubi
+    # - fileutils
+    - ffi
+    - highline
+    - i18n
+    - language_server-protocol
+    - listen
+    - method_source
+    # - minitest-power_assert
+    # - minitest
+    - netrc
+    - parallel
+    - parlour
+    - parser
+    # - pg
+    # - power_assert
+    - prettier_print
+    - pry-byebug
+    - pry
+    - racc
+    - rainbow
+    - rake
+    - rbi
+    - rbs
+    - rb-fsevent
+    - rb-inotify
+    - sord
+    - spoom
+    - steep
+    - strscan
+    - syntax_tree
+    - tapioca
+    - terminal-table
+    - thor
+    - tzinfo
+    - unicode-display_width
+    - unparser
+    - webrick
+    - yard-sorbet
+    - yard
+  doc: true
+  workers: 8
+dsl:
+  # Add your `dsl` command parameters here:
+  #
+  # exclude:
+  # - SomeGeneratorName
+  # workers: 5

data/sorbet/tapioca/require.rb

@@ -0,0 +1,5 @@
+# typed: true
+# frozen_string_literal: true
+
+require "active_record"
+require "securerandom"

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: iry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francesco Belladonna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+description: Transform database constraint errors into activerecord validation errors
+email:
+- francesco@fc5.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc.example"
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- Steepfile
+- VERSION
+- db/schema.pgsql
+- lib/iry.rb
+- lib/iry/callbacks.rb
+- lib/iry/constraint.rb
+- lib/iry/constraint/check.rb
+- lib/iry/constraint/exclusion.rb
+- lib/iry/constraint/foreign_key.rb
+- lib/iry/constraint/unique.rb
+- lib/iry/handlers.rb
+- lib/iry/handlers/null.rb
+- lib/iry/handlers/pg.rb
+- lib/iry/macros.rb
+- lib/iry/version.rb
+- rbi/iry.rbi
+- sig/iry.rbs
+- sorbet/config
+- sorbet/tapioca/config.yml
+- sorbet/tapioca/require.rb
+homepage: https://github.com/Fire-Dragon-DoL/iry
+licenses: []
+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:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.15
+signing_key: 
+specification_version: 4
+summary: Transform database constraint errors into activerecord validation errors
+test_files: []