activerecord-exclusive-arc 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27e01ec54aa223f1e36904771298125b451731632cca44ae6d0d15627cbcf879
-  data.tar.gz: 97990f81b596836909e67609a2d9745d6be13f0852373829656d2218454f6029
+  metadata.gz: 315a60d914bac0fcce5129cddb165afa90604355e2c4bc9c46cad1b2d5aac79a
+  data.tar.gz: 5b93a4be4ddba10b47eaaaddbd5ba7cb5df072b2462114e01945e2c2f9b051d6
 SHA512:
-  metadata.gz: 448c3910176f2f9163d0cfac054482fa2c6dc96b3e67d1093668626e2dbc94cfdeb59adcc371f3890af35541f9e4db7b8f4db0cd0108db09cd6bfe68de4954be
-  data.tar.gz: ec36d41ce0896b6505f76eb5112dd999db1cb334d9d0b956d82d7f043efba1e4999ef32ddbf0a384c140b5dcba01dfbaf7606b4638ac94381fbc8408751a7d3a
+  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.1"
+  VERSION = "0.2.3"
 end

data/lib/generators/exclusive_arc_generator.rb

@@ -31,10 +31,16 @@ class ExclusiveArcGenerator < ActiveRecord::Generators::Base
       model_file_path,
       class_name.demodulize,
       <<~RB
-        #{indents}include ExclusiveArc::Model
         #{indents}has_exclusive_arc #{model_exclusive_arcs}
       RB
     )
+    inject_into_class(
+      model_file_path,
+      class_name.demodulize,
+      <<~RB
+        #{indents}include ExclusiveArc::Model
+      RB
+    )
   end
 
   no_tasks do
@@ -44,12 +50,30 @@ class ExclusiveArcGenerator < ActiveRecord::Generators::Base
       string
     end
 
+    def add_references
+      belong_tos.map do |reference|
+        add_reference(reference)
+      end.join("\n")
+    end
+
     def add_reference(reference)
-      string = "add_reference :#{table_name}, :#{reference}"
-      type = reference_type(reference)
-      string += ", type: :#{type}" unless /int/.match?(type.downcase)
-      string += ", foreign_key: true" unless options[:skip_foreign_key_constraints]
-      string += ", index: {where: \"#{reference}_id IS NOT NULL\"}" unless options[:skip_foreign_key_indexes]
+      foreign_key = foreign_key_name(reference)
+      type = reference_type(reference).downcase
+      if foreign_key == "#{reference}_id"
+        string = "    add_reference :#{table_name}, :#{reference}"
+        string += ", type: :#{type}" unless /int/.match?(type)
+        string += ", foreign_key: true" unless options[:skip_foreign_key_constraints]
+        string += ", index: {where: \"#{foreign_key} IS NOT NULL\"}" unless options[:skip_foreign_key_indexes]
+      else
+        string = "    add_column :#{table_name}, :#{foreign_key}, :#{type}"
+        unless options[:skip_foreign_key_constraints]
+          referenced_table_name = reference_table_name(reference)
+          string += "\n    add_foreign_key :#{table_name}, :#{referenced_table_name}, column: :#{foreign_key}"
+        end
+        unless options[:skip_foreign_key_indexes]
+          string += "\n    add_index :#{table_name}, :#{foreign_key}, where: \"#{foreign_key} IS NOT NULL\""
+        end
+      end
       string
     end
 
@@ -62,15 +86,38 @@ class ExclusiveArcGenerator < ActiveRecord::Generators::Base
     end
 
     def reference_type(reference)
-      klass = reference.singularize.classify.constantize
+      klass = class_name.constantize.reflections[reference].klass
       klass.columns.find { |col| col.name == klass.primary_key }.sql_type
     rescue
       "bigint"
     end
 
+    def reference_table_name(reference)
+      class_name.constantize.reflections[reference].klass.table_name
+    rescue
+      reference.tableize
+    end
+
+    def foreign_key_name(reference)
+      class_name.constantize.reflections[reference].foreign_key
+    rescue
+      "#{reference}_id"
+    end
+
+    def add_check_constraint
+      return if options[:skip_check_constraint]
+      <<-RUBY
+    add_check_constraint(
+      :#{table_name},
+      "#{check_constraint}",
+      name: "#{arc}"
+    )
+      RUBY
+    end
+
     def check_constraint
       reference_checks = belong_tos.map do |reference|
-        "CASE WHEN #{reference}_id IS NULL THEN 0 ELSE 1 END"
+        "CASE WHEN #{foreign_key_name(reference)} IS NULL THEN 0 ELSE 1 END"
       end
       condition = options[:optional] ? "<= 1" : "= 1"
       "(#{reference_checks.join(" + ")}) #{condition}"

data/lib/generators/templates/migration.rb.erb

@@ -1,10 +1,6 @@
 class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
-    <% belong_tos.each do |reference| %><%= add_reference(reference) %>
-    <% end %><% unless options[:skip_check_constraint] %>add_check_constraint(
-      :<%= table_name %>,
-      "<%= check_constraint %>",
-      name: :<%= arc %>
-    )<% end %>
+<%= add_references %>
+<%= add_check_constraint %>
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-exclusive-arc
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-08 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