gruff 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,11 +1,19 @@
 CHANGELOG
 
+== 0.1.2
+
+* minimum_value and maximum_value can be set after data() to manually scale the graph
+* Fixed infinite loop bug when values are all equal
+* Added experimental net and spider graphs
+* Added non-linear scene graph for a simple interface to complex layered graphs
+* Initial refactoring of tests
+* A host of other bug fixes
+
 == 0.0.8
 
 * NEW Sidestacked Bar Graphs. [Alun Eyre]
 * baseline_value larger than data will now show correctly. [Mike Perham]
 * hide_dots and hide_lines are now options for line graphs.
-* 
 
 == 0.0.6
 

data/Rakefile

@@ -28,6 +28,15 @@ task :clean do
   rm_rf 'doc'
 end
 
+desc "Copy documentation to topfunky.com" 
+task :rdoc_deploy => [:rdoc] do
+  dirs = %w{doc}
+  onserver = "topfunky@topfunky.com:/home/topfunky/topfunky.com/clients/rails/gruff" 
+  dirs.each do | dir|
+    `rsync -avz -e ssh "#{`pwd`.chomp}/#{dir}" "#{onserver}" --exclude ".svn"`
+  end
+end
+
 # Run the unit tests
 Rake::TestTask.new { |t|
   t.libs << "test"
@@ -35,7 +44,6 @@ Rake::TestTask.new { |t|
   t.verbose = true
 }
 
-
 # Genereate the RDoc documentation
 Rake::RDocTask.new { |rdoc|
   rdoc.rdoc_dir = 'doc'
@@ -197,3 +205,5 @@ task :release => [:package] do
     end
   end
 end
+
+

data/lib/gruff.rb

@@ -6,6 +6,10 @@ 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'
+
+require File.dirname(__FILE__) + '/gruff/scene'

data/lib/gruff/bar.rb

@@ -6,7 +6,6 @@ class Gruff::Bar < Gruff::Base
 
   def draw
     super
-
     return unless @has_data
 
     # Setup spacing.

data/lib/gruff/base.rb

@@ -9,7 +9,8 @@
 # and also contributions by
 # Jarkko Laine, Mike Perham, Andreas Schwarz, 
 # Alun Eyre, Guillaume Theoret, David Stokar, 
-# Paul Rogers, Dave Woodward, Frank Oxener, 
+# Paul Rogers, Dave Woodward, Frank Oxener,
+# Kevin Clark, Cies Breijs, Richard Cowin,
 # and a cast of thousands.
 #
 
@@ -17,7 +18,7 @@ require 'RMagick'
 
 module Gruff
   
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
   
   class Base
   
@@ -58,10 +59,32 @@ module Gruff
     # 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 labels and lines
+    attr_accessor :marker_color
+    
+    # The font size of the large title at the top of the graph
     attr_accessor :title_font_size
 
+    # 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.
+    #
+    # If you use this, you must set it after you have given all your data to the graph object.
+    attr_accessor :maximum_value
+        
+    # Experimental
+    attr_accessor :additional_line_values
+    
+    # Experimental
+    attr_accessor :stacked
+    
+
     # 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'). 
@@ -100,6 +123,9 @@ module Gruff
 
       @hide_line_markers = @hide_legend = @hide_title = false
 
+      @additional_line_values = []      
+      @additional_line_colors = []
+
       reset_themes()
       theme_keynote()
     end
@@ -121,6 +147,57 @@ 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)
+      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
+
+    # Add a color to the list of available colors for lines.
+    #
+    # 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.
+    #
+    # Example: 
+    #  replace_colors('#cc99cc', '#d9e043', '#34d8a2')
+    def replace_colors(color_list=[])
+      @colors = color_list
+    end
+    
     # A color scheme similar to the popular presentation software.
     def theme_keynote
       reset_themes()
@@ -228,7 +305,7 @@ module Gruff
         end
         @minimum_value = less_than_min?(data_point) ? data_point : @minimum_value
         if @minimum_value < 0
-      	  @has_data = true
+     	  @has_data = true
         end
       end
     end
@@ -249,12 +326,50 @@ module Gruff
       end
     end
 
+    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
+
+
 protected
 
+
+    def make_stacked
+      stacked_values = Array.new(@column_count, 0)
+      @data.each do |value_set|
+        value_set[1].each_with_index do |value, index|
+          stacked_values[index] += value
+        end
+        value_set[1] = stacked_values.dup
+      end
+    end
+
+
     # Overridden by subclasses to do the actual plotting of the graph.
     #
     # Subclasses should start by calling super() for this method.
     def draw
+      make_stacked if @stacked
       setup_drawing()
   
       # Subclasses will do some drawing here...
@@ -276,8 +391,9 @@ protected
       setup_graph_measurements()
       sort_norm_data() # Sort norm_data with avg largest values set first (for display)
       
-      draw_line_markers()
       draw_legend()
+      setup_graph_height()
+      draw_line_markers()
       draw_title
     end
 
@@ -287,7 +403,7 @@ protected
         @norm_data = []
         return unless @has_data
         @spread = @maximum_value.to_f - @minimum_value.to_f
-        @spread = 1 if @spread == 0 # Protect from divide by 0
+        @spread = 20.0 if @spread == 0.0 # Protect from divide by zero
         min_val = @minimum_value.to_f
         @data.each do |data_row|
           norm_data_points = []
@@ -303,6 +419,10 @@ protected
       end
     end
 
+    def setup_graph_height
+      @graph_height = @graph_bottom - @graph_top
+    end
+
     def setup_graph_measurements
       # TODO Separate horizontal lines from line number labels so they can be shown or hidden independently
       # TODO Get width of longest left-hand vertical text label and space left margin accordingly
@@ -320,7 +440,7 @@ protected
 
       @graph_top = 150.0
       @graph_bottom = @raw_rows - @graph_bottom_margin
-      @graph_height = @graph_bottom - @graph_top
+      setup_graph_height()
     end
 
     # Draws horizontal background lines and labels
@@ -333,12 +453,10 @@ protected
       number_of_lines = 4
 
       # TODO Round maximum marker value to a round number like 100, 0.1, 0.5, etc.
-      
-      # added relative height
       spread = @maximum_value.to_f - @minimum_value.to_f
-      increment = significant(spread / number_of_lines)
+      spread = spread > 0 ? spread : 1
+      increment = (spread > 0) ? significant(spread / number_of_lines) : 1
       inc_graph = @graph_height.to_f / (spread / increment)
-      #inc_graph = @graph_height.to_f / increment
 
       (0..number_of_lines).each do |index|
         y = @graph_top + @graph_height - index.to_f * inc_graph
@@ -351,11 +469,32 @@ protected
         @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), 
                           marker_label.to_s, @scale)
-        #                  "help", @scale)
+      end
+      i = 0
+      @additional_line_values.each do |value|
+        inc_graph = @graph_height.to_f / (@maximum_value.to_f / value)
+        
+        y = @graph_top + @graph_height - inc_graph
+        
+        @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
     end
 
@@ -468,6 +607,13 @@ protected
       end
       image[0]
     end
+    
+    # Use with a theme to make a transparent background
+    def render_transparent_background
+      Image.new(@columns, @rows) do
+        self.background_color = 'transparent'
+      end
+    end
 
     def reset_themes
       @color_index = 0
@@ -511,6 +657,7 @@ protected
     end
    
     def significant(inc)
+      return 1.0 if inc == 0 # Keep from going into infinite loop
       factor = 1.0
       while (inc < 10)
         inc *= 10
@@ -571,7 +718,10 @@ private
           @color_index += 1
           return @colors[@color_index - 1]
         else
-          raise(ColorlistExhaustedException, "There are no more colors left to use.")
+          # Start over
+          @color_index = 0
+          return @colors[-1]
+          #raise(ColorlistExhaustedException, "There are no more colors left to use.")
         end
       end
     end

data/lib/gruff/line.rb

@@ -29,8 +29,7 @@ class Gruff::Line < Gruff::Base
       super args.shift
     end
     
-    @hide_dots = false
-    @hide_lines = args.empty? ? false : !args.shift # For backwards compatibility. Use g.hide_lines = true from now on.
+    @hide_dots = @hide_lines = false
     @baseline_color = 'red'
   end
 
@@ -57,7 +56,7 @@ class Gruff::Line < Gruff::Base
     end
 
     @norm_data.each do |data_row|
-      prev_x = prev_y = 0.0
+      prev_x = prev_y = nil
       @d = @d.stroke data_row[DATA_COLOR_INDEX]
       @d = @d.fill data_row[DATA_COLOR_INDEX]
 
@@ -69,7 +68,7 @@ class Gruff::Line < Gruff::Base
 
         new_y = @graph_top + (@graph_height - data_point * @graph_height)
 
-        if !@hide_lines and prev_x > 0 and prev_y > 0 then
+        if !@hide_lines and !prev_x.nil? and !prev_y.nil? then
           @d = @d.line(prev_x, prev_y, new_x, new_y)
         end
         @d = @d.circle(new_x, new_y, new_x - circle_radius, new_y) unless @hide_dots

data/lib/gruff/net.rb

@@ -0,0 +1,133 @@
+
+require File.dirname(__FILE__) + '/base'
+
+# Experimental!!! See also the Spider graph.
+class Gruff::Net < Gruff::Base
+
+  def draw
+
+    super
+
+    return unless @has_data
+
+    @radius = @graph_height / 2.0
+    @center_x = @graph_left + (@graph_width / 2.0)
+    @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[1].size * 2.5), 5.0)
+
+    @d = @d.stroke_opacity 1.0
+    @d = @d.stroke_width clip_value_if_greater_than(@columns / (@norm_data.first[1].size * 4), 5.0)
+
+    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
+      @d = @d.stroke data_row[DATA_COLOR_INDEX]
+      @d = @d.fill data_row[DATA_COLOR_INDEX]
+
+      data_row[1].each_with_index do |data_point, index|
+        next if data_point.nil?
+
+        rad_pos = index * Math::PI * 2 / @column_count
+        point_distance = data_point * @radius
+        start_x = @center_x + Math::sin(rad_pos) * point_distance
+        start_y = @center_y - Math::cos(rad_pos) * point_distance
+
+        next_index = index + 1 < data_row[1].length ? index + 1 : 0
+
+        next_rad_pos = next_index * Math::PI * 2 / @column_count
+        next_point_distance = data_row[1][next_index] * @radius
+        end_x = @center_x + Math::sin(next_rad_pos) * next_point_distance
+        end_y = @center_y - Math::cos(next_rad_pos) * next_point_distance
+
+        @d = @d.line(start_x, start_y, end_x, end_y)
+
+        @d = @d.circle(start_x, start_y, start_x - circle_radius, start_y) unless @hide_dots
+      end
+
+    end
+
+    @d.draw(@base_image)
+  end
+
+
+  # the lines connecting in the center, with the first line vertical
+  def draw_line_markers
+    return if @hide_line_markers
+
+
+    # have to do this here (AGAIN)... see draw() in this class
+    # because this funtion is called before the @radius, @center_x and @center_y are set
+    @radius = @graph_height / 2.0
+    @center_x = @graph_left + (@graph_width / 2.0)
+    @center_y = @graph_top + (@graph_height / 2.0) - 10 # Move graph up a bit
+
+
+    # Draw horizontal line markers and annotate with numbers
+    @d = @d.stroke(@marker_color)
+    @d = @d.stroke_width 1
+
+
+    (0..@column_count-1).each do |index|
+      rad_pos = index * Math::PI * 2 / @column_count
+
+      @d = @d.line(@center_x, @center_y, @center_x + Math::sin(rad_pos) * @radius, @center_y - Math::cos(rad_pos) * @radius)
+
+
+      marker_label = labels[index] ? labels[index].to_s : '000'
+
+      draw_label(@center_x, @center_y, rad_pos * 360 / (2 * Math::PI), @radius, marker_label)
+    end
+  end
+
+private
+
+  def draw_label(center_x, center_y, angle, radius, amount)
+    r_offset = 1.1
+    x_offset = center_x # + 15 # The label points need to be tweaked slightly
+    y_offset = center_y # + 0  # This one doesn't though
+    x = x_offset + (radius * r_offset * Math.sin(angle.deg2rad))
+    y = y_offset - (radius * r_offset * Math.cos(angle.deg2rad))
+
+    # Draw label
+    @d.fill = @marker_color
+    @d.font = @font if @font
+    @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.annotate_scaled(@base_image, 0, 0, x, y, amount, @scale)
+  end
+
+end
+
+
+class Float
+  # Used for degree => radian conversions
+  def deg2rad
+    self * (Math::PI/180.0)
+  end
+end
+
+
+