activerecord-exclusive-arc 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dbceaa69bcb956d89d1c636209771640242741ae2e06f57a038f474f64825d8
-  data.tar.gz: a8319a8c41ea99543fc8d52387adb35aa6a56b264adfdfa39a25b8b6d603f774
+  metadata.gz: b3824d9259213c59c55ee5287cc9bd3b8e76924be405a269c6752434811c2599
+  data.tar.gz: 2e8b6ad42b5b4cad774e7ef56e21c54fa9a0e8223fce05762ecb60cf791b4b87
 SHA512:
-  metadata.gz: c0c2ab91655256c9226c3775d2e6ee1c05d733089110728ade4aa39416e23f15a7a048f6e2189fc23aa9aac93783180ac8eabca57f404808957a044375c9ee8d
-  data.tar.gz: ca725edf128c121af9e4a5e8880b8a8895ce8eefabf0ae9175d7c0054a1c7f38475f8b8e47ede79cd31db64fc63a697e97c28525c63062a21b148e042eaefadf
+  metadata.gz: 28d0736dfd28b87e367ab62d9ac1c39cc556bc76d999b390a4b6220b88ac566bcac66c6fda36b0237a5442180b44602c72e6ef837ed99a4f281b0e42da4aac81
+  data.tar.gz: e62da6627153c7853dde9bba360ec654ea28baf088bb4db6261fc77dd88fc78d1bf4b5f5d2c2d777682d0233e7f6ab72567ed1790e8813670b4964ec69a063a8

data/README.md

@@ -10,7 +10,7 @@ fact that the Ruby class name is stored in the database as a string. If you want
 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.
 
-Another common argument concerns referential integrity. *Foreign Key Constraints* are a common mechanism to
+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.
 
@@ -19,8 +19,8 @@ polymorphic: true` relationship and the fact that polymorphic indexes require mu
 
 ### 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
+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.
 
 ## How to use
@@ -49,7 +49,7 @@ This will inject code into your `Comment` Model:
 ```ruby
 class Comment < ApplicationRecord
   include ExclusiveArc::Model
-  exclusive_arc :commentable, [:post, :comment]
+  has_exclusive_arc :commentable, [:post, :comment]
 end
 ```
 
@@ -73,6 +73,17 @@ end
 
 It's a bit more involved than that, but it demonstrates the essense of the API as an `ActiveRecord` user.
 
+If you need to customize a specific `belongs_to` relationship, you can do so by declaring it before
+`has_exclusive_arc`:
+
+```ruby
+class Comment < ApplicationRecord
+  include ExclusiveArc::Model
+  belongs_to :post, -> { where(comments_enabled: true) }, optional: true
+  has_exclusive_arc :commentable, [:post, :comment]
+end
+```
+
 Continuing with our example, the generator command would also produce a migration that looks like this:
 
 ```ruby
@@ -135,4 +146,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/waymon
 ### License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/lib/exclusive_arc/model.rb

@@ -8,27 +8,39 @@ module ExclusiveArc
     end
 
     class_methods do
-      def exclusive_arc(*args)
-        arcs = args[0].is_a?(Hash) ? args[0] : {args[0] => args[1]}
-        options = args[2] || {}
-        arcs.each do |(name, belong_tos)|
-          belong_tos.map { |option| belongs_to(option, optional: true) }
-          exclusive_arcs[name] = Definition.new(
-            reflections: reflections.slice(*belong_tos.map(&:to_s)),
-            options: options
-          )
+      def has_exclusive_arc(*args)
+        arc = args[0]
+        belong_tos = args[1]
+        belong_tos.map do |option|
+          next if reflections[option.to_s]
 
-          class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def #{name}
-              #{belong_tos.join(" || ")}
-            end
+          belongs_to(option, optional: true)
+        end
+        exclusive_arcs[arc] = Definition.new(
+          reflections: reflections.slice(*belong_tos.map(&:to_s)),
+          options: args[2] || {}
+        )
 
-            def #{name}=(polymorphic)
-              assign_exclusive_arc(:#{name}, polymorphic)
+        belong_tos.each do |option|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{option}=(polymorphic)
+              @#{arc} = nil unless @#{arc} == polymorphic
+              super
             end
           RUBY
         end
 
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{arc}
+            @#{arc} ||= (#{belong_tos.join(" || ")})
+          end
+
+          def #{arc}=(polymorphic)
+            assign_exclusive_arc(:#{arc}, polymorphic)
+            @#{arc} = polymorphic
+          end
+        RUBY
+
         validate :validate_exclusive_arcs
       end
     end
@@ -36,9 +48,10 @@ module ExclusiveArc
     private
 
     def assign_exclusive_arc(arc, polymorphic)
-      exclusive_arcs.fetch(arc).reflections.each do |name, reflection|
-        public_send("#{name}=", polymorphic.is_a?(reflection.klass) ? polymorphic : nil)
+      attributes = exclusive_arcs.fetch(arc).reflections.to_h do |name, reflection|
+        [name, polymorphic.is_a?(reflection.klass) ? polymorphic : nil]
       end
+      assign_attributes attributes
     end
 
     def validate_exclusive_arcs

data/lib/exclusive_arc/version.rb

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

data/lib/generators/exclusive_arc_generator.rb

@@ -27,12 +27,18 @@ class ExclusiveArcGenerator < ActiveRecord::Generators::Base
 
   def inject_exclusive_arc_into_model
     indents = "  " * (class_name.scan("::").count + 1)
+    inject_into_class(
+      model_file_path,
+      class_name.demodulize,
+      <<~RB
+        #{indents}has_exclusive_arc #{model_exclusive_arcs}
+      RB
+    )
     inject_into_class(
       model_file_path,
       class_name.demodulize,
       <<~RB
         #{indents}include ExclusiveArc::Model
-        #{indents}exclusive_arc #{model_exclusive_arcs}
       RB
     )
   end
@@ -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.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-08 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -50,26 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
 description:
 email:
 - gmail@justintalbott.com