gruff 0.12.2 → 0.15.0

data/lib/gruff/bullet.rb

@@ -27,12 +27,13 @@ class Gruff::Bullet < Gruff::Base
     self.theme = Gruff::Themes::GREYSCALE
   end
 
-  def initialize_ivars
+  def initialize_attributes
     super
 
-    @title_font_size = 20
+    @title_font.size = 20
+    @title_font.bold = false
   end
-  private :initialize_ivars
+  private :initialize_attributes
 
   def data(value, maximum_value, options = {})
     @value = value.to_f
@@ -51,7 +52,7 @@ class Gruff::Bullet < Gruff::Base
 
     draw_title
 
-    title_width  = calculate_width(@title_font_size, @title)
+    title_width  = calculate_width(@title_font, @title)
     margin       = 30.0
     thickness    = @raw_rows / 6.0
     right_margin = margin
@@ -60,15 +61,15 @@ class Gruff::Bullet < Gruff::Base
     graph_height = thickness * 3.0
 
     # Background
-    rect_renderer = Gruff::Renderer::Rectangle.new(color: @colors[0])
+    rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: @colors[0])
     rect_renderer.render(graph_left, 0, graph_left + graph_width, graph_height)
 
-    [:high, :low].each_with_index do |indicator, index|
+    %i[high low].each_with_index do |indicator, index|
       next unless @options.key?(indicator)
 
       indicator_width_x = graph_left + graph_width * (@options[indicator] / maximum_value)
 
-      rect_renderer = Gruff::Renderer::Rectangle.new(color: @colors[index + 1])
+      rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: @colors[index + 1])
       rect_renderer.render(graph_left, 0, indicator_width_x, graph_height)
     end
 
@@ -76,12 +77,12 @@ class Gruff::Bullet < Gruff::Base
       target_x = graph_left + graph_width * (@options[:target] / maximum_value)
       half_thickness = thickness / 2.0
 
-      rect_renderer = Gruff::Renderer::Rectangle.new(color: @font_color)
+      rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: @marker_color)
       rect_renderer.render(target_x, half_thickness, target_x + half_thickness, thickness * 2 + half_thickness)
     end
 
     # Value
-    rect_renderer = Gruff::Renderer::Rectangle.new(color: @font_color)
+    rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: @marker_color)
     rect_renderer.render(graph_left, thickness, graph_left + graph_width * (@value / maximum_value), thickness * 2)
   end
 
@@ -90,9 +91,9 @@ private
   def draw_title
     return if hide_title?
 
-    font_height = calculate_caps_height(scale_fontsize(@title_font_size))
+    font_height = calculate_caps_height(@title_font)
 
-    text_renderer = Gruff::Renderer::Text.new(@title, font: @font, size: @title_font_size, color: @font_color)
+    text_renderer = Gruff::Renderer::Text.new(renderer, @title, font: @title_font)
     text_renderer.add_to_render_queue(1.0, 1.0, font_height / 2, font_height / 2, Magick::NorthWestGravity)
   end
 end

data/lib/gruff/dot.rb

@@ -14,12 +14,14 @@
 #   g.write('dot.png')
 #
 class Gruff::Dot < Gruff::Base
-  def draw
-    @has_left_labels = true
-    super
+private
 
-    return unless data_given?
+  def initialize_attributes
+    super
+    @has_left_labels = true
+  end
 
+  def draw_graph
     # Setup spacing.
     #
     spacing_factor = 1.0
@@ -34,32 +36,30 @@ class Gruff::Dot < Gruff::Base
         y_pos = @graph_top + (items_width * point_index) + padding + (items_width.to_f / 2.0).round
 
         if row_index == 0
-          Gruff::Renderer::Line.new(color: @marker_color).render(@graph_left, y_pos, @graph_left + @graph_width, y_pos)
+          Gruff::Renderer::Line.new(renderer, color: @marker_color).render(@graph_left, y_pos, @graph_left + @graph_width, y_pos)
         end
 
-        Gruff::Renderer::Circle.new(color: data_row.color).render(x_pos, y_pos, x_pos + (item_width.to_f / 3.0).round, y_pos)
+        Gruff::Renderer::Circle.new(renderer, color: data_row.color).render(x_pos, y_pos, x_pos + (item_width.to_f / 3.0).round, y_pos)
 
         draw_label(y_pos, point_index)
       end
     end
   end
 
-protected
-
   # Instead of base class version, draws vertical background lines and label
   def draw_line_markers
     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 = Gruff::Renderer::Line.new(renderer, 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)
-        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(0, 0, x, @graph_bottom + (LABEL_MARGIN * 1.5), Magick::CenterGravity)
       end
     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/font.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Handle font setting to draw texts
+class Gruff::Font
+  BOLD_PATH = File.expand_path(File.join(__FILE__, '../../../assets/fonts/Roboto-Bold.ttf')).freeze
+  REGULAR_PATH = File.expand_path(File.join(__FILE__, '../../../assets/fonts/Roboto-Regular.ttf')).freeze
+
+  # Get/set font path.
+  attr_accessor :path
+
+  # Get/set font size.
+  attr_accessor :size
+
+  # Get/set font setting whether render bold text.
+  attr_accessor :bold
+
+  # Get/set font color.
+  attr_accessor :color
+
+  def initialize(path: nil, size: 20.0, bold: false, color: 'white')
+    @path = path
+    @bold = bold
+    @size = size
+    @color = color
+  end
+
+  # Get font weight.
+  # @return [Magick::WeightType] font weight
+  def weight
+    @bold ? Magick::BoldWeight : Magick::NormalWeight
+  end
+
+  # @private
+  def file_path
+    return @path if @path
+
+    @bold ? BOLD_PATH : REGULAR_PATH
+  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,71 @@
+# 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
+      val = begin
+        if format.is_a?(Proc)
+          format.call(@value)
+        else
+          sprintf(format || '%.2f', @value).commify
+        end
+      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
+      val = begin
+        if format.is_a?(Proc)
+          format.call(@value)
+        else
+          sprintf(format || '%.2f', @value).commify
+        end
+      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/helper/stacked_mixin.rb

@@ -7,10 +7,9 @@ module Gruff::Base::StackedMixin
   # tsal: moved from Base 03 FEB 2007
   def calculate_maximum_by_stack
     # Get sum of each stack
-    max_hash = {}
+    max_hash = Hash.new { |h, k| h[k] = 0.0 }
     store.data.each do |data_set|
       data_set.points.each_with_index do |data_point, i|
-        max_hash[i] = 0.0 unless max_hash[i]
         max_hash[i] += data_point.to_f
       end
     end

data/lib/gruff/histogram.rb

@@ -28,19 +28,21 @@ class Gruff::Histogram < Gruff::Bar
     @data = []
   end
 
-  def initialize_ivars
+  def data(name, data_points = [], color = nil)
+    @data << [name, data_points, color]
+  end
+
+private
+
+  def initialize_attributes
     super
     @bin_width = 10
     @minimum_bin = nil
     @maximum_bin = nil
   end
-  private :initialize_ivars
-
-  def data(name, data_points = [], color = nil)
-    @data << [name, data_points, color]
-  end
+  private :initialize_attributes
 
-  def draw
+  def setup_data
     @data.each do |(name, data_points, color)|
       bins, freqs = HistogramArray.new(data_points).histogram(bin_width: @bin_width, min: @minimum_bin, max: @maximum_bin)
       bins.each_with_index do |bin, index|

data/lib/gruff/line.rb

@@ -37,6 +37,9 @@ class Gruff::Line < Gruff::Base
   # accessors for support of xy data.
   attr_writer :maximum_x_value
 
+  # The number of vertical lines shown.
+  attr_writer :marker_x_count
+
   # Get the value if somebody has defined it.
   def baseline_value
     if @reference_lines.key?(:baseline)
@@ -78,29 +81,6 @@ class Gruff::Line < Gruff::Base
     end
   end
 
-  def initialize_store
-    @store = Gruff::Store.new(Gruff::Store::XYData)
-  end
-  private :initialize_store
-
-  def initialize_ivars
-    super
-    @reference_lines = {}
-    @reference_line_default_color = 'red'
-    @reference_line_default_width = 5
-
-    @hide_dots = @hide_lines = false
-    @maximum_x_value = nil
-    @minimum_x_value = nil
-
-    @line_width = nil
-    @dot_radius = nil
-    @dot_style = 'circle'
-
-    @show_vertical_markers = false
-  end
-  private :initialize_ivars
-
   # This method allows one to plot a dataset with both X and Y data.
   #
   # @overload dataxy(name, x_data_points = [], y_data_points = [], color = nil)
@@ -138,12 +118,14 @@ class Gruff::Line < Gruff::Base
   def dataxy(name, x_data_points = [], y_data_points = [], color = nil)
     # make sure it's an array
     x_data_points = Array(x_data_points)
-    y_data_points = Array(y_data_points)
 
     raise ArgumentError, 'x_data_points is nil!' if x_data_points.empty?
 
     if x_data_points.all? { |p| p.is_a?(Array) && p.size == 2 }
+      color = y_data_points if y_data_points.is_a?(String)
       x_data_points, y_data_points = x_data_points.transpose
+    else
+      y_data_points = Array(y_data_points)
     end
 
     raise ArgumentError, 'x_data_points.length != y_data_points.length!' if x_data_points.length != y_data_points.length
@@ -152,10 +134,34 @@ class Gruff::Line < Gruff::Base
     store.add(name, y_data_points, color, x_data_points)
   end
 
+private
+
+  def initialize_store
+    @store = Gruff::Store.new(Gruff::Store::XYData)
+  end
+
+  def initialize_attributes
+    super
+    @reference_lines = {}
+    @reference_line_default_color = 'red'
+    @reference_line_default_width = 5
+
+    @hide_dots = @hide_lines = false
+    @maximum_x_value = nil
+    @minimum_x_value = nil
+    @marker_x_count = nil
+
+    @line_width = nil
+    @dot_radius = nil
+    @dot_style = 'circle'
+
+    @show_vertical_markers = false
+  end
+
   def draw_reference_line(reference_line, left, right, top, bottom)
     color = reference_line[:color] || @reference_line_default_color
     width = reference_line[:width] || @reference_line_default_width
-    Gruff::Renderer::DashLine.new(color: color, width: width).render(left, top, right, bottom)
+    Gruff::Renderer::DashLine.new(renderer, color: color, width: width).render(left, top, right, bottom)
   end
 
   def draw_horizontal_reference_line(reference_line)
@@ -168,31 +174,15 @@ class Gruff::Line < Gruff::Base
     draw_reference_line(reference_line, index, index, @graph_top, @graph_top + @graph_height)
   end
 
-  def draw
-    super
-
-    return unless data_given?
-
+  def draw_graph
     # Check to see if more than one datapoint was given. NaN can result otherwise.
-    @x_increment = (column_count > 1) ? (@graph_width / (column_count - 1).to_f) : @graph_width
+    @x_increment = column_count > 1 ? (@graph_width / (column_count - 1).to_f) : @graph_width
 
     @reference_lines.each_value do |curr_reference_line|
       draw_horizontal_reference_line(curr_reference_line) if curr_reference_line.key?(:norm_value)
       draw_vertical_reference_line(curr_reference_line) if curr_reference_line.key?(:index)
     end
 
-    if @show_vertical_markers
-      (0..column_count).each do |column|
-        x = @graph_left + @graph_width - column.to_f * @x_increment
-
-        Gruff::Renderer::Line.new(color: @marker_color).render(x, @graph_bottom, x, @graph_top)
-        #If the user specified a marker shadow color, draw a shadow just below it
-        if @marker_shadow_color
-          Gruff::Renderer::Line.new(color: @marker_shadow_color).render(x + 1, @graph_bottom, x + 1, @graph_top)
-        end
-      end
-    end
-
     store.norm_data.each do |data_row|
       prev_x = prev_y = nil
 
@@ -200,7 +190,7 @@ class Gruff::Line < Gruff::Base
 
       data_row.coordinates.each_with_index do |(x_data, y_data), index|
         if x_data.nil?
-          #use the old method: equally spaced points along the x-axis
+          # use the old method: equally spaced points along the x-axis
           new_x = @graph_left + (@x_increment * index)
           draw_label(new_x, index)
         else
@@ -221,12 +211,12 @@ class Gruff::Line < Gruff::Base
         circle_radius = @dot_radius || clip_value_if_greater_than(@columns / (store.norm_data.first.y_points.size * 2.5), 5.0)
 
         if !@hide_lines && prev_x && prev_y
-          Gruff::Renderer::Line.new(color: data_row.color, width: stroke_width)
+          Gruff::Renderer::Line.new(renderer, color: data_row.color, width: stroke_width)
                                .render(prev_x, prev_y, new_x, new_y)
         end
 
         if one_point || !@hide_dots
-          Gruff::Renderer::Dot.new(@dot_style, color: data_row.color, width: stroke_width).render(new_x, new_y, circle_radius)
+          Gruff::Renderer::Dot.new(renderer, @dot_style, color: data_row.color, width: stroke_width).render(new_x, new_y, circle_radius)
         end
 
         prev_x = new_x
@@ -235,8 +225,6 @@ class Gruff::Line < Gruff::Base
     end
   end
 
-private
-
   def setup_data
     # Update the global min/max values for the x data
     @maximum_x_value ||= store.max_x
@@ -259,6 +247,11 @@ private
     super
   end
 
+  def setup_drawing
+    @marker_x_count ||= column_count - 1
+    super
+  end
+
   def normalize
     return unless data_given?
 
@@ -273,8 +266,22 @@ private
     end
   end
 
-  def sort_norm_data
-    super unless store.data.any?(&:x_points)
+  def draw_line_markers
+    # do all of the stuff for the horizontal lines on the y-axis
+    super
+    return if @hide_line_markers
+
+    (0..@marker_x_count).each do |index|
+      if @show_vertical_markers
+        x = @graph_left + @graph_width - index * @graph_width / @marker_x_count
+
+        Gruff::Renderer::Line.new(renderer, color: @marker_color).render(x, @graph_bottom, x, @graph_top)
+        # If the user specified a marker shadow color, draw a shadow just below it
+        if @marker_shadow_color
+          Gruff::Renderer::Line.new(renderer, color: @marker_shadow_color).render(x + 1, @graph_bottom, x + 1, @graph_top)
+        end
+      end
+    end
   end
 
   def get_x_coord(x_data_point, width, offset)

data/lib/gruff/mini/bar.rb

@@ -16,27 +16,30 @@ module Gruff
   module Mini
     # A class for drawing a small bar graph.
     class Bar < Gruff::Bar
+    private
+
       include Gruff::Mini::Legend
 
-      def initialize_ivars
+      def initialize_attributes
         super
 
         @hide_legend = true
         @hide_title = true
         @hide_line_numbers = true
 
-        @marker_font_size = 50.0
-        @legend_font_size = 60.0
+        @marker_font.size = 50.0
+        @legend_font.size = 60.0
 
         @minimum_value = 0.0
       end
-      private :initialize_ivars
 
-      def draw
+      def setup_data
         expand_canvas_for_vertical_legend
-
         super
+      end
 
+      def draw_graph
+        super
         draw_vertical_legend
       end
     end

data/lib/gruff/mini/legend.rb

@@ -3,6 +3,7 @@
 module Gruff
   module Mini
     # A module to handle the small legend.
+    # @private
     module Legend
       attr_accessor :hide_mini_legend, :legend_position
 
@@ -30,18 +31,20 @@ module Gruff
           @rows = [@rows, legend_height].max
           @columns += calculate_legend_width + @left_margin
         else
-          @rows += store.length * calculate_caps_height(scale_fontsize(@legend_font_size)) * 1.7
+          font = @legend_font.dup
+          font.size = scale_fontsize(font.size)
+          @rows += store.length * calculate_caps_height(font) * 1.7
         end
 
-        Gruff::Renderer.setup(@columns, @rows, @font, @scale, @theme_options)
+        @renderer = Gruff::Renderer.new(@columns, @rows, @scale, @theme_options)
       end
 
       def calculate_line_height
-        calculate_caps_height(@legend_font_size) * 1.7
+        calculate_caps_height(@legend_font) * 1.7
       end
 
       def calculate_legend_width
-        width = @legend_labels.map { |label| calculate_width(@legend_font_size, label) }.max
+        width = @legend_labels.map { |label| calculate_width(@legend_font, label) }.max
         scale_fontsize(width + 40 * 1.7)
       end
 
@@ -67,12 +70,12 @@ module Gruff
         @legend_labels.each_with_index do |legend_label, index|
           # Draw label
           label = truncate_legend_label(legend_label)
-          text_renderer = Gruff::Renderer::Text.new(label, font: @font, size: @legend_font_size, color: @font_color)
+          text_renderer = Gruff::Renderer::Text.new(renderer, label, font: @legend_font)
           x_offset = current_x_offset + (legend_square_width * 1.7)
           text_renderer.add_to_render_queue(@raw_columns, 1.0, x_offset, 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,
@@ -90,9 +93,10 @@ module Gruff
       def truncate_legend_label(label)
         truncated_label = label.to_s
 
-        font_size = scale_fontsize(@legend_font_size)
+        font = @legend_font.dup
+        font.size = scale_fontsize(font.size)
         max_width = @columns - @legend_left_margin - @right_margin
-        while calculate_width(font_size, truncated_label) > max_width && truncated_label.length > 1
+        while calculate_width(font, truncated_label) > max_width && truncated_label.length > 1
           truncated_label = truncated_label[0..truncated_label.length - 2]
         end
         truncated_label + (truncated_label.length < label.to_s.length ? '...' : '')

data/lib/gruff/mini/pie.rb

@@ -15,25 +15,28 @@ module Gruff
   module Mini
     # A class for drawing a small pie graph.
     class Pie < Gruff::Pie
+    private
+
       include Gruff::Mini::Legend
 
-      def initialize_ivars
+      def initialize_attributes
         super
 
         @hide_legend = true
         @hide_title = true
         @hide_line_numbers = true
 
-        @marker_font_size = 60.0
-        @legend_font_size = 60.0
+        @marker_font.size = 60.0
+        @legend_font.size = 60.0
       end
-      private :initialize_ivars
 
-      def draw
+      def setup_data
         expand_canvas_for_vertical_legend
-
         super
+      end
 
+      def draw_graph
+        super
         draw_vertical_legend
       end
     end