gruff 0.12.2 → 0.13.0

data/lib/gruff/base.rb

@@ -156,9 +156,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,
@@ -214,8 +216,8 @@ module Gruff
       @sort = false
       @sorted_drawing = false
       @title = nil
-      @title_font = nil
 
+      @title_font = nil
       @font = nil
       @bold_title = true
 
@@ -238,10 +240,12 @@ 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
 
@@ -603,7 +607,7 @@ module Gruff
 
         unless @hide_line_numbers
           marker_label = BigDecimal(index.to_s) * BigDecimal(@increment.to_s) + BigDecimal(minimum_value.to_s)
-          label = label(marker_label, @increment)
+          label = y_axis_label(marker_label, @increment)
           text_renderer = Gruff::Renderer::Text.new(label, font: @font, size: @marker_font_size, color: @font_color)
           text_renderer.add_to_render_queue(@graph_left - LABEL_MARGIN, 1.0, 0.0, y, Magick::EastGravity)
         end
@@ -627,7 +631,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
@@ -659,8 +663,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
@@ -674,7 +676,7 @@ module Gruff
       font_weight = @bold_title ? Magick::BoldWeight : Magick::NormalWeight
       font_size = @title_font_size
 
-      metrics = Renderer::Text.metrics(@title, font_size, font_weight)
+      metrics = Renderer::Text.metrics(@title, font, font_size, font_weight)
       if metrics.width > @raw_columns
         font_size = font_size * (@raw_columns / metrics.width) * 0.95
       end
@@ -694,11 +696,8 @@ module Gruff
         # TODO: See if index.odd? is the best stragegy
         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,6 +712,12 @@ 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(label_text, font: @font, size: @marker_font_size, color: @font_color)
+      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
@@ -818,10 +823,10 @@ module Gruff
         if @has_left_labels
           @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_size, truncate_label_text(text))
       longest_left_label_width *= 1.25 if @has_left_labels
 
       # Shift graph if left line numbers are hidden
@@ -831,17 +836,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 +853,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
@@ -892,6 +897,22 @@ module Gruff
       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
@@ -908,13 +929,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)
+      metrics = Renderer::Text.metrics('X', @font, font_size)
       metrics.height
     end
 
@@ -926,7 +972,7 @@ module Gruff
       text = text.to_s
       return 0 if text.empty?
 
-      metrics = Renderer::Text.metrics(text, font_size)
+      metrics = Renderer::Text.metrics(text, @font, font_size)
       metrics.width
     end
 

data/lib/gruff/dot.rb

@@ -51,14 +51,14 @@ protected
     return if @hide_line_markers
 
     (0..marker_count).each do |index|
-      marker_label = minimum_value + index * @increment
+      marker_label = BigDecimal(index.to_s) * BigDecimal(@increment.to_s) + BigDecimal(minimum_value.to_s)
       x = @graph_left + (marker_label - minimum_value) * @graph_width / @spread
 
       line_renderer = Gruff::Renderer::Line.new(color: @marker_color, shadow_color: @marker_shadow_color)
       line_renderer.render(x, @graph_bottom, x, @graph_bottom + 5)
 
       unless @hide_line_numbers
-        label = label(marker_label, @increment)
+        label = y_axis_label(marker_label, @increment)
         text_renderer = Gruff::Renderer::Text.new(label, font: @font, size: @marker_font_size, color: @font_color)
         text_renderer.add_to_render_queue(0, 0, x, @graph_bottom + (LABEL_MARGIN * 1.5), Magick::CenterGravity)
       end
@@ -70,8 +70,7 @@ protected
 
   def draw_label(y_offset, index)
     draw_unique_label(index) do
-      text_renderer = Gruff::Renderer::Text.new(@labels[index], font: @font, size: @marker_font_size, color: @font_color)
-      text_renderer.add_to_render_queue(@graph_left - LABEL_MARGIN, 1.0, 0.0, y_offset, Magick::EastGravity)
+      draw_label_at(@graph_left - LABEL_MARGIN, 1.0, 0.0, y_offset, @labels[index], Magick::EastGravity)
     end
   end
 end

data/lib/gruff/helper/bar_conversion.rb

@@ -14,29 +14,44 @@
 # @private
 class Gruff::BarConversion
   attr_writer :mode
-  attr_writer :zero
-  attr_writer :graph_top
-  attr_writer :graph_height
-  attr_writer :minimum_value
-  attr_writer :spread
 
-  def get_left_y_right_y_scaled(data_point)
+  def initialize(top:, bottom:, minimum_value:, maximum_value:, spread:)
+    @graph_top = top
+    @graph_height = bottom - top
+    @spread = spread
+    @minimum_value = minimum_value
+    @maximum_value = maximum_value
+
+    if minimum_value >= 0
+      # all bars go from zero to positive
+      @mode = 1
+    elsif maximum_value <= 0
+      # all bars go from 0 to negative
+      @mode = 2
+    else
+      # bars either go from zero to negative or to positive
+      @mode = 3
+      @zero = -minimum_value / @spread
+    end
+  end
+
+  def get_top_bottom_scaled(data_point)
     result = []
 
     case @mode
     when 1
       # minimum value >= 0 ( only positive values )
-      result[0] = @graph_top + @graph_height * (1 - data_point) + 1
-      result[1] = @graph_top + @graph_height - 1
+      result[0] = @graph_top + @graph_height * (1 - data_point)
+      result[1] = @graph_top + @graph_height
     when 2
       # only negative values
-      result[0] = @graph_top + 1
-      result[1] = @graph_top + @graph_height * (1 - data_point) - 1
+      result[0] = @graph_top
+      result[1] = @graph_top + @graph_height * (1 - data_point)
     when 3
       # positive and negative values
       val = data_point - @minimum_value / @spread
-      result[0] = @graph_top + @graph_height * (1 - (val - @zero)) + 1
-      result[1] = @graph_top + @graph_height * (1 - @zero) - 1
+      result[0] = @graph_top + @graph_height * (1 - (val - @zero))
+      result[1] = @graph_top + @graph_height * (1 - @zero)
     else
       result[0] = 0.0
       result[1] = 0.0

data/lib/gruff/helper/bar_value_label.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# @private
+module Gruff::BarValueLabel
+  using String::GruffCommify
+
+  # @private
+  class Base
+    attr_reader :coordinate, :value
+
+    def initialize(coordinate, value)
+      @coordinate = coordinate
+      @value = value
+    end
+  end
+
+  # @private
+  class Bar < Base
+    def prepare_rendering(format, _bar_width = 0)
+      left_x, left_y, right_x, _right_y = @coordinate
+      if format.is_a?(Proc)
+        val = format.call(@value)
+      else
+        val = sprintf(format || '%.2f', @value).commify
+      end
+
+      y = @value >= 0 ? left_y - 30 : left_y + 12
+      yield left_x + (right_x - left_x) / 2, y, val
+    end
+  end
+
+  # @private
+  class SideBar < Base
+    def prepare_rendering(format, bar_width = 0)
+      left_x, _left_y, right_x, right_y = @coordinate
+      if format.is_a?(Proc)
+        val = format.call(@value)
+      else
+        val = sprintf(format || '%.2f', @value).commify
+      end
+
+      x = @value >= 0 ? right_x + 40 : left_x - 40
+      yield x, right_y - bar_width / 2, val
+    end
+  end
+
+  # @private
+  class StackedBar
+    def initialize
+      @bars = []
+    end
+
+    def add(bar, index)
+      bars = @bars[index] || []
+      bars << bar
+      @bars[index] = bars
+    end
+
+    def prepare_rendering(format, bar_width = 0, &block)
+      @bars.each do |bars|
+        value = bars.sum(&:value)
+        bar = bars.last
+        bar_value_label = bar.class.new(bar.coordinate, value)
+        bar_value_label.prepare_rendering(format, bar_width, &block)
+      end
+    end
+  end
+end

data/lib/gruff/renderer/text.rb

@@ -34,7 +34,7 @@ module Gruff
       draw.rotation = @rotation if @rotation
       draw.fill = @font_color
       draw.stroke = 'transparent'
-      draw.font = @font if @font
+      draw.font = @font || Renderer::Text.default_font(@font_weight)
       draw.font_weight = @font_weight
       draw.pointsize = @font_size * scale
       draw.gravity = gravity
@@ -45,10 +45,11 @@ module Gruff
       draw.rotation = -@rotation if @rotation
     end
 
-    def self.metrics(text, size, font_weight = Magick::NormalWeight)
+    def self.metrics(text, font, size, font_weight = Magick::NormalWeight)
       draw  = Renderer.instance.draw
       image = Renderer.instance.image
 
+      draw.font = font || Renderer::Text.default_font(font_weight)
       draw.font_weight = font_weight
       draw.pointsize = size
 
