gruff 0.26.0 → 0.27.0

data/lib/gruff/bezier.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 #
 # Gruff::Bezier is a special line graph that have
 # the bezier curve.
@@ -25,14 +27,15 @@ private
     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)
+    stroke_width = clip_value_if_greater_than(@columns / (store.norm_data.first.points.size * 4.0), 5.0)
 
     store.norm_data.each do |data_row|
-      next if data_row[1].empty?
+      next if data_row.points.empty?
 
       poly_points = []
 
-      data_row[1].each_with_index do |data_point, index|
+      data_row.points.each_with_index do |data_point, index|
+        data_point = data_point.to_f
         # Use incremented x and scaled y
         new_x = @graph_left + (x_increment * index)
         new_y = @graph_top + (@graph_height - (data_point * @graph_height))

data/lib/gruff/box.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 #
 # Here's how to set up a Gruff::Box.
 #
@@ -11,10 +13,10 @@
 #
 class Gruff::Box < Gruff::Base
   # Specifies the filling opacity in area graph. Default is +0.2+.
-  attr_writer :fill_opacity
+  attr_writer :fill_opacity #: Float | Integer
 
   # Specifies the stroke width in line. Default is +3.0+.
-  attr_writer :stroke_width
+  attr_writer :stroke_width #: Float | Integer
 
   # Can be used to adjust the spaces between the bars.
   # Accepts values between 0.00 and 1.00 where 0.00 means no spacing at all
@@ -22,10 +24,12 @@ class Gruff::Box < Gruff::Base
   # line with no x dimension).
   #
   # Default value is +0.8+.
+  #
+  # @rbs space_percent: Float | Integer
   def spacing_factor=(space_percent)
     raise ArgumentError, 'spacing_factor must be between 0.00 and 1.00' if (space_percent < 0) || (space_percent > 1)
 
-    @spacing_factor = (1 - space_percent)
+    @spacing_factor = (1.0 - space_percent)
   end
 
 private
@@ -93,86 +97,106 @@ private
     @normalized_boxes ||= store.norm_data.map { |data| Gruff::Box::BoxData.new(data.label, data.points, data.color) }
   end
 
+  # @rbs return: Integer
   def column_count
     normalized_boxes.size
   end
 
+  # @rbs return: Integer
   def calculate_spacing
     column_count - 1
   end
 
   # @private
-  class BoxData < Struct.new(:label, :points, :color)
+  class BoxData
+    attr_accessor :label #: String
+    attr_accessor :points #: Array[Float | Integer]
+    attr_accessor :color #: String
+
     def initialize(label, points, color)
-      super(label, points.sort, color)
+      @label = label
+      @points = points.compact.sort
+      @color = color
     end
 
+    # @rbs return: Float | Integer
     def min
-      points.first || 0
+      points.first || 0.0
     end
 
+    # @rbs return: Float | Integer
     def max
-      points.last || 0
+      points.last || 0.0
     end
 
+    # @rbs return: Float | Integer
     def min_whisker
       [min, first_quartile - (1.5 * interquartile_range)].max
     end
 
+    # @rbs return: Float | Integer
     def max_whisker
       [max, third_quartile + (1.5 * interquartile_range)].min
     end
 
+    # @rbs return: Float | Integer
     def upper_whisker
       max = max_whisker
       points.select { |point| point <= max }.max
     end
 
+    # @rbs return: Float | Integer
     def lower_whisker
       min = min_whisker
       points.select { |point| point >= min }.min
     end
 
+    # @rbs return: Float
     def median
       if points.empty?
-        0
+        0.0
       elsif points.size.odd?
-        points[points.size / 2]
+        points[points.size / 2].to_f
       else
-        (points[points.size / 2] + points[(points.size / 2) - 1]) / 2.0
+        (points[points.size / 2].to_f + points[(points.size / 2) - 1].to_f) / 2.0
       end
     end
 
+    # @rbs return: Float
     def first_quartile
       if points.empty?
-        0
+        0.0
       elsif points.size.odd?
-        points[points.size / 4]
+        points[points.size / 4].to_f
       else
