polymorphic_belongs_to 0.0.0 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +21 -0
- data/lib/polymorphic_belongs_to/version.rb +1 -1
- data/lib/polymorphic_belongs_to.rb +2 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 290d53bdaab6800f56b0edf83ea87a690baf62ca3a271780b6825c95528dd05f
|
|
4
|
+
data.tar.gz: bfa1cc5b60ede65a5d744447858dff62830ceef4fe33c8f3d82758792cb725c3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d871be11f602c84d9be9a4aa4bf1c5f16bf47f8b79150ff88e878cb433eb1d8a5825baff9d9e19e7256788029925e8a0d28a9b6e30b63cf6f422d7e371100e55
|
|
7
|
+
data.tar.gz: 14139961b813f91033316cc9ea3eaaf1220b28bd8afc4cfdadd145a84285489c4799a0908e14a37c53a5ab3ae7de320ecf3f80507cc11be86348fa6a88188245
|
data/README.md
CHANGED
|
@@ -17,11 +17,32 @@ class Comment < ApplicationRecord
|
|
|
17
17
|
include PolymorphicBelongsTo
|
|
18
18
|
|
|
19
19
|
polymorphically_belongs_to :commentable, types: [Post, Photo]
|
|
20
|
+
|
|
21
|
+
# Disable the "type inclusion" validator
|
|
22
|
+
polymorphically_belongs_to :commentable, types: [Post, Photo], validate_types: false
|
|
23
|
+
|
|
24
|
+
# Customize the "type inclusion" validator
|
|
25
|
+
polymorphically_belongs_to :commentable,
|
|
26
|
+
types: [Post, Photo],
|
|
27
|
+
validate_types: { in: ["Post", "Photo", "Repost"], message: "..." }
|
|
20
28
|
end
|
|
21
29
|
```
|
|
22
30
|
|
|
23
31
|
Run `bin/tapioca dsl` to regenerate RBIs.
|
|
24
32
|
|
|
33
|
+
### Options
|
|
34
|
+
|
|
35
|
+
`polymorphically_belongs_to(name, types:, validate_types: true, optional: nil, **options)`
|
|
36
|
+
|
|
37
|
+
- `name` — The association name, e.g. `:commentable`.
|
|
38
|
+
- `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.
|
|
39
|
+
- `validate_types:` — Controls the validation of the "type" field:
|
|
40
|
+
- `true`: (Default) installs the validator with the list of allowed target classes: `validates :"#{name}_type", inclusion: ...`
|
|
41
|
+
- `false`: Skips the type-inclusion validator
|
|
42
|
+
- `{...}`: A Hash is passed straight through to `validates ..., inclusion:`, so you can override `in:`, supply a custom `message:`, etc.
|
|
43
|
+
- `optional:` — Forwarded to `belongs_to`, see Rails documentation. This also controls the type inclusion validator's `allow_nil` option.
|
|
44
|
+
- `**options` — Any remaining keyword arguments are forwarded to the underlying `belongs_to(name, polymorphic: true, ...)` call (e.g. `inverse_of:`, `dependent:`).
|
|
45
|
+
|
|
25
46
|
## Development
|
|
26
47
|
|
|
27
48
|
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.
|
|
@@ -26,7 +26,8 @@ module PolymorphicBelongsTo
|
|
|
26
26
|
foreign_type = reflect_on_association(name).foreign_type.to_sym
|
|
27
27
|
presence_required = validators_on(name).any? { |v| v.is_a?(ActiveRecord::Validations::PresenceValidator) }
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
inclusion_options = validate_types.is_a?(Hash) ? validate_types : {in: types.map(&:name)}
|
|
30
|
+
validates(foreign_type, inclusion: inclusion_options, allow_nil: !presence_required)
|
|
30
31
|
end
|
|
31
32
|
end
|
|
32
33
|
end
|