gruff 0.30.0 → 0.31.0

data/lib/gruff/candlestick.rb

@@ -36,6 +36,7 @@ class Gruff::Candlestick < Gruff::Base
   # Default value is +0.9+.
   #
   # @rbs space_percent: Float | Integer
+  # @rbs return: void
   def spacing_factor=(space_percent)
     raise ArgumentError, 'spacing_factor must be between 0.00 and 1.00' if (space_percent < 0) || (space_percent > 1)
 
@@ -43,11 +44,13 @@ class Gruff::Candlestick < Gruff::Base
   end
 
   # The sort feature is not supported in this graph.
+  # @rbs return: void
   def sort=(_value)
     raise 'Not support #sort= in Gruff::Candlestick'
   end
 
   # The sort feature is not supported in this graph.
+  # @rbs return: void
   def sorted_drawing=(_value)
     raise 'Not support #sorted_drawing= in Gruff::Candlestick'
   end
@@ -56,12 +59,14 @@ class Gruff::Candlestick < Gruff::Base
   # @rbs high: Float | Integer
   # @rbs open: Float | Integer
   # @rbs close: Float | Integer
+  # @rbs return: void
   def data(low:, high:, open:, close:)
     super('', [low, high, open, close])
   end
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
     @show_vertical_markers = false
@@ -74,6 +79,7 @@ private
     @hide_legend = true
   end
 
+  # @rbs return: void
   def draw_graph
     # Setup the BarConversion Object
     conversion = Gruff::BarConversion.new(
@@ -106,6 +112,7 @@ private
     end
   end
 
+  # @rbs return: Array[Gruff::Candlestick::CandlestickData]
   def normalized_candlesticks
     @normalized_candlesticks ||= store.norm_data.map { |data| Gruff::Candlestick::CandlestickData.new(*data.points) } # steep:ignore
   end
@@ -127,11 +134,16 @@ private
 
   # @private
   class CandlestickData
-    attr_accessor :low
-    attr_accessor :high
-    attr_accessor :open
-    attr_accessor :close
-
+    attr_accessor :low #: Float | Integer
+    attr_accessor :high #: Float | Integer
+    attr_accessor :open #: Float | Integer
+    attr_accessor :close #: Float | Integer
+
+    # @rbs low: Float | Integer
+    # @rbs high: Float | Integer
+    # @rbs open: Float | Integer
+    # @rbs close: Float | Integer
+    # @rbs return: void
     def initialize(low, high, open, close)
       @low = low.to_f
       @high = high.to_f

data/lib/gruff/dot.rb

@@ -29,6 +29,7 @@ class Gruff::Dot < Gruff::Base
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
     @hide_labels = false
@@ -49,6 +50,7 @@ private
     @hide_line_markers && @x_axis_label.nil? && @legend_at_bottom == false
   end
 
+  # @rbs return: void
   def draw_graph
     # Setup spacing.
     #
@@ -76,6 +78,7 @@ private
   end
 
   # Instead of base class version, draws vertical background lines and label
+  # @rbs return: void
   def draw_line_markers
     return if @hide_line_markers
 
@@ -98,6 +101,7 @@ private
 
   # @rbs y_offset: Float | Integer
   # @rbs index: Integer
+  # @rbs return: void
   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

@@ -26,6 +26,7 @@ class Gruff::Font
   # @rbs size: Float | Integer
   # @rbs bold: bool
   # @rbs color: String
+  # @rbs return: void
   def initialize(path: nil, size: 20.0, bold: false, color: 'white')
     @path = path
     @bold = bold
@@ -36,6 +37,7 @@ class Gruff::Font
   # Get font weight.
   # @return [Magick::WeightType] font weight
   # TODO: type annotation of return value
+  # @rbs return: untyped
   def weight
     @bold ? Magick::BoldWeight : Magick::NormalWeight
   end

data/lib/gruff/helper/bar_value_label.rb

@@ -45,6 +45,7 @@ module Gruff::BarValueLabel
     # @rbs format: nil | String | Proc
     # @rbs proc_text_metrics: Proc
     # @rbs yields: (Float | Integer, Float | Integer, String, Float, Float) -> void
+    # @rbs return: 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)
@@ -59,6 +60,7 @@ module Gruff::BarValueLabel
     # @rbs format: nil | String | Proc
     # @rbs proc_text_metrics: Proc
     # @rbs yields: (Float | Integer, Float | Integer, String, Float, Float) -> void
+    # @rbs return: 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)

data/lib/gruff/helper/stacked_mixin.rb

@@ -7,6 +7,7 @@ module Gruff::Base::StackedMixin
   # Used by StackedBar and child classes.
   #
   # tsal: moved from Base 03 FEB 2007
+  # @rbs return: void
   def calculate_maximum_by_stack
     # steep:ignore:start
     # Get sum of each stack

data/lib/gruff/histogram.rb

@@ -35,12 +35,14 @@ class Gruff::Histogram < Gruff::Bar
   # @rbs name: String | Symbol
   # @rbs data_points: Array[Float | Integer] | nil
   # @rbs color: String
+  # @rbs return: void
   def data(name, data_points = [], color = nil)
     @data << [name, Array(data_points), color]
   end
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
     @bin_width = 10
@@ -48,6 +50,7 @@ private
     @maximum_bin = nil
   end
 
+  # @rbs return: void
   def setup_data
     @data.each do |(name, data_points, color)|
       if data_points.empty?

data/lib/gruff/line.rb

@@ -51,6 +51,7 @@ class Gruff::Line < Gruff::Base
   #
   # The preferred way is to call {#hide_dots=} or {#hide_lines=} instead.
   #
+  # @rbs *args: untyped
   # @rbs return: void
   def initialize(*args)
     raise ArgumentError, 'Wrong number of arguments' if args.length > 2
@@ -74,6 +75,7 @@ class Gruff::Line < Gruff::Base
   # Set a value for a baseline reference line..
   #
   # @rbs new_value: Float | Integer
+  # @rbs return: Float | Integer
   def baseline_value=(new_value)
     @reference_lines[:baseline] ||= {}
     @reference_lines[:baseline][:value] = new_value
@@ -87,6 +89,7 @@ class Gruff::Line < Gruff::Base
   end
 
   # @rbs new_value: Float | Integer
+  # @rbs return: Float | Integer
   def baseline_color=(new_value)
     @reference_lines[:baseline] ||= {}
     @reference_lines[:baseline][:color] = new_value
@@ -115,6 +118,7 @@ class Gruff::Line < Gruff::Base
   #
   # @example
   #   data("Bart S.", [95, 45, 78, 89, 88, 76], '#ffcc00')
+  # @rbs return: void
   def data(name, data_points = [], color = nil)
     store.add(name, nil, data_points, color)
   end
@@ -158,6 +162,7 @@ class Gruff::Line < Gruff::Base
   # @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
+  # @rbs return: void
   def dataxy(name, x_data_points = [], y_data_points = [], color = nil)
     # make sure it's an array
     x_data_points = Array(x_data_points)
@@ -179,10 +184,12 @@ class Gruff::Line < Gruff::Base
 
 private
 
+  # @rbs return: void
   def initialize_store
     @store = Gruff::Store.new(Gruff::Store::XYData)
   end
 
+  # @rbs return: void
   def initialize_attributes
     super
     @reference_lines = {}
@@ -201,22 +208,33 @@ private
     @show_vertical_markers = false
   end
 
+  # @rbs reference_line: Hash[Symbol, untyped]
+  # @rbs left: Float | Integer
+  # @rbs right: Float | Integer
+  # @rbs top: Float | Integer
+  # @rbs bottom: Float | Integer
+  # @rbs return: void
   def draw_reference_line(reference_line, left, right, top, bottom)
     color = reference_line[:color] || @reference_line_default_color
     width = reference_line[:width] || @reference_line_default_width
     Gruff::Renderer::DashLine.new(renderer, color: color, width: width).render(left, top, right, bottom)
   end
 
+  # @rbs reference_line: Hash[Symbol, untyped]
+  # @rbs return: void
   def draw_horizontal_reference_line(reference_line)
     level = @graph_top + (@graph_height - (reference_line[:norm_value] * @graph_height))
     draw_reference_line(reference_line, @graph_left, @graph_left + @graph_width, level, level)
   end
 
+  # @rbs reference_line: Hash[Symbol, untyped]
+  # @rbs return: void
   def draw_vertical_reference_line(reference_line)
     index = @graph_left + (@x_increment * reference_line[:index])
     draw_reference_line(reference_line, index, index, @graph_top, @graph_top + @graph_height)
   end
 
+  # @rbs return: void
   def draw_graph
     # Check to see if more than one datapoint was given. NaN can result otherwise.
     @x_increment = column_count > 1 ? @graph_width / (column_count - 1) : @graph_width
@@ -268,6 +286,7 @@ private
     end
   end
 
+  # @rbs return: void
   def setup_data
     # Update the global min/max values for the x data
     @maximum_x_value = (@maximum_x_value || store.max_x).to_f
@@ -290,11 +309,13 @@ private
     super
   end
 
+  # @rbs return: void
   def setup_drawing
     @marker_x_count ||= column_count - 1
     super
   end
 
+  # @rbs return: void
   def normalize
     return unless data_given?
 
@@ -309,6 +330,7 @@ private
     end
   end
 
+  # @rbs return: void
   def draw_line_markers
     # do all of the stuff for the horizontal lines on the y-axis
     super
@@ -320,6 +342,10 @@ private
     end
   end
 
+  # @rbs x_data: Float | Integer | nil
+  # @rbs new_x: Float | Integer
+  # @rbs index: Integer
+  # @rbs return: void
   def draw_label_for_x_data(x_data, new_x, index)
     if x_data.nil?
       draw_label(new_x, index)
@@ -330,6 +356,8 @@ private
     end
   end
 
+  # @rbs data_row: Gruff::Store::XYData
+  # @rbs return: bool
   def contains_one_point_only?(data_row)
     data_row.y_points.compact.count == 1
   end

data/lib/gruff/mini/bar.rb

@@ -18,6 +18,7 @@ private
 
   include Gruff::Mini::Legend
 
+  # @rbs return: void
   def initialize_attributes
     super
 
@@ -31,11 +32,13 @@ private
     @minimum_value = 0.0
   end
 
+  # @rbs return: void
   def setup_data
     expand_canvas_for_vertical_legend # steep:ignore
     super
   end
 
+  # @rbs return: void
   def draw_graph
     super
     draw_vertical_legend # steep:ignore

data/lib/gruff/mini/legend.rb

@@ -4,8 +4,10 @@
 # A module to handle the small legend.
 # @private
 module Gruff::Mini::Legend
-  attr_accessor :hide_mini_legend, :legend_position
+  attr_accessor :hide_mini_legend #: bool
+  attr_accessor :legend_position  #: Symbol
 
+  # @rbs return: void
   def initialize(*)
     @hide_mini_legend = false
     @legend_position = nil
@@ -13,6 +15,7 @@ module Gruff::Mini::Legend
   end
 
   # The canvas needs to be bigger so we can put the legend beneath it.
+  # @rbs return: Gruff::Renderer
   def expand_canvas_for_vertical_legend
     # steep:ignore:start
 
@@ -39,10 +42,12 @@ module Gruff::Mini::Legend
     # steep:ignore:end
   end
 
+  # @rbs return: Float
   def calculate_line_height
     calculate_caps_height(@legend_font) * 1.7 # steep:ignore
   end
 
+  # @rbs return: Float
   def calculate_legend_width
     # steep:ignore:start
     width = @legend_labels.map { |label| calculate_width(@legend_font, label) }.max
@@ -51,6 +56,7 @@ module Gruff::Mini::Legend
   end
 
   # Draw the legend beneath the existing graph.
+  # @rbs return: void
   def draw_vertical_legend
     # steep:ignore:start
     return if @hide_mini_legend
@@ -88,6 +94,9 @@ module Gruff::Mini::Legend
   end
 
   # Shorten long labels so they will fit on the canvas.
+  # @rbs label: String | Symbol
+  # @rbs x_offset: Float | Integer
+  # @rbs return: String
   def truncate_legend_label(label, x_offset)
     # steep:ignore:start
     truncated_label = label.to_s
@@ -102,7 +111,9 @@ module Gruff::Mini::Legend
     # steep:ignore:end
   end
 
+  # @rbs value: Float | Integer
+  # @rbs return: Float
   def scale(value)
-    value * @scale
+    (value.to_f * @scale).to_f
   end
 end

data/lib/gruff/mini/pie.rb

@@ -17,6 +17,7 @@ private
 
   include Gruff::Mini::Legend
 
+  # @rbs return: void
   def initialize_attributes
     super
 
@@ -28,11 +29,13 @@ private
     @legend_font.size = 50.0
   end
 
+  # @rbs return: void
   def setup_data
     expand_canvas_for_vertical_legend # steep:ignore
     super
   end
 
+  # @rbs return: void
   def draw_graph
     super
     draw_vertical_legend # steep:ignore

data/lib/gruff/mini/side_bar.rb

@@ -25,6 +25,7 @@ private
 
   include Gruff::Mini::Legend
 
+  # @rbs return: void
   def initialize_attributes
     super
     @hide_legend = true
@@ -35,11 +36,13 @@ private
     @legend_font.size = 50.0
   end
 
+  # @rbs return: void
   def setup_data
     expand_canvas_for_vertical_legend # steep:ignore
     super
   end
 
+  # @rbs return: void
   def draw_graph
     super
     draw_vertical_legend # steep:ignore

data/lib/gruff/net.rb

@@ -34,6 +34,7 @@ class Gruff::Net < Gruff::Base
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
 
@@ -45,11 +46,13 @@ private
     @marker_font.bold = true
   end
 
+  # @rbs return: void
   def setup_drawing
     @center_labels_over_point = false
     super
   end
 
+  # @rbs return: void
   def setup_graph_measurements
     super
 
@@ -60,6 +63,7 @@ private
     @center_y = @graph_top + (@graph_height / 2.0) + 10
   end
 
+  # @rbs return: void
   def draw_graph
     store.norm_data.each do |data_row|
       poly_points = []
@@ -94,6 +98,7 @@ private
   end
 
   # the lines connecting in the center, with the first line vertical
+  # @rbs return: void
   def draw_line_markers
     return if @hide_line_markers
 
@@ -114,6 +119,7 @@ private
   # @rbs angle: Float | Integer
   # @rbs radius: Float
   # @rbs amount: String | Integer
+  # @rbs return: void
   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

@@ -7,6 +7,14 @@ module Magick
   module GruffAnnotate
     refine Draw do
       # Additional method to scale annotation text since Draw.scale doesn't.
+      # @rbs img: untyped
+      # @rbs width: Integer
+      # @rbs height: Integer
+      # @rbs x: Integer
+      # @rbs y: Integer
+      # @rbs text: String
+      # @rbs scale: Float
+      # @rbs return: void
       def annotate_scaled(img, width, height, x, y, text, scale)
         scaled_width = [(width * scale), 1].max
         scaled_height = [(height * scale), 1].max
@@ -23,6 +31,8 @@ module Magick
         # FIXME(uwe):  We should NOT need to implement this method.
         #              Remove this method as soon as RMagick4J Issue #16 is fixed.
         #              https://github.com/Serabe/RMagick4J/issues/16
+        # @rbs fill: String | Symbol
+        # @rbs return: void
         def fill=(fill)
           fill = { white: '#FFFFFF' }[fill.to_sym] || fill
           @draw.fill = Magick4J.ColorDatabase.query_default(fill)

data/lib/gruff/patch/string.rb

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

data/lib/gruff/pie.rb

@@ -41,6 +41,8 @@ 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.
   # @deprecated Please use {#start_degree=} instead.
+  # @rbs value: Float | Integer
+  # @rbs return: void
   def zero_degree=(value)
     warn '#zero_degree= is deprecated. Please use `start_degree` attribute instead'
     @start_degree = value
@@ -48,6 +50,7 @@ class Gruff::Pie < Gruff::Base
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
     @start_degree = -90.0
@@ -63,11 +66,13 @@ private
     @label_formatting = ->(value, percentage) { @show_values_as_labels ? value.to_s : "#{percentage}%" }
   end
 
+  # @rbs return: void
   def setup_drawing
     @center_labels_over_point = false
     super
   end
 
+  # @rbs return: void
   def draw_graph
     slices.each do |slice|
       if slice.value > 0
@@ -79,6 +84,7 @@ private
     end
   end
 
+  # @rbs return: Array[Gruff::Pie::PieSlice]
   def slices
     @slices ||= begin
       slices = store.data.map { |data| Gruff::Pie::PieSlice.new(data.label, data.points.first, data.color) }
@@ -93,6 +99,7 @@ private
   # General Helper Methods
 
   # @rbs degrees: Float | Integer
+  # @rbs return: void
   def update_chart_degrees_with(degrees)
     @chart_degrees = chart_degrees + degrees
   end
@@ -150,6 +157,7 @@ private
   # Label-Related Methods
 
   # @rbs slice: Gruff::Pie::PieSlice
+  # @rbs return: void
   def process_label_for(slice)
     if slice.percentage >= @hide_labels_less_than
       x, y = label_coordinates_for slice

data/lib/gruff/renderer/bezier.rb

@@ -16,6 +16,7 @@ module Gruff
     end
 
     # @rbs points: Array[Float | Integer]
+    # @rbs return: void
     def render(points)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)

data/lib/gruff/renderer/circle.rb

@@ -21,6 +21,7 @@ module Gruff
     # @rbs origin_y: Float | Integer
     # @rbs perim_x: Float | Integer
     # @rbs perim_y: Float | Integer
+    # @rbs return: void
     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

@@ -21,6 +21,7 @@ module Gruff
     # @rbs start_y: Float | Integer
     # @rbs end_x: Float | Integer
     # @rbs end_y: Float | Integer
+    # @rbs return: void
     def render(start_x, start_y, end_x, end_y)
       @renderer.draw.push
       @renderer.draw.stroke_color(@color)

data/lib/gruff/renderer/dot.rb

@@ -22,6 +22,7 @@ module Gruff
     # @rbs new_x: Float | Integer
     # @rbs new_y: Float | Integer
     # @rbs radius: Float | Integer
+    # @rbs return: void
     def render(new_x, new_y, radius)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)
@@ -41,10 +42,18 @@ module Gruff
 
   private
 
+    # @rbs new_x: Float | Integer
+    # @rbs new_y: Float | Integer
+    # @rbs radius: Float | Integer
+    # @rbs return: void
     def circle(new_x, new_y, radius)
       @renderer.draw.circle(new_x, new_y, new_x - radius, new_y)
     end
 
+    # @rbs new_x: Float | Integer
+    # @rbs new_y: Float | Integer
+    # @rbs radius: Float | Integer
+    # @rbs return: void
     def square(new_x, new_y, radius)
       corner1 = new_x - radius
       corner2 = new_y - radius
