unicode_plot 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3752009f07860fb96eba974ed4322ab975bd5547832e7747c95544918ad96c6
-  data.tar.gz: 1e86d05df7dd39473144ed8b26ec00b32980f6d61a684f978e7a6c914d42b71f
+  metadata.gz: 803cdd758712ba3337cf57baeaa0c167485201952cb9becae048375e8a157f58
+  data.tar.gz: b001770582a9a9ef06af3e5bb74494b0ec8422d77fd5c6955d7a4420b947f7b0
 SHA512:
-  metadata.gz: 68c546819e475ddb1a5e24114b8a8fae8bb0809e723870abfe8cb3583ce838fedb7601b051085f38898ac039e58addee618651f446ed9a22f9d627f64775e2cc
-  data.tar.gz: 86da79ec98b4d5c461bb0c3c27632fb3fda90e457066dcc5efa987d402f1e93c7a55e1330551eef270c1bb71f68a9ba3c9c24b578c7f6f8ad617ac7167d65433
+  metadata.gz: 4e148f810ba8a72332f298a27cf9247d27b65cd5813669d443db00252140426bdd3813d11e07526da2975db4bf6a5627aa5bd7b7a878fdf53cff3286ee662ca5
+  data.tar.gz: 3beaef1efb87df4f59318c03970b233a55838b0623e263093e5466e54dd8a83644546e957186b63eb41e08bf55f790744a447c02b3bab61cf0bbef0253c7414d

data/Gemfile

@@ -1,3 +1,6 @@
 source "https://rubygems.org/"
 
 gemspec
+
+# Temporary use this for module_function decorator support
+gem "yard", github: "mrkn/yard", branch: "module_function_decorator"

data/README.md

@@ -2,6 +2,10 @@
 
 UnicodePlot provides the feature to make charts with Unicode characters.
 
+## Documentation
+
+https://red-data-tools.github.io/unicode_plot.rb/
+
 ## Install
 
 ```console
@@ -18,8 +22,7 @@ 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
+plot.render
 ```
 
 You can get the results below by running the above script:
@@ -31,8 +34,7 @@ You can get the results below by running the above script:
 ### barplot
 
 ```ruby
-plot = UnicodePlot.barplot(data: {'foo': 20, 'bar': 50}, title: "Bar")
-plot.render($stdout)
+UnicodePlot.barplot(data: {'foo': 20, 'bar': 50}, title: "Bar").render
 ```
 
 <img src="img/barplot.png" width="50%" />
@@ -40,8 +42,7 @@ plot.render($stdout)
 ### boxplot
 
 ```ruby
-plot = UnicodePlot.boxplot(data: {foo: [1, 3, 5], bar: [3, 5, 7]}, title: "Box")
-plot.render($stdout)
+UnicodePlot.boxplot(data: {foo: [1, 3, 5], bar: [3, 5, 7]}, title: "Box").render
 ```
 
 <img src="img/boxplot.png" width="50%" />
@@ -51,8 +52,7 @@ plot.render($stdout)
 ```ruby
 x = Array.new(500) { 20*rand - 10 } + Array.new(500) { 6*rand - 3 }
 y = Array.new(1000) { 30*rand - 10 }
-plot = UnicodePlot.densityplot(x, y, title: "Density")
-plot.render($stdout)
+UnicodePlot.densityplot(x, y, title: "Density").render
 ```
 
 <img src="img/densityplot.png" width="50%" />
@@ -61,8 +61,7 @@ plot.render($stdout)
 
 ```ruby
 x = Array.new(100) { rand(10) } + Array.new(100) { rand(30) + 10 }
-plot = UnicodePlot.histogram(x, title: "Histogram")
-plot.render($stdout)
+UnicodePlot.histogram(x, title: "Histogram").render
 ```
 
 <img src="img/histogram.png" width="50%" />
@@ -76,8 +75,7 @@ See [Usage](#usage) section above.
 ```ruby
 x = Array.new(50) { rand(20) - 10 }
 y = x.map {|xx| xx*rand(30) - 10 }
-plot = UnicodePlot.scatterplot(x, y, title: "Scatter")
-plot.render($stdout)
+UnicodePlot.scatterplot(x, y, title: "Scatter").render
 ```
 
 <img src="img/scatterplot.png" width="50%" />

data/Rakefile

@@ -1,9 +1,9 @@
 require "bundler/gem_helper"
+require "yard"
 
 base_dir = File.expand_path("..", __FILE__)
 helper = Bundler::GemHelper.new(base_dir)
 helper.install
-spec = helper.gemspec
 
 desc "Run test"
 task :test do
@@ -11,3 +11,6 @@ task :test do
 end
 
 task default: :test
+
+YARD::Rake::YardocTask.new do |task|
+end

data/lib/unicode_plot.rb

@@ -2,17 +2,13 @@ require 'stringio'
 
 require 'unicode_plot/version'
 
+require 'unicode_plot/io_context'
 require 'unicode_plot/utils'
 require 'unicode_plot/styled_printer'
 require 'unicode_plot/value_transformer'
 require 'unicode_plot/renderer'
 
 require 'unicode_plot/canvas'
-require 'unicode_plot/braille_canvas'
-require 'unicode_plot/density_canvas'
-require 'unicode_plot/lookup_canvas'
-require 'unicode_plot/ascii_canvas'
-require 'unicode_plot/dot_canvas'
 
 require 'unicode_plot/plot'
 require 'unicode_plot/grid_plot'
@@ -23,3 +19,5 @@ require 'unicode_plot/densityplot'
 require 'unicode_plot/lineplot'
 require 'unicode_plot/histogram'
 require 'unicode_plot/scatterplot'
+require 'unicode_plot/stairs'
+require 'unicode_plot/stemplot'

data/lib/unicode_plot/barplot.rb

@@ -69,6 +69,57 @@ module UnicodePlot
     end
   end
 
+  # @overload barplot(text, heights, xscale: nil, title: nil, xlabel: nil, ylabel: nil, labels: true, border: :barplot, margin: Plot::DEFAULT_MARGIN, padding: Plot::DEFAULT_PADDING, color: Barplot::DEFAULT_COLOR, width: Plot::DEFAULT_WIDTH, symbol: Barplot::DEFAULT_SYMBOL)
+  #
+  #   Draws a horizontal barplot.
+  #
+  #   @param text [Array<String>] The lables / captions of the bars.
+  #   @param heights [Array<Numeric>] The values / heights of the bars.
+  #   @param xscale [nil,:log,:ln,:log10,:lg,:log2,:lb,callable]
+  #          A function name symbol or callable object to transform the bar
+  #          length before plotting.  This effectively scales the x-axis
+  #          without influencing the captions of the individual bars.
+  #          e.g. use `xscale: :log10` for logscale.
+  #   @param title
+  #   @param xlabel
+  #   @param ylabel
+  #   @param labels
+  #   @param border
+  #   @param margin
+  #   @param padding
+  #   @param color
+  #   @param width
+  #   @param symbol [String] Specifies the character that should be used
+  #          to render the bars.
+  #
+  #   @return [Barplot] A plot object.
+  #
+  #   @example Example usage of barplot on IRB:
+  #
+  #       >> UnicodePlot.barplot(["Paris", "New York", "Moskau", "Madrid"],
+  #                              [2.244, 8.406, 11.92, 3.165],
+  #                              xlabel: "population [in mil]").render
+  #                   ┌                                        ┐
+  #             Paris ┤■■■■■■ 2.244
+  #          New York ┤■■■■■■■■■■■■■■■■■■■■■■■ 8.406
+  #            Moskau ┤■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 11.92
+  #            Madrid ┤■■■■■■■■■ 3.165
+  #                   └                                        ┘
+  #                              population [in mil]
+  #       => nil
+  #
+  #   @see Plot
+  #   @see histogram
+  #   @see Barplot
+  #
+  # @overload barplot(data, **kwargs)
+  #
+  #   The different variation of barplot described above.
+  #
+  #   @param data [Hash] A hash in which the keys will be used as `text` and
+  #          the values will be utilized as `heights`.
+  #   @param kwargs Optional keyword arguments same as ones described above.
+  #   @return [Barplot] A plot object.
   module_function def barplot(*args,
                               width: Plot::DEFAULT_WIDTH,
                               color: Barplot::DEFAULT_COLOR,
@@ -108,10 +159,24 @@ module UnicodePlot
     plot
   end
 
+  # @overload barplot!(plot, text, heights)
+  #
+  #   Draw additional bars on the given existing plot.
+  #
+  #   @param plot [Barplot] the existing plot.
+  #   @return [Barplot] A plot object.
+  #
+  #   @see barplot
+  #
+  # @overload barplot!(plot, data)
+  #
+  #   The different variation of `barplot!` that takes the plotting data in a hash.
+  #
+  #   @param plot [Barplot] the existing plot.
+  #   @return [Barplot] A plot object.
   module_function def barplot!(plot,
                                *args,
-                               data: nil,
-                               **kw)
+                               data: nil)
     case args.length
     when 0
       data = Hash(data)

data/lib/unicode_plot/canvas.rb

@@ -2,16 +2,13 @@ module UnicodePlot
   class Canvas
     include BorderPrinter
 
+    CANVAS_CLASS_MAP = {}
+
     def self.create(canvas_type, width, height, **kw)
-      case canvas_type
-      when :ascii
-        AsciiCanvas.new(width, height, **kw)
-      when :braille
-        BrailleCanvas.new(width, height, **kw)
-      when :density
-        DensityCanvas.new(width, height, **kw)
-      when :dot
-        DotCanvas.new(width, height, **kw)
+      canvas_class = CANVAS_CLASS_MAP[canvas_type]
+      case canvas_class
+      when Class
+        canvas_class.new(width, height, **kw)
       else
         raise ArgumentError, "unknown canvas type: #{canvas_type}"
       end
@@ -166,4 +163,16 @@ module UnicodePlot
       raise ArgumentError, "#{name} has to be positive"
     end
   end
+
+  def self.canvas_types
+    Canvas::CANVAS_CLASS_MAP.keys
+  end
 end
+
+require_relative 'canvas/ascii_canvas'
+require_relative 'canvas/block_canvas'
+require_relative 'canvas/braille_canvas'
+require_relative 'canvas/density_canvas'
+require_relative 'canvas/dot_canvas'
+
+UnicodePlot::Canvas::CANVAS_CLASS_MAP.freeze

data/lib/unicode_plot/{ascii_canvas.rb → canvas/ascii_canvas.rb}

@@ -1,5 +1,9 @@
+require_relative 'lookup_canvas'
+
 module UnicodePlot
   class AsciiCanvas < LookupCanvas
+    Canvas::CANVAS_CLASS_MAP[:ascii] = self
+
     ASCII_SIGNS = [
       [ 0b100_000_000, 0b000_100_000, 0b000_000_100 ].freeze,
       [ 0b010_000_000, 0b000_010_000, 0b000_000_010 ].freeze,

data/lib/unicode_plot/canvas/block_canvas.rb

@@ -0,0 +1,38 @@
+module UnicodePlot
+  # The `BlockCanvas` is also Unicode-based.
+  # It has half the resolution of the `BrailleCanvas`.
+  # In contrast to BrailleCanvas, the pixels don't
+  # have visible spacing between them.
+  # This canvas effectively turns every character
+  # into 4 pixels that can individually be manipulated
+  # using binary operations.
+  class BlockCanvas < LookupCanvas
+    Canvas::CANVAS_CLASS_MAP[:block] = self
+
+    X_PIXEL_PER_CHAR = 2
+    Y_PIXEL_PER_CHAR = 2
+
+    def initialize(width, height, fill_char=0, **kw)
+      super(width, height,
+            X_PIXEL_PER_CHAR,
+            Y_PIXEL_PER_CHAR,
+            fill_char,
+            **kw)
+    end
+    
+    BLOCK_SIGNS = [
+      [0b1000, 0b0010].freeze,
+      [0b0100, 0b0001].freeze
+    ].freeze
+
+    BLOCK_DECODE = [
+      -' ', -'▗', -'▖', -'▄',
+      -'▝', -'▐', -'▞', -'▟',
+      -'▘', -'▚', -'▌', -'▙',
+      -'▀', -'▜', -'▛', -'█'
+    ].freeze
+
+    def lookup_encode(x,y) ; BLOCK_SIGNS[x][y] ; end
+    def lookup_decode(x) ; BLOCK_DECODE[x] ; end
+  end
+end

data/lib/unicode_plot/{braille_canvas.rb → canvas/braille_canvas.rb}

@@ -1,5 +1,7 @@
 module UnicodePlot
   class BrailleCanvas < Canvas
+    Canvas::CANVAS_CLASS_MAP[:braille] = self
+
     X_PIXEL_PER_CHAR = 2
     Y_PIXEL_PER_CHAR = 4
 
@@ -40,8 +42,8 @@ module UnicodePlot
       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
+      char_y = ((pixel_y - (char_y_off - 1)) / Y_PIXEL_PER_CHAR) + 1
 
       index = index_at(char_x - 1, char_y - 1)
       if index

data/lib/unicode_plot/{density_canvas.rb → canvas/density_canvas.rb}

@@ -1,5 +1,7 @@
 module UnicodePlot
   class DensityCanvas < Canvas
+    Canvas::CANVAS_CLASS_MAP[:density] = self
+
     DENSITY_SIGNS = [" ", "░", "▒", "▓", "█"].freeze
 
     MIN_WIDTH = 5

data/lib/unicode_plot/{dot_canvas.rb → canvas/dot_canvas.rb}

@@ -1,5 +1,7 @@
 module UnicodePlot
   class DotCanvas < LookupCanvas
+    Canvas::CANVAS_CLASS_MAP[:dot] = self
+
     DOT_SIGNS = [
                   [
                     0b10,

data/lib/unicode_plot/{lookup_canvas.rb → canvas/lookup_canvas.rb}

@@ -23,8 +23,8 @@ module UnicodePlot
       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
+      char_y = ((pixel_y - (char_y_off - 1)) / y_pixel_per_char) + 1
 
       index = index_at(char_x - 1, char_y - 1)
       if index

data/lib/unicode_plot/io_context.rb

@@ -0,0 +1,32 @@
+require "forwardable"
+
+module UnicodePlot
+  class IOContext
+    extend Forwardable
+
+    def initialize(io, color: :auto)
+      @io = io
+      @color = check_color(color)
+    end
+
+    def_delegators :@io, :print, :puts
+
+    def color?
+      case @color
+      when :auto
+        @io.respond_to?(:tty?) ? @io.tty? : false
+      else
+        @color
+      end
+    end
+
+    private def check_color(color)
+      case color
+      when true, false, :auto
+        color
+      else
+        raise ArgumentError, "color must be either true, false, :auto"
+      end
+    end
+  end
+end

data/lib/unicode_plot/lineplot.rb

@@ -4,6 +4,32 @@ module UnicodePlot
   class Lineplot < GridPlot
   end
 
+  # @overload lineplot([x], y, name: "", canvas: :braille, title: "", xlabel: "", ylabel: "", labels: true, border: :solid, margin: Plot::DEFAULT_MARGIN, padding: Plot::DEFAULT_PADDING, color: :auto, width: Plot::DEFAULT_WIDTH, height: GridPlot::DEFAULT_HEIGHT, xlim: [0, 0], ylim: [0, 0], canvas: :braille, grid: true)
+  #
+  #   Draws a path through the given points on a new canvas.
+  #
+  #   The first (optional) array `x` should contain the horizontal positions for all the points along the path.
+  #   The second array `y` should then contain the corresponding vertical positions respectively.
+  #   This means that the two vectors must be of the same length and ordering.
+  #
+  #   @param x [Array<Numeric>] Optional. The horizontal position for each point. If omitted, the axes of `y` will be used as `x`.
+  #   @param y [Array<Numeric>] The vertical position for each point.
+  #   @param name [String] Annotation of the current drawing to be displayed on the right.
+  #   @param title
+  #   @param xlabel
+  #   @param ylabel
+  #   @param labels
+  #   @param border
+  #   @param margin
+  #   @param padding
+  #   @param color
+  #   @param width
+  #   @param height
+  #   @param xlim
+  #   @param ylim
+  #   @param canvas [Symbol] The type of canvas that should be used for drawing.
+  #   @param grid [true,false] If `true`, draws grid-lines at the origin.
+  #   @return [Lineplot] A plot object.
   module_function def lineplot(*args,
                                canvas: :braille,
                                color: :auto,
@@ -41,6 +67,16 @@ module UnicodePlot
     end
   end
 
+  # @overload lineplot!(plot, [x], y, name: "", color: :auto)
+  #
+  #   Draws a path through the given points on the given canvas.
+  #
+  #   @param plot [Lineplot] The plot object.
+  #   @param x [Array<Numeric>] Optional. The horizontal position for each point. If omitted, the axes of `y` will be used as `x`.
+  #   @param y [Array<Numeric>] The vertical position for each point.
+  #   @param name [String] Annotation of the current drawing to be displayed on the right.
+  #   @param color
+  #   @return [Lineplot] The plot object same as the `plot` parameter.
   module_function def lineplot!(plot,
                                 *args,
                                 color: :auto,

data/lib/unicode_plot/plot.rb

@@ -17,7 +17,7 @@ module UnicodePlot
       @title = title
       @xlabel = xlabel
       @ylabel = ylabel
-      @border = border
+      @border = check_border(border)
       @margin = check_margin(margin)
       @padding = padding
       @labels_left = {}
@@ -103,8 +103,8 @@ module UnicodePlot
       end
     end
 
-    def render(out=$stdout, newline: true)
-      Renderer.render(out, self, newline)
+    def render(out=$stdout, newline: true, color: :auto)
+      Renderer.render(IOContext.new(out, color: color), self, newline)
     end
 
     COLOR_CYCLE = [
@@ -142,5 +142,10 @@ module UnicodePlot
         raise ArgumentError, "row_index out of bounds"
       end
     end
+
+    private def check_border(border)
+      return border if BORDER_MAP.key?(border)
+      raise ArgumentError, "unknown border type: #{border}"
+    end
   end
 end