scruffy 0.2.0 → 0.2.1

data/lib/scruffy/rasterizers.rb

@@ -1,2 +1,14 @@
+# ===Scruffy Rasterizers
+#
+# Author:: Brasten Sager
+# Date:: August 10th, 2006
+#
+# These handle the job of rasterizing SVG images to other image formats.
+# At the moment, only RMagickRasterizer exists, but others may soon follow.
+#
+# I'm somewhat interesting in finding a way to integrate Apache Batik, as it's
+# SVG rendering seems to be superior to ImageMagick's.
+module Scruffy::Rasterizers; end
+
 require 'scruffy/rasterizers/rmagick_rasterizer.rb'
-require 'scruffy/rasterizers/batik_rasterizer.rb'
+require 'scruffy/rasterizers/batik_rasterizer.rb'

data/lib/scruffy/rasterizers/batik_rasterizer.rb

@@ -1,25 +1,39 @@
-module Scruffy
-  module Rasterizers
-    class BatikRasterizer
-      def initialize(options={})
-        @command = options[:command]
-        @temp_folder = options[:temp_folder]
-      end
+module Scruffy::Rasterizers
+  # == Scruffy::Rasterizers::BatikRasterizer
+  #
+  # Author:: Brasten Sager
+  # Date:: August 14th, 2006
+  #
+  # Purely experimental.  Can be used to rasterize SVG graphs with
+  # Apache Batik.
+  class BatikRasterizer
+    # Returns new BatikRasterizer.
+    #
+    # Options:
+    # command:: Command needed to execute Batik. (ie: 'java -classpath {...}')
+    # temp_folder:: Folder for storing temporary files being passed between Scruffy and Batik.
+    def initialize(options={})
+      @command = options[:command]
+      @temp_folder = options[:temp_folder]
+    end
+    
+    # Rasterize graph.
+    #
+    # Options:
+    # as:: Image format to generate (PNG, JPG, et al.)
+    def rasterize(svg, options={})
+      File.open(@temp_folder + '/temp_svg.svg', 'w') { |file|
+        file.write(svg)
+      }
+      
+      `#{@command} -d #{@temp_folder} -m image/#{options[:as].downcase} #{@temp_folder}/temp_svg.svg`
+      
+      image = ""
+      File.open(@temp_folder + '/temp_svg.' + options[:as].downcase, 'r') { |file|
+        image = file.read
+      }
       
-      def rasterize(svg, options={})
-        File.open(@temp_folder + '/temp_svg.svg', 'w') { |file|
-          file.write(svg)
-        }
-        
-        `#{@command} -d #{@temp_folder} -m image/#{options[:as].downcase} #{@temp_folder}/temp_svg.svg`
-        
-        image = ""
-        File.open(@temp_folder + '/temp_svg.' + options[:as].downcase, 'r') { |file|
-          image = file.read
-        }
-        
-        image
-      end
+      image
     end
   end
 end

data/lib/scruffy/rasterizers/rmagick_rasterizer.rb

@@ -1,31 +1,28 @@
-module Scruffy
-  # ===Scruffy Rasterizers
+module Scruffy::Rasterizers
+
+  # == RMagickRasterizer
   #
   # Author:: Brasten Sager
-  # Date:: August 10th, 2006
-  #
-  # These handle the job of rasterizing SVG images to other image formats.
-  # At the moment, only RMagickRasterizer exists, but others may soon follow.
+  # Date:: August 14th, 2006
   #
-  # I'm somewhat interesting in finding a way to integrate Apache Batik, as it's
-  # SVG rendering seems to be superior to ImageMagick's.
-  module Rasterizers
-    class RMagickRasterizer
-      def rasterize(svg, options={})
-        
-        # I know this seems weird, I'm open to suggestions.
-        # I didn't want RMagick required unless absolutely necessary.
-        require 'RMagick'
+  # The RMagickRasterizer converts SVG graphs to images using ImageMagick.
+  class RMagickRasterizer
+    def rasterize(svg, options={})
+      
+      # I know this seems weird, I'm open to suggestions.
+      # I didn't want RMagick required unless absolutely necessary.
+      require 'RMagick'
 
-        image = Magick::Image::from_blob(svg)[0]
-        
-        image.resize!(options[:size][0], options[:size][1], Magick::BoxFilter, 1.25) if options[:actual_size]
-        if options[:to]
-          image.write(options[:to]) { self.format = options[:as] }
-        end
+      image = Magick::Image::from_blob(svg)[0]
 
-        image.to_blob { self.format = options[:as] }
+      # Removed for now
+      # image.resize!(options[:size][0], options[:size][1], Magick::BoxFilter, 1.25) if options[:actual_size]
+
+      if options[:to]
+        image.write(options[:to]) { self.format = options[:as] }
       end
+
+      image.to_blob { self.format = options[:as] }
     end
   end
 end

data/lib/scruffy/renderers.rb

@@ -1,5 +1,21 @@
+# ===Scruffy Renderers
+#
+# Author:: Brasten Sager
+# Date:: August 14th, 2006
+#
+# Renderers piece the entire graph together from a collection
+# of components.  Creating new renderers allows you to create
+# entirely new layouts for your graphs.
+#
+# Scruffy::Renderers::Base contains the basic functionality needed
+# by a layout.  The easiest way to create a new layout is by subclassing
+# Base.
+module Scruffy::Renderers; end
+
 require 'scruffy/renderers/base'
+require 'scruffy/renderers/empty'
 require 'scruffy/renderers/standard'
 require 'scruffy/renderers/reversed'
 require 'scruffy/renderers/cubed'
-require 'scruffy/renderers/split'
+require 'scruffy/renderers/split'
+require 'scruffy/renderers/cubed3d'

data/lib/scruffy/renderers/base.rb

@@ -1,37 +1,45 @@
-module Scruffy
-  module Renderers
-    class Base
-      include Scruffy::Helpers::Canvas
-      
-      attr_accessor :components    
+module Scruffy::Renderers
+  # ===Scruffy::Renderers::Base
+  #
+  # Author:: Brasten Sager
+  # Date:: August 14th, 2006
+  #
+  # Provides all the base functionality needed to render a graph, but
+  # does not provide a default layout.
+  #
+  # For a basic layout, see Scruffy::Renderers::Standard.
+  class Base
+    include Scruffy::Helpers::Canvas
+    
+    attr_accessor :components    
 
-      def render(options = {})
-        options[:graph_id]    ||= 'scruffy_graph'
-        options[:complexity]  ||= (global_complexity || :normal)
+    # Renders the graph and all components.
+    def render(options = {})
+      options[:graph_id]    ||= 'scruffy_graph'
+      options[:complexity]  ||= (global_complexity || :normal)
 
-        svg = Builder::XmlMarkup.new(:indent => 2)
-        svg.instruct!
-        svg.instruct! 'DOCTYPE', 'svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"  type'
-        svg.svg(:xmlns => "http://www.w3.org/2000/svg", 'xmlns:xlink' => "http://www.w3.org/1999/xlink", :width => options[:size].first, :height => options[:size].last) {
-          svg.g(:id => options[:graph_id]) {
-            self.components.each do |component|
-              component.render(svg, 
-                               bounds_for( options[:size], component.position, component.size ), 
-                               options)
-            end
-          }
-        }
-        svg.target!
-      end
-    
-      private
-        def global_complexity
-          if Kernel.const_defined? "SCRUFFY_COMPLEXITY"
-            SCRUFFY_COMPLEXITY
-          else
-            nil
+      svg = Builder::XmlMarkup.new(:indent => 2)
+      svg.instruct!
+      svg.instruct! 'DOCTYPE', 'svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"  type'
+      svg.svg(:xmlns => "http://www.w3.org/2000/svg", 'xmlns:xlink' => "http://www.w3.org/1999/xlink", :width => options[:size].first, :height => options[:size].last) {
+        svg.g(:id => options[:graph_id]) {
+          self.components.each do |component|
+            component.render(svg, 
+                             bounds_for( options[:size], component.position, component.size ), 
+                             options)
           end
-        end
+        }
+      }
+      svg.target!
     end
+  
+    private
+      def global_complexity
+        if Kernel.const_defined? "SCRUFFY_COMPLEXITY"
+          SCRUFFY_COMPLEXITY
+        else
+          nil
+        end
+      end
   end
 end

data/lib/scruffy/renderers/cubed.rb

@@ -1,36 +1,44 @@
-module Scruffy
-  module Renderers
-    # Renderer that splits the graphs up into four other little graphs.
-    class Cubed < Base
-      def initialize
-        self.components = []
-        self.components << Scruffy::Components::Background.new(:background, :position => [0,0], :size =>[100, 100])
-        self.components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
+module Scruffy::Renderers
+  # ===Scruffy::Renderers::Cubed
+  #
+  # Author:: Brasten Sager
+  # Date:: August 14th, 2006
+  #
+  # Graph layout consisting of four separate graphs arranged in a 2x2 grid.
+  class Cubed < Empty
+    VIEWPORT_SIZE = [35, 30]
+    VIEWPORTS     = { :top_left => [10, 25],
+                      :top_right => [55, 25],
+                      :bottom_left => [10, 65],
+                      :bottom_right => [55, 65] }
+    
+    # Returns a Cubed instance.
+    def initialize
+      super do |components|
+        components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
+                      
+        VIEWPORTS.each_pair do |category, position|
+          components << Scruffy::Components::Viewport.new(category, :position => position, 
+                                                          :size => VIEWPORT_SIZE, &graph_block(category))
+        end
 
-        # Viewports
-        self.components << Scruffy::Components::Viewport.new(:top_left, :position => [10, 25], 
-                                                             :size => [35, 30], &graph_block(:top_left))
-        self.components << Scruffy::Components::Viewport.new(:top_left, :position => [55, 25], 
-                                                             :size => [35, 30], &graph_block(:top_right))
-        self.components << Scruffy::Components::Viewport.new(:top_left, :position => [10, 65], 
-                                                             :size => [35, 30], &graph_block(:bottom_left))
-        self.components << Scruffy::Components::Viewport.new(:top_left, :position => [55, 65], 
-                                                             :size => [35, 30], &graph_block(:bottom_right))
-        
-        self.components << Scruffy::Components::Legend.new(:legend, :position => [5, 13], :size => [90, 5])
+        components << Scruffy::Components::Legend.new(:legend, :position => [5, 13], :size => [90, 5])
       end
-
-      private
-        def graph_block(graph_filter)
-          block = Proc.new { |components|
-            components << Scruffy::Components::Grid.new(:grid, :position => [10, 0], :size => [90, 89])
-            components << Scruffy::Components::ValueMarkers.new(:value_markers, :position => [0, 2], :size => [8, 89])
-            components << Scruffy::Components::DataMarkers.new(:data_markers, :position => [10, 92], :size => [90, 8])
-            components << Scruffy::Components::Graphs.new(:graphs, :position => [10, 0], :size => [90, 89], :only => graph_filter)
-          }
-          
-          block
-        end
     end
+
+    private
+      # Returns a typical graph layout.
+      #
+      # These are squeezed into viewports.
+      def graph_block(graph_filter)
+        block = Proc.new { |components|
+          components << Scruffy::Components::Grid.new(:grid, :position => [10, 0], :size => [90, 89])
+          components << Scruffy::Components::ValueMarkers.new(:value_markers, :position => [0, 2], :size => [8, 89])
+          components << Scruffy::Components::DataMarkers.new(:data_markers, :position => [10, 92], :size => [90, 8])
+          components << Scruffy::Components::Graphs.new(:graphs, :position => [10, 0], :size => [90, 89], :only => graph_filter)
+        }
+        
+        block
+      end
   end
 end

data/lib/scruffy/renderers/cubed3d.rb

