polymorphic_belongs_to 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '07971d74aa507ba0e738c433c955150723fbbe547f3ff009f8b8707a7479c122'
-  data.tar.gz: 3b5467dbac0e1c8111599a56a5f17b53325274173b25ff500af9966fb3e3eb75
+  metadata.gz: b1931a69a1ca4d6916e27182f40285e34d7a6d84d55796ff19c35faa0d91c425
+  data.tar.gz: cb2778380cf8c93d0846356562dc98a0d47411c13d686c41561517da208ebaef
 SHA512:
-  metadata.gz: 51e164ba36955d17eed4b4d7af629544fcc378d6640485dc6b5b2ae42dff44288b9888aa622fe9798272ab776f3e53a3a505c60336158d76d6cc8bf0bc9a1fbe
-  data.tar.gz: f24e08c20a3bd2e1a5832aa8916878f993d5f64c10819b294f7815f52bce6e339ae52a94671cb8c9bc94d8416501b449472593db7588043934bf0ef4602bf8bc
+  metadata.gz: e6cb3727467ec304122f5c0ca97f9b38a79f23d7837ff68f2eee2fcc3971f826d67f3498eb07ae83deac3c3f6edb131f011936b33f1ab13ea7dcff87c355067c
+  data.tar.gz: e47a40c40f3a9c092e2592d5b4d4154b47650a28b4cd076fe0a29da7f8d316707a868966a9df59056a04ab960b35593834e26590c79d9618ad5d9bfd5637b5c8

data/README.md

@@ -16,12 +16,33 @@ bundle add polymorphic_belongs_to
 class Comment < ApplicationRecord
   include PolymorphicBelongsTo
 
-  polymorphically_belongs_to :commentable, types: [Post, Photo]
+  polymorphic_belongs_to :commentable, types: [Post, Photo]
+
+  # Disable the "type inclusion" validator
+  polymorphic_belongs_to :commentable, types: [Post, Photo], validate_types: false
+
+  # Customize the "type inclusion" validator
+  polymorphic_belongs_to :commentable,
+    types: [Post, Photo],
+    validate_types: { in: ["Post", "Photo", "Repost"], message: "..." }
 end
 ```
 
 Run `bin/tapioca dsl` to regenerate RBIs.
 
+### Options
+
+`polymorphic_belongs_to(name, types:, validate_types: true, optional: nil, **options)`
+
+- `name` — The association name, e.g. `:commentable`.
+- `types:` — An array of allowed target classes. Used both as the source of truth for the type-inclusion validator and by the Tapioca DSL compiler when generating RBIs.
+- `validate_types:` — Controls the validation of the "type" field:
+  - `true`: (Default) installs the validator with the list of allowed target classes: `validates :"#{name}_type", inclusion: ...`
+  - `false`: Skips the type-inclusion validator
+  - `{...}`: A Hash is passed straight through to `validates ..., inclusion:`, so you can override `in:`, supply a custom `message:`, etc.
+- `optional:` — Forwarded to `belongs_to`, see Rails documentation. This also controls the type inclusion validator's `allow_nil` option.
+- `**options` — Any remaining keyword arguments are forwarded to the underlying `belongs_to(name, polymorphic: true, ...)` call (e.g. `inverse_of:`, `dependent:`).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/polymorphic_belongs_to/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module PolymorphicBelongsTo
-  VERSION = "0.0.0"
+  VERSION = "0.2.0"
 end

data/lib/polymorphic_belongs_to.rb

@@ -10,15 +10,15 @@ module PolymorphicBelongsTo
   extend ActiveSupport::Concern
 
   included do
-    class_attribute :defined_polymorphic_belongs_tos, instance_writer: false
+    class_attribute :polymorphic_belongs_to_types, instance_writer: false
   end
 
   module ClassMethods
-    def polymorphically_belongs_to(name, types:, validate_types: true, **options)
+    def polymorphic_belongs_to(name, types:, validate_types: true, **options)
       name = name.to_sym
 
-      self.defined_polymorphic_belongs_tos ||= {}
-      defined_polymorphic_belongs_tos[name.to_s] = types
+      self.polymorphic_belongs_to_types ||= {}
+      polymorphic_belongs_to_types[name.to_s] = types
 
       belongs_to(name, polymorphic: true, **options)
 
@@ -26,7 +26,8 @@ module PolymorphicBelongsTo
         foreign_type = reflect_on_association(name).foreign_type.to_sym
         presence_required = validators_on(name).any? { |v| v.is_a?(ActiveRecord::Validations::PresenceValidator) }
 
-        validates(foreign_type, inclusion: {in: types.map(&:name)}, allow_nil: !presence_required)
+        inclusion_options = validate_types.is_a?(Hash) ? validate_types : {in: types.map(&:name)}
+        validates(foreign_type, inclusion: inclusion_options, allow_nil: !presence_required)
       end
     end
   end

data/lib/tapioca/dsl/compilers/polymorphic_belongs_to.rb

@@ -15,12 +15,12 @@ module Tapioca
       def self.gather_constants
         all_classes.select do |klass|
           klass < ActiveRecord::Base &&
-            klass.respond_to?(:defined_polymorphic_belongs_tos)
+            klass.respond_to?(:polymorphic_belongs_to_types)
         end
       end
 
       def decorate
-        defined = T.unsafe(constant).defined_polymorphic_belongs_tos
+        defined = T.unsafe(constant).polymorphic_belongs_to_types
         return unless defined&.any?
 
         root.create_path(constant) do |model|

data/polymorphic_belongs_to.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Zach Ahn"]
   spec.email = ["engineering@zachahn.com"]
 
-  spec.summary = "PolymorphicBelongsTo provides a type-safe `polymorphically_belongs_to` association to ActiveRecord. Relies on Sorbet + Tapioca."
+  spec.summary = "PolymorphicBelongsTo provides a type-safe `polymorphic_belongs_to` association to ActiveRecord. Relies on Sorbet + Tapioca."
   spec.homepage = "https://github.com/zachahn/polymorphic_belongs_to"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.2.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polymorphic_belongs_to
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Zach Ahn
@@ -85,6 +85,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: PolymorphicBelongsTo provides a type-safe `polymorphically_belongs_to` association
+summary: PolymorphicBelongsTo provides a type-safe `polymorphic_belongs_to` association
   to ActiveRecord. Relies on Sorbet + Tapioca.
 test_files: []