hierarchable 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cbb9e575443a02be4dff5614306785def4eecb5a7738af39261a9001de4739c
-  data.tar.gz: fb740c37795bafefbb095ce5e0bf1a0cf42b80771976f79dda4919b87bd4b3da
+  metadata.gz: f108839bd5cf2491856dfdcc1af95e0d50204f32e467c22bb3f4925d0028f5be
+  data.tar.gz: 2379a67ad164232c8efb8c33f8ca6117c6e51387feb39585b4e114ce16542736
 SHA512:
-  metadata.gz: b63216b7d4c1887f8787f3775ab4f4781be9103723db3c132a1c5b87ed504ebe97129cec288662aff04e9d7755a5f567e6eb3a54b8a4a29d88fd5fb9f521582f
-  data.tar.gz: 71dee24abbeced1a0b5f13d0f8f8b0aa8bc6863f77a3f3c47e6286d7dfd77a1a4fbf8e8bb68c8dab95e9d17be3d28ddbcaa6d9ee55d34d658f6fba9db0ef97c5
+  metadata.gz: 88822385da9430f6183eafbc4873a7b3009461d733768453212c3abaf615bca2e318da1c36ac3fb9a4d46bdb072fcd07655069a9148a314212915e205f34baa0
+  data.tar.gz: bc9b0a309a1e31d7da843ff2ed5f1e75384f9812f63bde5d759018f72de51ebab45e8ea32d45f79cd7f12451d56b439bb69b32b2af0cbc06ee62eeab17ca7d44

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hierarchable (0.2.0)
+    hierarchable (0.2.1)
       activerecord (> 4.2.0)
       activesupport (> 4.2.0)
 

data/README.md

@@ -183,15 +183,25 @@ project.hierarchy_descendants(models: :this)
 task.hierarchy_siblings
 ```
 
-In order to figure out the potential descendants of an object we need to inspect the object and query all relations to to see if any of those have this object as an ancestor. In most cases these relations can be inferred correctly by getting all of the `has_many` relationships that a model has defined. However there are times when we need to manually add a child relation to be inspected. This can be done in one of two ways.
+In order to figure out the potential descendants of an object we need to inspect the object and query all relations to to see if any of those have this object as an ancestor. In many cases these relations can be inferred correctly by getting all of the `has_many` relationships that a model has defined. To be safe and not return potential duplicate associations, the only associations that are automatically detected are the ones that are the pluralized form of the model name. 
 
-The most common case is if we want to specify additional associations. This will take all of the associations that can be auto-detected and also add in the one provided.
+```ruby
+class Project
+  has_many :tasks
+  has_many :completed_tasks, -> { completed }, class_name: 'Task'
+  has_many :timestamps, class_name: 'MetricLibrary::Timestamp`
+end
+```
+
+In the `Project` model defined above, only the `:tasks` association will be used for finding descendants.
+
+However there are times when we need to manually add a child relation to be inspected. This can be done in one of two ways. The most common case is if we want to specify additional associations. This will take all of the associations that can be auto-detected and also add in the one provided.
 
 ```ruby
 class SomeObject
   include Hierarched
   hierarched parent_source: :parent,
-              additional_descendant_associations: [:some_association]
+             additional_descendant_associations: [:some_association]
 end
 ```
 
@@ -201,7 +211,7 @@ There may also be a case when we want exact control over what associations that
 class SomeObject
   include Hierarched
   hierarched parent_source: :parent,
-              descendant_associations: [:some_association]
+             descendant_associations: [:some_association]
 end
 ```
 

data/lib/hierarchable/hierarchable.rb

@@ -77,7 +77,7 @@ module Hierarchable
       self.hierarchable_config = {
         parent_source: opts.fetch(:parent_source, nil),
         additional_descendant_associations: opts.fetch(
-          :descendant_associations, []
+          :additional_descendant_associations, []
         ),
         descendant_associations: opts.fetch(:descendant_associations, nil),
         path_separator: opts.fetch(
@@ -382,10 +382,10 @@ module Hierarchable
                     hierarchy_root_id: id
                   )
                 else
-                  path = public_send(:hierarchy_ancestors_path)
+                  path = public_send(:hierarchy_full_path)
                   model.where(
                     'hierarchy_ancestors_path LIKE ?',
-                    "#{model.sanitize_sql_like(path)}_%"
+                    "#{model.sanitize_sql_like(path)}%"
                   )
                 end
         if model == self.class
@@ -421,10 +421,14 @@ module Hierarchable
     # Return all of the `has_many` association names this class class has as a
     # list of symbols.
     #
-    # The assumption is that all of the associations we care about for
-    # getting descendants can easily be obtained directly from inspecting
-    # the class. If there are some associations that need to be manually
-    # added, one simply specify them when setting up the model.
+    # In order to be safe and not return potential duplicate associations,
+    # the only associations that are automatically
+    # detected are the ones that are the pluralized form of the model name.
+    # For example, if a model as the association `has_many :tasks`, there
+    # will need to be a Task model for this association to be kept.
+    #
+    # If there are some associations that need to be manually
+    # added, one simply needs to specify them when setting up the model.
     #
     # The most common case is if we want to specify additional associations.
     # This will take all of the associations that can be auto-detected and
@@ -458,7 +462,7 @@ module Hierarchable
             .reject(&:through_reflection?)
             .map(&:name)
       associations += hierarchable_config[:additional_descendant_associations]
-      associations
+      associations.uniq
     end
 
     # Return the string representation of the current object in the format when

data/lib/hierarchable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hierarchable
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hierarchable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Patrick R. Schmid
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-22 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler