youplot 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39029ea73cd1233a1ad890343381986b5fcf46e1e7619708cd0329269d07135c
-  data.tar.gz: '08662eaab8c28351e57727c69f2f5479e1950d3cbbad7d65ab61ec8994830fec'
+  metadata.gz: 83145e216c0d124d537c8a01d63f9203730a74191fefcb9de5743b08e0e504bd
+  data.tar.gz: a246eab22f11ab8c526cc838d9f2fbf7d249721b4782287087c08a5410f8647b
 SHA512:
-  metadata.gz: 7f24fc609bf6501d9b9f6a6452db84d015cfbea7fe6c3a86f4d69ab31043c5a99d9907fe8dbf34f2672589fbfa99e51cde6cfab578c1ef570552e649a7ebfb10
-  data.tar.gz: 6fb46f5492480a385dec175d022e693442c43cdead3b5bd948dfdc0030a81d661ea5363cb386c9c9f7da5e25329cdc11c286d78985cc9383f7032a3a56a8435a
+  metadata.gz: d9138c26fade36d7d0ca19100b47dcb8e65c8c884d13b74d258dcae9ea304ced2fc783b08e871d76607e57e394e6b861c81f1f5030caba53493b2f4740a05cd2
+  data.tar.gz: f293d686791ba1481948877e534c9085e99c24ab9c36026979002ecaa9ee2ece6f12ad7193cda936c62e472e2f94008466cc666e9405157bfcc348c4c21c4579

data/README.md

@@ -1,10 +1,10 @@
 <p align="center">
-  <img src="https://user-images.githubusercontent.com/5798442/103439598-9e952a00-4c81-11eb-881f-67c593bb7861.png" width="75%" height="75%" />
+  <img src="logo.svg" width="60%" height="60%" />
 </p>
 
 ![Build Status](https://github.com/kojix2/youplot/workflows/test/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/youplot.svg)](https://badge.fury.io/rb/youplot)
-[![Docs Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://rubydoc.info/gems/youplot)
+[![Docs Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://rubydoc.info/gems/youplot)
 [![The MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
 [![DOI](https://zenodo.org/badge/283230219.svg)](https://zenodo.org/badge/latestdoi/283230219)
 
@@ -106,8 +106,8 @@ In this example, YouPlot counts the number of chromosomes where the gene is loca
 
 ```sh
 cat gencode.v35.annotation.gff3 \
-| grep -v '#' | grep 'gene' | cut -f1 | \
- uplot count -t "The number of human gene annotations per chromosome"  -c blue
+| grep -v '#' | grep 'gene' | cut -f1 \
+| uplot count -t "The number of human gene annotations per chromosome"  -c blue
 ```
 
 <p align="center">
@@ -119,7 +119,7 @@ This is fine in most cases, as long as the data size is small. If you want to vi
 
 ```sh
 cat gencode.v35.annotation.gff3 | grep -v '#' | grep 'gene' | cut -f1 \
-|sort | uniq -c | sort -nrk2 | awk '{print $2,$1}' \
+| sort | uniq -c | sort -nrk2 | awk '{print $2,$1}' \
 | uplot bar -d ' ' -t "The number of human gene annotations per chromosome"  -c blue
 ```
 
@@ -130,15 +130,15 @@ cat gencode.v35.annotation.gff3 | grep -v '#' | grep 'gene' | cut -f1 \
 Wouldn't it be a pain to have to run R, Python, Julia, gnuplot or whatever REPL just to check your data?
 YouPlot is a command line tool for this purpose. With YouPlot, you can continue working without leaving your terminal and shell.
 
-### how to use YouPlot?
+### How to use YouPlot?
 
 `uplot` is the shortened form of `youplot`. You can use either.
 
-|                                   |                                                |
-|-----------------------------------|------------------------------------------------|
-| Reads data from standard input    | `cat data.tsv \| uplot <command> [options]`    |
-| Reads data from files             | `uplot <command> [options] data.tsv ...`       |
-| Outputs data from stdin to stdout | `pipeline1 \| uplot <command> -O \| pipeline2` |
+| Command                                        | Description                       |
+|------------------------------------------------|-----------------------------------|
+| `cat data.tsv \| uplot <command> [options]`    | Take input from stdin             |
+| `uplot <command> [options] data.tsv ...`       | Take input from files             |
+| `pipeline1 \| uplot <command> -O \| pipeline2` | Outputs data from stdin to stdout |
 
 ### Where to output the plot?
 
@@ -148,7 +148,8 @@ The output file or stream for the plot can be specified with the `-o` option.
 ### Where to output the input data?
 
 By default, the input data is not shown anywhere.
-The `-O` option, with no arguments, outputs the input data directly to the standard output. This is useful when passing data to a subsequent pipeline.
+The `-O` option, with no arguments, outputs the input data directly to the standard output. 
+This is useful when passing data to a subsequent pipeline.
 
 ### What types of plots are available?
 
@@ -176,11 +177,21 @@ If your input data contains a header line, you need to specify the `-H` option.
 
 ### How to specify the delimiter?
 
-Use the `-d` option. To specify a blank space, you can use `uplot bar -d ' ' data.txt`. You do not need to use `-d` option for tab-delimited text since the default value is tab.
+Use the `-d` option. To specify a blank space, you can use `uplot bar -d ' ' data.txt`. 
+You do not need to use `-d` option for tab-delimited text since the default value is tab.
 
 ### Is there a way to specify a column as the x-axis or y-axis?
 
-Not yet. In principle, YouPlot treats the first column as the X axis and the second column as the Y axis. When working with multiple series, the first row is the X axis, the second row is series 1, the third row is series 2, and so on. If you pass only one column of data for `line` and `bar`, YouPlot will automatically use a sequential number starting from 1 as the X-axis. The　`--fmt xyy`, `--fmt xyxy` and `--fmt yx` options give you a few more choices. See `youplot <command> --help` for more details. YouPlot has limited functionalities, but you can use shell scripts such as `awk '{print $2, $1}'` to swap lines.
+Not yet. 
+YouPlot treats the first column as the X axis and the second column as the Y axis. 
+When working with multiple series, the first column is the X axis, the second column is series Y1, the third column is series Y2, and so on. 
+If you pass only one column of data for `line` and `bar`, YouPlot will automatically use a sequential number starting from 1 as the X-axis. 
+
+* `--fmt xyy` `--fmt xyxy` `--fmt yx` options give you a few more choices. 
+See `youplot <command> --help` for more details. 
+
+* Use `awk '{print $2, $1}'` to swap lines.
+* Use `paste` to concatenate series.
 
 ### How to plot real-time data?
 
@@ -216,18 +227,21 @@ uplot colors
 
 ## Contributing
 
+YouPlot is a library under development, so even small improvements like typofix are welcome!
+Please feel free to send us your pull requests.
+
 * [Report bugs](https://github.com/kojix2/youplot/issues)
 * Fix bugs and [submit pull requests](https://github.com/kojix2/youplot/pulls)
 * Write, clarify, or fix documentation
   * English corrections by native speakers are welcome.
 * Suggest or add new features
-
+* Make a donation
 
 ### Development
 
 ```sh
-git clone https://github.com/your_name/GR.rb # Clone the Git repo
-cd GR.rb
+# fork the main repository by clicking the Fork button. 
+git clone https://github.com/your_name/YouPlot
 bundle install             # Install the gem dependencies
 bundle exec rake test      # Run the test
 bundle exec rake install   # Installation from source code

data/lib/youplot/backends/processing.rb

@@ -11,12 +11,16 @@ module YouPlot
         if tally && Enumerable.method_defined?(:tally)
           arr.tally
         else
-          # https://github.com/marcandre/backports
-          arr.each_with_object(Hash.new(0)) { |item, res| res[item] += 1 }
-             .tap { |h| h.default = nil }
+          # value_counts Enumerable::Statistics
+          arr.value_counts(dropna: false)
         end
-          .sort { |a, b| a[1] <=> b[1] }
-          .reverse
+          .sort do |a, b|
+            # compare values
+            r = b[1] <=> a[1]
+            # If the values are the same, compare by name
+            r = a[0] <=> b[0] if r == 0
+            r
+          end
           .transpose
       end
     end

data/lib/youplot/backends/{unicode_plot_backend.rb → unicode_plot.rb}

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+# UnicodePlot - Plot your data by Unicode characters
+# https://github.com/red-data-tools/unicode_plot.rb
+
 require_relative 'processing'
 require 'unicode_plot'
 
 module YouPlot
   # plotting functions.
   module Backends
-    module UnicodePlotBackend
+    module UnicodePlot
       class Error < StandardError; end
 
       module_function
@@ -39,19 +42,7 @@ module YouPlot
           labels = series[x_col]
           values = series[y_col].map(&:to_f)
         end
-        begin
-          UnicodePlot.barplot(labels, values, **params.to_hc)
-        # UnicodePlot error:
-        # All values have to be positive. Negative bars are not supported.
-        rescue ArgumentError => e
-          if YouPlot.run_as_executable?
-            warn e.backtrace[0]
-            warn "\e[35m#{e}\e[0m"
-            exit 1
-          else
-            raise e
-          end
-        end
+        ::UnicodePlot.barplot(labels, values, **params.to_hc)
       end
 
       def histogram(data, params)
@@ -59,7 +50,7 @@ module YouPlot
         series = data.series
         params.title ||= data.headers[0] if headers
         values = series[0].map(&:to_f)
-        UnicodePlot.histogram(values, **params.to_hc)
+        ::UnicodePlot.histogram(values, **params.to_hc)
       end
 
       def line(data, params, fmt = nil)
@@ -69,7 +60,7 @@ module YouPlot
           # If there is only one series, it is assumed to be sequential data.
           params.ylabel ||= headers[0] if headers
           y = series[0].map(&:to_f)
-          UnicodePlot.lineplot(y, **params.to_hc)
+          ::UnicodePlot.lineplot(y, **params.to_hc)
         else
           # If there are 2 or more series...
           if fmt == 'yx'
@@ -87,7 +78,7 @@ module YouPlot
           end
           x = series[x_col].map(&:to_f)
           y = series[y_col].map(&:to_f)
-          UnicodePlot.lineplot(x, y, **params.to_hc)
+          ::UnicodePlot.lineplot(x, y, **params.to_hc)
         end
       end
 
@@ -106,9 +97,9 @@ module YouPlot
         end
         params.xlim ||= series[0].flatten.minmax # why need?
         params.ylim ||= series[1..-1].flatten.minmax # why need?
-        plot = UnicodePlot.public_send(method1, series[0], series[1], **params.to_hc)
+        plot = ::UnicodePlot.public_send(method1, series[0], series[1], **params.to_hc)
         2.upto(series.size - 1) do |i|
-          UnicodePlot.public_send(method2, plot, series[0], series[i], name: headers&.[](i))
+          ::UnicodePlot.public_send(method2, plot, series[0], series[i], name: headers&.[](i))
         end
         plot
       end
@@ -124,9 +115,9 @@ module YouPlot
         params.xlim ||= series2.map(&:first).flatten.minmax # why need?
         params.ylim ||= series2.map(&:last).flatten.minmax # why need?
         x1, y1 = series2.shift
-        plot = UnicodePlot.public_send(method1, x1, y1, **params.to_hc)
+        plot = ::UnicodePlot.public_send(method1, x1, y1, **params.to_hc)
         series2.each_with_index do |(xi, yi), i|
-          UnicodePlot.public_send(method2, plot, xi, yi, name: headers&.[]((i + 1) * 2))
+          ::UnicodePlot.public_send(method2, plot, xi, yi, name: headers&.[]((i + 1) * 2))
         end
         plot
       end
@@ -164,13 +155,13 @@ module YouPlot
         series = data.series
         headers ||= (1..series.size).map(&:to_s)
         series.map! { |s| s.map(&:to_f) }
-        UnicodePlot.boxplot(headers, series, **params.to_hc)
+        ::UnicodePlot.boxplot(headers, series, **params.to_hc)
       end
 
       def colors(color_names = false)
         # FIXME
         s = String.new
-        UnicodePlot::StyledPrinter::TEXT_COLORS.each do |k, v|
+        ::UnicodePlot::StyledPrinter::TEXT_COLORS.each do |k, v|
           s << v
           s << k.to_s
           unless color_names
@@ -190,18 +181,24 @@ module YouPlot
       def check_series_size(data, fmt)
         series = data.series
         if series.size == 1
-          warn 'youplot: There is only one series of input data. Please check the delimiter.'
-          warn ''
-          warn "  Headers: \e[35m#{data.headers.inspect}\e[0m"
-          warn "  The first item is: \e[35m\"#{series[0][0]}\"\e[0m"
-          warn "  The last item is : \e[35m\"#{series[0][-1]}\"\e[0m"
+          warn <<~EOS
+            youplot: There is only one series of input data. Please check the delimiter.
+
+            Headers: \e[35m#{data.headers.inspect}\e[0m
+            The first item is: \e[35m\"#{series[0][0]}\"\e[0m
+            The last item is : \e[35m\"#{series[0][-1]}\"\e[0m
+          EOS
+          # NOTE: Error messages cannot be colored.
           YouPlot.run_as_executable ? exit(1) : raise(Error)
         end
         if fmt == 'xyxy' && series.size.odd?
-          warn 'YouPlot: In the xyxy format, the number of series must be even.'
-          warn ''
-          warn "  Number of series: \e[35m#{series.size}\e[0m"
-          warn "  Headers: \e[35m#{data.headers.inspect}\e[0m"
+          warn <<~EOS
+            YouPlot: In the xyxy format, the number of series must be even.
+
+            Number of series: \e[35m#{series.size}\e[0m
+            Headers: \e[35m#{data.headers.inspect}\e[0m
+          EOS
+          # NOTE: Error messages cannot be colored.
           YouPlot.run_as_executable ? exit(1) : raise(Error)
         end
       end

data/lib/youplot/command.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require_relative 'dsv'
-require_relative 'command/parser'
+require_relative 'parser'
 
 # FIXME
-require_relative 'backends/unicode_plot_backend'
+require_relative 'backends/unicode_plot'
 
 module YouPlot
   Data = Struct.new(:headers, :series)
@@ -19,7 +19,7 @@ module YouPlot
       @command = nil
       @params  = nil
       @options = nil
-      @backend = YouPlot::Backends::UnicodePlotBackend
+      @backend = YouPlot::Backends::UnicodePlot
     end
 
     def run_as_executable
@@ -33,21 +33,34 @@ module YouPlot
       @options ||= parser.options
       @params  ||= parser.params
 
+      # color command
       if %i[colors color colours colour].include? @command
         plot = create_plot
         output_plot(plot)
-      elsif options[:progressive]
+        return
+      end
+
+      # progressive mode
+      if options[:progressive]
         stop = false
         Signal.trap(:INT) { stop = true }
-        options[:output].print "\e[?25l" # make cursor invisible
+
+        # make cursor invisible
+        options[:output].print "\e[?25l"
+
+        # mainloop
         while (input = Kernel.gets)
           n = main_progressive(input)
           break if stop
 
           options[:output].print "\e[#{n}F"
         end
+
         options[:output].print "\e[0J"
-        options[:output].print "\e[?25h" # make cursor visible
+        # make cursor visible
+        options[:output].print "\e[?25h"
+
+      # normal mode
       else
         # Sometimes the input file does not end with a newline code.
         while (input = Kernel.gets(nil))
@@ -59,13 +72,32 @@ module YouPlot
     private
 
     def main(input)
+      # Outputs input data to a file or stdout.
       output_data(input)
 
-      @data = read_dsv(input)
+      @data = parse_dsv(input)
 
+      # Debug mode, show parsed results
       pp @data if options[:debug]
 
-      plot = create_plot
+      # When run as a program instead of a library
+      if YouPlot.run_as_executable?
+        begin
+          plot = create_plot
+        rescue ArgumentError => e
+          # Show only one line of error.
+          warn e.backtrace[0]
+          # Show error message in purple
+          warn "\e[35m#{e}\e[0m"
+          # Explicitly terminated with exit code: 1
+          exit 1
+        end
+
+      # When running YouPlot as a library (e.g. for testing)
+      else
+        plot = create_plot
+      end
+
       output_plot(plot)
     end
 
@@ -85,15 +117,28 @@ module YouPlot
       @raw_data << input
 
       # FIXME
-      @data = read_dsv(@raw_data)
+      @data = parse_dsv(@raw_data)
 
       plot = create_plot
       output_plot_progressive(plot)
     end
 
-    def read_dsv(input)
-      input = input.dup.force_encoding(options[:encoding]).encode('utf-8') if options[:encoding]
-      DSV.parse(input, options[:delimiter], options[:headers], options[:transpose])
+    def parse_dsv(input)
+      # If encoding is specified, convert to UTF-8
+      if options[:encoding]
+        input.force_encoding(options[:encoding])
+             .encode!('utf-8')
+      end
+
+      begin
+        data = DSV.parse(input, options[:delimiter], options[:headers], options[:transpose])
+      rescue CSV::MalformedCSVError => e
+        warn 'Failed to parse the text. '
+        warn 'Please try to set the correct character encoding with --encoding option.'
+        raise e
+      end
+
+      data
     end
 
     def create_plot
@@ -137,9 +182,9 @@ module YouPlot
 
     def output_plot(plot)
       case options[:output]
-      when IO
+      when IO, StringIO
         plot.render(options[:output])
-      else
+      when String, Tempfile
         File.open(options[:output], 'w') do |f|
           plot.render(f)
         end
@@ -148,7 +193,7 @@ module YouPlot
 
     def output_plot_progressive(plot)
       case options[:output]
-      when IO
+      when IO, StringIO
         # RefactorMe
         out = StringIO.new(String.new)
         def out.tty?

data/lib/youplot/dsv.rb

@@ -3,41 +3,49 @@
 require 'csv'
 
 module YouPlot
-  # Read and interpret Delimiter-separated values format file or stream.
+  # Module to handle DSV (Delimiter-separated values) format.
+  # Extract header and series.
   module DSV
     module_function
 
     def parse(input, delimiter, headers, transpose)
-      arr = parse_as_csv(input, delimiter)
+      # Parse as CSV
+      arr = CSV.parse(input, col_sep: delimiter)
+
+      # Remove blank lines
+      arr.delete_if do |i|
+        i == [] or i.all? nil
+      end
+
+      # get header
       headers = get_headers(arr, headers, transpose)
+
+      # get series
       series = get_series(arr, headers, transpose)
-      if headers.nil?
-        Data.new(headers, series)
-      else
-        if headers.include?(nil)
-          warn "\e[35mHeaders contains nil in it.\e[0m"
-        elsif headers.include? ''
-          warn "\e[35mHeaders contains \"\" in it.\e[0m"
-        end
-        h_size = headers.size
-        s_size = series.size
-        if h_size == s_size
-          Data.new(headers, series)
-        elsif h_size > s_size
-          warn "\e[35mThe number of headers is greater than the number of series.\e[0m"
-          exit 1 if YouPlot.run_as_executable?
-        elsif h_size < s_size
-          warn "\e[35mThe number of headers is less than the number of series.\e[0m"
-          exit 1 if YouPlot.run_as_executable?
-        end
+
+      # Return if No header
+      return Data.new(headers, series) if headers.nil?
+
+      # Warn if header contains nil
+      warn "\e[35mHeaders contains nil in it.\e[0m" if headers.include?(nil)
+
+      # Warn if header contains ''
+      warn "\e[35mHeaders contains \"\" in it.\e[0m" if headers.include? ''
+
+      # Make sure the number of elements in the header matches the number of series.
+      h_size = headers.size
+      s_size = series.size
+
+      if h_size > s_size
+        warn "\e[35mThe number of headers is greater than the number of series.\e[0m"
+        exit 1 if YouPlot.run_as_executable?
+
+      elsif h_size < s_size
+        warn "\e[35mThe number of headers is less than the number of series.\e[0m"
+        exit 1 if YouPlot.run_as_executable?
       end
-    end
 
-    def parse_as_csv(input, delimiter)
-      CSV.parse(input, col_sep: delimiter)
-         .delete_if do |i|
-           i == [] or i.all? nil
-         end
+      Data.new(headers, series) if h_size == s_size
     end
 
     # Transpose different sized ruby arrays
@@ -47,31 +55,33 @@ module YouPlot
     end
 
     def get_headers(arr, headers, transpose)
-      if headers
-        if transpose
-          arr.map(&:first)
-        else
-          arr[0]
-        end
-      end
+      # header(-)
+      return nil unless headers
+
+      # header(+) trenspose(+)
+      return arr.map(&:first) if transpose
+
+      # header(+) transpose(-)
+      arr[0]
     end
 
     def get_series(arr, headers, transpose)
-      if headers
-        if arr.size > 1
-          if transpose
-            arr.map { |row| row[1..-1] }
-          else
-            transpose2(arr[1..-1])
-          end
-        else
-          Array.new(arr[0].size, [])
-        end
-      elsif transpose
-        arr
-      else
-        transpose2(arr)
+      # header(-)
+      unless headers
+        return arr if transpose
+
+        return transpose2(arr)
       end
+
+      # header(+) but no element in the series.
+      # TODO: should raise error?
+      return Array.new(arr[0].size, []) if arr.size == 1
+
+      # header(+) transpose(+)
+      return arr.map { |row| row[1..-1] } if transpose
+
+      # header(+) transpose(-)
+      transpose2(arr[1..-1])
     end
   end
 end

data/lib/youplot/options.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module YouPlot
+  # Command line options that are not Plot parameters
+  Options = Struct.new(
+    :delimiter,
+    :transpose,
+    :headers,
+    :pass,
+    :output,
+    :fmt,
+    :progressive,
+    :encoding,
+    :color_names,
+    :debug,
+    keyword_init: true
+  )
+end

data/lib/youplot/parameters.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module YouPlot
+  # UnicodePlot parameters.
+  # Why Struct, not Hash?
+  # * The keys are static in Struct.
+  # * Struct does not conflict with keyword arguments. Hash dose.
+  Parameters = Struct.new(
+    # Sort me!
+    :title,
+    :width,
+    :height,
+    :border,
+    :margin,
+    :padding,
+    :color,
+    :xlabel,
+    :ylabel,
+    :labels,
+    :symbol,
+    :xscale,
+    :nbins,
+    :closed,
+    :canvas,
+    :xlim,
+    :ylim,
+    :grid,
+    :name
+  ) do
+    def to_hc
+      to_h.compact
+    end
+  end
+end

data/lib/youplot/parser.rb

@@ -0,0 +1,306 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative 'options'
+
+module YouPlot
+  # Class for parsing command line options
+  class Parser
+    class Error < StandardError; end
+
+    attr_reader :command, :options, :params,
+                :main_parser, :sub_parser
+
+    def initialize
+      @command = nil
+
+      @options = Options.new(
+        delimiter: "\t",
+        transpose: false,
+        headers: nil,
+        pass: false,
+        output: $stderr,
+        fmt: 'xyy',
+        progressive: false,
+        encoding: nil,
+        color_names: false,
+        debug: false
+      )
+
+      @params = Parameters.new
+    end
+
+    def create_base_parser
+      OptionParser.new do |parser|
+        parser.program_name  = 'YouPlot'
+        parser.version       = YouPlot::VERSION
+        parser.summary_width = 23
+        parser.on_tail('') # Add a blank line at the end
+        parser.separator('')
+        parser.on('Common options:')
+        parser.on('-O', '--pass [FILE]', 'file to output input data to [stdout]',
+                  'for inserting YouPlot in the middle of Unix pipes') do |v|
+          options[:pass] = v || $stdout
+        end
+        parser.on('-o', '--output [FILE]', 'file to output plots to [stdout]',
+                  'If no option is specified, plot will print to stderr') do |v|
+          options[:output] = v || $stdout
+        end
+        parser.on('-d', '--delimiter DELIM', String, 'use DELIM instead of [TAB] for field delimiter') do |v|
+          options[:delimiter] = v
+        end
+        parser.on('-H', '--headers', TrueClass, 'specify that the input has header row') do |v|
+          options[:headers] = v
+        end
+        parser.on('-T', '--transpose', TrueClass, 'transpose the axes of the input data') do |v|
+          options[:transpose] = v
+        end
+        parser.on('-t', '--title STR', String, 'print string on the top of plot') do |v|
+          params.title = v
+        end
+        parser.on('-x', '--xlabel STR', String, 'print string on the bottom of the plot') do |v|
+          params.xlabel = v
+        end
+        parser.on('-y', '--ylabel STR', String, 'print string on the far left of the plot') do |v|
+          params.ylabel = v
+        end
+        parser.on('-w', '--width INT', Integer, 'number of characters per row') do |v|
+          params.width = v
+        end
+        parser.on('-h', '--height INT', Numeric, 'number of rows') do |v|
+          params.height = v
+        end
+        border_options = UnicodePlot::BORDER_MAP.keys.join(', ')
+        parser.on('-b', '--border STR', String, 'specify the style of the bounding box', "(#{border_options})") do |v|
+          params.border = v.to_sym
+        end
+        parser.on('-m', '--margin INT', Numeric, 'number of spaces to the left of the plot') do |v|
+          params.margin = v
+        end
+        parser.on('--padding INT', Numeric, 'space of the left and right of the plot') do |v|
+          params.padding = v
+        end
+        parser.on('-c', '--color VAL', String, 'color of the drawing') do |v|
+          params.color = v =~ /\A[0-9]+\z/ ? v.to_i : v.to_sym
+        end
+        parser.on('--[no-]labels', TrueClass, 'hide the labels') do |v|
+          params.labels = v
+        end
+        parser.on('-p', '--progress', TrueClass, 'progressive mode [experimental]') do |v|
+          options[:progressive] = v
+        end
+        parser.on('-C', '--color-output', TrueClass, 'colorize even if writing to a pipe') do |_v|
+          UnicodePlot::IOContext.define_method(:color?) { true } # FIXME
+        end
+        parser.on('-M', '--monochrome', TrueClass, 'no colouring even if writing to a tty') do |_v|
+          UnicodePlot::IOContext.define_method(:color?) { false } # FIXME
+        end
+        parser.on('--encoding STR', String, 'Specify the input encoding') do |v|
+          options[:encoding] = v
+        end
+        # Optparse adds the help option, but it doesn't show up in usage.
+        # This is why you need the code below.
+        parser.on('--help', 'print sub-command help menu') do
+          puts parser.help
+          exit if YouPlot.run_as_executable?
+        end
+        parser.on('--debug', TrueClass, 'print preprocessed data') do |v|
+          options[:debug] = v
+        end
+        # yield opt if block_given?
+      end
+    end
+
+    def create_main_parser
+      @main_parser = create_base_parser
+      main_parser.banner = \
+        <<~MSG
+
+          Program: YouPlot (Tools for plotting on the terminal)
+          Version: #{YouPlot::VERSION} (using UnicodePlot #{UnicodePlot::VERSION})
+          Source:  https://github.com/kojix2/youplot
+
+          Usage:   uplot <command> [options] <in.tsv>
+
+          Commands:
+              barplot    bar           draw a horizontal barplot
+              histogram  hist          draw a horizontal histogram
+              lineplot   line          draw a line chart
+              lineplots  lines         draw a line chart with multiple series
+              scatter    s             draw a scatter plot
+              density    d             draw a density plot
+              boxplot    box           draw a horizontal boxplot
+              colors     color         show the list of available colors
+
+              count      c             draw a baplot based on the number of
+                                       occurrences (slow)
+
+          General options:
+              --help                   print command specific help menu
+              --version                print the version of YouPlot
+        MSG
+
+      # Help for the main parser is simple.
+      # Simply show the banner above.
+      main_parser.on('--help', 'print sub-command help menu') do
+        puts main_parser.banner
+        puts
+        exit if YouPlot.run_as_executable?
+      end
+    end
+
+    def sub_parser_add_symbol
+      sub_parser.on_head('--symbol STR', String, 'character to be used to plot the bars') do |v|
+        params.symbol = v
+      end
+    end
+
+    def sub_parser_add_xscale
+      xscale_options = UnicodePlot::ValueTransformer::PREDEFINED_TRANSFORM_FUNCTIONS.keys.join(', ')
+      sub_parser.on_head('--xscale STR', String, "axis scaling (#{xscale_options})") do |v|
+        params.xscale = v.to_sym
+      end
+    end
+
+    def sub_parser_add_canvas
+      sub_parser.on_head('--canvas STR', String, 'type of canvas') do |v|
+        params.canvas = v.to_sym
+      end
+    end
+
+    def sub_parser_add_xlim
+      sub_parser.on_head('--xlim FLOAT,FLOAT', Array, 'plotting range for the x coordinate') do |v|
+        params.xlim = v
+      end
+    end
+
+    def sub_parser_add_ylim
+      sub_parser.on_head('--ylim FLOAT,FLOAT', Array, 'plotting range for the y coordinate') do |v|
+        params.ylim = v
+      end
+    end
+
+    def sub_parser_add_grid
+      sub_parser.on_head('--[no-]grid', TrueClass, 'draws grid-lines at the origin') do |v|
+        params.grid = v
+      end
+    end
+
+    def sub_parser_add_fmt_xyxy
+      sub_parser.on_head('--fmt STR', String,
+                         'xyxy : header is like x1, y1, x2, y2, x3, y3...',
+                         'xyy  : header is like x, y1, y2, y2, y3...') do |v|
+        options[:fmt] = v
+      end
+    end
+
+    def sub_parser_add_fmt_yx
+      sub_parser.on_head('--fmt STR', String,
+                         'xy : header is like x, y...',
+                         'yx : header is like y, x...') do |v|
+        options[:fmt] = v
+      end
+    end
+
+    def create_sub_parser
+      @sub_parser = create_base_parser
+      sub_parser.banner = \
+        <<~MSG
+
+          Usage: YouPlot #{command} [options] <in.tsv>
+
+          Options for #{command}:
+        MSG
+
+      case command
+
+      # If you type only `uplot` in the terminal.
+      when nil
+        warn main_parser.banner
+        warn "\n"
+        exit 1 if YouPlot.run_as_executable?
+
+      when :barplot, :bar
+        sub_parser_add_symbol
+        sub_parser_add_fmt_yx
+        sub_parser_add_xscale
+
+      when :count, :c
+        sub_parser_add_symbol
+        sub_parser_add_xscale
+
+      when :histogram, :hist
+        sub_parser_add_symbol
+        sub_parser.on_head('--closed STR', String, 'side of the intervals to be closed [left]') do |v|
+          params.closed = v
+        end
+        sub_parser.on_head('-n', '--nbins INT', Numeric, 'approximate number of bins') do |v|
+          params.nbins = v
+        end
+
+      when :lineplot, :line
+        sub_parser_add_canvas
+        sub_parser_add_grid
+        sub_parser_add_fmt_yx
+        sub_parser_add_ylim
+        sub_parser_add_xlim
+
+      when :lineplots, :lines
+        sub_parser_add_canvas
+        sub_parser_add_grid
+        sub_parser_add_fmt_xyxy
+        sub_parser_add_ylim
+        sub_parser_add_xlim
+
+      when :scatter, :s
+        sub_parser_add_canvas
+        sub_parser_add_grid
+        sub_parser_add_fmt_xyxy
+        sub_parser_add_ylim
+        sub_parser_add_xlim
+
+      when :density, :d
+        sub_parser_add_canvas
+        sub_parser_add_grid
+        sub_parser_add_fmt_xyxy
+        sub_parser_add_ylim
+        sub_parser_add_xlim
+
+      when :boxplot, :box
+        sub_parser_add_xlim
+
+      when :colors, :color, :colours, :colour
+        sub_parser.on_head('-n', '--names', 'show color names only', TrueClass) do |v|
+          options[:color_names] = v
+        end
+
+      else
+        error_message = "uplot: unrecognized command '#{command}'"
+        if YouPlot.run_as_executable?
+          warn error_message
+          exit 1
+        else
+          raise Error, error_message
+        end
+      end
+    end
+
+    def parse_options(argv = ARGV)
+      begin
+        create_main_parser.order!(argv)
+      rescue OptionParser::ParseError => e
+        warn "uplot: #{e.message}"
+        exit 1 if YouPlot.run_as_executable?
+      end
+
+      @command = argv.shift&.to_sym
+
+      begin
+        create_sub_parser&.parse!(argv)
+      rescue OptionParser::ParseError => e
+        warn "uplot: #{e.message}"
+        exit 1 if YouPlot.run_as_executable?
+      end
+    end
+  end
+end

data/lib/youplot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YouPlot
-  VERSION = '0.3.4'
+  VERSION = '0.4.0'
 end

data/lib/youplot.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'unicode_plot'
-require 'youplot/version'
-require 'youplot/dsv'
-require 'youplot/command'
+require_relative 'youplot/version'
+require_relative 'youplot/dsv'
+require_relative 'youplot/parameters'
+require_relative 'youplot/command'
 
 module YouPlot
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: youplot
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_plot
@@ -109,12 +109,12 @@ files:
 - exe/youplot
 - lib/youplot.rb
 - lib/youplot/backends/processing.rb
-- lib/youplot/backends/unicode_plot_backend.rb
+- lib/youplot/backends/unicode_plot.rb
 - lib/youplot/command.rb
-- lib/youplot/command/options.rb
-- lib/youplot/command/parser.rb
-- lib/youplot/command/plot_params.rb
 - lib/youplot/dsv.rb
+- lib/youplot/options.rb
+- lib/youplot/parameters.rb
+- lib/youplot/parser.rb
 - lib/youplot/version.rb
 homepage: https://github.com/kojix2/youplot
 licenses:
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: A command line tool for Unicode Plotting

data/lib/youplot/command/options.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module YouPlot
-  class Command
-    Options = Struct.new(
-      :delimiter,
-      :transpose,
-      :headers,
-      :pass,
-      :progressive,
-      :output,
-      :fmt,
-      :encoding,
-      :color_names,
-      :debug,
-      keyword_init: true
-    )
-  end
-end

data/lib/youplot/command/parser.rb

@@ -1,297 +0,0 @@
-# frozen_string_literal: true
-
-require 'optparse'
-require_relative 'options'
-require_relative 'plot_params'
-
-module YouPlot
-  class Command
-    class Parser
-      class Error < StandardError; end
-
-      attr_reader :command, :options, :params,
-                  :main_parser, :sub_parser
-
-      def initialize
-        @command = nil
-
-        @options = Options.new(
-          delimiter: "\t",
-          transpose: false,
-          headers: nil,
-          pass: false,
-          output: $stderr,
-          fmt: 'xyy',
-          encoding: nil,
-          color_names: false,
-          debug: false
-        )
-
-        @params = PlotParams.new
-      end
-
-      def create_default_parser
-        OptionParser.new do |parser|
-          parser.program_name  = 'YouPlot'
-          parser.version       = YouPlot::VERSION
-          parser.summary_width = 24
-          parser.on_tail('') # Add a blank line at the end
-          parser.separator('')
-          parser.on('Common options:')
-          parser.on('-O', '--pass [FILE]', 'file to output input data to [stdout]',
-                    'for inserting YouPlot in the middle of Unix pipes') do |v|
-            options[:pass] = v || $stdout
-          end
-          parser.on('-o', '--output [FILE]', 'file to output plots to [stdout]',
-                    'If no option is specified, plot will print to stderr') do |v|
-            options[:output] = v || $stdout
-          end
-          parser.on('-d', '--delimiter DELIM', String, 'use DELIM instead of [TAB] for field delimiter') do |v|
-            options[:delimiter] = v
-          end
-          parser.on('-H', '--headers', TrueClass, 'specify that the input has header row') do |v|
-            options[:headers] = v
-          end
-          parser.on('-T', '--transpose', TrueClass, 'transpose the axes of the input data') do |v|
-            options[:transpose] = v
-          end
-          parser.on('-t', '--title STR', String, 'print string on the top of plot') do |v|
-            params.title = v
-          end
-          parser.on('-x', '--xlabel STR', String, 'print string on the bottom of the plot') do |v|
-            params.xlabel = v
-          end
-          parser.on('-y', '--ylabel STR', String, 'print string on the far left of the plot') do |v|
-            params.ylabel = v
-          end
-          parser.on('-w', '--width INT', Integer, 'number of characters per row') do |v|
-            params.width = v
-          end
-          parser.on('-h', '--height INT', Numeric, 'number of rows') do |v|
-            params.height = v
-          end
-          parser.on('-b', '--border STR', String, 'specify the style of the bounding box') do |v|
-            params.border = v.to_sym
-          end
-          parser.on('-m', '--margin INT', Numeric, 'number of spaces to the left of the plot') do |v|
-            params.margin = v
-          end
-          parser.on('--padding INT', Numeric, 'space of the left and right of the plot') do |v|
-            params.padding = v
-          end
-          parser.on('-c', '--color VAL', String, 'color of the drawing') do |v|
-            params.color = v =~ /\A[0-9]+\z/ ? v.to_i : v.to_sym
-          end
-          parser.on('--[no-]labels', TrueClass, 'hide the labels') do |v|
-            params.labels = v
-          end
-          parser.on('-p', '--progress', TrueClass, 'progressive mode [experimental]') do |v|
-            options[:progressive] = v
-          end
-          parser.on('--encoding STR', String, 'Specify the input encoding') do |v|
-            options[:encoding] = v
-          end
-          # Optparse adds the help option, but it doesn't show up in usage.
-          # This is why you need the code below.
-          parser.on('--help', 'print sub-command help menu') do
-            puts parser.help
-            exit if YouPlot.run_as_executable?
-          end
-          parser.on('--debug', TrueClass, 'print preprocessed data') do |v|
-            options[:debug] = v
-          end
-          # yield opt if block_given?
-        end
-      end
-
-      def create_main_parser
-        @main_parser = create_default_parser
-        main_parser.banner = \
-          <<~MSG
-
-            Program: YouPlot (Tools for plotting on the terminal)
-            Version: #{YouPlot::VERSION} (using UnicodePlot #{UnicodePlot::VERSION})
-            Source:  https://github.com/kojix2/youplot
-
-            Usage:   uplot <command> [options] <in.tsv>
-
-            Commands:
-                barplot    bar           draw a horizontal barplot
-                histogram  hist          draw a horizontal histogram
-                lineplot   line          draw a line chart
-                lineplots  lines         draw a line chart with multiple series
-                scatter    s             draw a scatter plot
-                density    d             draw a density plot
-                boxplot    box           draw a horizontal boxplot
-                colors     color         show the list of available colors
-
-                count      c             draw a baplot based on the number of
-                                         occurrences (slow)
-
-            General options:
-                --help                   print command specific help menu
-                --version                print the version of YouPlot
-          MSG
-
-        # Help for the main parser is simple.
-        # Simply show the banner above.
-        main_parser.on('--help', 'print sub-command help menu') do
-          puts main_parser.banner
-          puts
-          exit if YouPlot.run_as_executable?
-        end
-      end
-
-      def sub_parser_add_symbol
-        sub_parser.on_head('--symbol STR', String, 'character to be used to plot the bars') do |v|
-          params.symbol = v
-        end
-      end
-
-      def sub_parser_add_xscale
-        xscale_options = UnicodePlot::ValueTransformer::PREDEFINED_TRANSFORM_FUNCTIONS.keys.join(', ')
-        sub_parser.on_head('--xscale STR', String, "axis scaling (#{xscale_options})") do |v|
-          params.xscale = v
-        end
-      end
-
-      def sub_parser_add_canvas
-        sub_parser.on_head('--canvas STR', String, 'type of canvas') do |v|
-          params.canvas = v.to_sym
-        end
-      end
-
-      def sub_parser_add_xlim
-        sub_parser.on_head('--xlim FLOAT,FLOAT', Array, 'plotting range for the x coordinate') do |v|
-          params.xlim = v.take(2)
-        end
-      end
-
-      def sub_parser_add_ylim
-        sub_parser.on_head('--ylim FLOAT,FLOAT', Array, 'plotting range for the y coordinate') do |v|
-          params.ylim = v.take(2)
-        end
-      end
-
-      def sub_parser_add_grid
-        sub_parser.on_head('--[no-]grid', TrueClass, 'draws grid-lines at the origin') do |v|
-          params.grid = v
-        end
-      end
-
-      def create_sub_parser
-        @sub_parser = create_default_parser
-        sub_parser.banner = \
-          <<~MSG
-
-            Usage: YouPlot #{command} [options] <in.tsv>
-
-            Options for #{command}:
-          MSG
-
-        case command
-
-        # If you type only `uplot` in the terminal.
-        when nil
-          warn main_parser.banner
-          warn "\n"
-          exit 1 if YouPlot.run_as_executable?
-
-        when :barplot, :bar
-          sub_parser_add_symbol
-          sub_parser.on_head('--fmt STR', String, 'xy : header is like x, y...', 'yx : header is like y, x...') do |v|
-            options[:fmt] = v
-          end
-          sub_parser_add_xscale
-
-        when :count, :c
-          sub_parser_add_symbol
-          sub_parser_add_xscale
-
-        when :histogram, :hist
-          sub_parser_add_symbol
-          sub_parser.on_head('--closed STR', String, 'side of the intervals to be closed [left]') do |v|
-            params.closed = v
-          end
-          sub_parser.on_head('-n', '--nbins INT', Numeric, 'approximate number of bins') do |v|
-            params.nbins = v
-          end
-
-        when :lineplot, :line
-          sub_parser_add_canvas
-          sub_parser_add_grid
-          sub_parser.on_head('--fmt STR', String, 'xy : header is like x, y...', 'yx : header is like y, x...') do |v|
-            options[:fmt] = v
-          end
-          sub_parser_add_ylim
-          sub_parser_add_xlim
-
-        when :lineplots, :lines
-          sub_parser_add_canvas
-          sub_parser_add_grid
-          sub_parser.on_head('--fmt STR', String, 'xyxy : header is like x1, y1, x2, y2, x3, y3...',
-                             'xyy  : header is like x, y1, y2, y2, y3...') do |v|
-            options[:fmt] = v
-          end
-          sub_parser_add_ylim
-          sub_parser_add_xlim
-
-        when :scatter, :s
-          sub_parser_add_canvas
-          sub_parser_add_grid
-          sub_parser.on_head('--fmt STR', String, 'xyxy : header is like x1, y1, x2, y2, x3, y3...',
-                             'xyy  : header is like x, y1, y2, y2, y3...') do |v|
-            options[:fmt] = v
-          end
-          sub_parser_add_ylim
-          sub_parser_add_xlim
-
-        when :density, :d
-          sub_parser_add_canvas
-          sub_parser_add_grid
-          sub_parser.on('--fmt STR', String, 'xyxy : header is like x1, y1, x2, y2, x3, y3...',
-                        'xyy  : header is like x, y1, y2, y2, y3...') do |v|
-            options[:fmt] = v
-          end
-          sub_parser_add_ylim
-          sub_parser_add_xlim
-
-        when :boxplot, :box
-          sub_parser_add_xlim
-
-        when :colors, :color, :colours, :colour
-          sub_parser.on_head('-n', '--names', 'show color names only', TrueClass) do |v|
-            options[:color_names] = v
-          end
-
-        else
-          error_message = "uplot: unrecognized command '#{command}'"
-          if YouPlot.run_as_executable?
-            warn error_message
-            exit 1
-          else
-            raise Error, error_message
-          end
-        end
-      end
-
-      def parse_options(argv = ARGV)
-        begin
-          create_main_parser.order!(argv)
-        rescue OptionParser::ParseError => e
-          warn "uplot: #{e.message}"
-          exit 1 if YouPlot.run_as_executable?
-        end
-
-        @command = argv.shift&.to_sym
-
-        begin
-          create_sub_parser&.parse!(argv)
-        rescue OptionParser::ParseError => e
-          warn "uplot: #{e.message}"
-          exit 1 if YouPlot.run_as_executable?
-        end
-      end
-    end
-  end
-end

data/lib/youplot/command/plot_params.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module YouPlot
-  class Command
-    # UnicodePlot parameters.
-    # * Normally in a Ruby program, you might use hash for the parameter object.
-    # * Here, I use Struct for 2 safety reason.
-    # * The keys are static in Struct.
-    # * Struct does not conflict with keyword arguments. Hash dose.
-    PlotParams = Struct.new(
-      # Sort me!
-      :title,
-      :width,
-      :height,
-      :border,
-      :margin,
-      :padding,
-      :color,
-      :xlabel,
-      :ylabel,
-      :labels,
-      :symbol,
-      :xscale,
-      :nbins,
-      :closed,
-      :canvas,
-      :xlim,
-      :ylim,
-      :grid,
-      :name
-    ) do
-      def to_hc
-        to_h.compact
-      end
-    end
-  end
-end