activerecord-polytypes 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de50052f2a84d18714886f41876bfe80b9d9b9b4e7fd426338c4029fad5b925b
-  data.tar.gz: d94bdc1f419a3f1aed49965f8c09fe36fabf833ffaf8dae2837a38d2cc760d2b
+  metadata.gz: 14bd860961bc0035b5fc2f83db1beec51d3a4c758ac8de01ed40171303aca333
+  data.tar.gz: f56ffea0e2286170c92ce30a77212786c96d7307f61306e1698362ceb203c3c7
 SHA512:
-  metadata.gz: e3c518408bf522adf86567c0f4a6f9bc0696bcf385b89159c29678a51de2d9660494c4a69ace25049920a67bac957fee425396b53526df71bfe4458f36ada2d0
-  data.tar.gz: ce13ce16d5239f575a98b2acd29cdd50d69bf36001e481cef893a76fb96f01ba27b2e790095d0d2a2c4c6e991b19e1dc8dd59e0be599856bac6381f98ade7633
+  metadata.gz: f42eda8dd767d1d49abb25ac42b9815c11a5bce20d92b57af8f8dc766ee41dc81fc340a5506844ca02c4017db061d2bfad51335b876bb1cee78fee9f3d0002b3
+  data.tar.gz: 7f7705175f42dc398ce1b2765fa518f848f0a76195c5e20c924d75b67abb0be22e993d6427c0572419aeee5649c4356d03ec02e52852995b3523e5fa1d20beb3

data/CODE_OF_CONDUCT.md

@@ -10,21 +10,21 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div
 
 Examples of behavior that contributes to a positive environment for our community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at wouter.coppieters@employmenthero.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at wc@pico.net.nz. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 
@@ -67,7 +67,7 @@ Community leaders will follow these Community Impact Guidelines in determining t
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within the community.
 

data/README.md

@@ -27,7 +27,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install activerecord-polytypes
 
-## Usage
+## Rationale
 
 Imagine you have a simple Entity model that can be either a User or an Organisation, and it has associated legal documents and a billing plan.
 
@@ -71,9 +71,9 @@ What are our options?
 - - We still have to perform aggregations or filters on subtype attributes in memory.
 - - We leak rigid code-specific strings into our database, making it more difficult to shuffle types.
 
-# This is where ActiveRecordPolytypes provides an alternative mechanism.
+# Use ActiveRecordPolytypes as an alternative mechanism.
 
-# With ActiveRecordPolytypes you can easily query across all subtypes like this:
+With ActiveRecordPolytypes you can easily query across all subtypes like this:
 
 ```ruby
   Entity::Subtype.where("user_created_at > ? OR organisation_country IN (?)", 1.day.ago, %(US)).order(billing_plan_renewal_date: :desc)
@@ -127,6 +127,8 @@ Vs query across all subtypes
   Entity::Subtype.where(...)
 ```
 
+## Usage
+
 All you need to do to install ActiveRecordPolytypes into an existing model, is make a call to `polymorphic_supertype_of` in the model, and pass in the names of the associations that you want to act as subtypes.
 It will work on any existing `belongs_to` or `has_one` association (respecting any non conventional foreign keys, class overrides etc.)
 
@@ -156,6 +158,25 @@ end
 Searchable::Subtype.all # => [#<Searchable::User..., #<Searchable::Post.., #<Searchable::Category.., #<Searchable::User..]
 ```
 
+Subtypes also inherit the relationships of their supertypes, so you can even eager or preload these. E.g.
+
+On the parent type
+
+```ruby
+# Load the user_posts relation for all users. Empty for non users
+# Load the organisation_documents relation for all organisations. Empty for non organisations
+assert Entity::Subtype.preload(:user_posts, :organisation_documents).all? { |s| s.user_posts.loaded? && s.organisation_documents.loaded? }
+assert Entity::Subtype.eager_load(:user_posts, :organisation_documents).all? { |s| s.user_posts.loaded? && s.organisation_documents.loaded? }
+```
+
+On the subtype
+
+```ruby
+# Load the user_posts relation for all users. Empty for non users
+assert Entity::User.preload(:posts).all? { |s| s.posts.loaded? }
+assert Entity::User.eager_load(:posts).all? { |s| s.posts.loaded? }
+```
+
 ## 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/activerecord-polytypes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordPolytypes
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/activerecord-polytypes.rb

@@ -159,10 +159,32 @@ module ActiveRecordPolytypes
         associations.each do |association|
           base_type = association.compute_class(association.class_name)
 
+          base_type.reflect_on_all_associations.each do |assoc|
+            case assoc.macro
+            when :belongs_to
+              subtype_class.belongs_to :"#{association.name}_#{assoc.name}", assoc.scope, **assoc.options, class_name: assoc.class_name
+            when :has_one, :has_many
+              scope = if assoc.options.key?(:as)
+                refined = ->{ where(assoc.type => base_type.name) }
+                if assoc.scope
+                  ->{ instance_exec(&refined).instance_exec(&assoc.scope) }
+                else
+                  refined
+                end
+              else
+                assoc.scope
+              end
+              self.send(assoc.macro, :"#{association.name}_#{assoc.name}", scope, **assoc.options.except(:inverse_of, :destroy, :as), primary_key: "#{association.name}_#{base_type.primary_key}", foreign_key: assoc.foreign_key, class_name: "::#{assoc.class_name}")
+            end
+          end
+        end
+
+        associations.each do |association|
+          base_type = association.compute_class(association.class_name)
           # Generate a class name for the subtype proxy.
           subtype_class_name = "#{supertype_type.name}::#{base_type.name}"
           # Dynamically create a proxy class for the multi-table inheritance.
-          build_mti_proxy_class!(association, base_type, supertype_type)
+          build_mti_proxy_class!(association, base_type, supertype_type, subtype_class)
 
           select_components_by_type[association.name] = base_type.columns.map do |column|
             column_name = "#{association.name}_#{column.name}"
@@ -186,6 +208,7 @@ module ActiveRecordPolytypes
               join_components_by_type[typename]
             ]
           end.transpose
+
           from(<<~SQL)
             (
               SELECT #{table_name}.*,#{select_components * ","}, CASE #{case_components * " "} ELSE '#{name}' END AS type
@@ -200,12 +223,12 @@ module ActiveRecordPolytypes
     end
 
     # Dynamically builds a proxy class for a given association to handle multi-table inheritance.
-    def build_mti_proxy_class!(association, base_type, supertype_type)
+    def build_mti_proxy_class!(association, base_type, supertype_type, subtype_class)
       # Remove any previously defined constant to avoid constant redefinition warnings.
       supertype_type.send(:remove_const, base_type.name) if supertype_type.constants.include?(base_type.name.to_sym)
 
       # Define a new class inherited from the current class acting as the subtype.
-      subtype_class = supertype_type.const_set(base_type.name, Class.new(self))
+      subtype_class = supertype_type.const_set(base_type.name, Class.new(subtype_class))
       subtype_class.class_eval do
         attr_reader :inner
 
@@ -217,9 +240,27 @@ module ActiveRecordPolytypes
         after_save :reload, if: :previously_new_record?
 
         # Define attributes and delegation methods for columns inherited from the base type.
+        base_type.reflect_on_all_associations.each do |assoc|
+          case assoc.macro
+          when :belongs_to
+            belongs_to assoc.name, assoc.scope, **assoc.options, class_name: assoc.class_name
+          when :has_one, :has_many
+            scope = if assoc.options.key?(:as)
+              refined = ->{ where(assoc.type => base_type.name) }
+              if assoc.scope
+                ->{ instance_exec(&refined).instance_exec(&assoc.scope) }
+              else
+                refined
+              end
+            else
+              assoc.scope
+            end
+            self.send(assoc.macro, assoc.name, scope, **assoc.options.except(:inverse_of, :destroy, :as), primary_key: "#{association.name}_#{base_type.primary_key}", foreign_key: assoc.foreign_key, class_name: "::#{assoc.class_name}")
+          end
+        end
         base_type.columns.each do |column|
           column_name = "#{association.name}_#{column.name}"
-          attribute column_name, column.type
+          attribute column_name
           delegate column.name, to: :@inner, allow_nil: true, prefix: association.name
           define_method :"#{column_name}=" do |value|
             case

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-polytypes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Wouter Coppieters
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord