unicode_plot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7870c250eab339403fa566e04bb0361d0d9bc56f655e54dde037e559124d8956
+  data.tar.gz: 8a01e8f5466020b081418c14c373c8fbc6a0c9a8d860c056bbfc31ba8fe1f820
+SHA512:
+  metadata.gz: 6548d8b2a016fb442407253908e1e57835c45e19cc9d2137dedcbbe1e52e41092f5864c3f36c322122b282c4f8d77d04e6e6afbc403b959b6819b8067eaccf1e
+  data.tar.gz: b813d2620b12c050c318868f02c7bf14bec7c3f44dedf9a5aeaaaaca5f98703a3b7cfab89f3fd45f7dffec2dfbe4f4ff9788b425c02501103fb41169a6ca3634

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org/"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2019 Kenta Murata
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# UnicodePlot - Plot your data by Unicode characters
+
+UnicodePlot provides the feature to make charts with Unicode characters.
+
+## Install
+
+```console
+$ gem install unicode_plot
+```
+
+## Usage
+
+```
+require 'unicode_plot'
+
+x = 0.step(3*Math::PI, by: 3*Math::PI / 30)
+y_sin = x.map {|xi| Math.sin(xi) }
+y_cos = x.map {|xi| Math.cos(xi) }
+plot = UnicodePlot.lineplot(x, y_sin, name: "sin(x)", width: 40, height: 10)
+UnicodePlot.lineplot!(plot, x, y_cos, name: "cos(x)")
+plot.render($stdout)
+puts
+```
+
+You can get the results below by running the above script:
+
+<img src="img/lineplot.png" width="50%" />
+
+## Supported charts
+
+- barplot
+- lineplot
+
+## Acknowledgement
+
+This library is strongly inspired by [UnicodePlot.jl](https://github.com/Evizero/UnicodePlots.jl).
+
+## License
+
+MIT License
+
+## Author
+
+- [Kenta Murata](https://github.com/mrkn)

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_helper"
+
+base_dir = File.expand_path("..", __FILE__)
+helper = Bundler::GemHelper.new(base_dir)
+helper.install
+spec = helper.gemspec
+
+desc "Run test"
+task :test do
+  ruby("test/run-test.rb")
+end
+
+task default: :test

data/lib/unicode_plot.rb

@@ -0,0 +1,14 @@
+require 'unicode_plot/version'
+
+require 'unicode_plot/styled_printer'
+require 'unicode_plot/value_transformer'
+require 'unicode_plot/renderer'
+
+require 'unicode_plot/canvas'
+require 'unicode_plot/ascii_canvas'
+require 'unicode_plot/braille_canvas'
+
+require 'unicode_plot/plot'
+
+require 'unicode_plot/barplot'
+require 'unicode_plot/lineplot'

data/lib/unicode_plot/ascii_canvas.rb

@@ -0,0 +1,157 @@
+module UnicodePlot
+  class AsciiCanvas < Canvas
+    ASCII_SIGNS = [
+      [ 0b100_000_000, 0b000_100_000, 0b000_000_100 ].freeze,
+      [ 0b010_000_000, 0b000_010_000, 0b000_000_010 ].freeze,
+      [ 0b001_000_000, 0b000_001_000, 0b000_000_001 ].freeze
+    ].freeze
+
+    ASCII_LOOKUP = {
+      0b101_000_000 => '"',
+      0b111_111_111 => '@',
+     #0b011_110_011 => '$',
+      0b010_000_000 => '\'',
+      0b010_100_010 => '(',
+      0b010_001_010 => ')',
+      0b000_010_000 => '*',
+      0b010_111_010 => '+',
+      0b000_010_010 => ',',
+      0b000_100_100 => ',',
+      0b000_001_001 => ',',
+      0b000_111_000 => '-',
+      0b000_000_010 => '.',
+      0b000_000_100 => '.',
+      0b000_000_001 => '.',
+      0b001_010_100 => '/',
+      0b010_100_000 => '/',
+      0b001_010_110 => '/',
+      0b011_010_010 => '/',
+      0b001_010_010 => '/',
+      0b110_010_111 => '1',
+     #0b111_010_100 => '7',
+      0b010_000_010 => ':',
+      0b111_000_111 => '=',
+     #0b010_111_101 => 'A',
+     #0b011_100_011 => 'C',
+     #0b110_101_110 => 'D',
+     #0b111_110_100 => 'F',
+     #0b011_101_011 => 'G',
+     #0b101_111_101 => 'H',
+      0b111_010_111 => 'I',
+     #0b011_001_111 => 'J',
+     #0b101_110_101 => 'K',
+      0b100_100_111 => 'L',
+     #0b111_111_101 => 'M',
+     #0b101_101_101 => 'N',
+     #0b111_101_111 => 'O',
+     #0b111_111_100 => 'P',
+      0b111_010_010 => 'T',
+     #0b101_101_111 => 'U',
+      0b101_101_010 => 'V',
+     #0b101_111_111 => 'W',
+      0b101_010_101 => 'X',
+      0b101_010_010 => 'Y',
+      0b110_100_110 => '[',
+      0b010_001_000 => '\\',
+      0b100_010_001 => '\\',
+      0b110_010_010 => '\\',
+      0b100_010_011 => '\\',
+      0b100_010_010 => '\\',
+      0b011_001_011 => ']',
+      0b010_101_000 => '^',
+      0b000_000_111 => '_',
+      0b100_000_000 => '`',
+     #0b000_111_111 => 'a',
+     #0b100_111_111 => 'b',
+     #0b001_111_111 => 'd',
+     #0b001_111_010 => 'f',
+     #0b100_111_101 => 'h',
+     #0b100_101_101 => 'k',
+      0b110_010_011 => 'l',
+     #0b000_111_101 => 'n',
+      0b000_111_100 => 'r',
+     #0b000_101_111 => 'u',
+      0b000_101_010 => 'v',
+      0b011_110_011 => '{',
+      0b010_010_010 => '|',
+      0b100_100_100 => '|',
+      0b001_001_001 => '|',
+      0b110_011_110 => '}',
+    }.freeze
+
+    ascii_lookup_key_order = [
+      0x0002, 0x00d2, 0x0113, 0x00a0, 0x0088,
+      0x002a, 0x0100, 0x0197, 0x0012, 0x0193,
+      0x0092, 0x0082, 0x008a, 0x0054, 0x0004,
+      0x01d2, 0x01ff, 0x0124, 0x00a8, 0x0056,
+      0x0001, 0x01c7, 0x0052, 0x0080, 0x0009,
+      0x00cb, 0x0007, 0x003c, 0x0111, 0x0140,
+      0x0024, 0x0127, 0x0192, 0x0010, 0x019e,
+      0x01a6, 0x01d7, 0x0155, 0x00a2, 0x00ba,
+      0x0112, 0x0049, 0x00f3, 0x0152, 0x0038,
+      0x016a
+    ]
+
+    ASCII_DECODE = [' ']
+
+    1.upto(0b111_111_111) do |i|
+      min_key = ascii_lookup_key_order.min_by {|k| (i ^ k).digits(2).sum }
+      ASCII_DECODE[i] = ASCII_LOOKUP[min_key]
+    end
+
+    ASCII_DECODE.freeze
+
+    PIXEL_PER_CHAR = 3
+
+    def initialize(width, height, **kw)
+      super(width, height,
+            width * PIXEL_PER_CHAR,
+            height * PIXEL_PER_CHAR,
+            0,
+            x_pixel_per_char: PIXEL_PER_CHAR,
+            y_pixel_per_char: PIXEL_PER_CHAR,
+            **kw)
+    end
+
+    def pixel!(pixel_x, pixel_y, color)
+      unless 0 <= pixel_x && pixel_x <= pixel_width &&
+             0 <= pixel_y && pixel_y <= pixel_height
+        return color
+      end
+      pixel_x -= 1 unless pixel_x < pixel_width
+      pixel_y -= 1 unless pixel_y < pixel_height
+
+      tx = pixel_x.fdiv(pixel_width) * width
+      char_x = tx.floor + 1
+      char_x_off = pixel_x % PIXEL_PER_CHAR + 1
+      char_x += 1 if char_x < tx.round + 1 && char_x_off == 1
+
+      char_y = (pixel_y.fdiv(pixel_height) * height).floor + 1
+      char_y_off = pixel_y % PIXEL_PER_CHAR + 1
+
+      index = index_at(char_x - 1, char_y - 1)
+      if index
+        @grid[index] |= lookup_encode(char_x_off - 1, char_y_off - 1)
+        @colors[index] |= COLOR_ENCODE[color]
+      end
+    end
+
+    def print_row(out, row_index)
+      unless 0 <= row_index && row_index < height
+        raise ArgumentError, "row_index out of bounds"
+      end
+      y = row_index
+      (0 ... width).each do |x|
+        print_color(out, color_at(x, y), lookup_decode(char_at(x, y)))
+      end
+    end
+
+    def lookup_encode(x, y)
+      ASCII_SIGNS[x][y]
+    end
+
+    def lookup_decode(code)
+      ASCII_DECODE[code]
+    end
+  end
+end

data/lib/unicode_plot/barplot.rb

@@ -0,0 +1,104 @@
+module UnicodePlot
+  class Barplot < Plot
+    include ValueTransformer
+
+    MIN_WIDTH = 10
+    DEFAULT_WIDTH = 40
+    DEFAULT_COLOR = :green
+    DEFAULT_SYMBOL = "■"
+
+    def initialize(bars, width, color, symbol, transform, **kw)
+      if symbol.length > 1
+        raise ArgumentError, "symbol must be a single character"
+      end
+      @bars = bars
+      @symbol = symbol
+      @max_freq, i = find_max(transform_values(transform, bars))
+      @max_len = bars[i].to_s.length
+      @width = [width, max_len + 7, MIN_WIDTH].max
+      @color = color
+      @symbol = symbol
+      @transform = transform
+      super(**kw)
+    end
+
+    attr_reader :max_freq
+    attr_reader :max_len
+    attr_reader :width
+
+    def n_rows
+      @bars.length
+    end
+
+    def n_columns
+      @width
+    end
+
+    def print_row(out, row_index)
+      check_row_index(row_index)
+      bar = @bars[row_index]
+      max_bar_width = [width - 2 - max_len, 1].max
+      val = transform_values(@transform, bar)
+      bar_len = max_freq > 0 ?
+        ([val, 0.0].max.fdiv(max_freq) * max_bar_width).round :
+        0
+      bar_str = max_freq > 0 ? @symbol * bar_len : ""
+      bar_lbl = bar.to_s
+      print_styled(out, bar_str, color: @color)
+      print_styled(out, " ", bar_lbl, color: :normal)
+      pan_len = [max_bar_width + 1 + max_len - bar_len - bar_lbl.length, 0].max
+      pad = " " * pan_len.round
+      out.print(pad)
+    end
+
+    private def find_max(values)
+      i = j = 0
+      max = values[i]
+      while j < values.length
+        if values[j] > max
+          i, max = j, values[j]
+        end
+        j += 1
+      end
+      [max, i]
+    end
+
+    private def check_row_index(row_index)
+      unless 0 <= row_index && row_index < n_rows
+        raise ArgumentError, "row_index is out of range"
+      end
+    end
+  end
+
+  module_function def barplot(*args,
+                              width: Barplot::DEFAULT_WIDTH,
+                              color: Barplot::DEFAULT_COLOR,
+                              symbol: Barplot::DEFAULT_SYMBOL,
+                              border: :barplot,
+                              xscale: nil,
+                              xlabel: nil,
+                              data: nil,
+                              **kw)
+    case args.length
+    when 0
+      data = Hash(args[0] || data)
+      keys = data.keys.map(&:to_s)
+      heights = data.values
+    when 2
+      keys = Array(args[0])
+      heights = Array(args[1])
+    else
+      raise ArgumentError, "invalid arguments"
+    end
+
+    xlabel ||= ValueTransformer.transform_name(xscale)
+    plot = Barplot.new(heights, width, color, symbol, xscale,
+                       border: border, xlabel: xlabel,
+                       **kw)
+    keys.each_with_index do |key, i|
+      plot.annotate_row!(:l, i, key)
+    end
+
+    plot
+  end
+end

data/lib/unicode_plot/boxplot.rb

@@ -0,0 +1,28 @@
+module UnicodePlot
+  class Boxplot < Plot
+    def initialize(
+  end
+
+  module_function def boxplot(*args,
+                              data: nil,
+                              border: :corners,
+                              color: Boxplot::DEFAULT_COLOR,
+                              width: Boxplot::DEFAULT_WIDTH,
+                              xlim: [0, 0],
+                              **kw)
+    case args.length
+    when 0
+      data = Hash(data)
+      text = data.keys
+      data = data.values
+    when 2
+      text, data = *args
+      text = Array(args[0])
+      data = Array(args[1])
+    else
+      raise ArgumentError, "wrong number of arguments"
+    end
+
+    plot = Boxplot.new(text, data)
+  end
+end

data/lib/unicode_plot/braille_canvas.rb

@@ -0,0 +1,65 @@
+module UnicodePlot
+  class BrailleCanvas < Canvas
+    X_PIXEL_PER_CHAR = 2
+    Y_PIXEL_PER_CHAR = 4
+
+    BRAILLE_SIGNS = [
+      [
+        0x2801,
+        0x2802,
+        0x2804,
+        0x2840,
+      ].freeze,
+      [
+        0x2808,
+        0x2810,
+        0x2820,
+        0x2880
+      ].freeze
+    ].freeze
+
+    def initialize(width, height, **kw)
+      super(width, height,
+            width * X_PIXEL_PER_CHAR,
+            height * Y_PIXEL_PER_CHAR,
+            "\u{2800}",
+            x_pixel_per_char: X_PIXEL_PER_CHAR,
+            y_pixel_per_char: Y_PIXEL_PER_CHAR,
+            **kw)
+    end
+
+    def pixel!(pixel_x, pixel_y, color)
+      unless 0 <= pixel_x && pixel_x <= pixel_width &&
+             0 <= pixel_y && pixel_y <= pixel_height
+        return color
+      end
+      pixel_x -= 1 unless pixel_x < pixel_width
+      pixel_y -= 1 unless pixel_y < pixel_height
+      tx = pixel_x.fdiv(pixel_width) * width
+      char_x = tx.floor + 1
+      char_x_off = pixel_x % X_PIXEL_PER_CHAR + 1
+      char_x += 1 if char_x < tx.round + 1 && char_x_off == 1
+
+      char_y = (pixel_y.fdiv(pixel_height) * height).floor + 1
+      char_y_off = pixel_y % Y_PIXEL_PER_CHAR + 1
+
+      index = index_at(char_x - 1, char_y - 1)
+      if index
+        @grid[index] = (@grid[index].ord | BRAILLE_SIGNS[char_x_off - 1][char_y_off - 1]).chr(Encoding::UTF_8)
+        @colors[index] |= COLOR_ENCODE[color]
+      end
+      color
+    end
+
+    def print_row(out, row_index)
+      unless 0 <= row_index && row_index < height
+        $stderr.puts [row_index, height].inspect
+        raise ArgumentError, "row_index out of bounds"
+      end
+      y = row_index
+      (0 ... width).each do |x|
+        print_color(out, color_at(x, y), char_at(x, y))
+      end
+    end
+  end
+end