gruff 0.12.2 → 0.15.0

data/lib/gruff/base.rb

@@ -93,15 +93,6 @@ module Gruff
     # Set the large title of the graph displayed at the top.
     attr_writer :title
 
-    # Same as {#font=} but for the title.
-    attr_writer :title_font
-
-    # Specifies whether to draw the title bolded or not. Default is +true+.
-    attr_writer :bold_title
-
-    # Specifies the text color.
-    attr_writer :font_color
-
     # Prevent drawing of line markers. Default is +false+.
     attr_writer :hide_line_markers
 
@@ -118,21 +109,9 @@ module Gruff
     # to +"No Data."+.
     attr_writer :no_data_message
 
-    # Set the font size of the large title at the top of the graph. Default is +36+.
-    attr_writer :title_font_size
-
-    # Optionally set the size of the font. Based on an 800x600px graph.
-    # Default is +20+.
-    #
-    # Will be scaled down if the graph is smaller than 800px wide.
-    attr_writer :legend_font_size
-
     # Display the legend under the graph. Default is +false+.
     attr_writer :legend_at_bottom
 
-    # The font size of the labels around the graph. Default is +21+.
-    attr_writer :marker_font_size
-
     # Set the color of the auxiliary lines.
     attr_writer :marker_color
 
@@ -156,9 +135,11 @@ module Gruff
     # Will be scaled down if graph is smaller than 800px wide.
     attr_writer :legend_box_size
 
-    # With Side Bars use the data label for the marker value to the left of the bar.
-    # Default is +false+.
-    attr_writer :use_data_label
+    # Allow passing lambdas to format labels for x axis.
+    attr_writer :x_axis_label_format
+
+    # Allow passing lambdas to format labels for y axis.
+    attr_writer :y_axis_label_format
 
     # 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,
@@ -179,7 +160,7 @@ module Gruff
       @rows.freeze
 
       initialize_graph_scale
-      initialize_ivars
+      initialize_attributes
       initialize_store
 
       self.theme = Themes::KEYNOTE
@@ -207,21 +188,17 @@ module Gruff
     #
     # This makes it possible to set defaults in a subclass but still allow
     # developers to change this values in their program.
-    def initialize_ivars
+    def initialize_attributes
       @marker_count = nil
       @maximum_value = @minimum_value = nil
       @labels = {}
       @sort = false
       @sorted_drawing = false
       @title = nil
-      @title_font = nil
-
-      @font = nil
-      @bold_title = true
 
-      @marker_font_size = 21.0
-      @legend_font_size = 20.0
-      @title_font_size = 36.0
+      @title_font = Gruff::Font.new(size: 36.0, bold: true)
+      @marker_font = Gruff::Font.new(size: 21.0)
+      @legend_font = Gruff::Font.new(size: 20.0)
 
       @top_margin = @bottom_margin = @left_margin = @right_margin = DEFAULT_MARGIN
       @legend_margin = LEGEND_MARGIN
@@ -238,12 +215,14 @@ module Gruff
       @label_max_size = 0
       @label_truncation_style = :absolute
 
-      @use_data_label = false
       @x_axis_increment = nil
       @x_axis_label = @y_axis_label = nil
       @y_axis_increment = nil
+
+      @x_axis_label_format = nil
+      @y_axis_label_format = nil
     end
-    protected :initialize_ivars
+    protected :initialize_attributes
 
     # Sets the top, bottom, left and right margins to +margin+.
     #
@@ -258,8 +237,62 @@ module Gruff
     # @param font_path [String] The path to font.
     #
     def font=(font_path)
-      @font = font_path
-      Gruff::Renderer.font = @font
+      @title_font.path = font_path unless @title_font.path
+      @marker_font.path = font_path
+      @legend_font.path = font_path
+    end
+
+    # Same as {#font=} but for the title.
+    #
+    # @param font_path [String] The path to font.
+    #
+    def title_font=(font_path)
+      @title_font.path = font_path
+    end
+
+    # Set the font size of the large title at the top of the graph. Default is +36+.
+    #
+    # @param value [Numeric] title font size
+    #
+    def title_font_size=(value)
+      @title_font.size = value
+    end
+
+    # The font size of the labels around the graph. Default is +21+.
+    #
+    # @param value [Numeric] marker font size
+    #
+    def marker_font_size=(value)
+      @marker_font.size = value
+    end
+
+    # Optionally set the size of the font. Based on an 800x600px graph.
+    # Default is +20+.
+    #
+    # Will be scaled down if the graph is smaller than 800px wide.
+    #
+    # @param value [Numeric] legend font size
+    #
+    def legend_font_size=(value)
+      @legend_font.size = value
+    end
+
+    # Specifies whether to draw the title bolded or not. Default is +true+.
+    #
+    # @param value [Boolean] specifies whether to draw the title bolded or not.
+    #
+    def bold_title=(value)
+      @title_font.bold = value
+    end
+
+    # Specifies the text color.
+    #
+    # @param value [String] color
+    #
+    def font_color=(value)
+      @title_font.color = value
+      @marker_font.color = value
+      @legend_font.color = value
     end
 
     # Add a color to the list of available colors for lines.
@@ -328,12 +361,13 @@ module Gruff
       }
       @theme_options = defaults.merge options
 
+      self.marker_color = @theme_options[:marker_color]
+      self.font_color = @theme_options[:font_color] || @marker_color
+
       @colors = @theme_options[:colors]
-      @marker_color = @theme_options[:marker_color]
       @marker_shadow_color = @theme_options[:marker_shadow_color]
-      @font_color = @theme_options[:font_color] || @marker_color
 
-      Gruff::Renderer.setup(@columns, @rows, @font, @scale, @theme_options)
+      @renderer = Gruff::Renderer.new(@columns, @rows, @scale, @theme_options)
     end
 
     # Apply Apple's keynote theme.
@@ -435,8 +469,8 @@ module Gruff
     def to_image
       @to_image ||= begin
         draw
-        Gruff::Renderer.finish
-        Gruff::Renderer.instance.image
+        renderer.finish
+        renderer.image
       end
     end
 
@@ -452,27 +486,29 @@ module Gruff
       end
     end
 
-  protected
-
-    # Overridden by subclasses to do the actual plotting of the graph.
-    #
-    # Subclasses should start by calling super() for this method.
+    # Draw a graph.
     def draw
+      setup_data
+
       # Maybe should be done in one of the following functions for more granularity.
       unless data_given?
         draw_no_data
         return
       end
 
-      setup_data
       setup_drawing
 
       draw_legend
       draw_line_markers
       draw_axis_labels
       draw_title
+      draw_graph
     end
 
+  protected
+
+    attr_reader :renderer
+
     # Perform data manipulation before calculating chart measurements
     def setup_data # :nodoc:
       if @y_axis_increment && !@hide_line_markers
@@ -577,13 +613,13 @@ module Gruff
         x_axis_label_y_coordinate = @graph_bottom + LABEL_MARGIN + @marker_caps_height
 
         # TODO: Center between graph area
-        text_renderer = Gruff::Renderer::Text.new(@x_axis_label, font: @font, size: @marker_font_size, color: @font_color)
+        text_renderer = Gruff::Renderer::Text.new(renderer, @x_axis_label, font: @marker_font)
         text_renderer.add_to_render_queue(@raw_columns, 1.0, 0.0, x_axis_label_y_coordinate)
       end
 
       if @y_axis_label
         # Y Axis, rotated vertically
-        text_renderer = Gruff::Renderer::Text.new(@y_axis_label, font: @font, size: @marker_font_size, color: @font_color, rotation: -90)
+        text_renderer = Gruff::Renderer::Text.new(renderer, @y_axis_label, font: @marker_font, rotation: -90)
         text_renderer.add_to_render_queue(1.0, @raw_rows, @left_margin + @marker_caps_height / 2.0, 0.0, Magick::CenterGravity)
       end
     end
@@ -598,13 +634,13 @@ module Gruff
       (0..marker_count).each do |index|
         y = @graph_top + @graph_height - index.to_f * increment_scaled
 
-        line_renderer = Gruff::Renderer::Line.new(color: @marker_color, shadow_color: @marker_shadow_color)
+        line_renderer = Gruff::Renderer::Line.new(renderer, color: @marker_color, shadow_color: @marker_shadow_color)
         line_renderer.render(@graph_left, y, @graph_right, y)
 
         unless @hide_line_numbers
           marker_label = BigDecimal(index.to_s) * BigDecimal(@increment.to_s) + BigDecimal(minimum_value.to_s)
-          label = label(marker_label, @increment)
-          text_renderer = Gruff::Renderer::Text.new(label, font: @font, size: @marker_font_size, color: @font_color)
+          label = y_axis_label(marker_label, @increment)
+          text_renderer = Gruff::Renderer::Text.new(renderer, label, font: @marker_font)
           text_renderer.add_to_render_queue(@graph_left - LABEL_MARGIN, 1.0, 0.0, y, Magick::EastGravity)
         end
       end
@@ -627,7 +663,7 @@ module Gruff
       current_x_offset = center(label_widths.first.sum)
       current_y_offset = begin
         if @legend_at_bottom
-          @graph_height + @title_margin
+          @graph_bottom + @legend_margin + @legend_caps_height + LABEL_MARGIN
         else
           hide_title? ? @top_margin + @title_margin : @top_margin + @title_margin + @title_caps_height
         end
@@ -637,17 +673,17 @@ module Gruff
         next if legend_label.empty?
 
         # Draw label
-        text_renderer = Gruff::Renderer::Text.new(legend_label, font: @font, size: @legend_font_size, color: @font_color)
+        text_renderer = Gruff::Renderer::Text.new(renderer, legend_label, font: @legend_font)
         text_renderer.add_to_render_queue(@raw_columns, 1.0, current_x_offset + (legend_square_width * 1.7), current_y_offset, Magick::WestGravity)
 
         # Now draw box with color of this dataset
-        rect_renderer = Gruff::Renderer::Rectangle.new(color: store.data[index].color)
+        rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: store.data[index].color)
         rect_renderer.render(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)
 
-        width = calculate_width(@legend_font_size, legend_label)
+        width = calculate_width(@legend_font, legend_label)
         current_x_offset += width + (legend_square_width * 2.7)
         label_widths.first.shift
 
@@ -659,8 +695,6 @@ module Gruff
           unless label_widths.empty?
             # Wrap to next line and shrink available graph dimensions
             current_y_offset += line_height
-            @graph_top += line_height
-            @graph_height = @graph_bottom - @graph_top
           end
         end
       end
@@ -670,15 +704,12 @@ module Gruff
     def draw_title
       return if hide_title?
 
-      font = @title_font || @font
-      font_weight = @bold_title ? Magick::BoldWeight : Magick::NormalWeight
-      font_size = @title_font_size
-
-      metrics = Renderer::Text.metrics(@title, font_size, font_weight)
+      metrics = Gruff::Renderer::Text.new(renderer, @title, font: @title_font).metrics
       if metrics.width > @raw_columns
-        font_size = font_size * (@raw_columns / metrics.width) * 0.95
+        @title_font.size = @title_font.size * (@raw_columns / metrics.width) * 0.95
       end
-      text_renderer = Gruff::Renderer::Text.new(@title, font: font, size: font_size, color: @font_color, weight: font_weight)
+
+      text_renderer = Gruff::Renderer::Text.new(renderer, @title, font: @title_font)
       text_renderer.add_to_render_queue(@raw_columns, 1.0, 0, @top_margin)
     end
 
@@ -691,14 +722,11 @@ module Gruff
 
         # TESTME
         # FIXME: Consider chart types other than bar
-        # TODO: See if index.odd? is the best stragegy
+        # TODO: See if index.odd? is the best strategy
         y_offset += @label_stagger_height if index.odd?
 
-        label_text = truncate_label_text(@labels[index].to_s)
-
         if x_offset >= @graph_left && x_offset <= @graph_right
-          text_renderer = Gruff::Renderer::Text.new(label_text, font: @font, size: @marker_font_size, color: @font_color)
-          text_renderer.add_to_render_queue(1.0, 1.0, x_offset, y_offset, gravity)
+          draw_label_at(1.0, 1.0, x_offset, y_offset, @labels[index], gravity)
         end
       end
     end
@@ -713,20 +741,33 @@ module Gruff
       end
     end
 
+    def draw_label_at(width, height, x, y, text, gravity = Magick::NorthGravity)
+      label_text = truncate_label_text(text)
+      text_renderer = Gruff::Renderer::Text.new(renderer, label_text, font: @marker_font)
+      text_renderer.add_to_render_queue(width, height, x, y, gravity)
+    end
+
     # Draws the data value over the data point in bar graphs
-    def draw_value_label(x_offset, y_offset, data_point, bar_value = false)
-      return if @hide_line_markers && !bar_value
+    def draw_value_label(x_offset, y_offset, data_point)
+      return if @hide_line_markers
 
-      text_renderer = Gruff::Renderer::Text.new(data_point, font: @font, size: @marker_font_size, color: @font_color)
+      text_renderer = Gruff::Renderer::Text.new(renderer, data_point, font: @marker_font)
       text_renderer.add_to_render_queue(1.0, 1.0, x_offset, y_offset)
     end
 
     # Shows an error message because you have no data.
     def draw_no_data
-      text_renderer = Gruff::Renderer::Text.new(@no_data_message, font: @font, size: 80, color: @font_color)
+      font = @title_font.dup
+      font.size = 80
+      font.bold = false
+      text_renderer = Gruff::Renderer::Text.new(renderer, @no_data_message, font: font)
       text_renderer.render(@raw_columns, @raw_rows, 0, 0, Magick::CenterGravity)
     end
 
+    def draw_graph
+      raise 'Should implement this method at inherited class.'
+    end
+
     # Resets everything to defaults (except data).
     def reset_themes
       @theme_options = {}
@@ -742,7 +783,7 @@ module Gruff
     end
 
     def clip_value_if_greater_than(value, max_value) # :nodoc:
-      (value > max_value) ? max_value : value
+      value > max_value ? max_value : value
     end
 
     def significant(i) # :nodoc:
@@ -789,15 +830,15 @@ module Gruff
   private
 
     def setup_marker_caps_height
-      hide_bottom_label_area? ? 0 : calculate_caps_height(@marker_font_size)
+      hide_bottom_label_area? ? 0 : calculate_caps_height(@marker_font)
     end
 
     def setup_title_caps_height
-      hide_title? ? 0 : calculate_caps_height(@title_font_size) * @title.lines.to_a.size
+      hide_title? ? 0 : calculate_caps_height(@title_font) * @title.lines.to_a.size
     end
 
     def setup_legend_caps_height
-      @hide_legend ? 0 : calculate_caps_height(@legend_font_size)
+      @hide_legend ? 0 : calculate_caps_height(@legend_font)
     end
 
     def graph_right_margin
@@ -808,7 +849,7 @@ module Gruff
       # Make space for half the width of the rightmost column label.
       # Might be greater than the number of columns if between-style bar markers are used.
       last_label = @labels.keys.max.to_i
-      (last_label >= (column_count - 1) && @center_labels_over_point) ? calculate_width(@marker_font_size, @labels[last_label]) / 2.0 : 0
+      last_label >= (column_count - 1) && @center_labels_over_point ? calculate_width(@marker_font, @labels[last_label]) / 2.0 : 0
     end
 
     def setup_left_margin
@@ -816,12 +857,12 @@ module Gruff
 
       text = begin
         if @has_left_labels
-          @labels.values.reduce('') { |value, memo| (value.to_s.length > memo.to_s.length) ? value : memo }
+          @labels.values.reduce('') { |value, memo| value.to_s.length > memo.to_s.length ? value : memo }
         else
-          label(maximum_value.to_f, @increment)
+          y_axis_label(maximum_value.to_f, @increment)
         end
       end
-      longest_left_label_width = calculate_width(@marker_font_size, text)
+      longest_left_label_width = calculate_width(@marker_font, truncate_label_text(text))
       longest_left_label_width *= 1.25 if @has_left_labels
 
       # Shift graph if left line numbers are hidden
@@ -831,17 +872,16 @@ module Gruff
     end
 
     def setup_top_margin
-      return @top_margin if @legend_at_bottom
-
       # When @hide title, leave a title_margin space for aesthetics.
       # Same with @hide_legend
       @top_margin +
         (hide_title? ? @title_margin : @title_caps_height + @title_margin) +
-        (@hide_legend ? @legend_margin : @legend_caps_height + @legend_margin)
+        (@hide_legend || @legend_at_bottom ? @legend_margin : calculate_legend_height + @legend_margin)
     end
 
     def setup_bottom_margin
       graph_bottom_margin = hide_bottom_label_area? ? @bottom_margin : @bottom_margin + @marker_caps_height + LABEL_MARGIN
+      graph_bottom_margin += (calculate_legend_height + @legend_margin) if @legend_at_bottom
 
       x_axis_label_height = @x_axis_label.nil? ? 0.0 : @marker_caps_height + LABEL_MARGIN
       # FIXME: Consider chart types other than bar
@@ -849,6 +889,7 @@ module Gruff
     end
 
     def truncate_label_text(text)
+      text = text.to_s
       return text if text.size <= @label_max_size
 
       if @label_truncation_style == :trailing_dots
@@ -863,40 +904,58 @@ module Gruff
     # Return a formatted string representing a number value that should be
     # printed as a label.
     def label(value, increment)
-      label = if increment
-                if increment >= 10 || (increment * 1) == (increment * 1).to_i.to_f
-                  sprintf('%0i', value)
-                elsif increment >= 1.0 || (increment * 10) == (increment * 10).to_i.to_f
-                  sprintf('%0.1f', value)
-                elsif increment >= 0.1 || (increment * 100) == (increment * 100).to_i.to_f
-                  sprintf('%0.2f', value)
-                elsif increment >= 0.01 || (increment * 1000) == (increment * 1000).to_i.to_f
-                  sprintf('%0.3f', value)
-                elsif increment >= 0.001 || (increment * 10000) == (increment * 10000).to_i.to_f
-                  sprintf('%0.4f', value)
-                else
-                  value.to_s
-                end
-              elsif (@spread.to_f % (marker_count.to_f == 0 ? 1 : marker_count.to_f) == 0) || !@y_axis_increment.nil?
-                value.to_i.to_s
-              elsif @spread > 10.0
-                sprintf('%0i', value)
-              elsif @spread >= 3.0
-                sprintf('%0.2f', value)
-              else
-                value.to_s
-              end
+      label = begin
+        if increment
+          if increment >= 10 || (increment * 1) == (increment * 1).to_i.to_f
+            sprintf('%0i', value)
+          elsif increment >= 1.0 || (increment * 10) == (increment * 10).to_i.to_f
+            sprintf('%0.1f', value)
+          elsif increment >= 0.1 || (increment * 100) == (increment * 100).to_i.to_f
+            sprintf('%0.2f', value)
+          elsif increment >= 0.01 || (increment * 1000) == (increment * 1000).to_i.to_f
+            sprintf('%0.3f', value)
+          elsif increment >= 0.001 || (increment * 10_000) == (increment * 10_000).to_i.to_f
+            sprintf('%0.4f', value)
+          else
+            value.to_s
+          end
+        elsif (@spread.to_f % (marker_count.to_f == 0 ? 1 : marker_count.to_f) == 0) || !@y_axis_increment.nil?
+          value.to_i.to_s
+        elsif @spread > 10.0
+          sprintf('%0i', value)
+        elsif @spread >= 3.0
+          sprintf('%0.2f', value)
+        else
+          value.to_s
+        end
+      end
 
       parts = label.split('.')
       parts[0] = parts[0].commify
       parts.join('.')
     end
 
+    def x_axis_label(value, increment)
+      if @x_axis_label_format
+        @x_axis_label_format.call(value)
+      else
+        label(value, increment)
+      end
+    end
+
+    def y_axis_label(value, increment)
+      if @y_axis_label_format
+        @y_axis_label_format.call(value)
+      else
+        label(value, increment)
+      end
+    end
+
     def calculate_legend_label_widths_for_each_line(legend_labels, legend_square_width)
       # May fix legend drawing problem at small sizes
       label_widths = [[]] # Used to calculate line wrap
       legend_labels.each do |label|
-        width = calculate_width(@legend_font_size, label)
+        width = calculate_width(@legend_font, label)
         label_width = width + legend_square_width * 2.7
         label_widths.last.push label_width
 
@@ -908,13 +967,38 @@ module Gruff
       label_widths
     end
 
+    def calculate_legend_height
+      return 0.0 if @hide_legend
+
+      legend_labels = store.data.map(&:label)
+      legend_square_width = @legend_box_size
+      label_widths = calculate_legend_label_widths_for_each_line(legend_labels, legend_square_width)
+      legend_height = 0.0
+
+      legend_labels.each_with_index do |legend_label, _index|
+        next if legend_label.empty?
+
+        label_widths.first.shift
+        if label_widths.first.empty?
+          label_widths.shift
+          line_height = [@legend_caps_height, legend_square_width].max + @legend_margin
+          unless label_widths.empty?
+            # Wrap to next line and shrink available graph dimensions
+            legend_height += line_height
+          end
+        end
+      end
+
+      legend_height + @legend_caps_height
+    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.
-    def calculate_caps_height(font_size)
-      metrics = Renderer::Text.metrics('X', font_size)
+    def calculate_caps_height(font)
+      metrics = Gruff::Renderer::Text.new(renderer, 'X', font: font).metrics
       metrics.height
     end
 
@@ -922,11 +1006,11 @@ module Gruff
     #
     # Not scaled since it deals with dimensions that the regular
     # scaling will handle.
-    def calculate_width(font_size, text)
+    def calculate_width(font, text)
       text = text.to_s
       return 0 if text.empty?
 
-      metrics = Renderer::Text.metrics(text, font_size)
+      metrics = Gruff::Renderer::Text.new(renderer, text, font: font).metrics
       metrics.width
     end
 
@@ -935,7 +1019,7 @@ module Gruff
         # Try to use a number of horizontal lines that will come out even.
         #
         # TODO Do the same for larger numbers...100, 75, 50, 25
-        @increment = (@spread > 0 && marker_count > 0) ? significant(@spread / marker_count) : 1
+        @increment = @spread > 0 && marker_count > 0 ? significant(@spread / marker_count) : 1
       else
         # TODO: Make this work for negative values
         self.marker_count = (@spread / @y_axis_increment).to_i

data/lib/gruff/bezier.rb

@@ -19,11 +19,9 @@
 #   g.write('bezier.png')
 #
 class Gruff::Bezier < Gruff::Base
-  def draw
-    super
-
-    return unless data_given?
+private
 
+  def draw_graph
     x_increment = @graph_width / (column_count - 1).to_f
 
     store.norm_data.each do |data_row|
@@ -48,9 +46,9 @@ class Gruff::Bezier < Gruff::Base
       stroke_width = clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 4), 5.0)
 
       if RUBY_PLATFORM == 'java'
-        Gruff::Renderer::Polyline.new(color: data_row.color, width: stroke_width).render(poly_points)
+        Gruff::Renderer::Polyline.new(renderer, color: data_row.color, width: stroke_width).render(poly_points)
       else
-        Gruff::Renderer::Bezier.new(color: data_row.color, width: stroke_width).render(poly_points)
+        Gruff::Renderer::Bezier.new(renderer, color: data_row.color, width: stroke_width).render(poly_points)
       end
     end
   end