text_chart 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bcc9a9d069cb1fc77252328c76b956bd69024bde31ae55bde6ce6d99d995be0
+  data.tar.gz: e281cc003c4f57706e66a321e3e107b10d334dabe89a108c09c53d61f570e357
+SHA512:
+  metadata.gz: 2c4147b7db9d1d4e4006afb8726ec8054b3308fa805e7ae8b57fa70fae0967e73e572303050a05ef756bccc19b6fd861a217f55b637686a99c85acfc7df2a32b
+  data.tar.gz: d42511067db1a0a4e1c459f47bd28fd26f07368c54fa43e3e9ada5b7c09eefb06d28bcfb47b98bc5a6a8fdab7a46218d950b72d1c0d1249ba9f3fc2bda5b990f

data/lib/text_chart/designer.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+class TextChart::Designer
+  # @param [TextChart] text_chart
+  # @param [TextChart::SizeCalculator] size_calc
+  # @param [Array<String>] chart_canvas
+  def initialize(text_chart, size_calc)
+    @text_chart = text_chart
+    @size_calc = size_calc
+    @chart_canvas = build_empty_chart
+  end
+
+  # @return [Array<String>]
+  def draw_header
+    header = []
+    header << "#{@text_chart.title}\n"
+    header << "Goal: #{@text_chart.goal}\n"
+    header << "\n"
+
+    @chart_canvas.prepend(*header)
+  end
+
+  # @return [Array<String>]
+  def draw_axis
+    draw_x_axis
+    draw_y_axis
+    draw_references
+
+    @chart_canvas
+  end
+
+  # @return [Array<String>]
+  def draw_bars
+    last_line_index = @chart_canvas.size - 1
+    zero_line = last_line_index - @text_chart.size_config(:x_axis_height)
+    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_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 = if bar_start == 0
+        ref_width + first_bar_margin
+      else
+        # + 1 because bar_end put us on the bar last column
+        bar_end + 1 + middle_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|
+        @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
+
+  private
+
+  def build_empty_chart
+    chart = []
+
+    number_of_columns = @size_calc.calculate_number_of_columns
+    number_of_rows = @size_calc.calculate_number_of_rows
+
+    empty_row = ""
+    number_of_columns.times { empty_row += " " }
+    empty_row += "\n"
+
+    number_of_rows.times { chart << empty_row.dup }
+
+    chart
+  end
+
+  def draw_x_axis
+    position = @size_calc.calculate_reference_width
+    size = @size_calc.calculate_x_axis_size
+    size.times do
+      @chart_canvas.last[position] = "-"
+      position += 1
+    end
+  end
+
+  def draw_y_axis
+    position = 0
+    margin = @size_calc.calculate_reference_width
+    size = @size_calc.calculate_y_axis_size
+    size.times do
+      @chart_canvas[position][margin] = "|"
+      position += 1
+    end
+  end
+
+  def draw_references
+    references = @text_chart.refs
+    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)
+
+    number_of_references.times do |i|
+      ref_size = references[i].digits.size
+
+      if ref_size == (width - margin_size)
+        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
+      end
+    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
+    end
+  end
+end

data/lib/text_chart/size_calculator.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+class TextChart::SizeCalculator
+  # @param [TextChart] text_chart
+  def initialize(text_chart)
+    @text_chart = text_chart
+  end
+
+  # @return [Integer]
+  def calculate_number_of_columns
+    @number_of_columns ||=
+      begin
+        result = 0
+
+        result += calculate_reference_width
+
+        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)
+        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)
+        # -1 to avoid adding spacing after the last bar.
+        result += (@text_chart.data.size - 1) * bar_spacing
+
+        result
+      end
+  end
+
+  # @return [Integer]
+  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
+      end
+  end
+
+  # @return [Integer]
+  def calculate_number_of_rows
+    @number_of_rows ||=
+      begin
+        result = 0
+
+        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 }
+
+        result
+      end
+  end
+
+  # @return [Integer]
+  def calculate_x_axis_size
+    @x_axis_size ||= calculate_number_of_columns - calculate_reference_width
+  end
+
+  # @return [Integer]
+  def calculate_y_axis_size
+    @y_axis_size ||=
+      begin
+        x_axis_row = @text_chart.size_config(:x_axis_height)
+        calculate_number_of_rows - x_axis_row
+      end
+  end
+end

data/lib/text_chart/version.rb

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

data/lib/text_chart.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "text_chart/version"
+require_relative "text_chart/size_calculator"
+require_relative "text_chart/designer"
+
+# This is the main class of the text_chart. After calling the `#to_s` method you'll receive a string
+# representing the chart, just like this one:
+#
+# text_chart demonstration
+# Goal: Show you how cool this is
+#
+# 9 |'''''''''''''''''''''''''''''''''''''''''''''''''''''###
+# 8 |                                                     ###
+# 7 |                                                     ###
+# 6 |'''''''''''''###                                     ###
+# 5 |'''''''''''''###'''''''''''''''''''''''''''###       ###
+# 4 |'''''''''''''###'''''''''''''''''''''''''''###'''''''###'''''''###
+# 3 |'''###'''''''###'''''''''''''''''###       ###       ###       ###
+# 2 |   ###       ###                 ###       ###       ###       ###
+# 1 |   ###       ###                 ###       ###       ###       ###
+# 0 |'''###'''''''###'''''''###       ###       ###       ###       ###
+#   ----------------------------------------------------------------------
+class TextChart
+  class Error < StandardError; end
+
+  # @param [String] title
+  # @param [String] goal
+  # @param [Array] data
+  def initialize(title, goal, data)
+    @title = title
+    @goal = goal
+    @data = data.empty? ? [0] : data
+    @refs = define_references
+    @size_calculator = SizeCalculator.new(self)
+    @designer = Designer.new(self, @size_calculator)
+  end
+
+  attr_reader :title, :goal, :refs, :data, :size_calculator, :designer
+
+  # @return [String]
+  def to_s
+    @designer.draw_axis
+    @designer.draw_bars
+    @designer.draw_header.join
+  end
+
+  # @param [Symbol] key
+  # @return [Integer]
+  def size_config(key)
+    SIZE_CONFIG[key]
+  end
+
+  private
+
+  SIZE_CONFIG = {
+    y_axis_width: 1,
+    bar_area_left_margin: 3,
+    bar_area_right_margin: 3,
+    bar_width: 3,
+    bar_spacing: 7,
+    reference_and_y_axis_margin: 1,
+    x_axis_height: 1,
+    reference_row_height: 1
+  }
+
+  def define_references
+    r = [*@data.min..@data.max].reverse
+    r << 0 unless r.include?(0)
+    r
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: text_chart
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gustavo Ribeiro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-24 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- grdev@tutanota.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/text_chart.rb
+- lib/text_chart/designer.rb
+- lib/text_chart/size_calculator.rb
+- lib/text_chart/version.rb
+homepage: https://github.com/gustavothecoder/text_chart
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gustavothecoder/text_chart
+  source_code_uri: https://github.com/gustavothecoder/text_chart
+  changelog_uri: https://github.com/gustavothecoder/text_chart/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Generate text-based charts.
+test_files: []