gruff 0.9.0 → 0.12.2

data/lib/gruff/side_stacked_bar.rb

@@ -1,52 +1,81 @@
 # frozen_string_literal: true
 
-require 'gruff/side_bar'
-require 'gruff/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)
 #
-# alun.eyre@googlemail.com
+# Here's how to set up a Gruff::SideStackedBar.
+#
+#   g = Gruff::SideStackedBar.new
+#   g.title = 'SideStackedBar Graph'
+#   g.labels = {
+#     0 => '5/6',
+#     1 => '5/15',
+#     2 => '5/24',
+#     3 => '5/30',
+#   }
+#   g.data :Art, [0, 5, 8, 15]
+#   g.data :Philosophy, [10, 3, 2, 8]
+#   g.data :Science, [2, 15, 8, 11]
+#   g.write('side_stacked_bar.png')
+#
 class Gruff::SideStackedBar < Gruff::SideBar
   include StackedMixin
   include BarValueLabelMixin
 
   # Spacing factor applied between bars.
-  attr_accessor :bar_spacing
+  attr_writer :bar_spacing
 
   # Number of pixels between bar segments.
-  attr_accessor :segment_spacing
+  attr_writer :segment_spacing
 
   # Set the number output format for labels using sprintf.
   # Default is +"%.2f"+.
-  attr_accessor :label_formatting
+  attr_writer :label_formatting
 
   # Output the values for the bars on a bar graph.
   # Default is +false+.
-  attr_accessor :show_labels_for_bar_values
+  attr_writer :show_labels_for_bar_values
+
+  # Prevent drawing of column labels left of a side stacked bar graph.  Default is +false+.
+  attr_writer :hide_labels
 
   def initialize_ivars
     super
+    @bar_spacing = 0.9
+    @segment_spacing = 2.0
     @label_formatting = nil
     @show_labels_for_bar_values = false
+    @hide_labels = false
   end
   private :initialize_ivars
 
   def draw
     @has_left_labels = true
-    get_maximum_by_stack
+    calculate_maximum_by_stack
     super
   end
 
+protected
+
+  def hide_labels?
+    @hide_labels
+  end
+
+  def hide_left_label_area?
+    hide_labels?
+  end
+
+  def hide_bottom_label_area?
+    @hide_line_markers
+  end
+
 private
 
   def draw_bars
     # Setup spacing.
     #
     # Columns sit stacked.
-    @bar_spacing ||= 0.9
-    @segment_spacing ||= 2.0
-
     bar_width = @graph_height / column_count.to_f
     height = Array.new(column_count, 0)
     length = Array.new(column_count, @graph_left)
@@ -55,7 +84,7 @@ private
 
     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 calcs from the stacked bar chart to get the difference between
+        ## 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 -
@@ -93,7 +122,5 @@ private
         draw_value_label(x, y, text, true)
       end
     end
-
-    Gruff::Renderer.finish
   end
 end

data/lib/gruff/spider.rb

@@ -1,16 +1,23 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
 # Experimental!!! See also the Net graph.
 #
-# Submitted by Kevin Clark http://glu.ttono.us/
+# Here's how to set up a Gruff::Spider.
+#
+#   g = Gruff::Spider.new(30)
+#   g.title = "Spider Graph"
+#   g.data :Strength, [10]
+#   g.data :Dexterity, [16]
+#   g.data :Constitution, [12]
+#   g.data :Intelligence, [12]
+#   g.data :Wisdom, [10]
+#   g.data 'Charisma', [16]
+#   g.write("spider.png")
+#
 class Gruff::Spider < Gruff::Base
   # Hide all text.
-  attr_reader :hide_text
-  attr_accessor :hide_axes
-  attr_reader :transparent_background
-  attr_accessor :rotation
+  attr_writer :hide_axes
+  attr_writer :rotation
 
   def transparent_background=(value)
     Gruff::Renderer.setup_transparent_background(@columns, @rows) if value
@@ -23,9 +30,16 @@ class Gruff::Spider < Gruff::Base
   def initialize(max_value, target_width = 800)
     super(target_width)
     @max_value = max_value
+  end
+
+  def initialize_ivars
+    super
     @hide_legend = true
+    @hide_axes = false
+    @hide_text = false
     @rotation = 0
   end
+  private :initialize_ivars
 
   def draw
     @hide_line_markers = true
@@ -44,12 +58,10 @@ class Gruff::Spider < Gruff::Base
     additive_angle = (2 * Math::PI) / store.length
 
     # Draw axes
-    draw_axes(center_x, center_y, radius, additive_angle) unless hide_axes
+    draw_axes(center_x, center_y, radius, additive_angle) unless @hide_axes
 
     # Draw polygon
     draw_polygon(center_x, center_y, additive_angle)
-
-    Gruff::Renderer.finish
   end
 
 private
@@ -66,14 +78,14 @@ private
     y = y_offset + ((radius + r_offset) * Math.sin(angle))
 
     # Draw label
-    text_renderer = Gruff::Renderer::Text.new(amount, font: @font, size: legend_font_size, color: @marker_color, weight: Magick::BoldWeight)
-    text_renderer.render(0, 0, x, y, Magick::CenterGravity)
+    text_renderer = Gruff::Renderer::Text.new(amount, font: @font, size: @legend_font_size, color: @marker_color, weight: Magick::BoldWeight)
+    text_renderer.add_to_render_queue(0, 0, x, y, Magick::CenterGravity)
   end
 
   def draw_axes(center_x, center_y, radius, additive_angle, line_color = nil)
-    return if hide_axes
+    return if @hide_axes
 
-    current_angle = rotation * Math::PI / 180.0
+    current_angle = @rotation * Math::PI / 180.0
 
     store.data.each do |data_row|
       x_offset = radius * Math.cos(current_angle)
@@ -82,7 +94,7 @@ private
       Gruff::Renderer::Line.new(color: line_color || data_row.color, width: 5.0)
                            .render(center_x, center_y, center_x + x_offset, center_y + y_offset)
 
-      draw_label(center_x, center_y, current_angle, radius, data_row.label.to_s) unless hide_text
+      draw_label(center_x, center_y, current_angle, radius, data_row.label.to_s) unless @hide_text
 
       current_angle += additive_angle
     end
@@ -90,7 +102,7 @@ private
 
   def draw_polygon(center_x, center_y, additive_angle, color = nil)
     points = []
-    current_angle = rotation * Math::PI / 180.0
+    current_angle = @rotation * Math::PI / 180.0
 
     store.data.each do |data_row|
       points << center_x + normalize_points(data_row.points.first) * Math.cos(current_angle)
@@ -102,6 +114,6 @@ private
   end
 
   def sums_for_spider
-    store.data.reduce(0.0) { |sum, data_row| sum + data_row.points.first }
+    store.data.sum { |data_row| data_row.points.first }
   end
 end

data/lib/gruff/stacked_area.rb

@@ -1,14 +1,27 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-require 'gruff/helper/stacked_mixin'
-
+#
+# Here's how to set up a Gruff::StackedArea.
+#
+#   g = Gruff::StackedArea.new
+#   g.title = 'StackedArea Graph'
+#   g.data :Jimmy, [25, 36, 86, 39, 25, 31, 79, 88]
+#   g.data :Charles, [80, 54, 67, 54, 68, 70, 90, 95]
+#   g.data :Julie, [22, 29, 35, 38, 36, 40, 46, 57]
+#   g.write('stacked_area.png')
+#
 class Gruff::StackedArea < Gruff::Base
   include StackedMixin
-  attr_accessor :last_series_goes_on_bottom
+  attr_writer :last_series_goes_on_bottom
+
+  def initialize_ivars
+    super
+    @last_series_goes_on_bottom = false
+  end
+  private :initialize_ivars
 
   def draw
-    get_maximum_by_stack
+    calculate_maximum_by_stack
     super
 
     return unless data_given?
@@ -18,7 +31,7 @@ class Gruff::StackedArea < Gruff::Base
     height = Array.new(column_count, 0)
 
     data_points = nil
-    iterator = last_series_goes_on_bottom ? :reverse_each : :each
+    iterator = @last_series_goes_on_bottom ? :reverse_each : :each
     store.norm_data.public_send(iterator) do |data_row|
       prev_data_points = data_points
       data_points = []
@@ -53,7 +66,5 @@ class Gruff::StackedArea < Gruff::Base
 
       Gruff::Renderer::Polygon.new(color: data_row.color).render(poly_points)
     end
-
-    Gruff::Renderer.finish
   end
 end

data/lib/gruff/stacked_bar.rb

@@ -1,46 +1,55 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-require 'gruff/helper/stacked_mixin'
-require 'gruff/helper/bar_value_label_mixin'
-
+#
+# Here's how to set up a Gruff::StackedBar.
+#
+#   g = Gruff::StackedBar.new
+#   g.title = 'StackedBar Graph'
+#   g.data :Art, [0, 5, 8, 15]
+#   g.data :Philosophy, [10, 3, 2, 8]
+#   g.data :Science, [2, 15, 8, 11]
+#   g.write('stacked_bar.png')
+#
 class Gruff::StackedBar < Gruff::Base
   include StackedMixin
   include BarValueLabelMixin
 
   # Spacing factor applied between bars.
-  attr_accessor :bar_spacing
+  attr_writer :bar_spacing
 
   # Number of pixels between bar segments.
-  attr_accessor :segment_spacing
+  attr_writer :segment_spacing
 
   # Set the number output format for labels using sprintf.
   # Default is +"%.2f"+.
-  attr_accessor :label_formatting
+  attr_writer :label_formatting
 
   # Output the values for the bars on a bar graph.
   # Default is +false+.
-  attr_accessor :show_labels_for_bar_values
+  attr_writer :show_labels_for_bar_values
+
+  # Prevent drawing of column labels below a stacked bar graph.  Default is +false+.
+  attr_writer :hide_labels
 
   def initialize_ivars
     super
+    @bar_spacing = 0.9
+    @segment_spacing = 2
     @label_formatting = nil
     @show_labels_for_bar_values = false
+    @hide_labels = false
   end
   private :initialize_ivars
 
   # Draws a bar graph, but multiple sets are stacked on top of each other.
   def draw
-    get_maximum_by_stack
+    calculate_maximum_by_stack
     super
     return unless data_given?
 
     # Setup spacing.
     #
     # Columns sit stacked.
-    @bar_spacing ||= 0.9
-    @segment_spacing ||= 2
-
     bar_width = @graph_width / column_count.to_f
     padding = (bar_width * (1 - @bar_spacing)) / 2
 
@@ -79,7 +88,19 @@ class Gruff::StackedBar < Gruff::Base
         draw_value_label(x, y, text, true)
       end
     end
+  end
+
+protected
+
+  def hide_labels?
+    @hide_labels
+  end
+
+  def hide_left_label_area?
+    @hide_line_markers
+  end
 
-    Gruff::Renderer.finish
+  def hide_bottom_label_area?
+    hide_labels?
   end
 end

data/lib/gruff/store/{base_data.rb → basic_data.rb}

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 module Gruff
-  # @private
   class Store
-    class BaseData < Struct.new(:label, :points, :color)
+    # @private
+    class BasicData < Struct.new(:label, :points, :color)
       def initialize(label, points, color)
-        self.label = label
-        self.points = Array(points)
-        self.color = color
+        super(label.to_s, Array(points), color)
+      end
+
+      def empty?
+        points.empty?
       end
 
       def columns
@@ -22,9 +24,9 @@ module Gruff
         points.compact.max
       end
 
-      def normalize(args = {})
+      def normalize(minimum:, spread:)
         norm_points = points.map do |point|
-          point.nil? ? nil : (point.to_f - args[:minimum].to_f) / args[:spread]
+          point.nil? ? nil : (point.to_f - minimum.to_f) / spread
         end
 
         self.class.new(label, norm_points, color)

data/lib/gruff/store/custom_data.rb

@@ -2,12 +2,14 @@
 
 module Gruff
   class Store
+    # @private
     class CustomData < Struct.new(:label, :points, :color, :custom)
       def initialize(label, points, color, custom = nil)
-        self.label = label
-        self.points = Array(points)
-        self.color = color
-        self.custom = custom
+        super(label.to_s, Array(points), color, custom)
+      end
+
+      def empty?
+        points.empty?
       end
 
       def columns
@@ -22,9 +24,9 @@ module Gruff
         points.compact.max
       end
 
-      def normalize(args = {})
+      def normalize(minimum:, spread:)
         norm_points = points.map do |point|
-          point.nil? ? nil : (point.to_f - args[:minimum].to_f) / args[:spread]
+          point.nil? ? nil : (point.to_f - minimum.to_f) / spread
         end
 
         self.class.new(label, norm_points, color, custom)

data/lib/gruff/store/store.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Gruff
+  # @private
   class Store
     attr_reader :data, :norm_data
 
@@ -15,10 +16,10 @@ module Gruff
       @data << @data_class.new(*args)
     end
 
-    def normalize(args = {})
+    def normalize(**keywords)
       unless @normalized
         @data.each do |data_row|
-          @norm_data << data_row.normalize(args)
+          @norm_data << data_row.normalize(**keywords)
         end
 
         @normalized = true
@@ -26,7 +27,7 @@ module Gruff
     end
 
     def empty?
-      @data.empty?
+      @data.all?(&:empty?)
     end
 
     def length
@@ -56,18 +57,18 @@ module Gruff
     end
 
     def sort_data!
-      @data = @data.sort_by { |a| -a.points.reduce(0) { |acc, elem| acc + elem.to_f } }
+      @data = @data.sort_by { |a| -a.points.sum(&:to_f) }
     end
 
     def sort_norm_data!
-      @norm_data = @norm_data.sort_by { |a| -a.points.reduce(0) { |acc, elem| acc + elem.to_f } }
+      @norm_data = @norm_data.sort_by { |a| -a.points.sum(&:to_f) }
     end
 
     def reverse!
       @data.reverse!
     end
 
-    def set_colors!(colors)
+    def change_colors(colors)
       index = 0
       @data.each do |data_row|
         data_row.color ||= begin