teejayvanslyke-gruff 0.3.6

data/lib/gruff/bullet.rb

@@ -0,0 +1,109 @@
+require File.dirname(__FILE__) + '/base'
+
+class Gruff::Bullet < Gruff::Base
+
+  def initialize(target_width="400x40")
+    if not Numeric === target_width
+      geometric_width, geometric_height = target_width.split('x')
+      @columns = geometric_width.to_f
+      @rows = geometric_height.to_f
+    else
+      @columns = target_width.to_f
+      @rows = target_width.to_f / 5.0
+    end
+
+    initialize_ivars
+
+    reset_themes
+    theme_greyscale
+    @title_font_size = 20
+  end
+
+  def data(value, maximum_value, options={})
+    @value = value.to_f
+    @maximum_value = maximum_value.to_f
+    @options = options
+    @options.map { |k, v| @options[k] = v.to_f if v === Numeric }
+  end
+
+  # def setup_drawing
+  #   # Maybe should be done in one of the following functions for more granularity.
+  #   unless @has_data
+  #     draw_no_data()
+  #     return
+  #   end
+  #
+  #   normalize()
+  #   setup_graph_measurements()
+  #   sort_norm_data() if @sort # Sort norm_data with avg largest values set first (for display)
+  #
+  #   draw_legend()
+  #   draw_line_markers()
+  #   draw_axis_labels()
+  #   draw_title
+  # end
+
+  def draw
+    # TODO Left label
+    # TODO Bottom labels and markers
+    # @graph_bottom
+    # Calculations are off 800x???
+
+    @colors.reverse!
+
+    draw_title
+
+    @margin       = 30.0
+    @thickness    = @raw_rows / 6.0
+    @right_margin = @margin
+    @graph_left   = @title_width * 1.3 rescue @margin # HACK Need to calculate real width
+    @graph_width  = @raw_columns - @graph_left - @right_margin
+    @graph_height = @thickness * 3.0
+
+    # Background
+    @d = @d.fill @colors[0]
+    @d = @d.rectangle(@graph_left, 0, @graph_left + @graph_width, @graph_height)
+
+    [:high, :low].each_with_index do |indicator, index|
+      next unless @options.has_key?(indicator)
+      @d = @d.fill @colors[index + 1]
+      indicator_width_x  = @graph_left + @graph_width * (@options[indicator] / @maximum_value)
+      @d = @d.rectangle(@graph_left, 0, indicator_width_x, @graph_height)
+    end
+
+    if @options.has_key?(:target)
+      @d = @d.fill @font_color
+      target_x = @graph_left + @graph_width * (@options[:target] / @maximum_value)
+      half_thickness = @thickness / 2.0
+      @d = @d.rectangle(target_x, half_thickness, target_x + half_thickness, @thickness * 2 + half_thickness)
+    end
+
+    # Value
+    @d = @d.fill @font_color
+    @d = @d.rectangle(@graph_left, @thickness, @graph_left + @graph_width * (@value / @maximum_value), @thickness * 2)
+
+    @d.draw(@base_image)
+  end
+
+  def draw_title
+    return unless @title
+
+    @font_height = calculate_caps_height(scale_fontsize(@title_font_size))
+    @title_width = calculate_width(@title_font_size, @title)
+
+    @d.fill        = @font_color
+    @d.font        = @font if @font
+    @d.stroke('transparent')
+    @d.font_weight = NormalWeight
+    @d.pointsize   = scale_fontsize(@title_font_size)
+    @d.gravity     = NorthWestGravity
+    @d             = @d.annotate_scaled(*[
+      @base_image,
+      1.0, 1.0,
+      @font_height/2, @font_height/2,
+      @title,
+      @scale
+    ])
+  end
+
+end

data/lib/gruff/deprecated.rb

@@ -0,0 +1,39 @@
+
+##
+# A mixin for methods that need to be deleted or have been
+# replaced by cleaner code.
+
+module Gruff
+  module Deprecated
+  
+    def scale_measurements
+      setup_graph_measurements
+    end
+    
+    def total_height
+      @rows + 10
+    end
+    
+    def graph_top
+      @graph_top * @scale
+    end
+    
+    def graph_height
+      @graph_height * @scale
+    end
+    
+    def graph_left 
+      @graph_left * @scale 
+    end
+    
+    def graph_width
+      @graph_width * @scale
+    end
+    
+    # TODO Should be calculate_graph_height
+    # def setup_graph_height
+    #   @graph_height = @graph_bottom - @graph_top
+    # end
+  
+  end
+end

data/lib/gruff/dot.rb

@@ -0,0 +1,113 @@
+require File.dirname(__FILE__) + '/base'
+
+##
+# Graph with dots and labels along a vertical access
+# see: 'Creating More Effective Graphs' by Robbins
+
+class Gruff::Dot < Gruff::Base
+
+  def draw
+    @has_left_labels = true
+    super
+
+    return unless @has_data
+
+    # Setup spacing.
+    #
+    spacing_factor = 1.0
+
+    @items_width = @graph_height / @column_count.to_f
+    @item_width = @items_width * spacing_factor / @norm_data.size
+    @d         = @d.stroke_opacity 0.0
+    height     = Array.new(@column_count, 0)
+    length     = Array.new(@column_count, @graph_left)
+    padding    = (@items_width * (1 - spacing_factor)) / 2
+
+    @norm_data.each_with_index do |data_row, row_index|
+      data_row[DATA_VALUES_INDEX].each_with_index do |data_point, point_index|
+
+        x_pos        = @graph_left + (data_point * @graph_width) - (@item_width.to_f/6.0).round
+        y_pos        = @graph_top + (@items_width * point_index) + padding + (@item_width.to_f/2.0).round      
+
+        if row_index == 0
+          @d           = @d.stroke(@marker_color)
+          @d           = @d.stroke_width 1.0
+          @d           = @d.opacity 0.1
+          @d           = @d.line(@graph_left, y_pos, @graph_left + @graph_width, y_pos)
+        end
+
+        @d           = @d.fill data_row[DATA_COLOR_INDEX]
+        @d           = @d.stroke('transparent')
+        @d           = @d.circle(x_pos, y_pos, x_pos + (@item_width.to_f/3.0).round, y_pos)
+
+        # Calculate center based on item_width and current row
+        label_center = @graph_top + (@items_width * point_index + @items_width / 2) + padding
+        draw_label(label_center, point_index)
+      end
+
+    end
+
+    @d.draw(@base_image)
+  end
+
+protected
+
+  # Instead of base class version, draws vertical background lines and label
+  def draw_line_markers
+
+    return if @hide_line_markers
+
+    @d = @d.stroke_antialias false
+
+    # Draw horizontal line markers and annotate with numbers
+    @d = @d.stroke(@marker_color)
+    @d = @d.stroke_width 1
+    number_of_lines = 5
+
+    # TODO Round maximum marker value to a round number like 100, 0.1, 0.5, etc.
+    increment = significant(@maximum_value.to_f / number_of_lines)
+    (0..number_of_lines).each do |index|
+
+      line_diff    = (@graph_right - @graph_left) / number_of_lines
+      x            = @graph_right - (line_diff * index) - 1
+      @d           = @d.line(x, @graph_bottom, x, @graph_bottom + 0.5 * LABEL_MARGIN)
+      diff         = index - number_of_lines
+      marker_label = diff.abs * increment
+
+      unless @hide_line_numbers
+        @d.fill      = @font_color
+        @d.font      = @font if @font
+        @d.stroke    = 'transparent'
+        @d.pointsize = scale_fontsize(@marker_font_size)
+        @d.gravity   = CenterGravity
+        # TODO Center text over line
+        @d           = @d.annotate_scaled( @base_image,
+                          0, 0, # Width of box to draw text in
+                          x, @graph_bottom + (LABEL_MARGIN * 2.0), # Coordinates of text
+                          marker_label.to_s, @scale)
+      end # unless
+      @d = @d.stroke_antialias true
+    end
+  end
+
+  ##
+  # Draw on the Y axis instead of the X
+
+  def draw_label(y_offset, index)
+    if !@labels[index].nil? && @labels_seen[index].nil?
+      @d.fill             = @font_color
+      @d.font             = @font if @font
+      @d.stroke           = 'transparent'
+      @d.font_weight      = NormalWeight
+      @d.pointsize        = scale_fontsize(@marker_font_size)
+      @d.gravity          = EastGravity
+      @d                  = @d.annotate_scaled(@base_image,
+                              1, 1,
+                              -@graph_left + LABEL_MARGIN * 2.0, y_offset,
+                              @labels[index], @scale)
+      @labels_seen[index] = 1
+    end
+  end
+
+end
+

data/lib/gruff/line.rb

@@ -0,0 +1,135 @@
+
+require File.dirname(__FILE__) + '/base'
+
+##
+# Here's how to make a Line graph:
+#
+#   g = Gruff::Line.new
+#   g.title = "A Line Graph"
+#   g.data 'Fries', [20, 23, 19, 8]
+#   g.data 'Hamburgers', [50, 19, 99, 29]
+#   g.write("test/output/line.png")
+#
+# There are also other options described below, such as #baseline_value, #baseline_color, #hide_dots, and #hide_lines.
+
+class Gruff::Line < Gruff::Base
+
+  # Draw a dashed line at the given value
+  attr_accessor :baseline_value
+
+  # Color of the baseline
+  attr_accessor :baseline_color
+  
+  # Dimensions of lines and dots; calculated based on dataset size if left unspecified
+  attr_accessor :line_width
+  attr_accessor :dot_radius
+
+  # Hide parts of the graph to fit more datapoints, or for a different appearance.
+  attr_accessor :hide_dots, :hide_lines
+
+  # Call with target pixel width of graph (800, 400, 300), and/or 'false' to omit lines (points only).
+  #
+  #  g = Gruff::Line.new(400) # 400px wide with lines
+  #
+  #  g = Gruff::Line.new(400, false) # 400px wide, no lines (for backwards compatibility)
+  #
+  #  g = Gruff::Line.new(false) # Defaults to 800px wide, no lines (for backwards compatibility)
+  #
+  # The preferred way is to call hide_dots or hide_lines instead.
+  def initialize(*args)
+    raise ArgumentError, "Wrong number of arguments" if args.length > 2
+    if args.empty? or ((not Numeric === args.first) && (not String === args.first)) then
+      super()
+    else
+      super args.shift
+    end
+
+    @hide_dots = @hide_lines = false
+    @baseline_color = 'red'
+    @baseline_value = nil
+  end
+
+  def draw
+    super
+
+    return unless @has_data
+
+    # Check to see if more than one datapoint was given. NaN can result otherwise.
+    @x_increment = (@column_count > 1) ? (@graph_width / (@column_count - 1).to_f) : @graph_width
+
+    if (defined?(@norm_baseline)) then
+      level = @graph_top + (@graph_height - @norm_baseline * @graph_height)
+      @d = @d.push
+      @d.stroke_color @baseline_color
+      @d.fill_opacity 0.0
+      @d.stroke_dasharray(10, 20)
+      @d.stroke_width 5
+      @d.line(@graph_left, level, @graph_left + @graph_width, level)
+      @d = @d.pop
+    end
+
+    @norm_data.each do |data_row|
+      prev_x = prev_y = nil
+
+      @one_point = contains_one_point_only?(data_row)
+
+      data_row[DATA_VALUES_INDEX].each_with_index do |data_point, index|
+        new_x = @graph_left + (@x_increment * index)
+        next if data_point.nil?
+
+        draw_label(new_x, index)
+
+        new_y = @graph_top + (@graph_height - data_point * @graph_height)
+
+        # Reset each time to avoid thin-line errors
+        @d = @d.stroke data_row[DATA_COLOR_INDEX]
+        @d = @d.fill data_row[DATA_COLOR_INDEX]
+        @d = @d.stroke_opacity 1.0
+        @d = @d.stroke_width line_width ||
+          clip_value_if_greater_than(@columns / (@norm_data.first[DATA_VALUES_INDEX].size * 4), 5.0)
+
+
+        circle_radius = dot_radius ||
+          clip_value_if_greater_than(@columns / (@norm_data.first[DATA_VALUES_INDEX].size * 2.5), 5.0)
+
+        if !@hide_lines and !prev_x.nil? and !prev_y.nil? then
+          @d = @d.line(prev_x, prev_y, new_x, new_y)
+        elsif @one_point
+          # Show a circle if there's just one_point
+          @d = @d.circle(new_x, new_y, new_x - circle_radius, new_y)
+        end
+        @d = @d.circle(new_x, new_y, new_x - circle_radius, new_y) unless @hide_dots
+
+        prev_x = new_x
+        prev_y = new_y
+      end
+
+    end
+
+    @d.draw(@base_image)
+  end
+
+  def normalize
+    @maximum_value = [@maximum_value.to_f, @baseline_value.to_f].max
+    super
+    @norm_baseline = (@baseline_value.to_f / @maximum_value.to_f) if @baseline_value
+  end
+
+  def contains_one_point_only?(data_row)
+    # Spin through data to determine if there is just one_value present.
+    one_point = false
+    data_row[DATA_VALUES_INDEX].each do |data_point|
+      if !data_point.nil?
+        if one_point
+          # more than one point, bail
+          return false
+        else
+          # there is at least one data point
+          return true
+        end
+      end
+    end
+    return one_point
+  end
+
+end

data/lib/gruff/mini/bar.rb

@@ -0,0 +1,37 @@
+##
+#
+# Makes a small bar graph suitable for display at 200px or even smaller.
+#
+module Gruff
+  module Mini
+
+    class Bar < Gruff::Bar
+
+      include Gruff::Mini::Legend
+      
+      def initialize_ivars
+        super
+        
+        @hide_legend = true
+        @hide_title = true
+        @hide_line_numbers = true
+
+        @marker_font_size = 50.0
+        @minimum_value = 0.0
+        @maximum_value = 0.0
+        @legend_font_size = 60.0
+      end
+
+      def draw
+        expand_canvas_for_vertical_legend
+
+        super
+
+        draw_vertical_legend
+        @d.draw(@base_image)
+      end
+
+    end
+  
+  end
+end