@@ -53,6 +62,10 @@ module Gruff
       @renderer.draw.rectangle(corner1, corner2, corner3, corner4)
     end
 
+    # @rbs new_x: Float | Integer
+    # @rbs new_y: Float | Integer
+    # @rbs radius: Float | Integer
+    # @rbs return: void
     def diamond(new_x, new_y, radius)
       polygon = []
       polygon += [new_x - radius, new_y]

data/lib/gruff/renderer/ellipse.rb

@@ -21,6 +21,7 @@ module Gruff
     # @rbs height: Float | Integer
     # @rbs arc_start: Float | Integer
     # @rbs arc_end: Float | Integer
+    # @rbs return: void
     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

@@ -21,12 +21,19 @@ module Gruff
     # @rbs start_y: Float | Integer
     # @rbs end_x: Float | Integer
     # @rbs end_y: Float | Integer
+    # @rbs return: void
     def render(start_x, start_y, end_x, end_y)
       render_line(start_x, start_y, end_x, end_y, @color)
     end
 
   private
 
+    # @rbs start_x: Float | Integer
+    # @rbs start_y: Float | Integer
+    # @rbs end_x: Float | Integer
+    # @rbs end_y: Float | Integer
+    # @rbs color: String
+    # @rbs return: void
     def render_line(start_x, start_y, end_x, end_y, color)
       # FIXME(uwe): Workaround for Issue #66
       #             https://github.com/topfunky/gruff/issues/66

data/lib/gruff/renderer/polygon.rb

@@ -17,6 +17,7 @@ module Gruff
     end
 
     # @rbs points: Array[Float | Integer]
+    # @rbs return: void
     def render(points)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)

data/lib/gruff/renderer/polyline.rb

@@ -18,6 +18,7 @@ module Gruff
     end
 
     # @rbs points: Array[Float | Integer]
+    # @rbs return: void
     def render(points)
       @renderer.draw.push
       @renderer.draw.stroke_linejoin(@linejoin)

data/lib/gruff/renderer/rectangle.rb

@@ -21,6 +21,7 @@ module Gruff
     # @rbs upper_left_y: Float | Integer
     # @rbs lower_right_x: Float | Integer
     # @rbs lower_right_y: Float | Integer
+    # @rbs return: void
     def render(upper_left_x, upper_left_y, lower_right_x, lower_right_y)
       @renderer.draw.push
       @renderer.draw.stroke_width(@width)