gruff 0.15.0-java → 0.18.0-java

data/lib/gruff/renderer/renderer.rb

@@ -23,10 +23,6 @@ module Gruff
       end
     end
 
-    def background_image=(image)
-      @image = image
-    end
-
     def background(columns, rows, scale, theme_options)
       case theme_options[:background_colors]
       when Array

data/lib/gruff/renderer/text.rb

@@ -25,6 +25,7 @@ module Gruff
     end
 
     def render(width, height, x, y, gravity = Magick::NorthGravity)
+      @renderer.draw.push
       @renderer.draw.rotation = @rotation if @rotation
       @renderer.draw.fill = @font.color
       @renderer.draw.stroke = 'transparent'
@@ -37,9 +38,11 @@ module Gruff
                                      x, y,
                                      @text, @renderer.scale)
       @renderer.draw.rotation = -@rotation if @rotation
+      @renderer.draw.pop
     end
 
     def metrics
+      @renderer.draw.push
       @renderer.draw.font = @font.file_path
       @renderer.draw.font_weight = @font.weight
       @renderer.draw.pointsize = @font.size
@@ -50,7 +53,10 @@ module Gruff
       # So, in here, it just escape % in order to avoid SEGV.
       text = @text.to_s.gsub(/(%+)/) { ('%' * Regexp.last_match(1).size * 2).to_s }
 
-      @renderer.draw.get_type_metrics(@renderer.image, text)
+      metrics = @renderer.draw.get_type_metrics(@renderer.image, text)
+      @renderer.draw.pop
+
+      metrics
     end
   end
 end

data/lib/gruff/scatter.rb

@@ -24,24 +24,35 @@ class Gruff::Scatter < Gruff::Base
   attr_writer :circle_radius
   attr_writer :stroke_width
 
-  # Allow disabling the significant rounding when labeling the X axis.
-  # 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 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 enabling vertical lines. When you have a lot of data, they can work great.
-  # @deprecated Please use +show_vertical_markers+ attribute instead.
+  # @deprecated Please use {#show_vertical_markers=} 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
 
+  # Allow using vertical labels in the X axis.
+  # @deprecated Please use {Gruff::Base#label_rotation=} instead.
+  def use_vertical_x_labels=(_value)
+    warn '#use_vertical_x_labels= is deprecated. It is no longer effective. Please use `#label_rotation=` instead'
+  end
+
+  # Allow using vertical labels in the X axis (and setting the label margin).
+  # @deprecated
+  def x_label_margin=(_value)
+    warn '#x_label_margin= is deprecated. It is no longer effective.'
+  end
+
+  # Allow disabling the significant rounding when labeling the X axis.
+  # This is useful when working with a small range of high values (for example, a date range of months, while seconds as units).
+  # @deprecated
+  def disable_significant_rounding_x_axis=(_value)
+    warn '#disable_significant_rounding_x_axis= is deprecated. It is no longer effective.'
+  end
+
   # The first parameter is the name of the dataset.  The next two are the
   # x and y axis data points contain in their own array in that respective
   # order.  The final parameter is the color.
@@ -55,11 +66,10 @@ class Gruff::Scatter < Gruff::Base
   # @note If you want to use a preset theme, you must set it before calling {#data}.
   #
   # @param name [String, Symbol] containing the name of the dataset.
-  # @param x_data_points [Array] An Array of of x-axis data points.
-  # @param y_data_points [Array] An Array of of y-axis data points.
+  # @param x_data_points [Array] An Array of x-axis data points.
+  # @param y_data_points [Array] An Array of y-axis data points.
   # @param color [String] The hex string for the color of the dataset. Defaults to nil.
   #
-  #
   # @raise [ArgumentError] Data points contain nil values.
   #   This error will get raised if either the x or y axis data points array
   #   contains a +nil+ value.  The graph will not make an assumption
@@ -88,7 +98,7 @@ class Gruff::Scatter < Gruff::Base
     raise ArgumentError, 'x_data_points.length != y_data_points.length!' if x_data_points.length != y_data_points.length
 
     # Call the existing data routine for the x/y axis data
-    store.add(name, y_data_points, color, x_data_points)
+    store.add(name, x_data_points, y_data_points, color)
   end
 
   alias dataxy data
@@ -102,56 +112,55 @@ private
   def initialize_attributes
     super
 
