gruff 0.8.0 → 0.9.0

data/lib/gruff/renderer/text.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Gruff
+  class Renderer::Text
+    def initialize(text, args = {})
+      @text = text.to_s
+      @font = args[:font]
+      @font_size = args[:size]
+      @font_color = args[:color]
+      @font_weight = args[:weight] || Magick::NormalWeight
+      @rotation = args[:rotation]
+    end
+
+    def render(width, height, x, y, gravity = Magick::NorthGravity)
+      draw  = Renderer.instance.draw
+      image = Renderer.instance.image
+      scale = Renderer.instance.scale
+
+      draw.rotation = @rotation if @rotation
+      draw.fill = @font_color
+      draw.stroke = 'transparent'
+      draw.font = @font if @font
+      draw.font_weight = @font_weight
+      draw.pointsize = @font_size * scale
+      draw.gravity = gravity
+      draw.annotate_scaled(image,
+                           width, height,
+                           x, y,
+                           @text, scale)
+      draw.rotation = -@rotation if @rotation
+    end
+
+    def self.metrics(text, size, font_weight = Magick::NormalWeight)
+      draw  = Renderer.instance.draw
+      image = Renderer.instance.image
+
+      draw.font_weight = font_weight
+      draw.pointsize = size
+      draw.get_type_metrics(image, text.to_s)
+    end
+  end
+end

data/lib/gruff/scatter.rb

@@ -1,15 +1,15 @@
-require File.dirname(__FILE__) + '/base'
+# frozen_string_literal: true
+
+require 'gruff/base'
 
 # Here's how to set up an XY Scatter Chart
 #
-# g = Gruff::Scatter.new(800)
-# g.data(:apples, [1,2,3,4], [4,3,2,1])
-# g.data('oranges', [5,7,8], [4,1,7])
-# g.write('test/output/scatter.png')
-#
+#   g = Gruff::Scatter.new(800)
+#   g.data(:apples, [1,2,3,4], [4,3,2,1])
+#   g.data('oranges', [5,7,8], [4,1,7])
+#   g.write('test/output/scatter.png')
 #
 class Gruff::Scatter < Gruff::Base
-
   # Maximum X Value. The value will get overwritten by the max in the
   # datasets.
   attr_accessor :maximum_x_value
@@ -18,47 +18,29 @@ class Gruff::Scatter < Gruff::Base
   # datasets.
   attr_accessor :minimum_x_value
 
-  # The number of vertical lines shown for reference
+  # The number of vertical lines shown for reference.
   attr_accessor :marker_x_count
 
-  #~ # Draw a dashed horizontal line at the given y value
-  #~ attr_accessor :baseline_y_value
-
-  #~ # Color of the horizontal baseline
-  #~ attr_accessor :baseline_y_color
-
-  #~ # Draw a dashed horizontal line at the given y value
-  #~ attr_accessor :baseline_x_value
-
-  #~ # Color of the horizontal baseline
-  #~ attr_accessor :baseline_x_color
-
-  # Attributes to allow customising the size of the points
+  # Attributes to allow customising the size of the points.
   attr_accessor :circle_radius
   attr_accessor :stroke_width
 
-  # Allow disabling the significant rounding when labeling the X axis
-  # This is useful when working with a small range of high values (for example, a date range of months, while seconds as units)
+  # Allow disabling the significant rounding when labeling the X axis.
+  # This is useful when working with a small range of high values (for example, a date range of months, while seconds as units).
   attr_accessor :disable_significant_rounding_x_axis
 
-  # Allow enabling vertical lines. When you have a lot of data, they can work great
+  # Allow enabling vertical lines. When you have a lot of data, they can work great.
   attr_accessor :enable_vertical_line_markers
 
-  # Allow using vertical labels in the X axis (and setting the label margin)
+  # Allow using vertical labels in the X axis (and setting the label margin).
   attr_accessor :x_label_margin
   attr_accessor :use_vertical_x_labels
 
-  # Allow passing lambdas to format labels
+  # Allow passing lambdas to format labels.
   attr_accessor :y_axis_label_format
   attr_accessor :x_axis_label_format
 
-  # Gruff::Scatter takes the same parameters as the Gruff::Line graph
-  #
-  # ==== Example
-  #
-  # g = Gruff::Scatter.new
-  #
-  def initialize(*)
+  def initialize_ivars
     super
 
     @baseline_x_color = @baseline_y_color = 'red'
@@ -73,61 +55,33 @@ class Gruff::Scatter < Gruff::Base
     @x_axis_label_format = nil
     @x_label_margin = nil
     @y_axis_label_format = nil
-  end
 
-  def setup_drawing
-    # TODO Need to get x-axis labels working. Current behavior will be to not allow.
-    @labels = {}
-
-    super
-
-    # Translate our values so that we can use the base methods for drawing
-    # the standard chart stuff
-    @column_count = @x_spread
+    @store = Gruff::Store.new(Gruff::Store::XYData)
   end
+  private :initialize_ivars
 
   def draw
     super
-    return unless @has_data
+    return unless data_given?
 
     # Check to see if more than one datapoint was given. NaN can result otherwise.
-    @x_increment = (@column_count > 1) ? (@graph_width / (@column_count - 1).to_f) : @graph_width
+    @x_increment = (@x_spread > 1) ? (@graph_width / (@x_spread - 1).to_f) : @graph_width
 
-    #~ if (defined?(@norm_y_baseline)) then
-      #~ level = @graph_top + (@graph_height - @norm_baseline * @graph_height)
-      #~ @d = @d.push
-      #~ @d.stroke_color @baseline_color
-      #~ @d.fill_opacity 0.0
-      #~ @d.stroke_dasharray(10, 20)
-      #~ @d.stroke_width 5
-      #~ @d.line(@graph_left, level, @graph_left + @graph_width, level)
-      #~ @d = @d.pop
-    #~ end
-
-    #~ if (defined?(@norm_x_baseline)) then
-
-    #~ end
-
-    @norm_data.each do |data_row|
-      data_row[DATA_VALUES_INDEX].each_with_index do |data_point, index|
-        x_value = data_row[DATA_VALUES_X_INDEX][index]
-        next if data_point.nil? || x_value.nil?
+    store.norm_data.each do |data_row|
+      data_row.coordinates.each do |x_value, y_value|
+        next if y_value.nil? || x_value.nil?
 
         new_x = get_x_coord(x_value, @graph_width, @graph_left)
-        new_y = @graph_top + (@graph_height - data_point * @graph_height)
+        new_y = @graph_top + (@graph_height - y_value * @graph_height)
 
         # Reset each time to avoid thin-line errors
-        @d = @d.stroke data_row[DATA_COLOR_INDEX]
-        @d = @d.fill data_row[DATA_COLOR_INDEX]
-        @d = @d.stroke_opacity 1.0
-        @d = @d.stroke_width @stroke_width || clip_value_if_greater_than(@columns / (@norm_data.first[1].size * 4), 5.0)
-
-        circle_radius = @circle_radius || clip_value_if_greater_than(@columns / (@norm_data.first[1].size * 2.5), 5.0)
-        @d = @d.circle(new_x, new_y, new_x - circle_radius, new_y)
+        stroke_width  = @stroke_width  || clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 4), 5.0)
+        circle_radius = @circle_radius || clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 2.5), 5.0)
+        Gruff::Renderer::Circle.new(color: data_row.color, width: stroke_width).render(new_x, new_y, new_x - circle_radius, new_y)
       end
     end
 
-    @d.draw(@base_image)
+    Gruff::Renderer.finish
   end
 
   # The first parameter is the name of the dataset.  The next two are the
@@ -140,57 +94,63 @@ class Gruff::Scatter < Gruff::Base
   # If the color argument is nil, the next color from the default theme will
   # be used.
   #
-  # NOTE: If you want to use a preset theme, you must set it before calling
-  # data().
+  # @note If you want to use a preset theme, you must set it before calling {#data}.
+  #
+  # @param name [String, Symbol] containing the name of the dataset.
+  # @param x_data_points [Array] An Array of of x-axis data points.
+  # @param y_data_points [Array] An Array of of y-axis data points.
+  # @param color [String] The hex string for the color of the dataset. Defaults to nil.
   #
-  # ==== Parameters
-  # name:: String or Symbol containing the name of the dataset.
-  # x_data_points:: An Array of of x-axis data points.
-  # y_data_points:: An Array of of y-axis data points.
-  # color:: The hex string for the color of the dataset.  Defaults to nil.
   #
-  # ==== Exceptions
-  # Data points contain nil values::
+  # @raise [ArgumentError] Data points contain nil values.
   #   This error will get raised if either the x or y axis data points array
-  #   contains a <tt>nil</tt> value.  The graph will not make an assumption
-  #   as how to graph <tt>nil</tt>
-  # x_data_points is empty::
+  #   contains a +nil+ value.  The graph will not make an assumption
+  #   as how to graph +nil+.
+  # @raise [ArgumentError] +x_data_points+ is empty.
   #   This error is raised when the array for the x-axis points are empty
-  # y_data_points is empty::
-  #   This error is raised when the array for the y-axis points are empty
-  # x_data_points.length != y_data_points.length::
-  #   Error means that the x and y axis point arrays do not match in length
+  # @raise [ArgumentError] +y_data_points+ is empty.
+  #   This error is raised when the array for the y-axis points are empty.
+  # @raise [ArgumentError] +x_data_points.length != y_data_points.length+.
+  #   Error means that the x and y axis point arrays do not match in length.
   #
-  # ==== Examples
-  # g = Gruff::Scatter.new
-  # g.data(:apples, [1,2,3], [3,2,1])
-  # g.data('oranges', [1,1,1], [2,3,4])
-  # g.data('bitter_melon', [3,5,6], [6,7,8], '#000000')
+  # @example
+  #   g = Gruff::Scatter.new
+  #   g.data(:apples, [1,2,3], [3,2,1])
+  #   g.data('oranges', [1,1,1], [2,3,4])
+  #   g.data('bitter_melon', [3,5,6], [6,7,8], '#000000')
   #
   def data(name, x_data_points = [], y_data_points = [], color = nil)
+    # make sure it's an array
+    x_data_points = Array(x_data_points)
+    y_data_points = Array(y_data_points)
+
     raise ArgumentError, 'Data Points contain nil Value!' if x_data_points.include?(nil) || y_data_points.include?(nil)
     raise ArgumentError, 'x_data_points is empty!' if x_data_points.empty?
     raise ArgumentError, 'y_data_points is empty!' if y_data_points.empty?
     raise ArgumentError, 'x_data_points.length != y_data_points.length!' if x_data_points.length != y_data_points.length
 
-    # Call the existing data routine for the y axis data
-    super(name, y_data_points, color)
+    # Call the existing data routine for the x/y axis data
+    store.add(name, y_data_points, color, x_data_points)
+  end
 
-    #append the x data to the last entry that was just added in the @data member
-    last_elem = @data.length() - 1
-    @data[last_elem] << x_data_points
+  alias dataxy data
 
-    if @maximum_x_value.nil? && @minimum_x_value.nil?
-      @maximum_x_value = @minimum_x_value = x_data_points.first
-    end
+private
+
+  def setup_data
+    # Update the global min/max values for the x data
+    @maximum_x_value ||= store.max_x
+    @minimum_x_value ||= store.min_x
 
-    @maximum_x_value = x_data_points.max > @maximum_x_value ?
-                        x_data_points.max : @maximum_x_value
-    @minimum_x_value = x_data_points.min < @minimum_x_value ?
-                        x_data_points.min : @minimum_x_value
+    super
   end
 
-protected
+  def setup_drawing
+    # TODO: Need to get x-axis labels working. Current behavior will be to not allow.
+    @labels = {}
+
+    super
+  end
 
   def calculate_spread #:nodoc:
     super
@@ -198,25 +158,10 @@ protected
     @x_spread = @x_spread > 0 ? @x_spread : 1
   end
 
-  def normalize(force = nil)
-    if @norm_data.nil? || force
-      @norm_data = []
-      return unless @has_data
+  def normalize
+    return unless data_given?
 
-      @data.each do |data_row|
-        norm_data_points = [data_row[DATA_LABEL_INDEX]]
-        norm_data_points << data_row[DATA_VALUES_INDEX].map do |r|
-          (r.to_f - @minimum_value.to_f) / @spread
-        end
-        norm_data_points << data_row[DATA_COLOR_INDEX]
-        norm_data_points << data_row[DATA_VALUES_X_INDEX].map do |r|
-          (r.to_f - @minimum_x_value.to_f) / @x_spread
-        end
-        @norm_data << norm_data_points
-      end
-    end
-    #~ @norm_y_baseline = (@baseline_y_value.to_f / @maximum_value.to_f) if @baseline_y_value
-    #~ @norm_x_baseline = (@baseline_x_value.to_f / @maximum_x_value.to_f) if @baseline_x_value
+    store.normalize(minimum_x: @minimum_x_value, spread_x: @x_spread, minimum_y: minimum_value, spread_y: @spread)
   end
 
   def draw_line_markers
@@ -224,10 +169,8 @@ protected
     super
     return if @hide_line_markers
 
-    @d = @d.stroke_antialias false
-
     if @x_axis_increment.nil?
-      # TODO Do the same for larger numbers...100, 75, 50, 25
+      # TODO: Do the same for larger numbers...100, 75, 50, 25
       if @marker_x_count.nil?
         (3..7).each do |lines|
           if @x_spread % lines == 0.0
