gruff 0.25.0 → 0.27.0

data/lib/gruff/histogram.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require 'histogram'
 
 #
@@ -15,19 +17,24 @@ require 'histogram'
 #
 class Gruff::Histogram < Gruff::Bar
   # Specifies interpolation between the min and max of the set. Default is +10+.
-  attr_writer :bin_width
+  attr_writer :bin_width #: Float | Integer
 
   # Specifies minimum value for bin.
-  attr_writer :minimum_bin
+  attr_writer :minimum_bin #: Float | Integer
 
   # Specifies maximum value for bin.
-  attr_writer :maximum_bin
+  attr_writer :maximum_bin #: Float | Integer
 
-  def initialize(*)
+  # @rbs target_width: (String | Float | Integer)
+  # @rbs return: void
+  def initialize(target_width = DEFAULT_TARGET_WIDTH)
     super
     @data = []
   end
 
+  # @rbs name: String | Symbol
+  # @rbs data_points: Array[Float | Integer] | nil
+  # @rbs color: String
   def data(name, data_points = [], color = nil)
     @data << [name, Array(data_points), color]
   end
@@ -46,7 +53,7 @@ private
       if data_points.empty?
         store.add(name, [], color)
       else
-        bins, freqs = HistogramArray.new(data_points).histogram(bin_width: @bin_width, min: @minimum_bin, max: @maximum_bin)
+        bins, freqs = HistogramArray.new(data_points.compact).histogram(bin_width: @bin_width, min: @minimum_bin, max: @maximum_bin) # steep:ignore
         bins.each_with_index do |bin, index|
           @labels[index] = bin
         end
@@ -58,7 +65,9 @@ private
   end
 
   # @private
+  # @rbs inherits Array[Float | Integer | nil]
   class HistogramArray < Array
+    # @rbs skip
     include ::Histogram
   end
 end

data/lib/gruff/line.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 #
 # Here's how to make a Gruff::Line.
 #
@@ -14,31 +16,32 @@
 #
 class Gruff::Line < Gruff::Base
   # Allow for reference lines ( which are like baseline ... just allowing for more & on both axes ).
-  attr_accessor :reference_lines
-  attr_writer :reference_line_default_color
-  attr_writer :reference_line_default_width
+  attr_accessor :reference_lines #: Hash[Symbol, untyped]
+  attr_writer :reference_line_default_color #: String
+  attr_writer :reference_line_default_width #: Float | Integer
 
   # Allow for vertical marker lines.
-  attr_writer :show_vertical_markers
+  attr_writer :show_vertical_markers #: bool
 
   # Dimensions of lines and dots; calculated based on dataset size if left unspecified.
-  attr_writer :line_width
-  attr_writer :dot_radius
+  attr_writer :line_width #: Float | Integer
+  attr_writer :dot_radius #: Float | Integer
 
   # default is +'circle'+, other options include +square+ and +diamond+.
-  attr_writer :dot_style
+  attr_writer :dot_style #: :square | :circle | :diamond | 'square' | 'circle' | 'diamond'
 
   # Hide parts of the graph to fit more data points, or for a different appearance.
-  attr_writer :hide_dots, :hide_lines
+  attr_writer :hide_dots #: bool
+  attr_writer :hide_lines #: bool
 
   # accessors for support of xy data.
-  attr_writer :minimum_x_value
+  attr_writer :minimum_x_value #: Float
 
   # accessors for support of xy data.
-  attr_writer :maximum_x_value
+  attr_writer :maximum_x_value #: Float
 
   # The number of vertical lines shown.
-  attr_writer :marker_x_count
+  attr_writer :marker_x_count #: Integer
 
   # Call with target pixel width of graph (+800+, +400+, +300+), and/or +false+ to omit lines (points only).
   #
@@ -47,6 +50,8 @@ class Gruff::Line < Gruff::Base
   #   g = Gruff::Line.new(false) # Defaults to 800px wide, no lines (for backwards compatibility)
   #
   # The preferred way is to call {#hide_dots=} or {#hide_lines=} instead.
+  #
+  # @rbs return: void
   def initialize(*args)
     raise ArgumentError, 'Wrong number of arguments' if args.length > 2
 
@@ -58,6 +63,8 @@ class Gruff::Line < Gruff::Base
   end
 
   # Get the value if somebody has defined it.
+  #
+  # @rbs return: Float | Integer | nil
   def baseline_value
     if @reference_lines.key?(:baseline)
       @reference_lines[:baseline][:value]
@@ -65,17 +72,21 @@ class Gruff::Line < Gruff::Base
   end
 
   # Set a value for a baseline reference line..
+  #
+  # @rbs new_value: Float | Integer
   def baseline_value=(new_value)
     @reference_lines[:baseline] ||= {}
     @reference_lines[:baseline][:value] = new_value
   end
 
+  # @rbs return: Float | Integer | nil
   def baseline_color
     if @reference_lines.key?(:baseline)
       @reference_lines[:baseline][:color]
     end
   end
 
+  # @rbs new_value: Float | Integer
   def baseline_color=(new_value)
     @reference_lines[:baseline] ||= {}
     @reference_lines[:baseline][:color] = new_value
@@ -93,8 +104,11 @@ class Gruff::Line < Gruff::Base
   # be used.
   #
   # @param name [String, Symbol] The name of the dataset.
+  # @rbs name: String | Symbol
   # @param data_points [Array] The array of dataset.
+  # @rbs data_points: Array[nil | Float | Integer] | nil
   # @param color [String] The color for drawing graph of dataset.
+  # @rbs color: String
   #
   # @note
   #   If you want to use a preset theme, you must set it before calling {#data}.
@@ -139,6 +153,11 @@ class Gruff::Line < Gruff::Base
   #   In this example the labels are drawn at x positions 2, 4, and 6:
   #   g.labels = {0 => '2003', 2 => '2004', 4 => '2005', 6 => '2006'}
   #   # The 0 => '2003' label will be ignored since it is outside the chart range.
+  #
+  # @rbs name: String | Symbol
+  # @rbs x_data_points: Array[nil | Float | Integer] | Array[[nil | Float | Integer, nil | Float | Integer]] | nil
+  # @rbs y_data_points: Array[nil | Float | Integer] | nil | String
+  # @rbs color: String
   def dataxy(name, x_data_points = [], y_data_points = [], color = nil)
     # make sure it's an array
     x_data_points = Array(x_data_points)
@@ -152,7 +171,7 @@ class Gruff::Line < Gruff::Base
       y_data_points = Array(y_data_points)
     end
 
-    raise ArgumentError, 'x_data_points.length != y_data_points.length!' if x_data_points.length != y_data_points.length
+    raise ArgumentError, 'x_data_points.length != y_data_points.length!' if x_data_points.length != y_data_points.length # steep:ignore
 
     # call the existing data routine for the x/y data.
     store.add(name, x_data_points, y_data_points, color)

data/lib/gruff/mini/bar.rb

@@ -31,12 +31,12 @@ private
   end
 
   def setup_data
-    expand_canvas_for_vertical_legend
+    expand_canvas_for_vertical_legend # steep:ignore
     super
   end
 
   def draw_graph
     super
-    draw_vertical_legend
+    draw_vertical_legend # steep:ignore
   end
 end

data/lib/gruff/mini/legend.rb

@@ -13,6 +13,8 @@ module Gruff::Mini::Legend
 
   # The canvas needs to be bigger so we can put the legend beneath it.
   def expand_canvas_for_vertical_legend
+    # steep:ignore:start
+
     return if @hide_mini_legend
 
     @legend_labels = store.data.map(&:label)
@@ -33,19 +35,23 @@ module Gruff::Mini::Legend
     end
 
     @renderer = Gruff::Renderer.new(@columns, @rows, @scale, @theme_options)
+    # steep:ignore:end
   end
 
   def calculate_line_height
-    calculate_caps_height(@legend_font) * 1.7
+    calculate_caps_height(@legend_font) * 1.7 # steep:ignore
   end
 
   def calculate_legend_width
+    # steep:ignore:start
     width = @legend_labels.map { |label| calculate_width(@legend_font, label) }.max
     scale(width + (40 * 1.7))
+    # steep:ignore:end
   end
 
   # Draw the legend beneath the existing graph.
   def draw_vertical_legend
+    # steep:ignore:start
     return if @hide_mini_legend
 
     legend_square_width = 40.0 # small square with color of this item
@@ -77,10 +83,12 @@ module Gruff::Mini::Legend
 
       current_y_offset += calculate_line_height
     end
+    # steep:ignore:end
   end
 
   # Shorten long labels so they will fit on the canvas.
   def truncate_legend_label(label, x_offset)
+    # steep:ignore:start
     truncated_label = label.to_s
 
     font = @legend_font.dup
@@ -90,6 +98,7 @@ module Gruff::Mini::Legend
       truncated_label = truncated_label[0..truncated_label.length - 2]
     end
     truncated_label + (truncated_label.length < label.to_s.length ? '...' : '')
+    # steep:ignore:end
   end
 
   def scale(value)

data/lib/gruff/mini/pie.rb

@@ -28,12 +28,12 @@ private
   end
 
   def setup_data
-    expand_canvas_for_vertical_legend
+    expand_canvas_for_vertical_legend # steep:ignore
     super
   end
 
   def draw_graph
     super
-    draw_vertical_legend
+    draw_vertical_legend # steep:ignore
   end
 end

data/lib/gruff/mini/side_bar.rb

@@ -35,12 +35,12 @@ private
   end
 
   def setup_data
-    expand_canvas_for_vertical_legend
+    expand_canvas_for_vertical_legend # steep:ignore
     super
   end
 
   def draw_graph
     super
-    draw_vertical_legend
+    draw_vertical_legend # steep:ignore
   end
 end

data/lib/gruff/net.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 # See also the Spider graph.
 #
 # Here's how to make a Gruff::Net.
@@ -24,11 +26,11 @@
 #
 class Gruff::Net < Gruff::Base
   # Hide parts of the graph to fit more data points, or for a different appearance.
-  attr_writer :hide_dots
+  attr_writer :hide_dots #: bool
 
   # Dimensions of lines and dots; calculated based on dataset size if left unspecified.
-  attr_writer :line_width
-  attr_writer :dot_radius
+  attr_writer :line_width #: Float | Integer
+  attr_writer :dot_radius #: Float | Integer
 
 private
 
@@ -63,10 +65,8 @@ private
       poly_points = []
 
       data_row.points.each_with_index do |data_point, index|
-        next if data_point.nil?
-
         rad_pos = index * Math::PI * 2 / column_count
-        point_distance = data_point * @radius
+        point_distance = data_point.to_f * @radius
         start_x = @center_x + (Math.sin(rad_pos) * point_distance)
         start_y = @center_y - (Math.cos(rad_pos) * point_distance)
         if poly_points.empty?
@@ -77,7 +77,7 @@ private
         next_index = index + 1 < data_row.points.length ? index + 1 : 0
 
         next_rad_pos = next_index * Math::PI * 2 / column_count
-        next_point_distance = data_row.points[next_index] * @radius
+        next_point_distance = data_row.points[next_index].to_f * @radius
         end_x = @center_x + (Math.sin(next_rad_pos) * next_point_distance)
         end_y = @center_y - (Math.cos(next_rad_pos) * next_point_distance)
         poly_points << end_x
@@ -109,6 +109,11 @@ private
     end
   end
 
+  # @rbs center_x: Float | Integer
+  # @rbs center_y: Float | Integer
+  # @rbs angle: Float | Integer
+  # @rbs radius: Float
+  # @rbs amount: String | Integer
   def draw_label(center_x, center_y, angle, radius, amount)
     x_offset = center_x # + 15 # The label points need to be tweaked slightly
     y_offset = center_y # + 0  # This one doesn't though

data/lib/gruff/patch/rmagick.rb

@@ -10,10 +10,12 @@ module Magick
         scaled_width = [(width * scale), 1].max
         scaled_height = [(height * scale), 1].max
 
+        # steep:ignore:start
         annotate(img,
                  scaled_width, scaled_height,
                  x * scale, y * scale,
                  text.gsub('%', '%%'))
+        # steep:ignore:end
       end
 
       if defined? JRUBY_VERSION

data/lib/gruff/patch/string.rb

@@ -8,7 +8,7 @@ module String::GruffCommify
   refine String do
     # Taken from http://codesnippets.joyent.com/posts/show/330
     def commify(delimiter = THOUSAND_SEPARATOR)
-      gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
+      gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}") # steep:ignore
     end
   end
 end

data/lib/gruff/pie.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 #
 # Here's how to make a Gruff::Pie.
 #
@@ -16,25 +18,25 @@ class Gruff::Pie < Gruff::Base
 
   # Can be used to make the pie start cutting slices at the top (-90.0)
   # or at another angle. Default is +-90.0+, which starts at 3 o'clock.
-  attr_writer :start_degree
+  attr_writer :start_degree #: Float | Integer
 
   # Set the number output format lambda.
-  attr_writer :label_formatting
+  attr_writer :label_formatting #: Proc
 
   # Do not show labels for slices that are less than this percent. Use 0 to always show all labels.
   # Defaults to +0+.
-  attr_writer :hide_labels_less_than
+  attr_writer :hide_labels_less_than #: Float | Integer
 
   # Affect the distance between the percentages and the pie chart.
   # Defaults to +0.1+.
-  attr_writer :text_offset_percentage
+  attr_writer :text_offset_percentage #: Float | Integer
 
   ## Use values instead of percentages.
-  attr_writer :show_values_as_labels
+  attr_writer :show_values_as_labels #: bool
 
   # Set to +true+ if you want the data sets sorted with largest avg values drawn
   # first. Default is +true+.
-  attr_writer :sort
+  attr_writer :sort #: bool
 
   # Can be used to make the pie start cutting slices at the top (-90.0)
   # or at another angle. Default is +-90.0+, which starts at 3 o'clock.
@@ -90,53 +92,64 @@ private
 
   # General Helper Methods
 
+  # @rbs degree: Float | Integer
   def update_chart_degrees_with(degrees)
     @chart_degrees = chart_degrees + degrees
   end
 
   # Spatial Value-Related Methods
 
+  # @rbs return: Float | Integer
   def chart_degrees
     @chart_degrees ||= @start_degree
   end
 
-  attr_reader :graph_height
-  attr_reader :graph_width
+  attr_reader :graph_height #: Float | Integer
+  attr_reader :graph_width #: Float | Integer
 
+  # @rbs return: Float | Integer
   def half_width
     graph_width / 2.0
   end
 
+  # @rbs return: Float | Integer
   def half_height
     graph_height / 2.0
   end
 
+  # @rbs return: Float | Integer
   def radius
     @radius ||= ([graph_width, graph_height].min / 2.0) * 0.8
   end
 
+  # @rbs return: Float | Integer
   def center_x
     @center_x ||= @graph_left + half_width
   end
 
+  # @rbs return: Float | Integer
   def center_y
     @center_y ||= @graph_top + half_height - 10
   end
 
+  # @rbs return: Float | Integer
   def distance_from_center
     20.0
   end
 
+  # @rbs return: Float | Integer | BigDecimal
   def radius_offset
     radius + (radius * @text_offset_percentage) + distance_from_center
   end
 
+  # @rbs return: Float | Integer
   def ellipse_factor
     radius_offset * @text_offset_percentage
   end
 
   # Label-Related Methods
 
+  # @rbs slice: Gruff::Pie::PieSlice
   def process_label_for(slice)
     if slice.percentage >= @hide_labels_less_than
       x, y = label_coordinates_for slice
@@ -145,16 +158,22 @@ private
     end
   end
 
+  # @rbs slice: Gruff::Pie::PieSlice
+  # @rbs return: [Float | Integer, Float | Integer]
   def label_coordinates_for(slice)
     angle = chart_degrees + (slice.degrees / 2.0)
 
     [x_label_coordinate(angle), y_label_coordinate(angle)]
   end
 
+  # @rbs angle: Float | Integer
+  # @rbs return: Float
   def x_label_coordinate(angle)
-    center_x + ((radius_offset + ellipse_factor) * Math.cos(deg2rad(angle)))
+    center_x + ((radius_offset + ellipse_factor) * Math.cos(deg2rad(angle))) #: Float
   end
 
+  # @rbs angle: Float | Integer
+  # @rbs return: Float
   def y_label_coordinate(angle)
     center_y + (radius_offset * Math.sin(deg2rad(angle)))
   end
@@ -162,19 +181,35 @@ private
   # Helper Classes
   #
   # @private
-  class PieSlice < Struct.new(:label, :value, :color)
-    attr_accessor :total
+  class PieSlice
+    attr_accessor :label #: String | Symbol
+    attr_accessor :value #: Float | Integer
+    attr_accessor :color #: String
+    attr_accessor :total #: Float | Integer
+
+    # @rbs label: String | Symbol
+    # @rbs value: nil | Float | Integer
+    # @rbs color: String
+    # @rbs return: void
+    def initialize(label, value, color)
+      @label = label
+      @value = value || 0.0
+      @color = color
+    end
 