@@ -60,5 +61,12 @@ module Gruff
 
       draw.get_type_metrics(image, text)
     end
+
+    FONT_BOLD = File.expand_path(File.join(__FILE__, '../../../../assets/fonts/Roboto-Bold.ttf'))
+    FONT_REGULAR = File.expand_path(File.join(__FILE__, '../../../../assets/fonts/Roboto-Regular.ttf'))
+
+    def self.default_font(font_weight)
+      (font_weight == Magick::BoldWeight) ? FONT_BOLD : FONT_REGULAR
+    end
   end
 end

data/lib/gruff/scatter.rb

@@ -28,17 +28,13 @@ class Gruff::Scatter < Gruff::Base
   # This is useful when working with a small range of high values (for example, a date range of months, while seconds as units).
   attr_writer :disable_significant_rounding_x_axis
 
-  # Allow enabling vertical lines. When you have a lot of data, they can work great.
-  attr_writer :enable_vertical_line_markers
+  # Allow for vertical marker lines.
+  attr_writer :show_vertical_markers
 
   # Allow using vertical labels in the X axis (and setting the label margin).
   attr_writer :x_label_margin
   attr_writer :use_vertical_x_labels
 
-  # Allow passing lambdas to format labels.
-  attr_writer :y_axis_label_format
-  attr_writer :x_axis_label_format
-
   def initialize_store
     @store = Gruff::Store.new(Gruff::Store::XYData)
   end
@@ -51,17 +47,22 @@ class Gruff::Scatter < Gruff::Base
     @baseline_x_value = @baseline_y_value = nil
     @circle_radius = nil
     @disable_significant_rounding_x_axis = false
-    @enable_vertical_line_markers = false
+    @show_vertical_markers = false
     @marker_x_count = nil
     @maximum_x_value = @minimum_x_value = nil
     @stroke_width = nil
     @use_vertical_x_labels = false
-    @x_axis_label_format = nil
     @x_label_margin = nil
-    @y_axis_label_format = nil
   end
   private :initialize_ivars
 
+  # Allow enabling vertical lines. When you have a lot of data, they can work great.
+  # @deprecated Please use +show_vertical_markers+ attribute instead.
+  def enable_vertical_line_markers=(value)
+    warn '#enable_vertical_line_markers= is deprecated. Please use `show_vertical_markers` attribute instead'
+    @show_vertical_markers = value
+  end
+
   def draw
     super
     return unless data_given?
@@ -191,7 +192,7 @@ private
       calculate_spread
       normalize
 
-      self.marker_count = (@x_spread / @x_axis_increment).to_i
+      @marker_x_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)
@@ -199,7 +200,7 @@ private
     # Draw vertical line markers and annotate with numbers
     (0..@marker_x_count).each do |index|
       # TODO: Fix the vertical lines, and enable them by default. Not pretty when they don't match up with top y-axis line
-      if @enable_vertical_line_markers
+      if @show_vertical_markers
         x = @graph_left + @graph_width - index.to_f * increment_x_scaled
 
         line_renderer = Gruff::Renderer::Line.new(color: @marker_color, shadow_color: @marker_shadow_color)
@@ -207,11 +208,11 @@ private
       end
 
       unless @hide_line_numbers
-        marker_label = index * @x_increment + @minimum_x_value.to_f
+        marker_label = BigDecimal(index.to_s) * BigDecimal(@x_increment.to_s) + BigDecimal(@minimum_x_value.to_s)
         y_offset = @graph_bottom + (@x_label_margin || LABEL_MARGIN)
         x_offset = get_x_coord(index.to_f, increment_x_scaled, @graph_left)
 
-        label = vertical_label(marker_label, @x_increment)
+        label = x_axis_label(marker_label, @x_increment)
         rotation = -90.0 if @use_vertical_x_labels
         text_renderer = Gruff::Renderer::Text.new(label, font: @font, size: @marker_font_size, color: @font_color, rotation: rotation)
         text_renderer.add_to_render_queue(1.0, 1.0, x_offset, y_offset)
@@ -219,22 +220,6 @@ private
     end
   end
 
-  def label(value, increment)
-    if @y_axis_label_format
-      @y_axis_label_format.call(value)
-    else
-      super
-    end
-  end
-
-  def vertical_label(value, increment)
-    if @x_axis_label_format
-      @x_axis_label_format.call(value)
-    else
-      label(value, increment)
-    end
-  end
-
   def get_x_coord(x_data_point, width, offset) #:nodoc:
     x_data_point * width + offset
   end