gruff 0.16.0-java → 0.19.0-java

data/lib/gruff/base.rb

@@ -45,14 +45,15 @@ module Gruff
     # Blank space below the legend. Default is +20+.
     attr_writer :legend_margin
 
-    # A hash of names for the individual columns, where the key is the array
-    # index for the column this label represents.
-    #
-    # Not all columns need to be named.
+    # Truncates labels if longer than max specified.
+    attr_writer :label_max_size
+
+    # How truncated labels visually appear if they exceed {#label_max_size=}.
     #
-    # @example
-    #   { 0 => 2005, 3 => 2006, 5 => 2007, 7 => 2008 }
-    attr_writer :labels
+    # - +:absolute+ - does not show trailing dots to indicate truncation. This is the default.
+    # - +:trailing_dots+ - shows trailing dots to indicate truncation (note that {#label_max_size=}
+    #   must be greater than 3).
+    attr_writer :label_truncation_style
 
     # Set a label for the bottom of the graph.
     attr_writer :x_axis_label
@@ -72,25 +73,9 @@ module Gruff
     # Set increment of the horizontal marking lines.
     attr_writer :y_axis_increment
 
-    # Height of staggering between labels (Bar graph only).
-    attr_writer :label_stagger_height
-
-    # Truncates labels if longer than max specified.
-    attr_writer :label_max_size
-
-    # How truncated labels visually appear if they exceed {#label_max_size=}.
-    #
-    # - +:absolute+ - does not show trailing dots to indicate truncation. This is the default.
-    # - +:trailing_dots+ - shows trailing dots to indicate truncation (note that {#label_max_size=}
-    #   must be greater than 3).
-    attr_writer :label_truncation_style
-
     # Get or set the list of colors that will be used to draw the bars or lines.
     attr_accessor :colors
 
-    # Set the large title of the graph displayed at the top.
-    attr_writer :title
-
     # Prevent drawing of line markers. Default is +false+.
     attr_writer :hide_line_markers
 
@@ -107,9 +92,6 @@ module Gruff
     # to +"No Data."+.
     attr_writer :no_data_message
 
-    # Display the legend under the graph. Default is +false+.
-    attr_writer :legend_at_bottom
-
     # Set the color of the auxiliary lines.
     attr_writer :marker_color
 
@@ -127,6 +109,9 @@ module Gruff
     # first. This does not affect the legend. Default is +false+.
     attr_writer :sorted_drawing
 
+    # Display the legend under the graph. Default is +false+.
+    attr_writer :legend_at_bottom
+
     # Optionally set the size of the colored box by each item in the legend.
     # Default is +20.0+.
     #
@@ -204,9 +189,9 @@ module Gruff
       @no_data_message = 'No Data'
 
       @hide_line_markers = @hide_legend = @hide_title = @hide_line_numbers = @legend_at_bottom = false
-      @label_stagger_height = 0
       @label_max_size = 0
       @label_truncation_style = :absolute
+      @label_rotation = 0
 
       @x_axis_increment = nil
       @x_axis_label = @y_axis_label = nil
@@ -217,6 +202,67 @@ module Gruff
     end
     protected :initialize_attributes
 
+    # A hash of names for the individual columns, where the key is the array
+    # index for the column this label represents.
+    # Not all columns need to be named with hash.
+    #
+    # Or, an array corresponding to the data values.
+    #
+    # @param labels [Hash, Array] the labels.
+    #
+    # @example
+    #   g = Gruff::Bar.new
+    #   g.labels = { 0 => 2005, 3 => 2006, 5 => 2007, 7 => 2008 }
+    #
+    #   g = Gruff::Bar.new
+    #   g.labels = ['2005', nil, nil, '2006', nil, nil, '2007', nil, nil, '2008'] # same labels for columns
+    def labels=(labels)
+      if labels.is_a?(Array)
+        labels = labels.each_with_index.each_with_object({}) do |(label, index), hash|
+          hash[index] = label
+        end
+      end
+
+      @labels = labels
+    end
+
+    # Set a rotation for labels. You can use  Default is +0+.
+    # You can use a rotation between +0.0+ and +45.0+, or between +0.0+ and +-45.0+.
+    #
+    # @param rotation [Numeric] the rotation.
+    #
+    def label_rotation=(rotation)
+      raise ArgumentError, 'rotation must be between 0.0 and 45.0 or between 0.0 and -45.0' if rotation > 45.0 || rotation < -45.0
+
+      @label_rotation = rotation.to_f
+    end
+
+    # Height of staggering between labels.
+    # @deprecated
+    def label_stagger_height=(_value)
+      warn '#label_stagger_height= is deprecated. It is no longer effective.'
+    end
+
+    # Set the large title of the graph displayed at the top.
+    # You can draw a multi-line title by putting a line break in the string
+    # or by setting an array as argument.
+    #
+    # @param title [String, Array] the title.
+    #
+    # @example
+    #   g = Gruff::Bar.new
+    #   g.title = "The graph title"
+    #
+    #   g = Gruff::Bar.new
+    #   g.title = ['The first line of title', 'The second line of title']
+    def title=(title)
+      if title.is_a?(Array)
+        title = title.join("\n")
+      end
+
+      @title = title
+    end
+
     # Sets the top, bottom, left and right margins to +margin+.
     #
     # @param margin [Numeric] The margin size.
@@ -320,7 +366,8 @@ module Gruff
     # You can set a theme manually. Assign a hash to this method before you
     # send your data.
     #
-    #   graph.theme = {
+    #   g = Gruff::Bar.new
+    #   g.theme = {
     #     colors: %w(orange purple green white red),
     #     marker_color: 'blue',
     #     background_colors: ['black', 'grey'],
@@ -357,7 +404,7 @@ module Gruff
       self.marker_color = @theme_options[:marker_color]
       self.font_color = @theme_options[:font_color] || @marker_color
 
-      @colors = @theme_options[:colors]
+      @colors = @theme_options[:colors].dup
       @marker_shadow_color = @theme_options[:marker_shadow_color]
 
       @renderer = Gruff::Renderer.new(@columns, @rows, @scale, @theme_options)
@@ -422,7 +469,8 @@ module Gruff
     #
     # Set it after you have given all your data to the graph object.
     def minimum_value
-      (@minimum_value || store.min).to_f
+      min = [0.0, store.min.to_f].min
+      (@minimum_value || min).to_f
     end
     attr_writer :minimum_value
 
@@ -503,11 +551,13 @@ module Gruff
     attr_reader :renderer
 
     # Perform data manipulation before calculating chart measurements
-    def setup_data # :nodoc:
+    def setup_data
       if @y_axis_increment && !@hide_line_markers
         self.maximum_value = [@y_axis_increment, maximum_value, (maximum_value / @y_axis_increment).round * @y_axis_increment].max
         self.minimum_value = [minimum_value, (minimum_value / @y_axis_increment).round * @y_axis_increment].min
       end
+
+      sort_data if @sort # Sort data with avg largest values set first (for display)
     end
 
     # Calculates size of drawable area and generates normalized data.
@@ -518,7 +568,6 @@ module Gruff
     def setup_drawing
       calculate_spread
       calculate_increment
-      sort_data if @sort # Sort data with avg largest values set first (for display)
       set_colors
       normalize
       setup_graph_measurements
@@ -559,8 +608,8 @@ module Gruff
     end
 
     def calculate_spread
-      @spread = maximum_value - minimum_value
-      @spread = @spread > 0 ? @spread : 1
+      @spread = maximum_value.to_f - minimum_value.to_f
+      @spread = @spread > 0 ? @spread : 1.0
     end
 
     def hide_title?
@@ -583,8 +632,7 @@ module Gruff
     # Calculates size of drawable area, general font dimensions, etc.
 
     def setup_graph_measurements
-      margin_on_right = graph_right_margin
-      @graph_right = @raw_columns - margin_on_right
+      @graph_right = setup_right_margin
       @graph_left = setup_left_margin
       @graph_top = setup_top_margin
       @graph_bottom = setup_bottom_margin
@@ -599,7 +647,7 @@ module Gruff
         # X Axis
         # Centered vertically and horizontally by setting the
         # height to 1.0 and the width to the width of the graph.
