acts_as_tree 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 780f4a181d2e28b847648e7fcacd7e29e29fbea9
-  data.tar.gz: db729268df6e10dbbbfc4626b3c279c4f5a38b4a
+  metadata.gz: 0010c309598e23c144cafccabd21527bcd4b52e0
+  data.tar.gz: dd8825aff3d508e09c8d5f28240e010af7d19716
 SHA512:
-  metadata.gz: 4df9150dac385c3ebcc0e365d7c9031bc6e535f874ff7e5118c476fd455e36d3887a943f37c8299fda98851321ca5bac9deb3deb90a8ec52bf90c9e1eda58ab6
-  data.tar.gz: cabc21ab491173998e506372b08adea1b3ee695ef25cbf4a88ef23e1f34cf9e3d80e54ffe671505a3cb6931df55260baa4b0361ae9b3ea52c1a84e8892cf4e44
+  metadata.gz: 2fed1a5bf286379948f3b11797f46d03b4db877b648f9a28221495e6cde387d75fe6905db99ea84a947c9df72560cc3d1de718cce269e491fd50f6daf195262e
+  data.tar.gz: 0b08f66b4c2ff06faaa9129c662ad4e55f1286dc357bfe435ffe720ee760cd289d482c4dca5b27d5e1cbc173cbb1eb8b46b60ac759eb492d35c8692fa94c6692

data/README.md

@@ -27,7 +27,7 @@ We also have a convenient `TreeView` module you can mixin if you want a little v
 class Category < ActiveRecord::Base
   extend ActsAsTree::TreeView
 
-  acts_as_tree order: "name"
+  acts_as_tree order: 'name'
 end
 
 > Category.tree_view(:name)
@@ -41,6 +41,24 @@ root
 => nil
 ```
 
+And there's a `TreeWalker` module (traversing the tree using depth-first search (default) or breadth-first search) as well. Example given the Model `Page` as
+
+```ruby
+class Page < ActiveRecord::Base
+  extend ActsAsTree::TreeWalker
+
+  acts_as_tree order: 'rank'
+end
+```
+
+In your view you could traverse the tree using
+
+```erb
+<% Page.walk_tree do |page, level| %>
+  <%= link_to "#{'-'*level}#{page.name}", page_path(page) %><br />
+<% end %>
+```
+
 ## Compatibility
 
 We no longer support Ruby 1.8 or versions of Rails/ActiveRecord older than 3.0. If you're using a version of ActiveRecord older than 3.0 please use 0.1.1.
@@ -48,6 +66,8 @@ We no longer support Ruby 1.8 or versions of Rails/ActiveRecord older than 3.0.
 Moving forward we will do our best to support the latest versions of ActiveRecord and Ruby.
 
 ## Change Log
+* 2.1.0 - September 25, 2014
+	* Added TreeWalker. See #30 -- 545ch4
 * 2.0.0 - July 3, 2014
 	* Renamed Presentation module to TreeView, see #27, #28 -- felixbuenemann
 * 1.6.1 - May 29, 2014

data/lib/acts_as_tree.rb

@@ -166,6 +166,51 @@ module ActsAsTree
 
   end
 
+  module TreeWalker
+    # Traverse the tree and call a block with the current node and current
+    # depth-level.
+    #
+    # options:
+    #   algorithm:
+    #     :dfs for depth-first search (default)
+    #     :bfs for breadth-first search
+    #   where: AR where statement to filter certain nodes
+    #
+    # The given block sets two parameters:
+    #   first: The current node
+    #   second: The current depth-level within the tree
+    #
+    # Example of acts_as_tree for model Page (ERB view):
+    # <% Page.walk_tree do |page, level| %>
+    #   <%= link_to "#{' '*level}#{page.name}", page_path(page) %><br />
+    # <% end %>
+    #
+    def walk_tree(_options = {}, level = 0, node = nil, &block)
+      options = {:algorithm => :dfs, :where => {}}.update(_options)
+      case options[:algorithm]
+      when :bfs
+        nodes = (node.nil? ? roots : node.children).where(options[:where])
+        nodes.each do |child|
+          block.call child, level
+        end
+        nodes.each do |child|
+          walk_tree options, level + 1, child, &block
+        end
+      else
+        if node.nil?
+          roots.where(options[:where]).each do |root_node|
+            walk_tree options, level, root_node, &block
+          end
+        else
+          block.call node, level
+          node.children.where(options[:where]).each do |child|
+            walk_tree options, level + 1, child, &block
+          end
+        end
+      end
+    end
+  end
+
   module InstanceMethods
     # Returns list of ancestors, starting from parent until root.
     #

data/lib/acts_as_tree/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTree
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/test/acts_as_tree_test.rb

@@ -264,6 +264,34 @@ class TreeTest < MiniTest::Unit::TestCase
     END
     assert_equal tree_view_outputs, capture_stdout { TreeMixin.tree_view(:id) }
   end
+
+  def test_tree_walker
+    assert_equal false, TreeMixin.respond_to?(:walk_tree)
+    TreeMixin.extend ActsAsTree::TreeWalker
+    assert_equal true,  TreeMixin.respond_to?(:walk_tree)
+
+    walk_tree_dfs_output = <<-END.gsub(/^\s+/, '')
+      1
+      -2
+      --3
+      ---4
+      -5
+      6
+      7
+      END
+    assert_equal walk_tree_dfs_output, capture_stdout { TreeMixin.walk_tree{|elem, level| puts "#{'-'*level}#{elem.id}"} }
+
+    walk_tree_bfs_output = <<-END.gsub(/^\s+/, '')
+      1
+      6
+      7
+      -2
+      -5
+      --3
+      ---4
+      END
+    assert_equal walk_tree_bfs_output, capture_stdout { TreeMixin.walk_tree(:algorithm => :bfs){|elem, level| puts "#{'-'*level}#{elem.id}"} }
+  end
 end
 
 class TestDeepDescendantsPerformance < MiniTest::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tree
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Erik Dahlstrand
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord