gruff 0.2.4 → 0.2.5

data/Manifest.txt

@@ -19,6 +19,11 @@ lib/gruff/side_stacked_bar.rb
 lib/gruff/spider.rb
 lib/gruff/stacked_bar.rb
 
+lib/gruff/mini/bar.rb
+lib/gruff/mini/pie.rb
+lib/gruff/mini/side_bar.rb
+lib/gruff/mini/legend.rb
+
 test/test_area.rb
 test/test_bar.rb
 test/test_base.rb
@@ -33,3 +38,7 @@ test/test_scene.rb
 test/test_sidestacked_bar.rb
 test/test_spider.rb
 test/test_stacked_bar.rb
+
+test/test_mini_bar.rb
+test/test_mini_pie.rb
+test/test_mini_side_bar.rb

data/lib/gruff.rb

@@ -1,15 +1,23 @@
-# Extra full path added to fix some require errors on some installations.
+# Extra full path added to fix loading errors on some installations.
 
-require File.dirname(__FILE__) + '/gruff/base'
+%w(
+  base
+  area
+  bar
+  line
+  pie
+  spider
+  net
+  stacked_bar
+  side_stacked_bar
+  side_bar
 
-require File.dirname(__FILE__) + '/gruff/area'
-require File.dirname(__FILE__) + '/gruff/bar'
-require File.dirname(__FILE__) + '/gruff/line'
-require File.dirname(__FILE__) + '/gruff/pie'
-require File.dirname(__FILE__) + '/gruff/spider'
-require File.dirname(__FILE__) + '/gruff/net'
-require File.dirname(__FILE__) + '/gruff/stacked_bar'
-require File.dirname(__FILE__) + '/gruff/side_stacked_bar'
-# require File.dirname(__FILE__) + '/gruff/photo_bar'
+  scene
 
-require File.dirname(__FILE__) + '/gruff/scene'
+  mini/legend
+  mini/bar
+  mini/pie
+  mini/side_bar
+).each do |filename|
+  require File.dirname(__FILE__) + "/gruff/#{filename}"
+end

data/lib/gruff/bar.rb

@@ -13,10 +13,16 @@ class Gruff::Bar < Gruff::Base
     super
     return unless @has_data
 
+    draw_bars
+  end
+
+protected
+
+  def draw_bars
     # Setup spacing.
     #
     # Columns sit side-by-side.
-    spacing_factor = 0.9
+    spacing_factor = 0.9 # space between the bars
     @bar_width = @graph_width / (@column_count * @data.length).to_f
 
     @d = @d.stroke_opacity 0.0
@@ -72,7 +78,7 @@ class Gruff::Bar < Gruff::Base
     # Draw the last label if requested
     draw_label(@graph_right, @column_count) if @center_labels_over_point
 
-    @d.draw(@base_image)    
+    @d.draw(@base_image)
   end
 
 end

data/lib/gruff/bar_conversion.rb

@@ -1,22 +1,13 @@
-##############################################################################
+##
+# Original Author: David Stokar
 #
-#  Ruby Gruff/bar_conversion 
+#	This class perfoms the y coordinats conversion for the bar class.
 #
-#  Copyright: David Stokar
+#	There are three cases: 
 #
-#  Date Written: 2006/01/27
-#
-#  $Revision: 0.2 $
-#
-#  $Log: bar_conversion.rb $
-#  $Log: Added comments $
-##############################################################################
-
-#
-#	This class perfoms the y coordinats conversion for the bar class
-#	There are 3 cases: 1. Bars all go from zero in positiv direction
-#					   2. Bars all go from zero to negativ direction	
-#					   3. Bars either go from zero to positiv or from zero to negativ	
+#   1. Bars all go from zero in positive direction
+#		2. Bars all go from zero to negative direction	
+#		3. Bars either go from zero to positive or from zero to negative
 #
 class Gruff::BarConversion
 	attr_writer :mode

data/lib/gruff/base.rb

@@ -20,7 +20,7 @@ require File.dirname(__FILE__) + '/deprecated'
 
 module Gruff
   
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
   
   class Base
   
@@ -53,6 +53,9 @@ module Gruff
     # By default, labels are centered over the point they represent.
     attr_accessor :center_labels_over_point
 
+    # Used internally for horizontal graph types.
+    attr_accessor :has_left_labels
+
     # A label for the bottom of the graph
     attr_accessor :x_axis_label
     
@@ -77,6 +80,8 @@ module Gruff
     # ENV['MAGICK_FONT_PATH']. Uses default RMagick font otherwise.
     attr_reader :font
 
+    attr_accessor :font_color
+
     # Hide various elements
     attr_accessor :hide_line_markers, :hide_legend, :hide_title, :hide_line_numbers
 
@@ -91,7 +96,7 @@ module Gruff
     # The font size of the labels around the graph
     attr_accessor :marker_font_size
     
-    # The color of the auxiliary labels and lines
+    # The color of the auxiliary lines
     attr_accessor :marker_color
 
     # The number of horizontal lines shown for reference
@@ -162,9 +167,11 @@ module Gruff
 
       @hide_line_markers = @hide_legend = @hide_title = @hide_line_numbers = false
       @center_labels_over_point = true
+      @has_left_labels = false
 
       @additional_line_values = []      
       @additional_line_colors = []
+      @theme_options = {}
       
       @x_axis_label = @y_axis_label = nil
       @y_axis_increment = nil
@@ -175,42 +182,6 @@ module Gruff
       theme_keynote()
     end
     
-
-
-    # You can set a theme manually. Assign a hash to this method before you send your data.
-    #
-    #  graph.theme = {
-    #    :colors => %w(orange purple green white red),
-    #    :marker_color => 'blue',
-    #    :background_colors => %w(black grey)
-    #  }
-    #
-    # :background_image => 'squirrel.png' is also possible.
-    #
-    # (Or hopefully something better looking than that.)
-    #
-    def theme=(options)
-      defaults = {
-        :colors => ['black', 'white'],
-        :additional_line_colors => ['grey'],
-        :marker_color => 'white',
-        :background_colors => nil,
-        :background_image => nil
-      }
-      options = defaults.merge options
-
-      reset_themes()
-
-      @colors = options[:colors]
-      @marker_color = options[:marker_color]
-      @additional_line_colors = options[:additional_line_colors]
-      if not options[:background_colors].nil?
-        @base_image = render_gradiated_background(*options[:background_colors])
-      else
-        @base_image = render_image_background(*options[:background_image])
-      end
-    end
-
     def font=(font_path)
       @font = font_path
       @d.font = @font
@@ -234,18 +205,42 @@ module Gruff
       @colors = color_list
     end
 
+
+    # You can set a theme manually. Assign a hash to this method before you send your data.
+    #
+    #  graph.theme = {
+    #    :colors => %w(orange purple green white red),
+    #    :marker_color => 'blue',
+    #    :background_colors => %w(black grey)
+    #  }
+    #
+    # :background_image => 'squirrel.png' is also possible.
+    #
+    # (Or hopefully something better looking than that.)
+    #
+    def theme=(options)
+      reset_themes()
+      
+      defaults = {
+        :colors => ['black', 'white'],
+        :additional_line_colors => [],
+        :marker_color => 'white',
+        :font_color => 'black',
+        :background_colors => nil,
+        :background_image => nil
+      }
+      @theme_options = defaults.merge options
+
+      @colors = @theme_options[:colors]
+      @marker_color = @theme_options[:marker_color]
+      @font_color = @theme_options[:font_color] || @marker_color
+      @additional_line_colors = @theme_options[:additional_line_colors]
+      
+      render_background
+    end
     
     # A color scheme similar to the popular presentation software.
     def theme_keynote
-      # defaults = {
-      #   :colors => ['black', 'white'],
-      #   :additional_line_colors => ['grey'],
-      #   :marker_color => 'white',
-      #   :background_colors => nil,
-      #   :background_image => nil
-      # }
-      
-      reset_themes()
       # Colors
       @blue = '#6886B4'
       @yellow = '#FDD84E'
@@ -256,14 +251,16 @@ module Gruff
       @white = 'white'
       @colors = [@yellow, @blue, @green, @red, @purple, @orange, @white]
 
-      @marker_color = 'white'
-      
-      @base_image = render_gradiated_background('black', '#4a465a')      
+      self.theme = {
+        :colors => @colors,
+        :marker_color => 'white',
+        :font_color => 'white',
+        :background_colors => ['black', '#4a465a']
+      }
     end
     
     # A color scheme plucked from the colors on the popular usability blog.
     def theme_37signals
-      reset_themes()
       # Colors
       @green = '#339933'
       @purple = '#cc99cc'
@@ -274,14 +271,16 @@ module Gruff
       @black = 'black'
       @colors = [@yellow, @blue, @green, @red, @purple, @orange, @black]
 
-      @marker_color = 'black'
-      
-      @base_image = render_gradiated_background('#d1edf5', 'white')
+      self.theme = {
+        :colors => @colors,
+        :marker_color => 'black',
+        :font_color => 'black',
+        :background_colors => ['#d1edf5', 'white']
+      }
     end
 
     # A color scheme from the colors used on the 2005 Rails keynote presentation at RubyConf.
     def theme_rails_keynote
-      reset_themes()
       # Colors
       @green = '#00ff00'
       @grey = '#333333'
@@ -291,15 +290,17 @@ module Gruff
       @light_grey = '#999999'
       @black = 'black'
       @colors = [@green, @grey, @orange, @red, @white, @light_grey, @black]
-
-      @marker_color = 'white'
       
-      @base_image = render_gradiated_background('#0083a3', '#0083a3')
+      self.theme = {
+        :colors => @colors,
+        :marker_color => 'white',
+        :font_color => 'white',
+        :background_colors => ['#0083a3', '#0083a3']
+      }
     end
 
     # A color scheme similar to that used on the popular podcast site.
     def theme_odeo
-      reset_themes()
       # Colors
       @grey = '#202020'
       @white = 'white'
@@ -309,10 +310,13 @@ module Gruff
       @dark_blue = '#3a5b87'
       @black = 'black'
       @colors = [@grey, @white, @dark_blue, @dark_pink, @green, @light_grey, @black]
-
-      @marker_color = 'white'
       
-      @base_image = render_gradiated_background('#ff47a4', '#ff1f81')
+      self.theme = {
+        :colors => @colors,
+        :marker_color => 'white',
+        :font_color => 'white',
+        :background_colors => ['#ff47a4', '#ff1f81']
+      }
     end
 
     # Parameters are an array where the first element is the name of the dataset
@@ -378,13 +382,13 @@ protected
       make_stacked if @stacked
       setup_drawing()
       
-      debug do
+      debug {
         # Outer margin
         @d.rectangle( LEFT_MARGIN, TOP_MARGIN, 
                             @raw_columns - RIGHT_MARGIN, @raw_rows - BOTTOM_MARGIN)
         # Graph area box
         @d.rectangle( @graph_left, @graph_top, @graph_right, @graph_bottom)
-      end
+      }
     end
 
     # Draws the decorations.
@@ -489,9 +493,9 @@ protected
         x_axis_label_y_coordinate = @graph_bottom + LABEL_MARGIN * 2 + @marker_caps_height
 
         # TODO Center between graph area
-        @d.fill = @marker_color
+        @d.fill = @font_color
         @d.font = @font if @font
-        @d.stroke = 'transparent'
+        @d.stroke('transparent')
         @d.pointsize = scale_fontsize(@marker_font_size)
         @d.gravity = NorthGravity
         @d = @d.annotate_scaled( @base_image, 
@@ -516,11 +520,9 @@ protected
     # Draws horizontal background lines and labels
     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 
-
       if @y_axis_increment.nil?
         # Try to use a number of horizontal lines that will come out even.
         #
@@ -547,16 +549,20 @@ protected
       end
       @increment_scaled = @graph_height.to_f / (@spread / @increment)
 
+      # Draw horizontal line markers and annotate with numbers
       (0..@marker_count).each do |index|
         y = @graph_top + @graph_height - index.to_f * @increment_scaled
+        
+        @d = @d.stroke(@marker_color)
+        @d = @d.stroke_width 1
         @d = @d.line(@graph_left, y, @graph_right, y)
 
         marker_label = index * @increment + @minimum_value.to_f
 
         unless @hide_line_numbers
-          @d.fill = @marker_color
+          @d.fill = @font_color
           @d.font = @font if @font
-          @d.stroke = 'transparent'
+          @d.stroke('transparent')
           @d.pointsize = scale_fontsize(@marker_font_size)
           @d.gravity = EastGravity
         
@@ -568,28 +574,30 @@ protected
         end
       end
       
-      # Submitted by a contibutor...the utility escapes me
-      i = 0
-      @additional_line_values.each do |value|
-        @increment_scaled = @graph_height.to_f / (@maximum_value.to_f / value)
-        
-        y = @graph_top + @graph_height - @increment_scaled
-        
-        @d = @d.stroke(@additional_line_colors[i])
-        @d = @d.line(@graph_left, y, @graph_right, y)
-
-
-        @d.fill = @additional_line_colors[i]
-        @d.font = @font if @font
-        @d.stroke = 'transparent'
-        @d.pointsize = scale_fontsize(@marker_font_size)
-        @d.gravity = EastGravity
-        @d = @d.annotate_scaled( @base_image, 
-                          100, 20,
-                          -10, y - (@marker_font_size/2.0), 
-                          "", @scale)
-        i += 1   
-      end
+      # # Submitted by a contibutor...the utility escapes me
+      # i = 0
+      # @additional_line_values.each do |value|
+      #   @increment_scaled = @graph_height.to_f / (@maximum_value.to_f / value)
+      # 
+      #   y = @graph_top + @graph_height - @increment_scaled
+      # 
+      #   @d = @d.stroke(@additional_line_colors[i])
+      #   @d = @d.line(@graph_left, y, @graph_right, y)
+      # 
+      # 
+      #   @d.fill = @additional_line_colors[i]
+      #   @d.font = @font if @font
+      #   @d.stroke('transparent')
+      #   @d.pointsize = scale_fontsize(@marker_font_size)
+      #   @d.gravity = EastGravity
+      #   @d = @d.annotate_scaled( @base_image, 
+      #                     100, 20,
+      #                     -10, y - (@marker_font_size/2.0), 
+      #                     "", @scale)
+      #   i += 1   
+      # end
+      
+      @d = @d.stroke_antialias true
     end
 
     # Draws a legend with the names of the datasets 
@@ -625,10 +633,10 @@ protected
       @legend_labels.each_with_index do |legend_label, index|        
 
         # Draw label
-        @d.fill = @marker_color
+        @d.fill = @font_color
         @d.font = @font if @font
         @d.pointsize = scale_fontsize(@legend_font_size)
-        @d.stroke = 'transparent'
+        @d.stroke('transparent')
         @d.font_weight = NormalWeight
         @d.gravity = WestGravity
         @d = @d.annotate_scaled( @base_image, 
@@ -637,7 +645,7 @@ protected
                           legend_label.to_s, @scale)
         
         # Now draw box with color of this dataset
-        @d = @d.stroke 'transparent'
+        @d = @d.stroke('transparent')
         @d = @d.fill @data[index][DATA_COLOR_INDEX]
         @d = @d.rectangle(current_x_offset, 
                           current_y_offset - legend_square_width / 2.0, 
@@ -655,9 +663,9 @@ protected
     def draw_title
       return if (@hide_title || @title.nil?)
       
-      @d.fill = @marker_color
+      @d.fill = @font_color
       @d.font = @font if @font
-      @d.stroke = 'transparent'
+      @d.stroke('transparent')
       @d.pointsize = scale_fontsize(@title_font_size)
       @d.font_weight = BoldWeight
       @d.gravity = NorthGravity
@@ -678,9 +686,9 @@ protected
       if !@labels[index].nil? && @labels_seen[index].nil?
         y_offset = @graph_bottom + LABEL_MARGIN
 
-        @d.fill = @marker_color
+        @d.fill = @font_color
         @d.font = @font if @font
-        @d.stroke = 'transparent'
+        @d.stroke('transparent')
         @d.font_weight = NormalWeight
         @d.pointsize = scale_fontsize(@marker_font_size)
         @d.gravity = NorthGravity
@@ -694,9 +702,9 @@ protected
     end
 
     def draw_no_data
-        @d.fill = @marker_color
+        @d.fill = @font_color
         @d.font = @font if @font
-        @d.stroke = 'transparent'
+        @d.stroke('transparent')
         @d.font_weight = NormalWeight
         @d.pointsize = scale_fontsize(80)
         @d.gravity = CenterGravity
@@ -706,6 +714,19 @@ protected
                         @no_data_message, @scale)
     end
 
+    ##
+    # Finds the best background to render based on the provided theme options.
+    #
+    # Creates a @base_image to draw on.
+    #
+    def render_background
+      if not @theme_options[:background_colors].nil?
+        @base_image = render_gradiated_background(*@theme_options[:background_colors])
+      else
+        @base_image = render_image_background(*@theme_options[:background_image])
+      end
+    end
+
     # Use with a theme definition method to draw a gradiated (or solid color) background.
     def render_gradiated_background(top_color, bottom_color)
       Image.new(@columns, @rows, 
@@ -730,7 +751,8 @@ protected
 
     def reset_themes
       @color_index = 0
-      @labels_seen = Hash.new
+      @labels_seen = {}
+      @theme_options = {}
       
       @d = Draw.new
       # Scale down from 800x600 used to calculate drawing.
@@ -883,7 +905,7 @@ private
     #
     # Not scaled since it deals with dimensions that the regular 
     # scaling will handle.
-    
+    #
     def calculate_caps_height(font_size)
       @d.pointsize = font_size
       @d.get_type_metrics(@base_image, 'X').height
@@ -894,7 +916,7 @@ private
     #
     # Not scaled since it deals with dimensions that the regular 
     # scaling will handle.
-    
+    #    
     def calculate_width(font_size, text)
       @d.pointsize = font_size
       @d.get_type_metrics(@base_image, text.to_s).width