-        x_axis_label_y_coordinate = @graph_bottom + (LABEL_MARGIN * 2) + marker_caps_height
+        x_axis_label_y_coordinate = @graph_bottom + (LABEL_MARGIN * 2) + labels_caps_height
 
         text_renderer = Gruff::Renderer::Text.new(renderer, @x_axis_label, font: @marker_font)
         text_renderer.add_to_render_queue(@raw_columns, 1.0, 0.0, x_axis_label_y_coordinate)
@@ -616,14 +664,12 @@ module Gruff
     def draw_line_markers
       return if @hide_line_markers
 
-      increment_scaled = @graph_height / (@spread / @increment)
+      increment_scaled = (@graph_height / (@spread / @increment)).to_f
 
       # Draw horizontal line markers and annotate with numbers
       (0..marker_count).each do |index|
         y = @graph_top + @graph_height - (index * increment_scaled)
-
-        Gruff::Renderer::Line.new(renderer, color: @marker_color).render(@graph_left, y, @graph_right, y)
-        Gruff::Renderer::Line.new(renderer, color: @marker_shadow_color).render(@graph_left, y + 1, @graph_right, y + 1) if @marker_shadow_color
+        draw_marker_horizontal_line(y)
 
         unless @hide_line_numbers
           marker_label = (BigDecimal(index.to_s) * BigDecimal(@increment.to_s)) + BigDecimal(minimum_value.to_s)
@@ -634,6 +680,25 @@ module Gruff
       end
     end
 
+    def draw_marker_horizontal_line(y)
+      Gruff::Renderer::Line.new(renderer, color: @marker_color).render(@graph_left, y, @graph_right, y)
+      Gruff::Renderer::Line.new(renderer, color: @marker_shadow_color).render(@graph_left, y + 1, @graph_right, y + 1) if @marker_shadow_color
+    end
+
+    def draw_marker_vertical_line(x, tick_mark_mode: false)
+      if tick_mark_mode
+        Gruff::Renderer::Line.new(renderer, color: @marker_color).render(x, @graph_bottom, x, @graph_bottom + 5)
+        if @marker_shadow_color
+          Gruff::Renderer::Line.new(renderer, color: @marker_shadow_color).render(x + 1, @graph_bottom, x + 1, @graph_bottom + 5)
+        end
+      else
+        Gruff::Renderer::Line.new(renderer, color: @marker_color).render(x, @graph_bottom, x, @graph_top)
+        if @marker_shadow_color
+          Gruff::Renderer::Line.new(renderer, color: @marker_shadow_color).render(x + 1, @graph_bottom, x + 1, @graph_top)
+        end
+      end
+    end
+
     # Return a calculation of center
     def center(size)
       (@raw_columns - size) / 2
@@ -651,7 +716,7 @@ module Gruff
 
       current_y_offset = begin
         if @legend_at_bottom
-          @graph_bottom + @legend_margin + legend_caps_height + LABEL_MARGIN + (@x_axis_label ? (LABEL_MARGIN * 2) + marker_caps_height : 0)
+          @graph_bottom + @legend_margin + labels_caps_height + LABEL_MARGIN + (@x_axis_label ? (LABEL_MARGIN * 2) + marker_caps_height : 0)
         else
           hide_title? ? @top_margin + @title_margin : @top_margin + @title_margin + title_caps_height
         end
@@ -702,14 +767,14 @@ module Gruff
       text_renderer.add_to_render_queue(@raw_columns, 1.0, 0, @top_margin)
     end
 
-    # Draws column labels below graph, centered over x_offset
-    def draw_label(x_offset, index, gravity = Magick::NorthGravity, &block)
+    # Draws column labels below graph, centered over x
+    def draw_label(x, index, gravity = Magick::NorthGravity, &block)
       draw_unique_label(index) do
-        y_offset = @graph_bottom + LABEL_MARGIN
-        y_offset += @label_stagger_height if index.odd?
+        if x >= @graph_left && x <= @graph_right
+          y = @graph_bottom
+          x_offset, y_offset = calculate_label_offset(@marker_font, @labels[index], LABEL_MARGIN, @label_rotation)
 
-        if x_offset >= @graph_left && x_offset <= @graph_right
-          draw_label_at(1.0, 1.0, x_offset, y_offset, @labels[index], gravity)
+          draw_label_at(1.0, 1.0, x + x_offset, y + y_offset, @labels[index], gravity: gravity, rotation: @label_rotation)
           yield if block
         end
       end
@@ -725,17 +790,17 @@ module Gruff
       end
     end
 
-    def draw_label_at(width, height, x, y, text, gravity = Magick::NorthGravity)
+    def draw_label_at(width, height, x, y, text, gravity: Magick::NorthGravity, rotation: 0)
       label_text = truncate_label_text(text)
-      text_renderer = Gruff::Renderer::Text.new(renderer, label_text, font: @marker_font)
+      text_renderer = Gruff::Renderer::Text.new(renderer, label_text, font: @marker_font, rotation: rotation)
       text_renderer.add_to_render_queue(width, height, x, y, gravity)
     end
 
     # Draws the data value over the data point in bar graphs
-    def draw_value_label(width, height, x_offset, y_offset, data_point, gravity = Magick::CenterGravity)
+    def draw_value_label(width, height, x_offset, y_offset, data_point, gravity: Magick::CenterGravity)
       return if @hide_line_markers
 
-      draw_label_at(width, height, x_offset, y_offset, data_point, gravity)
+      draw_label_at(width, height, x_offset, y_offset, data_point, gravity: gravity)
     end
 
     # Shows an error message because you have no data.
@@ -756,20 +821,11 @@ module Gruff
       @theme_options = {}
     end
 
-    def scale(value) # :nodoc:
-      value * @scale
-    end
-
-    # Return a comparable fontsize for the current graph.
-    def scale_fontsize(value)
-      value * @scale
-    end
-
-    def clip_value_if_greater_than(value, max_value) # :nodoc:
+    def clip_value_if_greater_than(value, max_value)
       value > max_value ? max_value : value
     end
 
-    def significant(i) # :nodoc:
+    def significant(i)
       return 1.0 if i == 0 # Keep from going into infinite loop
 
       inc = BigDecimal(i.to_s)
@@ -816,6 +872,10 @@ module Gruff
       hide_bottom_label_area? ? 0 : calculate_caps_height(@marker_font)
     end
 
+    def labels_caps_height
+      hide_bottom_label_area? ? 0 : calculate_labels_height(@marker_font)
+    end
+
     def title_caps_height
       hide_title? ? 0 : calculate_caps_height(@title_font) * @title.lines.to_a.size
     end
@@ -824,21 +884,6 @@ module Gruff
       @hide_legend ? 0 : calculate_caps_height(@legend_font)
     end
 
-    def graph_right_margin
-      @hide_line_markers ? @right_margin : @right_margin + extra_room_for_long_label
-    end
-
-    def extra_room_for_long_label
-      # Make space for half the width of the rightmost column label.
-      # Might be greater than the number of columns if between-style bar markers are used.
-      last_label = @labels.keys.max.to_i
-      if last_label >= (column_count - 1) && @center_labels_over_point
-        calculate_width(@marker_font, truncate_label_text(@labels[last_label])) / 2.0
-      else
-        0
-      end
-    end
-
     def setup_left_margin
       return @left_margin if hide_left_label_area?
 
@@ -851,10 +896,62 @@ module Gruff
       end
       longest_left_label_width = calculate_width(@marker_font, truncate_label_text(text))
 
-      # Shift graph if left line numbers are hidden
-      line_number_width = !@has_left_labels && (@hide_line_markers || @hide_line_numbers) ? 0.0 : (longest_left_label_width + LABEL_MARGIN)
+      line_number_width = begin
+        if !@has_left_labels && (@hide_line_markers || @hide_line_numbers)
+          0.0
+        else
+          longest_left_label_width + LABEL_MARGIN
+        end
+      end
+      y_axis_label_width = @y_axis_label.nil? ? 0.0 : marker_caps_height + (LABEL_MARGIN * 2)
+
+      bottom_label_width = extra_left_room_for_long_label
+
+      margin = line_number_width + y_axis_label_width
+      @left_margin + (margin > bottom_label_width ? margin : bottom_label_width)
+    end
 
-      @left_margin + line_number_width + (@y_axis_label.nil? ? 0.0 : marker_caps_height + (LABEL_MARGIN * 2))
+    def setup_right_margin
+      @raw_columns - (@hide_line_markers ? @right_margin : @right_margin + extra_right_room_for_long_label)
+    end
+
+    def extra_left_room_for_long_label
+      if require_extra_side_margin?
+        width = calculate_width(@marker_font, truncate_label_text(@labels[0]), rotation: @label_rotation)
+        case @label_rotation
+        when 0
+          width / 2.0
+        when 0..45
+          0
+        when -45..0
+          width
+        end
+      else
+        0
+      end
+    end
+
+    def extra_right_room_for_long_label
+      # Make space for half the width of the rightmost column label.
+      # Might be greater than the number of columns if between-style bar markers are used.
+      last_label = @labels.keys.max.to_i
+      if last_label >= (column_count - 1) && require_extra_side_margin?
+        width = calculate_width(@marker_font, truncate_label_text(@labels[last_label]), rotation: @label_rotation)
+        case @label_rotation
+        when 0
+          width / 2.0
+        when 0..45
+          width
+        when -45..0
+          0
+        end
+      else
+        0
+      end
+    end
+
+    def require_extra_side_margin?
+      !hide_bottom_label_area? && @center_labels_over_point
     end
 
     def setup_top_margin
@@ -866,11 +963,11 @@ module Gruff
     end
 
     def setup_bottom_margin
-      graph_bottom_margin = hide_bottom_label_area? ? @bottom_margin : @bottom_margin + marker_caps_height + LABEL_MARGIN
+      graph_bottom_margin = hide_bottom_label_area? ? @bottom_margin : @bottom_margin + labels_caps_height + LABEL_MARGIN
       graph_bottom_margin += (calculate_legend_height + @legend_margin) if @legend_at_bottom
 
       x_axis_label_height = @x_axis_label.nil? ? 0.0 : marker_caps_height + (LABEL_MARGIN * 2)
-      @raw_rows - graph_bottom_margin - x_axis_label_height - @label_stagger_height
+      @raw_rows - graph_bottom_margin - x_axis_label_height
     end
 
     def truncate_label_text(text)
@@ -973,32 +1070,38 @@ module Gruff
       calculate_height(font, 'X')
     end
 
+    def calculate_labels_height(font)
+      @labels.values.map { |label| calculate_height(font, label, rotation: @label_rotation) }.max || marker_caps_height
+    end
+
     # Returns the height of a string at this point size.
     #
     # Not scaled since it deals with dimensions that the regular scaling will
     # handle.
-    def calculate_height(font, text)
+    def calculate_height(font, text, rotation: 0)
       text = text.to_s
       return 0 if text.empty?
 
-      metrics = text_metrics(font, text)
-      metrics.height
+      metrics = text_metrics(font, text, rotation: rotation)
+      # Calculate manually because it does not return the height after rotation.
+      (metrics.width * Math.sin(deg2rad(rotation))).abs + (metrics.height * Math.cos(deg2rad(rotation))).abs
     end
 
     # Returns the width of a string at this point size.
     #
     # Not scaled since it deals with dimensions that the regular
     # scaling will handle.
-    def calculate_width(font, text)
+    def calculate_width(font, text, rotation: 0)
       text = text.to_s
       return 0 if text.empty?
 
-      metrics = text_metrics(font, text)
-      metrics.width
+      metrics = text_metrics(font, text, rotation: rotation)
+      # Calculate manually because it does not return the width after rotation.
+      (metrics.width * Math.cos(deg2rad(rotation))).abs - (metrics.height * Math.sin(deg2rad(rotation))).abs
     end
 
-    def text_metrics(font, text)
-      Gruff::Renderer::Text.new(renderer, text, font: font).metrics
+    def text_metrics(font, text, rotation: 0)
+      Gruff::Renderer::Text.new(renderer, text, font: font, rotation: rotation).metrics
     end
 
     def calculate_increment
@@ -1006,14 +1109,32 @@ module Gruff
         # Try to use a number of horizontal lines that will come out even.
         #
         # TODO Do the same for larger numbers...100, 75, 50, 25
-        @increment = @spread > 0 && marker_count > 0 ? significant(@spread / marker_count) : 1
+        @increment = @spread > 0 && marker_count > 0 ? significant(@spread / marker_count) : 1.0
       else
         # TODO: Make this work for negative values
         self.marker_count = (@spread / @y_axis_increment).to_i
-        @increment = @y_axis_increment
+        @increment = @y_axis_increment.to_f
       end
     end
 
+    def calculate_label_offset(font, label, margin, rotation)
+      width = calculate_width(font, label, rotation: rotation)
+      height = calculate_height(font, label, rotation: rotation)
+      x_offset = begin
+        case rotation
+        when 0
+          0
+        when 0..45
+          width / 2.0
+        when -45..0
+          -(width / 2.0)
+        end
+      end
+      y_offset = (height / 2.0) > margin ? (height / 2.0) : margin
+
+      [x_offset, y_offset]
+    end
+
     # Used for degree <=> radian conversions
     def deg2rad(angle)
       (angle * Math::PI) / 180.0

data/lib/gruff/bezier.rb

@@ -22,9 +22,14 @@ class Gruff::Bezier < Gruff::Base
 private
 
   def draw_graph
-    x_increment = @graph_width / (column_count - 1)
+    x_increment = (@graph_width / (column_count - 1)).to_f
+
+    renderer_class = RUBY_PLATFORM == 'java' ? Gruff::Renderer::Polyline : Gruff::Renderer::Bezier
+    stroke_width = clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 4.0), 5.0)
 
     store.norm_data.each do |data_row|
+      next if data_row[1].empty?
+
       poly_points = []
 
       data_row[1].each_with_index do |data_point, index|
@@ -43,13 +48,7 @@ private
         draw_label(new_x, index)
       end
 
-      stroke_width = clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 4), 5.0)
-
-      if RUBY_PLATFORM == 'java'
-        Gruff::Renderer::Polyline.new(renderer, color: data_row.color, width: stroke_width).render(poly_points)
-      else
-        Gruff::Renderer::Bezier.new(renderer, color: data_row.color, width: stroke_width).render(poly_points)
-      end
+      renderer_class.new(renderer, color: data_row.color, width: stroke_width).render(poly_points)
     end
   end
 end

data/lib/gruff/{box_plot.rb → box.rb}

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 #
-# Here's how to set up a Gruff::BoxPlot.
+# Here's how to set up a Gruff::Box.
 #
-#   g = Gruff::BoxPlot.new
+#   g = Gruff::Box.new
 #   g.data "A", [2, 3, 5, 6, 8, 10, 11, 15, 17, 20, 28, 29, 33, 34, 45, 46, 49, 61]
 #   g.data "B", [3, 4, 34, 35, 38, 39, 45, 60, 61, 69, 80, 130]
 #   g.data "C", [4, 40, 41, 46, 57, 64, 77, 76, 79, 78, 99, 153]
 #   g.write("box_plot.png")
 #
-class Gruff::BoxPlot < Gruff::Base
+class Gruff::Box < Gruff::Base
   # Specifies the filling opacity in area graph. Default is +0.2+.
   attr_writer :fill_opacity
 
@@ -44,11 +44,13 @@ private
       minimum_value: minimum_value, maximum_value: maximum_value, spread: @spread
     )
 
-    width = (@graph_width - calculate_spacing) / normalized_boxes.size
+    width = (@graph_width - calculate_spacing) / column_count
     bar_width = width * @spacing_factor
     padding = width - bar_width
 
     normalized_boxes.each_with_index do |box, index|
+      next if box.points.empty?
+
       left_x = @graph_left + (width * index) + (padding / 2.0)
       right_x = left_x + bar_width
       center_x = (left_x + right_x) / 2.0
@@ -88,11 +90,15 @@ private
   end
 
   def normalized_boxes
-    @normalized_boxes ||= store.norm_data.map { |data| Gruff::BoxPlot::BoxData.new(data.label, data.points, data.color) }
+    @normalized_boxes ||= store.norm_data.map { |data| Gruff::Box::BoxData.new(data.label, data.points, data.color) }
+  end
+
+  def column_count
+    normalized_boxes.size
   end
 
   def calculate_spacing
-    @scale * (column_count - 1)
+    column_count - 1
   end
 
   # @private