@@ -0,0 +1,53 @@
+module Scruffy::Renderers
+  # ===Scruffy::Renderers::Cubed3d
+  #
+  # Author:: Brasten Sager
+  # Date:: August 17th, 2006
+  #
+  # A 3-dimensional cube effect.
+  class Cubed3d < Empty
+    VIEWPORT_SIZE = [25, 45]
+    VIEWPORTS     = { :top_left => [10, 25],
+                      :top_right => [55, 25],
+                      :bottom_left => [10, 65],
+                      :bottom_right => [55, 65] }
+    
+    # Returns a Cubed instance.
+    def initialize
+      super do |components|
+        components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
+                      
+        components << Scruffy::Components::Viewport.new(:one, :position => [10, 50], 
+                                                        :size => VIEWPORT_SIZE, :skewY => '-25', 
+                                                        &graph_block(:one))
+        components << Scruffy::Components::Viewport.new(:two, :position => [30, 50], 
+                                                        :size => VIEWPORT_SIZE, :skewY => '-25', 
+                                                        &graph_block(:two))
+        components << Scruffy::Components::Viewport.new(:three, :position => [50, 50], 
+                                                        :size => VIEWPORT_SIZE, :skewY => '-25', 
+                                                        &graph_block(:three))
+        components << Scruffy::Components::Viewport.new(:four, :position => [70, 50], 
+                                                        :size => VIEWPORT_SIZE, :skewY => '-25', 
+                                                        &graph_block(:four))
+
+
+        components << Scruffy::Components::Legend.new(:legend, :position => [5, 13], :size => [90, 5])
+      end
+    end
+
+    private
+      # Returns a typical graph layout.
+      #
+      # These are squeezed into viewports.
+      def graph_block(graph_filter)
+        block = Proc.new { |components|
+          components << Scruffy::Components::Grid.new(:grid, :position => [10, 0], :size => [90, 89])
+          components << Scruffy::Components::ValueMarkers.new(:value_markers, :position => [0, 2], :size => [8, 89])
+          components << Scruffy::Components::DataMarkers.new(:data_markers, :position => [10, 92], :size => [90, 8])
+          components << Scruffy::Components::Graphs.new(:graphs, :position => [10, 0], :size => [90, 89], :only => graph_filter)
+        }
+        
+        block
+      end
+  end
+end

data/lib/scruffy/renderers/empty.rb

@@ -0,0 +1,23 @@
+module Scruffy::Renderers
+  # ===Scruffy::Renderers::Empty
+  #
+  # Author:: Brasten Sager
+  # Date:: August 17th, 2006
+  #
+  # An Empty graph isn't completely empty, it adds a background componenet
+  # to itself before handing other all other layout responsibilities to it's
+  # subclasses or caller.
+  class Empty < Base
+
+    # Returns a renderer with just a background.
+    #
+    # If a block is provided, the components array is passed to
+    # the block, allowing callers to add components during initialize.
+    def initialize
+      self.components = []
+      self.components << Scruffy::Components::Background.new(:background, :position => [0,0], :size =>[100, 100])      
+
+      yield(components) if block_given?
+    end
+  end
+end

data/lib/scruffy/renderers/sparkline.rb

@@ -0,0 +1,11 @@
+module Scruffy
+  module Renderers
+    # Experimental, do not use.
+    class Sparkline < Base
+      def initialize
+        self.components = []
+        self.components << Scruffy::Components::Graphs.new(:sparkline, :position => [0, 0], :size => [100, 100])                  
+      end
+    end
+  end
+end

data/lib/scruffy/themes.rb

@@ -1,70 +1,90 @@
-module Scruffy
-  module Themes
-    class Base
-      attr_accessor :background
-      attr_accessor :colors
-      attr_accessor :marker
-      attr_accessor :font_family
+# ===Scruffy Themes
+#
+# Author:: Brasten Sager
+# Date:: August 10th, 2006
+#
+# Scruffy Themes allow you to alter the colors and appearances of
+# your graph.
+module Scruffy::Themes
+  # ==Scruffy::Themes::Base
+  #
+  # Author:: Brasten Sager
+  # Date:: August 14th, 2006
+  #
+  # The base theme class.  Most themes can be constructed simply
+  # by instantiating a new Base object with a hash of color values.
+  #
+  # See Scruffy::Themes::Base#instantiate for examples.
+  class Base
+    attr_accessor :background
+    attr_accessor :colors
+    attr_accessor :marker
+    attr_accessor :font_family
 
