gruff 0.26.0 → 0.27.0

data/lib/gruff/renderer/polygon.rb

@@ -3,6 +3,11 @@
 module Gruff
   # @private
   class Renderer::Polygon
+    # @rbs renderer: Gruff::Renderer
+    # @rbs color: String
+    # @rbs width: Float | Integer
+    # @rbs opacity: Float | Integer
+    # @rbs return: void
     def initialize(renderer, color:, width: 1.0, opacity: 1.0)
       @renderer = renderer
       @color = color
@@ -10,6 +15,7 @@ module Gruff
       @opacity = opacity
     end
 
+    # @rbs points: Array[Float | Integer]
     def render(points)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)

data/lib/gruff/renderer/polyline.rb

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer::Polyline
+    # @rbs renderer: Gruff::Renderer
+    # @rbs color: String
+    # @rbs width: Float | Integer
+    # @rbs linejoin: String
+    # @rbs return: void
     def initialize(renderer, color:, width: 1.0, linejoin: 'bevel')
       @renderer = renderer
       @color = color
@@ -10,6 +17,7 @@ module Gruff
       @linejoin = linejoin
     end
 
+    # @rbs points: Array[Float | Integer]
     def render(points)
       @renderer.draw.push
       @renderer.draw.stroke_linejoin(@linejoin)

data/lib/gruff/renderer/rectangle.rb

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer::Rectangle
+    # @rbs renderer: Gruff::Renderer
+    # @rbs color: String
+    # @rbs width: Float | Integer
+    # @rbs opacity: Float | Integer
+    # @rbs return: void
     def initialize(renderer, color: nil, width: 1.0, opacity: 1.0)
       @renderer = renderer
       @color = color
@@ -10,6 +17,10 @@ module Gruff
       @opacity = opacity
     end
 
+    # @rbs upper_left_x: Float | Integer
+    # @rbs upper_left_y: Float | Integer
+    # @rbs lower_right_x: Float | Integer
+    # @rbs lower_right_y: Float | Integer
     def render(upper_left_x, upper_left_y, lower_right_x, lower_right_y)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)

data/lib/gruff/renderer/renderer.rb

@@ -1,11 +1,20 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer
-    attr_accessor :text_renderers
-    attr_reader :draw, :image, :scale
-
+    attr_accessor :text_renderers #: Array[Gruff::Renderer::Text]
+    attr_reader :draw
+    attr_reader :image
+    attr_reader :scale #: real
+
+    # @rbs columns: Integer
+    # @rbs rows: Integer
+    # @rbs scale: Float | Integer
+    # @rbs theme_options: ::Hash[Symbol, untyped]
+    # @rbs return: void
     def initialize(columns, rows, scale, theme_options)
       @draw = Magick::Draw.new
       @text_renderers = []
@@ -23,6 +32,8 @@ module Gruff
       end
     end
 
+    # @rbs columns: Integer
+    # @rbs rows: Integer
     def transparent_background(columns, rows)
       @image = render_transparent_background(columns, rows)
     end
@@ -30,11 +41,11 @@ module Gruff
   private
 
     def background(columns, rows, scale, theme_options)
-      return image_background(scale, *theme_options[:background_image]) if theme_options[:background_image]
+      return image_background(scale, *theme_options[:background_image]) if theme_options[:background_image] # steep:ignore
 
       case theme_options[:background_colors]
       when Array
-        gradated_background(columns, rows, *theme_options[:background_colors][0..1], theme_options[:background_direction])
+        gradated_background(columns, rows, *theme_options[:background_colors][0..1], theme_options[:background_direction]) # steep:ignore
       when String
         solid_background(columns, rows, theme_options[:background_colors])
       else

data/lib/gruff/renderer/text.rb

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer::Text
     using Magick::GruffAnnotate
 
+    # @rbs renderer: Gruff::Renderer
+    # @rbs text: String
+    # @rbs font: Gruff::Font
+    # @rbs rotation: Float | Integer
     def initialize(renderer, text, font:, rotation: nil)
       @renderer = renderer
       @text = text.to_s
@@ -12,8 +18,14 @@ module Gruff
       @rotation = rotation
     end
 
-    attr_reader :width, :height, :x, :y, :gravity
+    attr_reader :width, :height, :x, :y #: Float | Integer
+    attr_reader :gravity
 
+    # @rbs width: Float | Integer
+    # @rbs height: Float | Integer
+    # @rbs x: Float | Integer
+    # @rbs y: Float | Integer
+    # @rbs gravity: untyped
     def add_to_render_queue(width, height, x, y, gravity = Magick::NorthGravity)
       @width = width
       @height = height
@@ -24,6 +36,11 @@ module Gruff
       @renderer.text_renderers << self
     end
 
+    # @rbs width: Float | Integer
+    # @rbs height: Float | Integer
+    # @rbs x: Float | Integer
+    # @rbs y: Float | Integer
+    # @rbs gravity: untyped
     def render(width, height, x, y, gravity = Magick::NorthGravity)
       @renderer.draw.push
       @renderer.draw.rotation = @rotation if @rotation
@@ -51,7 +68,7 @@ module Gruff
       # This format is used to embed value into a string using image properties.
       # However, gruff use plain image as canvas which does not have any property.
       # So, in here, it just escape % in order to avoid SEGV.
-      text = @text.to_s.gsub(/(%+)/) { ('%' * Regexp.last_match(1).size * 2).to_s }
+      text = @text.to_s.gsub(/(%+)/) { ('%' * Regexp.last_match(1).size * 2).to_s } # steep:ignore
 
       metrics = @renderer.draw.get_type_metrics(@renderer.image, text)
       @renderer.draw.pop

data/lib/gruff/scatter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 #
 # Here's how to set up a Gruff::Scatter.
 #
@@ -11,21 +13,21 @@
 class Gruff::Scatter < Gruff::Base
   # Maximum X Value. The value will get overwritten by the max in the
   # datasets.
-  attr_writer :maximum_x_value
+  attr_writer :maximum_x_value #: Float | Integer
 
   # Minimum X Value. The value will get overwritten by the min in the
   # datasets.
-  attr_writer :minimum_x_value
+  attr_writer :minimum_x_value #: Float | Integer
 
   # The number of vertical lines shown for reference.
-  attr_writer :marker_x_count
+  attr_writer :marker_x_count #: Integer
 
   # Attributes to allow customising the size of the points.
-  attr_writer :circle_radius
-  attr_writer :stroke_width
+  attr_writer :circle_radius #: Float | Integer
+  attr_writer :stroke_width #: Float | Integer
 
   # Allow for vertical marker lines.
-  attr_writer :show_vertical_markers
+  attr_writer :show_vertical_markers #: bool
 
   # Allow enabling vertical lines. When you have a lot of data, they can work great.
   # @deprecated Please use {#show_vertical_markers=} instead.
@@ -87,6 +89,10 @@ class Gruff::Scatter < Gruff::Base
   #   g.data('oranges', [1,1,1], [2,3,4])
   #   g.data('bitter_melon', [3,5,6], [6,7,8], '#000000')
   #
+  # @rbs name: String | Symbol
+  # @rbs x_data_points: Array[nil | Float | Integer] | nil
+  # @rbs y_data_points: Array[nil | Float | Integer] | nil
+  # @rbs color: String
   def data(name, x_data_points = [], y_data_points = [], color = nil)
     # make sure it's an array
     x_data_points = Array(x_data_points)
@@ -142,8 +148,8 @@ private
   end
 
   def draw_graph
-    stroke_width  = @stroke_width  || clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 4.0), 5.0)
-    circle_radius = @circle_radius || clip_value_if_greater_than(@columns / (store.norm_data.first[1].size * 2.5), 5.0)
+    stroke_width  = @stroke_width  || clip_value_if_greater_than(@columns / (store.norm_data.first.x_points.size * 4.0), 5.0)
+    circle_radius = @circle_radius || clip_value_if_greater_than(@columns / (store.norm_data.first.x_points.size * 2.5), 5.0)
 
     store.norm_data.each do |data_row|
       data_row.coordinates.each do |x_value, y_value|
@@ -195,6 +201,7 @@ private
     end
   end
 
+  # @rbs return: Integer
   def marker_x_count
     # TODO: Do the same for larger numbers...100, 75, 50, 25
     @marker_x_count ||= begin
@@ -212,6 +219,7 @@ private
     end
   end
 
+  # @rbs return: Float | Integer | BigDecimal
   def x_increment
     @x_increment ||= begin
       if @x_axis_increment.nil?

data/lib/gruff/side_bar.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require_relative 'helper/bar_mixin'
 
 # Graph with individual horizontal bars instead of vertical bars.
@@ -21,30 +23,32 @@ require_relative 'helper/bar_mixin'
 #   g.write('sidebar.png')
 #
 class Gruff::SideBar < Gruff::Base
-  include BarMixin
+  include Gruff::Base::BarMixin
 
   # Spacing factor applied between bars.
-  attr_writer :bar_spacing
+  attr_writer :bar_spacing #: Float | Integer
 
   # Spacing factor applied between a group of bars belonging to the same label.
-  attr_writer :group_spacing
+  attr_writer :group_spacing #: Float | Integer
 
   # Set the number output format string or lambda.
   # Default is +"%.2f"+.
-  attr_writer :label_formatting
+  attr_writer :label_formatting #: nil | String | Proc
 
   # Output the values for the bars on a bar graph.
   # Default is +false+.
-  attr_writer :show_labels_for_bar_values
+  attr_writer :show_labels_for_bar_values #: bool
 
   # Prevent drawing of column labels left of a side bar graph.  Default is +false+.
-  attr_writer :hide_labels
+  attr_writer :hide_labels #: bool
 
   # Value to avoid completely overwriting the coordinate axis
   AXIS_MARGIN = 0.5
   private_constant :AXIS_MARGIN
 
-  def initialize(*)
+  # @rbs target_width: (String | Float | Integer)
+  # @rbs return: void
+  def initialize(target_width = DEFAULT_TARGET_WIDTH)
     super
     @has_left_labels = true
   end
@@ -66,14 +70,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
@@ -103,7 +110,7 @@ private
     #
     bars_width = (@graph_height - calculate_spacing) / column_count
     bar_width = bars_width / store.length
-    padding = (bar_width * (1 - @bar_spacing)) / 2
+    padding = (bar_width * (1.0 - @bar_spacing)) / 2
 
     # Setup the BarConversion Object
     conversion = Gruff::BarConversion.new(
@@ -114,12 +121,12 @@ private
     group_left_y = @graph_top
 
     normalized_group_bars.each_with_index do |group_bars, group_index|
-      right_y = 0
+      right_y = 0.0
       group_bars.each_with_index do |bar, index|
         left_y = group_left_y + (bar_width * index) + padding
         right_y = left_y + (bar_width * @bar_spacing)
 
-        bottom_x, top_x = conversion.get_top_bottom_scaled(bar.point).sort
+        bottom_x, top_x = conversion.get_top_bottom_scaled(bar.point).sort #: [Float, Float]
         if bottom_x != top_x
           rect_renderer = Gruff::Renderer::Rectangle.new(renderer, color: bar.color)
           rect_renderer.render(bottom_x + AXIS_MARGIN, left_y, top_x, right_y)
@@ -175,10 +182,12 @@ private
     end
   end
 
+  # @rbs return: Float | Integer
   def calculate_spacing
     @group_spacing * (column_count - 1)
   end
 
+  # @rbs return: Proc
   def proc_text_metrics
     ->(text) { text_metrics(@marker_font, text) }
   end

data/lib/gruff/side_stacked_bar.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require_relative 'helper/stacked_mixin'
 
 #
@@ -22,26 +24,28 @@ require_relative 'helper/stacked_mixin'
 #   g.write('side_stacked_bar.png')
 #
 class Gruff::SideStackedBar < Gruff::SideBar
-  include StackedMixin
+  include Gruff::Base::StackedMixin
 
   # Spacing factor applied between bars.
-  attr_writer :bar_spacing
+  attr_writer :bar_spacing #: Float | Integer
 
   # Number of pixels between bar segments.
-  attr_writer :segment_spacing
+  attr_writer :segment_spacing #: Float | Integer
 
   # Set the number output format string or lambda.
   # Default is +"%.2f"+.
-  attr_writer :label_formatting
+  attr_writer :label_formatting #: nil | String | Proc
 
   # Output the values for the bars on a bar graph.
   # Default is +false+.
-  attr_writer :show_labels_for_bar_values
+  attr_writer :show_labels_for_bar_values #: bool
 
   # Prevent drawing of column labels left of a side 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
   end
@@ -68,7 +72,7 @@ private
     #
     # Columns sit stacked.
     bar_width = @graph_height / column_count
-    padding = (bar_width * (1 - @bar_spacing)) / 2
+    padding = (bar_width * (1.0 - @bar_spacing)) / 2
 
     # Setup the BarConversion Object
     conversion = Gruff::BarConversion.new(
@@ -79,13 +83,13 @@ private
     proc_text_metrics = ->(text) { text_metrics(@marker_font, text) }
 
     normalized_stacked_bars.each_with_index do |stacked_bars, stacked_index|
-      total = 0
+      total = 0.0
       left_y = @graph_top + (bar_width * stacked_index) + padding
       right_y = left_y + (bar_width * @bar_spacing)
 
-      top_x = 0
+      top_x = 0.0
       stacked_bars.each do |bar|
-        next if bar.point == 0
+        next if bar.point.nil? || bar.point == 0
 
         bottom_x, = conversion.get_top_bottom_scaled(total)
         bottom_x += @segment_spacing

data/lib/gruff/spider.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 # Experimental!!! See also the Net graph.
 #
 # Here's how to set up a Gruff::Spider.
@@ -16,14 +18,18 @@
 #
 class Gruff::Spider < Gruff::Base
   # Hide all text.
-  attr_writer :hide_axes
-  attr_writer :rotation
+  attr_writer :hide_axes #: bool
+  attr_writer :rotation #: Float | Integer
 
+  # @rbs max_value: Float | Integer
+  # @rbs target_width: (String | Float | Integer)
+  # @rbs return: void
   def initialize(max_value, target_width = 800)
     super(target_width)
     @max_value = max_value
   end
 
+  # @rbs value: bool
   def hide_text=(value)
     @hide_title = @hide_text = value
   end
@@ -82,6 +88,7 @@ private
     draw_polygon(center_x, center_y, additive_angle)
   end
 
+  # @rbs value: nil | Float | Integer
   def normalize_points(value)
     value.to_f * @unit_length
   end

data/lib/gruff/stacked_area.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require_relative 'helper/stacked_mixin'
 
 #
@@ -13,7 +15,7 @@ require_relative 'helper/stacked_mixin'
 #   g.write('stacked_area.png')
 #
 class Gruff::StackedArea < Gruff::Base
-  include StackedMixin
+  include Gruff::Base::StackedMixin
 
   # @deprecated
   def last_series_goes_on_bottom=(_value)
@@ -44,6 +46,7 @@ private
       data_points = []
 
       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) - height[index])
@@ -58,10 +61,12 @@ private
 
       poly_points = data_points.dup
       if prev_data_points
+        # steep:ignore:start
         ((prev_data_points.length / 2) - 1).downto(0) do |i|
           poly_points << prev_data_points[2 * i]
           poly_points << prev_data_points[(2 * i) + 1]
         end
+        # steep:ignore:end
       else
         poly_points << @graph_right
         poly_points << (@graph_bottom - 1)

data/lib/gruff/stacked_bar.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require_relative 'helper/stacked_mixin'
 
 #
@@ -13,24 +15,24 @@ require_relative 'helper/stacked_mixin'
 #   g.write('stacked_bar.png')
 #
 class Gruff::StackedBar < Gruff::Base
-  include StackedMixin
+  include Gruff::Base::StackedMixin
 
   # Spacing factor applied between bars.
-  attr_writer :bar_spacing
+  attr_writer :bar_spacing #: Float | Integer
 
   # Number of pixels between bar segments.
-  attr_writer :segment_spacing
+  attr_writer :segment_spacing #: Float | Integer
 
   # Set the number output format string or lambda.
   # Default is +"%.2f"+.
-  attr_writer :label_formatting
+  attr_writer :label_formatting #: nil | String | Proc
 
   # Output the values for the bars on a bar graph.
   # Default is +false+.
-  attr_writer :show_labels_for_bar_values
+  attr_writer :show_labels_for_bar_values #: bool
 
   # Prevent drawing of column labels below a stacked bar graph.  Default is +false+.
-  attr_writer :hide_labels
+  attr_writer :hide_labels #: bool
 
 private
 
@@ -78,7 +80,7 @@ private
     #
     # Columns sit stacked.
     bar_width = @graph_width / column_count
-    padding = (bar_width * (1 - @bar_spacing)) / 2.0
+    padding = (bar_width * (1.0 - @bar_spacing)) / 2.0
 
     # Setup the BarConversion Object
     conversion = Gruff::BarConversion.new(
@@ -87,13 +89,13 @@ private
     )
 
     normalized_stacked_bars.each_with_index do |stacked_bars, stacked_index|
-      total = 0
+      total = 0.0
       left_x = @graph_left + (bar_width * stacked_index) + padding
       right_x = left_x + (bar_width * @bar_spacing)
 
-      top_y = 0
+      top_y = 0.0
       stacked_bars.each do |bar|
-        next if bar.point == 0
+        next if bar.point.nil? || bar.point == 0
 
         bottom_y, = conversion.get_top_bottom_scaled(total)
         bottom_y -= @segment_spacing
@@ -117,18 +119,22 @@ private
     end
   end
 
+  # @rbs return: bool
   def hide_labels?
     @hide_labels
   end
 
+  # @rbs return: bool
   def hide_left_label_area?
     @hide_line_markers && @y_axis_label.nil?
   end
 
+  # @rbs return: bool
   def hide_bottom_label_area?
     hide_labels? && @x_axis_label.nil? && @legend_at_bottom == false
   end
 
+  # @rbs return: Proc
   def proc_text_metrics
     ->(text) { text_metrics(@marker_font, text) }
   end

data/lib/gruff/store/basic_data.rb

@@ -1,29 +1,63 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   class Store
     # @private
-    class BasicData < Struct.new(:label, :points, :color)
+    class BasicData
+      attr_accessor :label #: String | Symbol
+      attr_accessor :points #: Array[nil | Float | Integer]
+      attr_accessor :color #: String
+
+      # @rbs label: String | Symbol
+      # @rbs points: Array[nil | Float | Integer] | nil
+      # @rbs color: String
       def initialize(label, points, color)
-        super(label.to_s, Array(points), color)
+        @label = label.to_s
+        @points = Array(points)
+        @color = color
+      end
+
+      alias x_points points
+
+      def y_points
+        raise NotImplementedError, 'x_points is not implemented for BasicData'
+      end
+
+      def coordinates
+        raise NotImplementedError, 'This method is not implemented for BasicData'
+      end
+
+      def coordinate_and_pointsizes
+        raise NotImplementedError, 'This method is not implemented for BasicData'
       end
 
+      # @rbs return: bool
       def empty?
         points.empty?
       end
 
+      # @rbs return: Integer
       def columns
         points.length
       end
 
+      # @rbs return: Float | Integer
       def min
         points.compact.min
       end
+      alias min_x min
 
+      # @rbs return: Float | Integer
       def max
         points.compact.max
       end
+      alias max_x max
 
+      # @rbs minimum: Float | Integer
+      # @rbs spread: Float | Integer
+      # @rbs return: Gruff::Store::BasicData
       def normalize(minimum:, spread:)
         norm_points = points.map do |point|
           point.nil? ? nil : (point.to_f - minimum.to_f) / spread