gruff 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae885f81fed47dcd147251d6de49321377f2e6eb3191160ce09abb81a9fa666d
-  data.tar.gz: fe6d010756e6574e519babf89117e4cf5c8beb84712ca8274c7f8562c13249fe
+  metadata.gz: 98ee5b42ff833633329e8c3d6eb0bda9c9f390ef1b007a497bba41406a2252f6
+  data.tar.gz: dd10520cbc862790a6c99610d497df0f470323328cc67bd35b60067d76cbb001
 SHA512:
-  metadata.gz: e2e4bf075d99c36eeda51dad47c5f207e7cc589354f8ca686b51709e9f7fc351d344dd0129af4cd846f647160110cd4cc6b0d357170d6720dbc64bc026a36fa2
-  data.tar.gz: 28462538e4e988bb4f2de241fabec2d91e4e6fb2b862319fd95387cf0faead34ea0dac9a373b8a8620e5e012e6c964e180121488fc268ec99076c22b019761c9
+  metadata.gz: 17dd968e6fb2c606ae611827753d27acc15c34f6aba27c06e8b336891e152c0fa6a384ebd65632b3416b88dda3170d7f32688c47958111027efe2b08519e4c6c
+  data.tar.gz: ca648c54fb85acb7e144ce23ba3fad5e678543ddd67a133c9bcd3adccbd889c47f3e6213fef2a7abed51cbf93efc688557aadf8b3dfba9db17c5e462e8f0ccfb

data/.rubocop_todo.yml

@@ -63,12 +63,6 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   Max: 20
 
-# Offense count: 2
-Naming/AccessorMethodName:
-  Exclude:
-    - 'lib/gruff/helper/stacked_mixin.rb'
-    - 'lib/gruff/store/store.rb'
-
 # Offense count: 1
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
 # SupportedStylesForLeadingUnderscores: disallowed, required, optional

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.10.0
+
+* Add Histogram chart (#419)
+* Fix that Y axis label is not displayed on JRuby platform (#415)
+* Add fill_opacity and stroke_width in Gruff::Area in order to specify the filling opacity (#413)
+* Fix "`get_type_metrics': no text to measure" exception (#410, #409)
+
 ## 0.9.0
 
 * Fix that sidebar label is not displayed on JRuby platform (#402)

data/README.md

@@ -119,6 +119,10 @@ In progress!
 
 ![Stacked bar chart](https://raw.github.com/topfunky/gruff/master/test/expected/stacked_bar_keynote.png)
 
+### Histogram chart
+
+![Histogram chart](https://raw.github.com/topfunky/gruff/master/test/expected/histogram.png)
+
 
 ## Documentation
 

data/gruff.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     s.add_dependency 'rmagick'
     s.add_development_dependency 'rubocop', '~> 0.81.0'
   end
+  s.add_dependency 'histogram'
   s.required_ruby_version = '>= 1.9.3'
 
   s.add_development_dependency 'rake'

data/lib/gruff.rb

@@ -16,6 +16,7 @@ require 'gruff/version'
   bezier
   bullet
   dot
+  histogram
   line
   net
   pie

data/lib/gruff/accumulator_bar.rb

@@ -2,9 +2,19 @@
 
 require 'gruff/base'
 
-# A special bar graph that shows a single dataset as a set of
-# stacked bars. The bottom bar shows the running total and
-# the top bar shows the new value being added to the array.
+#
+# Gruff::AccumulatorBar is a special bar graph that shows a
+# single dataset as a set of stacked bars.
+# The bottom bar shows the running total and the top bar shows
+# the new value being added to the array.
+#
+# Here's how to set up a Gruff::AccumulatorBar.
+#
+#   g = Gruff::AccumulatorBar.new
+#   g.title = 'Your Savings'
+#   g.data 'First', [1, 1, 1]
+#   g.write('accumulator_bar.png')
+#
 class Gruff::AccumulatorBar < Gruff::StackedBar
   def draw
     raise(Gruff::IncorrectNumberOfDatasetsException) unless store.length == 1

data/lib/gruff/area.rb

@@ -2,10 +2,31 @@
 
 require 'gruff/base'
 
+#
+# Gruff::Area provides an area graph which displays graphically
+# quantitative data.
+#
+# Here's how to set up a Gruff::Area.
+#
+#   g = Gruff::Area.new
+#   g.title = 'Area Graph'
+#   g.data :Jimmy, [25, 36, 86, 39, 25, 31, 79, 88]
+#   g.data :Charles, [80, 54, 67, 54, 68, 70, 90, 95]
+#   g.data :Julie, [22, 29, 35, 38, 36, 40, 46, 57]
+#   g.write('area.png')
+#
 class Gruff::Area < Gruff::Base
+  # Specifies the filling opacity in area graph. Default is +0.85+.
+  attr_accessor :fill_opacity
+
+  # Specifies the stroke width in line around area graph. Default is +2.0+.
+  attr_accessor :stroke_width
+
   def initialize_ivars
     super
     @sorted_drawing = true
+    @fill_opacity = 0.85
+    @stroke_width = 2.0
   end
   private :initialize_ivars
 
@@ -36,7 +57,7 @@ class Gruff::Area < Gruff::Base
       poly_points << @graph_left
       poly_points << @graph_bottom - 1
 
-      Gruff::Renderer::Polygon.new(color: data_row.color).render(poly_points)
+      Gruff::Renderer::Polygon.new(color: data_row.color, width: @stroke_width, opacity: @fill_opacity).render(poly_points)
     end
 
     Gruff::Renderer.finish

data/lib/gruff/bar.rb

@@ -3,6 +3,21 @@
 require 'gruff/base'
 require 'gruff/helper/bar_conversion'
 
+#
+# Gruff::Bar provide a bar graph that presents categorical data
+# with rectangular bars.
+#
+# Here's how to set up a Gruff::Bar.
+#
+#   g = Gruff::Bar.new
+#   g.title = 'Bar Graph With Manual Colors'
+#   g.spacing_factor = 0.1
+#   g.group_spacing = 20
+#   g.data :Art, [0, 5, 8, 15], '#990000'
+#   g.data :Philosophy, [10, 3, 2, 8], '#009900'
+#   g.data :Science, [2, 15, 8, 11], '#990099'
+#   g.write('bar.png')
+#
 class Gruff::Bar < Gruff::Base
   # Spacing factor applied between bars.
   attr_accessor :bar_spacing

data/lib/gruff/base.rb

@@ -25,24 +25,22 @@ module Gruff
 
     DEFAULT_TARGET_WIDTH = 800.0
 
-    THOUSAND_SEPARATOR = ','
-
-    # Blank space above the graph.
+    # Blank space above the graph. Default is +20+.
     attr_accessor :top_margin
 
-    # Blank space below the graph.
+    # Blank space below the graph. Default is +20+.
     attr_accessor :bottom_margin
 
-    # Blank space to the right of the graph.
+    # Blank space to the right of the graph. Default is +20+.
     attr_accessor :right_margin
 
-    # Blank space to the left of the graph.
+    # Blank space to the left of the graph. Default is +20+.
     attr_accessor :left_margin
 
-    # Blank space below the title.
+    # Blank space below the title. Default is +20+.
     attr_accessor :title_margin
 
-    # Blank space below the legend.
+    # Blank space below the legend. Default is +20+.
     attr_accessor :legend_margin
 
     # A hash of names for the individual columns, where the key is the array
@@ -59,19 +57,19 @@ module Gruff
     # By default, labels are centered over the point they represent.
     attr_accessor :center_labels_over_point
 
-    # Used internally for horizontal graph types.
+    # Used internally for horizontal graph types. Default is +false+.
     attr_accessor :has_left_labels
 
-    # A label for the bottom of the graph.
+    # Set a label for the bottom of the graph.
     attr_accessor :x_axis_label
 
-    # A label for the left side of the graph.
+    # Set a label for the left side of the graph.
     attr_accessor :y_axis_label
 
-    # Manually set increment of the vertical marking lines.
+    # Set increment of the vertical marking lines.
     attr_accessor :x_axis_increment
 
-    # Manually set increment of the horizontal marking lines.
+    # Set increment of the horizontal marking lines.
     attr_accessor :y_axis_increment
 
     # Height of staggering between labels (Bar graph only).
@@ -90,7 +88,7 @@ module Gruff
     # Get or set the list of colors that will be used to draw the bars or lines.
     attr_accessor :colors
 
-    # The large title of the graph displayed at the top.
+    # Set the large title of the graph displayed at the top.
     attr_accessor :title
 
     # Font used for titles, labels, etc. Works best if you provide the full
@@ -98,31 +96,32 @@ module Gruff
     # libraries for this to work properly.
     attr_reader :font
 
-    # Same as font but for the title.
+    # Same as {#font} but for the title.
     attr_accessor :title_font
 
-    # Specifies whether to draw the title bolded or not.
+    # Specifies whether to draw the title bolded or not. Default is +true+.
     attr_accessor :bold_title
 
+    # Specifies the text color.
     attr_accessor :font_color
 
-    # Prevent drawing of line markers.
+    # Prevent drawing of line markers. Default is +false+.
     attr_accessor :hide_line_markers
 
-    # Prevent drawing of the legend.
+    # Prevent drawing of the legend. Default is +false+.
     attr_accessor :hide_legend
 
-    # Prevent drawing of the title.
+    # Prevent drawing of the title. Default is +false+.
     attr_accessor :hide_title
 
-    # Prevent drawing of line numbers.
+    # Prevent drawing of line numbers. Default is +false+.
     attr_accessor :hide_line_numbers
 
-    # Message shown when there is no data. Fits up to 20 characters. Defaults
+    # Set a message shown when there is no data. Fits up to 20 characters. Defaults
     # to +"No Data."+.
     attr_accessor :no_data_message
 
-    # The font size of the large title at the top of the graph.
+    # Set the font size of the large title at the top of the graph. Default is +36+.
     attr_accessor :title_font_size
 
     # Optionally set the size of the font. Based on an 800x600px graph.
@@ -131,30 +130,29 @@ module Gruff
     # Will be scaled down if the graph is smaller than 800px wide.
     attr_accessor :legend_font_size
 
-    # Display the legend under the graph.
+    # Display the legend under the graph. Default is +false+.
     attr_accessor :legend_at_bottom
 
-    # The font size of the labels around the graph.
+    # The font size of the labels around the graph. Default is +21+.
     attr_accessor :marker_font_size
 
-    # The color of the auxiliary lines.
+    # Set the color of the auxiliary lines.
     attr_accessor :marker_color
+
+    # Set the shadow color of the auxiliary lines.
     attr_accessor :marker_shadow_color
 
-    # The number of horizontal lines shown for reference.
+    # Set the number of horizontal lines shown for reference.
     attr_accessor :marker_count
 
-    # Set to true if you want the data sets sorted with largest avg values drawn
-    # first.
+    # Set to +true+ if you want the data sets sorted with largest avg values drawn
+    # first. Default is +false+.
     attr_accessor :sort
 
-    # Set to true if you want the data sets drawn with largest avg values drawn
-    # first.  This does not affect the legend.
+    # Set to +true+ if you want the data sets drawn with largest avg values drawn
+    # first. This does not affect the legend. Default is +false+.
     attr_accessor :sorted_drawing
 
-    # Experimental
-    attr_accessor :additional_line_values
-
     # Optionally set the size of the colored box by each item in the legend.
     # Default is +20.0+.
     #
@@ -166,10 +164,13 @@ module Gruff
     attr_accessor :use_data_label
 
     # If one numerical argument is given, the graph is drawn at 4/3 ratio
-    # according to the given width (800 results in 800x600, 400 gives 400x300,
+    # according to the given width (+800+ results in 800x600, +400+ gives 400x300,
     # etc.).
     #
-    # Or, send a geometry string for other ratios ('800x400', '400x225').
+    # Or, send a geometry string for other ratios ( +'800x400'+, +'400x225'+).
+    #
+    # @param target_width [Numeric, String] The graph image width.
+    #
     def initialize(target_width = DEFAULT_TARGET_WIDTH)
       if target_width.is_a?(String)
         geometric_width, geometric_height = target_width.split('x')
@@ -200,18 +201,18 @@ module Gruff
       @raw_columns.freeze
       @raw_rows.freeze
 
+      @scale = @columns / @raw_columns
+      @scale.freeze
+
       @marker_count = nil
       @maximum_value = @minimum_value = nil
       @increment = nil
       @labels = {}
-      @labels_seen = {}
       @sort = false
       @sorted_drawing = false
       @title = nil
       @title_font = nil
 
-      @scale = @columns / @raw_columns
-
       @font = nil
       @bold_title = true
 
@@ -234,8 +235,6 @@ module Gruff
       @label_max_size = 0
       @label_truncation_style = :absolute
 
-      @additional_line_values = []
-      @additional_line_colors = []
       @theme_options = {}
 
       @use_data_label = false
@@ -248,11 +247,17 @@ module Gruff
     protected :initialize_ivars
 
     # Sets the top, bottom, left and right margins to +margin+.
+    #
+    # @param margin [Numeric] The margin size.
+    #
     def margins=(margin)
       @top_margin = @left_margin = @right_margin = @bottom_margin = margin
     end
 
     # Sets the font for graph text to the font at +font_path+.
+    #
+    # @param font_path [String] The path to font.
+    #
     def font=(font_path)
       @font = font_path
       Gruff::Renderer.font = @font
@@ -260,6 +265,8 @@ module Gruff
 
     # Add a color to the list of available colors for lines.
     #
+    # @param colorname [String] The color.
+    #
     # @example
     #   add_color('#c0e9d3')
     def add_color(colorname)
@@ -277,6 +284,8 @@ module Gruff
     # {#data} method made prior to this call will use whatever color scheme
     # was in place at the time data was called.
     #
+    # @param color_list [Array] The array of colors.
+    #
     # @example
     #   replace_colors ['#cc99cc', '#d9e043', '#34d8a2']
     def replace_colors(color_list = [])
@@ -296,12 +305,13 @@ module Gruff
     #
     # (Or hopefully something better looking than that.)
     #
+    # @param options [Hash] The optional setting for theme
+    #
     def theme=(options)
       reset_themes
 
       defaults = {
         colors: %w[black white],
-        additional_line_colors: [],
         marker_color: 'white',
         marker_shadow_color: nil,
         font_color: 'black',
@@ -314,35 +324,42 @@ module Gruff
       @marker_color = @theme_options[:marker_color]
       @marker_shadow_color = @theme_options[:marker_shadow_color]
       @font_color = @theme_options[:font_color] || @marker_color
-      @additional_line_colors = @theme_options[:additional_line_colors]
 
       Gruff::Renderer.setup(@columns, @rows, @font, @scale, @theme_options)
     end
 
+    # Apply Apple's keynote theme.
     def theme_keynote
       self.theme = Themes::KEYNOTE
     end
 
+    # Apply 37signals theme.
     def theme_37signals
       self.theme = Themes::THIRTYSEVEN_SIGNALS
     end
 
+    # Apply Rails theme.
     def theme_rails_keynote
       self.theme = Themes::RAILS_KEYNOTE
     end
 
+    # Apply Odeo theme.
     def theme_odeo
       self.theme = Themes::ODEO
     end
 
+    # Apply pastel theme.
     def theme_pastel
       self.theme = Themes::PASTEL
     end
 
+    # Apply greyscale theme.
     def theme_greyscale
       self.theme = Themes::GREYSCALE
     end
 
+    # Input the data in the graph.
+    #
     # Parameters are an array where the first element is the name of the dataset
     # and the value is an array of values to plot.
     #
@@ -352,6 +369,10 @@ module Gruff
     # If the color argument is nil, the next color from the default theme will
     # be used.
     #
+    # @param name [String, Symbol] The name of the dataset.
+    # @param data_points [Array] The array of dataset.
+    # @param color [String] The color for drawing graph of dataset.
+    #
     # @note
     #   If you want to use a preset theme, you must set it before calling {#data}.
     #
@@ -382,6 +403,8 @@ module Gruff
 
     # Writes the graph to a file. Defaults to +'graph.png'+
     #
+    # @param file_name [String] The file name of output image.
+    #
     # @example
     #   write('graphs/my_pretty_graph.png')
     def write(file_name = 'graph.png')
@@ -465,12 +488,16 @@ module Gruff
       @spread = @spread > 0 ? @spread : 1
     end
 
+    def hide_title?
+      @hide_title || @title.nil? || @title.empty?
+    end
+
     ##
     # Calculates size of drawable area, general font dimensions, etc.
 
     def setup_graph_measurements
       @marker_caps_height = @hide_line_markers ? 0 : calculate_caps_height(@marker_font_size)
-      @title_caps_height = (@hide_title || @title.nil?) ? 0 : calculate_caps_height(@title_font_size) * @title.lines.to_a.size
+      @title_caps_height = hide_title? ? 0 : calculate_caps_height(@title_font_size) * @title.lines.to_a.size
       @legend_caps_height = @hide_legend ? 0 : calculate_caps_height(@legend_font_size)
 
       if @hide_line_markers
@@ -512,7 +539,7 @@ module Gruff
           @top_margin
         else
           @top_margin +
-            (@hide_title ? title_margin : @title_caps_height + title_margin) +
+            (hide_title? ? title_margin : @title_caps_height + title_margin) +
             (@hide_legend ? legend_margin : @legend_caps_height + legend_margin)
         end
       end
@@ -559,9 +586,8 @@ module Gruff
           Gruff::Renderer::Line.new(color: @marker_shadow_color).render(@graph_left, y + 1, @graph_right, y + 1)
         end
 
-        marker_label = BigDecimal(index.to_s) * BigDecimal(@increment.to_s) + BigDecimal(minimum_value.to_s)
-
         unless @hide_line_numbers
+          marker_label = BigDecimal(index.to_s) * BigDecimal(@increment.to_s) + BigDecimal(minimum_value.to_s)
           label = label(marker_label, @increment)
           text_renderer = Gruff::Renderer::Text.new(label, font: @font, size: @marker_font_size, color: @font_color)
           text_renderer.render(@graph_left - LABEL_MARGIN, 1.0, 0.0, y, Magick::EastGravity)
@@ -593,8 +619,8 @@ module Gruff
       # May fix legend drawing problem at small sizes
       label_widths = [[]] # Used to calculate line wrap
       legend_labels.each do |label|
-        metrics = Renderer::Text.metrics(label, @legend_font_size)
-        label_width = metrics.width + legend_square_width * 2.7
+        width = calculate_width(@legend_font_size, label)
+        label_width = width + legend_square_width * 2.7
         label_widths.last.push label_width
 
         if sum(label_widths.last) > (@raw_columns * 0.9)
@@ -607,11 +633,13 @@ module Gruff
         if @legend_at_bottom
           @graph_height + title_margin
         else
-          @hide_title ? @top_margin + title_margin : @top_margin + title_margin + @title_caps_height
+          hide_title? ? @top_margin + title_margin : @top_margin + title_margin + @title_caps_height
         end
       end
 
       legend_labels.each_with_index do |legend_label, index|
+        next if legend_label.empty?
+
         # Draw label
         text_renderer = Gruff::Renderer::Text.new(legend_label, font: @font, size: @legend_font_size, color: @font_color)
         text_renderer.render(@raw_columns, 1.0, current_x_offset + (legend_square_width * 1.7), current_y_offset, Magick::WestGravity)
@@ -623,8 +651,8 @@ module Gruff
                              current_x_offset + legend_square_width,
                              current_y_offset + legend_square_width / 2.0)
 
-        metrics = Renderer::Text.metrics(legend_label, legend_font_size)
-        current_string_offset = metrics.width + (legend_square_width * 2.7)
+        width = calculate_width(legend_font_size, legend_label)
+        current_string_offset = width + (legend_square_width * 2.7)
 
         # Handle wrapping
         label_widths.first.shift
@@ -646,9 +674,9 @@ module Gruff
 
     # Draws a title on the graph.
     def draw_title
-      return if @hide_title || @title.nil?
+      return if hide_title?
 
-      font = (@title_font || @font) if @title_font || @font
+      font = @title_font || @font
       font_weight = @bold_title ? Magick::BoldWeight : Magick::NormalWeight
       font_size = @title_font_size
 
@@ -672,20 +700,7 @@ module Gruff
         # TODO: See if index.odd? is the best stragegy
         y_offset += @label_stagger_height if index.odd?
 
-        label_text = labels[index].to_s
-
-        # TESTME
-        # FIXME: Consider chart types other than bar
-        if label_text.size > @label_max_size
-          if @label_truncation_style == :trailing_dots
-            if @label_max_size > 3
-              # 4 because '...' takes up 3 chars
-              label_text = "#{label_text[0..(@label_max_size - 4)]}..."
-            end
-          else # @label_truncation_style is :absolute (default)
-            label_text = label_text[0..(@label_max_size - 1)]
-          end
-        end
+        label_text = truncate_label_text(labels[index].to_s)
 
         if x_offset >= @graph_left && x_offset <= @graph_right
           text_renderer = Gruff::Renderer::Text.new(label_text, font: @font, size: @marker_font_size, color: @font_color)
@@ -697,6 +712,7 @@ module Gruff
     def draw_unique_label(index)
       return if @hide_line_markers
 
+      @labels_seen ||= {}
       if !@labels[index].nil? && @labels_seen[index].nil?
         yield
         @labels_seen[index] = 1
@@ -719,7 +735,6 @@ module Gruff
 
     # Resets everything to defaults (except data).
     def reset_themes
-      @labels_seen = {}
       @theme_options = {}
     end
 
@@ -768,7 +783,7 @@ module Gruff
 
     # Set the color for each data set unless it was given in the data(...) call.
     def set_colors
-      store.set_colors!(@colors)
+      store.change_colors(@colors)
     end
 
     # Sort with largest overall summed value at front of array so it shows up
@@ -779,6 +794,18 @@ module Gruff
 
   private
 
+    def truncate_label_text(text)
+      return text if text.size <= @label_max_size
+
+      if @label_truncation_style == :trailing_dots
+        # 4 because '...' takes up 3 chars
+        text = "#{text[0..(@label_max_size - 4)]}..." if @label_max_size > 3
+      else
+        text = text[0..(@label_max_size - 1)]
+      end
+      text
+    end
+
     # Return a formatted string representing a number value that should be
     # printed as a label.
     def label(value, increment)
@@ -807,7 +834,7 @@ module Gruff
               end
 
       parts = label.split('.')
-      parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{THOUSAND_SEPARATOR}")
+      parts[0] = parts[0].commify
       parts.join('.')
     end
 
@@ -826,7 +853,8 @@ module Gruff
     # Not scaled since it deals with dimensions that the regular
     # scaling will handle.
     def calculate_width(font_size, text)
-      return 0 if text.nil?
+      text = text.to_s
+      return 0 if text.empty?
 
       metrics = Renderer::Text.metrics(text, font_size)
       metrics.width

data/lib/gruff/bezier.rb

@@ -2,6 +2,24 @@
 
 require 'gruff/base'
 
+#
+# Gruff::Bezier is a special line graph that have
+# the bezier curve.
+#
+# Here's how to set up a Gruff::Bezier.
+#
+#   dataset = [
+#     +0.00, +0.09, +0.19, +0.29, +0.38, +0.47, +0.56, +0.64, +0.71, +0.78,
+#     +0.84, +0.89, +0.93, +0.96, +0.98, +0.99, +0.99, +0.99, +0.97, +0.94,
+#     +0.90, +0.86, +0.80, +0.74, +0.67, +0.59, +0.51, +0.42, +0.33, +0.23,
+#     +0.14, +0.04, -0.06, -0.16, -0.26, -0.36, -0.45, -0.53, -0.62, -0.69,
+#     -0.76, -0.82, -0.88, -0.92, -0.96, -0.98, -1.00, -1.00, -1.00, -0.99,
+#     -0.96, -0.93, -0.89, -0.84, -0.78, -0.71, -0.64, -0.56, -0.47, -0.38,
+#   ]
+#   g = Gruff::Bezier.new
+#   g.data 'sin', dataset
+#   g.write('bezier.png')
+#
 class Gruff::Bezier < Gruff::Base
   def draw
     super

data/lib/gruff/bullet.rb

@@ -3,7 +3,17 @@
 require 'gruff/base'
 require 'gruff/themes'
 
+#
+# A bullet graph is a variation of a bar graph.
 # http://en.wikipedia.org/wiki/Bullet_graph
+#
+# Here's how to set up a Gruff::Bullet.
+#
+#   g = Gruff::Bullet.new
+#   g.title = 'Monthly Revenue'
+#   g.data 75, 100, { target: 80, low: 50, high: 90 }
+#   g.write('bullet.png')
+#
 class Gruff::Bullet < Gruff::Base
   def initialize(target_width = '400x40')
     if target_width.is_a?(String)

data/lib/gruff/dot.rb

@@ -2,8 +2,19 @@
 
 require 'gruff/base'
 
-# Graph with dots and labels along a vertical access
+#
+# Graph with dots and labels along a vertical access.
 # see: 'Creating More Effective Graphs' by Robbins
+#
+# Here's how to set up a Gruff::Dot.
+#
+#   g = Gruff::Dot.new
+#   g.title = 'Dot Graph'
+#   g.data :Art, [0, 5, 8, 15]
+#   g.data :Philosophy, [10, 3, 2, 8]
+#   g.data :Science, [2, 15, 8, 11]
+#   g.write('dot.png')
+#
 class Gruff::Dot < Gruff::Base
   def draw
     @has_left_labels = true
@@ -84,7 +95,7 @@ protected
   def draw_label(y_offset, index)
     draw_unique_label(index) do
       text_renderer = Gruff::Renderer::Text.new(@labels[index], font: @font, size: @marker_font_size, color: @font_color)
-      text_renderer.render(1, 1, -@graph_left + LABEL_MARGIN * 2.0, y_offset, Magick::EastGravity)
+      text_renderer.render(@graph_left - LABEL_MARGIN * 2, 1.0, 0.0, y_offset, Magick::EastGravity)
     end
   end
 end

data/lib/gruff/helper/stacked_mixin.rb

@@ -5,7 +5,7 @@ module Gruff::Base::StackedMixin
   # Used by StackedBar and child classes.
   #
   # tsal: moved from Base 03 FEB 2007
-  def get_maximum_by_stack
+  def calculate_maximum_by_stack
     # Get sum of each stack
     max_hash = {}
     store.data.each do |data_set|

data/lib/gruff/histogram.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'histogram'
+require 'gruff/base'
+
+#
+# Here's how to set up a Gruff::Histogram.
+#
+#   g = Gruff::Histogram.new
+#   g.title = 'Histogram Graph'
+#   g.minimum_bin = 10
+#   g.bin_width = 20
+#   g.data :A, [10, 10, 20, 30, 40, 40, 40, 40, 40, 40, 50, 10, 10, 10]
+#   g.data :B, [100, 100, 100, 100, 90, 90, 80, 30, 30, 30, 30, 30]
+#   g.write('histogram.png')
+#
+class Gruff::Histogram < Gruff::Bar
+  def initialize_ivars
+    super
+    @bin_width = 10
+    @minimum_bin = nil
+    @maximum_bin = nil
+  end
+  private :initialize_ivars
+
+  # Specifies interpolation between the min and max of the set. Default is +10+.
+  def bin_width=(width)
+    raise 'bin_width= should be called before set the data.' unless store.empty?
+
+    @bin_width = width
+  end
+
+  # Specifies minimum value for bin.
+  def minimum_bin=(min)
+    raise 'minimum_bin= should be called before set the data.' unless store.empty?
+
+    @minimum_bin = min
+  end
+
+  # Specifies maximum value for bin.
+  def maximum_bin=(max)
+    raise 'maximum_bin= should be called before set the data.' unless store.empty?
+
+    @maximum_bin = max
+  end
+
+  def data(name, data_points = [], color = nil)
+    bins, freqs = HistogramArray.new(data_points).histogram(bin_width: @bin_width, min: @minimum_bin, max: @maximum_bin)
+    bins.each_with_index do |bin, index|
+      labels[index] = bin
+    end
+    store.add(name, freqs, color)
+  end
+
+  # @private
+  class HistogramArray < Array
+    include ::Histogram
+  end
+end

data/lib/gruff/line.rb

@@ -2,16 +2,18 @@
 
 require 'gruff/base'
 
-# Here's how to make a Line graph:
+#
+# Here's how to make a Gruff::Line.
 #
 #   g = Gruff::Line.new
 #   g.title = "A Line Graph"
 #   g.data 'Fries', [20, 23, 19, 8]
 #   g.data 'Hamburgers', [50, 19, 99, 29]
-#   g.write("test/output/line.png")
+#   g.write("line.png")
 #
 # There are also other options described below, such as {#baseline_value}, {#baseline_color},
 # {#hide_dots}, and {#hide_lines}.
+#
 class Gruff::Line < Gruff::Base
   # Allow for reference lines ( which are like baseline ... just allowing for more & on both axes ).
   attr_accessor :reference_lines

data/lib/gruff/mini/bar.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
-##
 #
 # Makes a small bar graph suitable for display at 200px or even smaller.
 #
+# Here's how to set up a Gruff::Mini::Bar.
+#
+#   g = Gruff::Mini::Bar.new
+#   g.title = 'Mini Bar Graph'
+#   g.data :Art, [0, 5, 8, 15]
+#   g.data :Philosophy, [10, 3, 2, 8]
+#   g.data :Science, [2, 15, 8, 11]
+#   g.write('mini_bar.png')
+#
 module Gruff
   module Mini
     class Bar < Gruff::Bar

data/lib/gruff/mini/pie.rb

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
-##
 #
 # Makes a small pie graph suitable for display at 200px or even smaller.
 #
+# Here's how to set up a Gruff::Mini::Pie.
+#
+#   g = Gruff::Mini::Pie.new
+#   g.title = "Visual Pie Graph Test"
+#   g.data 'Fries', 20
+#   g.data 'Hamburgers', 50
+#   g.write("mini_pie_keynote.png")
+#
 module Gruff
   module Mini
     class Pie < Gruff::Pie

data/lib/gruff/mini/side_bar.rb

@@ -1,8 +1,23 @@
 # frozen_string_literal: true
 
-##
 #
-# Makes a small pie graph suitable for display at 200px or even smaller.
+# Makes a small side bar graph suitable for display at 200px or even smaller.
+#
+# Here's how to set up a Gruff::Mini::SideBar.
+#
+#   g = Gruff::Mini::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('mini_sidebar.png')
 #
 module Gruff
   module Mini

data/lib/gruff/net.rb

@@ -2,7 +2,28 @@
 
 require 'gruff/base'
 
-# Experimental!!! See also the Spider graph.
+# See also the Spider graph.
+#
+# Here's how to make a Gruff::Net.
+#
+#   g = Gruff::Net.new
+#   g.title = "Net Graph"
+#   g.labels = {
+#     0 => '5/6',
+#     1 => '5/15',
+#     2 => '5/24',
+#     3 => '5/30',
+#     4 => '6/4',
+#     5 => '6/12',
+#     6 => '6/21',
+#     7 => '6/28'
+#   }
+#   g.line_width = 3
+#   g.dot_radius = 4
+#   g.data :Jimmy, [25, 36, 86, 39, 25, 31, 79, 88]
+#   g.data :Julie, [22, 29, 35, 38, 36, 40, 46, 57]
+#   g.write("net.png")
+#
 class Gruff::Net < Gruff::Base
   # Hide parts of the graph to fit more datapoints, or for a different appearance.
   attr_accessor :hide_dots

data/lib/gruff/patch/string.rb

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

data/lib/gruff/pie.rb

@@ -2,16 +2,17 @@
 
 require 'gruff/base'
 
-##
-# Here's how to make a Pie graph:
+#
+# 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
 

data/lib/gruff/scatter.rb

@@ -2,12 +2,13 @@
 
 require 'gruff/base'
 
-# Here's how to set up an XY Scatter Chart
+#
+# Here's how to set up a Gruff::Scatter.
 #
 #   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.data :apples, [1,2,3,4], [4,3,2,1]
+#   g.data 'oranges', [5,7,8], [4,1,7]
+#   g.write('scatter.png')
 #
 class Gruff::Scatter < Gruff::Base
   # Maximum X Value. The value will get overwritten by the max in the

data/lib/gruff/side_bar.rb

@@ -3,6 +3,23 @@
 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.
   attr_accessor :bar_spacing
@@ -125,11 +142,7 @@ private
       lbl = @use_data_label ? label : @labels[index]
 
       text_renderer = Gruff::Renderer::Text.new(lbl, font: @font, size: @marker_font_size, color: @font_color)
-      if RUBY_PLATFORM == 'java'
-        text_renderer.render(1, 1, @graph_left - LABEL_MARGIN * 2.0, y_offset, Magick::EastGravity)
-      else
-        text_renderer.render(1, 1, -@graph_left + LABEL_MARGIN * 2.0, y_offset, Magick::EastGravity)
-      end
+      text_renderer.render(@graph_left - LABEL_MARGIN * 2, 1.0, 0.0, y_offset, Magick::EastGravity)
     end
   end
 

data/lib/gruff/side_stacked_bar.rb

@@ -3,10 +3,25 @@
 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
@@ -34,7 +49,7 @@ class Gruff::SideStackedBar < Gruff::SideBar
 
   def draw
     @has_left_labels = true
-    get_maximum_by_stack
+    calculate_maximum_by_stack
     super
   end
 

data/lib/gruff/spider.rb

@@ -4,7 +4,18 @@ require 'gruff/base'
 
 # Experimental!!! See also the Net graph.
 #
-# Submitted by Kevin Clark http://glu.ttono.us/
+# Here's how to set up a Gruff::Spider.
+#
+#   g = Gruff::Spider.new(30)
+#   g.title = "Spider Graph"
+#   g.data :Strength, [10]
+#   g.data :Dexterity, [16]
+#   g.data :Constitution, [12]
+#   g.data :Intelligence, [12]
+#   g.data :Wisdom, [10]
+#   g.data 'Charisma', [16]
+#   g.write("spider.png")
+
 class Gruff::Spider < Gruff::Base
   # Hide all text.
   attr_reader :hide_text

data/lib/gruff/stacked_area.rb

@@ -3,12 +3,22 @@
 require 'gruff/base'
 require 'gruff/helper/stacked_mixin'
 
+#
+# Here's how to set up a Gruff::StackedArea.
+#
+#   g = Gruff::StackedArea.new
+#   g.title = 'StackedArea Graph'
+#   g.data :Jimmy, [25, 36, 86, 39, 25, 31, 79, 88]
+#   g.data :Charles, [80, 54, 67, 54, 68, 70, 90, 95]
+#   g.data :Julie, [22, 29, 35, 38, 36, 40, 46, 57]
+#   g.write('stacked_area.png')
+#
 class Gruff::StackedArea < Gruff::Base
   include StackedMixin
   attr_accessor :last_series_goes_on_bottom
 
   def draw
-    get_maximum_by_stack
+    calculate_maximum_by_stack
     super
 
     return unless data_given?

data/lib/gruff/stacked_bar.rb

@@ -4,6 +4,16 @@ require 'gruff/base'
 require 'gruff/helper/stacked_mixin'
 require 'gruff/helper/bar_value_label_mixin'
 
+#
+# Here's how to set up a Gruff::StackedBar.
+#
+#   g = Gruff::StackedBar.new
+#   g.title = 'StackedBar Graph'
+#   g.data :Art, [0, 5, 8, 15]
+#   g.data :Philosophy, [10, 3, 2, 8]
+#   g.data :Science, [2, 15, 8, 11]
+#   g.write('stacked_bar.png')
+#
 class Gruff::StackedBar < Gruff::Base
   include StackedMixin
   include BarValueLabelMixin
@@ -31,7 +41,7 @@ class Gruff::StackedBar < Gruff::Base
 
   # Draws a bar graph, but multiple sets are stacked on top of each other.
   def draw
-    get_maximum_by_stack
+    calculate_maximum_by_stack
     super
     return unless data_given?
 

data/lib/gruff/store/base_data.rb

@@ -5,7 +5,7 @@ module Gruff
   class Store
     class BaseData < Struct.new(:label, :points, :color)
       def initialize(label, points, color)
-        self.label = label
+        self.label = label.to_s
         self.points = Array(points)
         self.color = color
       end

data/lib/gruff/store/custom_data.rb

@@ -4,7 +4,7 @@ module Gruff
   class Store
     class CustomData < Struct.new(:label, :points, :color, :custom)
       def initialize(label, points, color, custom = nil)
-        self.label = label
+        self.label = label.to_s
         self.points = Array(points)
         self.color = color
         self.custom = custom

data/lib/gruff/store/store.rb

@@ -67,7 +67,7 @@ module Gruff
       @data.reverse!
     end
 
-    def set_colors!(colors)
+    def change_colors(colors)
       index = 0
       @data.each do |data_row|
         data_row.color ||= begin

data/lib/gruff/store/xy_data.rb

@@ -4,7 +4,7 @@ module Gruff
   class Store
     class XYData < Struct.new(:label, :y_points, :color, :x_points)
       def initialize(label, y_points, color, x_points = nil)
-        self.label = label
+        self.label = label.to_s
         self.y_points = Array(y_points)
         self.color = color
         self.x_points = Array(x_points) if x_points

data/lib/gruff/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gruff
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Geoffrey Grosenbach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.81.0
+- !ruby/object:Gem::Dependency
+  name: histogram
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - lib/gruff/helper/bar_conversion.rb
 - lib/gruff/helper/bar_value_label_mixin.rb
 - lib/gruff/helper/stacked_mixin.rb
+- lib/gruff/histogram.rb
 - lib/gruff/line.rb
 - lib/gruff/mini/bar.rb
 - lib/gruff/mini/legend.rb