gruff 0.3.4 → 0.3.6

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

@@ -16,10 +16,14 @@ 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
 
@@ -30,7 +34,7 @@ class Gruff::Line < Gruff::Base
   #  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
@@ -39,7 +43,7 @@ class Gruff::Line < Gruff::Base
     else
       super args.shift
     end
-    
+
     @hide_dots = @hide_lines = false
     @baseline_color = 'red'
     @baseline_value = nil
@@ -49,10 +53,10 @@ class Gruff::Line < Gruff::Base
     super
 
     return unless @has_data
-    
-    # Check to see if more than one datapoint was given. NaN can result otherwise.  
+
+    # 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
@@ -64,9 +68,11 @@ class Gruff::Line < Gruff::Base
       @d = @d.pop
     end
 
-    @norm_data.each do |data_row|      
+    @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?
@@ -79,12 +85,19 @@ class Gruff::Line < Gruff::Base
         @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 clip_value_if_greater_than(@columns / (@norm_data.first[DATA_VALUES_INDEX].size * 4), 5.0)
+        @d = @d.stroke_width line_width ||
+          clip_value_if_greater_than(@columns / (@norm_data.first[DATA_VALUES_INDEX].size * 4), 5.0)
+
 
-        if !@hide_lines and !prev_x.nil? and !prev_y.nil? then          
+        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
-        circle_radius = clip_value_if_greater_than(@columns / (@norm_data.first[DATA_VALUES_INDEX].size * 2.5), 5.0)
         @d = @d.circle(new_x, new_y, new_x - circle_radius, new_y) unless @hide_dots
 
         prev_x = new_x
@@ -101,5 +114,22 @@ class Gruff::Line < Gruff::Base
     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

@@ -9,15 +9,20 @@ module Gruff
 
       include Gruff::Mini::Legend
       
-      def draw
+      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

data/lib/gruff/mini/legend.rb

@@ -2,10 +2,14 @@ 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
@@ -15,7 +19,8 @@ module Gruff
       # 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
@@ -69,7 +74,7 @@ module Gruff
         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 ? "…" : '')
+        truncated_label + (truncated_label.length < label.to_s.length ? "..." : '')
       end
       
     end

data/lib/gruff/net.rb

@@ -6,11 +6,16 @@ class Gruff::Net < Gruff::Base
 
   # Hide parts of the graph to fit more datapoints, or for a different appearance.
   attr_accessor :hide_dots
+  
+  # Dimensions of lines and dots; calculated based on dataset size if left unspecified
+  attr_accessor :line_width
+  attr_accessor :dot_radius
 
   def initialize(*args)
     super
     
     @hide_dots = false
+    @hide_line_numbers = true
   end
 
   def draw
@@ -24,10 +29,12 @@ class Gruff::Net < Gruff::Base
     @center_y = @graph_top + (@graph_height / 2.0) - 10 # Move graph up a bit
 
     @x_increment = @graph_width / (@column_count - 1).to_f
-    circle_radius = clip_value_if_greater_than(@columns / (@norm_data.first[DATA_VALUES_INDEX].size * 2.5), 5.0)
+    circle_radius = dot_radius ||
+      clip_value_if_greater_than(@columns / (@norm_data.first[DATA_VALUES_INDEX].size * 2.5), 5.0)
 
     @d = @d.stroke_opacity 1.0
-    @d = @d.stroke_width clip_value_if_greater_than(@columns / (@norm_data.first[DATA_VALUES_INDEX].size * 4), 5.0)
+    @d = @d.stroke_width line_width ||
+      clip_value_if_greater_than(@columns / (@norm_data.first[DATA_VALUES_INDEX].size * 4), 5.0)
 
     if (defined?(@norm_baseline)) then
       level = @graph_top + (@graph_height - @norm_baseline * @graph_height)
@@ -115,16 +122,7 @@ private
     @d.pointsize = scale_fontsize(20)
     @d.stroke = 'transparent'
     @d.font_weight = BoldWeight
-    s = angle.deg2rad / (2*Math::PI)
-    @d.gravity = SouthGravity     if s >= 0.96 or s < 0.04
-    @d.gravity = SouthWestGravity if s >= 0.04 or s < 0.21
-    @d.gravity = WestGravity      if s >= 0.21 or s < 0.29
-    @d.gravity = NorthWestGravity if s >= 0.29 or s < 0.46
-    @d.gravity = NorthGravity     if s >= 0.46 or s < 0.54
-    @d.gravity = NorthEastGravity if s >= 0.54 or s < 0.71
-    @d.gravity = EastGravity      if s >= 0.71 or s < 0.79
-    @d.gravity = SouthEastGravity if s >= 0.79 or s < 0.96
-#     @d.gravity = NorthGravity
+    @d.gravity = CenterGravity
     @d.annotate_scaled(@base_image, 0, 0, x, y, amount, @scale)
   end
 

data/lib/gruff/side_bar.rb

@@ -13,13 +13,14 @@ class Gruff::SideBar < Gruff::Base
 
     # Setup spacing.
     #
-    spacing_factor = 0.9
+    @bar_spacing ||= 0.9
 
     @bars_width = @graph_height / @column_count.to_f
-    @bar_width = @bars_width * spacing_factor / @norm_data.size
+    @bar_width = @bars_width * @bar_spacing / @norm_data.size
     @d         = @d.stroke_opacity 0.0
     height     = Array.new(@column_count, 0)
     length     = Array.new(@column_count, @graph_left)
+    padding    = (@bars_width * (1 - @bar_spacing)) / 2
 
     @norm_data.each_with_index do |data_row, row_index|
       @d = @d.fill data_row[DATA_COLOR_INDEX]
@@ -34,7 +35,7 @@ class Gruff::SideBar < Gruff::Base
         difference = temp2 - temp1
 
         left_x     = length[point_index] - 1
-        left_y     = @graph_top + (@bars_width * point_index) + (@bar_width * row_index)
+        left_y     = @graph_top + (@bars_width * point_index) + (@bar_width * row_index) + padding
         right_x    = left_x + difference
         right_y    = left_y + @bar_width
 

data/lib/gruff/side_stacked_bar.rb

@@ -21,12 +21,13 @@ class Gruff::SideStackedBar < Gruff::SideBar
     # Setup spacing.
     #
     # Columns sit stacked.
-    spacing_factor = 0.9
+    @bar_spacing ||= 0.9
 
     @bar_width = @graph_height / @column_count.to_f
     @d = @d.stroke_opacity 0.0
     height = Array.new(@column_count, 0)
     length = Array.new(@column_count, @graph_left)
+    padding = (@bar_width * (1 - @bar_spacing)) / 2
 
     @norm_data.each_with_index do |data_row, row_index|
       @d = @d.fill data_row[DATA_COLOR_INDEX]
@@ -42,16 +43,16 @@ class Gruff::SideStackedBar < Gruff::SideBar
     	  difference = temp2 - temp1
 
     	  left_x = length[point_index] #+ 1
-              left_y = @graph_top + (@bar_width * point_index)
+              left_y = @graph_top + (@bar_width * point_index) + padding
     	  right_x = left_x + difference
-              right_y = left_y + @bar_width * spacing_factor
+              right_y = left_y + @bar_width * @bar_spacing
     	  length[point_index] += difference
         height[point_index] += (data_point * @graph_width - 2)
 
         @d = @d.rectangle(left_x, left_y, right_x, right_y)
 
         # Calculate center based on bar_width and current row
-        label_center = @graph_top + (@bar_width * point_index) + (@bar_width * spacing_factor / 2.0)
+        label_center = @graph_top + (@bar_width * point_index) + (@bar_width * @bar_spacing / 2.0)
         draw_label(label_center, point_index)
       end
 

data/lib/gruff/stacked_bar.rb

@@ -14,8 +14,9 @@ class Gruff::StackedBar < Gruff::Base
       # Setup spacing.
       #
       # Columns sit stacked.
-      spacing_factor = 0.9
+      @bar_spacing ||= 0.9
       @bar_width = @graph_width / @column_count.to_f
+      padding = (@bar_width * (1 - @bar_spacing)) / 2
     
       @d = @d.stroke_opacity 0.0
       
@@ -26,16 +27,16 @@ class Gruff::StackedBar < Gruff::Base
           @d = @d.fill data_row[DATA_COLOR_INDEX]
           
           # Calculate center based on bar_width and current row
-          label_center = @graph_left + (@bar_width * point_index) + (@bar_width * spacing_factor / 2.0)
+          label_center = @graph_left + (@bar_width * point_index) + (@bar_width * @bar_spacing / 2.0)
           draw_label(label_center, point_index)
 
           next if (data_point == 0)
           # Use incremented x and scaled y
-          left_x = @graph_left + (@bar_width * point_index)
+          left_x = @graph_left + (@bar_width * point_index) + padding
           left_y = @graph_top + (@graph_height -
                                  data_point * @graph_height - 
                                  height[point_index]) + 1
-          right_x = left_x + @bar_width * spacing_factor
+          right_x = left_x + @bar_width * @bar_spacing
           right_y = @graph_top + @graph_height - height[point_index] - 1
           
           # update the total height of the current stacked bar

data/test/test_bar.rb

@@ -20,6 +20,7 @@ class TestGruffBar < GruffTestCase
   def test_bar_graph
     g = setup_basic_graph
     g.title = "Bar Graph Test"
+    g.title_margin = 100
     g.write("test/output/bar_keynote.png")
         
     g = setup_basic_graph
@@ -32,10 +33,20 @@ class TestGruffBar < GruffTestCase
     g.theme_odeo
     g.write("test/output/bar_odeo.png")
   end
+  
+  def test_thousand_separators
+    g = Gruff::Bar.new(600)
+    g.title = "Formatted numbers"
+    g.bar_spacing = 0.2
+    g.marker_count = 8
+    g.data("data", [4025, 1024, 50257, 703672, 1580456])
+    g.write("test/output/bar_formatted_numbers.png")
+  end
 
   def test_bar_graph_set_colors
     g = Gruff::Bar.new
     g.title = "Bar Graph With Manual Colors"
+    g.legend_margin = 50
     g.labels = {
       0 => '5/6', 
       1 => '5/15', 
@@ -248,6 +259,18 @@ class TestGruffBar < GruffTestCase
     g.minimum_value = 0
     g.write("test/output/bar_themed.png")
   end
+  
+  def test_legend_should_not_overlap
+    g = Gruff::Bar.new(400)
+    g.theme_37signals()
+    g.title = 'My Graph'
+    g.data("Apples Oranges Watermelon Apples Oranges", [1, 2, 3, 4, 4, 3])
+    g.data('Oranges', [4, 8, 7, 9, 8, 9])
+    g.data('Watermelon', [2, 3, 1, 5, 6, 8])
+    g.data('Peaches', [9, 9, 10, 8, 7, 9])
+    g.labels = {0 => '2003', 2 => '2004', 4 => '2005'}
+    g.write("test/output/bar_long_legend_text.png")
+  end
 
   def test_july_enhancements
     g = Gruff::Bar.new(600)