gruff 0.3.6 → 0.3.7

data/lib/gruff/mini/legend.rb

@@ -1,28 +1,49 @@
 module Gruff
   module Mini
     module Legend
-      
-      attr_accessor :hide_mini_legend
-      
+
+      attr_accessor :hide_mini_legend, :legend_position
+
       ##
       # 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
-        
+
+        @legend_labels = @data.collect {|item| item[Gruff::Base::DATA_LABEL_INDEX] }
+
+        legend_height = scale_fontsize(
+                                       @data.length * calculate_line_height +
+                                       @top_margin + @bottom_margin)
+
         @original_rows = @raw_rows
-        @rows += @data.length * calculate_caps_height(scale_fontsize(@legend_font_size)) * 1.7
+        @original_columns = @raw_columns
+
+        case @legend_position
+        when :right then
+          @rows = [@rows, legend_height].max
+          @columns += calculate_legend_width + @left_margin
+        else
+          @rows += @data.length * calculate_caps_height(scale_fontsize(@legend_font_size)) * 1.7
+        end
         render_background
       end
-      
+
+      def calculate_line_height
+        calculate_caps_height(@legend_font_size) * 1.7
+      end
+
+      def calculate_legend_width
+        width = @legend_labels.map { |label| calculate_width(@legend_font_size, label) }.max
+        scale_fontsize(width + 40*1.7)
+      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
@@ -32,12 +53,18 @@ module Gruff
         @d.font = @font if @font
         @d.pointsize = @legend_font_size
 
-        current_x_offset = @legend_left_margin
-        current_y_offset = @original_rows + legend_top_margin
+        case @legend_position
+        when :right then
+          current_x_offset = @original_columns + @left_margin
+          current_y_offset = @top_margin + legend_top_margin
+        else
+          current_x_offset = @legend_left_margin
+          current_y_offset = @original_rows + legend_top_margin
+        end
 
         debug { @d.line 0.0, current_y_offset, @raw_columns, current_y_offset }
 
-        @legend_labels.each_with_index do |legend_label, index|        
+        @legend_labels.each_with_index do |legend_label, index|
 
           # Draw label
           @d.fill = @font_color
@@ -46,20 +73,20 @@ module Gruff
           @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)
+          @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, 
+          @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
+
+          current_y_offset += calculate_line_height
         end
         @color_index = 0
       end
@@ -68,7 +95,7 @@ module Gruff
       # 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)
@@ -76,7 +103,7 @@ module Gruff
         end
         truncated_label + (truncated_label.length < label.to_s.length ? "..." : '')
       end
-      
+
     end
   end
 end

data/lib/gruff/pie.rb

@@ -18,10 +18,14 @@ class Gruff::Pie < Gruff::Base
   # Can be used to make the pie start cutting slices at the top (-90.0)
   # or at another angle. Default is 0.0, which starts at 3 o'clock.
   attr_accessor :zero_degree
+  # Do not show labels for slices that are less than this percent. Use 0 to always show all labels.
+  # Defaults to 0
+  attr_accessor :hide_labels_less_than
 
   def initialize_ivars
     super
     @zero_degree = 0.0
+    @hide_labels_less_than = 0.0
   end
 
   def draw
@@ -58,17 +62,15 @@ class Gruff::Pie < Gruff::Base
                   
         half_angle = prev_degrees + ((prev_degrees + current_degrees) - prev_degrees) / 2
         
-        # Following line is commented to allow display of the percentiles
-        # bug appeared between r90 and r92
-        # unless @hide_line_markers then
+        label_val = ((data_row[DATA_VALUES_INDEX].first / total_sum) * 100.0).round
+        unless label_val < @hide_labels_less_than
           # End the string with %% to escape the single %.
           # RMagick must use sprintf with the string and % has special significance.
-          label_string = ((data_row[DATA_VALUES_INDEX].first / total_sum) *
-                          100.0).round.to_s + '%%'
+          label_string = label_val.to_s + '%%'
           @d = draw_label(center_x,center_y, half_angle,
                           radius + (radius * TEXT_OFFSET_PERCENTAGE),
                           label_string)
-        # end
+        end
 
         prev_degrees += current_degrees
       end

data/lib/gruff/scatter.rb

@@ -0,0 +1,268 @@
+require File.dirname(__FILE__) + '/base'
+
+# Here's how to set up an XY Scatter Chart
+#
+# g = Gruff::Scatter.new(800)
+# g.data(:apples, [1,2,3,4], [4,3,2,1])
+# g.data('oranges', [5,7,8], [4,1,7])
+# g.write('test/output/scatter.png')
+# 
+#
+class Gruff::Scatter < Gruff::Base
+
+  # Maximum X Value. The value will get overwritten by the max in the
+  # datasets.  
+  attr_accessor :maximum_x_value
+  
+  # Minimum X Value. The value will get overwritten by the min in the 
+  # datasets.  
+  attr_accessor :minimum_x_value
+  
+  # The number of vertical lines shown for reference
+  attr_accessor :marker_x_count
+  
+  #~ # Draw a dashed horizontal line at the given y value
+  #~ attr_accessor :baseline_y_value
+	
+  #~ # Color of the horizontal baseline
+  #~ attr_accessor :baseline_y_color
+  
+  #~ # Draw a dashed horizontal line at the given y value
+  #~ attr_accessor :baseline_x_value
+	
+  #~ # Color of the horizontal baseline
+  #~ attr_accessor :baseline_x_color
+  
+  
+  # Gruff::Scatter takes the same parameters as the Gruff::Line graph
+  #
+  # ==== Example
+  #
+  # g = Gruff::Scatter.new
+  #
+  def initialize(*args)
+    super(*args)
+    
+    @maximum_x_value = @minimum_x_value = nil
+    @baseline_x_color = @baseline_y_color = 'red'
+    @baseline_x_value = @baseline_y_value = nil
+    @marker_x_count = nil
+  end
+  
+  def draw
+    calculate_spread
+    @sort = false
+    
+    # TODO Need to get x-axis labels working. Current behavior will be to not allow.
+    @labels = {}
+    
+    # Translate our values so that we can use the base methods for drawing
+    # the standard chart stuff
+    @column_count = @x_spread
+
+    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_y_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
+
+    #~ if (defined?(@norm_x_baseline)) then
+      
+    #~ end
+
+    @norm_data.each do |data_row|      
+      prev_x = prev_y = nil
+
+      data_row[DATA_VALUES_INDEX].each_with_index do |data_point, index|
+        x_value = data_row[DATA_VALUES_X_INDEX][index]
+        next if data_point.nil? || x_value.nil? 
+
+        new_x = getXCoord(x_value, @graph_width, @graph_left)
+        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 clip_value_if_greater_than(@columns / (@norm_data.first[1].size * 4), 5.0)
+
+        circle_radius = clip_value_if_greater_than(@columns / (@norm_data.first[1].size * 2.5), 5.0)
+        @d = @d.circle(new_x, new_y, new_x - circle_radius, new_y)
+
+        prev_x = new_x
+        prev_y = new_y
+      end
+    end
+
+    @d.draw(@base_image)
+  end
+  
+  # The first parameter is the name of the dataset.  The next two are the
+  # x and y axis data points contain in their own array in that respective
+  # order.  The final parameter is the color.
+  #
+  # Can be called multiple times with different datasets for a multi-valued
+  # graph.
+  #
+  # If the color argument is nil, the next color from the default theme will
+  # be used.
+  #
+  # NOTE: If you want to use a preset theme, you must set it before calling
+  # data().
+  #
+  # ==== Parameters
+  # name:: String or Symbol containing the name of the dataset.
+  # x_data_points:: An Array of of x-axis data points. 
+  # y_data_points:: An Array of of y-axis data points. 
+  # color:: The hex string for the color of the dataset.  Defaults to nil.
+  #
+  # ==== Exceptions
+  # Data points contain nil values::
+  #   This error will get raised if either the x or y axis data points array
+  #   contains a <tt>nil</tt> value.  The graph will not make an assumption
+  #   as how to graph <tt>nil</tt>
+  # x_data_points is empty::
+  #   This error is raised when the array for the x-axis points are empty
+  # y_data_points is empty::
+  #   This error is raised when the array for the y-axis points are empty
+  # x_data_points.length != y_data_points.length::
+  #   Error means that the x and y axis point arrays do not match in length
+  #
+  # ==== Examples
+  # g = Gruff::Scatter.new
+  # g.data(:apples, [1,2,3], [3,2,1])
+  # g.data('oranges', [1,1,1], [2,3,4])
+  # g.data('bitter_melon', [3,5,6], [6,7,8], '#000000')
+  #
+  def data(name, x_data_points=[], y_data_points=[], color=nil)
+    
+    raise ArgumentError, "Data Points contain nil Value!" if x_data_points.include?(nil) || y_data_points.include?(nil)
+    raise ArgumentError, "x_data_points is empty!" if x_data_points.empty?
+    raise ArgumentError, "y_data_points is empty!" if y_data_points.empty?
+    raise ArgumentError, "x_data_points.length != y_data_points.length!" if x_data_points.length != y_data_points.length
+    
+    # Call the existing data routine for the y axis data
+    super(name, y_data_points, color)
+    
+    #append the x data to the last entry that was just added in the @data member
+    lastElem = @data.length()-1
+    @data[lastElem] << x_data_points
+    
+    if @maximum_x_value.nil? && @minimum_x_value.nil?
+      @maximum_x_value = @minimum_x_value = x_data_points.first
+    end
+    
+    @maximum_x_value = x_data_points.max > @maximum_x_value ?
+                        x_data_points.max : @maximum_x_value
+    @minimum_x_value = x_data_points.min < @minimum_x_value ?
+                        x_data_points.min : @minimum_x_value
+  end
+  
+protected
+  
+  def calculate_spread #:nodoc:
+    super
+    @x_spread = @maximum_x_value.to_f - @minimum_x_value.to_f
+    @x_spread = @x_spread > 0 ? @x_spread : 1
+  end
+  
+  def normalize(force=@xy_normalize)
+    if @norm_data.nil? || force 
+      @norm_data = []
+      return unless @has_data
+      
+      @data.each do |data_row|
+        norm_data_points = [data_row[DATA_LABEL_INDEX]]
+        norm_data_points << data_row[DATA_VALUES_INDEX].map do |r|  
+                                (r.to_f - @minimum_value.to_f) / @spread
+                            end
+        norm_data_points << data_row[DATA_COLOR_INDEX]
+        norm_data_points << data_row[DATA_VALUES_X_INDEX].map do |r|  
+                                (r.to_f - @minimum_x_value.to_f) / @x_spread 
+                            end
+        @norm_data << norm_data_points
+      end
+    end
+    #~ @norm_y_baseline = (@baseline_y_value.to_f / @maximum_value.to_f) if @baseline_y_value
+    #~ @norm_x_baseline = (@baseline_x_value.to_f / @maximum_x_value.to_f) if @baseline_x_value
+  end
+  
+  def draw_line_markers
+    # do all of the stuff for the horizontal lines on the y-axis
+    super
+    return if @hide_line_markers
+    
+    @d = @d.stroke_antialias false
+
+    if @x_axis_increment.nil?
+      # TODO Do the same for larger numbers...100, 75, 50, 25
+      if @marker_x_count.nil?
+        (3..7).each do |lines|
+          if @x_spread % lines == 0.0
+            @marker_x_count = lines
+            break
+          end
+        end
+        @marker_x_count ||= 4
+      end
+      @x_increment = (@x_spread > 0) ? significant(@x_spread / @marker_x_count) : 1
+    else
+      # TODO Make this work for negative values
+      @maximum_x_value = [@maximum_value.ceil, @x_axis_increment].max
+      @minimum_x_value = @minimum_x_value.floor
+      calculate_spread
+      normalize(true)
+      
+      @marker_count = (@x_spread / @x_axis_increment).to_i
+      @x_increment = @x_axis_increment
+    end
+    @increment_x_scaled = @graph_width.to_f / (@x_spread / @x_increment)
+
+    # Draw vertical line markers and annotate with numbers
+    (0..@marker_x_count).each do |index|
+      x = @graph_left + @graph_width - index.to_f * @increment_x_scaled
+      
+      # TODO Fix the vertical lines.  Not pretty when they don't match up with top y-axis line
+      #~ @d = @d.stroke(@marker_color)
+      #~ @d = @d.stroke_width 1
+      #~ @d = @d.line(x, @graph_top, x, @graph_bottom)
+
+      unless @hide_line_numbers
+        marker_label = index * @x_increment + @minimum_x_value.to_f
+        y_offset = @graph_bottom + LABEL_MARGIN 
+        x_offset = getXCoord(index.to_f, @increment_x_scaled, @graph_left)
+
+        @d.fill = @font_color
+        @d.font = @font if @font
+        @d.stroke('transparent')
+        @d.pointsize = scale_fontsize(@marker_font_size)
+        @d.gravity = NorthGravity
+        
+        @d = @d.annotate_scaled(@base_image, 
+                          1.0, 1.0, 
+                          x_offset, y_offset, 
+                          label(marker_label), @scale)
+      end
+    end
+    
+    @d = @d.stroke_antialias true
+  end
+  
+private
+  
+  def getXCoord(x_data_point, width, offset) #:nodoc:
+    return(x_data_point * width + offset)
+  end
+  
+end # end Gruff::Scatter

data/lib/gruff/scene.rb

@@ -133,7 +133,7 @@ class Gruff::Layer
   def initialize(base_dir, folder_name)
     @base_dir = base_dir.to_s
     @name = folder_name.to_s
-    @filenames = Dir.open(File.join(base_dir, folder_name)).entries.select { |file| file =~ /^[^.]+\.png$/ }
+    @filenames = Dir.open(File.join(base_dir, folder_name)).entries.select { |file| file =~ /^[^.]+\.png$/ }.sort
     @selected_filename = select_default
   end
   

data/lib/gruff/side_bar.rb

@@ -5,22 +5,30 @@ require File.dirname(__FILE__) + '/base'
 
 class Gruff::SideBar < Gruff::Base
 
+  # Spacing factor applied between bars
+  attr_accessor :bar_spacing
+  
   def draw
     @has_left_labels = true
     super
 
     return unless @has_data
+    draw_bars
+  end
+
+protected
 
+  def draw_bars
     # Setup spacing.
     #
     @bar_spacing ||= 0.9
 
     @bars_width = @graph_height / @column_count.to_f
-    @bar_width = @bars_width * @bar_spacing / @norm_data.size
+    @bar_width = @bars_width / @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
+    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]
@@ -37,7 +45,7 @@ class Gruff::SideBar < Gruff::Base
         left_x     = length[point_index] - 1
         left_y     = @graph_top + (@bars_width * point_index) + (@bar_width * row_index) + padding
         right_x    = left_x + difference
-        right_y    = left_y + @bar_width
+        right_y    = left_y + @bar_width * @bar_spacing
 
         height[point_index] += (data_point * @graph_width)
 
@@ -53,8 +61,6 @@ class Gruff::SideBar < Gruff::Base
     @d.draw(@base_image)
   end
 
-protected
-
   # Instead of base class version, draws vertical background lines and label
   def draw_line_markers
 
@@ -68,14 +74,14 @@ protected
     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)
+    increment = significant(@spread.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_top)
       diff         = index - number_of_lines
-      marker_label = diff.abs * increment
+      marker_label = diff.abs * increment + @minimum_value
 
       unless @hide_line_numbers
         @d.fill      = @font_color