samhendley-scruffy 0.2.7

data/lib/scruffy/layers/pie_slice.rb

@@ -0,0 +1,119 @@
+module Scruffy::Layers
+  # ==Scruffy::Layers::PieSlice
+  # 
+  # Author:: A.J. Ostman
+  # Date:: August 14th, 2006
+  # 
+  # Basic Pie Chart Slice..
+    
+  class PieSlice < Base
+  
+    # Setup Constants
+    RADIANS = Math::PI / 180 
+    MARKER_OFFSET_RATIO = 1.2
+    MARKER_FONT_SIZE = 6
+    
+    attr_accessor :diameter
+    attr_accessor :percent_used
+    attr_accessor :degree_offset
+    attr_accessor :scaler
+    attr_accessor :center_x, :center_y
+    
+    def draw(svg, coords, options = {})
+      # Scaler is the multiplier to normalize the values to a percentage across
+      # the Pie Chart
+      @scaler = options[:scaler] || 1
+      
+      # Degree Offset is degrees by which the pie chart is twisted when it
+      # begins
+      @degree_offset = options[:degree_offset] || @options[:degree_offset] || 0
+      
+      # Percent Used keeps track of where in the pie chart we are
+      @percent_used = options[:percent_used] || @options[:percent_used] || 0
+      
+      # Diameter of the pie chart defaults to 80% of the height
+      @diameter = relative(options[:diameter]) || relative(@options[:diameter]) || relative(80.0)
+      
+      # Stroke
+      stroke = options[:stroke] || @options[:stroke] || "none"
+
+      # Shadow
+      shadow = options[:shadow] || @options[:shadow_] || false
+      shadow_x = relative(options[:shadow_x]) || relative(@options[:shadow_x]) || relative(-0.5)
+      shadow_y = relative(options[:shadow_y]) || relative(@options[:shadow_y]) || relative(0.5)
+      shadow_color = options[:shadow_color] || @options[:shadow_color] || "white"
+      shadow_opacity = options[:shadow_opacity] || @options[:shadow_opacity] || 0.06
+      
+      # Coordinates for the center of the pie chart.
+      @center_x = relative_width(options[:center_x]) || relative_width(@options[:center_x]) || relative_width(50)
+      @center_y = relative_height(options[:center_y]) || relative_height(@options[:center_y]) || relative_height(50)
+      radius = @diameter / 2.0
+      
+      # Graphing calculated using percent of graph. We later multiply by 3.6 to
+      # convert to 360 degree system.
+      percent = @scaler * sum_values
+      
+
+      # Calculate the Radian Start Point
+      radians_start = ((@percent_used * 3.6) + @degree_offset) * RADIANS
+      # Calculate the Radian End Point
+      radians_end = ((@percent_used + percent) * 3.6 + @degree_offset) * RADIANS
+
+      radians_mid_point = radians_start + ((radians_end - radians_start) / 2)
+      
+      if options[:explode]
+        @center_x = @center_x + (Math.sin(radians_mid_point) * relative(options[:explode]))
+        @center_y = @center_y - (Math.cos(radians_mid_point) * relative(options[:explode]))
+      end
+  
+
+      # Calculate the beginning coordinates
+      x_start = @center_x + (Math.sin(radians_start) * radius)
+      y_start = @center_y - (Math.cos(radians_start) * radius)
+      
+      # Calculate the End Coords
+      x_end = @center_x + (Math.sin(radians_end) * radius)
+      y_end = @center_y - (Math.cos(radians_end) * radius)
+
+      
+
+      # If percentage is really really close to 100% then draw a circle instead!
+      if percent >= 99.9999
+        
+        if shadow
+          svg.circle(:cx => "#{@center_x + shadow_x}", :cy => "#{@center_y + shadow_y}", :r=>"#{radius}",:stroke => "none", 
+            :fill => shadow_color.to_s,  :style => "fill-opacity: #{shadow_opacity.to_s};")
+        end
+        
+        svg.circle(:cx => "#{@center_x}", :cy => "#{@center_y}", :r=>"#{radius}",:stroke => stroke, :fill => color.to_s)
+
+      else  
+        if shadow
+          svg.path(:d =>  "M#{@center_x + shadow_x},#{@center_y + shadow_y} L#{x_start + shadow_x},#{y_start + shadow_y} A#{radius},#{radius} 0, #{percent >= 50 ? '1' : '0'}, 1, #{x_end + shadow_x} #{y_end + shadow_y} Z", 
+            :fill => shadow_color.to_s, :style => "fill-opacity: #{shadow_opacity.to_s};")
+        end
+        
+        svg.path(:d =>  "M#{@center_x},#{@center_y} L#{x_start},#{y_start} A#{radius},#{radius} 0, #{percent >= 50 ? '1' : '0'}, 1, #{x_end} #{y_end} Z", 
+          :stroke => stroke, :fill => color.to_s)
+      end
+      
+      text_x = @center_x + (Math.sin(radians_mid_point) * radius * MARKER_OFFSET_RATIO)
+      text_y = @center_y - (Math.cos(radians_mid_point) * radius * MARKER_OFFSET_RATIO)
+
+      svg.text("#{sprintf('%d', percent)}%",
+        :x => text_x,
+        :y => text_y + relative(MARKER_FONT_SIZE / 2), 
+        'font-size' => relative(MARKER_FONT_SIZE),
+        'font-family' => options[:theme].font_family,
+        :fill => (options[:theme].marker || 'black').to_s, 
+        'text-anchor' => 'middle')
+    end
+
+    protected
+    def generate_coordinates(options = {})
+      # Coordinate Generation didn't make much sense here. Overridden just
+      # because Brasten said this would be overridden.
+    end
+  end
+  
+end

