gruff 0.11.0-java → 0.12.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2eb363f545e171df5a5d457b5d34e867a060dc4d84eda87d77b2447172d2c04
-  data.tar.gz: fa7708d508f2a016c11af3c08d2b877ff65eaf62955658c9b57fbd08b9f45659
+  metadata.gz: 86f7128ad67d7111e7f286742bef3ec55674923f120f7b53747c2aeb19011aa7
+  data.tar.gz: 8a8554f44e0c642a04d2aa87763696be6cba4d207e7bd33a8945df860fac9246
 SHA512:
-  metadata.gz: 06d22482b55dd1f478f9ad8ae660f8fe96a4f4b8c7f651207b3de2d1cacf9c1399cf6d88ebd3fdad3178acb020371924f189fa86ee6107d240850788dd9156f3
-  data.tar.gz: 61461cbe1691e7aec5a6c178778c0f40ede97d496857f6a797867be3ae6f52565b33ad8556654ce592aec2717e11e7512bf2cfb25e7cfcdff9797da1faeb9b01
+  metadata.gz: c4c709368e7a3cb96390099e7577df107343e179005c374dda3ad0f1ec981304f556eea435c71b50214e622a11544c4bb7ca6ec8519af41616c9b463c69940ec
+  data.tar.gz: 19528b2ac748979d5acb64c7fd8ff3c66d819d03754249398ab4daacb16a44bac28afad60db20eac1c8b4e4b94e610508702c45c035e49da241847a4e42f834f

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.12.0
+- Mark Gruff::Base#to_blob as deprecated (#473)
+- Add Gruff::Base#to_image method (#472)
+- Drop support of Ruby v2.3.x or below (#453, #448)
+- add hide_labels to stacked side bar graphs (#452)
+- add hide_labels to side bar graphs (#451)
+- add hide_labels to stacked bar graphs (#450)
+- support hide_labels separate from hide_line_markers for bar graphs only (#446)
+
 ## 0.11.0
 - Fix regression in empty data handling (#445)
 - Rendering text in front most (#439)

data/gruff.gemspec

@@ -13,7 +13,9 @@ Gem::Specification.new do |s|
   s.date = Date.today.to_s
   s.description = 'Beautiful graphs for one or multiple datasets. Can be used on websites or in documents.'
   s.email = 'boss@topfunky.com'
-  s.files = `git ls-files`.split($/).reject { |f| f =~ /^test/ }
+  s.files = `git ls-files`.split.reject do |f|
+    f =~ /^\.|^test|^docker|^Rakefile/
+  end
   s.homepage = 'https://github.com/topfunky/gruff'
   s.require_paths = %w[lib]
   s.summary = 'Beautiful graphs for one or multiple datasets.'
@@ -27,12 +29,14 @@ Gem::Specification.new do |s|
     s.add_dependency 'rmagick4j'
   else
     s.add_dependency 'rmagick'
-    s.add_development_dependency 'rubocop', '~> 0.81.0'
+    s.add_development_dependency 'rubocop', '~> 1.0.0'
+    s.add_development_dependency 'rubocop-performance', '~> 1.8'
   end
   s.add_dependency 'histogram'
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.4.0'
 
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'parallel'
   s.add_development_dependency 'minitest-reporters'
   s.add_development_dependency 'yard', '~> 0.9.25'
 end

data/lib/gruff.rb

@@ -9,8 +9,13 @@ require 'gruff/version'
   patch/rmagick
   patch/string
 
-  themes
   base
+
+  helper/bar_conversion.rb
+  helper/stacked_mixin
+  helper/bar_value_label_mixin
+
+  themes
   area
   bar
   bezier
@@ -22,10 +27,10 @@ require 'gruff/version'
   pie
   scatter
   spider
+  side_bar
   stacked_area
   stacked_bar
   side_stacked_bar
-  side_bar
   accumulator_bar
 
   scene
@@ -43,7 +48,7 @@ require 'gruff/version'
   renderer/text
 
   store/store
-  store/base_data
+  store/basic_data
   store/custom_data
   store/xy_data
 

data/lib/gruff/accumulator_bar.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
 #
 # Gruff::AccumulatorBar is a special bar graph that shows a
 # single dataset as a set of stacked bars.

data/lib/gruff/area.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
 #
 # Gruff::Area provides an area graph which displays graphically
 # quantitative data.
@@ -59,7 +57,5 @@ class Gruff::Area < Gruff::Base
 
       Gruff::Renderer::Polygon.new(color: data_row.color, width: @stroke_width, opacity: @fill_opacity).render(poly_points)
     end
-
-    Gruff::Renderer.finish
   end
 end

data/lib/gruff/bar.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-require 'gruff/helper/bar_conversion'
-
 #
 # Gruff::Bar provide a bar graph that presents categorical data
 # with rectangular bars.
@@ -19,6 +16,8 @@ require 'gruff/helper/bar_conversion'
 #   g.write('bar.png')
 #
 class Gruff::Bar < Gruff::Base
+  using String::GruffCommify
+
   # Spacing factor applied between bars.
   attr_writer :bar_spacing
 
@@ -33,12 +32,16 @@ class Gruff::Bar < Gruff::Base
   # Default is +false+.
   attr_writer :show_labels_for_bar_values
 
+  # Prevent drawing of column labels below a bar graph.  Default is +false+.
+  attr_writer :hide_labels
+
   def initialize_ivars
     super
     @spacing_factor = 0.9
     @group_spacing = 10
     @label_formatting = nil
     @show_labels_for_bar_values = false
+    @hide_labels = false
   end
   private :initialize_ivars
 
@@ -68,6 +71,18 @@ class Gruff::Bar < Gruff::Base
 
 protected
 
+  def hide_labels?
+    @hide_labels
+  end
+
+  def hide_left_label_area?
+    @hide_line_markers
+  end
+
+  def hide_bottom_label_area?
+    hide_labels?
+  end
+
   def draw_bars
     # Setup spacing.
     #
@@ -129,8 +144,6 @@ protected
 
     # Draw the last label if requested
     draw_label(@graph_right, column_count, Magick::NorthWestGravity) if @center_labels_over_point
-
-    Gruff::Renderer.finish
   end
 
   def calculate_spacing

data/lib/gruff/base.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'rmagick'
 require 'bigdecimal'
 
 ##
@@ -17,6 +16,9 @@ require 'bigdecimal'
 #
 # See {Gruff::Base#theme=} for setting themes.
 module Gruff
+  using String::GruffCommify
+
+  # A common base class inherited from class of drawing a graph.
   class Base
     # Space around text elements. Mostly used for vertical spacing.
     LEGEND_MARGIN = TITLE_MARGIN = 20.0
@@ -195,11 +197,11 @@ module Gruff
     protected :initialize_graph_scale
 
     def initialize_store
-      @store = Gruff::Store.new(Gruff::Store::BaseData)
+      @store = Gruff::Store.new(Gruff::Store::BasicData)
     end
     protected :initialize_store
 
-    # Initialize instance variable of attribures
+    # Initialize instance variable of attributes
     #
     # Subclasses can override this, call super, then set values separately.
     #
@@ -414,16 +416,40 @@ module Gruff
     # @example
     #   write('graphs/my_pretty_graph.png')
     def write(file_name = 'graph.png')
-      draw
-      Gruff::Renderer.write(file_name)
+      to_image.write(file_name)
+    end
+
+    # Return a rendered graph image.
+    # This can use RMagick's methods to adjust the image before saving.
+    #
+    # @return [Magick::Image] The rendered image.
+    #
+    # @example
+    #   g = Gruff::Line.new
+    #   g.data :Jimmy, [25, 36, 86, 39, 25, 31, 79, 88]
+    #   g.data :Charles, [80, 54, 67, 54, 68, 70, 90, 95]
+    #   image = g.to_image
+    #   image = image.resize(400, 300).quantize(128, Magick::RGBColorspace)
+    #   image.write('test.png')
+    #
+    def to_image
+      @to_image ||= begin
+        draw
+        Gruff::Renderer.finish
+        Gruff::Renderer.instance.image
+      end
     end
 
     # Return the graph as a rendered binary blob.
     #
     # @param image_format [String] The image format of binary blob.
+    #
+    # @deprecated Please use +to_image.to_blob+ instead.
     def to_blob(image_format = 'PNG')
-      draw
-      Gruff::Renderer.to_blob(image_format)
+      warn '#to_blob is deprecated. Please use `to_image.to_blob` instead'
+      to_image.to_blob do
+        self.format = image_format
+      end
     end
 
   protected
@@ -486,6 +512,18 @@ module Gruff
       store.columns
     end
 
+    def marker_count
+      @marker_count ||= begin
+        count = nil
+        (3..7).each do |lines|
+          if @spread.to_f % lines == 0.0
+            count = lines and break
+          end
+        end
+        count || 4
+      end
+    end
+
     # Make copy of data with values scaled between 0-100
     def normalize
       store.normalize(minimum: minimum_value, spread: @spread)
@@ -500,6 +538,18 @@ module Gruff
       @hide_title || @title.nil? || @title.empty?
     end
 
+    def hide_labels?
+      @hide_line_markers
+    end
+
+    def hide_left_label_area?
+      @hide_line_markers
+    end
+
+    def hide_bottom_label_area?
+      @hide_line_markers
+    end
+
     ##
     # Calculates size of drawable area, general font dimensions, etc.
 
@@ -545,7 +595,7 @@ module Gruff
       increment_scaled = @graph_height.to_f / (@spread / @increment)
 
       # Draw horizontal line markers and annotate with numbers
-      (0..@marker_count).each do |index|
+      (0..marker_count).each do |index|
         y = @graph_top + @graph_height - index.to_f * increment_scaled
 
         line_renderer = Gruff::Renderer::Line.new(color: @marker_color, shadow_color: @marker_shadow_color)
@@ -560,13 +610,6 @@ module Gruff
       end
     end
 
-    # Return the sum of values in an array.
-    #
-    # Duplicated to not conflict with active_support in Rails.
-    def sum(arr)
-      arr.reduce(0) { |i, m| m + i }
-    end
-
     # Return a calculation of center
     def center(size)
       (@raw_columns - size) / 2
@@ -581,7 +624,7 @@ module Gruff
       legend_square_width = @legend_box_size # small square with color of this item
       label_widths = calculate_legend_label_widths_for_each_line(legend_labels, legend_square_width)
 
-      current_x_offset = center(sum(label_widths.first))
+      current_x_offset = center(label_widths.first.sum)
       current_y_offset = begin
         if @legend_at_bottom
           @graph_height + @title_margin
@@ -611,7 +654,7 @@ module Gruff
         # Handle wrapping
         if label_widths.first.empty?
           label_widths.shift
-          current_x_offset = center(sum(label_widths.first)) unless label_widths.empty?
+          current_x_offset = center(label_widths.first.sum) unless label_widths.empty?
           line_height = [@legend_caps_height, legend_square_width].max + @legend_margin
           unless label_widths.empty?
             # Wrap to next line and shrink available graph dimensions
@@ -661,7 +704,7 @@ module Gruff
     end
 
     def draw_unique_label(index)
-      return if @hide_line_markers
+      return if hide_labels?
 
       @labels_seen ||= {}
       if !@labels[index].nil? && @labels_seen[index].nil?
@@ -746,7 +789,7 @@ module Gruff
   private
 
     def setup_marker_caps_height
-      @hide_line_markers ? 0 : calculate_caps_height(@marker_font_size)
+      hide_bottom_label_area? ? 0 : calculate_caps_height(@marker_font_size)
     end
 
     def setup_title_caps_height
@@ -769,15 +812,18 @@ module Gruff
     end
 
     def setup_left_margin
-      return @left_margin if @hide_line_markers
+      return @left_margin if hide_left_label_area?
 
-      if @has_left_labels
-        longest_left_label_width = calculate_width(@marker_font_size,
-                                                   @labels.values.reduce('') { |value, memo| (value.to_s.length > memo.to_s.length) ? value : memo }) * 1.25
-      else
-        longest_left_label_width = calculate_width(@marker_font_size,
-                                                   label(maximum_value.to_f, @increment))
+      text = begin
+        if @has_left_labels
+          @labels.values.reduce('') { |value, memo| (value.to_s.length > memo.to_s.length) ? value : memo }
+        else
+          label(maximum_value.to_f, @increment)
+        end
       end
+      longest_left_label_width = calculate_width(@marker_font_size, text)
+      longest_left_label_width *= 1.25 if @has_left_labels
+
       # Shift graph if left line numbers are hidden
       line_number_width = @hide_line_numbers && !@has_left_labels ? 0.0 : (longest_left_label_width + LABEL_MARGIN * 2)
 
@@ -795,7 +841,7 @@ module Gruff
     end
 
     def setup_bottom_margin
-      graph_bottom_margin = @hide_line_markers ? @bottom_margin : @bottom_margin + @marker_caps_height + LABEL_MARGIN
+      graph_bottom_margin = hide_bottom_label_area? ? @bottom_margin : @bottom_margin + @marker_caps_height + LABEL_MARGIN
 
       x_axis_label_height = @x_axis_label.nil? ? 0.0 : @marker_caps_height + LABEL_MARGIN
       # FIXME: Consider chart types other than bar
@@ -831,7 +877,7 @@ module Gruff
                 else
                   value.to_s
                 end
-              elsif (@spread.to_f % (@marker_count.to_f == 0 ? 1 : @marker_count.to_f) == 0) || !@y_axis_increment.nil?
+              elsif (@spread.to_f % (marker_count.to_f == 0 ? 1 : marker_count.to_f) == 0) || !@y_axis_increment.nil?
                 value.to_i.to_s
               elsif @spread > 10.0
                 sprintf('%0i', value)
@@ -854,7 +900,7 @@ module Gruff
         label_width = width + legend_square_width * 2.7
         label_widths.last.push label_width
 
-        if sum(label_widths.last) > (@raw_columns * 0.9)
+        if label_widths.last.sum > (@raw_columns * 0.9)
           label_widths.push [label_widths.last.pop]
         end
       end
@@ -872,7 +918,7 @@ module Gruff
       metrics.height
     end
 
-    # Returns the width of a string at this pointsize.
+    # Returns the width of a string at this point size.
     #
     # Not scaled since it deals with dimensions that the regular
     # scaling will handle.
@@ -889,19 +935,10 @@ 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
-        if @marker_count.nil?
-          (3..7).each do |lines|
-            if @spread % lines == 0.0
-              @marker_count = lines
-              break
-            end
-          end
-          @marker_count ||= 4
-        end
-        @increment = (@spread > 0 && @marker_count > 0) ? significant(@spread / @marker_count) : 1
+        @increment = (@spread > 0 && marker_count > 0) ? significant(@spread / marker_count) : 1
       else
         # TODO: Make this work for negative values
-        @marker_count = (@spread / @y_axis_increment).to_i
+        self.marker_count = (@spread / @y_axis_increment).to_i
         @increment = @y_axis_increment
       end
     end

data/lib/gruff/bezier.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-
 #
 # Gruff::Bezier is a special line graph that have
 # the bezier curve.
@@ -55,7 +53,5 @@ class Gruff::Bezier < Gruff::Base
         Gruff::Renderer::Bezier.new(color: data_row.color, width: stroke_width).render(poly_points)
       end
     end
-
-    Gruff::Renderer.finish
   end
 end

data/lib/gruff/bullet.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'gruff/base'
-require 'gruff/themes'
-
 #
 # A bullet graph is a variation of a bar graph.
 # http://en.wikipedia.org/wiki/Bullet_graph
@@ -16,6 +13,8 @@ require 'gruff/themes'
 #
 class Gruff::Bullet < Gruff::Base
   def initialize(target_width = '400x40')
+    super
+
     if target_width.is_a?(String)
       @columns, @rows = target_width.split('x').map(&:to_f)
     else
@@ -25,10 +24,6 @@ class Gruff::Bullet < Gruff::Base
     @columns.freeze
     @rows.freeze
 
-    initialize_graph_scale
-    initialize_ivars
-    initialize_store
-
     self.theme = Gruff::Themes::GREYSCALE
   end
 
@@ -88,8 +83,6 @@ class Gruff::Bullet < Gruff::Base
     # Value
     rect_renderer = Gruff::Renderer::Rectangle.new(color: @font_color)
     rect_renderer.render(graph_left, thickness, graph_left + graph_width * (@value / maximum_value), thickness * 2)
-
-    Gruff::Renderer.finish
   end
 
 private