+    # @rbs return: Float | Integer
     def percentage
       (size * 100.0).round
     end
 
+    # @rbs return: Float
     def degrees
       size * 360.0
     end
 
   private
 
+    # @rbs return: Float | Integer
     def size
       value / total
     end

data/lib/gruff/renderer/bezier.rb

@@ -1,14 +1,21 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer::Bezier
+    # @rbs renderer: Gruff::Renderer
+    # @rbs color: String
+    # @rbs width: Float | Integer
+    # @rbs return: void
     def initialize(renderer, color:, width: 1.0)
       @renderer = renderer
       @color = color
       @width = width
     end
 
+    # @rbs points: Array[Float | Integer]
     def render(points)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)

data/lib/gruff/renderer/circle.rb

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer::Circle
+    # @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 +17,10 @@ module Gruff
       @opacity = opacity
     end
 
+    # @rbs origin_x: Float | Integer
+    # @rbs origin_y: Float | Integer
+    # @rbs perim_x: Float | Integer
+    # @rbs perim_y: Float | Integer
     def render(origin_x, origin_y, perim_x, perim_y)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)

data/lib/gruff/renderer/dash_line.rb

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer::DashLine
+    # @rbs renderer: Gruff::Renderer
+    # @rbs color: String
+    # @rbs width: Float | Integer
+    # @rbs dasharray: Array[Float | Integer]
+    # @rbs return: void
     def initialize(renderer, color:, width:, dasharray: [10, 20])
       @renderer = renderer
       @color = color
@@ -10,6 +17,10 @@ module Gruff
       @dasharray = dasharray
     end
 
+    # @rbs start_x: Float | Integer
+    # @rbs start_y: Float | Integer
+    # @rbs end_x: Float | Integer
+    # @rbs end_y: Float | Integer
     def render(start_x, start_y, end_x, end_y)
       @renderer.draw.push
       @renderer.draw.stroke_color(@color)

data/lib/gruff/renderer/dot.rb

@@ -1,8 +1,16 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer::Dot
+    # @rbs renderer: Gruff::Renderer
+    # @rbs style: :square | :circle | :diamond | 'square' | 'circle' | 'diamond'
+    # @rbs color: String
+    # @rbs width: Float | Integer
+    # @rbs opacity: Float | Integer
+    # @rbs return: void
     def initialize(renderer, style, color:, width: 1.0, opacity: 1.0)
       @renderer = renderer
       @style = style.to_sym
@@ -11,6 +19,9 @@ module Gruff
       @opacity = opacity
     end
 
+    # @rbs new_x: Float | Integer
+    # @rbs new_y: Float | Integer
+    # @rbs radius: Float | Integer
     def render(new_x, new_y, radius)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)

data/lib/gruff/renderer/ellipse.rb

@@ -1,14 +1,26 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer::Ellipse
+    # @rbs renderer: Gruff::Renderer
+    # @rbs color: String
+    # @rbs width: Float | Integer
+    # @rbs return: void
     def initialize(renderer, color:, width: 1.0)
       @renderer = renderer
       @color = color
       @width = width
     end
 
+    # @rbs origin_x: Float | Integer
+    # @rbs origin_y: Float | Integer
+    # @rbs width: Float | Integer
+    # @rbs height: Float | Integer
+    # @rbs arc_start: Float | Integer
+    # @rbs arc_end: Float | Integer
     def render(origin_x, origin_y, width, height, arc_start, arc_end)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)

data/lib/gruff/renderer/line.rb

@@ -1,16 +1,26 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Renderer::Line
     EPSILON = 0.001
 
+    # @rbs renderer: Gruff::Renderer
+    # @rbs color: String
+    # @rbs width: Float | Integer
+    # @rbs return: void
     def initialize(renderer, color:, width: nil)
       @renderer = renderer
       @color = color
       @width = width
     end
 
+    # @rbs start_x: Float | Integer
+    # @rbs start_y: Float | Integer
+    # @rbs end_x: Float | Integer
+    # @rbs end_y: Float | Integer
     def render(start_x, start_y, end_x, end_y)
       render_line(start_x, start_y, end_x, end_y, @color)
     end