tree_view 0.1.8 → 0.2

data/README.md

@@ -23,6 +23,7 @@ rails g tree_view:install
 
 include necessary javascript and stylesheet files.
 
+Add these files to your application.js
 ```ruby
 //= require jquery.dimensions.min.js
 //= require jquery.drawinglibrary.js
@@ -30,6 +31,10 @@ include necessary javascript and stylesheet files.
 //= require tree_view.drawline.js
 ```
 
+Add the stylesheet to your application.css
+```ruby
+//= require tree_view
+```
 Example
 =======
 
@@ -47,9 +52,22 @@ In View
 <%= tree_view(@root) %>
 ```
 
+To customise the content or each view you can simple pass a block and can 
+
 API Doc
 =======
 
-Coming soon...
+```ruby
+# generate html tree view helper
+#
+# @param root      [model instance] the root node of the tree structure
+# @param opt       [Hash]           the options to generate tree nodes
+#       :css       [String]         the wrapper div's css
+#       :drawline  [true, false]    whether draw lines among each nodes
+#       :node_css  [String]         the css for each node
+#       :order_by  [sym]            the order of the children
+# @param &block    [code block]     if you want to customise the content of each tree node, just passing a code block
+def tree_view(root, opt = {}, &block)
+```
 
 Copyright (c) 2011 Ben Zhang, released under the MIT license

data/lib/assets/stylesheets/tree_view.sass

@@ -1,6 +1,3 @@
-.hidden
-  display: none
-
 .tree-list, .tree-list ul
   list-style: none
 

data/lib/tree_view/version.rb

@@ -1,3 +1,3 @@
 module TreeView
-  VERSION = "0.1.8"
+  VERSION = "0.2"
 end

data/lib/tree_view/view_helpers/action_view.rb

@@ -1,7 +1,15 @@
 module TreeView
   
   module ActionView
-    
+    # generate html tree view helper
+    #
+    # @param root      [model instance] the root node of the tree structure
+    # @param opt       [Hash]           the options to generate tree nodes
+    #       :css       [String]         the wrapper div's css
+    #       :drawline  [true, false]    whether draw lines among each nodes
+    #       :node_css  [String]         the css for each node
+    #       :order_by  [sym]            the order of the children
+    # @param &block    [code block]     if you want to customise the content of each tree node, just passing a code block
     def tree_view(root, opt = {}, &block)
       css = opt[:css] || "treeview"    
       drawline = opt.has_key?(:drawline) ? opt[:drawline] : true
@@ -23,9 +31,7 @@ module TreeView
       if block_given?
         content = capture(root, &block)
       else
-        content = <<-EOF
-        #{image_position root.entry_type}<a href="#">#{root.entry_type == 'root' ? 'Organisation Chart' : truncate(root.name, :length => 20)}</a>
-        EOF
+        content = "<a href='#'>#{truncate(root.name, :length => 20)}</a>"
       end
       result, script = "", ""
       html = <<-EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tree_view
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000 Z
+date: 2012-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2155888860 !ruby/object:Gem::Requirement
+  requirement: &2151806360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155888860
+  version_requirements: *2151806360
 description: view helper to generate tree view chart
 email:
 - bzbnhang@gmail.com