advanced_relationship_management 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f221df65f0856c3c8b946e80ecda01dd2a32557497ea66d9e3bee45e9fe7b24
+  data.tar.gz: e32baec528fab08a83c1f84cec9b844e65fc76e7ee7bea63d5e5100f778edc7e
+SHA512:
+  metadata.gz: 513d6327b555cde3e42101a92ddf79e8fd0b7fa00edc3e190c042733b59ac6c2d9257c76b690b430fe2b39cd672a302fc4e8662bfb00041d34f87464823ebda3
+  data.tar.gz: c9a7f3608959234358bde548208b5541cb2d8f82aac5c8e5650131e0a6743473073a76cb22d89c61aa52f97ffd22b5e74802ead2995837e575a5d6b10fbb62bb

data/lib/advanced_relationship_management/advanced_scoping.rb

@@ -0,0 +1,25 @@
+module AdvancedRelationshipManagement
+    module AdvancedScoping
+      extend ActiveSupport::Concern
+  
+      included do
+        scope :roots, -> { where(parent_id: nil) }
+        scope :by_depth, ->(depth) { where("depth <= ?", depth) }
+  
+        def depth
+          if AdvancedRelationshipManagement.enable_caching
+            Rails.cache.fetch([self, "depth"]) { calculate_depth }
+          else
+            calculate_depth
+          end
+        end
+  
+        def calculate_depth
+          ancestors.size
+        end
+  
+        scope :with_min_descendants, ->(min) { select { |record| record.descendants.size >= min } }
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/configuration.rb

@@ -0,0 +1,16 @@
+module AdvancedRelationshipManagement
+    module Configuration
+      extend ActiveSupport::Concern
+  
+      included do
+        mattr_accessor :default_parent_column, :default_child_column, :enable_caching
+      end
+  
+      module ClassMethods
+        def configure
+          yield self
+        end
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/counts.rb

@@ -0,0 +1,14 @@
+module AdvancedRelationshipManagement
+    module Counts
+      extend ActiveSupport::Concern
+  
+      def ancestor_count
+        ancestors.size
+      end
+  
+      def descendant_count
+        descendants.size
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/cycle_detection.rb

@@ -0,0 +1,16 @@
+module AdvancedRelationshipManagement
+    module CycleDetection
+      extend ActiveSupport::Concern
+  
+      included do
+        validate :no_cycles
+      end
+  
+      def no_cycles
+        if ancestors.include?(self)
+          errors.add(:base, "Cycle detected in the hierarchy")
+        end
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/filter_scope.rb

@@ -0,0 +1,12 @@
+module AdvancedRelationshipManagement
+    module FilterScope
+      extend ActiveSupport::Concern
+  
+      module ClassMethods
+        def filter_scope(name, scope_block)
+          scope name, scope_block
+        end
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/lazy_loading.rb

@@ -0,0 +1,19 @@
+module AdvancedRelationshipManagement
+    module LazyLoading
+      extend ActiveSupport::Concern
+  
+      included do
+        scope :lazy_load_children, -> { includes(:children) }
+        scope :lazy_load_parent, -> { includes(:parent) }
+      end
+  
+      def lazy_descendants
+        self.class.lazy_load_children.where("#{self.class.parent_column_name} = ?", self.id)
+      end
+  
+      def lazy_ancestors
+        self.class.lazy_load_parent.where("#{self.class.child_column_name} = ?", self.id)
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/path_to_root.rb

@@ -0,0 +1,33 @@
+module AdvancedRelationshipManagement
+    module PathToRoot
+      extend ActiveSupport::Concern
+  
+      def path_to_root(format: :array, attribute: :id)
+        path = []
+        current_node = self
+        while current_node
+          path << current_node
+          current_node = current_node.parent
+        end
+        path.reverse!
+  
+        case format
+        when :array
+          path
+        when :symbolic
+          path.map { |node| node.public_send(attribute) }.join(' -> ')
+        when :json
+          path.map { |node| { id: node.id, attribute => node.public_send(attribute) } }.to_json
+        when :html
+          path.map { |node| "<a href='/users/#{node.id}'>#{node.public_send(attribute)}</a>" }.join(' > ')
+        when :reverse_symbolic
+          path.map { |node| node.public_send(attribute) }.reverse.join(' -> ')
+        when :nested_hash
+          path.inject(nil) { |acc, node| { id: node.id, attribute => node.public_send(attribute), parent: acc } }
+        else
+          raise ArgumentError, "Unsupported format: #{format}"
+        end
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/railtie.rb

@@ -0,0 +1,7 @@
+require 'rails/railtie'
+
+module AdvancedRelationshipManagement
+  class Railtie < Rails::Railtie
+    railtie_name :advanced_relationship_management
+  end
+end

data/lib/advanced_relationship_management/recursive_relationships.rb

@@ -0,0 +1,98 @@
+  module AdvancedRelationshipManagement
+    module RecursiveRelationships
+      extend ActiveSupport::Concern
+  
+      included do
+        after_initialize :setup_recursive_relationships
+        after_create :clear_cache
+        after_update :clear_cache
+        after_destroy :clear_cache
+      end
+  
+      def setup_recursive_relationships
+        return if self.class.reflect_on_association(:children) && self.class.reflect_on_association(:parent)
+  
+        parent_column = self.class.parent_column_name
+        self.class.setup_relationships(parent_column)
+      end
+  
+      def descendants(*scopes)
+        if AdvancedRelationshipManagement.enable_caching
+          Rails.cache.fetch([self, "descendants"] + scopes) { fetch_descendants(*scopes) }
+        else
+          fetch_descendants(*scopes)
+        end
+      end
+  
+      def fetch_descendants(*scopes)
+        relation = self.class.find_by_sql([<<-SQL, id])
+          WITH RECURSIVE descendants_cte AS (
+            SELECT *
+            FROM #{self.class.table_name}
+            WHERE #{self.class.child_column_name} = ?
+            UNION ALL
+            SELECT #{self.class.table_name}.*
+            FROM #{self.class.table_name}
+            INNER JOIN descendants_cte ON descendants_cte.#{self.class.child_column_name} = #{self.class.table_name}.#{self.class.parent_column_name}
+          )
+          SELECT *
+          FROM descendants_cte
+        SQL
+  
+        scopes.each do |scope|
+          relation = relation.public_send(scope) if scope.is_a?(Symbol)
+          relation = relation.merge(scope) if scope.is_a?(ActiveRecord::Relation)
+        end
+  
+        relation
+      end
+  
+      def ancestors
+        if AdvancedRelationshipManagement.enable_caching
+          Rails.cache.fetch([self, "ancestors"]) { fetch_ancestors }
+        else
+          fetch_ancestors
+        end
+      end
+  
+      def fetch_ancestors
+        all_ancestors = []
+        ActiveRecord::Base.silence do
+          current_node = self
+          while current_node.parent
+            all_ancestors << current_node.parent
+            current_node = current_node.parent
+          end
+        end
+        all_ancestors
+      end
+  
+      def depth_of_descendants
+        descendants_with_depth = {}
+        descendants.each do |descendant|
+          descendants_with_depth[descendant] = depth(descendant)
+        end
+        descendants_with_depth
+      end
+  
+      def depth_of_ancestors
+        ancestors_with_depth = {}
+        ancestors.each do |ancestor|
+          ancestors_with_depth[ancestor] = depth(ancestor)
+        end
+        ancestors_with_depth
+      end
+  
+      def depth(node)
+        node.ancestors.size
+      end
+  
+      private
+  
+      def clear_cache
+        Rails.cache.delete([self, "descendants"])
+        Rails.cache.delete([self, "ancestors"])
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/relationship_visualizations.rb

@@ -0,0 +1,11 @@
+module AdvancedRelationshipManagement
+    module RelationshipVisualizations
+      extend ActiveSupport::Concern
+  
+      def visualize_relationships
+        # graph = graph() 
+        # graph.write_to_graphic_file('png', 'relationship_graph')
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/sibling_relationships.rb

@@ -0,0 +1,12 @@
+module AdvancedRelationshipManagement
+    module SiblingRelationships
+      extend ActiveSupport::Concern
+  
+      def siblings
+        return [] if parent.nil?
+  
+        parent.children.where.not(id: self.id)
+      end
+    end
+  end
+  

data/lib/advanced_relationship_management/version.rb

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

data/lib/advanced_relationship_management.rb

