activerecord-exclusive-arc 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3824d9259213c59c55ee5287cc9bd3b8e76924be405a269c6752434811c2599
-  data.tar.gz: 2e8b6ad42b5b4cad774e7ef56e21c54fa9a0e8223fce05762ecb60cf791b4b87
+  metadata.gz: 315a60d914bac0fcce5129cddb165afa90604355e2c4bc9c46cad1b2d5aac79a
+  data.tar.gz: 5b93a4be4ddba10b47eaaaddbd5ba7cb5df072b2462114e01945e2c2f9b051d6
 SHA512:
-  metadata.gz: 28d0736dfd28b87e367ab62d9ac1c39cc556bc76d999b390a4b6220b88ac566bcac66c6fda36b0237a5442180b44602c72e6ef837ed99a4f281b0e42da4aac81
-  data.tar.gz: e62da6627153c7853dde9bba360ec654ea28baf088bb4db6261fc77dd88fc78d1bf4b5f5d2c2d777682d0233e7f6ab72567ed1790e8813670b4964ec69a063a8
+  metadata.gz: 502088f01538ad5c31fbb4052f2a03c7f4dbe5723533d452b07abb331dae7d20c6dc4b87f3c5e019731c2b6cfce43834726f4cc89febf32e971593d2ecb39e44
+  data.tar.gz: 74c62d1c094c033ff0224af98128fe0d65a114e1f36099845cf1d3312cbd39d34a73db71f65b275eda92746be51d063e62ca65feb31849578833951af8115976

data/README.md

@@ -1,31 +1,31 @@
-### What does it do?
+## 💫 `activerecord-exclusive-arc` 💫
 
-It allows an ActiveRecord model to exclusively belong to one of any number of different types of ActiveRecord
-models.
+A RubyGem that allows an ActiveRecord model to exclusively belong to one of any number of different
+types of ActiveRecord models.
 
-### Doesn’t Rails already provide this?
+### Doesn’t Rails already provide a way to do this?
 
-It does, but there are decent arguments against the default Rails way of doing polymorphism. Consider the
-fact that the Ruby class name is stored in the database as a string. If you want to change the name of the
-Ruby class used for such reasons, you must also update the database strings that represent it. The bleeding
-of application-layer definitions into the database may become a liability.
+It does, but there are decent arguments against the default Rails way of doing polymorphism.
+Consider the fact that the Ruby class name is stored in the database as a string. If you want to
+change the name of the Ruby class used for such reasons, you must also update the database strings
+that represent it. The seeping of application-layer definitions into the database may become a
+liability.
 
-Another common argument concerns referential integrity. _Foreign Key Constraints_ are a common mechanism to
-ensure primary keys of tables can be reliably used as foreign keys on others. This becomes harder to enforce
-when a column that represents a Ruby class is one of the components required for unique identification.
-
-There are also quality of life considerations, such as not being able to eager-load the `belongs_to ...
-polymorphic: true` relationship and the fact that polymorphic indexes require multiple columns.
+Another common argument concerns referential integrity. _Foreign Key Constraints_ are a common
+mechanism to ensure primary keys of database tables can be reliably used as foreign keys on others.
+This becomes harder to enforce in the databse when a string column that represents a Ruby class is
+one of the components required for unique identification.
 
 ### So how does this work?
 
-It reduces the boilerplate of managing a _Polymorphic Assication_ modeled as a pattern called an _Exclusive
-Arc_. This maps nicely to a database constraint, a set of optional `belongs_to` relationships, some
-polymorphic methods, and an `ActiveRecord` validation for good measure.
+It reduces the boilerplate of managing a _Polymorphic Assication_ modeled as a pattern called an
+_Exclusive Arc_, where each potential polymorphic reference has its own foreign key. This maps
+nicely to a set of optional `belongs_to` relationships, some polymorphic convenience methods, and a
+database check constraint with a matching `ActiveRecord` validation.
 
 ## How to use
 
-Firstly, in your `Gemfile`:
+Firstly, add the gem to your `Gemfile` and `bundle install`:
 
 ```ruby
 gem "activerecord-exclusive-arc"
@@ -37,8 +37,8 @@ The feature set of this gem is offered via a Rails generator command:
 bin/rails g exclusive_arc <Model> <arc> <belongs_to1> <belongs_to2> ...
 ```
 
-This assumes you already have a `<Model>`. The `<arc>` is the name of the polymorphic association you want to
-establish that may either be a `<belongs_to1>`, `<belongs_to2>`, etc. Say we ran:
+This assumes you already have a `<Model>`. The `<arc>` is the name of the polymorphic association
+you want to establish that may either be a `<belongs_to1>`, `<belongs_to2>`, etc. Say we ran:
 
 ```
 bin/rails g exclusive_arc Comment commentable post comment
@@ -84,7 +84,8 @@ class Comment < ApplicationRecord
 end
 ```
 
-Continuing with our example, the generator command would also produce a migration that looks like this:
+Continuing with our example, the generator command would also produce a migration that looks like
+this:
 
 ```ruby
 class CommentCommentableExclusiveArc < ActiveRecord::Migration[7.0]
@@ -100,9 +101,9 @@ class CommentCommentableExclusiveArc < ActiveRecord::Migration[7.0]
 end
 ```
 
-The check constraint ensures `ActiveRecord` validations can’t be bypassed to break the fabeled rule - "There
-Can Only Be One™️". Traditional foreign key constraints can be used and the partial indexes provide improved
-lookup performance for each individual polymorphic assoication.
+The check constraint ensures `ActiveRecord` validations can’t be bypassed to break the fabeled
+rule - "There Can Only Be One️". Traditional foreign key constraints can be used and the partial
+indexes provide improved lookup performance for each individual polymorphic assoication.
 
 ### Exclusive Arc Options
 
@@ -114,30 +115,24 @@ Usage:
   rails generate exclusive_arc NAME [arc belongs_to1 belongs_to2 ...] [options]
 
 Options:
-  [--skip-namespace], [--no-skip-namespace]                              # Skip namespace (affects only isolated engines)
-  [--skip-collision-check], [--no-skip-collision-check]                  # Skip collision check
   [--optional], [--no-optional]                                          # Exclusive arc is optional
   [--skip-foreign-key-constraints], [--no-skip-foreign-key-constraints]  # Skip foreign key constraints
   [--skip-foreign-key-indexes], [--no-skip-foreign-key-indexes]          # Skip foreign key partial indexes
   [--skip-check-constraint], [--no-skip-check-constraint]                # Skip check constraint
 
-Runtime options:
-  -f, [--force]                    # Overwrite files that already exist
-  -p, [--pretend], [--no-pretend]  # Run but do not make any changes
-  -q, [--quiet], [--no-quiet]      # Suppress status output
-  -s, [--skip], [--no-skip]        # Skip files that already exist
-
 Adds an Exclusive Arc to an ActiveRecord model and generates the migration for it
 ```
 
-Notably, if you want to make an Exclusive Arc optional, you can use the `--optional` flag. This will adjust
-the definition in your `ActiveRecord` model and loosen both the validation and database check constraint so
-that there can be 0 or 1 foreign keys set for the polymorphic association.
+Notably, if you want to make an Exclusive Arc optional, you can use the `--optional` flag. This will
+adjust the definition in your `ActiveRecord` model and loosen both the validation and database check
+constraint so that there can be 0 or 1 foreign keys set for the polymorphic reference.
 
 ### Compatibility
 
-Currently `activerecord-exclusive-arc` is tested against a matrix of Ruby 2.7 and 3.2, Rails 6.1 and 7.0, and
-`postgresql` and `sqlite3` database adapters.
+Currently `activerecord-exclusive-arc` is tested against a matrix of:
+* Ruby 2.7 and 3.2
+* Rails 6.1 and 7.0
+* `postgresql` and `sqlite3` database adapters
 
 ### Contributing
 

data/lib/exclusive_arc/version.rb

@@ -1,3 +1,3 @@
 module ExclusiveArc
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/generators/exclusive_arc_generator.rb

@@ -110,7 +110,7 @@ class ExclusiveArcGenerator < ActiveRecord::Generators::Base
     add_check_constraint(
       :#{table_name},
       "#{check_constraint}",
-      name: :#{arc}
+      name: "#{arc}"
     )
       RUBY
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-exclusive-arc
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: An ActiveRecord extension for polymorphic exclusive arc relationships