gruff 0.5.1 → 0.10.0

data/lib/gruff/scene.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
 
-require "observer"
-require File.dirname(__FILE__) + '/base'
+require 'observer'
+require 'gruff/base'
 
-##
 # A scene is a non-linear graph that assembles layers together to tell a story.
-# Layers are folders with appropriately named files (see below). You can group 
+# Layers are folders with appropriately named files (see below). You can group
 # layers and control them together or just set their values individually.
 #
 # Examples:
@@ -12,8 +12,6 @@ require File.dirname(__FILE__) + '/base'
 # * A city scene that changes with the time of day and the weather conditions.
 # * A traffic map that shows red lines on streets that are crowded and green on free-flowing ones.
 #
-# Usage:
-# 
 #  g = Gruff::Scene.new("500x100", "path/to/city_scene_directory")
 #
 #  # Define order of layers, back to front
@@ -31,34 +29,31 @@ require File.dirname(__FILE__) + '/base'
 #  # Write the final graph to disk
 #  g.write "hazy_daytime_city_scene.png"
 #
-#
 # There are several rules that will magically select a layer when possible.
 #
 # * Numbered files will be selected according to the closest value that is less than the input value.
-# * 'true.png' and 'false.png' will be used as booleans.
+# * +'true.png'+ and +'false.png'+ will be used as booleans.
 # * Other named files will be used if the input matches the filename (without the filetype extension).
-# * If there is a file named 'default.png', it will be used unless other input values are set for the corresponding layer.
-
+# * If there is a file named +'default.png'+, it will be used unless other input values are set for the corresponding layer.
 class Gruff::Scene < Gruff::Base
-    
-  # An array listing the foldernames that will be rendered, from back to front.
-  #
-  #  g.layers = %w(sky clouds buildings street people)
+  # An array listing the folder names that will be rendered, from back to front.
   #
+  # @example
+  #   g.layers = %w(sky clouds buildings street people)
   attr_reader :layers
 
   def initialize(target_width, base_dir)
     @base_dir = base_dir
     @groups = {}
-    @layers = []    
+    @layers = []
     super target_width
   end
 
   def draw
     # Join all the custom paths and filter out the empty ones
-    image_paths = @layers.map { |layer| layer.path }.select { |path| !path.empty? }
+    image_paths = @layers.map(&:path).reject(&:empty?)
     images = Magick::ImageList.new(*image_paths)
-    @base_image = images.flatten_images
+    Gruff::Renderer.background_image = images.flatten_images
   end
 
   def layers=(ordered_list)
@@ -78,10 +73,10 @@ class Gruff::Scene < Gruff::Base
   def method_missing(method_name, *args)
     case method_name.to_s
     when /^(\w+)_group=$/
-      add_group $1, *args
+      add_group Regexp.last_match(1), *args
       return
     when /^(\w+)=$/
-      set_input $1, args.first
+      set_input Regexp.last_match(1), args.first
       return
     end
     super
@@ -94,20 +89,16 @@ private
   end
 
   def set_input(input_name, input_value)
-    if not @groups[input_name].nil?
+    if !@groups[input_name].nil?
       @groups[input_name].send_updates(input_value)
-    else
-      if chosen_layer = @layers.detect { |layer| layer.name == input_name }
-        chosen_layer.update input_value
-      end
+    elsif chosen_layer = @layers.find { |layer| layer.name == input_name }
+      chosen_layer.update input_value
     end
   end
-  
 end
 
-
+# @private
 class Gruff::Group
-
   include Observable
   attr_reader :name
 
@@ -117,31 +108,29 @@ class Gruff::Group
       layer.observe self
     end
   end
-  
+
   def send_updates(value)
     changed
     notify_observers value
   end
-  
 end
 
-
+# @private
 class Gruff::Layer
-  
   attr_reader :name
-  
+
   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
     @selected_filename = select_default
   end
-  
+
   # Register this layer so it receives updates from the group
   def observe(obj)
     obj.add_observer self
   end
