gruff 0.28.0-java → 0.30.0-java

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 module Gruff
   # @private
@@ -16,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)

data/lib/gruff/renderer/renderer.rb

@@ -6,9 +6,9 @@ module Gruff
   # @private
   class Renderer
     attr_accessor :text_renderers #: Array[Gruff::Renderer::Text]
-    attr_reader :draw
-    attr_reader :image
-    attr_reader :scale #: real
+    attr_reader :draw #: untyped
+    attr_reader :image #: untyped
+    attr_reader :scale #: Float | Integer
 
     # @rbs columns: Integer
     # @rbs rows: Integer
@@ -24,6 +24,7 @@ module Gruff
       @image = background(columns, rows, scale, theme_options)
     end
 
+    # @rbs return: void
     def finish
       @draw.draw(@image)
 
@@ -34,12 +35,18 @@ module Gruff
 
     # @rbs columns: Integer
     # @rbs rows: Integer
+    # @rbs return: void
     def transparent_background(columns, rows)
       @image = render_transparent_background(columns, rows)
     end
 
   private
 
+    # @rbs columns: Integer
+    # @rbs rows: Integer
+    # @rbs scale: Float | Integer
+    # @rbs theme_options: ::Hash[Symbol, untyped]
+    # @rbs return: void
     def background(columns, rows, scale, theme_options)
       return image_background(scale, *theme_options[:background_image]) if theme_options[:background_image] # steep:ignore
 
@@ -54,6 +61,9 @@ module Gruff
     end
 
     # Use with a theme to use an image (800x600 original) background.
+    # @rbs scale: Float | Integer
+    # @rbs image_path: String
+    # @rbs return: untyped
     def image_background(scale, image_path)
       image = Magick::Image.read(image_path)
       if scale != 1.0
@@ -63,6 +73,10 @@ module Gruff
     end
 
     # Make a new image at the current size with a solid +color+.
+    # @rbs columns: Integer
+    # @rbs rows: Integer
+    # @rbs color: String
+    # @rbs return: void
     def solid_background(columns, rows, color)
       Magick::Image.new(columns, rows) do |img|
         img.background_color = color
@@ -70,6 +84,12 @@ module Gruff
     end
 
     # Use with a theme definition method to draw a gradated background.
+    # @rbs columns: Integer
+    # @rbs rows: Integer
+    # @rbs top_color: String
+    # @rbs bottom_color: String
+    # @rbs direct: Symbol
+    # @rbs return: void
     def gradated_background(columns, rows, top_color, bottom_color, direct = :top_bottom)
       gradient_fill = begin
         case direct
@@ -105,6 +125,9 @@ module Gruff
     end
 
     # Use with a theme to make a transparent background
+    # @rbs columns: Integer
+    # @rbs rows: Integer
+    # @rbs return: void
     def render_transparent_background(columns, rows)
       Magick::Image.new(columns, rows) do |img|
         img.background_color = 'transparent'

data/lib/gruff/renderer/text.rb

@@ -11,6 +11,7 @@ module Gruff
     # @rbs text: String
     # @rbs font: Gruff::Font
     # @rbs rotation: Float | Integer
+    # @rbs return: void
     def initialize(renderer, text, font:, rotation: nil)
       @renderer = renderer
       @text = text.to_s
@@ -19,13 +20,14 @@ module Gruff
     end
 
     attr_reader :width, :height, :x, :y #: Float | Integer
-    attr_reader :gravity
+    attr_reader :gravity #: untyped
 
     # @rbs width: Float | Integer
     # @rbs height: Float | Integer
     # @rbs x: Float | Integer
     # @rbs y: Float | Integer
     # @rbs gravity: untyped
+    # @rbs return: void
     def add_to_render_queue(width, height, x, y, gravity = Magick::NorthGravity)
       @width = width
       @height = height
@@ -41,6 +43,7 @@ module Gruff
     # @rbs x: Float | Integer
     # @rbs y: Float | Integer
     # @rbs gravity: untyped
+    # @rbs return: void
     def render(width, height, x, y, gravity = Magick::NorthGravity)
       @renderer.draw.push
       @renderer.draw.rotation = @rotation if @rotation
@@ -58,6 +61,7 @@ module Gruff
       @renderer.draw.pop
     end
 
+    # @rbs return: untyped
     def metrics
       @renderer.draw.push
       @renderer.draw.font = @font.file_path

data/lib/gruff/scatter.rb

@@ -31,6 +31,8 @@ class Gruff::Scatter < Gruff::Base
 
   # Allow enabling vertical lines. When you have a lot of data, they can work great.
   # @deprecated Please use {#show_vertical_markers=} instead.
+  # @rbs value: bool
+  # @rbs return: void
   def enable_vertical_line_markers=(value)
     warn '#enable_vertical_line_markers= is deprecated. Please use `show_vertical_markers` attribute instead'
     @show_vertical_markers = value
@@ -38,12 +40,16 @@ class Gruff::Scatter < Gruff::Base
 
   # Allow using vertical labels in the X axis.
   # @deprecated Please use {Gruff::Base#label_rotation=} instead.
+  # @rbs _value: untyped
+  # @rbs return: void
   def use_vertical_x_labels=(_value)
     warn '#use_vertical_x_labels= is deprecated. It is no longer effective. Please use `#label_rotation=` instead'
   end
 
   # Allow using vertical labels in the X axis (and setting the label margin).
   # @deprecated
+  # @rbs _value: untyped
+  # @rbs return: void
   def x_label_margin=(_value)
     warn '#x_label_margin= is deprecated. It is no longer effective.'
   end
@@ -51,6 +57,8 @@ class Gruff::Scatter < Gruff::Base
   # Allow disabling the significant rounding when labeling the X axis.
   # This is useful when working with a small range of high values (for example, a date range of months, while seconds as units).
   # @deprecated
+  # @rbs _value: untyped
+  # @rbs return: void
   def disable_significant_rounding_x_axis=(_value)
     warn '#disable_significant_rounding_x_axis= is deprecated. It is no longer effective.'
   end
@@ -93,6 +101,7 @@ class Gruff::Scatter < Gruff::Base
   # @rbs x_data_points: Array[nil | Float | Integer] | nil
   # @rbs y_data_points: Array[nil | Float | Integer] | nil
   # @rbs color: String
+  # @rbs return: void
   def data(name, x_data_points = [], y_data_points = [], color = nil)
     # make sure it's an array
     x_data_points = Array(x_data_points)
@@ -111,10 +120,12 @@ class Gruff::Scatter < Gruff::Base
 
 private
 
+  # @rbs return: void
   def initialize_store
     @store = Gruff::Store.new(Gruff::Store::XYData)
   end
 
+  # @rbs return: void
   def initialize_attributes
     super
 
@@ -125,11 +136,13 @@ private
     @stroke_width = nil
   end
 
+  # @rbs return: void
   def setup_drawing
     @center_labels_over_point = false
     super
   end
 
+  # @rbs return: void
   def setup_data
     # TODO: Need to get x-axis labels working. Current behavior will be to not allow.
     @labels = {}
@@ -147,6 +160,7 @@ private
     super
   end
 
+  # @rbs return: void
   def draw_graph
     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)
@@ -163,18 +177,21 @@ private
     end
   end
 
+  # @rbs return: void
   def calculate_spread
     super
     @x_spread = @maximum_x_value.to_f - @minimum_x_value.to_f
     @x_spread = @x_spread > 0 ? @x_spread : 1.0
   end
 
+  # @rbs return: void
   def normalize
     return unless data_given?
 
     store.normalize(minimum_x: @minimum_x_value, spread_x: @x_spread, minimum_y: minimum_value, spread_y: @spread)
   end
 
+  # @rbs return: void
   def draw_line_markers
     # do all of the stuff for the horizontal lines on the y-axis
     super

data/lib/gruff/side_bar.rb

@@ -55,12 +55,15 @@ class Gruff::SideBar < Gruff::Base
 
   # With Side Bars use the data label for the marker value to the left of the bar.
   # @deprecated
+  # @rbs _value: untyped
+  # @rbs return: void
   def use_data_label=(_value)
     warn '#use_data_label is deprecated. It is no longer effective.'
   end
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
     @bar_spacing = 0.9
@@ -85,6 +88,7 @@ private
     @hide_line_markers && @x_axis_label.nil? && @legend_at_bottom == false
   end
 
+  # @rbs return: void
   def setup_graph_measurements
     super
     return if @hide_line_markers
@@ -105,6 +109,7 @@ private
     end
   end
 
+  # @rbs return: void
   def draw_graph
     # Setup spacing.
     #
@@ -148,6 +153,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
 
@@ -176,6 +182,9 @@ private
   ##
   # Draw on the Y axis instead of the X
 
+  # @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/side_stacked_bar.rb

@@ -52,6 +52,7 @@ class Gruff::SideStackedBar < Gruff::SideBar
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
     @bar_spacing = 0.9
@@ -62,11 +63,13 @@ private
     @minimum_value = 0.0
   end
 
+  # @rbs return: void
   def setup_data
     calculate_maximum_by_stack
     super
   end
 
+  # @rbs return: void
   def draw_graph
     # Setup spacing.
     #

data/lib/gruff/spider.rb

@@ -30,12 +30,14 @@ class Gruff::Spider < Gruff::Base
   end
 
   # @rbs value: bool
+  # @rbs return: void
   def hide_text=(value)
     @hide_title = @hide_text = value
   end
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
     @hide_legend = true
@@ -48,11 +50,13 @@ private
     @hide_line_markers.freeze
   end
 
+  # @rbs return: void
   def setup_drawing
     @center_labels_over_point = false
     super
   end
 
+  # @rbs return: void
   def setup_graph_measurements
     super
 
@@ -65,12 +69,14 @@ private
     @graph_height = @graph_bottom - @graph_top
   end
 
+  # @rbs return: void
   def setup_data
     raise(Gruff::IncorrectNumberOfDatasetsException, 'Requires 3 or more data sets') if store.length < 3
 
     super
   end
 
+  # @rbs return: void
   def draw_graph
     # Setup basic positioning
     radius = @graph_height / 2.0
@@ -88,11 +94,18 @@ private
     draw_polygon(center_x, center_y, additive_angle)
   end
 
-  # @rbs value: nil | Float | Integer
+  # @rbs value: Float | Integer
+  # @rbs return: Float
   def normalize_points(value)
-    value.to_f * @unit_length
+    (value.to_f * @unit_length).to_f
   end
 
+  # @rbs center_x: Float | Integer
+  # @rbs center_y: Float | Integer
+  # @rbs angle: Float | Integer
+  # @rbs radius: Float | Integer
+  # @rbs amount: Float | Integer
+  # @rbs return: void
   def draw_label(center_x, center_y, angle, radius, amount)
     degree = rad2deg(angle)
     metrics = text_metrics(@marker_font, amount)
@@ -118,6 +131,12 @@ private
     draw_label_at(metrics.width, metrics.height, x, y, amount, gravity: Magick::CenterGravity)
   end
 
+  # @rbs center_x: Float | Integer
+  # @rbs center_y: Float | Integer
+  # @rbs radius: Float | Integer
+  # @rbs additive_angle: Float | Integer
+  # @rbs line_color: String | nil
+  # @rbs return: void
   def draw_axes(center_x, center_y, radius, additive_angle, line_color = nil)
     return if @hide_axes
 
@@ -136,6 +155,11 @@ private
     end
   end
 
+  # @rbs center_x: Float | Integer
+  # @rbs center_y: Float | Integer
+  # @rbs additive_angle: Float | Integer
+  # @rbs color: String | nil
+  # @rbs return: void
   def draw_polygon(center_x, center_y, additive_angle, color = nil)
     points = []
     current_angle = deg2rad(@rotation)

data/lib/gruff/stacked_area.rb

@@ -18,22 +18,27 @@ class Gruff::StackedArea < Gruff::Base
   include Gruff::Base::StackedMixin
 
   # @deprecated
+  # @rbs _value: untyped
+  # @rbs return: void
   def last_series_goes_on_bottom=(_value)
     warn '#last_series_goes_on_bottom is deprecated. It is no longer effective.'
   end
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
     @minimum_value = 0.0
   end
 
+  # @rbs return: void
   def setup_data
     calculate_maximum_by_stack
     super
   end
 
+  # @rbs return: void
   def draw_graph
     x_increment = (@graph_width / (column_count - 1)).to_f
 

data/lib/gruff/stacked_bar.rb

@@ -36,6 +36,7 @@ class Gruff::StackedBar < Gruff::Base
 
 private
 
+  # @rbs return: void
   def initialize_attributes
     super
     @bar_spacing = 0.9
@@ -46,6 +47,7 @@ private
     @minimum_value = 0.0
   end
 
+  # @rbs return: void
   def setup_drawing
     # Labels will be centered over the left of the bar if
     # there are more labels than columns. This is basically the same
@@ -55,11 +57,13 @@ private
     super
   end
 
+  # @rbs return: void
   def setup_data
     calculate_maximum_by_stack
     super
   end
 
+  # @rbs return: void
   def setup_graph_measurements
     super
     return if @hide_line_markers
@@ -75,6 +79,7 @@ private
   end
 
   # Draws a bar graph, but multiple sets are stacked on top of each other.
+  # @rbs return: void
   def draw_graph
     # Setup spacing.
     #

data/lib/gruff/store/basic_data.rb

@@ -13,6 +13,7 @@ module Gruff
       # @rbs label: String | Symbol
       # @rbs points: Array[nil | Float | Integer] | nil
       # @rbs color: String
+      # @rbs return: void
       def initialize(label, points, color)
         @label = label.to_s
         @points = Array(points)
@@ -21,14 +22,17 @@ module Gruff
 
       alias x_points points
 
+      # @rbs return: void
       def y_points
         raise NotImplementedError, 'x_points is not implemented for BasicData'
       end
 
+      # @rbs return: void
       def coordinates
         raise NotImplementedError, 'This method is not implemented for BasicData'
       end
 
+      # @rbs return: void
       def coordinate_and_pointsizes
         raise NotImplementedError, 'This method is not implemented for BasicData'
       end

data/lib/gruff/store/store.rb

@@ -7,12 +7,15 @@ module Gruff
   class Store
     attr_reader :data #: Array[Gruff::Store::BasicData | Gruff::Store::XYData | Gruff::Store::XYPointsizeData]
 
+    # @rbs data_class: untyped
     # @rbs return: void
     def initialize(data_class)
       @data_class = data_class
       @data = []
     end
 
+    # @rbs *args: untyped
+    # @rbs return: void
     def add(*args)
       @data << @data_class.new(*args)
     end
@@ -22,6 +25,8 @@ module Gruff
       @norm_data || []
     end
 
+    # @rbs **keywords: untyped
+    # @rbs return: untyped
     def normalize(**keywords)
       @norm_data = @data.map { |data_row| data_row.normalize(**keywords) } # steep:ignore
     end
@@ -63,10 +68,12 @@ module Gruff
       @max_x ||= @data.filter_map(&:max_x).max
     end
 
+    # @rbs return: void
     def sort_data!
       @data = @data.sort_by { |a| -a.points.sum(&:to_f) }
     end
 
+    # @rbs return: void
     def sort_norm_data!
       @norm_data = @norm_data.sort_by { |a| -a.points.sum(&:to_f) }
     end
@@ -77,6 +84,7 @@ module Gruff
     end
 
     # @rbs colors: Array[String]
+    # @rbs return: void
     def change_colors(colors)
       index = 0
       @data.each do |data_row|