data/lib/scruffy/layers/scatter.rb

@@ -0,0 +1,21 @@
+module Scruffy::Layers
+  # ==Scruffy::Layers::Line
+  #
+  # Author:: Mat Schaffer
+  # Date:: March 20th, 2007
+  #
+  # Simple scatter graph
+  class Scatter < Base
+    
+    # Renders scatter graph.
+    def draw(svg, coords, options={})
+      svg.g(:class => 'shadow', :transform => "translate(#{relative(0.5)}, #{relative(0.5)})") {
+        coords.each { |coord| svg.circle( :cx => coord.first, :cy => coord.last + relative(0.9), :r => relative(2), 
+                                          :style => "stroke-width: #{relative(2)}; stroke: black; opacity: 0.35;" ) }
+      }
+
+      coords.each { |coord| svg.circle( :cx => coord.first, :cy => coord.last, :r => relative(2), 
+                                        :style => "stroke-width: #{relative(2)}; stroke: #{color.to_s}; fill: #{color.to_s}" ) }
+    end
+  end
+end

data/lib/scruffy/layers/sparkline_bar.rb

@@ -0,0 +1,39 @@
+module Scruffy
+  module Layers
+    # Experimental, do not use.
+    class SparklineBar < Base
+    
+      def draw(svg, coords, options = {})
+        zero_point = @height / 2.0
+
+        coords.each do |coord|
+          x, y, bar_height = (coord.first-(@bar_width * 0.5)), coord.last, (height - coord.last)
+
+          bar_color = (y > zero_point) ? 'black' : 'red'
+          bar_height = (bar_height - zero_point)
+          
+          #y = (bar_height < 0) ? 
+
+          # svg.rect( :x => x, :y => zero_point, :width => @bar_width, :height => , 
+          #           :fill => bar_color, :stroke => 'none', 'style' => "opacity: #{opacity}" )
+        end
+      end
+
+      protected
+        def generate_coordinates(options = {})
+          @bar_width = (width / points.size) * 0.9
+          options[:point_distance] = (width - (width / points.size)) / (points.size - 1).to_f
+
+          #TODO iteration by index on points.  Needs to change
+          coords = (0...points.size).map do |idx| 
+            x_coord = (options[:point_distance] * idx) + (width / points.size * 0.5)
+
+            relative_percent = ((points[idx] == min_value) ? 0 : ((points[idx] - min_value) / (max_value - min_value).to_f))
+            y_coord = (height - (height * relative_percent))
+            [x_coord, y_coord]
+          end
+          coords
+        end
+    end
+  end
+end

data/lib/scruffy/layers/stacked.rb

