acts_as_associate_tree 0.0.1

data/lib/acts_as_associate_tree.rb

@@ -0,0 +1,193 @@
+##
+# Module
+# ActsAsAssociateTree
+#
+# Used for generating tree-like data
+#
+# Interface: generate_tree_nodes
+#
+# Suppose you have a class like this
+#
+#     class Foo
+#       attr_reader :i
+#       def initialize(i)
+#         @i = i
+#       end
+#
+#       def items
+#         foo_items = []
+#         i.times do |i|
+#           foo_items.push Foo.new("Item" + i.to_s)
+#         end
+#         foo_items
+#       end
+#
+#       class << self
+#         def all
+#           all_foos = []
+#           2.times do |i|
+#             all_foos.push Foo.new(i + 1)
+#           end
+#           all_foos
+#         end
+#       end
+#     end
+#     
+#     generate_tree_nodes do
+#       nodes { Foo.all }
+#       node_attrs { { :text => i } } # invoke this block by the instance_eval
+#                                     # method of each element in nodes
+#       children {
+#         nodes { items }
+#         node_attrs { { :text => i } } # using nodes#element.instance_eval to run this block
+#       }
+#     end
+#
+# it will return a array like bellow:
+#
+#     [{
+#       :text=>1,
+#       :children=>[{
+#         :text=>"Item0",
+#         :leaf=>true
+#       }]
+#     }, {
+#       :text=>2,
+#       :children=>[{
+#         :text=>"Item0",
+#         :leaf=>true
+#       }, {
+#         :text=>"Item1",
+#         :leaf=>true
+#       }]
+#     }]
+#
+# include this module in your controller or model or any of your classes
+# used to generating tree-like datas, you will get a instance function
+# *generate_tree_nodes*, then you could use it this way.
+#
+#     class Parent < ActiveRecord::Base
+#        has_many :children
+#     end
+#     
+#     class Child < ActiveRecord::Base
+#       belongs_to :parent
+#     end
+# 
+# 其数据如下:
+# 
+#     # Parent.all
+#     # +-------+---------+
+#     # | id    | name    |
+#     # +-------+---------+
+#     # | 1     | xx1     |
+#     # | 2     | xx2     |
+#     # | 3     | xx3     |
+#     # | 4     | xx4     |
+#     # | 5     | xx5     |
+#     # +-------+---------+
+#     
+#     # Child.all
+#     # +-------+--------------+--------+
+#     # | id    | parent_id    | name   |
+#     # +-------+--------------+--------+
+#     # | 1     | 1            | xx0    |
+#     # | 2     | 1            | xx1    |
+#     # | 3     | 1            | xx2    |
+#     # | 4     | 2            | xx0    |
+#     # | 5     | 2            | xx1    |
+#     # +-------+--------------+--------+
+# 
+#     class ParentController < ApplicationController
+#       include ActsAsAssociateTree
+#       
+#       # GET /parent/index_tree.json
+#       def index_tree
+#         special_tag = 'special_tag'
+#         render :josn => generate_tree_nodes {
+#           # 一个树可以有不同的结点集
+#           add_set {
+#             nodes { Parent.all }  # 结点的数据，block的执行结果需返回一个数组
+#             node_attrs { { :name => name } }  # 结点属性，block执行结果需返回一个Hash实例，block 中可以执行任何一个 Parent 实例能执行的方法
+#             children { 
+#               nodes { children }  # 在子结点中可以执行任何一个 Parent 实例能执行的方法
+#               node_attrs { { :name => name, :special => id == 1 ? special_tag : 'nothing' } }  # 每一个 block 中都能访问闭包变量，如 special_tag
+#             }
+#             # 可以添加多个子节点
+#             children {
+#               nodes { [1, 2, 3, 4, 5] }
+#               node_attrs { { :name => self } }
+#             }
+#           }
+#           # 其他结点集
+#           add_set {
+#             set_attrs { { :text => 'i am a tree nodes set' } }  # 可以添加结点集描述
+#             nodes { %w(act_as_associate_tree is so powerful) }
+#             node_attrs { { :text => self } }
+#           }
+#         }
+#       end
+#     end
+# 
+# *index_tree* 方法会返回如下形式的数据
+# 
+#     [{:name=>"xx1",
+#       :children=>
+#        [{:name=>"xx0", :special=>"special_tag", :leaf=>true},
+#         {:name=>"xx1", :special=>"nothing", :leaf=>true},
+#         {:name=>"xx2", :special=>"nothing", :leaf=>true},
+#         {:name=>1, :leaf=>true},
+#         {:name=>2, :leaf=>true},
+#         {:name=>3, :leaf=>true},
+#         {:name=>4, :leaf=>true},
+#         {:name=>5, :leaf=>true}]},
+#      {:name=>"xx2",
+#       :children=>
+#        [{:name=>"xx0", :special=>"nothing", :leaf=>true},
+#         {:name=>"xx1", :special=>"nothing", :leaf=>true},
+#         {:name=>1, :leaf=>true},
+#         {:name=>2, :leaf=>true},
+#         {:name=>3, :leaf=>true},
+#         {:name=>4, :leaf=>true},
+#         {:name=>5, :leaf=>true}]},
+#      {:name=>"xx3",
+#       :children=>
+#        [{:name=>1, :leaf=>true},
+#         {:name=>2, :leaf=>true},
+#         {:name=>3, :leaf=>true},
+#         {:name=>4, :leaf=>true},
+#         {:name=>5, :leaf=>true}]},
+#      {:name=>"xx4",
+#       :children=>
+#        [{:name=>1, :leaf=>true},
+#         {:name=>2, :leaf=>true},
+#         {:name=>3, :leaf=>true},
+#         {:name=>4, :leaf=>true},
+#         {:name=>5, :leaf=>true}]},
+#      {:name=>"xx5",
+#       :children=>
+#        [{:name=>1, :leaf=>true},
+#         {:name=>2, :leaf=>true},
+#         {:name=>3, :leaf=>true},
+#         {:name=>4, :leaf=>true},
+#         {:name=>5, :leaf=>true}]},
+#      {:text=>"i am a tree nodes set",
+#       :children=>
+#        [{:text=>"act_as_associate_tree", :leaf=>true},
+#         {:text=>"is", :leaf=>true},
+#         {:text=>"so", :leaf=>true},
+#         {:text=>"powerful", :leaf=>true}]}]
+#
+require_relative 'acts_as_associate_tree/node_set.rb'
+require_relative 'acts_as_associate_tree/set_tree.rb'
+
+module ActsAsAssociateTree
+  class ConfigurationError < Exception; end
+  
+  ##
+  # act_as_associate_tree 的统一接口，传入结点构造器后，产生结点
+  def generate_tree_nodes &block
+    (SetTree.new.instance_eval &block).expand
+  end
+  module_function :generate_tree_nodes
+end

data/lib/acts_as_associate_tree/node_set.rb

@@ -0,0 +1,107 @@
+module ActsAsAssociateTree
+  class NodeSet
+    attr_reader :children_sets, :nodes_block, :node_attrs_block, :set_block, :set_attrs_block
+    attr_reader :set_symbol, :expandable, :mother_tree, :parent_set  # for 'symbol' feature
+    def initialize(mother_tree, parent_set = nil, &block)
+      @children_sets = []
+      @set_symbol = ''
+      @mother_tree = mother_tree
+      @expandable = true
+      @parent_set = parent_set
+      
+      self.instance_eval &block
+    end
+    
+    # with symbol setting, you would be able to generate only a part of a tree instead of a whole one
+    def symbol(sym)
+      raise ConfigurationError.new('symbol Must be a SYMBOL') unless sym.kind_of? Symbol
+      @set_symbol = sym
+      return if mother_tree.expanding_symbol == :all
+      @expandable = false
+      enable_expanding if mother_tree.expanding_symbol == @set_symbol
+    end
+    
+    # resymbolize
+    # def resymbol
+    #   symbol set_symbol
+    # end
+    
+    def enable_expanding
+      @expandable = true
+      parent_set.enable_expanding unless parent_set.nil?
+    end
+
+    ##
+    # 树集的属性
+    # block 的执行结果需返回一个 hash
+    def set_attrs(&block)
+      @set_attrs_block = block
+    end
+    
+    ##
+    # 节点集合
+    def nodes(&block)
+      @nodes_block = block
+    end
+
+    ##
+    # 节点属性
+    # block 的执行结果需返回一个 hash
+    def node_attrs(&block)
+      @node_attrs_block = block
+    end
+
+    ##
+    # 子节点属性
+    def children(&block)
+      @children_sets << NodeSet.new(mother_tree, self, &block)
+    end
+    
+    def expandable?
+      expandable
+    end
+    
+    ##
+    # 展开树集
+    def expand(parent_scope = Object)
+      return [] unless expandable?
+      nodes = parent_scope.instance_eval &nodes_block
+      # Expand child set of each node
+      expanded_set = nodes.map do |node|
+        node_attrs = generate_node_attrs(node)
+        expand_node_children_set(node, node_attrs)
+      end
+      # Wrap a set around the expaned set
+      expanded_set = set_up_set_attributes(parent_scope, expanded_set) unless set_attrs_block.nil?
+
+      expanded_set
+    end
+
+    private
+      def generate_node_attrs(node)
+        attrs = node.instance_eval &node_attrs_block
+        raise ConfigurationError.new("Node attributes isn't a HASH INSTANCE") unless attrs.kind_of?(Hash)
+        attrs
+      end
+
+      def expand_node_children_set(node, node_attrs)
+        node_attrs[:children] = []
+        children_sets.each do |children_set|
+          node_attrs[:children] += children_set.expand(node)
+        end
+        if node_attrs[:children].empty?
+          node_attrs.delete(:children)
+          node_attrs[:leaf] = true
+        end
+
+        node_attrs
+      end
+
+      def set_up_set_attributes(parent_scope, expanded_set)
+        set_attrs = parent_scope.instance_eval &set_attrs_block
+        raise ConfigurationError.new("Set attributes isn't a HASH INSTANCE") unless set_attrs.kind_of?(Hash)
+        set_attrs[:children] = expanded_set
+        [set_attrs]
+      end
+  end
+end

