gruff 0.6.0 → 0.11.0

data/lib/gruff/patch/rmagick.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+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
+
+      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
+
+    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
+      # EMXIF
+    end
+  end
+end

data/lib/gruff/patch/string.rb

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

data/lib/gruff/photo_bar.rb

@@ -1,36 +1,37 @@
-require File.dirname(__FILE__) + '/base'
+# 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
-    return unless @has_data
+    return unless data_given?
 
-    return # TODO Remove for further development
+    return # TODO: Remove for further development
+
+    init_photo_bar_graphics
 
-    init_photo_bar_graphics()
-    
     #Draw#define_clip_path()
     #Draw#clip_path(pathname)
     #Draw#composite....with bar graph image OverCompositeOp
@@ -38,44 +39,41 @@ class Gruff::PhotoBar < Gruff::Base
     # See also
     #
     # Draw.pattern # define an image to tile as the filling of a draw object
-    # 
+    #
 
     # Setup spacing.
     #
     # Columns sit side-by-side.
     spacing_factor = 0.9
-    @bar_width = @norm_data[0][DATA_COLOR_INDEX].columns
+    bar_width = store.norm_data[0].color.columns
 
-    @norm_data.each_with_index do |data_row, row_index|
-  
-      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|
         data_point = 0 if data_point.nil?
         # Use incremented x and scaled y
-        left_x = @graph_left + (@bar_width * (row_index + point_index + ((@data.length - 1) * point_index)))
+        left_x = @graph_left + (bar_width * (row_index + point_index + ((store.length - 1) * point_index)))
         left_y = @graph_top + (@graph_height - data_point * @graph_height) + 1
-        right_x = left_x + @bar_width * spacing_factor
+        right_x = left_x + bar_width * spacing_factor
         right_y = @graph_top + @graph_height - 1
-      
-        bar_image_width = data_row[DATA_COLOR_INDEX].columns
+
+        bar_image_width = data_row.color.columns
         bar_image_height = right_y.to_f - left_y.to_f
-      
+
         # Crop to scale for data
-        bar_image = data_row[DATA_COLOR_INDEX].crop(0, 0, bar_image_width, bar_image_height)
-        
-        @d.gravity = NorthWestGravity
-        @d = @d.composite(left_x, left_y, bar_image_width, bar_image_height, bar_image)
-      
+        bar_image = data_row.color.crop(0, 0, bar_image_width, bar_image_height)
+
+        @d.gravity = Magick::NorthWestGravity
+        @d.composite(left_x, left_y, bar_image_width, bar_image_height, bar_image)
+
         # Calculate center based on bar_width and current row
-        label_center = @graph_left + (@data.length * @bar_width * point_index) + (@data.length * @bar_width / 2.0)
+        label_center = @graph_left + (store.length * bar_width * point_index) + (store.length * bar_width / 2.0)
         draw_label(label_center, point_index)
       end
-
     end
 
-    @d.draw(@base_image)    
+    Gruff::Renderer.finish
   end
 
-
   # Return the chosen theme or the default
   def theme
     @theme || 'plastik'
@@ -85,16 +83,15 @@ protected
 
   # Sets up colors with a list of images that will be used.
   # Images should be 340px tall
-  def init_photo_bar_graphics    
-    color_list = Array.new
+  def init_photo_bar_graphics
+    color_list = []
     theme_dir = File.dirname(__FILE__) + '/../../assets/' + theme
 
     Dir.open(theme_dir).each do |file|
       next unless /\.png$/.match(file)
-      color_list << Image.read("#{theme_dir}/#{file}").first
+
+      color_list << Magick::Image.read("#{theme_dir}/#{file}").first
     end
     @colors = color_list
   end
-
 end
-

data/lib/gruff/pie.rb

@@ -1,31 +1,40 @@
-require File.dirname(__FILE__) + '/base'
+# frozen_string_literal: true
 
-##
-# Here's how to make a Pie graph:
+require 'gruff/base'
+
+#
+# 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
 
   # Can be used to make the pie start cutting slices at the top (-90.0)
-  # or at another angle. Default is 0.0, which starts at 3 o'clock.
-  attr_accessor :zero_degree
+  # or at another angle. Default is +0.0+, which starts at 3 o'clock.
+  attr_writer :zero_degree
+
   # Do not show labels for slices that are less than this percent. Use 0 to always show all labels.
-  # Defaults to 0
-  attr_accessor :hide_labels_less_than
-  # Affect the distance between the percentages and the pie chart
-  # Defaults to 0.15
-  attr_accessor :text_offset_percentage
-  ## Use values instead of percentages
-  attr_accessor :show_values_as_labels
+  # Defaults to +0+.
+  attr_writer :hide_labels_less_than
+
+  # Affect the distance between the percentages and the pie chart.
+  # Defaults to +0.15+.
+  attr_writer :text_offset_percentage
+
+  ## Use values instead of percentages.
+  attr_writer :show_values_as_labels
+
+  def initialize_store
+    @store = Gruff::Store.new(Gruff::Store::CustomData)
+  end
+  private :initialize_store
 
   def initialize_ivars
     super
@@ -34,90 +43,172 @@ class Gruff::Pie < Gruff::Base
     @text_offset_percentage = DEFAULT_TEXT_OFFSET_PERCENTAGE
     @show_values_as_labels = false
   end
+  private :initialize_ivars
+
+  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
+    }
+  end
 
   def draw
-    @hide_line_markers = true
-    
+    hide_line_markers
+
     super
 
-    return unless @has_data
-
-    diameter = @graph_height
-    radius = ([@graph_width, @graph_height].min / 2.0) * 0.8
-    center_x = @graph_left + (@graph_width / 2.0)
-    center_y = @graph_top + (@graph_height / 2.0) - 10 # Move graph up a bit
-    total_sum = sums_for_pie()
-    prev_degrees = @zero_degree
-
-    # Use full data since we can easily calculate percentages
-    data = (@sort ? @data.sort{ |a, b| a[DATA_VALUES_INDEX].first <=> b[DATA_VALUES_INDEX].first } : @data)
-    data.each do |data_row|
-      if data_row[DATA_VALUES_INDEX].first > 0
-        @d = @d.stroke data_row[DATA_COLOR_INDEX]
-        @d = @d.fill 'transparent'
-        @d.stroke_width(radius) # stroke width should be equal to radius. we'll draw centered on (radius / 2)
-
-        current_degrees = (data_row[DATA_VALUES_INDEX].first / total_sum) * 360.0 
-
-        # ellipse will draw the the stroke centered on the first two parameters offset by the second two.
-        # therefore, in order to draw a circle of the proper diameter we must center the stroke at
-        # half the radius for both x and y
-        @d = @d.ellipse(center_x, center_y, 
-                  radius / 2.0, radius / 2.0,
-                  prev_degrees, prev_degrees + current_degrees + 0.5) # <= +0.5 'fudge factor' gets rid of the ugly gaps
-                  
-        half_angle = prev_degrees + ((prev_degrees + current_degrees) - prev_degrees) / 2
-        
-        label_val = ((data_row[DATA_VALUES_INDEX].first / total_sum) * 100.0).round
-        unless label_val < @hide_labels_less_than
-          # RMagick must use sprintf with the string and % has special significance.
-          label_string = @show_values_as_labels ? data_row[DATA_VALUES_INDEX].first.to_s : label_val.to_s + '%'
-          @d = draw_label(center_x,center_y, half_angle,
-                          radius + (radius * @text_offset_percentage),
-                          label_string)
-        end
-
-        prev_degrees += current_degrees
+    return unless data_given?
+
+    slices.each do |slice|
+      if slice.value > 0
+        Gruff::Renderer::Ellipse.new(color: slice.color, width: radius)
+                                .render(center_x, center_y, radius / 2.0, radius / 2.0, chart_degrees, chart_degrees + slice.degrees + 0.5)
+        process_label_for slice
+        update_chart_degrees_with slice.degrees
       end
     end
 
-    # TODO debug a circle where the text is drawn...
-    
-    @d.draw(@base_image)
+    Gruff::Renderer.finish
   end
 
 private
 
-  ##
-  # Labels are drawn around a slightly wider ellipse to give room for 
-  # labels on the left and right.
-  def draw_label(center_x, center_y, angle, radius, amount)
-    # TODO Don't use so many hard-coded numbers
-    r_offset = 20.0      # The distance out from the center of the pie to get point
-    x_offset = center_x  # + 15.0 # The label points need to be tweaked slightly
-    y_offset = center_y  # This one doesn't though
-    radius_offset = (radius + r_offset)
-    ellipse_factor = radius_offset * @text_offset_percentage
-    x = x_offset + ((radius_offset + ellipse_factor) * Math.cos(deg2rad(angle)))
-    y = y_offset + (radius_offset * Math.sin(deg2rad(angle)))
-    
-    # Draw label
-    @d.fill = @font_color
-    @d.font = @font if @font
-    @d.pointsize = scale_fontsize(@marker_font_size)
-    @d.stroke = 'transparent'
-    @d.font_weight = BoldWeight
-    @d.gravity = CenterGravity
-    @d.annotate_scaled( @base_image, 
-                      0, 0,
-                      x, y, 
-                      amount, @scale)
-  end
-
-  def sums_for_pie
-    total_sum = 0.0
-    @data.collect {|data_row| total_sum += data_row[DATA_VALUES_INDEX].first }
-    total_sum
+  def slices
+    @slices ||= begin
+      slices = store.data.map { |data| slice_class.new(data, options) }
+
+      slices.sort_by(&:value) if @sort
+
+      total = slices.map(&:value).inject(:+).to_f
+      slices.each { |slice| slice.total = total }
+    end
+  end
+
+  # General Helper Methods
+
+  def hide_line_markers
+    @hide_line_markers = true
+  end
+
+  def update_chart_degrees_with(degrees)
+    @chart_degrees = chart_degrees + degrees
+  end
+
+  def slice_class
+    PieSlice
+  end
+
+  # Spatial Value-Related Methods
+
+  def chart_degrees
+    @chart_degrees ||= @zero_degree
+  end
+
+  attr_reader :graph_height
+
+  attr_reader :graph_width
+
+  def diameter
+    graph_height
+  end
+
+  def half_width
+    graph_width / 2.0
+  end
+
+  def half_height
+    graph_height / 2.0
+  end
+
+  def radius
+    @radius ||= ([graph_width, graph_height].min / 2.0) * 0.8
+  end
+
+  def center_x
+    @center_x ||= @graph_left + half_width
+  end
+
+  def center_y
+    @center_y ||= @graph_top + half_height - 10
+  end
+
+  def distance_from_center
+    20.0
+  end
+
+  def radius_offset
+    radius + (radius * @text_offset_percentage) + distance_from_center
+  end
+
+  def ellipse_factor
+    radius_offset * @text_offset_percentage
+  end
+
+  # Label-Related Methods
+
+  def process_label_for(slice)
+    if slice.percentage >= @hide_labels_less_than
+      x, y = label_coordinates_for slice
+
+      draw_label(x, y, slice.label)
+    end
+  end
+
+  def label_coordinates_for(slice)
+    angle = chart_degrees + slice.degrees / 2
+
+    [x_label_coordinate(angle), y_label_coordinate(angle)]
   end
 
+  def x_label_coordinate(angle)
+    center_x + ((radius_offset + ellipse_factor) * Math.cos(deg2rad(angle)))
+  end
+
+  def y_label_coordinate(angle)
+    center_y + (radius_offset * Math.sin(deg2rad(angle)))
+  end
+
+  # Drawing-Related Methods
+
+  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.add_to_render_queue(0, 0, x, y, Magick::CenterGravity)
+  end
+
+  # Helper Classes
+  #
+  # @private
+  class PieSlice < Struct.new(:data_array, :options)
+    attr_accessor :total
+
+    def name
+      data_array[0]
+    end
+
+    def value
+      data_array[1].first
+    end
+
+    def color
+      data_array[2]
+    end
+
+    def size
+      @size ||= value / total
+    end
+
+    def percentage
+      @percentage ||= (size * 100.0).round
+    end
+
+    def degrees
+      @degrees ||= size * 360.0
+    end
+
+    def label
+      options[:show_values_as_labels] ? value.to_s : "#{percentage}%"
+    end
+  end
 end