acts_as_recursive_tree 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 064f977e7f4e77083f3a967fce16c6c47fc29ee9
-  data.tar.gz: 2b8e5949381e248c33034868ee816126367e19bd
+SHA256:
+  metadata.gz: a28e3f6eadbc8b37622ef525b25e654b13c0903f4053adb096f4f853f36ccc06
+  data.tar.gz: f2614872c77bf263526ac596bbb82438b75af1e49e393c6464e07515c5605288
 SHA512:
-  metadata.gz: 91e3f8cdf111f4efed5618391d806ccab6e5bdb2c8e5325862292e23a67d990aaa86de199dfffabade3f0ee6a18ba501d9032e9a700b9dba567eb75e0d6265ec
-  data.tar.gz: cb6576280d42539dc013e96b07414cae5ad49b416a28518c742731fb43697ec9fc997da237cf8f0cbc5f53c01bf530fd37353bb3108cf9e1e06313c2174aecc9
+  metadata.gz: 9a4ccf41395828283e882f8e88b6e9c8a7edea75995219840d2c6d07da69bbb8bb6f15aeec6cddf8a105f4f8ad15d3dfddad2bf7aaeead54074fffa28030bd68
+  data.tar.gz: c48904528902e0554d1a46dea5883afcc28473597f4df2493ccf1015e80967b2490cae5f41fb5dac9eb7925a2c9d00feeb9637b902366e3dc1be0d6dddc3c7ab

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### Version 2.1.0
+- BUGFIX association self_and_siblings not working
+- BUGFIX primary_key of model is retrieved on first usage and not on setup
+- NEW when no ordering/depth is required, then use subselect instead of joining the temp table
+
 ### Version 2.0.2
 - fix for condition relation was executed before merging
 

data/lib/acts_as_recursive_tree.rb

@@ -4,6 +4,7 @@ require_relative 'acts_as_recursive_tree/railtie' if defined?(Rails)
 module ActsAsRecursiveTree
   extend ActiveSupport::Autoload
 
+  autoload :Config
   autoload :ActsMacro
   autoload :Model
   autoload :Associations

data/lib/acts_as_recursive_tree/acts_macro.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 module ActsAsRecursiveTree
   module ActsMacro
 
@@ -11,11 +9,10 @@ module ActsAsRecursiveTree
     def recursive_tree(parent_key: :parent_id, parent_type_column: nil)
 
       class_attribute :_recursive_tree_config
-      self._recursive_tree_config = OpenStruct.new(
-        primary_key:        self.primary_key.to_sym,
+      self._recursive_tree_config = Config.new(
+        model_class:        self,
         parent_key:         parent_key.to_sym,
-        parent_type_column: parent_type_column.try(:to_sym),
-        depth_column:       :recursive_depth
+        parent_type_column: parent_type_column.try(:to_sym)
       )
 
       include ActsAsRecursiveTree::Model

data/lib/acts_as_recursive_tree/associations.rb

@@ -17,9 +17,9 @@ module ActsAsRecursiveTree
                inverse_of:  :parent
 
       has_many :self_and_siblings,
-               class_name:  self.base_class.to_s,
-               primary_key: self._recursive_tree_config.parent_key,
-               foreign_key: self._recursive_tree_config.parent_key
+               through: :parent,
+               source: :children,
+               class_name:  self.base_class.to_s
     end
   end
 end

data/lib/acts_as_recursive_tree/builders.rb

@@ -5,6 +5,7 @@ module ActsAsRecursiveTree
     autoload :Values
     autoload :DepthCondition
     autoload :QueryOptions
+    autoload :Strategy
     autoload :RelationBuilder
     autoload :Descendants
     autoload :Ancestors

data/lib/acts_as_recursive_tree/builders/leaves.rb

@@ -2,7 +2,7 @@ module ActsAsRecursiveTree
   module Builders
     class Leaves < Descendants
 
-      def create_select_manger
+      def create_select_manger(column = nil)
         select_manager = super
 
         select_manager.where(

data/lib/acts_as_recursive_tree/builders/relation_builder.rb

@@ -1,5 +1,8 @@
 module ActsAsRecursiveTree
   module Builders
+    #
+    # Constructs the Arel necessary for recursion.
+    #
     class RelationBuilder
 
       def self.build(klass, ids, exclude_ids: false, &block)
@@ -9,6 +12,7 @@ module ActsAsRecursiveTree
       attr_reader :klass, :ids, :recursive_temp_table, :travers_loc_table, :without_ids
       mattr_reader(:random) { Random.new }
 
+      # Delegators for easier accessing config and query options
       delegate :primary_key, :depth_column, :parent_key, :parent_type_column, to: :@config
       delegate :depth_present?, :depth, :condition, :ensure_ordering, to: :@query_opts
 
@@ -25,6 +29,13 @@ module ActsAsRecursiveTree
         @travers_loc_table    = Arel::Table.new("traverse_#{rand_int}_loc")
       end
 
+      #
+      # Constructs a new QueryOptions and yield it to the proc if one is present.
+      # Subclasses may override this method to provide sane defaults.
+      #
+      # @param proc [Proc] a proc or nil
+      #
+      # @return [ActsAsRecursiveTree::Options::QueryOptions] the new QueryOptions instance
       def get_query_options(proc)
         opts = ActsAsRecursiveTree::Options::QueryOptions.new
 
@@ -38,18 +49,9 @@ module ActsAsRecursiveTree
       end
 
       def build
-        final_select_mgr = base_table.join(
-          create_select_manger.as(recursive_temp_table.name)
-        ).on(
-          base_table[primary_key].eq(recursive_temp_table[primary_key])
-        )
-
-        relation = klass.joins(final_select_mgr.join_sources)
+        relation = Strategy.for_query_options(@query_opts).build(self)
 
         relation = apply_except_id(relation)
-        relation = apply_depth(relation)
-        relation = apply_order(relation)
-
         relation
       end
 
@@ -69,8 +71,14 @@ module ActsAsRecursiveTree
         relation.order(recursive_temp_table[depth_column].asc)
       end
 
-      def create_select_manger
-        travers_loc_table.project(Arel.star).with(:recursive, build_cte_table)
+      def create_select_manger(column = nil)
+        projections = if column
+          travers_loc_table[column]
+        else
+          Arel.star
+        end
+
+        travers_loc_table.project(projections).with(:recursive, build_cte_table)
       end
 
       def build_cte_table
@@ -125,6 +133,9 @@ module ActsAsRecursiveTree
         relation.merge(condition)
       end
 
+      #
+      # U
+      #
       def build_join_condition
         raise 'not implemented'
       end

data/lib/acts_as_recursive_tree/builders/strategy.rb

@@ -0,0 +1,27 @@
+module ActsAsRecursiveTree
+  module Builders
+    #
+    # Strategy module for different strategies of how to build the resulting query.
+    #
+    module Strategy
+      extend ActiveSupport::Autoload
+
+      autoload :Join
+      autoload :Subselect
+
+      #
+      # Returns a Strategy appropriate for query_opts
+      #
+      # @param query_opts [ActsAsRecursiveTree::Options::QueryOptions]
+      #
+      # @return a strategy class best suited for the opts
+      def self.for_query_options(query_opts)
+        if query_opts.depth_present? || query_opts.ensure_ordering
+          Join
+        else
+          Subselect
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_recursive_tree/builders/strategy/join.rb

@@ -0,0 +1,29 @@
+module ActsAsRecursiveTree
+  module Builders
+    module Strategy
+      #
+      # Build a relation using an INNER JOIN.
+      #
+      module Join
+        #
+        # Builds the relation.
+        #
+        # @param builder [ActsAsRecursiveTree::Builders::RelationBuilder]
+        # @return [ActiveRecord::Relation]
+        def self.build(builder)
+          final_select_mgr = builder.base_table.join(
+            builder.create_select_manger.as(builder.recursive_temp_table.name)
+          ).on(
+            builder.base_table[builder.primary_key].eq(builder.recursive_temp_table[builder.primary_key])
+          )
+
+          relation = builder.klass.joins(final_select_mgr.join_sources)
+
+          relation = builder.apply_depth(relation)
+          relation = builder.apply_order(relation)
+          relation
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_recursive_tree/builders/strategy/subselect.rb

@@ -0,0 +1,23 @@
+module ActsAsRecursiveTree
+  module Builders
+    module Strategy
+      #
+      # Strategy for building a relation using an WHERE ID IN(...).
+      #
+      module Subselect
+        #
+        # Builds the relation.
+        #
+        # @param builder [ActsAsRecursiveTree::Builders::RelationBuilder]
+        # @return [ActiveRecord::Relation]
+        def self.build(builder)
+          builder.klass.where(
+            builder.base_table[builder.primary_key].in(
+              builder.create_select_manger(builder.primary_key)
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_recursive_tree/config.rb

@@ -0,0 +1,22 @@
+module ActsAsRecursiveTree
+  #
+  # Stores the configuration of one Model class
+  #
+  class Config
+    attr_reader :parent_key, :parent_type_column, :depth_column
+
+    def initialize(model_class:, parent_key:, parent_type_column:, depth_column: :recursive_depth)
+      @model_class        = model_class
+      @parent_key         = parent_key
+      @parent_type_column = parent_type_column
+      @depth_column       = depth_column
+    end
+
+    #
+    # Returns the primary key for the model class.
+    # @return [Symbol]
+    def primary_key
+      @primary_key ||= @model_class.primary_key.to_sym
+    end
+  end
+end

data/lib/acts_as_recursive_tree/version.rb

@@ -1,3 +1,3 @@
 module ActsAsRecursiveTree
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_recursive_tree
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Wolfgang Wedelich-John
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -127,6 +127,10 @@ files:
 - lib/acts_as_recursive_tree/builders/descendants.rb
 - lib/acts_as_recursive_tree/builders/leaves.rb
 - lib/acts_as_recursive_tree/builders/relation_builder.rb
+- lib/acts_as_recursive_tree/builders/strategy.rb
+- lib/acts_as_recursive_tree/builders/strategy/join.rb
+- lib/acts_as_recursive_tree/builders/strategy/subselect.rb
+- lib/acts_as_recursive_tree/config.rb
 - lib/acts_as_recursive_tree/model.rb
 - lib/acts_as_recursive_tree/options.rb
 - lib/acts_as_recursive_tree/options/depth_condition.rb
@@ -165,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Drop in replacement for acts_as_tree but using recursive queries
@@ -180,4 +184,3 @@ test_files:
 - spec/model/relation_spec.rb
 - spec/spec_helper.rb
 - spec/values_spec.rb
-has_rdoc: