acts_as_ordered_tree 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86dc7f385344addb7fa9390045711d13e450e08f
-  data.tar.gz: 00ed12a00031723963094178dc4820cfde4952b2
+  metadata.gz: 8d1d945d226f1b6846fa1b58f24a6adab1d41425
+  data.tar.gz: a894af6acac2e1d1bbc044cc008effc846b5b42a
 SHA512:
-  metadata.gz: 7d7dfc4a087d7cdc79f7f819b4d732cdca4371950421f7b1bad0daf2e355469675a58b5a3f07fa83311dfabbd3892b3db73fd5ffd26fd7a9bb20fbaeea2e4a99
-  data.tar.gz: 8e4647629a8719db47d2875306a28bcea5932d87c2c0a4c5dfd14a5c7020a1bc84b1e2ee41e6b1ef387aec64c204c15ca253a7dc935ec1ad217a8c50a9ebf713
+  metadata.gz: 458af4339a7cdb37ab604344970a7c83264827b62923b90f90e5e607355babd918df26b96897ff91ca2f1b6064f8d0cb6f2d95d1af14c3da6d67cb9cd3ecd060
+  data.tar.gz: 62cd0756ebb2c63518cd73ef53b6163eac7bf1716ebb3d3614217bd2bebe2eefa14109dd87a53ae755032f63ce0c75a24a4f43fd1069b8d5dbca0c7edd970f78

data/lib/acts_as_ordered_tree.rb

@@ -1,8 +1,8 @@
-require "active_record"
-require "acts_as_ordered_tree/version"
-require "acts_as_ordered_tree/class_methods"
-require "acts_as_ordered_tree/instance_methods"
-require "acts_as_ordered_tree/validators"
+require 'active_record'
+require 'acts_as_ordered_tree/version'
+require 'acts_as_ordered_tree/class_methods'
+require 'acts_as_ordered_tree/instance_methods'
+require 'acts_as_ordered_tree/validators'
 
 module ActsAsOrderedTree
   PROTECTED_ATTRIBUTES_SUPPORTED = ActiveRecord::VERSION::STRING < '4.0.0' ||

data/lib/acts_as_ordered_tree/adapters/postgresql_adapter.rb

@@ -1,3 +1,6 @@
+require 'acts_as_ordered_tree/arrangeable'
+require 'acts_as_ordered_tree/relation/preloaded'
+
 module ActsAsOrderedTree
   module Adapters
     module PostgreSQLAdapter
@@ -15,9 +18,10 @@ module ActsAsOrderedTree
           QUERY
 
           with_recursive_join(query, 'self_and_ancestors').
-              order('self_and_ancestors._depth DESC')
+              order('self_and_ancestors._depth DESC').
+              extending(Arrangeable)
         else
-          ancestors + [self]
+          (ancestors + [self]).tap { |ary| ary.extend(Arrangeable) }
         end
       end
 
@@ -33,7 +37,9 @@ module ActsAsOrderedTree
             INNER JOIN ancestors ON alias1.id = ancestors.#{parent_column}
         QUERY
 
-        with_recursive_join(query, 'ancestors').order('ancestors._depth DESC')
+        with_recursive_join(query, 'ancestors').
+            order('ancestors._depth DESC').
+            extending(Arrangeable)
       end
 
       def root
@@ -52,7 +58,8 @@ module ActsAsOrderedTree
         QUERY
 
         with_recursive_join(query, 'descendants').
-            order('descendants._positions ASC')
+            order('descendants._positions ASC').
+            extending(Arrangeable)
       end
 
       def descendants

data/lib/acts_as_ordered_tree/arrangeable.rb

@@ -0,0 +1,80 @@
+module ActsAsOrderedTree
+  module Arrangeable
+    # @api private
+    class Arranger
+      attr_reader :collection, :cache
+
+      def initialize(collection, options = {})
+        @collection = collection
+        @discard_orphans = options[:orphans] == :discard
+        @min_level = nil
+
+        if discard_orphans? && !collection.klass.depth_column && ActiveRecord::Base.logger
+          ActiveRecord::Base.logger.warn {
+            '%s model has no `depth` column, '\
+            'it can lead to N+1 queries during #arrange method invocation' % collection.klass
+          }
+        end
+
+        @cache = Hash.new
+        @prepared = false
+      end
+
+      def arrange
+        prepare unless prepared?
+
+        @arranged ||= collection.each_with_object(Hash.new) do |node, result|
+          ancestors = ancestors(node)
+
+          if discard_orphans?
+            root = ancestors.first || node
+
+            next if root.level > @min_level
+          end
+
+          insertion_point = result
+
+          ancestors.each { |a| insertion_point = (insertion_point[a] ||= {}) }
+
+          insertion_point[node] = {}
+        end
+      end
+
+      private
+      def prepare
+        collection.each do |node|
+          cache[node.id] = node if node.id
+          @min_level = [@min_level, node.level].compact.min
+        end
+
+        @prepared = true
+      end
+
+      def discard_orphans?
+        @discard_orphans
+      end
+
+      def prepared?
+        @prepared
+      end
+
+      # get parent node of +node+
+      def parent(node)
+        cache[node[node.parent_column]]
+      end
+
+      def ancestors(node)
+        parent = parent(node)
+        parent ? ancestors(parent) + [parent] : []
+      end
+    end
+    private_constant :Arranger
+
+    # Arrange associated collection into a nested hash of the form
+    # {node => children}, where children = {} if the node has no children.
+    def arrange(options = {})
+      @arranger ||= Arranger.new(self, options)
+      @arranger.arrange
+    end
+  end
+end

data/lib/acts_as_ordered_tree/instance_methods.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
-require "acts_as_ordered_tree/tenacious_transaction"
-require "acts_as_ordered_tree/relation/preloaded"
+require 'acts_as_ordered_tree/tenacious_transaction'
+require 'acts_as_ordered_tree/relation/preloaded'
+require 'acts_as_ordered_tree/arrangeable'
 
 module ActsAsOrderedTree
   module InstanceMethods
@@ -16,7 +17,7 @@ module ActsAsOrderedTree
       persisted? && if children_counter_cache_column
         self[children_counter_cache_column] == 0
       else
-        children.count == 0
+        !children.reorder(nil).exists?
       end
     end
 
@@ -50,7 +51,8 @@ module ActsAsOrderedTree
 
       # 3. create fake scope
       ActsAsOrderedTree::Relation::Preloaded.new(self.class).
-          where(:id => nodes.map(&:id)).
+          where(:id => nodes.map(&:id).compact).
+          extending(Arrangeable).
           records(nodes)
     end
 
@@ -93,7 +95,8 @@ module ActsAsOrderedTree
       records = fetch_self_and_descendants - [self]
 
       ActsAsOrderedTree::Relation::Preloaded.new(self.class).
-          where(:id => records.map(&:id)).
+          where(:id => records.map(&:id).compact).
+          extending(Arrangeable).
           records(records)
     end
 
@@ -103,6 +106,7 @@ module ActsAsOrderedTree
 
       ActsAsOrderedTree::Relation::Preloaded.new(self.class).
           where(:id => records.map(&:id)).
+          extending(Arrangeable).
           records(records)
     end
 

data/lib/acts_as_ordered_tree/version.rb

@@ -1,3 +1,3 @@
 module ActsAsOrderedTree
-  VERSION = '1.2.1'
+  VERSION = '1.3.1'
 end

data/spec/acts_as_ordered_tree_spec.rb

@@ -415,6 +415,97 @@ describe ActsAsOrderedTree, :transactional do
     end
   end
 
+  describe '#arrange' do
+    shared_examples 'arrangeable' do
+      let(:child_1) { root.children.first }
+      let(:child_2) { root.children.last }
+      let(:grandchild_11) { child_1.children.first }
+      let(:grandchild_12) { child_1.children.last }
+      let(:grandchild_21) { child_2.children.first }
+      let(:grandchild_22) { child_2.children.last }
+
+      specify '#descendants scope should be arrangeable' do
+        expect(root.descendants.arrange).to eq Hash[
+          child_1 => {
+            grandchild_11 => {},
+            grandchild_12 => {}
+          },
+          child_2 => {
+            grandchild_21 => {},
+            grandchild_22 => {}
+          }
+        ]
+      end
+
+      specify '#self_and_descendants should be arrangeable' do
+        expect(root.self_and_descendants.arrange).to eq Hash[
+          root => {
+            child_1 => {
+              grandchild_11 => {},
+              grandchild_12 => {}
+            },
+            child_2 => {
+              grandchild_21 => {},
+              grandchild_22 => {}
+            }
+          }
+        ]
+      end
+
+      specify '#ancestors should be arrangeable' do
+        expect(grandchild_11.ancestors.arrange).to eq Hash[
+          root => {
+            child_1 => {}
+          }
+        ]
+      end
+
+      specify '#self_and_ancestors should be arrangeable' do
+        expect(grandchild_11.self_and_ancestors.arrange).to eq Hash[
+          root => {
+            child_1 => {
+              grandchild_11 => {}
+            }
+          }
+        ]
+      end
+
+      it 'should not discard orphaned nodes by default' do
+        relation = root.descendants.where(root.class.arel_table[:id].not_eq(child_1.id))
+
+        expect(relation.arrange).to eq Hash[
+          grandchild_11 => {},
+          grandchild_12 => {},
+          child_2 => {
+            grandchild_21 => {},
+            grandchild_22 => {}
+          }
+        ]
+      end
+
+      it 'should discard orphans if option :discard passed' do
+        relation = root.descendants.where(root.class.arel_table[:id].not_eq(child_1.id))
+
+        expect(relation.arrange(:orphans => :discard)).to eq Hash[
+          child_2 => {
+            grandchild_21 => {},
+            grandchild_22 => {}
+          }
+        ]
+      end
+    end
+
+    context 'when persisted tree given' do
+      it_should_behave_like 'arrangeable' do
+        let(:root) { create :default }
+
+        before { create_list :default, 2, :parent => root }
+        before { create_list :default, 2, :parent => root.children.first }
+        before { create_list :default, 2, :parent => root.children.last }
+      end
+    end
+  end
+
   describe "move actions" do
     let!(:root) { create :default_with_counter_cache, :name => 'root' }
     let!(:child_1) { create :default_with_counter_cache, :parent => root, :name => 'child_1' }

data/spec/spec_helper.rb

@@ -28,6 +28,7 @@ ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(File.join(test_di
 ActiveRecord::Base.establish_connection(ENV['DB'])
 ActiveRecord::Base.logger = Logger.new(ENV['DEBUG'] ? $stderr : '/dev/null')
 ActiveRecord::Migration.verbose = false
+I18n.enforce_available_locales = false if I18n.respond_to?(:enforce_available_locales=)
 load(File.join(test_dir, 'db', 'schema.rb'))
 
 require 'shoulda-matchers'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_ordered_tree
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Alexei Mikhailov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-23 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ extra_rdoc_files: []
 files:
 - lib/acts_as_ordered_tree.rb
 - lib/acts_as_ordered_tree/adapters/postgresql_adapter.rb
+- lib/acts_as_ordered_tree/arrangeable.rb
 - lib/acts_as_ordered_tree/class_methods.rb
 - lib/acts_as_ordered_tree/instance_methods.rb
 - lib/acts_as_ordered_tree/relation/base.rb