@@ -242,47 +185,36 @@ protected
         @x_increment = significant(@x_increment)
       end
     else
-      # TODO Make this work for negative values
-      @maximum_x_value = [@maximum_value.ceil, @x_axis_increment].max
+      # TODO: Make this work for negative values
+      @maximum_x_value = [maximum_value.ceil, @x_axis_increment].max
       @minimum_x_value = @minimum_x_value.floor
       calculate_spread
-      normalize(true)
+      normalize
 
       @marker_count = (@x_spread / @x_axis_increment).to_i
       @x_increment = @x_axis_increment
     end
-    @increment_x_scaled = @graph_width.to_f / (@x_spread / @x_increment)
+    increment_x_scaled = @graph_width.to_f / (@x_spread / @x_increment)
 
     # Draw vertical line markers and annotate with numbers
     (0..@marker_x_count).each do |index|
-      # TODO Fix the vertical lines, and enable them by default. Not pretty when they don't match up with top y-axis line
+      # TODO: Fix the vertical lines, and enable them by default. Not pretty when they don't match up with top y-axis line
       if @enable_vertical_line_markers
-        x = @graph_left + @graph_width - index.to_f * @increment_x_scaled
-        @d = @d.stroke(@marker_color)
-        @d = @d.stroke_width 1
-        @d = @d.line(x, @graph_top, x, @graph_bottom)
+        x = @graph_left + @graph_width - index.to_f * increment_x_scaled
+        Gruff::Renderer::Line.new(color: @marker_color).render(x, @graph_top, x, @graph_bottom)
       end
 
       unless @hide_line_numbers
         marker_label = index * @x_increment + @minimum_x_value.to_f
         y_offset = @graph_bottom + (@x_label_margin || LABEL_MARGIN)
-        x_offset = get_x_coord(index.to_f, @increment_x_scaled, @graph_left)
-
-        @d.fill = @font_color
-        @d.font = @font if @font
-        @d.stroke('transparent')
-        @d.pointsize = scale_fontsize(@marker_font_size)
-        @d.gravity = NorthGravity
-        @d.rotation = -90.0 if @use_vertical_x_labels
-        @d = @d.annotate_scaled(@base_image,
-                                1.0, 1.0,
-                                x_offset, y_offset,
-                                vertical_label(marker_label, @x_increment), @scale)
-        @d.rotation = 90.0 if @use_vertical_x_labels
+        x_offset = get_x_coord(index.to_f, increment_x_scaled, @graph_left)
+
+        label = vertical_label(marker_label, @x_increment)
+        rotation = -90.0 if @use_vertical_x_labels
+        text_renderer = Gruff::Renderer::Text.new(label, font: @font, size: @marker_font_size, color: @font_color, rotation: rotation)
+        text_renderer.render(1.0, 1.0, x_offset, y_offset)
       end
     end
-
-    @d = @d.stroke_antialias true
   end
 
   def label(value, increment)
@@ -301,10 +233,7 @@ protected
     end
   end
 
-private
-
   def get_x_coord(x_data_point, width, offset) #:nodoc:
     x_data_point * width + offset
   end
-
-end # end Gruff::Scatter
+end

data/lib/gruff/scene.rb

@@ -1,7 +1,8 @@
-require "observer"
-require File.dirname(__FILE__) + '/base'
+# frozen_string_literal: true
+
+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 and control them together or just set their values individually.
@@ -11,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
@@ -30,20 +29,17 @@ 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)
@@ -55,9 +51,9 @@ class Gruff::Scene < Gruff::Base
 
   def draw
     # Join all the custom paths and filter out the empty ones
-    image_paths = @layers.map { |layer| layer.path }.reject { |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)
@@ -77,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
@@ -93,19 +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
 
@@ -120,11 +113,10 @@ class Gruff::Group
     changed
     notify_observers value
   end
-
 end
 
+# @private
 class Gruff::Layer
-
   attr_reader :name
 
   def initialize(base_dir, folder_name)
@@ -149,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
@@ -185,7 +177,8 @@ private
         return "#{times[index - 1]}.png"
       end
     end
-    return "#{times.last}.png"
+
+    "#{times.last}.png"
   end
 
   # Match "partly cloudy" to "partly_cloudy.png"
@@ -194,7 +187,7 @@ private
   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.
@@ -203,5 +196,4 @@ private
   def file_exists_or_blank(filename)
     @filenames.include?("#{filename}.png") ? "#{filename}.png" : select_default
   end
-
 end