gruff 0.12.2 → 0.15.0

data/lib/gruff/renderer/text.rb

@@ -5,12 +5,10 @@ module Gruff
   class Renderer::Text
     using Magick::GruffAnnotate
 
-    def initialize(text, font:, size:, color:, weight: Magick::NormalWeight, rotation: nil)
+    def initialize(renderer, text, font:, rotation: nil)
+      @renderer = renderer
       @text = text.to_s
       @font = font
-      @font_size = size
-      @font_color = color
-      @font_weight = weight
       @rotation = rotation
     end
 
@@ -23,42 +21,36 @@ module Gruff
       @y = y
       @gravity = gravity
 
-      Renderer.instance.text_renderers << self
+      @renderer.text_renderers << self
     end
 
     def render(width, height, x, y, gravity = Magick::NorthGravity)
-      draw  = Renderer.instance.draw
-      image = Renderer.instance.image
-      scale = Renderer.instance.scale
-
-      draw.rotation = @rotation if @rotation
-      draw.fill = @font_color
-      draw.stroke = 'transparent'
-      draw.font = @font if @font
-      draw.font_weight = @font_weight
-      draw.pointsize = @font_size * scale
-      draw.gravity = gravity
-      draw.annotate_scaled(image,
-                           width, height,
-                           x, y,
-                           @text, scale)
-      draw.rotation = -@rotation if @rotation
+      @renderer.draw.rotation = @rotation if @rotation
+      @renderer.draw.fill = @font.color
+      @renderer.draw.stroke = 'transparent'
+      @renderer.draw.font = @font.file_path
+      @renderer.draw.font_weight = @font.weight
+      @renderer.draw.pointsize = @font.size * @renderer.scale
+      @renderer.draw.gravity = gravity
+      @renderer.draw.annotate_scaled(@renderer.image,
+                                     width, height,
+                                     x, y,
+                                     @text, @renderer.scale)
+      @renderer.draw.rotation = -@rotation if @rotation
     end
 
-    def self.metrics(text, size, font_weight = Magick::NormalWeight)
-      draw  = Renderer.instance.draw
-      image = Renderer.instance.image
-
-      draw.font_weight = font_weight
-      draw.pointsize = size
+    def metrics
+      @renderer.draw.font = @font.file_path
+      @renderer.draw.font_weight = @font.weight
+      @renderer.draw.pointsize = @font.size
 
       # The old ImageMagick causes SEGV with string which has '%' + alphabet (eg. '%S').
       # This format is used to embed value into a string using image properties.
       # However, gruff use plain image as canvas which does not have any property.
       # So, in here, it just escape % in order to avoid SEGV.
-      text = text.to_s.gsub(/(%+)/) { ('%' * Regexp.last_match(1).size * 2).to_s }
+      text = @text.to_s.gsub(/(%+)/) { ('%' * Regexp.last_match(1).size * 2).to_s }
 
-      draw.get_type_metrics(image, text)
+      @renderer.draw.get_type_metrics(@renderer.image, text)
     end
   end
 end

data/lib/gruff/scatter.rb

@@ -28,60 +28,18 @@ 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
-  private :initialize_store
-
-  def initialize_ivars
-    super
-
-    @baseline_x_color = @baseline_y_color = 'red'
-    @baseline_x_value = @baseline_y_value = nil
-    @circle_radius = nil
-    @disable_significant_rounding_x_axis = false
-    @enable_vertical_line_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
-
-  def draw
-    super
-    return unless data_given?
-
-    # 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
-
-    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)
-
-        # 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)
-        circle_radius = @circle_radius || clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 2.5), 5.0)
-        Gruff::Renderer::Circle.new(color: data_row.color, width: stroke_width).render(new_x, new_y, new_x - circle_radius, new_y)
-      end
-    end
+  # 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
 
   # The first parameter is the name of the dataset.  The next two are the
@@ -137,6 +95,44 @@ class Gruff::Scatter < Gruff::Base
 
 private
 
+  def initialize_store
+    @store = Gruff::Store.new(Gruff::Store::XYData)
+  end
+
+  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
+
+    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)
+
+        # 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)
+        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
@@ -152,7 +148,7 @@ private
     super
   end
 
-  def calculate_spread #:nodoc:
+  def calculate_spread
     super
     @x_spread = @maximum_x_value.to_f - @minimum_x_value.to_f
     @x_spread = @x_spread > 0 ? @x_spread : 1
@@ -180,18 +176,18 @@ private
         end
         @marker_x_count ||= 4
       end
-      @x_increment = (@x_spread > 0) ? (@x_spread / @marker_x_count) : 1
+      @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_value.ceil, @x_axis_increment].max
+      @maximum_x_value = [@maximum_x_value.ceil, @x_axis_increment].max
       @minimum_x_value = @minimum_x_value.floor
       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,43 +195,27 @@ 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)
+        line_renderer = Gruff::Renderer::Line.new(renderer, color: @marker_color, shadow_color: @marker_shadow_color)
         line_renderer.render(x, @graph_top, x, @graph_bottom)
       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 = 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)
       end
     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:
+  def get_x_coord(x_data_point, width, offset)
     x_data_point * width + offset
   end
 end

data/lib/gruff/scene.rb

@@ -52,7 +52,7 @@ class Gruff::Scene < Gruff::Base
     # Join all the custom paths and filter out the empty ones
     image_paths = @layers.map(&:path).reject(&:empty?)
     images = Magick::ImageList.new(*image_paths)
-    Gruff::Renderer.background_image = images.flatten_images
+    renderer.background_image = images.flatten_images
   end
 
   def layers=(ordered_list)
@@ -73,12 +73,20 @@ class Gruff::Scene < Gruff::Base
     case method_name.to_s
     when /^(\w+)_group=$/
       add_group Regexp.last_match(1), *args
-      return
     when /^(\w+)=$/
       set_input Regexp.last_match(1), args.first
-      return
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_sym, include_private)
+    case method_sym.to_s
+    when /^(\w+)_group=$/, /^(\w+)=$/
+      true
+    else
+      super
     end
-    super
   end
 
 private
@@ -90,7 +98,7 @@ private
   def set_input(input_name, input_value)
     if !@groups[input_name].nil?
       @groups[input_name].send_updates(input_value)
-    elsif chosen_layer = @layers.find { |layer| layer.name == input_name }
+    elsif (chosen_layer = @layers.find { |layer| layer.name == input_name })
       chosen_layer.update input_value
     end
   end
@@ -121,7 +129,7 @@ class Gruff::Layer
   def initialize(base_dir, folder_name)
     @base_dir = base_dir.to_s
     @name = folder_name.to_s
-    @filenames = Dir.open(File.join(base_dir, folder_name)).entries.select { |file| file =~ /^[^.]+\.png$/ }.sort
+    @filenames = Dir.open(File.join(base_dir, folder_name)).entries.grep(/^[^.]+\.png$/).sort
     @selected_filename = select_default
   end
 
@@ -132,18 +140,20 @@ class Gruff::Layer
 
   # Choose the appropriate filename for this layer, based on the input
   def update(value)
-    @selected_filename =  case value.to_s
-                          when /^(true|false)$/
-                            select_boolean value
-                          when /^(\w|\s)+$/
-                            select_string value
-                          when /^-?(\d+\.)?\d+$/
-                            select_numeric value
-                          when /(\d\d):(\d\d):\d\d/
-                            select_time "#{Regexp.last_match(1)}#{Regexp.last_match(2)}"
-                          else
-                            select_default
-                          end
+    @selected_filename = begin
+      case value.to_s
+      when /^(true|false)$/
+        select_boolean value
+      when /^(\w|\s)+$/
+        select_string value
+      when /^-?(\d+\.)?\d+$/
+        select_numeric value
+      when /(\d\d):(\d\d):\d\d/
+        select_time "#{Regexp.last_match(1)}#{Regexp.last_match(2)}"
+      else
+        select_default
+      end
+    end
     # Finally, try to use 'default' if we're still blank
     @selected_filename ||= select_default
   end

data/lib/gruff/side_bar.rb

@@ -19,15 +19,13 @@
 #   g.write('sidebar.png')
 #
 class Gruff::SideBar < Gruff::Base
-  using String::GruffCommify
-
   # Spacing factor applied between bars.
   attr_writer :bar_spacing
 
   # Spacing factor applied between a group of bars belonging to the same label.
   attr_writer :group_spacing
 
-  # Set the number output format for labels using sprintf.
+  # Set the number output format string or lambda.
   # Default is +"%.2f"+.
   attr_writer :label_formatting
 
@@ -38,27 +36,24 @@ class Gruff::SideBar < Gruff::Base
   # Prevent drawing of column labels left of a side bar graph.  Default is +false+.
   attr_writer :hide_labels
 
-  def initialize_ivars
+  # With Side Bars use the data label for the marker value to the left of the bar.
+  # @deprecated
+  def use_data_label=(_value)
+    warn '#use_data_label is deprecated. It is no longer effective.'
+  end
+
+private
+
+  def initialize_attributes
     super
     @bar_spacing = 0.9
     @group_spacing = 10
     @label_formatting = nil
     @show_labels_for_bar_values = false
     @hide_labels = false
-  end
-  private :initialize_ivars
-
-  def draw
     @has_left_labels = true
-    super
-
-    return unless data_given?
-
-    draw_bars
   end
 
-protected
-
   def hide_labels?
     @hide_labels
   end
@@ -71,55 +66,44 @@ protected
     @hide_line_markers
   end
 
-private
+  # Value to avoid completely overwriting the coordinate axis
+  AXIS_MARGIN = 0.5
 
-  def draw_bars
+  def draw_graph
     # Setup spacing.
     #
     bars_width = (@graph_height - calculate_spacing) / column_count.to_f
     bar_width = bars_width / store.length
-    height = Array.new(column_count, 0)
-    length = Array.new(column_count, @graph_left)
     padding = (bar_width * (1 - @bar_spacing)) / 2
 
-    # if we're a side stacked bar then we don't need to draw ourself at all
-    # because sometimes (due to different heights/min/max) you can actually
-    # see both graphs and it looks like crap
-    return if is_a?(Gruff::SideStackedBar)
+    # Setup the BarConversion Object
+    conversion = Gruff::BarConversion.new(
+      top: @graph_right, bottom: @graph_left,
+      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
 
-        # 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])
-        temp2 = @graph_left + @graph_width - height[point_index]
-        difference = temp2 - temp1
-
-        left_x = length[point_index] - 1
         left_y = @graph_top + (bars_width * point_index) + (bar_width * row_index) + padding + group_spacing
-        right_x = left_x + difference
         right_y = left_y + bar_width * @bar_spacing
 
-        height[point_index] += (data_point * @graph_width)
+        left_x, right_x = conversion.get_top_bottom_scaled(data_point).sort
 
-        rect_renderer = Gruff::Renderer::Rectangle.new(color: data_row.color)
-        rect_renderer.render(left_x, left_y, right_x, right_y)
+        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
 
-        if @use_data_label
-          label_center = left_y + bar_width / 2
-          draw_label(label_center, row_index, store.norm_data[row_index].label)
-        else
-          label_center = left_y + bars_width / 2
-          draw_label(label_center, point_index)
-        end
+        # Subtract half a bar width to center left if requested
+        draw_label(label_center, point_index)
         if @show_labels_for_bar_values
-          val = (@label_formatting || '%.2f') % store.data[row_index].points[point_index]
-          draw_value_label(right_x + 40, right_y - bar_width / 2, val.commify, true)
+          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)
+          end
         end
       end
     end
@@ -139,14 +123,14 @@ private
       line_diff = (@graph_right - @graph_left) / number_of_lines
       x = @graph_right - (line_diff * index) - 1
 
-      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_top)
 
-      diff = index - number_of_lines
-      marker_label = diff.abs * increment + minimum_value
-
       unless @hide_line_numbers
-        text_renderer = Gruff::Renderer::Text.new(marker_label, font: @font, size: @marker_font_size, color: @font_color)
+        diff = index - number_of_lines
+        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)
       end
     end
@@ -155,12 +139,9 @@ private
   ##
   # Draw on the Y axis instead of the X
 
-  def draw_label(y_offset, index, label = nil)
+  def draw_label(y_offset, index)
     draw_unique_label(index) do
-      lbl = @use_data_label ? label : @labels[index]
-
-      text_renderer = Gruff::Renderer::Text.new(lbl, 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
 

data/lib/gruff/side_stacked_bar.rb

@@ -21,7 +21,6 @@
 #
 class Gruff::SideStackedBar < Gruff::SideBar
   include StackedMixin
-  include BarValueLabelMixin
 
   # Spacing factor applied between bars.
   attr_writer :bar_spacing
@@ -29,7 +28,7 @@ class Gruff::SideStackedBar < Gruff::SideBar
   # Number of pixels between bar segments.
   attr_writer :segment_spacing
 
-  # Set the number output format for labels using sprintf.
+  # Set the number output format string or lambda.
   # Default is +"%.2f"+.
   attr_writer :label_formatting
 
@@ -40,24 +39,23 @@ 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_ivars
+private
+
+  def initialize_attributes
     super
     @bar_spacing = 0.9
     @segment_spacing = 2.0
     @label_formatting = nil
     @show_labels_for_bar_values = false
     @hide_labels = false
+    @has_left_labels = true
   end
-  private :initialize_ivars
 
-  def draw
-    @has_left_labels = true
+  def setup_data
     calculate_maximum_by_stack
     super
   end
 
-protected
-
   def hide_labels?
     @hide_labels
   end
@@ -70,9 +68,7 @@ protected
     @hide_line_markers
   end
 
-private
-
-  def draw_bars
+  def draw_graph
     # Setup spacing.
     #
     # Columns sit stacked.
@@ -80,7 +76,7 @@ private
     height = Array.new(column_count, 0)
     length = Array.new(column_count, @graph_left)
     padding = (bar_width * (1 - @bar_spacing)) / 2
-    bar_value_label = BarValueLabel.new(column_count, bar_width)
+    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|
@@ -91,6 +87,7 @@ private
                                   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
@@ -99,14 +96,14 @@ private
         length[point_index] += difference
         height[point_index] += (data_point * @graph_width - 2)
 
-        bar_value_label.coordinates[point_index] = [left_x, left_y, right_x, right_y]
-        bar_value_label.values[point_index] += store.data[row_index].points[point_index]
+        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(color: data_row.color)
+          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
@@ -118,8 +115,8 @@ private
     end
 
     if @show_labels_for_bar_values
-      bar_value_label.prepare_sidebar_rendering(@label_formatting) do |x, y, text|
-        draw_value_label(x, y, text, true)
+      stack_bar_value_label.prepare_rendering(@label_formatting, bar_width) do |x, y, text|
+        draw_value_label(x, y, text)
       end
     end
   end