-    @baseline_x_color = @baseline_y_color = 'red'
-    @baseline_x_value = @baseline_y_value = nil
     @circle_radius = nil
-    @disable_significant_rounding_x_axis = 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_label_margin = nil
   end
 
-  def draw_graph
-    # Check to see if more than one datapoint was given. NaN can result otherwise.
-    @x_increment = @x_spread > 1 ? (@graph_width / (@x_spread - 1).to_f) : @graph_width
+  def setup_drawing
+    @center_labels_over_point = false
+    super
+  end
 
+  def setup_data
+    # TODO: Need to get x-axis labels working. Current behavior will be to not allow.
+    @labels = {}
+
+    # Update the global min/max values for the x data
+    @maximum_x_value = (@maximum_x_value || store.max_x).to_f
+    @minimum_x_value = (@minimum_x_value || store.min_x).to_f
+
+    if @x_axis_increment
+      # TODO: Make this work for negative values
+      @maximum_x_value = [@maximum_x_value.ceil, @x_axis_increment.to_f].max
+      @minimum_x_value = @minimum_x_value.floor
+    end
+
+    super
+  end
+
+  def draw_graph
     store.norm_data.each do |data_row|
       data_row.coordinates.each do |x_value, y_value|
         next if y_value.nil? || x_value.nil?
 
-        new_x = get_x_coord(x_value, @graph_width, @graph_left)
-        new_y = @graph_top + (@graph_height - y_value * @graph_height)
+        new_x = @graph_left + (x_value * @graph_width)
+        new_y = @graph_bottom - (y_value * @graph_height)
 
         # Reset each time to avoid thin-line errors
-        stroke_width  = @stroke_width  || clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 4), 5.0)
+        stroke_width  = @stroke_width  || clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 4.0), 5.0)
         circle_radius = @circle_radius || clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 2.5), 5.0)
         Gruff::Renderer::Circle.new(renderer, color: data_row.color, width: stroke_width).render(new_x, new_y, new_x - circle_radius, new_y)
       end
     end
   end
 
-  def setup_data
-    # Update the global min/max values for the x data
-    @maximum_x_value ||= store.max_x
-    @minimum_x_value ||= store.min_x
-
-    super
-  end
-
-  def setup_drawing
-    # TODO: Need to get x-axis labels working. Current behavior will be to not allow.
-    @labels = {}
-
-    super
-  end
-
   def calculate_spread
     super
     @x_spread = @maximum_x_value.to_f - @minimum_x_value.to_f
-    @x_spread = @x_spread > 0 ? @x_spread : 1
+    @x_spread = @x_spread > 0 ? @x_spread : 1.0
   end
 
   def normalize
@@ -165,57 +174,51 @@ private
     super
     return if @hide_line_markers
 
-    if @x_axis_increment.nil?
-      # TODO: Do the same for larger numbers...100, 75, 50, 25
-      if @marker_x_count.nil?
-        (3..7).each do |lines|
-          if @x_spread % lines == 0.0
-            @marker_x_count = lines
-            break
-          end
-        end
-        @marker_x_count ||= 4
-      end
-      @x_increment = @x_spread > 0 ? (@x_spread / @marker_x_count) : 1
-      unless @disable_significant_rounding_x_axis
-        @x_increment = significant(@x_increment)
-      end
-    else
-      # TODO: Make this work for negative values
-      @maximum_x_value = [@maximum_x_value.ceil, @x_axis_increment].max
-      @minimum_x_value = @minimum_x_value.floor
-      calculate_spread
-      normalize
-
-      @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)
+    increment_x_scaled = (@graph_width / (@x_spread / x_increment)).to_f
 
     # Draw vertical line markers and annotate with numbers
-    (0..@marker_x_count).each do |index|
+    (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 @show_vertical_markers
-        x = @graph_left + @graph_width - index.to_f * increment_x_scaled
-
-        line_renderer = Gruff::Renderer::Line.new(renderer, color: @marker_color, shadow_color: @marker_shadow_color)
-        line_renderer.render(x, @graph_top, x, @graph_bottom)
+        draw_marker_vertical_line(@graph_left + (index * increment_x_scaled))
       end
 
       unless @hide_line_numbers
-        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 = x_axis_label(marker_label, @x_increment)
-        rotation = -90.0 if @use_vertical_x_labels
-        text_renderer = Gruff::Renderer::Text.new(renderer, label, font: @marker_font, rotation: rotation)
-        text_renderer.add_to_render_queue(1.0, 1.0, x_offset, y_offset)
+        marker_label = (BigDecimal(index.to_s) * BigDecimal(x_increment.to_s)) + BigDecimal(@minimum_x_value.to_s)
+        label = x_axis_label(marker_label, x_increment)
+        x = @graph_left + (increment_x_scaled * index)
+        y = @graph_bottom
+        x_offset, y_offset = calculate_label_offset(@marker_font, label, LABEL_MARGIN, @label_rotation)
+
+        draw_label_at(1.0, 1.0, x + x_offset, y + y_offset, label, rotation: @label_rotation)
       end
     end
   end
 
-  def get_x_coord(x_data_point, width, offset)
-    x_data_point * width + offset
+  def marker_x_count
+    # TODO: Do the same for larger numbers...100, 75, 50, 25
+    @marker_x_count ||= begin
+      if @x_axis_increment.nil?
+        count = nil
+        (3..7).each do |lines|
+          if @x_spread % lines == 0.0
+            count = lines and break
+          end
+        end
+        count || 4
+      else
+        (@x_spread / @x_axis_increment).to_i
+      end
+    end
+  end
+
+  def x_increment
+    @x_increment ||= begin
+      if @x_axis_increment.nil?
+        @x_spread > 0 ? significant(@x_spread / marker_x_count) : 1.0
+      else
+        @x_axis_increment.to_f
+      end
+    end
   end
 end

data/lib/gruff/side_bar.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'helper/bar_mixin'
+
 # Graph with individual horizontal bars instead of vertical bars.
 #
 # Here's how to set up a Gruff::SideBar.
@@ -19,6 +21,8 @@
 #   g.write('sidebar.png')
 #
 class Gruff::SideBar < Gruff::Base
+  include BarMixin
+
   # Spacing factor applied between bars.
   attr_writer :bar_spacing
 
@@ -36,6 +40,15 @@ class Gruff::SideBar < Gruff::Base
   # Prevent drawing of column labels left of a side bar graph.  Default is +false+.
   attr_writer :hide_labels
 
+  # Value to avoid completely overwriting the coordinate axis
+  AXIS_MARGIN = 0.5
+  private_constant :AXIS_MARGIN
+
+  def initialize(*)
+    super
+    @has_left_labels = true
+  end
+
   # With Side Bars use the data label for the marker value to the left of the bar.
   # @deprecated
   def use_data_label=(_value)
@@ -51,7 +64,6 @@ private
     @label_formatting = nil
     @show_labels_for_bar_values = false
     @hide_labels = false
-    @has_left_labels = true
   end
 
   def hide_labels?
@@ -59,20 +71,37 @@ private
   end
 
   def hide_left_label_area?
-    hide_labels?
+    hide_labels? && @y_axis_label.nil?
   end
 
   def hide_bottom_label_area?
-    @hide_line_markers
+    @hide_line_markers && @x_axis_label.nil? && @legend_at_bottom == false
   end
 
-  # Value to avoid completely overwriting the coordinate axis
-  AXIS_MARGIN = 0.5
+  def setup_graph_measurements
+    super
+    return if @hide_line_markers
+
+    if @show_labels_for_bar_values
+      if maximum_value >= 0
+        _, metrics = Gruff::BarValueLabel.metrics(maximum_value, @label_formatting, proc_text_metrics)
+        @graph_right -= metrics.width
+      end
+
+      if minimum_value < 0
+        _, metrics = Gruff::BarValueLabel.metrics(minimum_value, @label_formatting, proc_text_metrics)
+        width = metrics.width + LABEL_MARGIN
+        @graph_left += width - @graph_left if width > @graph_left
+      end
+
+      @graph_width = @graph_right - @graph_left
+    end
+  end
 
   def draw_graph
     # Setup spacing.
     #
-    bars_width = (@graph_height - calculate_spacing) / column_count.to_f
+    bars_width = (@graph_height - calculate_spacing) / column_count
     bar_width = bars_width / store.length
     padding = (bar_width * (1 - @bar_spacing)) / 2
 
@@ -82,30 +111,32 @@ private
       minimum_value: minimum_value, maximum_value: maximum_value, spread: @spread
     )
 
-    store.norm_data.each_with_index do |data_row, row_index|
-      data_row.points.each_with_index do |data_point, point_index|
-        group_spacing = @group_spacing * @scale * point_index
-
-        left_y = @graph_top + (bars_width * point_index) + (bar_width * row_index) + padding + group_spacing
-        right_y = left_y + bar_width * @bar_spacing
+    group_left_y = @graph_top
 
-        left_x, right_x = conversion.get_top_bottom_scaled(data_point).sort
+    normalized_group_bars.each_with_index do |group_bars, group_index|
+      right_y = 0
+      group_bars.each_with_index do |bar, index|
+        left_y = group_left_y + (bar_width * index) + padding
+        right_y = left_y + (bar_width * @bar_spacing)
 
-        rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: data_row.color)
-        rect_renderer.render(left_x + AXIS_MARGIN, left_y, right_x + AXIS_MARGIN, right_y)
-
-        # Calculate center based on bar_width and current row
-        label_center = left_y + bars_width / 2
+        bottom_x, top_x = conversion.get_top_bottom_scaled(bar.point).sort
+        if bar.point != 0
+          rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: bar.color)
+          rect_renderer.render(bottom_x + AXIS_MARGIN, left_y, top_x, right_y)
+        end
 
-        # Subtract half a bar width to center left if requested
-        draw_label(label_center, point_index)
-        if @show_labels_for_bar_values
-          bar_value_label = Gruff::BarValueLabel::SideBar.new([left_x, left_y, right_x, right_y], store.data[row_index].points[point_index])
-          bar_value_label.prepare_rendering(@label_formatting, bar_width) do |x, y, text|
-            draw_value_label(x, y, text)
+        if @show_labels_for_bar_values && bar.value
+          bar_value_label = Gruff::BarValueLabel::SideBar.new([bottom_x, left_y, top_x, right_y], bar.value)
+          bar_value_label.prepare_rendering(@label_formatting, proc_text_metrics) do |x, y, text, text_width, _text_height|
+            draw_value_label(text_width, bar_width * @bar_spacing, x, y, text)
           end
         end
       end
+
+      label_center = group_left_y + (bars_width / 2.0)
+      draw_label(label_center, group_index)
+
+      group_left_y = right_y + padding + @group_spacing
     end
   end
 
@@ -118,17 +149,15 @@ private
     number_of_lines = 1 if number_of_lines == 0
 
     # TODO: Round maximum marker value to a round number like 100, 0.1, 0.5, etc.
-    increment = significant(@spread.to_f / number_of_lines)
+    increment = significant(@spread / number_of_lines)
     (0..number_of_lines).each do |index|
       line_diff = (@graph_right - @graph_left) / number_of_lines
       x = @graph_right - (line_diff * index) - 1
-
-      line_renderer = Gruff::Renderer::Line.new(renderer, color: @marker_color, shadow_color: @marker_shadow_color)
-      line_renderer.render(x, @graph_bottom, x, @graph_top)
+      draw_marker_vertical_line(x)
 
       unless @hide_line_numbers
         diff = index - number_of_lines
-        marker_label = BigDecimal(diff.abs.to_s) * BigDecimal(increment.to_s) + BigDecimal(minimum_value.to_s)
+        marker_label = (BigDecimal(diff.abs.to_s) * BigDecimal(increment.to_s)) + BigDecimal(minimum_value.to_s)
         label = x_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, Magick::CenterGravity)
@@ -141,11 +170,15 @@ private
 
   def draw_label(y_offset, index)
     draw_unique_label(index) do
-      draw_label_at(@graph_left - LABEL_MARGIN, 1.0, 0.0, y_offset, @labels[index], Magick::EastGravity)
+      draw_label_at(@graph_left - LABEL_MARGIN, 1.0, 0.0, y_offset, @labels[index], gravity: Magick::EastGravity)
     end
   end
 
   def calculate_spacing
-    @scale * @group_spacing * (column_count - 1)
+    @group_spacing * (column_count - 1)
+  end
+
+  def proc_text_metrics
+    ->(text) { text_metrics(@marker_font, text) }
   end
 end

data/lib/gruff/side_stacked_bar.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'helper/stacked_mixin'
+
 #
 # New gruff graph type added to enable sideways stacking bar charts
 # (basically looks like a x/y flip of a standard stacking bar chart)
@@ -39,6 +41,11 @@ class Gruff::SideStackedBar < Gruff::SideBar
   # Prevent drawing of column labels left of a side stacked bar graph.  Default is +false+.
   attr_writer :hide_labels
 
+  def initialize(*)
+    super
+    @has_left_labels = true
+  end
+
 private
 
   def initialize_attributes
@@ -48,7 +55,7 @@ private
     @label_formatting = nil
     @show_labels_for_bar_values = false
     @hide_labels = false
-    @has_left_labels = true
+    @minimum_value = 0.0
   end
 
   def setup_data
@@ -56,67 +63,48 @@ private
     super
   end
 
-  def hide_labels?
-    @hide_labels
-  end
-
-  def hide_left_label_area?
-    hide_labels?
-  end
-
-  def hide_bottom_label_area?
-    @hide_line_markers
-  end
-
   def draw_graph
     # Setup spacing.
     #
     # Columns sit stacked.
-    bar_width = @graph_height / column_count.to_f
-    height = Array.new(column_count, 0)
-    length = Array.new(column_count, @graph_left)
+    bar_width = @graph_height / column_count
     padding = (bar_width * (1 - @bar_spacing)) / 2
-    stack_bar_value_label = Gruff::BarValueLabel::StackedBar.new
-
-    store.norm_data.each_with_index do |data_row, row_index|
-      data_row.points.each_with_index do |data_point, point_index|
-        ## using the original calculations from the stacked bar chart to get the difference between
-        ## part of the bart chart we wish to stack.
-        temp1 = @graph_left + (@graph_width -
-                                  data_point * @graph_width -
-                                  height[point_index]) + 1
-        temp2 = @graph_left + @graph_width - height[point_index] - 1
-        difference = temp2 - temp1
-        difference = 0 if row_index == 0 && difference < 0
-
-        left_x = length[point_index]
-        left_y = @graph_top + (bar_width * point_index) + padding
-        right_x = left_x + difference - @segment_spacing
-        right_y = left_y + bar_width * @bar_spacing
-        length[point_index] += difference
-        height[point_index] += (data_point * @graph_width - 2)
-
-        bar_value_label = Gruff::BarValueLabel::SideBar.new([left_x, left_y, right_x, right_y], store.data[row_index].points[point_index])
-        stack_bar_value_label.add(bar_value_label, point_index)
-
-        # if a data point is 0 it can result in weird really thing lines
-        # that shouldn't even be there being drawn on top of the existing
-        # bar - this is bad
-        if data_point != 0
-          rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: data_row.color)
-          rect_renderer.render(left_x, left_y, right_x, right_y)
-          # Calculate center based on bar_width and current row
-        end
-        # we still need to draw the labels
-        # Calculate center based on bar_width and current row
-        label_center = left_y + bar_width / 2
-        draw_label(label_center, point_index)
+
+    # Setup the BarConversion Object
+    conversion = Gruff::BarConversion.new(
+      top: @graph_right, bottom: @graph_left,
+      minimum_value: minimum_value, maximum_value: maximum_value, spread: @spread
+    )
+
+    proc_text_metrics = ->(text) { text_metrics(@marker_font, text) }
+
+    normalized_stacked_bars.each_with_index do |stacked_bars, stacked_index|
+      total = 0
+      left_y = @graph_top + (bar_width * stacked_index) + padding
+      right_y = left_y + (bar_width * @bar_spacing)
+
+      top_x = 0
+      stacked_bars.each do |bar|
+        next if bar.point == 0
+
+        bottom_x, = conversion.get_top_bottom_scaled(total)
+        bottom_x += @segment_spacing
+        top_x, = conversion.get_top_bottom_scaled(total + bar.point)
+
+        rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: bar.color)
+        rect_renderer.render(bottom_x, left_y, top_x, right_y)
+
+        total += bar.point
       end
-    end
 
-    if @show_labels_for_bar_values
-      stack_bar_value_label.prepare_rendering(@label_formatting, bar_width) do |x, y, text|
-        draw_value_label(x, y, text)
+      label_center = left_y + (bar_width / 2.0)
+      draw_label(label_center, stacked_index)
+
+      if @show_labels_for_bar_values
+        bar_value_label = Gruff::BarValueLabel::SideBar.new([@graph_left, left_y, top_x, right_y], stacked_bars.sum(&:value))
+        bar_value_label.prepare_rendering(@label_formatting, proc_text_metrics) do |x, y, text, text_width, _text_height|
+          draw_value_label(text_width, bar_width * @bar_spacing, x, y, text)
+        end
       end
     end
   end