data/lib/acts_as_associate_tree/set_tree.rb

@@ -0,0 +1,47 @@
+module ActsAsAssociateTree
+  class SetTree
+    attr_reader :root
+    def initialize
+      @node_sets = []
+      @expanding_symbol = :all
+    end
+  
+    ##
+    # 添加根节点，如果不需要根节点，可以不添加，节点类型需为一个哈希
+    def enroot(root)
+      raise ConfigurationError.new("Root configuration should be a HASH INSTANCE") unless root.kind_of?(Hash)
+      @root = root
+    end
+  
+    # expanding_symbol = :all || :set_symbol
+    def expanding_symbol(type = nil)
+      return @expanding_symbol if type.nil?
+      raise ConfigurationError.new('expanding_symbol Must be a SYMBOL') unless type.kind_of? Symbol
+      @expanding_symbol = type
+    end
+
+    ##
+    # 添加一个新的节点集
+    def add_set(&set_block)
+      @node_sets << NodeSet.new(self, &set_block)
+      self
+    end
+
+    ##
+    # 展开所有的节点集
+    def expand
+      # Expand all node sets
+      expanded_node_sets = []
+      @node_sets.each do |node_set|
+        expanded_node_sets += node_set.expand
+      end
+      # set up root attributes
+      unless @root.nil?
+        @root[:children] = expanded_node_sets
+        expanded_node_sets = @root
+      end
+
+      expanded_node_sets
+    end
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_associate_tree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin_lu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-13 00:00:00.000000000 Z
+dependencies: []
+description: organize a tree data
+email: gdjyluxiaoyong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acts_as_associate_tree.rb
+- lib/acts_as_associate_tree/node_set.rb
+- lib/acts_as_associate_tree/set_tree.rb
+homepage: http://rubygems.org/gems/acts_as_associate_tree
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: tree data
+test_files: []