youplot 0.3.1 → 0.4.0

data/lib/youplot/command.rb

@@ -1,97 +1,216 @@
 # frozen_string_literal: true
 
-require_relative 'dsv_reader'
-require_relative 'command/parser'
+require_relative 'dsv'
+require_relative 'parser'
 
 # FIXME
-require_relative 'backends/unicode_plot_backend'
+require_relative 'backends/unicode_plot'
 
 module YouPlot
   Data = Struct.new(:headers, :series)
 
   class Command
-    attr_accessor :params
-    attr_reader :data, :fmt, :parser
+    attr_accessor :command, :params, :options
+    attr_reader :data, :parser
 
     def initialize(argv = ARGV)
       @argv    = argv
-      @params  = Params.new
       @parser  = Parser.new
-      @backend = YouPlot::Backends::UnicodePlotBackend
+      @command = nil
+      @params  = nil
+      @options = nil
+      @backend = YouPlot::Backends::UnicodePlot
+    end
+
+    def run_as_executable
+      YouPlot.run_as_executable = true
+      run
     end
 
     def run
       parser.parse_options(@argv)
-      command   = parser.command
-      params    = parser.params
-      delimiter = parser.delimiter
-      transpose = parser.transpose
-      headers   = parser.headers
-      pass      = parser.pass
-      output    = parser.output
-      fmt       = parser.fmt
-      @encoding = parser.encoding
-      @debug    = parser.debug
-
-      if command == :colors
-        @backend.colors(parser.color_names)
-        exit
+      @command ||= parser.command
+      @options ||= parser.options
+      @params  ||= parser.params
+
+      # color command
+      if %i[colors color colours colour].include? @command
+        plot = create_plot
+        output_plot(plot)
+        return
       end
 
-      # Sometimes the input file does not end with a newline code.
-      while (input = Kernel.gets(nil))
-
-        # Pass the input to subsequent pipelines
-        case pass
-        when IO
-          pass.print(input)
-        else
-          if pass
-            File.open(pass, 'w') do |f|
-              f.print(input)
-            end
-          end
+      # progressive mode
+      if options[:progressive]
+        stop = false
+        Signal.trap(:INT) { stop = true }
+
+        # 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"
+        # 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))
+          main(input)
+        end
+      end
+    end
+
+    private
+
+    def main(input)
+      # Outputs input data to a file or stdout.
+      output_data(input)
+
+      @data = parse_dsv(input)
+
+      # Debug mode, show parsed results
+      pp @data if options[:debug]
+
+      # 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
+
+    def main_progressive(input)
+      output_data(input)
+
+      # FIXME
+      # Worked around the problem of not being able to draw
+      # plots when there is only one header line.
+      if @raw_data.nil?
+        @raw_data = String.new
+        if options[:headers]
+          @raw_data << input
+          return
         end
+      end
+      @raw_data << input
+
+      # FIXME
+      @data = parse_dsv(@raw_data)
+
+      plot = create_plot
+      output_plot_progressive(plot)
+    end
+
+    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
 
-        @data = if @encoding
-                  input2 = input.dup.force_encoding(@encoding).encode('utf-8')
-                  DSVReader.input(input2, delimiter, headers, transpose)
-                else
-                  DSVReader.input(input, delimiter, headers, transpose)
-                end
-
-        pp @data if @debug
-
-        plot = case command
-               when :bar, :barplot
-                 @backend.barplot(data, params, fmt)
-               when :count, :c
-                 @backend.barplot(data, params, count: true)
-               when :hist, :histogram
-                 @backend.histogram(data, params)
-               when :line, :lineplot
-                 @backend.line(data, params, fmt)
-               when :lines, :lineplots
-                 @backend.lines(data, params, fmt)
-               when :scatter, :s
-                 @backend.scatter(data, params, fmt)
-               when :density, :d
-                 @backend.density(data, params, fmt)
-               when :box, :boxplot
-                 @backend.boxplot(data, params)
-               else
-                 raise "unrecognized plot_type: #{command}"
-               end
-
-        case output
-        when IO
-          plot.render(output)
-        else
-          File.open(output, 'w') do |f|
-            plot.render(f)
+    def create_plot
+      case command
+      when :bar, :barplot
+        @backend.barplot(data, params, options[:fmt])
+      when :count, :c
+        @backend.barplot(data, params, count: true)
+      when :hist, :histogram
+        @backend.histogram(data, params)
+      when :line, :lineplot
+        @backend.line(data, params, options[:fmt])
+      when :lines, :lineplots
+        @backend.lines(data, params, options[:fmt])
+      when :scatter, :s
+        @backend.scatter(data, params, options[:fmt])
+      when :density, :d
+        @backend.density(data, params, options[:fmt])
+      when :box, :boxplot
+        @backend.boxplot(data, params)
+      when :colors, :color, :colours, :colour
+        @backend.colors(options[:color_names])
+      else
+        raise "unrecognized plot_type: #{command}"
+      end
+    end
+
+    def output_data(input)
+      # Pass the input to subsequent pipelines
+      case options[:pass]
+      when IO
+        options[:pass].print(input)
+      else
+        if options[:pass]
+          File.open(options[:pass], 'w') do |f|
+            f.print(input)
           end
         end
+      end
+    end
 
+    def output_plot(plot)
+      case options[:output]
+      when IO, StringIO
+        plot.render(options[:output])
+      when String, Tempfile
+        File.open(options[:output], 'w') do |f|
+          plot.render(f)
+        end
+      end
+    end
+
+    def output_plot_progressive(plot)
+      case options[:output]
+      when IO, StringIO
+        # RefactorMe
+        out = StringIO.new(String.new)
+        def out.tty?
+          true
+        end
+        plot.render(out)
+        lines = out.string.lines
+        lines.each do |line|
+          options[:output].print line.chomp
+          options[:output].print "\e[0K"
+          options[:output].puts
+        end
+        options[:output].print "\e[0J"
+        options[:output].flush
+        out.string.lines.size
+      else
+        raise 'In progressive mode, output to a file is not possible.'
       end
     end
   end

data/lib/youplot/dsv.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module YouPlot
+  # Module to handle DSV (Delimiter-separated values) format.
+  # Extract header and series.
+  module DSV
+    module_function
+
+    def parse(input, delimiter, headers, transpose)
+      # 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)
+
+      # 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
+
+      Data.new(headers, series) if h_size == s_size
+    end
+
+    # Transpose different sized ruby arrays
+    # https://stackoverflow.com/q/26016632
+    def transpose2(arr)
+      Array.new(arr.map(&:length).max) { |i| arr.map { |e| e[i] } }
+    end
+
+    def get_headers(arr, headers, transpose)
+      # header(-)
+      return nil unless headers
+
+      # header(+) trenspose(+)
+      return arr.map(&:first) if transpose
+
+      # header(+) transpose(-)
+      arr[0]
+    end
+
+    def get_series(arr, headers, transpose)
+      # 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