-        (points[points.size / 4] + points[(points.size / 4) - 1]) / 2.0
+        (points[points.size / 4].to_f + points[(points.size / 4) - 1].to_f) / 2.0
       end
     end
 
+    # @rbs return: Float
     def third_quartile
       if points.empty?
-        0
+        0.0
       elsif points.size.odd?
-        points[(points.size * 3) / 4]
+        points[(points.size * 3) / 4].to_f
       else
-        (points[(points.size * 3) / 4] + points[((points.size * 3) / 4) - 1]) / 2.0
+        (points[(points.size * 3) / 4].to_f + points[((points.size * 3) / 4) - 1].to_f) / 2.0
       end
     end
 
+    # @rbs return: Array[Float | Integer]
     def lower_outliers
       min = lower_whisker
       points.select { |point| point < min }
     end
 
+    # @rbs return: Array[Float | Integer]
     def upper_outliers
       max = upper_whisker
       points.select { |point| point > max }
     end
 
+    # @rbs return: Float | Integer
     def interquartile_range
       third_quartile - first_quartile
     end

data/lib/gruff/bubble.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 #
 # Here's how to set up a Gruff::Bubble.
 #
@@ -9,10 +11,10 @@
 #
 class Gruff::Bubble < Gruff::Scatter
   # Specifies the filling opacity in area graph. Default is +0.6+.
-  attr_writer :fill_opacity
+  attr_writer :fill_opacity #: Float | Integer
 
   # Specifies the stroke width in line. Default is +1.0+.
-  attr_writer :stroke_width
+  attr_writer :stroke_width #: Float | Integer
 
   # The first parameter is the name of the dataset.  The next two are the
   # x and y axis data points contain in their own array in that respective
@@ -53,6 +55,11 @@ class Gruff::Bubble < Gruff::Scatter
   #   g.title = "Bubble Graph"
   #   g.data :A, [-1, 19, -4, -23], [-35, 21, 23, -4], [4.5, 1.0, 2.1, 0.9]
   #
+  # @rbs name: String | Symbol
+  # @rbs x_data_points: Array[nil | Float | Integer] | nil
+  # @rbs y_data_points: Array[nil | Float | Integer] | nil
+  # @rbs point_sizes: Array[nil | Float | Integer] | nil
+  # @rbs color: String
   def data(name, x_data_points = [], y_data_points = [], point_sizes = [], color = nil)
     # make sure it's an array
     x_data_points = Array(x_data_points)

data/lib/gruff/bullet.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 #
 # A bullet graph is a variation of a bar graph.
 # http://en.wikipedia.org/wiki/Bullet_graph
@@ -12,6 +14,8 @@
 #   g.write('bullet.png')
 #
 class Gruff::Bullet < Gruff::Base
+  # @rbs target_width: String | Float | Integer
+  # @rbs return: void
   def initialize(target_width = '400x40')
     super
 
@@ -35,11 +39,14 @@ class Gruff::Bullet < Gruff::Base
   end
   private :initialize_attributes
 
+  # @rbs value: Float | Integer
+  # @rbs maximum_value: Float | Integer
+  # @rbs options: Hash[Symbol, Float | Integer]
   def data(value, maximum_value, options = {})
     @value = value.to_f
     self.maximum_value = maximum_value.to_f
     @options = options
-    @options.map { |k, v| @options[k] = v.to_f if v.is_a?(Numeric) }
+    @options.map { |k, v| @options[k] = v.to_f if v.respond_to?(:to_f) }
   end
 
   def draw

data/lib/gruff/candlestick.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 #
 # Here's how to set up a Gruff::Candlestick.
 #
@@ -12,19 +14,19 @@
 #
 class Gruff::Candlestick < Gruff::Base
   # Allow for vertical marker lines.
-  attr_writer :show_vertical_markers
+  attr_writer :show_vertical_markers #: bool
 
   # Specifies the filling opacity in area graph. Default is +0.4+.
-  attr_writer :fill_opacity
+  attr_writer :fill_opacity #: Float | Integer
 
   # Specifies the stroke width in line. Default is +2.0+.
-  attr_writer :stroke_width
+  attr_writer :stroke_width #: Float | Integer
 
   # Specifies the color with up bar. Default is +'#579773'+.
-  attr_writer :up_color
+  attr_writer :up_color #: String
 
   # Specifies the color with down bar. Default is +'#eb5242'+.
-  attr_writer :down_color
+  attr_writer :down_color #: String
 
   # Can be used to adjust the spaces between the bars.
   # Accepts values between 0.00 and 1.00 where 0.00 means no spacing at all
@@ -32,10 +34,12 @@ class Gruff::Candlestick < Gruff::Base
   # line with no x dimension).
   #
   # Default value is +0.9+.
+  #
+  # @rbs space_percent: Float | Integer
   def spacing_factor=(space_percent)
     raise ArgumentError, 'spacing_factor must be between 0.00 and 1.00' if (space_percent < 0) || (space_percent > 1)
 
-    @spacing_factor = (1 - space_percent)
+    @spacing_factor = (1.0 - space_percent)
   end
 
   # The sort feature is not supported in this graph.
@@ -48,6 +52,10 @@ class Gruff::Candlestick < Gruff::Base
     raise 'Not support #sorted_drawing= in Gruff::Candlestick'
   end
 
+  # @rbs low: Float | Integer
+  # @rbs high: Float | Integer
+  # @rbs open: Float | Integer
+  # @rbs close: Float | Integer
   def data(low:, high:, open:, close:)
     super('', [low, high, open, close])
   end
@@ -99,22 +107,36 @@ private
   end
 
   def normalized_candlesticks
-    @normalized_candlesticks ||= store.norm_data.map { |data| Gruff::Candlestick::CandlestickData.new(*data.points) }
+    @normalized_candlesticks ||= store.norm_data.map { |data| Gruff::Candlestick::CandlestickData.new(*data.points) } # steep:ignore
   end
 
+  # @rbs return: Integer
   def column_count
     normalized_candlesticks.size
   end
 
+  # @rbs return: Integer
   def calculate_spacing
     column_count - 1
   end
 
+  # @rbs return: bool
   def show_marker_vertical_line?
     !@hide_line_markers && @show_vertical_markers
   end
 
   # @private
-  class CandlestickData < Struct.new(:low, :high, :open, :close)
+  class CandlestickData
+    attr_accessor :low
+    attr_accessor :high
+    attr_accessor :open
+    attr_accessor :close
+
+    def initialize(low, high, open, close)
+      @low = low.to_f
+      @high = high.to_f
+      @open = open.to_f
+      @close = close.to_f
+    end
   end
 end

data/lib/gruff/dot.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 #
 # Graph with dots and labels along a vertical access.
 # see: 'Creating More Effective Graphs' by Robbins
@@ -15,9 +17,11 @@
 #
 class Gruff::Dot < Gruff::Base
   # Prevent drawing of column labels below a stacked bar graph.  Default is +false+.
-  attr_writer :hide_labels
+  attr_writer :hide_labels #: bool
 
-  def initialize(*)
+  # @rbs target_width: (String | Float | Integer)
+  # @rbs return: void
+  def initialize(target_width = DEFAULT_TARGET_WIDTH)
     super
     @has_left_labels = true
     @dot_style = 'circle'
@@ -30,14 +34,17 @@ private
     @hide_labels = false
   end
 
+  # @rbs return: bool
   def hide_labels?
     @hide_labels
   end
 
+  # @rbs return: bool
   def hide_left_label_area?
     hide_labels? && @y_axis_label.nil?
   end
 
+  # @rbs return: bool
   def hide_bottom_label_area?
     @hide_line_markers && @x_axis_label.nil? && @legend_at_bottom == false
   end
@@ -53,12 +60,13 @@ private
 
     store.norm_data.each_with_index do |data_row, row_index|
       data_row.points.each_with_index do |data_point, point_index|
-        x_pos = @graph_left + (data_point * @graph_width)
+        x_pos = @graph_left + (data_point.to_f * @graph_width)
         y_pos = @graph_top + (items_width * point_index) + padding + (items_width / 2.0)
 
         if row_index == 0
           Gruff::Renderer::Line.new(renderer, color: @marker_color).render(@graph_left, y_pos, @graph_left + @graph_width, y_pos)
         end
+        next if data_point.nil?
 
         Gruff::Renderer::Dot.new(renderer, @dot_style, color: data_row.color).render(x_pos, y_pos, item_width / 3.0)
 
@@ -88,6 +96,8 @@ private
   ##
   # Draw on the Y axis instead of the X
 
+  # @rbs y_offset: Float | Integer
+  # @rbs index: Integer
   def draw_label(y_offset, index)
     draw_unique_label(index) do
       draw_label_at(@graph_left - @label_margin, 1.0, 0.0, y_offset, @labels[index], gravity: Magick::EastGravity)

data/lib/gruff/font.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 # Handle font setting to draw texts
 class Gruff::Font
   BOLD_PATH = File.expand_path(File.join(__FILE__, '../../../assets/fonts/Roboto-Bold.ttf')).freeze
@@ -9,17 +11,21 @@ class Gruff::Font
   private_constant :REGULAR_PATH
 
   # Get/set font path.
-  attr_accessor :path
+  attr_accessor :path #: String
 
   # Get/set font size.
-  attr_accessor :size
+  attr_accessor :size #: Float | Integer
 
   # Get/set font setting whether render bold text.
-  attr_accessor :bold
+  attr_accessor :bold #: bool
 
   # Get/set font color.
-  attr_accessor :color
+  attr_accessor :color #: String
 
+  # @rbs path: String | nil
+  # @rbs size: Float | Integer
+  # @rbs bold: bool
+  # @rbs color: String
   def initialize(path: nil, size: 20.0, bold: false, color: 'white')
     @path = path
     @bold = bold
@@ -29,11 +35,13 @@ class Gruff::Font
 
   # Get font weight.
   # @return [Magick::WeightType] font weight
+  # TODO: type annotation of return value
   def weight
     @bold ? Magick::BoldWeight : Magick::NormalWeight
   end
 
   # @private
+  # @rbs return: String
   def file_path
     return @path if @path
 

data/lib/gruff/helper/bar_conversion.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 ##
 # Original Author: David Stokar
 #
@@ -13,6 +15,12 @@
 #
 # @private
 class Gruff::BarConversion
+  # @rbs top: Float | Integer
+  # @rbs bottom: Float | Integer
+  # @rbs minimum_value: Float | Integer
+  # @rbs maximum_value: Float | Integer
+  # @rbs spread: Float | Integer
+  # @rbs return: void
   def initialize(top:, bottom:, minimum_value:, maximum_value:, spread:)
     @graph_top = top
     @graph_height = bottom - top
@@ -33,6 +41,8 @@ class Gruff::BarConversion
     end
   end
 
+  # @rbs data_point: Float | Integer
+  # @rbs return: [Float, Float]
   def get_top_bottom_scaled(data_point)
     data_point = data_point.to_f
     result = []
@@ -53,6 +63,7 @@ class Gruff::BarConversion
       result[1] = @graph_top + (@graph_height * (1 - @zero))
     end
 
-    result
+    # TODO: Remove RBS type annotation
+    result #: [Float, Float]
   end
 end

data/lib/gruff/helper/bar_mixin.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 # @private
 module Gruff::Base::BarMixin
+  # @rbs return: Array[Array[Gruff::Base::BarMixin::BarData]]
   def normalized_group_bars
+    # steep:ignore:start
     @normalized_group_bars ||= begin
       group_bars = Array.new(column_count) { [] }
       store.norm_data.each_with_index do |data_row, row_index|
@@ -17,9 +21,23 @@ module Gruff::Base::BarMixin
       end
       group_bars
     end
+    # steep:ignore:end
   end
 
   # @private
-  class BarData < Struct.new(:point, :value, :color)
+  class BarData
+    attr_accessor :point #: Float | Integer
+    attr_accessor :value #: nil | Float | Integer
+    attr_accessor :color #: String
+
+    # @rbs point: Float | Integer
+    # @rbs value: nil | Float | Integer
+    # @rbs color: String
+    # @rbs return: void
+    def initialize(point, value, color)
+      @point = point
+      @value = value
+      @color = color
+    end
   end
 end

data/lib/gruff/helper/bar_value_label.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 # @private
 module Gruff::BarValueLabel
   using String::GruffCommify
 
   # @private
+  #
+  # @rbs value: Float | Integer
+  # @rbs format: nil | String | Proc
+  # @rbs proc_text_metrics: Proc
+  # @rbs return: [String, untyped]
+  # TODO: Fix the return type
   def self.metrics(value, format, proc_text_metrics)
     val = begin
       if format.is_a?(Proc)
         format.call(value)
       else
-        sprintf(format || '%.2f', value).commify
+        sprintf(format || '%.2f', value).commify # steep:ignore
       end
     end
 
@@ -20,8 +28,12 @@ module Gruff::BarValueLabel
 
   # @private
   class Base
-    attr_reader :coordinate, :value
+    attr_reader :coordinate #: [Float | Integer, Float | Integer, Float | Integer, Float | Integer]
+    attr_reader :value #: Float | Integer
 
+    # @rbs coordinate: [nil | Float | Integer, nil | Float | Integer, nil | Float | Integer, nil | Float | Integer]
+    # @rbs value: Float | Integer
+    # @rbs return: void
     def initialize(coordinate, value)
       @coordinate = coordinate
       @value = value
@@ -30,22 +42,28 @@ module Gruff::BarValueLabel
 
   # @private
   class Bar < Base
+    # @rbs format: nil | String | Proc
+    # @rbs proc_text_metrics: Proc
+    # @rbs &: (Float | Integer, Float | Integer, String, Float, Float) -> void
     def prepare_rendering(format, proc_text_metrics)
       left_x, left_y, _right_x, _right_y = @coordinate
       val, metrics = Gruff::BarValueLabel.metrics(@value, format, proc_text_metrics)
 
-      y = @value >= 0 ? left_y - metrics.height - 5 : left_y + 5
+      y = @value >= 0 ? left_y - metrics.height - 5 : left_y + 5 #: Float
       yield left_x, y, val, metrics.width, metrics.height
     end
   end
 
   # @private
   class SideBar < Base
+    # @rbs format: nil | String | Proc
+    # @rbs proc_text_metrics: Proc
+    # @rbs &: (Float | Integer, Float | Integer, String, Float, Float) -> void
     def prepare_rendering(format, proc_text_metrics)
       left_x, left_y, right_x, _right_y = @coordinate
       val, metrics = Gruff::BarValueLabel.metrics(@value, format, proc_text_metrics)
 
-      x = @value >= 0 ? right_x + 10 : left_x - metrics.width - 10
+      x = @value >= 0 ? right_x + 10 : left_x - metrics.width - 10 #: Float
       yield x, left_y, val, metrics.width, metrics.height
     end
   end

data/lib/gruff/helper/stacked_mixin.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 # @private
 module Gruff::Base::StackedMixin
   # Used by StackedBar and child classes.
   #
   # tsal: moved from Base 03 FEB 2007
   def calculate_maximum_by_stack
+    # steep:ignore:start
     # Get sum of each stack
     max_hash = Hash.new { |h, k| h[k] = 0.0 }
     store.data.each do |data_set|
@@ -20,9 +23,12 @@ module Gruff::Base::StackedMixin
     end
 
     raise "Can't handle negative values in stacked graph" if minimum_value < 0
+    # steep:ignore:end
   end
 
+  # @rbs return: Array[Array[Gruff::Base::StackedMixin::BarData]]
   def normalized_stacked_bars
+    # steep:ignore:start
     @normalized_stacked_bars ||= begin
       stacked_bars = Array.new(column_count) { [] }
       store.norm_data.each_with_index do |data_row, row_index|
@@ -32,9 +38,23 @@ module Gruff::Base::StackedMixin
       end
       stacked_bars
     end
+    # steep:ignore:end
   end
 
   # @private
-  class BarData < Struct.new(:point, :value, :color)
+  class BarData
+    attr_accessor :point #: Float | Integer
+    attr_accessor :value #: Float | Integer
+    attr_accessor :color #: String
+
+    # @rbs point: Float | Integer
+    # @rbs value: Float | Integer
+    # @rbs color: String
+    # @rbs return: void
+    def initialize(point, value, color)
+      @point = point
+      @value = value
+      @color = color
+    end
   end
 end