data/lib/gruff/mini/legend.rb

@@ -0,0 +1,82 @@
+module Gruff
+  module Mini
+    module Legend
+      
+      attr_accessor :hide_mini_legend
+      
+      ##
+      # The canvas needs to be bigger so we can put the legend beneath it.
+
+      def expand_canvas_for_vertical_legend
+        return if @hide_mini_legend
+        
+        @original_rows = @raw_rows
+        @rows += @data.length * calculate_caps_height(scale_fontsize(@legend_font_size)) * 1.7
+        render_background
+      end
+      
+      ##
+      # Draw the legend beneath the existing graph.
+
+      def draw_vertical_legend
+        return if @hide_mini_legend
+        
+        @legend_labels = @data.collect {|item| item[Gruff::Base::DATA_LABEL_INDEX] }
+        
+        legend_square_width = 40.0 # small square with color of this item
+        legend_square_margin = 10.0
+        @legend_left_margin = 100.0
+        legend_top_margin = 40.0
+
+        # May fix legend drawing problem at small sizes
+        @d.font = @font if @font
+        @d.pointsize = @legend_font_size
+
+        current_x_offset = @legend_left_margin
+        current_y_offset = @original_rows + legend_top_margin
+
+        debug { @d.line 0.0, current_y_offset, @raw_columns, current_y_offset }
+
+        @legend_labels.each_with_index do |legend_label, index|        
+
+          # Draw label
+          @d.fill = @font_color
+          @d.font = @font if @font
+          @d.pointsize = scale_fontsize(@legend_font_size)
+          @d.stroke = 'transparent'
+          @d.font_weight = Magick::NormalWeight
+          @d.gravity = Magick::WestGravity
+          @d = @d.annotate_scaled( @base_image, 
+                            @raw_columns, 1.0,
+                            current_x_offset + (legend_square_width * 1.7), current_y_offset, 
+                            truncate_legend_label(legend_label), @scale)
+
+          # Now draw box with color of this dataset
+          @d = @d.stroke 'transparent'
+          @d = @d.fill @data[index][Gruff::Base::DATA_COLOR_INDEX]
+          @d = @d.rectangle(current_x_offset, 
+                            current_y_offset - legend_square_width / 2.0, 
+                            current_x_offset + legend_square_width, 
+                            current_y_offset + legend_square_width / 2.0)
+          
+          current_y_offset += calculate_caps_height(@legend_font_size) * 1.7
+        end
+        @color_index = 0
+      end
+
+      ##
+      # Shorten long labels so they will fit on the canvas.
+      #
+      #   Department of Hu...
+      
+      def truncate_legend_label(label)
+        truncated_label = label.to_s
+        while calculate_width(scale_fontsize(@legend_font_size), truncated_label) > (@columns - @legend_left_margin - @right_margin) && (truncated_label.length > 1)
+          truncated_label = truncated_label[0..truncated_label.length-2]
+        end
+        truncated_label + (truncated_label.length < label.to_s.length ? "..." : '')
+      end
+      
+    end
+  end
+end

data/lib/gruff/mini/pie.rb

@@ -0,0 +1,36 @@
+##
+#
+# Makes a small pie graph suitable for display at 200px or even smaller.
+#
+module Gruff
+  module Mini
+
+    class Pie < Gruff::Pie
+
+      include Gruff::Mini::Legend
+
+      def initialize_ivars
+        super
+        
+        @hide_legend = true
+        @hide_title = true
+        @hide_line_numbers = true
+  
+        @marker_font_size = 60.0
+        @legend_font_size = 60.0
+      end
+
+      def draw
+        expand_canvas_for_vertical_legend
+        
+        super
+        
+        draw_vertical_legend
+        
+        @d.draw(@base_image)
+      end # def draw
+
+    end # class Pie
+  
+  end
+end

data/lib/gruff/mini/side_bar.rb

@@ -0,0 +1,35 @@
+##
+#
+# Makes a small pie graph suitable for display at 200px or even smaller.
+#
+module Gruff
+  module Mini
+
+    class SideBar < Gruff::SideBar
+
+      include Gruff::Mini::Legend
+      
+      def initialize_ivars
+        super
+        @hide_legend = true
+        @hide_title = true
+        @hide_line_numbers = true
+
+        @marker_font_size = 50.0
+        @legend_font_size = 50.0
+      end
+      
+      def draw
+        expand_canvas_for_vertical_legend
+        
+        super
+        
+        draw_vertical_legend
+        
+        @d.draw(@base_image)
+      end
+      
+    end
+  
+  end
+end