gruff 0.9.0 → 0.12.2

data/lib/gruff/bezier.rb

@@ -1,7 +1,23 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
+#
+# Gruff::Bezier is a special line graph that have
+# the bezier curve.
+#
+# Here's how to set up a Gruff::Bezier.
+#
+#   dataset = [
+#     +0.00, +0.09, +0.19, +0.29, +0.38, +0.47, +0.56, +0.64, +0.71, +0.78,
+#     +0.84, +0.89, +0.93, +0.96, +0.98, +0.99, +0.99, +0.99, +0.97, +0.94,
+#     +0.90, +0.86, +0.80, +0.74, +0.67, +0.59, +0.51, +0.42, +0.33, +0.23,
+#     +0.14, +0.04, -0.06, -0.16, -0.26, -0.36, -0.45, -0.53, -0.62, -0.69,
+#     -0.76, -0.82, -0.88, -0.92, -0.96, -0.98, -1.00, -1.00, -1.00, -0.99,
+#     -0.96, -0.93, -0.89, -0.84, -0.78, -0.71, -0.64, -0.56, -0.47, -0.38,
+#   ]
+#   g = Gruff::Bezier.new
+#   g.data 'sin', dataset
+#   g.write('bezier.png')
+#
 class Gruff::Bezier < Gruff::Base
   def draw
     super
@@ -37,7 +53,5 @@ class Gruff::Bezier < Gruff::Base
         Gruff::Renderer::Bezier.new(color: data_row.color, width: stroke_width).render(poly_points)
       end
     end
-
-    Gruff::Renderer.finish
   end
 end

data/lib/gruff/bullet.rb

@@ -1,15 +1,22 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-require 'gruff/themes'
-
+#
+# A bullet graph is a variation of a bar graph.
 # http://en.wikipedia.org/wiki/Bullet_graph
+#
+# Here's how to set up a Gruff::Bullet.
+#
+#   g = Gruff::Bullet.new
+#   g.title = 'Monthly Revenue'
+#   g.data 75, 100, { target: 80, low: 50, high: 90 }
+#   g.write('bullet.png')
+#
 class Gruff::Bullet < Gruff::Base
   def initialize(target_width = '400x40')
+    super
+
     if target_width.is_a?(String)
-      geometric_width, geometric_height = target_width.split('x')
-      @columns = geometric_width.to_f
-      @rows = geometric_height.to_f
+      @columns, @rows = target_width.split('x').map(&:to_f)
     else
       @columns = target_width.to_f
       @rows = target_width.to_f / 5.0
@@ -17,12 +24,15 @@ class Gruff::Bullet < Gruff::Base
     @columns.freeze
     @rows.freeze
 
-    initialize_ivars
-
-    reset_themes
     self.theme = Gruff::Themes::GREYSCALE
+  end
+
+  def initialize_ivars
+    super
+
     @title_font_size = 20
   end
+  private :initialize_ivars
 
   def data(value, maximum_value, options = {})
     @value = value.to_f
@@ -45,7 +55,7 @@ class Gruff::Bullet < Gruff::Base
     margin       = 30.0
     thickness    = @raw_rows / 6.0
     right_margin = margin
-    graph_left   = (@title && (title_width * 1.3)) || margin
+    graph_left   = [title_width * 1.3, margin].max
     graph_width  = @raw_columns - graph_left - right_margin
     graph_height = thickness * 3.0
 
@@ -73,18 +83,16 @@ class Gruff::Bullet < Gruff::Base
     # Value
     rect_renderer = Gruff::Renderer::Rectangle.new(color: @font_color)
     rect_renderer.render(graph_left, thickness, graph_left + graph_width * (@value / maximum_value), thickness * 2)
-
-    Gruff::Renderer.finish
   end
 
 private
 
   def draw_title
-    return unless @title
+    return if hide_title?
 
     font_height = calculate_caps_height(scale_fontsize(@title_font_size))
 
     text_renderer = Gruff::Renderer::Text.new(@title, font: @font, size: @title_font_size, color: @font_color)
-    text_renderer.render(1.0, 1.0, font_height / 2, font_height / 2, Magick::NorthWestGravity)
+    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

@@ -1,9 +1,18 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
-# Graph with dots and labels along a vertical access
+#
+# Graph with dots and labels along a vertical access.
 # see: 'Creating More Effective Graphs' by Robbins
+#
+# Here's how to set up a Gruff::Dot.
+#
+#   g = Gruff::Dot.new
+#   g.title = 'Dot Graph'
+#   g.data :Art, [0, 5, 8, 15]
+#   g.data :Philosophy, [10, 3, 2, 8]
+#   g.data :Science, [2, 15, 8, 11]
+#   g.write('dot.png')
+#
 class Gruff::Dot < Gruff::Base
   def draw
     @has_left_labels = true
@@ -33,8 +42,6 @@ class Gruff::Dot < Gruff::Base
         draw_label(y_pos, point_index)
       end
     end
-
-    Gruff::Renderer.finish
   end
 
 protected
@@ -43,37 +50,17 @@ protected
   def draw_line_markers
     return if @hide_line_markers
 
-    # Draw horizontal line markers and annotate with numbers
-    if @y_axis_increment
-      increment = @y_axis_increment
-      number_of_lines = (@spread / @y_axis_increment).to_i
-    else
-      # Try to use a number of horizontal lines that will come out even.
-      #
-      # TODO Do the same for larger numbers...100, 75, 50, 25
-      if @marker_count.nil?
-        (3..7).each do |lines|
-          if @spread % lines == 0.0
-            @marker_count = lines
-            break
-          end
-        end
-        @marker_count ||= 5
-      end
-      # TODO: Round maximum marker value to a round number like 100, 0.1, 0.5, etc.
-      increment = (@spread > 0 && @marker_count > 0) ? significant(@spread / @marker_count) : 1
-      number_of_lines = @marker_count
-    end
-
-    (0..number_of_lines).each do |index|
-      marker_label = minimum_value + index * increment
+    (0..marker_count).each do |index|
+      marker_label = minimum_value + index * @increment
       x = @graph_left + (marker_label - minimum_value) * @graph_width / @spread
-      Gruff::Renderer::Line.new(color: @marker_color).render(x, @graph_bottom, x, @graph_bottom + 0.5 * LABEL_MARGIN)
+
+      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 = label(marker_label, @increment)
         text_renderer = Gruff::Renderer::Text.new(label, font: @font, size: @marker_font_size, color: @font_color)
-        text_renderer.render(0, 0, x, @graph_bottom + (LABEL_MARGIN * 2.0), Magick::CenterGravity)
+        text_renderer.add_to_render_queue(0, 0, x, @graph_bottom + (LABEL_MARGIN * 1.5), Magick::CenterGravity)
       end
     end
   end
@@ -84,7 +71,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.render(1, 1, -@graph_left + LABEL_MARGIN * 2.0, y_offset, Magick::EastGravity)
+      text_renderer.add_to_render_queue(@graph_left - LABEL_MARGIN, 1.0, 0.0, y_offset, Magick::EastGravity)
     end
   end
 end

data/lib/gruff/helper/bar_conversion.rb

@@ -3,7 +3,7 @@
 ##
 # Original Author: David Stokar
 #
-#   This class perfoms the y coordinats conversion for the bar class.
+#   This class performs the y coordinates conversion for the bar class.
 #
 #   There are three cases:
 #
@@ -24,16 +24,16 @@ class Gruff::BarConversion
     result = []
 
     case @mode
-    when 1 then # Case one
-                # minimum value >= 0 ( only positive values )
+    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
-    when 2 then # Case two
-                # only negative values
+    when 2
+      # only negative values
       result[0] = @graph_top + 1
       result[1] = @graph_top + @graph_height * (1 - data_point) - 1
-    when 3 then # Case three
-                # positive and negative values
+    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

data/lib/gruff/helper/bar_value_label_mixin.rb

@@ -2,6 +2,9 @@
 
 # @private
 module Gruff::Base::BarValueLabelMixin
+  using String::GruffCommify
+
+  # @private
   class BarValueLabel
     attr_accessor :coordinates, :values
 

data/lib/gruff/helper/stacked_mixin.rb

@@ -5,7 +5,7 @@ module Gruff::Base::StackedMixin
   # Used by StackedBar and child classes.
   #
   # tsal: moved from Base 03 FEB 2007
-  def get_maximum_by_stack
+  def calculate_maximum_by_stack
     # Get sum of each stack
     max_hash = {}
     store.data.each do |data_set|

data/lib/gruff/histogram.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'histogram'
+
+#
+# Here's how to set up a Gruff::Histogram.
+#
+#   g = Gruff::Histogram.new
+#   g.title = 'Histogram Graph'
+#   g.minimum_bin = 10
+#   g.bin_width = 20
+#   g.data :A, [10, 10, 20, 30, 40, 40, 40, 40, 40, 40, 50, 10, 10, 10]
+#   g.data :B, [100, 100, 100, 100, 90, 90, 80, 30, 30, 30, 30, 30]
+#   g.write('histogram.png')
+#
+class Gruff::Histogram < Gruff::Bar
+  # Specifies interpolation between the min and max of the set. Default is +10+.
+  attr_writer :bin_width
+
+  # Specifies minimum value for bin.
+  attr_writer :minimum_bin
+
+  # Specifies maximum value for bin.
+  attr_writer :maximum_bin
+
+  def initialize(*)
+    super
+    @data = []
+  end
+
+  def initialize_ivars
+    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
+
+  def draw
+    @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|
+        @labels[index] = bin
+      end
+      store.add(name, freqs, color)
+    end
+
+    super
+  end
+
+  # @private
+  class HistogramArray < Array
+    include ::Histogram
+  end
+end

data/lib/gruff/line.rb

@@ -1,41 +1,41 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
-# Here's how to make a Line graph:
+#
+# Here's how to make a Gruff::Line.
 #
 #   g = Gruff::Line.new
 #   g.title = "A Line Graph"
 #   g.data 'Fries', [20, 23, 19, 8]
 #   g.data 'Hamburgers', [50, 19, 99, 29]
-#   g.write("test/output/line.png")
+#   g.write("line.png")
 #
 # There are also other options described below, such as {#baseline_value}, {#baseline_color},
-# {#hide_dots}, and {#hide_lines}.
+# {#hide_dots=}, and {#hide_lines=}.
+#
 class Gruff::Line < Gruff::Base
   # Allow for reference lines ( which are like baseline ... just allowing for more & on both axes ).
   attr_accessor :reference_lines
-  attr_accessor :reference_line_default_color
-  attr_accessor :reference_line_default_width
+  attr_writer :reference_line_default_color
+  attr_writer :reference_line_default_width
 
   # Allow for vertical marker lines.
-  attr_accessor :show_vertical_markers
+  attr_writer :show_vertical_markers
 
   # 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
 
   # default is +'circle'+, other options include square.
-  attr_accessor :dot_style
+  attr_writer :dot_style
 
-  # Hide parts of the graph to fit more datapoints, or for a different appearance.
-  attr_accessor :hide_dots, :hide_lines
+  # Hide parts of the graph to fit more data points, or for a different appearance.
+  attr_writer :hide_dots, :hide_lines
 
   # accessors for support of xy data.
-  attr_accessor :minimum_x_value
+  attr_writer :minimum_x_value
 
   # accessors for support of xy data.
-  attr_accessor :maximum_x_value
+  attr_writer :maximum_x_value
 
   # Get the value if somebody has defined it.
   def baseline_value
@@ -67,7 +67,7 @@ class Gruff::Line < Gruff::Base
   #   g = Gruff::Line.new(400, false) # 400px wide, no lines (for backwards compatibility)
   #   g = Gruff::Line.new(false) # Defaults to 800px wide, no lines (for backwards compatibility)
   #
-  # The preferred way is to call {#hide_dots} or {#hide_lines} instead.
+  # The preferred way is to call {#hide_dots=} or {#hide_lines=} instead.
   def initialize(*args)
     raise ArgumentError, 'Wrong number of arguments' if args.length > 2
 
@@ -76,7 +76,15 @@ class Gruff::Line < Gruff::Base
     else
       super args.shift
     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
@@ -85,12 +93,13 @@ class Gruff::Line < Gruff::Base
     @maximum_x_value = nil
     @minimum_x_value = nil
 
+    @line_width = nil
+    @dot_radius = nil
     @dot_style = 'circle'
 
     @show_vertical_markers = false
-
-    @store = Gruff::Store.new(Gruff::Store::XYData)
   end
+  private :initialize_ivars
 
   # This method allows one to plot a dataset with both X and Y data.
   #
@@ -123,7 +132,7 @@ class Gruff::Line < Gruff::Base
   #   g.data("Capples", [1, 1, 2, 2, 3, 3])
   #
   #   # labels will be drawn at the x locations of the keys passed in.
-  #   In this example the lables are drawn at x positions 2, 4, and 6:
+  #   In this example the labels are drawn at x positions 2, 4, and 6:
   #   g.labels = {0 => '2003', 2 => '2004', 4 => '2005', 6 => '2006'}
   #   # The 0 => '2003' label will be ignored since it is outside the chart range.
   def dataxy(name, x_data_points = [], y_data_points = [], color = nil)
@@ -144,11 +153,9 @@ class Gruff::Line < Gruff::Base
   end
 
   def draw_reference_line(reference_line, left, right, top, bottom)
-    config = {
-      color: reference_line[:color] || @reference_line_default_color,
-      width: reference_line[:width] || @reference_line_default_width
-    }
-    Gruff::Renderer::DashLine.new(config).render(left, top, right, 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)
   end
 
   def draw_horizontal_reference_line(reference_line)
@@ -210,8 +217,8 @@ class Gruff::Line < Gruff::Base
         new_y = @graph_top + (@graph_height - y_data * @graph_height)
 
         # Reset each time to avoid thin-line errors
-        stroke_width  = line_width || clip_value_if_greater_than(@columns / (store.norm_data.first.y_points.size * 4), 5.0)
-        circle_radius = dot_radius || clip_value_if_greater_than(@columns / (store.norm_data.first.y_points.size * 2.5), 5.0)
+        stroke_width  = @line_width || clip_value_if_greater_than(@columns / (store.norm_data.first.y_points.size * 4), 5.0)
+        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)
@@ -226,8 +233,6 @@ class Gruff::Line < Gruff::Base
         prev_y = new_y
       end
     end
-
-    Gruff::Renderer.finish
   end
 
 private