@@ -0,0 +1,87 @@
+module Scruffy::Layers
+  # ==Scruffy::Layers::Stacked
+  #
+  # Author:: Brasten Sager
+  # Date:: August 12th, 2006
+  #
+  # Provides a generic way for stacking graphs.  This may or may not
+  # do what you'd expect under every situation, but it at least kills
+  # a couple birds with one stone (stacked bar graphs and stacked area
+  # graphs work fine).
+  class Stacked < Base
+    include Scruffy::Helpers::LayerContainer
+    
+    # Returns new Stacked graph.
+    #
+    # You can provide a block for easily adding layers during (just after) initialization.
+    # Example:
+    #   Stacked.new do |stacked|
+    #     stacked << Scruffy::Layers::Line.new( ... )
+    #     stacked.add(:bar, 'My Bar', [...])
+    #   end
+    #
+    # The initialize method passes itself to the block, and since stacked is a LayerContainer,
+    # layers can be added just as if they were being added to Graph.
+    def initialize(options={}, &block)
+      super(options)
+
+      block.call(self)    # Allow for population of data with a block during initialization.
+    end
+    
+    # Overrides Base#render to fiddle with layers' points to achieve a stacked effect.
+    def render(svg, options = {})
+      #TODO ensure this works with new points
+      current_points = points.dup
+      
+      layers.each do |layer|
+        real_points = layer.points
+        layer.points = current_points
+        layer_options = options.dup
+        layer_options[:color] = layer.preferred_color || layer.color || options[:theme].next_color          
+        layer.render(svg, layer_options)
+        options.merge(layer_options)
+        layer.points = real_points
+        
+        layer.points.each_with_index { |val, idx| current_points[idx] -= val }
+      end
+    end
+
+    # A stacked graph has many data sets.  Return legend information for all of them.
+    def legend_data
+      if relevant_data?
+        retval = []
+        layers.each do |layer|
+          retval << layer.legend_data
+        end
+        retval
+      else
+        nil
+      end
+    end
+
+    # TODO, special points accessor  
+    def points
+      longest_arr = layers.inject(nil) do |longest, layer|
+        longest = layer.points if (longest.nil? || longest.size < layer.points.size)
+      end
+      
+      summed_points = (0...longest_arr.size).map do |idx|
+        layers.inject(nil) do |sum, layer|
+          if sum.nil? && !layer.points[idx].nil?
+            sum = layer.points[idx]
+          elsif !layer.points[idx].nil?
+            sum += layer.points[idx]
+          end
+          
+          sum
+        end
+      end
+
+      summed_points
+    end
+
+    def points=(val)
+      throw ArgumentsError, "Stacked layers cannot accept points, only other layers."
+    end
+  end
+end

data/lib/scruffy/layers.rb

@@ -0,0 +1,24 @@
+# ==Scruffy::Layers
+#
+# Author:: Brasten Sager
+# Date:: August 10th, 2006
+#
+# See documentation in Scruffy::Layers::Base
+#
+module Scruffy::Layers
+
+  # Should be raised whenever a predictable error during rendering occurs,
+  # particularly if you do not want to terminate the graph rendering process.
+  class RenderError < StandardError; end
+  
+end
+
+require 'scruffy/layers/base'
+require 'scruffy/layers/area'
+require 'scruffy/layers/all_smiles'
+require 'scruffy/layers/bar'
+require 'scruffy/layers/line'
+require 'scruffy/layers/average'
+require 'scruffy/layers/stacked'
+require 'scruffy/layers/pie'
+require 'scruffy/layers/pie_slice'

data/lib/scruffy/rasterizers/batik_rasterizer.rb

@@ -0,0 +1,39 @@
+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
+      }
+      
+      image
+    end
+  end
+end

data/lib/scruffy/rasterizers/rmagick_rasterizer.rb

@@ -0,0 +1,27 @@
+module Scruffy::Rasterizers
+
+  # == RMagickRasterizer
+  #
+  # Author:: Brasten Sager
+  # Date:: August 14th, 2006
+  #
+  # 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]
+
+      # 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/rasterizers.rb

@@ -0,0 +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'

data/lib/scruffy/renderers/base.rb

@@ -0,0 +1,95 @@
+require 'builder'
+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 :options
+
+    def initialize(options = {})
+      self.components = []
+      self.options = options
+      define_layout
+    end
+
+    # Renders the graph and all components.
+    def render(options = {})
+      options[:graph_id]    ||= 'scruffy_graph'
+      options[:complexity]  ||= (global_complexity || :normal)
+
+      # Allow subclasses to muck with components prior to renders.
+      rendertime_renderer = self.clone
+      rendertime_renderer.instance_eval { before_render if respond_to?(:before_render) }
+
+      svg = Builder::XmlMarkup.new(:indent => 2)
+      unless options[:no_doctype_header]
+        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'
+      end
+      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]) {
+          rendertime_renderer.components.each do |component|
+            component.render(svg, 
+                             bounds_for( options[:size], component.position, component.size ), 
+                             options)
+          end
+        }
+      }
+      svg.target!
+    end
+    
+    def before_render
+      if self.options
+        set_values(self.options[:values])    if (self.options[:values] && self.options[:values] != :hide)
+        hide_grid     if (self.options[:grid] == :hide)
+        hide_values   if (self.options[:values] == :hide)
+        hide_labels   if (self.options[:labels] == :hide)
+      end
+    end
+    
+    def method_missing(sym, *args)
+      self.options = {} if self.options.nil?
+      
+      if args.size > 0
+        self.options[sym] = args[0]
+      else
+        return self.options[sym]
+      end
+    end
+
+    protected
+      def hide_grid
+        grids.each { |grid| grid.visible = false }
+      end
+    
+      def set_values(val)
+        values.each { |value| value.markers = val }
+        grids.each { |grid| grid.markers = val }
+      end
+    
+      def hide_values
+        values.each { |value| value.visible = false }
+      end
+    
+      def hide_labels
+        labels.each { |label| label.visible = false }
+      end    
+
+    private
+      def global_complexity
+        if Kernel.const_defined? "SCRUFFY_COMPLEXITY"
+          SCRUFFY_COMPLEXITY
+        else
+          nil
+        end
+      end
+  end   # base
+end

data/lib/scruffy/renderers/cubed.rb

@@ -0,0 +1,44 @@
+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 define_layout
+      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
+
+        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/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 define_layout
+      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,22 @@
+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 define_layout
+      self.components << Scruffy::Components::Background.new(:background, :position => [0,0], :size =>[100, 100])      
+
+      yield(self.components) if block_given?
+    end
+  end
+end

data/lib/scruffy/renderers/pie.rb

@@ -0,0 +1,20 @@
+module Scruffy::Renderers
+  # ===Scruffy::Renderers::Base
+  # 
+  # Author:: A.J. Ostman
+  # Date:: August 14th, 2006
+  # 
+  # Provides a more appropriate rendering for Pie Charts.
+  # Does not show grid or Data markers, but does add Pie Value Markers.
+  class Pie < Base
+
+    def initialize
+      self.components = []
+      self.components << Scruffy::Components::Background.new(:background, :position => [0,0], :size =>[100, 100])
+      self.components << Scruffy::Components::Graphs.new(:graphs, :position => [-15, 12], :size => [90, 88])
+      self.components << Scruffy::Components::Title.new(:title, :position => [5, 2], :size => [90, 7])
+      self.components << Scruffy::Components::Legend.new(:legend, :position => [60, 15], :size => [40, 88], :vertical_legend => true)
+    end
+  end
+  
+end

data/lib/scruffy/renderers/reversed.rb

@@ -0,0 +1,17 @@
+module Scruffy
+  module Renderers
+    class Reversed < Base
+
+      def define_layout
+        self.components << Scruffy::Components::Background.new(:background, :position => [0,0], :size =>[100, 100])
+        self.components << Scruffy::Components::Title.new(:title, :position => [98, 95], :size => [1, 3], :text_anchor => 'end')
+        #self.components << Scruffy::Components::Grid.new(:grid, :position => [14, 12], :size => [78.5, 70])
+        self.components << Scruffy::Components::ValueMarkers.new(:value_markers, :position => [2, 14], :size => [10, 70])
+        self.components << Scruffy::Components::DataMarkers.new(:data_markers, :position => [14, 3.5], :size => [78.5, 4])
+        self.components << Scruffy::Components::Graphs.new(:graphs, :position => [14, 12], :size => [78.5, 70])
+        self.components << Scruffy::Components::Legend.new(:legend, :position => [3, 90], :size => [55, 6])
+      end
+
+    end
+  end
+end

data/lib/scruffy/renderers/sparkline.rb

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