unicode_plot 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7870c250eab339403fa566e04bb0361d0d9bc56f655e54dde037e559124d8956
-  data.tar.gz: 8a01e8f5466020b081418c14c373c8fbc6a0c9a8d860c056bbfc31ba8fe1f820
+  metadata.gz: 30cc04427f90664c0157ae18002b8e241cb54d232b33f66edc72b0e6b2dac3d7
+  data.tar.gz: 05c0bfc5b3d2c910bb39f655fb1b10f44c76a552b6e87ede46b4b3f3d04055ca
 SHA512:
-  metadata.gz: 6548d8b2a016fb442407253908e1e57835c45e19cc9d2137dedcbbe1e52e41092f5864c3f36c322122b282c4f8d77d04e6e6afbc403b959b6819b8067eaccf1e
-  data.tar.gz: b813d2620b12c050c318868f02c7bf14bec7c3f44dedf9a5aeaaaaca5f98703a3b7cfab89f3fd45f7dffec2dfbe4f4ff9788b425c02501103fb41169a6ca3634
+  metadata.gz: 6111ed2d7cc47821286ff5da5a33660c24298a04eaeb56377717aa548b9ba150a4c2b67e0ccf62b4aa36c577413babf0bf7fdc50fd37b6945142628ad0d9ed5a
+  data.tar.gz: 0d11730310f093b679a71ca4bb00b760d10e127030cbe797cbf7a171094e192908a3bb3cf7d9de2ba83527ccd8b60ce8f5dbb1956870741aa4a4f55b5c45ac95

data/README.md

@@ -29,6 +29,7 @@ You can get the results below by running the above script:
 ## Supported charts
 
 - barplot
+- boxplot
 - lineplot
 
 ## Acknowledgement

data/lib/unicode_plot.rb

@@ -1,5 +1,6 @@
 require 'unicode_plot/version'
 
+require 'unicode_plot/utils'
 require 'unicode_plot/styled_printer'
 require 'unicode_plot/value_transformer'
 require 'unicode_plot/renderer'
@@ -11,4 +12,5 @@ require 'unicode_plot/braille_canvas'
 require 'unicode_plot/plot'
 
 require 'unicode_plot/barplot'
+require 'unicode_plot/boxplot'
 require 'unicode_plot/lineplot'

data/lib/unicode_plot/boxplot.rb

@@ -1,6 +1,100 @@
+require 'enumerable/statistics'
+
 module UnicodePlot
   class Boxplot < Plot
-    def initialize(
+    MIN_WIDTH = 10
+    DEFAULT_COLOR = :green
+    DEFAULT_WIDTH = 40
+
+    def initialize(data, width, color, min_x, max_x, **kw)
+      if min_x == max_x
+        min_x -= 1
+        max_x += 1
+      end
+      width = [width, MIN_WIDTH].max
+      @data = [data.percentile([0, 25, 50, 75, 100])]
+      @color = color
+      @width = [width, MIN_WIDTH].max
+      @min_x = min_x
+      @max_x = max_x
+      super(**kw)
+    end
+
+    attr_reader :min_x, :max_x
+
+    def n_data
+      @data.length
+    end
+
+    def n_rows
+      3 * @data.length
+    end
+
+    def n_columns
+      @width
+    end
+
+    def add_series!(data)
+      mi, ma = data.minmax
+      @data << data.percentile([0, 25, 50, 75, 100])
+      @min_x = [mi, @min_x].min
+      @max_x = [ma, @max_x].max
+    end
+
+    def print_row(out, row_index)
+      check_row_index(row_index)
+      series = @data[(row_index / 3.0).to_i]
+
+      series_row = row_index % 3
+
+      min_char       = ['╷', '├' , '╵'][series_row]
+      line_char      = [' ', '─' , ' '][series_row]
+      left_box_char  = ['┌', '┤' , '└'][series_row]
+      line_box_char  = ['─', ' ' , '─'][series_row]
+      median_char    = ['┬', '│' , '┴'][series_row]
+      right_box_char = ['┐', '├' , '┘'][series_row]
+      max_char       = ['╷', '┤' , '╵'][series_row]
+
+      line = (0 ... @width).map { ' ' }
+
+      # Draw shapes first - this is most important,
+      # so they'll always be drawn even if there's not enough space
+
+      transformed = transform(series)
+      line[transformed[0] - 1] = min_char
+      line[transformed[1] - 1] = left_box_char
+      line[transformed[2] - 1] = median_char
+      line[transformed[3] - 1] = right_box_char
+      line[transformed[4] - 1] = max_char
+
+      (transformed[0] ... (transformed[1] - 1)).each do |i|
+        line[i] = line_char
+      end
+      (transformed[1] ... (transformed[2] - 1)).each do |i|
+        line[i] = line_box_char
+      end
+      (transformed[2] ... (transformed[3] - 1)).each do |i|
+        line[i] = line_box_char
+      end
+      (transformed[3] ... (transformed[4] - 1)).each do |i|
+        line[i] = line_char
+      end
+
+      print_styled(out, line.join(''), color: @color)
+    end
+
+    private def transform(values)
+      values.map do |val|
+        val = (val - @min_x).fdiv(@max_x - @min_x) * @width
+        val.round(half: :even).clamp(1, @width).to_i
+      end
+    end
+
+    private def check_row_index(row_index)
+      unless 0 <= row_index && row_index < n_rows
+        raise ArgumentError, "row_index out of bounds"
+      end
+    end
   end
 
   module_function def boxplot(*args,
@@ -15,14 +109,87 @@ module UnicodePlot
       data = Hash(data)
       text = data.keys
       data = data.values
+    when 1
+      data = args[0]
     when 2
-      text, data = *args
       text = Array(args[0])
-      data = Array(args[1])
+      data = args[1]
     else
       raise ArgumentError, "wrong number of arguments"
     end
 
-    plot = Boxplot.new(text, data)
+    case data[0]
+    when Numeric
+      data = [data]
+    when Array
+      # do nothing
+    else
+      data = data.to_ary
+    end
+    text ||= Array.new(data.length, "")
+
+    unless text.length == data.length
+      raise ArgumentError, "wrong number of text"
+    end
+
+    unless xlim.length == 2
+      raise ArgumentError, "xlim must be a length 2 array"
+    end
+
+    min_x, max_x = Utils.extend_limits(data.map(&:minmax).flatten, xlim)
+    width = [width, Boxplot::MIN_WIDTH].max
+
+    plot = Boxplot.new(data[0], width, color, min_x, max_x,
+                       border: border, **kw)
+    (1 ... data.length).each do |i|
+      plot.add_series!(data[i])
+    end
+
+    mean_x = (min_x + max_x) / 2.0
+    min_x_str  = (Utils.roundable?(min_x) ? min_x.round : min_x).to_s
+    mean_x_str = (Utils.roundable?(mean_x) ? mean_x.round : mean_x).to_s
+    max_x_str  = (Utils.roundable?(max_x) ? max_x.round : max_x).to_s
+    plot.annotate!(:bl, min_x_str, color: :light_black)
+    plot.annotate!(:b,  mean_x_str, color: :light_black)
+    plot.annotate!(:br, max_x_str, color: :light_black)
+
+    text.each_with_index do |name, i|
+      plot.annotate_row!(:l, i*3+1, name) if name.length > 0
+    end
+
+    plot
+  end
+
+  module_function def boxplot!(plot, *args, **kw)
+    case args.length
+    when 1
+      data = args[0]
+      name = kw[:name] || ""
+    when 2
+      name = args[0]
+      data = args[1]
+    else
+      raise ArgumentError, "worng number of arguments"
+    end
+
+    if data.empty?
+      raise ArgumentError, "Can't append empty array to boxplot"
+    end
+
+    plot.add_series!(data)
+
+    plot.annotate_row!(:l, (plot.n_data - 1)*3+1, name) if name && name != ""
+
+    min_x = plot.min_x
+    max_x = plot.max_x
+    mean_x = (min_x + max_x) / 2.0
+    min_x_str  = (Utils.roundable?(min_x) ? min_x.round : min_x).to_s
+    mean_x_str = (Utils.roundable?(mean_x) ? mean_x.round : mean_x).to_s
+    max_x_str  = (Utils.roundable?(max_x) ? max_x.round : max_x).to_s
+    plot.annotate!(:bl, min_x_str, color: :light_black)
+    plot.annotate!(:b,  mean_x_str, color: :light_black)
+    plot.annotate!(:br, max_x_str, color: :light_black)
+
+    plot
   end
 end

data/lib/unicode_plot/lineplot.rb

@@ -19,8 +19,8 @@ module UnicodePlot
       end
       width = [width, MIN_WIDTH].max
       height = [height, MIN_HEIGHT].max
-      min_x, max_x = extend_limits(x, xlim)
-      min_y, max_y = extend_limits(y, ylim)
+      min_x, max_x = Utils.extend_limits(x, xlim)
+      min_y, max_y = Utils.extend_limits(y, ylim)
       origin_x = min_x
       origin_y = min_y
       plot_width = max_x - origin_x
@@ -32,10 +32,10 @@ module UnicodePlot
                               plot_height: plot_height)
       super(**kw)
 
-      min_x_str = (roundable?(min_x) ? min_x.round : min_x).to_s
-      max_x_str = (roundable?(max_x) ? max_x.round : max_x).to_s
-      min_y_str = (roundable?(min_y) ? min_y.round : min_y).to_s
-      max_y_str = (roundable?(max_y) ? max_y.round : max_y).to_s
+      min_x_str = (Utils.roundable?(min_x) ? min_x.round : min_x).to_s
+      max_x_str = (Utils.roundable?(max_x) ? max_x.round : max_x).to_s
+      min_y_str = (Utils.roundable?(min_y) ? min_y.round : min_y).to_s
+      max_y_str = (Utils.roundable?(max_y) ? max_y.round : max_y).to_s
 
       annotate_row!(:l, 0, max_y_str, color: :light_black)
       annotate_row!(:l, height-1, min_y_str, color: :light_black)
@@ -93,62 +93,6 @@ module UnicodePlot
     def print_row(out, row_index)
       @canvas.print_row(out, row_index)
     end
-
-    def extend_limits(values, limits)
-      mi, ma = limits.minmax.map(&:to_f)
-      if mi == 0 && ma == 0
-        mi, ma = values.minmax.map(&:to_f)
-      end
-      diff = ma - mi
-      if diff == 0
-        ma = mi + 1
-        mi = mi - 1
-      end
-      if limits == [0, 0]
-        plotting_range_narrow(mi, ma)
-      else
-        [mi, ma]
-      end
-    end
-
-    def plotting_range_narrow(xmin, xmax)
-      diff = xmax - xmin
-      xmax = round_up_subtick(xmax, diff)
-      xmin = round_down_subtick(xmin, diff)
-      [xmin.to_f, xmax.to_f]
-    end
-
-    def round_up_subtick(x, m)
-      if x == 0
-        0.0
-      elsif x > 0
-        x.ceil(ceil_neg_log10(m) + 1)
-      else
-        -(-x).floor(ceil_neg_log10(m) + 1)
-      end
-    end
-
-    def round_down_subtick(x, m)
-      if x == 0
-        0.0
-      elsif x > 0
-        x.floor(ceil_neg_log10(m) + 1)
-      else
-        -(-x).ceil(ceil_neg_log10(m) + 1)
-      end
-    end
-
-    def ceil_neg_log10(x)
-      if roundable?(-Math.log10(x))
-        (-Math.log10(x)).ceil
-      else
-        (-Math.log10(x)).floor
-      end
-    end
-
-    def roundable?(x)
-      x.to_i == x
-    end
   end
 
   class Lineplot < GridCanvas

data/lib/unicode_plot/renderer.rb

@@ -11,6 +11,17 @@ module UnicodePlot
       r:  "│"
     }.freeze
 
+    BORDER_CORNERS = {
+      tl: "┌",
+      tr: "┐",
+      bl: "└",
+      br: "┘",
+      t:  " ",
+      l:  " ",
+      b:  " ",
+      r:  " ",
+    }.freeze
+
     BORDER_BARPLOT = {
       tl: "┌",
       tr: "┐",
@@ -25,6 +36,7 @@ module UnicodePlot
 
   BORDER_MAP = {
     solid:   BorderMaps::BORDER_SOLID,
+    corners: BorderMaps::BORDER_CORNERS,
     barplot: BorderMaps::BORDER_BARPLOT,
   }.freeze
 

data/lib/unicode_plot/utils.rb

@@ -0,0 +1,61 @@
+module UnicodePlot
+  module Utils
+    module_function
+
+    def extend_limits(values, limits)
+      mi, ma = limits.minmax.map(&:to_f)
+      if mi == 0 && ma == 0
+        mi, ma = values.minmax.map(&:to_f)
+      end
+      diff = ma - mi
+      if diff == 0
+        ma = mi + 1
+        mi = mi - 1
+      end
+      if limits == [0, 0]
+        plotting_range_narrow(mi, ma)
+      else
+        [mi, ma]
+      end
+    end
+
+    def plotting_range_narrow(xmin, xmax)
+      diff = xmax - xmin
+      xmax = round_up_subtick(xmax, diff)
+      xmin = round_down_subtick(xmin, diff)
+      [xmin.to_f, xmax.to_f]
+    end
+
+    def round_up_subtick(x, m)
+      if x == 0
+        0.0
+      elsif x > 0
+        x.ceil(ceil_neg_log10(m) + 1)
+      else
+        -(-x).floor(ceil_neg_log10(m) + 1)
+      end
+    end
+
+    def round_down_subtick(x, m)
+      if x == 0
+        0.0
+      elsif x > 0
+        x.floor(ceil_neg_log10(m) + 1)
+      else
+        -(-x).ceil(ceil_neg_log10(m) + 1)
+      end
+    end
+
+    def ceil_neg_log10(x)
+      if roundable?(-Math.log10(x))
+        (-Math.log10(x)).ceil
+      else
+        (-Math.log10(x)).floor
+      end
+    end
+
+    def roundable?(x)
+      x.to_i == x
+    end
+  end
+end

data/lib/unicode_plot/version.rb

@@ -1,5 +1,5 @@
 module UnicodePlot
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 
   module Version
     numbers, TAG = VERSION.split("-", 2)

data/test/test-boxplot.rb

@@ -1,4 +1,3 @@
-__END__
 class BoxplotTest < Test::Unit::TestCase
   include Helper::Fixture
   include Helper::WithTerm
@@ -8,7 +7,7 @@ class BoxplotTest < Test::Unit::TestCase
       test("without name") do
         plot = UnicodePlot.boxplot([1, 2, 3, 4, 5])
         _, output = with_term { plot.render($stdout) }
-        assert_equal(fixture_path("boxplot/default_name.txt").read,
+        assert_equal(fixture_path("boxplot/default.txt").read,
                      output)
       end
 
@@ -29,7 +28,7 @@ class BoxplotTest < Test::Unit::TestCase
       end
 
       test("print to tty") do
-        _, output = with_term { plot.render($stdout) }
+        _, output = with_term { @plot.render($stdout) }
         assert_equal(fixture_path("boxplot/default_parameters.txt").read,
                      output)
       end
@@ -44,5 +43,41 @@ class BoxplotTest < Test::Unit::TestCase
                      output)
       end
     end
+
+    data([5, 6, 10, 20, 40].map.with_index {|max_x, i|
+           ["max_x: #{max_x}", [i + 1, max_x]] }.to_h)
+    test("with scaling") do
+      i, max_x = data
+      plot = UnicodePlot.boxplot([1, 2, 3, 4, 5], xlim: [0, max_x])
+      _, output = with_term { plot.render($stdout) }
+      assert_equal(fixture_path("boxplot/scale#{i}.txt").read,
+                   output)
+    end
+
+    test("multi-series") do
+      plot = UnicodePlot.boxplot(["one", "two"],
+                                 [
+                                   [1, 2, 3, 4, 5],
+                                   [2, 3, 4, 5, 6, 7, 8, 9]
+                                 ],
+                                 title: "Multi-series",
+                                 xlabel: "foo",
+                                 color: :yellow)
+      _, output = with_term { plot.render($stdout) }
+      assert_equal(fixture_path("boxplot/multi1.txt").read,
+                   output)
+
+      assert_same(plot,
+                  UnicodePlot.boxplot!(plot, "one more", [-1, 2, 3, 4, 11]))
+      _, output = with_term { plot.render($stdout) }
+      assert_equal(fixture_path("boxplot/multi2.txt").read,
+                   output)
+
+      assert_same(plot,
+                  UnicodePlot.boxplot!(plot, [4, 2, 2.5, 4, 14], name: "last one"))
+      _, output = with_term { plot.render($stdout) }
+      assert_equal(fixture_path("boxplot/multi3.txt").read,
+                   output)
+    end
   end
 end

data/unicode_plot.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = %q{Plot your data by Unicode characters}
   spec.description = %q{Plot your data by Unicode characters}
-  spec.homepage = "https://github.com/mrkn/unicode_plot.rb"
+  spec.homepage = "https://github.com/red-data-tools/unicode_plot.rb"
   spec.license = "MIT"
 
   spec.files = ["README.md", "Rakefile", "Gemfile", "#{spec.name}.gemspec"]
@@ -29,6 +29,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "enumerable-statistics", ">= 2.0.0.pre"
+
   spec.add_development_dependency "bundler", ">= 1.17"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "test-unit"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: unicode_plot
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - mrkn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-09 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: enumerable-statistics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +87,7 @@ files:
 - lib/unicode_plot/plot.rb
 - lib/unicode_plot/renderer.rb
 - lib/unicode_plot/styled_printer.rb
+- lib/unicode_plot/utils.rb
 - lib/unicode_plot/value_transformer.rb
 - lib/unicode_plot/version.rb
 - test/helper.rb
@@ -84,7 +99,7 @@ files:
 - test/test-canvas.rb
 - test/test-lineplot.rb
 - unicode_plot.gemspec
-homepage: https://github.com/mrkn/unicode_plot.rb
+homepage: https://github.com/red-data-tools/unicode_plot.rb
 licenses:
 - MIT
 metadata: {}