gruff 0.15.0 → 0.16.0

data/lib/gruff/stacked_bar.rb

@@ -39,6 +39,7 @@ private
     @label_formatting = nil
     @show_labels_for_bar_values = false
     @hide_labels = false
+    @minimum_value = 0.0
   end
 
   def setup_data
@@ -46,47 +47,68 @@ private
     super
   end
 
+  def setup_graph_measurements
+    super
+    return if @hide_line_markers
+
+    if @show_labels_for_bar_values
+      proc_text_metrics = ->(text) { text_metrics(@marker_font, text) }
+
+      if maximum_value >= 0
+        _, metrics = Gruff::BarValueLabel.metrics(maximum_value, @label_formatting, proc_text_metrics)
+        @graph_top += metrics.height
+      end
+
+      @graph_height = @graph_bottom - @graph_top
+    end
+  end
+
   # Draws a bar graph, but multiple sets are stacked on top of each other.
   def draw_graph
     # Setup spacing.
     #
     # Columns sit stacked.
-    bar_width = @graph_width / column_count.to_f
+    bar_width = @graph_width / column_count
     padding = (bar_width * (1 - @bar_spacing)) / 2
 
     height = Array.new(column_count, 0)
-    stack_bar_value_label = Gruff::BarValueLabel::StackedBar.new
+    length = Array.new(column_count, @graph_bottom)
+    stack_bar_value_labels = Gruff::BarValueLabel::StackedBar.new
 
     store.norm_data.each_with_index do |data_row, row_index|
       data_row.points.each_with_index do |data_point, point_index|
-        next if data_point == 0
+        temp1 = @graph_top + (@graph_height - (data_point * @graph_height) - height[point_index])
+        temp2 = @graph_top + @graph_height - height[point_index]
+        difference = temp2 - temp1
+        difference = 0 if difference < 0
 
         # Use incremented x and scaled y
         left_x = @graph_left + (bar_width * point_index) + padding
-        left_y = @graph_top + (@graph_height -
-                               data_point * @graph_height -
-                               height[point_index]) + @segment_spacing
-        right_x = left_x + bar_width * @bar_spacing
-        right_y = @graph_top + @graph_height - height[point_index]
+        left_y = length[point_index] - difference
+        right_x = left_x + (bar_width * @bar_spacing)
+        right_y = length[point_index]
+        right_y -= @segment_spacing if row_index != store.columns - 1
 
         # update the total height of the current stacked bar
+        length[point_index] -= difference
         height[point_index] += (data_point * @graph_height)
 
         rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: data_row.color)
         rect_renderer.render(left_x, left_y, right_x, right_y)
 
         # Calculate center based on bar_width and current row
-        label_center = left_x + bar_width * @bar_spacing / 2.0
+        label_center = left_x + (bar_width * @bar_spacing / 2.0)
         draw_label(label_center, point_index)
 
         bar_value_label = Gruff::BarValueLabel::Bar.new([left_x, left_y, right_x, right_y], store.data[row_index].points[point_index])
-        stack_bar_value_label.add(bar_value_label, point_index)
+        stack_bar_value_labels.add(bar_value_label, point_index)
       end
     end
 
     if @show_labels_for_bar_values
-      stack_bar_value_label.prepare_rendering(@label_formatting, bar_width) do |x, y, text|
-        draw_value_label(x, y, text)
+      proc_text_metrics = ->(text) { text_metrics(@marker_font, text) }
+      stack_bar_value_labels.prepare_rendering(@label_formatting, proc_text_metrics) do |x, y, text, _text_width, text_height|
+        draw_value_label(bar_width * @bar_spacing, text_height, x, y, text)
       end
     end
   end
@@ -96,10 +118,10 @@ private
   end
 
   def hide_left_label_area?
-    @hide_line_markers
+    @hide_line_markers && @y_axis_label.nil?
   end
 
   def hide_bottom_label_area?
-    hide_labels?
+    hide_labels? && @x_axis_label.nil? && @legend_at_bottom == false
   end
 end

data/lib/gruff/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gruff
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/lib/gruff.rb

@@ -2,13 +2,13 @@
 
 require 'rmagick'
 
-require 'gruff/patch/rmagick'
-require 'gruff/patch/string'
-require 'gruff/renderer/renderer'
-require 'gruff/store/store'
-require 'gruff/font'
-require 'gruff/base'
-require 'gruff/version'
+require_relative 'gruff/patch/rmagick'
+require_relative 'gruff/patch/string'
+require_relative 'gruff/renderer/renderer'
+require_relative 'gruff/store/store'
+require_relative 'gruff/font'
+require_relative 'gruff/base'
+require_relative 'gruff/version'
 
 ##
 # = Gruff. Graphs.
@@ -29,14 +29,15 @@ module Gruff
   autoload :Area, Gruff.libpath('area')
   autoload :Bar, Gruff.libpath('bar')
   autoload :Bezier, Gruff.libpath('bezier')
+  autoload :BoxPlot, Gruff.libpath('box_plot')
   autoload :Bullet, Gruff.libpath('bullet')
+  autoload :Candlestick, Gruff.libpath('candlestick')
   autoload :Dot, Gruff.libpath('dot')
   autoload :Histogram, Gruff.libpath('histogram')
   autoload :Line, Gruff.libpath('line')
   autoload :Net, Gruff.libpath('net')
   autoload :Pie, Gruff.libpath('pie')
   autoload :Scatter, Gruff.libpath('scatter')
-  autoload :Scene, Gruff.libpath('scene')
   autoload :SideBar, Gruff.libpath('side_bar')
   autoload :SideStackedBar, Gruff.libpath('side_stacked_bar')
   autoload :Spider, Gruff.libpath('spider')
@@ -61,7 +62,6 @@ module Gruff
 
   class Store
     autoload :BasicData, Gruff.libpath('store/basic_data')
-    autoload :CustomData, Gruff.libpath('store/custom_data')
     autoload :XYData, Gruff.libpath('store/xy_data')
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gruff
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Geoffrey Grosenbach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-17 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -165,7 +165,9 @@ files:
 - lib/gruff/bar.rb
 - lib/gruff/base.rb
 - lib/gruff/bezier.rb
+- lib/gruff/box_plot.rb
 - lib/gruff/bullet.rb
+- lib/gruff/candlestick.rb
 - lib/gruff/dot.rb
 - lib/gruff/font.rb
 - lib/gruff/helper/bar_conversion.rb
@@ -193,14 +195,12 @@ files:
 - lib/gruff/renderer/renderer.rb
 - lib/gruff/renderer/text.rb
 - lib/gruff/scatter.rb
-- lib/gruff/scene.rb
 - lib/gruff/side_bar.rb
 - lib/gruff/side_stacked_bar.rb
 - lib/gruff/spider.rb
 - lib/gruff/stacked_area.rb
 - lib/gruff/stacked_bar.rb
 - lib/gruff/store/basic_data.rb
-- lib/gruff/store/custom_data.rb
 - lib/gruff/store/store.rb
 - lib/gruff/store/xy_data.rb
 - lib/gruff/themes.rb

data/lib/gruff/scene.rb

@@ -1,208 +0,0 @@
-# frozen_string_literal: true
-
-require 'observer'
-
-# 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.
-#
-# Examples:
-#
-# * 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.
-#
-#  g = Gruff::Scene.new("500x100", "path/to/city_scene_directory")
-#
-#  # Define order of layers, back to front
-#  g.layers = %w(background haze sky clouds)
-#
-#  # Define groups that will be controlled by the same input
-#  g.weather_group = %w(clouds)
-#  g.time_group = %w(background sky)
-#
-#  # Set values for the layers or groups
-#  g.weather = "cloudy"
-#  g.time = Time.now
-#  g.haze = true
-#
-#  # 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.
-# * 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.
-class Gruff::Scene < Gruff::Base
-  # 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 = []
-    super target_width
-  end
-
-  def draw
-    # Join all the custom paths and filter out the empty ones
-    image_paths = @layers.map(&:path).reject(&:empty?)
-    images = Magick::ImageList.new(*image_paths)
-    renderer.background_image = images.flatten_images
-  end
-
-  def layers=(ordered_list)
-    ordered_list.each do |layer_name|
-      @layers << Gruff::Layer.new(@base_dir, layer_name)
-    end
-  end
-
-  # Group layers to input values
-  #
-  #  g.weather_group = ["sky", "sea", "clouds"]
-  #
-  # Set input values
-  #
-  #  g.weather = "cloudy"
-  #
-  def method_missing(method_name, *args)
-    case method_name.to_s
-    when /^(\w+)_group=$/
-      add_group Regexp.last_match(1), *args
-    when /^(\w+)=$/
-      set_input Regexp.last_match(1), args.first
-    else
-      super
-    end
-  end
-
-  def respond_to_missing?(method_sym, include_private)
-    case method_sym.to_s
-    when /^(\w+)_group=$/, /^(\w+)=$/
-      true
-    else
-      super
-    end
-  end
-
-private
-
-  def add_group(input_name, layer_names)
-    @groups[input_name] = Gruff::Group.new(input_name, @layers.select { |layer| layer_names.include?(layer.name) })
-  end
-
-  def set_input(input_name, input_value)
-    if !@groups[input_name].nil?
-      @groups[input_name].send_updates(input_value)
-    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
-
-  def initialize(folder_name, layers)
-    @name = folder_name
-    layers.each do |layer|
-      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.grep(/^[^.]+\.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 = begin
-      case value.to_s
-      when /^(true|false)$/
-        select_boolean value
-      when /^(\w|\s)+$/
-        select_string value
-      when /^-?(\d+\.)?\d+$/
-        select_numeric value
-      when /(\d\d):(\d\d):\d\d/
-        select_time "#{Regexp.last_match(1)}#{Regexp.last_match(2)}"
-      else
-        select_default
-      end
-    end
-    # Finally, try to use 'default' if we're still blank
-    @selected_filename ||= select_default
-  end
-
-  # Returns the full path to the selected image, or a blank string
-  def path
-    unless @selected_filename.nil? || @selected_filename.empty?
-      return File.join(@base_dir, @name, @selected_filename)
-    end
-
-    ''
-  end
-
-private
-
-  # Match "true.png" or "false.png"
-  def select_boolean(value)
-    file_exists_or_blank value.to_s
-  end
-
-  # Match -5 to _5.png
-  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|
-      if (time > value) && (index > 0)
-        return "#{times[index - 1]}.png"
-      end
-    end
-
-    "#{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' : ''
-  end
-
-  # Returns the string "#{filename}.png", if it exists.
-  #
-  # Failing that, it returns default.png, or '' if that doesn't exist.
-  def file_exists_or_blank(filename)
-    @filenames.include?("#{filename}.png") ? "#{filename}.png" : select_default
-  end
-end

data/lib/gruff/store/custom_data.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Gruff
-  class Store
-    # @private
-    class CustomData < Struct.new(:label, :points, :color, :custom)
-      def initialize(label, points, color, custom = nil)
-        super(label.to_s, Array(points), color, custom)
-      end
-
-      def empty?
-        points.empty?
-      end
-
-      def columns
-        points.length
-      end
-
-      def min
-        points.compact.min
-      end
-
-      def max
-        points.compact.max
-      end
-
-      def normalize(minimum:, spread:)
-        norm_points = points.map do |point|
-          point.nil? ? nil : (point.to_f - minimum.to_f) / spread
-        end
-
-        self.class.new(label, norm_points, color, custom)
-      end
-    end
-  end
-end