-      def initialize(descriptor)
-        self.background = descriptor[:background]
-        self.colors     = descriptor[:colors]
-        self.marker     = descriptor[:marker]
-        self.font_family = descriptor[:font_family]
-      end
-      
-      def next_color
-        @previous_color = 0 if @previous_color.nil?
-        @previous_color += 1
-                
-        self.colors[(@previous_color-1) % self.colors.size]
-      end
-      
-      def darken(color, shift=20)
-        
-      end
-      
-      def lighten(color, shift=20)
-        
-      end
-    end
-    
-    # Keynote theme, based on Apple's Keynote presentation software.
+    # Returns a new Scruffy::Themes::Base object.
     #
-    # Color values used from Gruff's default theme.
-    class Keynote < Base
-      def initialize
-        super({  
-                :background => [:black, '#4A465A'],
-                :marker => :white, 
-                :colors => %w(#6886B4 #FDD84E #72AE6E #D1695E #8A6EAF #EFAA43 white)
-               })
-      end
-    end
-
-    # Roughly, roughly based on the color scheme of www.mephistoblog.com.
-    class Mephisto < Base
-      def initialize
-        super({
-                :background => ['#101010', '#999977'],
-                :marker => :white,
-                :colors => %w(#DD3300 #66AABB #225533 #992200)
-              })
-        
-      end
+    # Hash options:
+    # background:: background color.
+    # colors:: an array of color values to use for graphs.
+    # marker:: color used for grid lines, values, data points, etc.
+    # font_family:: in general, allows you to change the font used in the graph.
+    #               This is not yet supported in most graph elements.
+    def initialize(descriptor)
+      self.background = descriptor[:background]
+      self.colors     = descriptor[:colors]
+      self.marker     = descriptor[:marker]
+      self.font_family = descriptor[:font_family]
     end
     
-    # Based on the color scheme used by almost every Ruby blogger.
-    class RubyBlog < Base
-      def initialize
-        super({
-                :background => ['#670A0A', '#831515'],
-                :marker => '#DBD1C1',
-                :colors => %w(#007777 #444477 #994444 #77FFBB #D75A20)
-              })
-      end
+    # Returns the next available color in the color array.
+    def next_color
+      @previous_color = 0 if @previous_color.nil?
+      @previous_color += 1
+              
+      self.colors[(@previous_color-1) % self.colors.size]
     end
+
+    # todo: Implement darken function.
+    def darken(color, shift=20); end
     
+    # todo: Implement lighten function.
+    def lighten(color, shift=20); end
     
   end
+  
+  # Keynote theme, based on Apple's Keynote presentation software.
+  #
+  # Color values used from Gruff's default theme.
+  class Keynote < Base
+    def initialize
+      super({  
+              :background => [:black, '#4A465A'],
+              :marker => :white, 
+              :colors => %w(#6886B4 #FDD84E #72AE6E #D1695E #8A6EAF #EFAA43 white)
+             })
+    end
+  end
+
+  # Roughly, roughly based on the color scheme of www.mephistoblog.com.
+  class Mephisto < Base
+    def initialize
+      super({
+              :background => ['#101010', '#999977'],
+              :marker => :white,
+              :colors => %w(#DD3300 #66AABB #225533 #992200)
+            })
+      
+    end
+  end
+  
+  # Based on the color scheme used by almost every Ruby blogger.
+  class RubyBlog < Base
+    def initialize
+      super({
+              :background => ['#670A0A', '#831515'],
+              :marker => '#DBD1C1',
+              :colors => %w(#007777 #444477 #994444 #77FFBB #D75A20)
+            })
+    end
+  end
 end