-  
+
   # Choose the appropriate filename for this layer, based on the input
   def update(value)
     @selected_filename =  case value.to_s
@@ -152,7 +141,7 @@ class Gruff::Layer
                           when /^-?(\d+\.)?\d+$/
                             select_numeric value
                           when /(\d\d):(\d\d):\d\d/
-                            select_time "#{$1}#{$2}"
+                            select_time "#{Regexp.last_match(1)}#{Regexp.last_match(2)}"
                           else
                             select_default
                           end
@@ -165,6 +154,7 @@ class Gruff::Layer
     unless @selected_filename.nil? || @selected_filename.empty?
       return File.join(@base_dir, @name, @selected_filename)
     end
+
     ''
   end
 
@@ -179,7 +169,7 @@ private
   def select_numeric(value)
     file_exists_or_blank value.to_s.gsub('-', '_')
   end
-  
+
   def select_time(value)
     times = @filenames.map { |filename| filename.gsub('.png', '') }
     times.each_with_index do |time, index|
@@ -187,16 +177,17 @@ private
         return "#{times[index - 1]}.png"
       end
     end
-    return "#{times.last}.png"
+
+    "#{times.last}.png"
   end
-  
+
   # Match "partly cloudy" to "partly_cloudy.png"
   def select_string(value)
     file_exists_or_blank value.to_s.gsub(' ', '_')
   end
-  
+
   def select_default
-    @filenames.include?("default.png") ? "default.png" : ''
+    @filenames.include?('default.png') ? 'default.png' : ''
   end
 
   # Returns the string "#{filename}.png", if it exists.
@@ -205,5 +196,4 @@ private
   def file_exists_or_blank(filename)
     @filenames.include?("#{filename}.png") ? "#{filename}.png" : select_default
   end
-  
 end

data/lib/gruff/side_bar.rb

@@ -1,44 +1,78 @@
-require File.dirname(__FILE__) + '/base'
+# frozen_string_literal: true
 
-##
-# Graph with individual horizontal bars instead of vertical bars.
+require 'gruff/base'
 
+# Graph with individual horizontal bars instead of vertical bars.
+#
+# Here's how to set up a Gruff::SideBar.
+#
+#   g = Gruff::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('sidebar.png')
+#
 class Gruff::SideBar < Gruff::Base
-
-  # Spacing factor applied between bars
+  # Spacing factor applied between bars.
   attr_accessor :bar_spacing
 
+  # Spacing factor applied between a group of bars belonging to the same label.
+  attr_accessor :group_spacing
+
+  # Set the number output format for labels using sprintf.
+  # Default is +"%.2f"+.
+  attr_accessor :label_formatting
+
+  # Output the values for the bars on a bar graph.
+  # Default is +false+.
+  attr_accessor :show_labels_for_bar_values
+
+  def initialize_ivars
+    super
+    @label_formatting = nil
+    @show_labels_for_bar_values = false
+  end
+  private :initialize_ivars
+
   def draw
     @has_left_labels = true
     super
 
-    return unless @has_data
+    return unless data_given?
+
     draw_bars
   end
 
-  protected
+private
 
   def draw_bars
     # Setup spacing.
     #
     @bar_spacing ||= 0.9
+    @group_spacing ||= 10
 
-    @bars_width = @graph_height / @column_count.to_f
-    @bar_width = @bars_width / @norm_data.size
-    @d = @d.stroke_opacity 0.0
-    height = Array.new(@column_count, 0)
-    length = Array.new(@column_count, @graph_left)
-    padding = (@bar_width * (1 - @bar_spacing)) / 2
+    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 self.is_a?(Gruff::SideStackedBar)
-
-    @norm_data.each_with_index do |data_row, row_index|
-      @d = @d.fill data_row[DATA_COLOR_INDEX]
+    return if is_a?(Gruff::SideStackedBar)
 
-      data_row[DATA_VALUES_INDEX].each_with_index do |data_point, point_index|
+    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 calcs from the stacked bar chart
         # to get the difference between
@@ -48,91 +82,71 @@ class Gruff::SideBar < Gruff::Base
         difference = temp2 - temp1
 
         left_x = length[point_index] - 1
-        left_y = @graph_top + (@bars_width * point_index) + (@bar_width * row_index) + padding
+        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
+        right_y = left_y + bar_width * @bar_spacing
 
         height[point_index] += (data_point * @graph_width)
 
-        @d = @d.rectangle(left_x, left_y, right_x, right_y)
+        rect_renderer = Gruff::Renderer::Rectangle.new(color: data_row.color)
+        rect_renderer.render(left_x, left_y, right_x, right_y)
 
         # Calculate center based on bar_width and current row
 
         if @use_data_label
-          label_center = @graph_top + (@bar_width * (row_index+point_index) + @bar_width / 2)
-          draw_label(label_center, row_index, @norm_data[row_index][DATA_LABEL_INDEX])
+          label_center = left_y + bar_width / 2
+          draw_label(label_center, row_index, store.norm_data[row_index].label)
         else
-          label_center = @graph_top + (@bars_width * point_index + @bars_width / 2)
+          label_center = left_y + bars_width / 2
           draw_label(label_center, point_index)
         end
         if @show_labels_for_bar_values
-          val = (@label_formatting || '%.2f') % @norm_data[row_index][3][point_index]
-          draw_value_label(right_x+40, (@graph_top + (((row_index+point_index+1) * @bar_width) - (@bar_width / 2)))-12, val.commify, true)
+          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)
         end
       end
-
     end
 
-    @d.draw(@base_image)
+    Gruff::Renderer.finish
   end
 
   # Instead of base class version, draws vertical background lines and label
   def draw_line_markers
-
     return if @hide_line_markers
 
-    @d = @d.stroke_antialias false
-
     # Draw horizontal line markers and annotate with numbers
-    @d = @d.stroke(@marker_color)
-    @d = @d.stroke_width 1
     number_of_lines = @marker_count || 5
     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.
+    # TODO: Round maximum marker value to a round number like 100, 0.1, 0.5, etc.
     increment = significant(@spread.to_f / 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
-      @d = @d.line(x, @graph_bottom, x, @graph_top)
+      Gruff::Renderer::Line.new(color: @marker_color).render(x, @graph_bottom, x, @graph_top)
       diff = index - number_of_lines
-      marker_label = diff.abs * increment + @minimum_value
+      marker_label = diff.abs * increment + minimum_value
 
       unless @hide_line_numbers
-        @d.fill = @font_color
-        @d.font = @font if @font
-        @d.stroke = 'transparent'
-        @d.pointsize = scale_fontsize(@marker_font_size)
-        @d.gravity = CenterGravity
-        # TODO Center text over line
-        @d = @d.annotate_scaled(@base_image,
-                                0, 0, # Width of box to draw text in
-                                x, @graph_bottom + (LABEL_MARGIN * 2.0), # Coordinates of text
-                                marker_label.to_s, @scale)
-      end # unless
-      @d = @d.stroke_antialias true
+        text_renderer = Gruff::Renderer::Text.new(marker_label, font: @font, size: @marker_font_size, color: @font_color)
+        text_renderer.render(0, 0, x, @graph_bottom + (LABEL_MARGIN * 2.0), Magick::CenterGravity)
+      end
     end
   end
 
   ##
   # Draw on the Y axis instead of the X
 
-  def draw_label(y_offset, index, label=nil)
-    if !@labels[index].nil? && @labels_seen[index].nil?
-      lbl = (@use_data_label) ? label : @labels[index]
-      @d.fill = @font_color
-      @d.font = @font if @font
-      @d.stroke = 'transparent'
-      @d.font_weight = NormalWeight
-      @d.pointsize = scale_fontsize(@marker_font_size)
-      @d.gravity = EastGravity
-      @d = @d.annotate_scaled(@base_image,
-                              1, 1,
-                              -@graph_left + LABEL_MARGIN * 2.0, y_offset,
-                              lbl, @scale)
-      @labels_seen[index] = 1
+  def draw_label(y_offset, index, label = nil)
+    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.render(@graph_left - LABEL_MARGIN * 2, 1.0, 0.0, y_offset, Magick::EastGravity)
     end
   end
 
+  def calculate_spacing
+    @scale * @group_spacing * (column_count - 1)
+  end
 end

data/lib/gruff/side_stacked_bar.rb

@@ -1,97 +1,114 @@
-require File.dirname(__FILE__) + '/base'
-require File.dirname(__FILE__) + '/side_bar'
-require File.dirname(__FILE__) + '/stacked_mixin'
+# frozen_string_literal: true
 
-##
-# New gruff graph type added to enable sideways stacking bar charts 
+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
+  # Spacing factor applied between bars.
   attr_accessor :bar_spacing
-  
+
+  # Number of pixels between bar segments.
+  attr_accessor :segment_spacing
+
+  # Set the number output format for labels using sprintf.
+  # Default is +"%.2f"+.
+  attr_accessor :label_formatting
+
+  # Output the values for the bars on a bar graph.
+  # Default is +false+.
+  attr_accessor :show_labels_for_bar_values
+
+  def initialize_ivars
+    super
+    @label_formatting = nil
+    @show_labels_for_bar_values = false
+  end
+  private :initialize_ivars
+
   def draw
     @has_left_labels = true
-    get_maximum_by_stack
+    calculate_maximum_by_stack
     super
   end
 
-  protected
+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
-    @d = @d.stroke_opacity 0.0
-    height = Array.new(@column_count, 0)
-    length = Array.new(@column_count, @graph_left)
-    padding = (@bar_width * (1 - @bar_spacing)) / 2
-    if @show_labels_for_bar_values
-      label_values = Array.new
-      0.upto(@column_count-1) {|i| label_values[i] = {:value => 0, :right_x => 0}}
-    end
-    @norm_data.each_with_index do |data_row, row_index|
-      data_row[DATA_VALUES_INDEX].each_with_index do |data_point, point_index|
-
-    	  ## using the original calcs 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
-
-    	  @d = @d.fill data_row[DATA_COLOR_INDEX]
-
-        left_x = length[point_index] #+ 1
-              left_y = @graph_top + (@bar_width * point_index) + padding
-    	  right_x = left_x + difference
-              right_y = left_y + @bar_width * @bar_spacing
-    	  length[point_index] += difference
+    bar_width = @graph_height / column_count.to_f
+    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)
+
+    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
+        ## 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
+
+        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)
-        
-        if @show_labels_for_bar_values
-          label_values[point_index][:value] += @norm_data[row_index][3][point_index]
-          label_values[point_index][:right_x] = right_x
-        end
-                
+
+        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]
+
         # 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
-          @d = @d.rectangle(left_x, left_y, right_x, right_y)
+          rect_renderer = Gruff::Renderer::Rectangle.new(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 = @graph_top + (@bar_width * point_index) + (@bar_width * @bar_spacing / 2.0)
+        label_center = left_y + bar_width / 2
         draw_label(label_center, point_index)
       end
-
     end
+
     if @show_labels_for_bar_values
-      label_values.each_with_index do |data, i|
-        val = (@label_formatting || "%.2f") % data[:value]
-        draw_value_label(data[:right_x]+40, (@graph_top + (((i+1) * @bar_width) - (@bar_width / 2)))-12, val.commify, true)
+      bar_value_label.prepare_sidebar_rendering(@label_formatting) do |x, y, text|
+        draw_value_label(x, y, text, true)
       end
     end
-    
-    @d.draw(@base_image)    
-  end
 
-  def larger_than_max?(data_point, index=0)
-    max(data_point, index) > @maximum_value
+    Gruff::Renderer.finish
   end
-
-  def max(data_point, index)
-    @data.inject(0) {|sum, item| sum + item[DATA_VALUES_INDEX][index]}
-  end
-
 end