adjustable_schema 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4525066ba26fd96f436d9e4620260becf28e8dade751b5caee3b56aa00791211
-  data.tar.gz: 7f3d844b8be42f563aaf20fcf5b0b1519efc7a9b7e465fb2e06231a57be68326
+  metadata.gz: 2857a886692a24ac2506137f2962966e6bbcde416b8b3fed091e0fc219a8b81a
+  data.tar.gz: f46a4a33c5f3cb201bfdcebbd54c6e1854c3b1f21eb44ba1a05befea056c8d47
 SHA512:
-  metadata.gz: 1bd658b2800d4d355057e5d17e032b1eee417dd5a74537cc24fb50dfd42a6785423a71c437e536ad2885ae5d0b78ce498aa9efe4f8367eace50b78f314d5cbd6
-  data.tar.gz: 263cdad0cf81bfb3b1a050ef98c78d4738019732b262aa23a08a759e8ef07e25e9110af092ad6ba54e28ad7356be7b64da103d4438b28822ed077529bc8be0a3
+  metadata.gz: 44e84ec51c7d255d309499fad94e346062d7cb07164d202148f71c9e54ab8f00fd18d728053e504405fbc01860b1213a35d128dc81f1be2fa0ec6d357340b512
+  data.tar.gz: deb4ad146c70fd8ccd8eafbe943d49f68e8ce4526afc7e8ec44adad3e0cb937c3c1e82f394775b36405bb9312f4324f4760dc417e8c34a767ffaa11e5a166ea1

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## [0.11.1] — 2025-05-19
+
+### Fixed
+
+- Associations setup for inherited models got broken in v0.11.0.
+
+
+## [0.11.0] — 2025-05-09
+
+### Changed
+
+- Deprecated `Relationship.seed!` in favor of `AdjustableSchema.relationship!`.
+- Special naming rules for “actor-like” models:
+	switched from `<associat>ful` form to check for related records’ presence back to a passive one (`<associat>ed`).
+	Thus, it’s `authored` and `edited` now instead of `authorful` and `editful`.
+- `Relationship.to`/`.of` handle STI classes precisely instead of falling back to a base class.
+- Customized inspections for `Relationship`.
+
+### Added
+
+- `referencing`/`referenced_by` scopes to filter by related records.
+- `#referencing!`/`#referenced_by!` setters to add related records.
+- Short-cut methods for related records.
+	For example, `authors` association provides the following extras:
+	- `.authored_by` scope to filter records by authors,
+	- `#authored_by?` — to check if the record is authored by provided ones,
+	- `#authored_by!` — to add an author.
+
+
 ## [0.10.0] — 2025-04-23
 
 ### Changed

data/README.md

@@ -1,5 +1,15 @@
 # Adjustable Schema for Rails
 
+![GitHub Actions Workflow Status](
+https://img.shields.io/github/actions/workflow/status/Alexander-Senko/adjustable_schema/ci.yml
+)
+![Code Climate maintainability](
+https://img.shields.io/codeclimate/maintainability-percentage/Alexander-Senko/adjustable_schema
+)
+![Code Climate coverage](
+https://img.shields.io/codeclimate/coverage/Alexander-Senko/adjustable_schema
+)
+
 Define your model associations in the database without changing the schema or models.
 
 This Rails Engine was renamed and refactored from [Rails Dynamic Associations](https://github.com/Alexander-Senko/rails_dynamic_associations).
@@ -24,7 +34,7 @@ AdjustableSchema::Relationship.create! source_type: 'Person',
 Or use a helper method:
 
 ``` ruby
-AdjustableSchema::Relationship.seed! Person => Book
+AdjustableSchema.relationship! Person => Book
 ```
 
 Now you have:
@@ -39,7 +49,7 @@ book.people
 You can create multiple role-based associations between two models.
 
 ``` ruby
-AdjustableSchema::Relationship.seed! Person => Book, roles: %w[author editor]
+AdjustableSchema.relationship! Person => Book, roles: %w[author editor]
 ```
 
 You will get:
@@ -61,7 +71,7 @@ book.editor_people
 In case you have set up relationships with `User` model you'll get a slightly different naming:
 
 ``` ruby
-AdjustableSchema::Relationship.seed! User => Book, roles: %w[author editor]
+AdjustableSchema.relationship! User => Book, roles: %w[author editor]
 ```
 
 ``` ruby
@@ -87,7 +97,7 @@ end
 You may want to set up recursive relationships:
 
 ``` ruby
-AdjustableSchema::Relationship.seed! Person, roles: %w[friend]
+AdjustableSchema.relationship! Person, roles: %w[friend]
 ```
 
 In this case you'll get these associations:

data/app/models/adjustable_schema/relationship.rb

@@ -38,9 +38,9 @@ module AdjustableSchema
 				case object
 				when ::ActiveRecord::Base, nil
 					where association => object
-				when Class
-					where "#{association}_type" => object.ancestors
-							.grep(..object.base_class)
+				when ...::ActiveRecord::Base
+					where "#{association}_type" => object.descendants
+							.including(object)
 							.map(&:name)
 				when ::ActiveRecord::Relation
 					send(method, object.klass)
@@ -99,27 +99,13 @@ module AdjustableSchema
 						.reduce &:or
 			end
 
-			def seed! *models, roles: [], **mapping # rubocop:disable Metrics
-				return seed!({ **Hash[*models], **mapping }, roles:) if mapping.any? # support keyword arguments syntax
-
-				case models
-				in [
-						String | Symbol | Class => source_type,
-						String | Symbol | Class => target_type,
-				]
-					roles
-							.map { |name| Role.find_or_create_by! name: }
-							.then { it.presence or [ nil ] } # no roles => nameless relationship
-							.map { |role| create! source_type:, target_type:, role: }
-				in [ Hash => models ]
-					for sources, targets in models do
-						for source, target in Array(sources).product Array(targets) do
-							seed! source, target, roles:
-						end
-					end
-				in [ Class => source ]
-					seed! source, source, roles: # recursive
-				end
+			def seed!(...)
+				AdjustableSchema.deprecator.warn <<~TEXT.squish
+					#{self}.#{__method__} is deprecated and will be removed in v0.12.
+					Please use AdjustableSchema.relationship! instead.
+				TEXT
+
+				AdjustableSchema.relationship!(...)
 			end
 		end
 
@@ -131,5 +117,19 @@ module AdjustableSchema
 		end
 
 		def abstract? = not (source or target)
+
+		def inspect
+			<<~TEXT.chomp.gsub(/-+/, '-')
+				#<#{self.class}##{id}: #{
+						source_type
+				}#{
+						source_id&.then { "##{it}" }
+				}>-#{name}->#{
+						target_type unless target_type == source_type and target_id
+				}#{
+						target_id&.then { "##{it}" }
+				}>
+			TEXT
+		end
 	end
 end

data/app/models/concerns/adjustable_schema/active_record/associations.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
+require 'memery'
+
 module AdjustableSchema
 	module ActiveRecord # :nodoc:
 		concern :Associations do
 			class_methods do
-				private
+				include Memery
+
+				protected
+
+				memoize def adjust_associations
+					adjust_parent_associations
 
-				def adjust_associations
 					relationships
 							.flat_map do |direction, relationships|
 								relationships
@@ -19,6 +25,17 @@ module AdjustableSchema
 							&.tap do # finally, if any relationships have been set up
 								include Relationships::InstanceMethods
 							end
+							&.size # optimization
+				end
+
+				private
+
+				def adjust_parent_associations
+					return unless superclass < Associations
+
+					superclass.adjust_associations
+
+					_reflections.reverse_merge! superclass._reflections # update
 				end
 
 				def setup_association direction, target = self, role = nil

data/app/models/concerns/adjustable_schema/active_record/relationships/builder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module AdjustableSchema
+	module ActiveRecord
+		module Relationships
+			module Builder # :nodoc:
+				private
+
+				def define_reference_scope direction, name
+					scope name, -> records, role: ANY do
+						joins(relationships = :"#{direction}_relationships")
+								.distinct
+								.where(
+										relationships => { id: Relationship
+												.send(Config.shortcuts[direction], records) # [to|of]: records
+												.then do
+													case role
+													when ANY
+														it
+													when nil
+														it.nameless
+													else
+														it.named *role
+													end
+												end,
+										},
+								)
+					end
+				end
+
+				def define_reference_setter direction, name
+					define_method "#{name}!" do |records, **options|
+						reference! direction => records, **options
+					end
+				end
+
+				def define_recursive_method association_name, method
+					define_method method do
+						send(association_name)
+								.recursive
+					end
+				end
+			end
+		end
+	end
+end

data/app/models/concerns/adjustable_schema/active_record/relationships.rb

@@ -5,35 +5,44 @@ require 'memery'
 module AdjustableSchema
 	module ActiveRecord # :nodoc:
 		concern :Relationships do
+			ANY = Object.new
+
 			class_methods do
 				include Memery
 
 				memoize def relationships
-					Config.association_directions.index_with do
-						Relationship.abstract.send Config.shortcuts.opposite[it], self
-					end
+					Config.association_directions
+							.with_opposite
+							.transform_values do
+								Relationship.abstract
+										.where "#{it}_type": name
+							end
 				end
 
 				def roles(&) = Role.of self, &
-
-				private
-
-				def define_recursive_methods association_name, method
-					define_method method do
-						send(association_name)
-								.recursive
-					end
-				end
 			end
 
 			concern :InstanceMethods do # to include when needed
 				included do
 					scope :roleless, -> { merge Relationship.nameless }
 
+					extend Relationships::Builder
+
+					Config.association_directions.references
+							.select { reflect_on_association "#{_1}_relationships" }
+							.tap do
+								it
+										.reject { respond_to? _2 }
+										.each   { define_reference_scope _1, _2 }
+								it
+										.reject { method_defined? "#{_2}!" }
+										.each   { define_reference_setter _1, _2 }
+							end
+
 					Config.association_directions.recursive
 							.select { reflect_on_association _1 }
 							.reject { method_defined? _2 }
-							.each   { define_recursive_methods _1, _2 }
+							.each   { define_recursive_method _1, _2 }
 				end
 
 				def related?(...)
@@ -43,7 +52,6 @@ module AdjustableSchema
 
 				def related(...)
 					relationships(...)
-							.preload(Config.association_directions)
 							.map do |relationship|
 								Config.association_directions
 										.map { relationship.send it } # both objects
@@ -62,10 +70,26 @@ module AdjustableSchema
 								.map { relationships_to it }
 								.reduce(&:or)
 					end
+							.preload(Config.association_directions)
 				end
 
 				private
 
+				def reference! source: self, target: self, role: nil
+					role &&= Relationship::Role[role]
+
+					[ source, target ]
+							.map { Array it }
+							.reduce(&:product)
+							.each do |source, target|
+								Relationship.create! source:, target:, role:
+							rescue ::ActiveRecord::RecordNotUnique
+								# That’s OK, it’s already there
+							end
+
+					self # for chainability
+				end
+
 				def relationships_to direction
 					try "#{direction}_relationships" or
 							Relationship.none

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

@@ -44,6 +44,10 @@ module AdjustableSchema
 							source: role.name,
 							target: "#{role.name.passivize}_#{target_name}",
 					}[direction]
+
+					def name_for_any(name = object_name) = name
+							.passivize
+							.to_sym
 				end
 
 				def initialize(...)
@@ -87,8 +91,6 @@ module AdjustableSchema
 
 				def name_without_role = target_name
 
-				def roleless_name = name(target_name)
-
 				def name_for_any (name = object_name) = :"#{name}ful"
 				def name_for_none(name = object_name) = :"#{name}less"
 			end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module AdjustableSchema
+	module ActiveRecord
+		module Association::Referenced # :nodoc:
+			private
+
+			def scopes
+				role = self.role.name # save the context
+
+				{
+						**super,
+
+						referenced_name => -> { referenced_by it, role: },
+				}
+			end
+
+			def flags
+				name = self.name # save the context
+
+				{
+						**super,
+
+						referenced_name => -> { it.in? send name },
+				}
+			end
+
+			def setters
+				role = self.role.name # save the context
+
+				{
+						**super,
+
+						referenced_name => -> { referenced_by! it, role: },
+				}
+			end
+
+			using Association::Inflections
+
+			def referenced_name = :"#{object_name.passivize}_by"
+		end
+	end
+end

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

@@ -22,6 +22,8 @@ module AdjustableSchema
 							.merge Relationship.named *roles
 				end
 			end
+
+			def roleless_name = name target_name
 		end
 	end
 end

data/lib/adjustable_schema/active_record/association.rb

@@ -15,14 +15,22 @@ module AdjustableSchema
 			require_relative 'association/scopes'
 			require_relative 'association/roleless'
 			require_relative 'association/hierarchy'
+			require_relative 'association/referenced'
 
 			include Memery
 
+			class << self
+				include Memery
+
+				memoize :new # unique
+			end
+
 			def initialize(...)
 				super
 
-				extend Roleless  if roleless?
-				extend Hierarchy if hierarchy?
+				extend Roleless   if roleless?
+				extend Hierarchy  if hierarchy?
+				extend Referenced if source? and role and target.actor?
 			end
 
 			def define
@@ -31,7 +39,7 @@ module AdjustableSchema
 				has_many name, **options do
 					include Scopes
 					include Scopes::Recursive if association.recursive?
-				end
+				end or return
 
 				define_scopes
 				define_methods
@@ -58,13 +66,15 @@ module AdjustableSchema
 
 			def define_scopes
 				scopes
-						.reject { owner.singleton_class.method_defined? _1 }
+						.reject { owner.respond_to? _1 }
 						.each   { owner.scope _1, _2 }
 			end
 
 			def define_methods
-				flags
-						.transform_keys { :"#{it}?" }
+				{
+						**flag_methods,
+						**setter_methods,
+				}
 						.reject { owner.method_defined? _1 }
 						.each   { owner.define_method _1, &_2 }
 			end
@@ -93,6 +103,14 @@ module AdjustableSchema
 				}
 			end
 
+			def flag_methods = flags
+					.transform_keys { :"#{it}?" }
+
+			def setters = {}
+
+			def setter_methods = setters
+					.transform_keys { :"#{it}!" }
+
 			memoize def options = {
 					through:     define_relationships,
 					source:      direction,

data/lib/adjustable_schema/active_record/builder.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AdjustableSchema
+	module ActiveRecord
+		module Builder # :nodoc:
+			def relationship! *models, roles: [], **mapping
+				return relationship!({ **Hash[*models], **mapping }, roles:) if
+						mapping.any? # support keyword arguments syntax
+
+				case models
+				in [
+						String | Symbol | Class => source,
+						String | Symbol | Class => target,
+				]
+					define_relationship source, target,
+							roles:
+				in [ Hash => models ]
+					define_relationships models,
+							roles:
+				in [ String | Symbol | Class => model ]
+					define_recursive_relationship model,
+							roles:
+				end
+			end
+
+			def role! name
+				Relationship::Role.find_or_create_by! name:
+			end
+
+			private
+
+			def define_recursive_relationship model, roles: []
+				define_relationship model, model, roles:
+			end
+
+			def define_relationships models, roles: []
+				models
+						.flat_map { it.map { Array it }.reduce &:product }
+						.each { define_relationship *it, roles: }
+			end
+
+			def define_relationship source_type, target_type, roles: []
+				roles
+						.map { role! it }
+						.then { it.presence or [ nil ] } # no roles => nameless relationship
+						.map { |role| Relationship.create! source_type:, target_type:, role: }
+			end
+		end
+	end
+end

data/lib/adjustable_schema/active_record.rb

@@ -3,6 +3,7 @@
 module AdjustableSchema
 	module ActiveRecord # :nodoc:
 		autoload :Association, 'adjustable_schema/active_record/association'
+		autoload :Builder,     'adjustable_schema/active_record/builder'
 
 		ActiveSupport.on_load :active_record do
 			include Associations

data/lib/adjustable_schema/config.rb

@@ -21,7 +21,8 @@ module AdjustableSchema
 				end
 			end
 
-			def self = config :self
+			def self       = config :self
+			def references = config :reference
 
 			def recursive
 				config.values.to_h do
@@ -33,6 +34,10 @@ module AdjustableSchema
 				grep_v(to).sole
 			end
 
+			def with_opposite
+				index_with { opposite to: it }
+			end
+
 			private
 
 			def config section = nil

data/lib/adjustable_schema/engine.rb

@@ -11,11 +11,13 @@ module AdjustableSchema
 						source: {
 								shortcut:  :of,
 								self:      :child,
+								reference: :referenced_by,
 								recursive: :descendants,
 						},
 						target: {
 								shortcut:  :to,
 								self:      :parent,
+								reference: :referencing,
 								recursive: :ancestors,
 						},
 				},

data/lib/adjustable_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdjustableSchema
-	VERSION = '0.10.0'
+	VERSION = '0.11.1'
 end

data/lib/adjustable_schema.rb

@@ -9,9 +9,15 @@ require 'rails_model_load_hook' # should be loaded
 module AdjustableSchema # :nodoc:
 	autoload :Config, 'adjustable_schema/config'
 
+	extend ActiveRecord::Builder
+
 	module_function
 
 	def available?
 		Relationship.table_exists?
 	end
+
+	def deprecator # :nodoc:
+		@deprecator ||= ActiveSupport::Deprecation.new
+	end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: adjustable_schema
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Alexander Senko
 bindir: bin
 cert_chain: []
-date: 2025-04-23 00:00:00.000000000 Z
+date: 2025-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,6 +82,7 @@ files:
 - app/models/adjustable_schema/relationship/role.rb
 - app/models/concerns/adjustable_schema/active_record/associations.rb
 - app/models/concerns/adjustable_schema/active_record/relationships.rb
+- app/models/concerns/adjustable_schema/active_record/relationships/builder.rb
 - app/models/concerns/adjustable_schema/actors.rb
 - config/initializers/associations.rb
 - config/initializers/model_names.rb
@@ -91,8 +92,10 @@ files:
 - lib/adjustable_schema/active_record/association.rb
 - lib/adjustable_schema/active_record/association/hierarchy.rb
 - lib/adjustable_schema/active_record/association/naming.rb
+- lib/adjustable_schema/active_record/association/referenced.rb
 - lib/adjustable_schema/active_record/association/roleless.rb
 - lib/adjustable_schema/active_record/association/scopes.rb
+- lib/adjustable_schema/active_record/builder.rb
 - lib/adjustable_schema/authors.rb
 - lib/adjustable_schema/config.rb
 - lib/adjustable_schema/engine.rb
@@ -104,7 +107,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.10.0/CHANGELOG.md
+  changelog_uri: https://github.com/Alexander-Senko/adjustable_schema/blob/v0.11.1/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib