gruff 0.2.8 → 0.2.9

data/CHANGELOG

@@ -1,4 +1,8 @@
-CHANGELOG
+== 0.2.9
+
+* Patch to make SideBar accurate instead of stacked [Marik]
+* Will be extracting net, pie, stacked, and side-stacked to separate gem
+  in next release.
 
 == 0.2.8
 

data/Manifest.txt

@@ -1,9 +1,9 @@
 CHANGELOG
-Manifest.txt
 MIT-LICENSE
-Rakefile
+Manifest.txt
 README.txt
-assets/pc306715.jpg
+Rakefile
+assets/bubble.png
 assets/city_scene/background/0000.png
 assets/city_scene/background/0600.png
 assets/city_scene/background/2000.png
@@ -26,14 +26,22 @@ assets/city_scene/sky/1400.png
 assets/city_scene/sky/1500.png
 assets/city_scene/sky/1700.png
 assets/city_scene/sky/2000.png
+assets/pc306715.jpg
+assets/plastik/blue.png
+assets/plastik/green.png
+assets/plastik/red.png
 lib/gruff.rb
+lib/gruff/accumulator_bar.rb
 lib/gruff/area.rb
 lib/gruff/bar.rb
 lib/gruff/bar_conversion.rb
-lib/gruff/accumulator_bar.rb
 lib/gruff/base.rb
 lib/gruff/deprecated.rb
 lib/gruff/line.rb
+lib/gruff/mini/bar.rb
+lib/gruff/mini/legend.rb
+lib/gruff/mini/pie.rb
+lib/gruff/mini/side_bar.rb
 lib/gruff/net.rb
 lib/gruff/photo_bar.rb
 lib/gruff/pie.rb
@@ -41,15 +49,12 @@ lib/gruff/scene.rb
 lib/gruff/side_bar.rb
 lib/gruff/side_stacked_bar.rb
 lib/gruff/spider.rb
+lib/gruff/stacked_area.rb
 lib/gruff/stacked_bar.rb
-lib/gruff/mini/bar.rb
-lib/gruff/mini/legend.rb
-lib/gruff/mini/pie.rb
-lib/gruff/mini/side_bar.rb
+lib/gruff/stacked_mixin.rb
 test/gruff_test_case.rb
-test/output
-test/test_area.rb
 test/test_accumulator_bar.rb
+test/test_area.rb
 test/test_bar.rb
 test/test_base.rb
 test/test_legend.rb

data/Rakefile

@@ -11,6 +11,8 @@ Hoe.new('Gruff', Gruff::VERSION) do |p|
   p.summary = "Beautiful graphs for one or multiple datasets."
   p.url = "http://nubyonrails.com/pages/gruff"
   p.clean_globs = ['test/output/*.png']
+  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
+  p.remote_rdoc_dir = '' # Release to root
 end
 
 desc "Simple test on packaged files to make sure they are all there"
@@ -21,15 +23,30 @@ task :verify => :package do
   end
 end
 
+namespace :test do
+
+  desc "Run mini tests"
+  task :mini => :clean do
+    Dir['test/test_mini*'].each do |file|
+      system "ruby #{file}"
+    end
+
+  end
+
+end
+
 ##
 # Catch unmatched tasks and run them as a unit test.
 #
 # Makes it possible to do
-#  
+#
 #  rake pie
 #
-# To run the +test/test_pie+ file.
+# To run the +test/test_pie+ and +test/test_mini_pie+ files.
 
 rule '' do |t|
-  system "ruby test/test_#{t.name}.rb"
+  # Rake::Task["clean"].invoke
+  Dir["test/test_*#{t.name}*.rb"].each do |filename|
+    system "ruby #{filename}"
+  end
 end

data/lib/gruff.rb

@@ -8,6 +8,7 @@
   pie
   spider
   net
+  stacked_area
   stacked_bar
   side_stacked_bar
   side_bar

data/lib/gruff/base.rb

@@ -1,29 +1,26 @@
-#
+require 'rubygems'
+require 'RMagick'
+require File.dirname(__FILE__) + '/deprecated'
+
 # = Gruff. Graphs.
 #
 # Author:: Geoffrey Grosenbach boss@topfunky.com
 #
 # Originally Created:: October 23, 2005
 #
-# Extra thanks to Tim Hunter for writing RMagick, 
-# and also contributions by
-# Jarkko Laine, Mike Perham, Andreas Schwarz, 
-# Alun Eyre, Guillaume Theoret, David Stokar, 
-# Paul Rogers, Dave Woodward, Frank Oxener,
-# Kevin Clark, Cies Breijs, Richard Cowin,
-# and a cast of thousands.
+# Extra thanks to Tim Hunter for writing RMagick, and also contributions by
+# Jarkko Laine, Mike Perham, Andreas Schwarz, Alun Eyre, Guillaume Theoret,
+# David Stokar, Paul Rogers, Dave Woodward, Frank Oxener, Kevin Clark, Cies
+# Breijs, Richard Cowin, and a cast of thousands.
 #
+# See Gruff::Base#theme= for setting themes.
+module Gruff
 
-require 'rubygems'
-require 'RMagick'
-require File.dirname(__FILE__) + '/deprecated'
+  # This is the version of Gruff you are using.
+  VERSION = '0.2.9'
 
-module Gruff
-  
-  VERSION = '0.2.8'
-  
   class Base
-  
+
     include Magick
     include Deprecated
 
@@ -35,13 +32,25 @@ module Gruff
     DATA_VALUES_INDEX = 1
     DATA_COLOR_INDEX = 2
 
-    # Blank space around the edges of the graph
-    TOP_MARGIN = BOTTOM_MARGIN = RIGHT_MARGIN = LEFT_MARGIN = 20.0
-    
     # Space around text elements. Mostly used for vertical spacing
     LEGEND_MARGIN = TITLE_MARGIN = LABEL_MARGIN = 10.0
-    
-    # A hash of names for the individual columns, where the key is the array index for the column this label represents.
+
+    DEFAULT_TARGET_WIDTH = 800
+
+    # Blank space above the graph
+    attr_accessor :top_margin
+
+    # Blank space below the graph
+    attr_accessor :bottom_margin
+
+    # Blank space to the right of the graph
+    attr_accessor :right_margin
+
+    # Blank space to the left of the graph
+    attr_accessor :left_margin
+
+    # A hash of names for the individual columns, where the key is the array
+    # index for the column this label represents.
     #
     # Not all columns need to be named.
     #
@@ -58,12 +67,12 @@ module Gruff
 
     # A label for the bottom of the graph
     attr_accessor :x_axis_label
-    
+
     # A label for the left side of the graph
     attr_accessor :y_axis_label
 
     # attr_accessor :x_axis_increment
-    
+
     # Manually set increment of the horizontal marking lines
     attr_accessor :y_axis_increment
 
@@ -73,71 +82,92 @@ module Gruff
     # The large title of the graph displayed at the top
     attr_accessor :title
 
-    # Font used for titles, labels, etc. Works best if you provide the full path to the TTF font file.
-    # RMagick must be built with the Freetype libraries for this to work properly.
+    # Font used for titles, labels, etc. Works best if you provide the full
+    # path to the TTF font file.  RMagick must be built with the Freetype
+    # libraries for this to work properly.
     #
     # Tries to find Bitstream Vera (Vera.ttf) in the location specified by
     # ENV['MAGICK_FONT_PATH']. Uses default RMagick font otherwise.
+    #
+    # The font= method below fulfills the role of the writer, so we only need
+    # a reader here.
     attr_reader :font
 
     attr_accessor :font_color
 
-    # Hide various elements
-    attr_accessor :hide_line_markers, :hide_legend, :hide_title, :hide_line_numbers
+    # Prevent drawing of line markers
+    attr_accessor :hide_line_markers
+
+    # Prevent drawing of the legend
+    attr_accessor :hide_legend
+
+    # Prevent drawing of the title
+    attr_accessor :hide_title
+
+    # Prevent drawing of line numbers
+    attr_accessor :hide_line_numbers
 
-    # Message shown when there is no data. Fits up to 20 characters. Defaults to "No Data."
+    # Message shown when there is no data. Fits up to 20 characters. Defaults
+    # to "No Data."
     attr_accessor :no_data_message
 
     # The font size of the large title at the top of the graph
     attr_accessor :title_font_size
 
-    # Optionally set the size of the font. Based on an 800x600px graph. Default is 20.
+    # Optionally set the size of the font. Based on an 800x600px graph.
+    # Default is 20.
     #
     # Will be scaled down if graph is smaller than 800px wide.
     attr_accessor :legend_font_size
 
     # The font size of the labels around the graph
     attr_accessor :marker_font_size
-    
+
     # The color of the auxiliary lines
     attr_accessor :marker_color
 
     # The number of horizontal lines shown for reference
     attr_accessor :marker_count
-    
 
-    # You can manually set a minimum value instead of having the values guessed for you.
+    # You can manually set a minimum value instead of having the values
+    # guessed for you.
     #
     # Set it after you have given all your data to the graph object.
     attr_accessor :minimum_value
 
-    # You can manually set a maximum value, such as a percentage-based graph that always goes to 100.
+    # You can manually set a maximum value, such as a percentage-based graph
+    # that always goes to 100.
     #
-    # If you use this, you must set it after you have given all your data to the graph object.
+    # If you use this, you must set it after you have given all your data to
+    # the graph object.
     attr_accessor :maximum_value
-    
-    # Set to false if you don't want the data to be sorted with largest avg values at the back.
+
+    # Set to false if you don't want the data to be sorted with largest avg
+    # values at the back.
     attr_accessor :sort
-    
+
     # Experimental
     attr_accessor :additional_line_values
-    
+
     # Experimental
     attr_accessor :stacked
-    
-    
-    # Optionally set the size of the colored box by each item in the legend. Default is 20.0
+
+    # Optionally set the size of the colored box by each item in the legend.
+    # Default is 20.0
     #
     # Will be scaled down if graph is smaller than 800px wide.
     attr_accessor :legend_box_size
 
-
-    # If one numerical argument is given, the graph is drawn at 4/3 ratio according to the given width (800 results in 800x600, 400 gives 400x300, etc.).
+    # If one numerical argument is given, the graph is drawn at 4/3 ratio
+    # according to the given width (800 results in 800x600, 400 gives 400x300,
+    # etc.).
     #
-    # Or, send a geometry string for other ratios ('800x400', '400x225'). 
+    # Or, send a geometry string for other ratios ('800x400', '400x225').
     #
-    # Looks for Bitstream Vera as the default font. Expects an environment var of MAGICK_FONT_PATH to be set. (Uses RMagick's default font otherwise.)
-    def initialize(target_width=800)
+    # Looks for Bitstream Vera as the default font. Expects an environment var
+    # of MAGICK_FONT_PATH to be set. (Uses RMagick's default font otherwise.)
+    def initialize(target_width=DEFAULT_TARGET_WIDTH)
+      @top_margin = @bottom_margin = @left_margin = @right_margin = 20.0
 
       if not Numeric === target_width
         geometric_width, geometric_height = target_width.split('x')
@@ -154,14 +184,12 @@ module Gruff
       theme_keynote
     end
 
-    ##
     # Set instance variables for this object.
     #
     # Subclasses can override this, call super, then set values separately.
     #
     # This makes it possible to set defaults in a subclass but still allow
     # developers to change this values in their program.
-    
     def initialize_ivars
       # Internal for calculations
       @raw_columns = 800.0
@@ -202,7 +230,13 @@ module Gruff
       @stacked = nil
       @norm_data = nil
     end
-    
+
+    # Sets the top, bottom, left and right margins to +margin+.
+    def margins=(margin)
+      @top_margin = @left_margin = @right_margin = @bottom_margin = margin
+    end
+
+    # Sets the font for graph text to the font at +font_path+.
     def font=(font_path)
       @font = font_path
       @d.font = @font
@@ -210,24 +244,24 @@ module Gruff
 
     # Add a color to the list of available colors for lines.
     #
-    # Example: 
+    # Example:
     #  add_color('#c0e9d3')
     def add_color(colorname)
       @colors << colorname
     end
 
-
-    # Replace the entire color list with a new array of colors. You need to have one more color
-    # than the number of datasets you intend to draw. Also aliased as the colors= setter method.
+    # Replace the entire color list with a new array of colors. You need to
+    # have one more color than the number of datasets you intend to draw. Also
+    # aliased as the colors= setter method.
     #
-    # Example: 
-    #  replace_colors('#cc99cc', '#d9e043', '#34d8a2')
+    # Example:
+    #  replace_colors ['#cc99cc', '#d9e043', '#34d8a2']
     def replace_colors(color_list=[])
       @colors = color_list
     end
 
-
-    # You can set a theme manually. Assign a hash to this method before you send your data.
+    # 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),
@@ -259,7 +293,7 @@ module Gruff
       
       render_background
     end
-    
+
     # A color scheme similar to the popular presentation software.
     def theme_keynote
       # Colors
@@ -279,7 +313,7 @@ module Gruff
         :background_colors => ['black', '#4a465a']
       }
     end
-    
+
     # A color scheme plucked from the colors on the popular usability blog.
     def theme_37signals
       # Colors
@@ -300,7 +334,8 @@ module Gruff
       }
     end
 
-    # A color scheme from the colors used on the 2005 Rails keynote presentation at RubyConf.
+    # A color scheme from the colors used on the 2005 Rails keynote
+    # presentation at RubyConf.
     def theme_rails_keynote
       # Colors
       @green = '#00ff00'
@@ -340,19 +375,61 @@ module Gruff
       }
     end
 
+    # A pastel theme
+    def theme_pastel
+      # Colors
+      @colors = [
+          '#a9dada', # blue
+          '#aedaa9', # green
+          '#daaea9', # peach
+          '#dadaa9', # yellow
+          '#a9a9da', # dk purple
+          '#daaeda', # purple
+          '#dadada' # grey
+        ]
+      
+      self.theme = {
+        :colors => @colors,
+        :marker_color => '#aea9a9', # Grey
+        :font_color => 'black',
+        :background_colors => 'white'
+      }
+    end
+
+    # A greyscale theme
+    def theme_greyscale
+      # Colors
+      @colors = [
+          '#282828', # 
+          '#383838', # 
+          '#686868', # 
+          '#989898', # 
+          '#c8c8c8', # 
+          '#e8e8e8', # 
+        ]
+      
+      self.theme = {
+        :colors => @colors,
+        :marker_color => '#aea9a9', # Grey
+        :font_color => 'black',
+        :background_colors => 'white'
+      }
+    end
+
     # Parameters are an array where the first element is the name of the dataset
     # and the value is an array of values to plot.
     #
-    # Can be called multiple times with different datasets for a multi-valued graph.
+    # 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.
+    # 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().
+    # NOTE: If you want to use a preset theme, you must set it before calling
+    # data().
     #
     # Example:
-    #
-    #  data("Bart S.", [95, 45, 78, 89, 88, 76], '#ffcc00')
-    #
+    #   data("Bart S.", [95, 45, 78, 89, 88, 76], '#ffcc00')
     def data(name, data_points=[], color=nil)
       data_points = Array(data_points) # make sure it's an array
       @data << [name, data_points, (color || increment_color)]
@@ -380,7 +457,8 @@ module Gruff
 
     # Writes the graph to a file. Defaults to 'graph.png'
     #
-    # Example: write('graphs/my_pretty_graph.png')
+    # Example:
+    #   write('graphs/my_pretty_graph.png')
     def write(filename="graph.png")
       draw()
       @base_image.write(filename)
