text_chart 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bcc9a9d069cb1fc77252328c76b956bd69024bde31ae55bde6ce6d99d995be0
-  data.tar.gz: e281cc003c4f57706e66a321e3e107b10d334dabe89a108c09c53d61f570e357
+  metadata.gz: 3151e15fd8d9c6ad4d4850b2d7200585644b19212bbac4bc6e8c1cf22b01fd51
+  data.tar.gz: 276efc536bfc80c1e1df0b9378e5d1645fa284bbdf5b7652ff1798f3a3a76edd
 SHA512:
-  metadata.gz: 2c4147b7db9d1d4e4006afb8726ec8054b3308fa805e7ae8b57fa70fae0967e73e572303050a05ef756bccc19b6fd861a217f55b637686a99c85acfc7df2a32b
-  data.tar.gz: d42511067db1a0a4e1c459f47bd28fd26f07368c54fa43e3e9ada5b7c09eefb06d28bcfb47b98bc5a6a8fdab7a46218d950b72d1c0d1249ba9f3fc2bda5b990f
+  metadata.gz: 9f452855f7b707e3bb44735bf75016ebed13665e267c458c17f2ff7f0f0828f94ebb57eafed7f8a88c507d1e4a864ebefc3764ee608e16f26d6a3bfb56c1cfbb
+  data.tar.gz: ce3e6d56b4844b95f843954a39acf4e62344b02d6fbb752e396958085cd255240a0fad8a04cc2189f79f3eaf456dcecdd3af41312f5377ea8b04fcf10337428b

data/lib/text_chart/designer.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class TextChart::Designer
   # @param [TextChart] text_chart
   # @param [TextChart::SizeCalculator] size_calc
@@ -14,7 +12,7 @@ class TextChart::Designer
   def draw_header
     header = []
     header << "#{@text_chart.title}\n"
-    header << "Goal: #{@text_chart.goal}\n"
+    header << "#{@text_chart.subtitle}\n"
     header << "\n"
 
     @chart_canvas.prepend(*header)
@@ -36,40 +34,46 @@ class TextChart::Designer
     chart_line = 0
     ref_width = @size_calc.calculate_reference_width
     y_axis_width = @text_chart.size_config(:y_axis_width)
-    first_bar_margin = y_axis_width + @text_chart.size_config(:bar_area_left_margin)
-    middle_bar_margin = @text_chart.size_config(:bar_spacing)
+    bar_margin = @text_chart.size_config(:bar_margin)
     bar_row = "###"
     bar_width = @text_chart.size_config(:bar_width)
-    bar_height = bar_start = bar_end = bar_top = 0
-
-    @text_chart.data.each do |d|
-      # + 1 to guarantee that the bar will always be rendered
-      bar_height = d + 1
+    bar_start = bar_end = bar_top = 0
+    height_of_bars = define_height_of_bars
 
+    height_of_bars.each do |height|
       bar_start = if bar_start == 0
-        ref_width + first_bar_margin
+        ref_width + bar_margin + y_axis_width
       else
         # + 1 because bar_end put us on the bar last column
-        bar_end + 1 + middle_bar_margin
+        bar_end + 1 + bar_margin
       end
 
       # - 1 because bar_start already put us on the bar first column
       bar_end = bar_start + bar_width - 1
 
       chart_line = zero_line
-      bar_top = bar_height - 1
-      bar_height.times do |t|
+      bar_top = height - 1
+      height.times do |t|
         @chart_canvas[chart_line][bar_start..bar_end] = bar_row
 
         chart_line -= 1 unless t == bar_top
       end
-
-      draw_reference_line(chart_line, ref_width + y_axis_width, bar_start)
     end
 
     @chart_canvas
   end
 
