mtah-ruby-treemap 0.0.3.1

data/Rakefile

@@ -0,0 +1,72 @@
+# -*- coding: undecided -*-
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'treemap'
+
+CLEAN.include FileList['test/*.html', 'test/*.png', 'test/*.svg']
+CLEAN.include 'docs'
+
+PKG_NAME      = 'mtah-ruby-treemap'
+PKG_VERSION   = Treemap::VERSION
+
+desc 'list available tasks'
+task :default do
+    puts "Run 'rake --tasks' for the list of available tasks"
+end
+
+Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'docs'
+    rdoc.title    = "RubyTreemap"
+    rdoc.options << "--all"
+    rdoc.options << "-S"
+    rdoc.options << "-N"
+    rdoc.options << "--main=README"
+    rdoc.rdoc_files.include("README", "EXAMPLES", "TODO", "ChangeLog", "lib/*.rb", "lib/**/*.rb")
+end
+
+desc "Run unit tests"
+Rake::TestTask.new do |t|
+    t.libs << "test"
+    begin
+        require 'RMagick'
+        t.pattern = 'test/tc_*.rb'
+    rescue LoadError
+        t.test_files = ['tc_color.rb','tc_html.rb']
+    end
+    t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+    s.platform = Gem::Platform::RUBY
+
+    s.name = PKG_NAME
+    s.summary = "Treemap visualization in ruby"
+    s.description = %q{Treemap visualization in ruby}
+    s.version = PKG_VERSION
+    s.author = "Martin Häger"
+    s.email = "martin.haeger@gmail.com"
+    s.homepage = "http://github.com/mtah/ruby-treemap"
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = [ "README", "EXAMPLES" ]
+    s.rdoc_options = [ "--main", "README" ]
+    s.requirements << 'none'
+
+    s.require_path = 'lib'
+    s.autorequire = 'treemap'
+
+    s.files = [ "Rakefile", "TODO", "EXAMPLES", "README", "ChangeLog", "COPYING"]
+    s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+    s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+    p.need_tar = true
+end

data/TODO

@@ -0,0 +1,6 @@
+= RubyTreemap - TODO
+
+* Lots of testing. Need to create solid unit tests.
+* HTML output seems to be a few pixels off when drawing treemap squares.
+* Better image output support. Need to add the ability to draw labels.
+* Add option to pad squares in treemap.

data/lib/treemap.rb

@@ -0,0 +1,66 @@
+#
+# treemap.rb - RubyTreemap
+#
+# Copyright (c) 2006 by Andrew Bruno <aeb@qnot.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+#
+
+require File.dirname(__FILE__) + '/treemap/node'
+require File.dirname(__FILE__) + '/treemap/layout_base'
+require File.dirname(__FILE__) + '/treemap/output_base'
+require File.dirname(__FILE__) + '/treemap/color_base'
+require File.dirname(__FILE__) + '/treemap/slice_layout'
+require File.dirname(__FILE__) + '/treemap/squarified_layout'
+require File.dirname(__FILE__) + '/treemap/html_output'
+require File.dirname(__FILE__) + '/treemap/rectangle'
+require File.dirname(__FILE__) + '/treemap/gradient_color'
+require File.dirname(__FILE__) + '/treemap/svg_output'
+
+# XXX these are still expirmental. Requires RMagick
+# require File.dirname(__FILE__) + '/treemap/image_output'
+
+module Treemap
+    VERSION = "0.0.3.1"
+
+    def Treemap::dump_tree(node)
+        puts "#{node.label}: #{node.bounds.to_s}"
+        node.children.each do |c|
+            dump_tree(c)
+        end
+    end
+
+    def Treemap::tree_from_xml(file)
+        doc = REXML::Document.new(file)
+        node_from_xml(doc.root)
+    end
+
+    def Treemap::node_from_xml(xmlnode)
+        node = Treemap::Node.new
+
+        node.label = xmlnode.attributes["label"]
+        id = xmlnode.attributes["id"]
+        if(!id.nil?)
+            node.id = id.to_s
+        end
+
+        node.size = xmlnode.attributes["size"]
+        node.size = node.size.to_f unless node.size.nil?
+
+        node.color = xmlnode.attributes["change"]
+        node.color = node.color.to_f unless node.color.nil?
+
+
+        xmlnode.elements.each do |c|
+            child = node_from_xml(c)
+            node.add_child(child) if !child.nil?
+        end
+
+        return nil if node.size < 5
+        node
+    end
+end

data/lib/treemap/color_base.rb

@@ -0,0 +1,61 @@
+#
+# color_base.rb - RubyTreemap
+#
+# Copyright (c) 2006 by Andrew Bruno <aeb@qnot.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+#
+
+module Treemap
+    class ColorBase
+        def get_hex_color(value)
+            # base classes override
+        end
+
+        def get_rgb_color(value)
+            # base classes override
+        end
+        
+        def red(color)
+            color.sub!(/^#/, "")
+            color[0,2].hex 
+        end 
+
+        def green(color)
+            color.sub!(/^#/, "")
+            color[2,2].hex 
+        end
+
+        def blue(color)
+            color.sub!(/^#/, "")
+            color[4,2].hex 
+        end
+
+        def to_rgb(color)
+            [red(color), green(color), blue(color)]
+        end
+
+        def to_html(width=1, height=20)
+            html = "<div>"
+            index = @min
+
+            while(index <= @max)
+                html += "<span style=\"display: block; float: left;"
+                html += "width: " + width.to_s + "px;"
+                html += "height: " + height.to_s + "px;"
+                html += "background-color: #" + get_hex_color(index) + ";"
+                html += "\">"
+                html += "<img width=\"1\" height=\"1\" />"
+                html += "</span>"
+                index += @increment
+            end
+
+            html += "</div>"
+            html
+        end
+    end
+end

data/lib/treemap/gradient_color.rb

@@ -0,0 +1,71 @@
+#
+# gradient_color.rb - RubyTreemap
+#
+# Copyright (c) 2006 by Andrew Bruno <aeb@qnot.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+#
+
+require File.dirname(__FILE__) + "/color_base"
+
+class Treemap::GradientColor < Treemap::ColorBase
+    attr_accessor(:min, :max, :min_color, :mean_color, :max_color, :increment)
+
+    def initialize
+        @min = -100
+        @max = 100
+        @min_color = "FF0000"   # red
+        @mean_color = "000000"  # black
+        @max_color = "00FF00"   # green
+        @increment = 1
+
+        yield self if block_given?
+
+        # XXX add in error checking. if min >= max, if colors aren't hex, etc.
+        @min = @min.to_f
+        @max = @max.to_f
+        @mean = (@min + @max) / 2.to_f
+        @slices = (1.to_f / @increment.to_f) * (@max - @mean).to_f
+    end
+
+    def get_hex_color(value)
+        value = @max if(value > @max)
+        vaue = @min if(value < @min)
+
+
+        r1, g1, b1 = to_rgb(@mean_color)
+        r2, g2, b2 = to_rgb(@min_color)
+        if(value >= @mean) 
+            r2, g2, b2 = to_rgb(@max_color)
+        end
+
+        rfactor = ((r1 -r2).abs.to_f / @slices) * value.abs 
+        gfactor = ((g1 -g2).abs.to_f / @slices) * value.abs
+        bfactor = ((b1 -b2).abs.to_f / @slices) * value.abs
+
+        newr = r1 + rfactor
+        if(r1 > r2)
+            newr = r1 - rfactor
+        end
+
+        newg = g1 + gfactor
+        if(g1 > g2)
+            newg = g1 - gfactor
+        end
+
+        newb = b1 + bfactor
+        if(b1 > b2)
+            newb = b1 - bfactor
+        end
+
+        sprintf("%02X", newr.round) + sprintf("%02X", newg.round) + sprintf("%02X", newb.round)
+    end
+
+    def get_rgb_color(value)
+        to_rgb(get_hex_color(value))
+    end
+end

data/lib/treemap/html_output.rb

@@ -0,0 +1,173 @@
+#
+# html_output.rb - RubyTreemap
+#
+# Copyright (c) 2006 by Andrew Bruno <aeb@qnot.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+#
+
+require 'cgi'
+require File.dirname(__FILE__) + "/output_base"
+require File.dirname(__FILE__) + "/slice_layout"
+
+class Treemap::HtmlOutput < Treemap::OutputBase
+    attr_accessor(:full_html, :base_font_size, :center_labels_at_depth, :center_labels_at_z, :stylesheets, :javascripts, :metadata)
+
+    def initialize
+        super
+
+        # default options for HtmlOutput
+        @full_html = true
+        @center_labels_at_depth = nil
+        @center_labels_at_z = 100
+        @stylesheets = ""
+        @javascripts = ""
+        @base_font_size = 14
+
+        yield self if block_given?
+
+        @layout.position = :absolute
+    end
+
+    def default_css
+        css = <<CSS
+.node {
+    border: 1px solid black;
+}
+.label {
+    color: #FFFFFF;
+    font-size: 11px;
+}
+.label-heading {
+    color: #FFFFFF;
+    font-size: 14pt;
+    font-weight: bold;
+    text-decoration: underline;
+}
+CSS
+    end
+
+    def node_label(node)
+        CGI.escapeHTML(node.label)
+    end
+
+    def node_color(node)
+        color = "#CCCCCC"
+
+        if(!node.color.nil?)
+            if(not Numeric === node.color)
+                color = node.color
+            else
+                color = "#" + @color.get_hex_color(node.color)
+            end
+        end
+
+        color
+    end
+
+    def to_html(node)
+        @bounds = self.bounds
+
+        @layout.process(node, @bounds)
+
+        draw_map(node)
+    end
+
+    def draw_map(node)
+        html = ""
+
+        if(@full_html)
+            html += "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" "
+            html += "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">"
+            html += "<html><head>"
+            html += "<title>Treemap - #{node_label(node)}</title>"
+            html += "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />"
+            html += "<style type=\"text/css\">" + default_css + "</style>"
+            html += self.stylesheets
+            html += self.javascripts
+            html += "</head><body>"
+        end
+
+        html += draw_node(node)
+
+        if(@full_html)
+            html += "</body></html>"
+        end
+
+        html
+    end
+
+    def draw_label(node)
+        label= "<span"
+        if(!@center_labels_at_depth.nil? and @center_labels_at_depth == node.depth)
+            px_per_point = 20
+            label_size = node.label.length * px_per_point
+
+            label += " style=\""
+            label += "overflow: hidden; position: absolute;"
+            label += "margin-top: " + (node.bounds.height/2 - node.font_size(@base_font_size)/2).to_s + "px;"
+
+            label += "left: 0px; top: 0px; width: 100%; height: 100%; line-height: 100%; text-align: center;"
+            label += "z-index: #{@center_labels_at_z};"
+            label += "font-size:#{node.font_size(@base_font_size)}px;"
+            label += "\""
+            label += " class=\"label-heading\""
+        else
+            label += " class=\"label\""
+            label += " style=\"font-size:#{node.font_size(@base_font_size)}px\""
+        end
+        label += ">"
+        label += node_label(node)
+        label += "</span>"
+
+        label
+    end
+
+    # Subclass can override to add more html inside <div/> of node
+    def draw_node_body(node)
+        draw_label(node)
+    end
+
+    def draw_node(node)
+        return "" if node.bounds.nil?
+
+        root_class = node.depth == 0 ? " treemap-root" : ""
+      
+        html = "<div id=\"node-#{node.id}\"" 
+        html += " style=\""
+        html += "overflow: hidden; position: absolute; display: inline;"
+        html += "left: #{node.bounds.x1}px; top: #{node.bounds.y1}px;"
+        html += "width: #{node.bounds.width}px; height: #{node.bounds.height}px;"
+        html += "background-color: " + node_color(node) + ";"
+        if(!@center_labels_at_depth.nil? and @center_labels_at_depth == node.depth)
+            html += "border: 1px solid black;"
+        end
+        html += "\" class=\"#{metadata(node)}node#{root_class}\""
+        html += ">"
+
+        html += draw_node_body(node)
+
+        if(!node.children.nil? and node.children.size > 0)
+            node.children.each do |c|
+                html += draw_node(c)
+            end
+        end
+
+        html += "</div>"
+    end
+
+    private
+    def metadata(node)
+      if node.object && @metadata
+        metadata = @metadata.map { |c| "'#{c}': '#{node.object.send(c).to_s}'" } || []
+
+        return "" if metadata.empty?
+
+        return "{#{metadata.join(',')}} "
+      end
+    end
+end