gruff 0.26.0-java → 0.27.0-java

data/lib/gruff/store/store.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   # @private
   class Store
-    attr_reader :data
+    attr_reader :data #: Array[Gruff::Store::BasicData | Gruff::Store::XYData | Gruff::Store::XYPointsizeData]
 
+    # @rbs return: void
     def initialize(data_class)
       @data_class = data_class
       @data = []
@@ -14,40 +17,48 @@ module Gruff
       @data << @data_class.new(*args)
     end
 
+    # @rbs return: Array[Gruff::Store::BasicData | Gruff::Store::XYData | Gruff::Store::XYPointsizeData]
     def norm_data
       @norm_data || []
     end
 
     def normalize(**keywords)
-      @norm_data = @data.map { |data_row| data_row.normalize(**keywords) }
+      @norm_data = @data.map { |data_row| data_row.normalize(**keywords) } # steep:ignore
     end
 
+    # @rbs return: bool
     def empty?
       @data.all?(&:empty?)
     end
 
+    # @rbs return: Integer
     def length
       @data.length
     end
 
+    # @rbs return: Integer
     def columns
       @columns ||= @data.empty? ? 0 : @data.map(&:columns).max
     end
 
+    # @rbs return: Float | Integer
     def min
       @min ||= @data.filter_map(&:min).min
     end
     alias min_y min
 
+    # @rbs return: Float | Integer
     def max
       @max ||= @data.filter_map(&:max).max
     end
     alias max_y max
 
+    # @rbs return: Float | Integer
     def min_x
       @min_x ||= @data.filter_map(&:min_x).min
     end
 
+    # @rbs return: Float | Integer
     def max_x
       @max_x ||= @data.filter_map(&:max_x).max
     end
@@ -60,14 +71,16 @@ module Gruff
       @norm_data = @norm_data.sort_by { |a| -a.points.sum(&:to_f) }
     end
 
+    # @rbs return: Array[Gruff::Store::BasicData | Gruff::Store::XYData | Gruff::Store::XYPointsizeData]
     def reverse!
       @data.reverse!
     end
 
+    # @rbs colors: Array[String]
     def change_colors(colors)
       index = 0
       @data.each do |data_row|
-        data_row.color ||= begin
+        data_row.color ||= begin # steep:ignore
           index = (index + 1) % colors.length
           colors[index - 1]
         end

data/lib/gruff/store/xy_data.rb

@@ -1,49 +1,79 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   class Store
     # @private
-    class XYData < Struct.new(:label, :x_points, :y_points, :color)
+    class XYData
+      attr_accessor :label #: String
+      attr_accessor :x_points #: Array[nil | Float | Integer]
+      attr_accessor :y_points #: Array[nil | Float | Integer]
+      attr_accessor :color #: String
+
+      # @rbs label: String | Symbol
+      # @rbs x_points: Array[nil | Float | Integer] | nil
+      # @rbs y_points: Array[nil | Float | Integer] | nil
+      # @rbs color: String
       def initialize(label, x_points, y_points, color)
         y_points = Array(y_points)
         x_points = x_points ? Array(x_points) : Array.new(y_points.length)
         raise ArgumentError, 'x_points.length != y_points.length!' if x_points.length != y_points.length
 
-        super(label.to_s, x_points, y_points, color)
+        @label = label.to_s
+        @x_points = x_points
+        @y_points = y_points
+        @color = color
       end
 
       alias points y_points
 
+      # @rbs return: Array[[Float | Integer | nil, Float | Integer | nil]]
       def coordinates
         x_points.zip(y_points)
       end
 
+      def coordinate_and_pointsizes
+        raise NotImplementedError, 'This method is not implemented for XYData'
+      end
+
+      # @rbs return: bool
       def empty?
         y_points.empty?
       end
 
+      # @rbs return: Integer
       def columns
         y_points.length
       end
 
+      # @rbs return: Float | Integer
       def min
         y_points.compact.min
       end
       alias min_y min
 
+      # @rbs return: Float | Integer
       def max
         y_points.compact.max
       end
       alias max_y max
 
+      # @rbs return: Float | Integer
       def min_x
         x_points.compact.min
       end
 
+      # @rbs return: Float | Integer
       def max_x
         x_points.compact.max
       end
 
+      # @rbs minimum_x: Float | Integer
+      # @rbs minimum_y: Float | Integer
+      # @rbs spread_x: Float | Integer
+      # @rbs spread_y: Float | Integer
+      # @rbs return: Gruff::Store::XYData
       def normalize(minimum_x:, minimum_y:, spread_x:, spread_y:)
         norm_x_points = x_points.map do |x|
           x.nil? ? nil : (x.to_f - minimum_x.to_f) / spread_x

data/lib/gruff/store/xy_pointsizes_data.rb

@@ -1,50 +1,83 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   class Store
     # @private
-    class XYPointsizeData < Struct.new(:label, :x_points, :y_points, :point_sizes, :color)
+    class XYPointsizeData
+      attr_accessor :label #: String
+      attr_accessor :x_points #: Array[nil | Float | Integer]
+      attr_accessor :y_points #: Array[nil | Float | Integer]
+      attr_accessor :point_sizes #: Array[nil | Float | Integer]
+      attr_accessor :color #: String
+
+      # @rbs label: String | Symbol
+      # @rbs x_points: Array[nil | Float | Integer] | nil
+      # @rbs y_points: Array[nil | Float | Integer] | nil
+      # @rbs point_sizes: Array[nil | Float | Integer]
+      # @rbs color: String
       def initialize(label, x_points, y_points, point_sizes, color)
         y_points = Array(y_points)
         x_points = x_points ? Array(x_points) : Array.new(y_points.length)
         raise ArgumentError, 'x_points.length != y_points.length!'    if x_points.length != y_points.length
         raise ArgumentError, 'x_points.length != point_sizes.length!' if x_points.length != point_sizes.length
 
-        super(label.to_s, x_points, y_points, point_sizes, color)
+        @label = label.to_s
+        @x_points = x_points
+        @y_points = y_points
+        @point_sizes = point_sizes
+        @color = color
       end
 
       alias points y_points
 
+      def coordinates
+        raise NotImplementedError, 'This method is not implemented for XYPointsizeData'
+      end
+
+      # @rbs return: Array[[Float | Integer | nil, Float | Integer | nil, Float | Integer]]
       def coordinate_and_pointsizes
-        x_points.zip(y_points, point_sizes)
+        x_points.zip(y_points, point_sizes) #: Array[[Float | Integer | nil, Float | Integer | nil, Float | Integer]]
       end
 
+      # @rbs return: bool
       def empty?
         y_points.empty?
       end
 
+      # @rbs return: Integer
       def columns
         y_points.length
       end
 
+      # @rbs return: Float | Integer
       def min
         y_points.compact.min
       end
       alias min_y min
 
+      # @rbs return: Float | Integer
       def max
         y_points.compact.max
       end
       alias max_y max
 
+      # @rbs return: Float | Integer
       def min_x
         x_points.compact.min
       end
 
+      # @rbs return: Float | Integer
       def max_x
         x_points.compact.max
       end
 
+      # @rbs minimum_x: Float | Integer
+      # @rbs minimum_y: Float | Integer
+      # @rbs spread_x: Float | Integer
+      # @rbs spread_y: Float | Integer
+      # @rbs return: Gruff::Store::XYPointsizeData
       def normalize(minimum_x:, minimum_y:, spread_x:, spread_y:)
         norm_x_points = x_points.map do |x|
           x.nil? ? nil : (x.to_f - minimum_x.to_f) / spread_x

data/lib/gruff/themes.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
   module Themes
     # A color scheme similar to the popular presentation software.

data/lib/gruff/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 module Gruff
-  VERSION = '0.26.0'
+  VERSION = '0.27.0'
 end

data/lib/gruff.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rbs_inline: enabled
+
 require 'rmagick'
 
 require_relative 'gruff/patch/rmagick'
@@ -16,7 +18,7 @@ require_relative 'gruff/version'
 module Gruff
   # @private
   def self.libpath(path)
-    File.join(__dir__, 'gruff', path)
+    File.join(__dir__, 'gruff', path) # steep:ignore
   end
 
   autoload :BarConversion, Gruff.libpath('helper/bar_conversion')

data/sig/generated/gruff/accumulator_bar.rbs

@@ -0,0 +1,19 @@
+# Generated from lib/gruff/accumulator_bar.rb with RBS::Inline
+
+#
+#  Gruff::AccumulatorBar is a special bar graph that shows a
+#  single dataset as a set of stacked bars.
+#  The bottom bar shows the running total and the top bar shows
+#  the new value being added to the array.
+#
+#  Here's how to set up a Gruff::AccumulatorBar.
+#
+#    g = Gruff::AccumulatorBar.new
+#    g.title = 'Your Savings'
+#    g.data 'First', [1, 1, 1]
+#    g.write('accumulator_bar.png')
+class Gruff::AccumulatorBar < Gruff::StackedBar
+  private
+
+  def setup_data: () -> untyped
+end

data/sig/generated/gruff/area.rbs

@@ -0,0 +1,27 @@
+# Generated from lib/gruff/area.rb with RBS::Inline
+
+#
+#  Gruff::Area provides an area graph which displays graphically
+#  quantitative data.
+#
+#  Here's how to set up a Gruff::Area.
+#
+#    g = Gruff::Area.new
+#    g.title = 'Area Graph'
+#    g.data :Jimmy, [25, 36, 86, 39, 25, 31, 79, 88]
+#    g.data :Charles, [80, 54, 67, 54, 68, 70, 90, 95]
+#    g.data :Julie, [22, 29, 35, 38, 36, 40, 46, 57]
+#    g.write('area.png')
+class Gruff::Area < Gruff::Base
+  # Specifies the filling opacity in area graph. Default is +0.85+.
+  attr_writer fill_opacity: Float | Integer
+
+  # Specifies the stroke width in line around area graph. Default is +2.0+.
+  attr_writer stroke_width: Float | Integer
+
+  private
+
+  def initialize_attributes: () -> untyped
+
+  def draw_graph: () -> untyped
+end

data/sig/generated/gruff/bar.rbs

@@ -0,0 +1,74 @@
+# Generated from lib/gruff/bar.rb with RBS::Inline
+
+#
+#  Gruff::Bar provide a bar graph that presents categorical data
+#  with rectangular bars.
+#
+#  Here's how to set up a Gruff::Bar.
+#
+#    g = Gruff::Bar.new
+#    g.title = 'Bar Graph With Manual Colors'
+#    g.spacing_factor = 0.1
+#    g.group_spacing = 20
+#    g.data :Art, [0, 5, 8, 15], '#990000'
+#    g.data :Philosophy, [10, 3, 2, 8], '#009900'
+#    g.data :Science, [2, 15, 8, 11], '#990099'
+#    g.write('bar.png')
+class Gruff::Bar < Gruff::Base
+  include Gruff::Base::BarMixin
+
+  # Spacing factor applied between bars.
+  attr_writer bar_spacing: Float | Integer
+
+  # Spacing factor applied between a group of bars belonging to the same label.
+  attr_writer group_spacing: Float | Integer
+
+  # Set the number output format string or lambda.
+  # Default is +"%.2f"+.
+  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: bool
+
+  # Prevent drawing of column labels below a bar graph.  Default is +false+.
+  attr_writer hide_labels: bool
+
+  # Value to avoid completely overwriting the coordinate axis
+  AXIS_MARGIN: ::Float
+
+  # 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
+  # and 1 means that each bars' width is nearly 0 (so each bar is a simple
+  # line with no x dimension).
+  #
+  # Default value is +0.9+.
+  #
+  # @rbs space_percent: Float | Integer
+  def spacing_factor=: (Float | Integer space_percent) -> untyped
+
+  private
+
+  def initialize_attributes: () -> untyped
+
+  def setup_drawing: () -> untyped
+
+  # @rbs return: bool
+  def hide_labels?: () -> bool
+
+  # @rbs return: bool
+  def hide_left_label_area?: () -> bool
+
+  # @rbs return: bool
+  def hide_bottom_label_area?: () -> bool
+
+  def setup_graph_measurements: () -> untyped
+
+  def draw_graph: () -> untyped
+
+  # @rbs return: Float | Integer
+  def calculate_spacing: () -> (Float | Integer)
+
+  # @rbs return: Proc
+  def proc_text_metrics: () -> Proc
+end