gruff 0.9.0 → 0.12.2

data/lib/gruff/mini/bar.rb

@@ -1,11 +1,20 @@
 # frozen_string_literal: true
 
-##
 #
 # Makes a small bar graph suitable for display at 200px or even smaller.
 #
+# Here's how to set up a Gruff::Mini::Bar.
+#
+#   g = Gruff::Mini::Bar.new
+#   g.title = 'Mini Bar Graph'
+#   g.data :Art, [0, 5, 8, 15]
+#   g.data :Philosophy, [10, 3, 2, 8]
+#   g.data :Science, [2, 15, 8, 11]
+#   g.write('mini_bar.png')
+#
 module Gruff
   module Mini
+    # A class for drawing a small bar graph.
     class Bar < Gruff::Bar
       include Gruff::Mini::Legend
 
@@ -29,7 +38,6 @@ module Gruff
         super
 
         draw_vertical_legend
-        Gruff::Renderer.finish
       end
     end
   end

data/lib/gruff/mini/legend.rb

@@ -2,6 +2,7 @@
 
 module Gruff
   module Mini
+    # A module to handle the small legend.
     module Legend
       attr_accessor :hide_mini_legend, :legend_position
 
@@ -25,7 +26,7 @@ module Gruff
         @original_columns = @raw_columns
 
         case @legend_position
-        when :right then
+        when :right
           @rows = [@rows, legend_height].max
           @columns += calculate_legend_width + @left_margin
         else
@@ -55,7 +56,7 @@ module Gruff
         legend_top_margin = 40.0
 
         case @legend_position
-        when :right then
+        when :right
           current_x_offset = @original_columns + @left_margin
           current_y_offset = @top_margin + legend_top_margin
         else
@@ -67,7 +68,8 @@ module Gruff
           # 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.render(@raw_columns, 1.0, current_x_offset + (legend_square_width * 1.7), current_y_offset, Magick::WestGravity)
+          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)
@@ -87,7 +89,10 @@ module Gruff
 
       def truncate_legend_label(label)
         truncated_label = label.to_s
-        while calculate_width(scale_fontsize(@legend_font_size), truncated_label) > (@columns - @legend_left_margin - @right_margin) && (truncated_label.length > 1)
+
+        font_size = scale_fontsize(@legend_font_size)
+        max_width = @columns - @legend_left_margin - @right_margin
+        while calculate_width(font_size, 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

@@ -1,11 +1,19 @@
 # frozen_string_literal: true
 
-##
 #
 # Makes a small pie graph suitable for display at 200px or even smaller.
 #
+# Here's how to set up a Gruff::Mini::Pie.
+#
+#   g = Gruff::Mini::Pie.new
+#   g.title = "Visual Pie Graph Test"
+#   g.data 'Fries', 20
+#   g.data 'Hamburgers', 50
+#   g.write("mini_pie_keynote.png")
+#
 module Gruff
   module Mini
+    # A class for drawing a small pie graph.
     class Pie < Gruff::Pie
       include Gruff::Mini::Legend
 
@@ -27,8 +35,6 @@ module Gruff
         super
 
         draw_vertical_legend
-
-        Gruff::Renderer.finish
       end
     end
   end

data/lib/gruff/mini/side_bar.rb

@@ -1,11 +1,27 @@
 # frozen_string_literal: true
 
-##
 #
-# Makes a small pie graph suitable for display at 200px or even smaller.
+# Makes a small side bar graph suitable for display at 200px or even smaller.
+#
+# Here's how to set up a Gruff::Mini::SideBar.
+#
+#   g = Gruff::Mini::SideBar.new
+#   g.title = 'SideBar Graph'
+#   g.labels = {
+#     0 => '5/6',
+#     1 => '5/15',
+#     2 => '5/24',
+#     3 => '5/30',
+#   }
+#   g.group_spacing = 20
+#   g.data :Art, [0, 5, 8, 15]
+#   g.data :Philosophy, [10, 3, 2, 8]
+#   g.data :Science, [2, 15, 8, 11]
+#   g.write('mini_sidebar.png')
 #
 module Gruff
   module Mini
+    # A class for drawing a small side bar graph.
     class SideBar < Gruff::SideBar
       include Gruff::Mini::Legend
 
@@ -26,8 +42,6 @@ module Gruff
         super
 
         draw_vertical_legend
-
-        Gruff::Renderer.finish
       end
     end
   end

data/lib/gruff/net.rb

@@ -1,20 +1,41 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
-# Experimental!!! See also the Spider graph.
+# See also the Spider graph.
+#
+# Here's how to make a Gruff::Net.
+#
+#   g = Gruff::Net.new
+#   g.title = "Net Graph"
+#   g.labels = {
+#     0 => '5/6',
+#     1 => '5/15',
+#     2 => '5/24',
+#     3 => '5/30',
+#     4 => '6/4',
+#     5 => '6/12',
+#     6 => '6/21',
+#     7 => '6/28'
+#   }
+#   g.line_width = 3
+#   g.dot_radius = 4
+#   g.data :Jimmy, [25, 36, 86, 39, 25, 31, 79, 88]
+#   g.data :Julie, [22, 29, 35, 38, 36, 40, 46, 57]
+#   g.write("net.png")
+#
 class Gruff::Net < Gruff::Base
-  # Hide parts of the graph to fit more datapoints, or for a different appearance.
-  attr_accessor :hide_dots
+  # Hide parts of the graph to fit more data points, or for a different appearance.
+  attr_writer :hide_dots
 
   # Dimensions of lines and dots; calculated based on dataset size if left unspecified.
-  attr_accessor :line_width
-  attr_accessor :dot_radius
+  attr_writer :line_width
+  attr_writer :dot_radius
 
   def initialize_ivars
     super
 
     @hide_dots = false
+    @line_width = nil
+    @dot_radius = nil
     @hide_line_numbers = true
     @sorted_drawing = true
   end
@@ -25,9 +46,6 @@ class Gruff::Net < Gruff::Base
 
     return unless data_given?
 
-    stroke_width = line_width  || clip_value_if_greater_than(@columns / (store.norm_data.first.points.size * 4), 5.0)
-    circle_radius = dot_radius || clip_value_if_greater_than(@columns / (store.norm_data.first.points.size * 2.5), 5.0)
-
     store.norm_data.each do |data_row|
       data_row.points.each_with_index do |data_point, index|
         next if data_point.nil?
@@ -44,13 +62,14 @@ class Gruff::Net < Gruff::Base
         end_x = @center_x + Math.sin(next_rad_pos) * next_point_distance
         end_y = @center_y - Math.cos(next_rad_pos) * next_point_distance
 
-        Gruff::Renderer::Line.new(color: data_row.color, width: stroke_width).render(start_x, start_y, end_x, end_y)
+        Gruff::Renderer::Line.new(color: data_row.color, width: @stroke_width).render(start_x, start_y, end_x, end_y)
 
-        Gruff::Renderer::Circle.new(color: data_row.color, width: stroke_width).render(start_x, start_y, start_x - circle_radius, start_y) unless @hide_dots
+        unless @hide_dots
+          circle_renderer = Gruff::Renderer::Circle.new(color: data_row.color, width: @stroke_width)
+          circle_renderer.render(start_x, start_y, start_x - @circle_radius, start_y)
+        end
       end
     end
-
-    Gruff::Renderer.finish
   end
 
 private
@@ -59,8 +78,10 @@ private
     super
 
     @radius = @graph_height / 2.0
+    @circle_radius = @dot_radius || clip_value_if_greater_than(@columns / (store.norm_data.first.points.size * 2.5), 5.0)
+    @stroke_width  = @line_width || clip_value_if_greater_than(@columns / (store.norm_data.first.points.size * 4), 5.0)
     @center_x = @graph_left + (@graph_width / 2.0)
-    @center_y = @graph_top + (@graph_height / 2.0) - 10 # Move graph up a bit
+    @center_y = @graph_top + (@graph_height / 2.0) + 10
   end
 
   # the lines connecting in the center, with the first line vertical
@@ -74,20 +95,19 @@ private
       Gruff::Renderer::Line.new(color: @marker_color)
                            .render(@center_x, @center_y, @center_x + Math.sin(rad_pos) * @radius, @center_y - Math.cos(rad_pos) * @radius)
 
-      marker_label = labels[index] ? labels[index].to_s : '000'
-      draw_label(@center_x, @center_y, rad_pos * 360 / (2 * Math::PI), @radius, marker_label)
+      marker_label = @labels[index] ? @labels[index].to_s : '000'
+      draw_label(@center_x, @center_y, rad_pos * 360 / (2 * Math::PI), @radius + @circle_radius, marker_label)
     end
   end
 
   def draw_label(center_x, center_y, angle, radius, amount)
-    r_offset = 1.1
     x_offset = center_x # + 15 # The label points need to be tweaked slightly
     y_offset = center_y # + 0  # This one doesn't though
-    x = x_offset + (radius * r_offset * Math.sin(deg2rad(angle)))
-    y = y_offset - (radius * r_offset * Math.cos(deg2rad(angle)))
+    x = x_offset + (radius + LABEL_MARGIN) * Math.sin(deg2rad(angle))
+    y = y_offset - (radius + LABEL_MARGIN) * Math.cos(deg2rad(angle))
 
     # Draw label
     text_renderer = Gruff::Renderer::Text.new(amount, font: @font, size: 20, color: @marker_color, weight: Magick::BoldWeight)
-    text_renderer.render(0, 0, x, y, Magick::CenterGravity)
+    text_renderer.add_to_render_queue(0, 0, x, y, Magick::CenterGravity)
   end
 end

data/lib/gruff/patch/rmagick.rb

@@ -1,33 +1,31 @@
 # frozen_string_literal: true
 
+# @private
 module Magick
-  class Draw
-    # Additional method to scale annotation text since Draw.scale doesn't.
-    def annotate_scaled(img, width, height, x, y, text, scale)
-      scaled_width = (width * scale) >= 1 ? (width * scale) : 1
-      scaled_height = (height * scale) >= 1 ? (height * scale) : 1
+  # @private
+  module GruffAnnotate
+    refine Draw do
+      # Additional method to scale annotation text since Draw.scale doesn't.
+      def annotate_scaled(img, width, height, x, y, text, scale)
+        scaled_width = (width * scale) >= 1 ? (width * scale) : 1
+        scaled_height = (height * scale) >= 1 ? (height * scale) : 1
 
-      annotate(img,
-               scaled_width, scaled_height,
-               x * scale, y * scale,
-               text.gsub('%', '%%'))
-    end
-
-    remove_method :stroke_opacity
-    def stroke_opacity(_opacity)
-      raise '#stroke_opacity method has different behavior between RMagick and RMagick4J. Should not use this method.'
-    end
+        annotate(img,
+                 scaled_width, scaled_height,
+                 x * scale, y * scale,
+                 text.gsub('%', '%%'))
+      end
 
-    if defined? JRUBY_VERSION
-      # FIXME(uwe):  We should NOT need to implement this method.
-      #              Remove this method as soon as RMagick4J Issue #16 is fixed.
-      #              https://github.com/Serabe/RMagick4J/issues/16
-      def fill=(fill)
-        fill = { white: '#FFFFFF' }[fill.to_sym] || fill
-        @draw.fill = Magick4J.ColorDatabase.query_default(fill)
-        self
+      if defined? JRUBY_VERSION
+        # FIXME(uwe):  We should NOT need to implement this method.
+        #              Remove this method as soon as RMagick4J Issue #16 is fixed.
+        #              https://github.com/Serabe/RMagick4J/issues/16
+        def fill=(fill)
+          fill = { white: '#FFFFFF' }[fill.to_sym] || fill
+          @draw.fill = Magick4J.ColorDatabase.query_default(fill)
+          self
+        end
       end
-      # EMXIF
     end
   end
 end

data/lib/gruff/patch/string.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
-class String
-  #Taken from http://codesnippets.joyent.com/posts/show/330
-  def commify(delimiter = ',')
-    gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
+# @private
+module String::GruffCommify
+  THOUSAND_SEPARATOR = ','
+
+  refine String do
+    #Taken from http://codesnippets.joyent.com/posts/show/330
+    def commify(delimiter = THOUSAND_SEPARATOR)
+      gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
+    end
   end
 end

data/lib/gruff/photo_bar.rb

@@ -1,28 +1,26 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
 # EXPERIMENTAL!
 #
 # Doesn't work yet.
 #
 class Gruff::PhotoBar < Gruff::Base
-# TODO
-#
-# define base and cap in yml
-# allow for image directory to be located elsewhere
-# more exact measurements for bar heights (go all the way to the bottom of the graph)
-# option to tile images instead of use a single image
-# drop base label a few px lower so photo bar graphs can have a base dropping over the lower marker line
-#
+  # TODO
+  #
+  # define base and cap in yml
+  # allow for image directory to be located elsewhere
+  # more exact measurements for bar heights (go all the way to the bottom of the graph)
+  # option to tile images instead of use a single image
+  # drop base label a few px lower so photo bar graphs can have a base dropping over the lower marker line
+  #
 
   # The name of a pre-packaged photo-based theme.
   attr_reader :theme
 
-#   def initialize(target_width=800)
-#     super
-#     init_photo_bar_graphics()
-#   end
+  # def initialize(target_width=800)
+  #   super
+  #   init_photo_bar_graphics()
+  # end
 
   def draw
     super
@@ -70,8 +68,6 @@ class Gruff::PhotoBar < Gruff::Base
         draw_label(label_center, point_index)
       end
     end
-
-    Gruff::Renderer.finish
   end
 
   # Return the chosen theme or the default

data/lib/gruff/pie.rb

@@ -1,17 +1,16 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
-##
-# Here's how to make a Pie graph:
+#
+# Here's how to make a Gruff::Pie.
 #
 #   g = Gruff::Pie.new
 #   g.title = "Visual Pie Graph Test"
 #   g.data 'Fries', 20
 #   g.data 'Hamburgers', 50
-#   g.write("test/output/pie_keynote.png")
+#   g.write("pie_keynote.png")
+#
+# To control where the pie chart starts creating slices, use {#zero_degree=}.
 #
-# To control where the pie chart starts creating slices, use #zero_degree.
 class Gruff::Pie < Gruff::Base
   DEFAULT_TEXT_OFFSET_PERCENTAGE = 0.15
 
@@ -28,35 +27,28 @@ class Gruff::Pie < Gruff::Base
   attr_writer :text_offset_percentage
 
   ## Use values instead of percentages.
-  attr_accessor :show_values_as_labels
+  attr_writer :show_values_as_labels
+
+  def initialize_store
+    @store = Gruff::Store.new(Gruff::Store::CustomData)
+  end
+  private :initialize_store
 
   def initialize_ivars
     super
-
+    @zero_degree = 0.0
+    @hide_labels_less_than = 0.0
+    @text_offset_percentage = DEFAULT_TEXT_OFFSET_PERCENTAGE
     @show_values_as_labels = false
-
-    @store = Gruff::Store.new(Gruff::Store::CustomData)
   end
   private :initialize_ivars
 
-  def zero_degree
-    @zero_degree ||= 0.0
-  end
-
-  def hide_labels_less_than
-    @hide_labels_less_than ||= 0.0
-  end
-
-  def text_offset_percentage
-    @text_offset_percentage ||= DEFAULT_TEXT_OFFSET_PERCENTAGE
-  end
-
   def options
     {
-      zero_degree: zero_degree,
-      hide_labels_less_than: hide_labels_less_than,
-      text_offset_percentage: text_offset_percentage,
-      show_values_as_labels: show_values_as_labels
+      zero_degree: @zero_degree,
+      hide_labels_less_than: @hide_labels_less_than,
+      text_offset_percentage: @text_offset_percentage,
+      show_values_as_labels: @show_values_as_labels
     }
   end
 
@@ -75,8 +67,6 @@ class Gruff::Pie < Gruff::Base
         update_chart_degrees_with slice.degrees
       end
     end
-
-    Gruff::Renderer.finish
   end
 
 private
@@ -87,7 +77,7 @@ private
 
       slices.sort_by(&:value) if @sort
 
-      total = slices.map(&:value).inject(:+).to_f
+      total = slices.sum(&:value).to_f
       slices.each { |slice| slice.total = total }
     end
   end
@@ -109,7 +99,7 @@ private
   # Spatial Value-Related Methods
 
   def chart_degrees
-    @chart_degrees ||= zero_degree
+    @chart_degrees ||= @zero_degree
   end
 
   attr_reader :graph_height
@@ -145,17 +135,17 @@ private
   end
 
   def radius_offset
-    radius + (radius * text_offset_percentage) + distance_from_center
+    radius + (radius * @text_offset_percentage) + distance_from_center
   end
 
   def ellipse_factor
-    radius_offset * text_offset_percentage
+    radius_offset * @text_offset_percentage
   end
 
   # Label-Related Methods
 
   def process_label_for(slice)
-    if slice.percentage >= hide_labels_less_than
+    if slice.percentage >= @hide_labels_less_than
       x, y = label_coordinates_for slice
 
       draw_label(x, y, slice.label)
@@ -180,7 +170,7 @@ private
 
   def draw_label(x, y, value)
     text_renderer = Gruff::Renderer::Text.new(value, font: @font, size: @marker_font_size, color: @font_color, weight: Magick::BoldWeight)
-    text_renderer.render(0, 0, x, y, Magick::CenterGravity)
+    text_renderer.add_to_render_queue(0, 0, x, y, Magick::CenterGravity)
   end
 
   # Helper Classes