tree_decorator 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rob Nichols
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+TreeDecorator
+=============
+
+TreeDecorator has been designed to make it easier to decorate trees or nested
+sets of data. The tools provided, walk through a hash or nested object and 
+apply code to containers and elements based on user defined rules.
+
+For example:
+
+    class Thing < ActiveRecord::Base
+      acts_as_nested_set
+
+      def name
+        @name
+      end
+    end
+
+    hanger = TreeDecorator::ObjectHanger.new(
+              Thing.roots.first,
+              :children_method => :children,
+              :content_method => :name
+            )
+
+    hanger.outer   {|content| "<ul>#{content}</ul>"}
+    hanger.inner   {|content| "<li>#{content}</li>"}
+    hanger.element {|content| "<span class=\"thing\">#{content}</span>"}
+
+    hanger.tree  #----> outputs a nested HTML unordered list with each thing's name 
+                 #      in a span of class 'thing'.
+
+See lib/example and tests for examples of usage

data/lib/example.rb

@@ -0,0 +1,30 @@
+require_relative('tree_decorator')
+
+tree = {
+        1 => {
+          2 => {
+            4 => {},
+            5 => {},
+          },
+          6 => {}         
+        },
+        7 => {}
+      }
+
+hanger = TreeDecorator::Hanger.new(tree)
+
+hanger.outer {|content| "<ul>#{content}</ul>"}
+hanger.inner {|content| "<li>#{content}<li>"}
+
+puts unordered_list = hanger.tree
+
+hanger = TreeDecorator::Hanger.new(tree)
+hanger.element {|content| "element:#{content}"}
+hanger.outer {|content| "<container>#{content}</container>"}
+hanger.join_with(',')
+
+puts containers = hanger.tree
+
+
+
+

data/lib/tree_decorator/hanger.rb

@@ -0,0 +1,45 @@
+module TreeDecorator
+  
+  # Walks through a nested hash and decorates each element and container
+  class Hanger
+    def initialize(tree)
+      @tree = tree
+    end
+    
+    def outer(&containment)
+      @outer = containment
+    end
+    
+    def inner(&elementizer)
+      @inner = elementizer
+    end
+    
+    def element(&element)
+      @element = element
+    end
+    
+    def join_with(text)
+      @join_with = text
+    end
+    
+    def tree
+      output = packager(@tree)
+      @outer ? @outer.call(output) : output 
+    end
+    
+    private
+    def packager(hash)
+      output = []
+      hash.each do |parent, child|
+        parent = @element.call(parent) if @element
+        if child and !child.empty?
+          child = packager(child)
+          child = @outer.call(child) if @outer
+          parent = parent.to_s + child
+        end
+        output << (@inner ? @inner.call(parent) : parent)
+      end
+      return output.join(@join_with)
+    end
+  end
+end

data/lib/tree_decorator/object_hanger.rb

@@ -0,0 +1,42 @@
+require_relative 'hanger'
+
+module TreeDecorator
+  
+  # Walks through objects that have containers with sub-objects
+  # and decorates each object and sub-object.
+  class ObjectHanger < Hanger
+    attr_reader :children_method, :content_method
+    
+    def initialize(root, args = {})
+      @root = root
+      @children_method = args[:children_method]
+      @content_method = args[:content_method]
+      @tree = hash
+    end
+    
+    def hash
+      @tree ||= get_hash_from_objects
+    end
+    
+    private
+    def get_hash_from_objects
+      content = Hash.new
+      content[@root.send(content_method)] = populate_with_children(@root)
+      return content
+    end
+    
+    def populate_with_children(object)
+      content = Hash.new
+      children = object.send(children_method)
+      
+      if children and !children.empty?
+        children.each do |child|
+          content[child.send(content_method)] = populate_with_children(child)
+        end
+      end
+      
+      return content
+    end
+  end
+  
+end

data/lib/tree_decorator.rb

@@ -0,0 +1,6 @@
+require_relative 'tree_decorator/hanger'
+require_relative 'tree_decorator/object_hanger'
+
+module TreeDecorator
+    
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: tree_decorator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-28 00:00:00.000000000Z
+dependencies: []
+description: A tool that walks through a hash or nested object and applies code to
+  containers and elements based on user defined rules.
+email: rob@undervale.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/tree_decorator.rb
+- lib/tree_decorator/object_hanger.rb
+- lib/tree_decorator/hanger.rb
+- lib/example.rb
+homepage: https://github.com/reggieb/TreeDecorator
+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.10
+signing_key: 
+specification_version: 3
+summary: Tree Decorator decorates trees or nested sets of data
+test_files: []