+  # @return [Array<String>]
+  def paint
+    @chart_canvas.map do |row|
+      next if row.gsub!(@text_chart.title, colorize(@text_chart.title, :bold))
+
+      row.gsub!(/-?\d/) { colorize($&, :cyan) }
+      row.gsub!(/#+/) { colorize($&, :blue) }
+    end
+    @chart_canvas
+  end
+
   private
 
   def build_empty_chart
@@ -107,34 +111,43 @@ class TextChart::Designer
   end
 
   def draw_references
-    references = @text_chart.refs
+    references = @text_chart.data
     width = @size_calc.calculate_reference_width
-    number_of_references = references.size
-    ref_size = ref_start = ref_end = nil
-    margin_size = @text_chart.size_config(:reference_and_y_axis_margin)
+    y_axis_size = @size_calc.calculate_y_axis_size
+    ref_size = ref_start = ref_end = ref_str = nil
 
-    number_of_references.times do |i|
-      ref_size = references[i].digits.size
+    references.each do |r|
+      row = y_axis_size - @size_calc.calculate_bar_height(r)
+      ref_str = r.to_s
+      ref_size = ref_str.size
 
-      if ref_size == (width - margin_size)
+      if ref_size == width
         ref_start = 0
         ref_end = ref_size - 1
-        @chart_canvas[i][ref_start..ref_end] = references[i].to_s
       else
-        ref_start = ref_size
-        @chart_canvas[i][ref_start] = references[i].to_s
+        ref_start = width - ref_size
+        ref_end = [ref_start, ref_size].max
       end
+      @chart_canvas[row][ref_start..ref_end] = ref_str
     end
   end
 
-  def draw_reference_line(chart_line, line_start, line_end)
-    current_position = line_start
-    until current_position == line_end
-      if @chart_canvas[chart_line][current_position] != "#"
-        @chart_canvas[chart_line][current_position] = "'"
-      end
-
-      current_position += 1
+  # @param string to be colorized [String]
+  # @param desired color/formatting [Symbol]
+  # @return colorized string [String]
+  def colorize(str, format)
+    case format
+    when :bold
+      "\e[1m#{str}\e[22m"
+    when :cyan
+      "\e[36m#{str}\e[0m"
+    when :blue
+      "\e[34m#{str}\e[0m"
     end
   end
+
+  # @return height of each sample item [Array<Integer>]
+  def define_height_of_bars
+    @text_chart.data.map { |i| @size_calc.calculate_bar_height(i) }
+  end
 end

data/lib/text_chart/size_calculator.rb

@@ -17,14 +17,14 @@ class TextChart::SizeCalculator
         y_axis_width = @text_chart.size_config(:y_axis_width)
         result += y_axis_width
 
-        left_margin = @text_chart.size_config(:bar_area_left_margin)
-        right_margin = @text_chart.size_config(:bar_area_right_margin)
+        left_margin = @text_chart.size_config(:bar_margin)
+        right_margin = @text_chart.size_config(:bar_margin)
         result += left_margin + right_margin
 
         bar_width = @text_chart.size_config(:bar_width)
         result += @text_chart.data.size * bar_width
 
-        bar_spacing = @text_chart.size_config(:bar_spacing)
+        bar_spacing = @text_chart.size_config(:bar_margin)
         # -1 to avoid adding spacing after the last bar.
         result += (@text_chart.data.size - 1) * bar_spacing
 
@@ -36,10 +36,8 @@ class TextChart::SizeCalculator
   def calculate_reference_width
     @reference_width ||=
       begin
-        biggest_item = @text_chart.data.max
-        biggest_item_width = biggest_item.digits.count
-        reference_margin = @text_chart.size_config(:reference_and_y_axis_margin)
-        biggest_item_width + reference_margin
+        biggest_number_size = @text_chart.data.map(&:to_s).map(&:size).max
+        biggest_number_size
       end
   end
 
@@ -52,14 +50,23 @@ class TextChart::SizeCalculator
         x_axis_row = @text_chart.size_config(:x_axis_height)
         result += x_axis_row
 
-        reference_row = @text_chart.size_config(:reference_row_height)
-        number_of_references = @text_chart.refs.size
-        number_of_references.times { result += reference_row }
+        calculate_bar_height(@text_chart.data.max).times do
+          result += @text_chart.size_config(:bar_row_height)
+        end
 
         result
       end
   end
 
+  # @param bar [Integer]
+  # @return the number of rows that we should render [Integer]
+  def calculate_bar_height(bar)
+    return 0 if bar.zero?
+
+    min_bar_height = 1
+    (calculate_increase_percentile(@text_chart.data.min, bar) / bar_height_limiter).round + min_bar_height
+  end
+
   # @return [Integer]
   def calculate_x_axis_size
     @x_axis_size ||= calculate_number_of_columns - calculate_reference_width
@@ -73,4 +80,27 @@ class TextChart::SizeCalculator
         calculate_number_of_rows - x_axis_row
       end
   end
+
+  private
+
+  # @param initial value [Numeric]
+  # @param final value [Numeric]
+  # @return increase percentile [Float]
+  def calculate_increase_percentile(initial, final)
+    float_initial = initial.to_f
+    float_final = final.to_f
+    diff = float_final - float_initial
+    (diff / float_initial) * 100.0
+  end
+
+  # @return the denominator to assure the `max_rows` config [Integer]
+  def bar_height_limiter
+    @bar_height_limiter ||=
+      begin
+        limiter = 10.0
+        max_diff = calculate_increase_percentile(@text_chart.data.min, @text_chart.data.max)
+        limiter *= 10.0 until (max_diff / limiter).round <= @text_chart.size_config(:max_bar_height)
+        limiter
+      end
+  end
 end

data/lib/text_chart/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TextChart
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/text_chart.rb

@@ -8,41 +8,53 @@ require_relative "text_chart/designer"
 # representing the chart, just like this one:
 #
 # text_chart demonstration
-# Goal: Show you how cool this is
+# Show you how cool this is
 #
-# 9 |'''''''''''''''''''''''''''''''''''''''''''''''''''''###
-# 8 |                                                     ###
-# 7 |                                                     ###
-# 6 |'''''''''''''###                                     ###
-# 5 |'''''''''''''###'''''''''''''''''''''''''''###       ###
-# 4 |'''''''''''''###'''''''''''''''''''''''''''###'''''''###'''''''###
-# 3 |'''###'''''''###'''''''''''''''''###       ###       ###       ###
-# 2 |   ###       ###                 ###       ###       ###       ###
-# 1 |   ###       ###                 ###       ###       ###       ###
-# 0 |'''###'''''''###'''''''###       ###       ###       ###       ###
-#   ----------------------------------------------------------------------
+# 73|                                                         ###
+#   |                                                         ###
+# 67|             ###             ###                         ###         ###
+#   |             ###             ###                         ###         ###
+# 54|     ###     ###     ###     ###                         ### ###     ###
+#   |     ###     ###     ###     ###                         ### ###     ###
+# 44|     ### ### ###     ###     ###     ###                 ### ###     ### ###
+#   |     ### ### ###     ###     ###     ###                 ### ###     ### ###
+# 33|     ### ### ###     ### ### ###     ###                 ### ###     ### ###
+#   |     ### ### ###     ### ### ###     ###                 ### ###     ### ###
+# 27|     ### ### ### ### ### ### ###     ###         ### ### ### ###     ### ###
+# 20|     ### ### ### ### ### ### ###     ###     ### ### ### ### ### ### ### ###
+# 14| ### ### ### ### ### ### ### ### ### ###     ### ### ### ### ### ### ### ###
+# 10| ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
+#  5| ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
+#   ----------------------------------------------------------------------------------
 class TextChart
   class Error < StandardError; end
 
   # @param [String] title
-  # @param [String] goal
+  # @param [String] subtitle
   # @param [Array] data
-  def initialize(title, goal, data)
+  # @param [Boolean] colors
+  def initialize(title, subtitle, data, colors = false)
+    raise Error, "`data` cannot be empty" if data.empty?
+
     @title = title
-    @goal = goal
-    @data = data.empty? ? [0] : data
-    @refs = define_references
+    @subtitle = subtitle
+    @data = data.empty? ? [0] : data.filter(&:positive?)
+    @colors = colors
     @size_calculator = SizeCalculator.new(self)
     @designer = Designer.new(self, @size_calculator)
   end
 
-  attr_reader :title, :goal, :refs, :data, :size_calculator, :designer
+  attr_reader :title, :subtitle, :data, :size_calculator, :designer
 
   # @return [String]
   def to_s
-    @designer.draw_axis
-    @designer.draw_bars
-    @designer.draw_header.join
+    result = @designer.draw_axis &&
+      @designer.draw_bars &&
+      @designer.draw_header
+
+    result = @designer.paint if @colors
+
+    result.join
   end
 
   # @param [Symbol] key
@@ -55,18 +67,10 @@ class TextChart
 
   SIZE_CONFIG = {
     y_axis_width: 1,
-    bar_area_left_margin: 3,
-    bar_area_right_margin: 3,
+    bar_margin: 1,
     bar_width: 3,
-    bar_spacing: 7,
-    reference_and_y_axis_margin: 1,
     x_axis_height: 1,
-    reference_row_height: 1
+    bar_row_height: 1,
+    max_bar_height: 60
   }
-
-  def define_references
-    r = [*@data.min..@data.max].reverse
-    r << 0 unless r.include?(0)
-    r
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: text_chart
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gustavo Ribeiro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-24 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies: []
 description:
 email: