youplot 0.3.5 → 0.4.3

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,
+    :reverse,      # count
+    :color_names,  # color
+    :debug
+  )
+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,309 @@
+# 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(
+        "\t",    # elimiter:
+        false,   # transpose:
+        nil,     # headers:
+        false,   # pass:
+        $stderr, # output:
+        'xyy',   # fmt:
+        false,   # progressive:
+        nil,     # encoding:
+        false,   # color_names:
+        false    # debug:
+      )
+
+      @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('--xlabel STR', String, 'print string on the bottom of the plot') do |v|
+          params.xlabel = v
+        end
+        parser.on('--ylabel STR', String, 'print string on the far left of the plot') do |v|
+          params.ylabel = v
+        end
+        parser.on('-w', '--width INT', Numeric, '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/red-data-tools/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
+              count      c             draw a baplot based on the number of
+                                       occurrences (slow)
+              colors     color         show the list of available colors
+
+          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
+      canvas_types = UnicodePlot::Canvas::CANVAS_CLASS_MAP.keys.join(', ')
+      sub_parser.on_head('--canvas STR', String, 'type of canvas', "(#{canvas_types})") 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.map(&:to_f)
+      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.map(&:to_f)
+      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.on_head('-r', '--reverse', TrueClass, 'reverse the result of comparisons') do |v|
+          options.reverse = v
+        end
+        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', TrueClass, 'show color names only') 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.5'
+  VERSION = '0.4.3'
 end

data/lib/youplot.rb

@@ -1,11 +1,17 @@
 # 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
+  # @run_as_executable = true / false
+  # YouPlot behaves slightly differently when run as a command line tool
+  # and when run as a script (e.g. for testing). In the event of an error,
+  # when run as a command line tool, YouPlot will display a short error message
+  # and exit abnormally. When run as a script, it will just raise an error.
+  @run_as_executable = false
   class << self
     attr_accessor :run_as_executable
 
@@ -13,5 +19,4 @@ module YouPlot
       @run_as_executable
     end
   end
-  @run_as_executable = false
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: youplot
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.3
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_plot
@@ -16,84 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
 description: A command line tool for Unicode Plotting
 email:
 - 2xijok@gmail.com
@@ -109,14 +39,14 @@ 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
+homepage: https://github.com/red-data-tools/YouPlot
 licenses:
 - MIT
 metadata: {}
@@ -135,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.26
 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,
-      :output,
-      :fmt,
-      :progressive,
-      :encoding,
-      :color_names,
-      :debug,
-      keyword_init: true
-    )
-  end
-end