@@ -405,20 +483,18 @@ protected
       
       debug {
         # Outer margin
-        @d.rectangle( LEFT_MARGIN, TOP_MARGIN, 
-                            @raw_columns - RIGHT_MARGIN, @raw_rows - BOTTOM_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
 
-    ##
     # Calculates size of drawable area and draws the decorations.
     #
     # * line markers
     # * legend
     # * title
-    
     def setup_drawing
       # Maybe should be done in one of the following functions for more granularity.
       unless @has_data
@@ -458,23 +534,24 @@ protected
       end
     end
 
-    def calculate_spread
+    def calculate_spread # :nodoc:
       @spread = @maximum_value.to_f - @minimum_value.to_f
       @spread = @spread > 0 ? @spread : 1
     end
 
-    ##
     # Calculates size of drawable area, general font dimensions, etc.
-    
     def setup_graph_measurements
-      @marker_caps_height = calculate_caps_height(@marker_font_size)
-      @title_caps_height = calculate_caps_height(@title_font_size)
-      @legend_caps_height = calculate_caps_height(@legend_font_size)
-      
+      @marker_caps_height = @hide_line_markers ? 0 :
+                              calculate_caps_height(@marker_font_size)
+      @title_caps_height = @hide_title ? 0 :
+                              calculate_caps_height(@title_font_size)
+      @legend_caps_height = @hide_legend ? 0 :
+                              calculate_caps_height(@legend_font_size)
+
       if @hide_line_markers
-        (@graph_left, 
-         @graph_right_margin, 
-         @graph_bottom_margin) = [LEFT_MARGIN, RIGHT_MARGIN, BOTTOM_MARGIN]
+        (@graph_left,
+         @graph_right_margin,
+         @graph_bottom_margin) = [@left_margin, @right_margin, @bottom_margin]
       else
         longest_left_label_width = 0
         if @has_left_labels
@@ -484,13 +561,13 @@ protected
           longest_left_label_width = calculate_width(@marker_font_size, 
                           label(@maximum_value.to_f))
         end
-      
+
         # Shift graph if left line numbers are hidden
         line_number_width = @hide_line_numbers && !@has_left_labels ? 
                               0.0 : 
                               (longest_left_label_width + LABEL_MARGIN * 2)
 
-        @graph_left = LEFT_MARGIN + 
+        @graph_left = @left_margin + 
                       line_number_width + 
                       (@y_axis_label.nil? ? 0.0 : @marker_caps_height + LABEL_MARGIN * 2)
         # Make space for half the width of the rightmost column label.
@@ -499,9 +576,9 @@ protected
         extra_room_for_long_label = (last_label >= (@column_count-1) && @center_labels_over_point) ?
           calculate_width(@marker_font_size, @labels[last_label])/2.0 :
           0
-        @graph_right_margin =   RIGHT_MARGIN + extra_room_for_long_label
+        @graph_right_margin =   @right_margin + extra_room_for_long_label
                                 
-        @graph_bottom_margin =  BOTTOM_MARGIN + 
+        @graph_bottom_margin =  @bottom_margin + 
                                 @marker_caps_height + LABEL_MARGIN
       end
 
@@ -510,13 +587,13 @@ protected
 
       # When @hide title, leave a TITLE_MARGIN space for aesthetics.
       # Same with @hide_legend
-      @graph_top = TOP_MARGIN + 
+      @graph_top = @top_margin + 
                     (@hide_title ? TITLE_MARGIN : @title_caps_height + TITLE_MARGIN * 2) +
                     (@hide_legend ? LEGEND_MARGIN : @legend_caps_height + LEGEND_MARGIN * 2)
 
-      @graph_bottom = @raw_rows - @graph_bottom_margin -
-                      (@x_axis_label.nil? ? 0.0 : @marker_caps_height + LABEL_MARGIN)
-      
+      x_axis_label_height = @x_axis_label.nil? ? 0.0 :
+                              @marker_caps_height + LABEL_MARGIN
+      @graph_bottom = @raw_rows - @graph_bottom_margin - x_axis_label_height
       @graph_height = @graph_bottom - @graph_top
     end
 
@@ -547,7 +624,7 @@ protected
         @d.gravity = CenterGravity
         @d = @d.annotate_scaled( @base_image, 
                           1.0, @raw_rows,
-                          LEFT_MARGIN + @marker_caps_height / 2.0, 0.0, 
+                          @left_margin + @marker_caps_height / 2.0, 0.0, 
                           @y_axis_label, @scale)
         @d.rotation = -90.0
       end
@@ -636,8 +713,8 @@ protected
       @d = @d.stroke_antialias true
     end
 
-    # Draws a legend with the names of the datasets 
-    # matched to the colors used to draw them.
+    # Draws a legend with the names of the datasets matched to the colors used
+    # to draw them.
     def draw_legend
       return if @hide_legend
 
@@ -658,8 +735,8 @@ protected
 
       current_x_offset = legend_left
       current_y_offset =  @hide_title ? 
-                          TOP_MARGIN + LEGEND_MARGIN : 
-                          TOP_MARGIN + 
+                          @top_margin + LEGEND_MARGIN : 
+                          @top_margin + 
                           TITLE_MARGIN + @title_caps_height +
                           LEGEND_MARGIN
 
@@ -695,9 +772,10 @@ protected
       @color_index = 0
     end
 
+    # Draws a title on the graph.
     def draw_title
       return if (@hide_title || @title.nil?)
-      
+
       @d.fill = @font_color
       @d.font = @font if @font
       @d.stroke('transparent')
@@ -706,15 +784,13 @@ protected
       @d.gravity = NorthGravity
       @d = @d.annotate_scaled( @base_image, 
                         @raw_columns, 1.0,
-                        0, TOP_MARGIN, 
+                        0, @top_margin, 
                         @title, @scale)
     end
 
-    ##
     # Draws column labels below graph, centered over x_offset
-    #
+    #--
     # TODO Allow WestGravity as an option
-    
     def draw_label(x_offset, index)
       return if @hide_line_markers
 
@@ -736,6 +812,7 @@ protected
       end
     end
 
+    # Shows an error message because you have no data.
     def draw_no_data
         @d.fill = @font_color
         @d.font = @font if @font
@@ -749,11 +826,9 @@ 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
       case @theme_options[:background_colors]
       when Array
@@ -765,9 +840,7 @@ protected
       end
     end
 
-    ##
     # Make a new image at the current size with a solid +color+.
-    
     def render_solid_background(color)
       Image.new(@columns, @rows) {
         self.background_color = color
@@ -788,7 +861,7 @@ protected
       end
       image[0]
     end
-    
+
     # Use with a theme to make a transparent background
     def render_transparent_background
       Image.new(@columns, @rows) do
@@ -796,20 +869,21 @@ protected
       end
     end
 
+    # Resets everything to defaults (except data).
     def reset_themes
       @color_index = 0
       @labels_seen = {}
       @theme_options = {}
-      
+
       @d = Draw.new
       # Scale down from 800x600 used to calculate drawing.
       @d = @d.scale(@scale, @scale)
     end
 
-    def scale(value)
+    def scale(value) # :nodoc:
       value * @scale
     end
-    
+
     # Return a comparable fontsize for the current graph.
     def scale_fontsize(value)
       new_fontsize = value * @scale
@@ -817,32 +891,30 @@ protected
       return new_fontsize
     end
 
-    def clip_value_if_greater_than(value, max_value)
+    def clip_value_if_greater_than(value, max_value) # :nodoc:
       (value > max_value) ? max_value : value
     end
 
     # Overridden by subclasses such as stacked bar.
-    def larger_than_max?(data_point, index=0)
+    def larger_than_max?(data_point, index=0) # :nodoc:
       data_point > @maximum_value
     end
 
-	  def less_than_min?(data_point, index=0)
+	  def less_than_min?(data_point, index=0) # :nodoc:
       data_point < @minimum_value
     end
 
-    ##
     # Overridden by subclasses that need it.
-    def max(data_point, index)
+    def max(data_point, index) # :nodoc:
       data_point
     end
 
-    ##
     # Overridden by subclasses that need it.
-	  def min(data_point, index)
+	  def min(data_point, index) # :nodoc:
       data_point
     end
-   
-    def significant(inc)
+
+    def significant(inc) # :nodoc:
       return 1.0 if inc == 0 # Keep from going into infinite loop
       factor = 1.0
       while (inc < 10)
@@ -863,23 +935,21 @@ protected
       end
     end
 
-    # Sort with largest overall summed value at front of array 
-    # so it shows up correctly in the drawn graph.
+    # Sort with largest overall summed value at front of array so it shows up
+    # correctly in the drawn graph.
     def sort_norm_data
       @norm_data.sort! { |a,b| sums(b[1]) <=> sums(a[1]) }
     end
 
-    def sums(data_set)
+    def sums(data_set) # :nodoc:
       total_sum = 0
       data_set.collect {|num| total_sum += num.to_f }
       total_sum
     end
 
-    ##
     # Used by StackedBar and child classes.
     #
     # May need to be moved to the StackedBar class.
-    
     def get_maximum_by_stack
       # Get sum of each stack
       max_hash = {}
@@ -897,7 +967,7 @@ protected
       @minimum_value = 0
     end
 
-    def make_stacked
+    def make_stacked # :nodoc:
       stacked_values = Array.new(@column_count, 0)
       @data.each do |value_set|
         value_set[1].each_with_index do |value, index|
@@ -908,11 +978,11 @@ protected
     end
 
 private
-    
+
     # Takes a block and draws it if DEBUG is true.
     #
+    # Example:
     #   debug { @d.rectangle x1, y1, x2, y2 }
-    #
     def debug
       if DEBUG
         @d = @d.fill 'transparent'
@@ -920,7 +990,8 @@ private
         @d = yield
       end
     end
-    
+
+    # Uses the next color in your color list.
     def increment_color
       if @color_index == 0
         @color_index += 1
@@ -937,14 +1008,13 @@ private
       end
     end
 
-    ##
-    # Return a formatted string representing a number value that should be printed as a label.   
-
-    def label(value)      
+    # Return a formatted string representing a number value that should be
+    # printed as a label.
+    def label(value)
       if (@spread.to_f % @marker_count.to_f == 0) || !@y_axis_increment.nil?
         return value.to_i.to_s
       end
-      
+
       if @spread > 10.0
         sprintf("%0i", value)
       elsif @spread >= 3.0
@@ -954,51 +1024,47 @@ private
       end
     end
 
-    ##
-    # Returns the height of the capital letter 'X' for the current font and size.
-    #
-    # Not scaled since it deals with dimensions that the regular 
-    # scaling will handle.
+    # Returns the height of the capital letter 'X' for the current font and
+    # size.
     #
+    # 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
     end
 
-    ##
     # Returns the width of a string at this pointsize.
     #
     # 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
     end
 
   end # Gruff::Base
-  
+
   class IncorrectNumberOfDatasetsException < StandardError; end
-          
-end # Gruff
 
+end # Gruff
 
 module Magick
-  
+
   class Draw
-    
-    # Additional method since Draw.scale doesn't affect annotations.
+
+    # Additional method to scale annotation text since Draw.scale doesn't.
     def annotate_scaled(img, width, height, x, y, text, scale)
       scaled_width = (width * scale) >= 1 ? (width * scale) : 1
       scaled_height = (height * scale) >= 1 ? (height * scale) : 1
-      
-      self.annotate( img, 
+
+      self.annotate( img,
                       scaled_width, scaled_height,
                       x * scale, y * scale,
                       text)
     end
-    
+
   end
-  
+
 end # Magick