@@ -0,0 +1,88 @@
+require 'active_support/concern'
+require 'active_record'
+require_relative 'advanced_relationship_management/recursive_relationships'
+require_relative 'advanced_relationship_management/relationship_visualizations'
+require_relative 'advanced_relationship_management/advanced_scoping'
+require_relative 'advanced_relationship_management/cycle_detection'
+require_relative 'advanced_relationship_management/sibling_relationships'
+require_relative 'advanced_relationship_management/counts'
+require_relative 'advanced_relationship_management/path_to_root'
+require_relative 'advanced_relationship_management/filter_scope'
+require_relative 'advanced_relationship_management/lazy_loading'
+
+module AdvancedRelationshipManagement
+  extend ActiveSupport::Concern
+
+  mattr_accessor :default_parent_column, :default_child_column, :enable_caching
+
+  self.default_parent_column = :parent_id
+  self.default_child_column = :id
+  self.enable_caching = true
+
+  included do
+    include AdvancedRelationshipManagement::RecursiveRelationships
+    include AdvancedRelationshipManagement::RelationshipVisualizations
+    include AdvancedRelationshipManagement::AdvancedScoping
+    include AdvancedRelationshipManagement::CycleDetection
+    include AdvancedRelationshipManagement::SiblingRelationships
+    include AdvancedRelationshipManagement::Counts
+    include AdvancedRelationshipManagement::PathToRoot
+    include AdvancedRelationshipManagement::FilterScope
+    include AdvancedRelationshipManagement::LazyLoading
+  end
+
+  class_methods do
+    def setup_relationships(parent_column = nil, child_column = nil)
+      parent_column ||= AdvancedRelationshipManagement.default_parent_column
+      child_column ||= AdvancedRelationshipManagement.default_child_column
+
+      has_many :children, class_name: name, foreign_key: parent_column, inverse_of: :parent
+      belongs_to :parent, class_name: name, foreign_key: parent_column, optional: true
+    end
+
+    def configure_relationships(parent_column: :parent_id, child_column: :id, enable_caching: true)
+      @parent_column = parent_column
+      @child_column = child_column
+      AdvancedRelationshipManagement.enable_caching = enable_caching
+      setup_relationships(parent_column, child_column)
+    end
+
+    def parent_column(column_name)
+      @parent_column = column_name
+      setup_relationships(column_name, @child_column)
+    end
+
+    def child_column(column_name)
+      @child_column = column_name
+      setup_relationships(@parent_column, column_name)
+    end
+
+    def enable_caching?
+      AdvancedRelationshipManagement.enable_caching
+    end
+
+    def enable_caching(enable)
+      AdvancedRelationshipManagement.enable_caching = enable
+    end
+
+    def parent_column_name
+      @parent_column || AdvancedRelationshipManagement.default_parent_column
+    end
+
+    def child_column_name
+      @child_column || AdvancedRelationshipManagement.default_child_column
+    end
+  end
+end
+
+module ActiveRecord
+  class Base
+    def self.silence
+      old_logger = ActiveRecord::Base.logger
+      ActiveRecord::Base.logger = nil
+      yield
+    ensure
+      ActiveRecord::Base.logger = old_logger
+    end
+  end
+end

data/lib/generators/advanced_relationship_management/install/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module AdvancedRelationshipManagement
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_migration
+        migration_template "create_graph_edges_migration.rb", "db/migrate/create_graph_edges.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end

data/lib/generators/advanced_relationship_management/install/templates/create_graph_edges_migration.rb

@@ -0,0 +1,10 @@
+class CreateGraphEdges < ActiveRecord::Migration[6.0]
+    def change
+      create_table :graph_edges do |t|
+        t.references :source, polymorphic: true, null: false
+        t.references :target, polymorphic: true, null: false
+        t.timestamps
+      end
+    end
+  end
+  

data/lib/tasks/advanced_relationship_management_tasks.rake

@@ -0,0 +1,7 @@
+namespace :advanced_relationship_management do
+    desc "Install AdvancedRelationshipManagement"
+    task install: :environment do
+      Rails::Generators.invoke("advanced_relationship_management:install")
+    end
+  end
+  

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: advanced_relationship_management
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rgl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+description: A gem to manage complex relationships, including recursive and graph-based
+  relationships, for ActiveRecord models in Rails.
+email:
+- shanmugamjanarthan24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/advanced_relationship_management.rb
+- lib/advanced_relationship_management/advanced_scoping.rb
+- lib/advanced_relationship_management/configuration.rb
+- lib/advanced_relationship_management/counts.rb
+- lib/advanced_relationship_management/cycle_detection.rb
+- lib/advanced_relationship_management/filter_scope.rb
+- lib/advanced_relationship_management/lazy_loading.rb
+- lib/advanced_relationship_management/path_to_root.rb
+- lib/advanced_relationship_management/railtie.rb
+- lib/advanced_relationship_management/recursive_relationships.rb
+- lib/advanced_relationship_management/relationship_visualizations.rb
+- lib/advanced_relationship_management/sibling_relationships.rb
+- lib/advanced_relationship_management/version.rb
+- lib/generators/advanced_relationship_management/install/install_generator.rb
+- lib/generators/advanced_relationship_management/install/templates/create_graph_edges_migration.rb
+- lib/tasks/advanced_relationship_management_tasks.rake
+homepage: https://github.com/janarthanan-shanmugam/advanced_relationship_management
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/janarthanan-shanmugam/advanced_relationship_management
+  source_code_uri: https://github.com/janarthanan-shanmugam/advanced_relationship_management
+  changelog_uri: https://github.com/janarthanan-shanmugam/advanced_relationship_management
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key: 
+specification_version: 4
+summary: Advanced Relationship Management for ActiveRecord Models
+test_files: []