adjustable_schema 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9fab61b2df51275e0e3c9ebf681dc48a30378a48248b1f02c7bad89afc47075
-  data.tar.gz: 266abb846dba3f7119dd424f855e77942d3ffc98b012b44d2210902cff32a604
+  metadata.gz: 5a26450a562fbcde4b87abd3a84e85f577d3c1a7c9f8ecfdf22b79728875f1e6
+  data.tar.gz: b2cda5f212ae129a97b92a80440f8e053af2c44d5c54676e2358da3230cb987a
 SHA512:
-  metadata.gz: 9f2b270be59abff4ada4cfc1d9146f00bcbf43c8473588e23f411b71a5daf4f1928e1c075da4b3d4112e1883245249a5a6f42c5bbff148663ceca5fed8492bbe
-  data.tar.gz: f9ea77c562420ed47c701f963d2fcc9d7835ead91411e7e150944d9d9a9ba49a09b6bdc5ea44c4bcf7bf73e98e9767b8eb383b493f8d5f5aaae1821a4f10cf6c
+  metadata.gz: 1bf5d1bcef25e17cdbfc7de6d1f4f0278571169e9416d96fa4542ae654ea236184b39fa162938870d085a5afc496beac98e8a6a48ad311e69a277a97eb2f01d8
+  data.tar.gz: '099e2973293293635d6a1a1cda5a3105363e5c42dedc14cc30f07fc967870b6586da29dd4443e2ab37ee7b93059e063e538a8f3c39bc98308354342f5398a3bb'

data/README.md

@@ -56,10 +56,12 @@ book.editor_people
 
 #### Special cases
 
-In case you have set up relations with a `User` model you'll get a slightly different naming:
+##### "Actor-like" models
+
+In case you have set up relationships with `User` model you'll get a slightly different naming:
 
 ``` ruby
-AdjustableSchema::Relationship.seed! User => Book, %w[author editor]
+AdjustableSchema::Relationship.seed! User => Book, roles: %w[author editor]
 ```
 
 ``` ruby
@@ -71,11 +73,42 @@ book.editors
 The list of models to be handled this way can be set with `actor_model_names` configuration parameter.
 It includes `User` by default.
 
-###### TODO
+##### Self-referencing models
+
+You may want to set up self-targeted relationships:
+
+``` ruby
+AdjustableSchema::Relationship.seed! Person, roles: %w[friend]
+```
+
+In this case you'll get these associations:
+
+``` ruby
+person.parents
+person.children # for all the children
+person.people   # for "roleless" children, not friends
+person.friends
+person.friended_people
+```
+
+If you prefer a different naming over `parents` & `children`, you can configure it like this:
 
-* Describe self-referential associations.
+```ruby
+AdjustableSchema::Engine.configure do
+  config.names[:associations][:source][:self] = :effect
+  config.names[:associations][:target][:self] = :cause
+end
+```
+
+Thus, for the self-referenced `Event`s, you'll get:
+
+``` ruby
+event.causes
+event.effects
+```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -83,13 +116,15 @@ gem "adjustable_schema"
 ```
 
 And then execute:
+
 ```bash
-$ bundle
+bundle
 ```
 
 Or install it yourself as:
+
 ```bash
-$ gem install adjustable_schema
+gem install adjustable_schema
 ```
 
 ## Contributing
@@ -101,4 +136,5 @@ $ gem install adjustable_schema
 5. Create new Pull Request
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/db/migrate/01_create_adjustable_schema_relationship_tables.rb

@@ -4,7 +4,7 @@ class CreateAdjustableSchemaRelationshipTables < ActiveRecord::Migration[7.1]
 		primary_key_type, foreign_key_type = primary_and_foreign_key_types
 
 		create_table :adjustable_schema_relationship_roles do |t|
-			t.string :name, index: { unique: true }
+			t.string :name, null: false, index: { unique: true }
 
 			t.timestamps
 		end
@@ -17,13 +17,20 @@ class CreateAdjustableSchemaRelationshipTables < ActiveRecord::Migration[7.1]
 
 			t.timestamps
 
-			t.index %i[
+			%i[
 					source_id source_type
 					target_id target_type
 					role_id
 			].tap { |columns|
-					columns.reject! { _1.ends_with? '_type' } if foreign_key_type == :uuid # OPTIMIZATION: IDs are unique
-			}, unique: true, name: :index_adjustable_schema_relationships_uniqueness
+				columns.reject! { _1.ends_with? '_type' } if foreign_key_type == :uuid # OPTIMIZATION: IDs are unique
+
+				# NULLS are DISTINCT by default.
+				# One can use `ADD CONSTRAINT … UNIQUE NULLS NOT DISTINCT (…)` instead
+				t.index columns,
+						unique: true, where: 'role_id IS NOT NULL', name: :index_adjustable_schema_relationships_uniqueness_with_role
+				t.index columns.excluding(:role_id),
+						unique: true, where: 'role_id IS     NULL', name: :index_adjustable_schema_relationships_uniqueness_without_role
+			}
 		end
 	end
 

data/lib/adjustable_schema/active_record/association/naming.rb

@@ -9,7 +9,9 @@ module AdjustableSchema
 				module Inflections
 					refine String do
 						def passivize
-							sub(/(e?d?|ing|[eo]r|ant|(t)ion)$/, '\\2ed')
+							self
+									.sub(/(author)$/, '\\2ed')
+									.sub(/(e*|ed|ing|[eo]r|ant|(t)ion)$/, '\\2ed')
 						end
 					end
 				end
@@ -36,7 +38,7 @@ module AdjustableSchema
 				private
 
 				memoize def name_with_role
-					if self_targeted?
+					if recursive?
 						{
 								source: role.name,
 								target: "#{role.name.passivize}_#{target_name}",
@@ -50,13 +52,16 @@ module AdjustableSchema
 				end
 
 				memoize def name_without_role
-					if self_targeted?
+					if recursive?
 						Config.association_directions
-								.self_related[direction]
+								.self[direction]
 					else
 						target_name
 					end
 				end
+
+				def name_for_any  = :"#{name.to_s.singularize.passivize}"
+				def name_for_none = :"#{name.to_s.singularize}less"
 			end
 		end
 	end

data/lib/adjustable_schema/active_record/association.rb

@@ -15,19 +15,24 @@ module AdjustableSchema
 							class_name:  target.name
 					}) do
 						include Scopes
-						include Scopes::Recursive if association.self_targeted?
+						include Scopes::Recursive if association.recursive?
 					end
 
+					define_scopes
+					define_methods
+
 					unless role
-						has_many target_name.tableize.to_sym, -> { roleless }, **options if
-								self_targeted?
+						# HACK: using `try` to overcome a Rails bug
+						# (see https://github.com/rails/rails/issues/40109)
+						has_many target_name.tableize.to_sym, -> { try :roleless }, **options if
+								recursive?
 
 						define_role_methods
 					end
 				end
 			end
 
-			def self_targeted? = target == owner
+			def recursive? = target == owner
 
 			private
 
@@ -40,6 +45,29 @@ module AdjustableSchema
 				end
 			end
 
+			def define_scopes
+				name = relationships_name
+
+				{
+						name_for_any  => -> { where.associated name },
+						name_for_none => -> { where.missing    name },
+				}
+						.reject { owner.singleton_class.method_defined? _1 }
+						.each   { owner.scope _1, _2 }
+			end
+
+			def define_methods
+				name = self.name
+
+				{
+						name_for_any  => -> { send(name).any?  },
+						name_for_none => -> { send(name).none? },
+				}
+						.transform_keys {"#{_1}?" }
+						.reject { owner.method_defined? _1 }
+						.each   { owner.define_method _1, &_2 }
+			end
+
 			def define_role_methods
 				name = self.name
 

data/lib/adjustable_schema/config.rb

@@ -19,11 +19,11 @@ module AdjustableSchema
 				end
 			end
 
-			def self_related = config :self_related
+			def self = config :self
 
 			def recursive
 				config.values.to_h do
-					[ _1[:self_related].to_s.pluralize.to_sym, _1[:recursive].to_sym ]
+					[ _1[:self].to_s.pluralize.to_sym, _1[:recursive].to_sym ]
 				end
 			end
 

data/lib/adjustable_schema/engine.rb

@@ -7,16 +7,19 @@ module AdjustableSchema
 		config.names = {
 				associations: {
 						source: {
-								shortcut:     :of,
-								self_related: :child,
-								recursive:    :descendants,
+								shortcut:  :of,
+								self:      :child,
+								recursive: :descendants,
 						},
 						target: {
-								shortcut:     :to,
-								self_related: :parent,
-								recursive:    :ancestors,
+								shortcut:  :to,
+								self:      :parent,
+								recursive: :ancestors,
 						},
 				},
 		}
+
+		config.active_record
+				.automatically_invert_plural_associations = true
 	end
 end

data/lib/adjustable_schema/version.rb

@@ -1,3 +1,3 @@
 module AdjustableSchema
-	VERSION = '0.6.0'
+	VERSION = '0.7.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adjustable_schema
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Alexander Senko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,7 +111,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Alexander-Senko/adjustable_schema
   source_code_uri: https://github.com/Alexander-Senko/adjustable_schema
-  changelog_uri: https://github.com/Alexander-Senko/adjustable_schema/blob/v0.6.0/CHANGELOG.md
+  changelog_uri: https://github.com/Alexander-Senko/adjustable_schema/blob/v0.7.1/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Adjustable data schemas for Rails