youplot 0.3.1 → 0.4.0

data/lib/youplot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: youplot
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_plot
@@ -94,8 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "Create ASCII charts on the terminal with data from standard streams
-  in the \npipeline. \n"
+description: A command line tool for Unicode Plotting
 email:
 - 2xijok@gmail.com
 executables:
@@ -110,11 +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/params.rb
-- lib/youplot/command/parser.rb
-- lib/youplot/dsv_reader.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,8 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
-summary: Create Ascii charts on your terminal.
+summary: A command line tool for Unicode Plotting
 test_files: []

data/lib/youplot/command/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.
-    Params = 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

data/lib/youplot/command/parser.rb

@@ -1,277 +0,0 @@
-# frozen_string_literal: true
-
-require 'optparse'
-require_relative 'params'
-
-module YouPlot
-  class Command
-    class Parser
-      attr_reader :command, :params,
-                  :delimiter, :transpose, :headers, :pass, :output, :fmt,
-                  :color_names, :encoding, :debug
-
-      def initialize
-        @command     = nil
-        @params      = Params.new
-
-        @delimiter   = "\t"
-        @transpose   = false
-        @headers     = nil
-        @pass        = false
-        @output      = $stderr
-        @fmt         = 'xyy'
-        @encoding    = nil
-        @debug       = false
-        @color_names = false
-      end
-
-      def create_default_parser
-        OptionParser.new do |opt|
-          opt.program_name  = 'YouPlot'
-          opt.version       = YouPlot::VERSION
-          opt.summary_width = 24
-          opt.on_tail('') # Add a blank line at the end
-          opt.separator('')
-          opt.on('Common options:')
-          opt.on('-O', '--pass [VAL]', 'file to output standard input data to [stdout]',
-                 'for inserting YouPlot in the middle of Unix pipes') do |v|
-            @pass = v || $stdout
-          end
-          opt.on('-o', '--output VAL', 'file to output results to [stderr]') do |v|
-            @output = v
-          end
-          opt.on('-d', '--delimiter VAL', String, 'use DELIM instead of TAB for field delimiter') do |v|
-            @delimiter = v
-          end
-          opt.on('-H', '--headers', TrueClass, 'specify that the input has header row') do |v|
-            @headers = v
-          end
-          opt.on('-T', '--transpose', TrueClass, 'transpose the axes of the input data') do |v|
-            @transpose = v
-          end
-          opt.on('-t', '--title VAL', String, 'print string on the top of plot') do |v|
-            params.title = v
-          end
-          opt.on('-x', '--xlabel VAL', String, 'print string on the bottom of the plot') do |v|
-            params.xlabel = v
-          end
-          opt.on('-y', '--ylabel VAL', String, 'print string on the far left of the plot') do |v|
-            params.ylabel = v
-          end
-          opt.on('-w', '--width VAL', Integer, 'number of characters per row') do |v|
-            params.width = v
-          end
-          opt.on('-h', '--height VAL', Numeric, 'number of rows') do |v|
-            params.height = v
-          end
-          opt.on('-b', '--border VAL', String, 'specify the style of the bounding box') do |v|
-            params.border = v.to_sym
-          end
-          opt.on('-m', '--margin VAL', Numeric, 'number of spaces to the left of the plot') do |v|
-            params.margin = v
-          end
-          opt.on('-p', '--padding VAL', Numeric, 'space of the left and right of the plot') do |v|
-            params.padding = v
-          end
-          opt.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
-          opt.on('--[no-]labels', TrueClass, 'hide the labels') do |v|
-            params.labels = v
-          end
-          opt.on('--encoding VAL', String, 'Specify the input encoding') do |v|
-            @encoding = v
-          end
-          # Optparse adds the help option, but it doesn't show up in usage.
-          # This is why you need the code below.
-          opt.on('--help', 'print sub-command help menu') do
-            puts opt.help
-            exit
-          end
-          opt.on('--debug', TrueClass, 'print preprocessed data') do |v|
-            @debug = v
-          end
-          yield opt if block_given?
-        end
-      end
-
-      def main_parser
-        @main_parser ||= create_default_parser do |main_parser|
-          # Here, help message is stored in the banner.
-          # Because help of main_parser may be referred by `sub_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                   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
-
-          # Actually, main_parser can take common optional arguments.
-          # However, these options dose not be shown in the help menu.
-          # I think the main help should be simple.
-          main_parser.on('--help', 'print sub-command help menu') do
-            puts main_parser.banner
-            puts
-            exit
-          end
-        end
-      end
-
-      def sub_parser
-        @sub_parser ||= create_default_parser do |parser|
-          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
-
-          when :barplot, :bar
-            parser.on_head('--symbol VAL', String, 'character to be used to plot the bars') do |v|
-              params.symbol = v
-            end
-            parser.on_head('--xscale VAL', String, 'axis scaling') do |v|
-              params.xscale = v
-            end
-            parser.on_head('--fmt VAL', String, 'xy : header is like x, y...', 'yx : header is like y, x...') do |v|
-              @fmt = v
-            end
-
-          when :count, :c
-            parser.on_head('--symbol VAL', String, 'character to be used to plot the bars') do |v|
-              params.symbol = v
-            end
-
-          when :histogram, :hist
-            parser.on_head('-n', '--nbins VAL', Numeric, 'approximate number of bins') do |v|
-              params.nbins = v
-            end
-            parser.on_head('--closed VAL', String) do |v|
-              params.closed = v
-            end
-            parser.on_head('--symbol VAL', String, 'character to be used to plot the bars') do |v|
-              params.symbol = v
-            end
-
-          when :lineplot, :line
-            parser.on_head('--canvas VAL', String, 'type of canvas') do |v|
-              params.canvas = v
-            end
-            parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
-              params.xlim = v.take(2)
-            end
-            parser.on_head('--ylim VAL', Array, 'plotting range for the y coordinate') do |v|
-              params.ylim = v.take(2)
-            end
-            parser.on_head('--fmt VAL', String, 'xy : header is like x, y...', 'yx : header is like y, x...') do |v|
-              @fmt = v
-            end
-
-          when :lineplots, :lines
-            parser.on_head('--canvas VAL', String) do |v|
-              params.canvas = v
-            end
-            parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
-              params.xlim = v.take(2)
-            end
-            parser.on_head('--ylim VAL', Array, 'plotting range for the y coordinate') do |v|
-              params.ylim = v.take(2)
-            end
-            parser.on_head('--fmt VAL', String, 'xyxy : header is like x1, y1, x2, y2, x3, y3...', 'xyy  : header is like x, y1, y2, y2, y3...') do |v|
-              @fmt = v
-            end
-
-          when :scatter, :s
-            parser.on_head('--canvas VAL', String) do |v|
-              params.canvas = v
-            end
-            parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
-              params.xlim = v.take(2)
-            end
-            parser.on_head('--ylim VAL', Array, 'plotting range for the y coordinate') do |v|
-              params.ylim = v.take(2)
-            end
-            parser.on_head('--fmt VAL', String, 'xyxy : header is like x1, y1, x2, y2, x3, y3...', 'xyy  : header is like x, y1, y2, y2, y3...') do |v|
-              @fmt = v
-            end
-
-          when :density, :d
-            parser.on_head('--grid', TrueClass) do |v|
-              params.grid = v
-            end
-            parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
-              params.xlim = v.take(2)
-            end
-            parser.on_head('--ylim VAL', Array, 'plotting range for the y coordinate') do |v|
-              params.ylim = v.take(2)
-            end
-            parser.on('--fmt VAL', String, 'xyxy : header is like x1, y1, x2, y2, x3, y3...', 'xyy  : header is like x, y1, y2, y2, y3...') do |v|
-              @fmt = v
-            end
-
-          when :boxplot, :box
-            parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
-              params.xlim = v.take(2)
-            end
-
-          when :colors
-            parser.on_head('-n', '--names', 'show color names only', TrueClass) do |v|
-              @color_names = v
-            end
-
-          else
-            warn "uplot: unrecognized command '#{command}'"
-            exit 1
-          end
-        end
-      end
-
-      def parse_options(argv = ARGV)
-        begin
-          main_parser.order!(argv)
-        rescue OptionParser::ParseError => e
-          warn "uplot: #{e.message}"
-          exit 1
-        end
-
-        @command = argv.shift&.to_sym
-
-        begin
-          sub_parser.parse!(argv)
-        rescue OptionParser::ParseError => e
-          warn "uplot: #{e.message}"
-          exit 1
-        end
-      end
-    end
-  end
-end

data/lib/youplot/dsv_reader.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'csv'
-
-module YouPlot
-  # Read and interpret Delimiter-separated values format file or stream.
-  module DSVReader
-    module_function
-
-    def input(input, delimiter, headers, transpose)
-      arr = parse_as_csv(input, delimiter)
-      headers = get_headers(arr, headers, transpose)
-      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
-        elsif h_size < s_size
-          warn "\e[35mThe number of headers is less than the number of series.\e[0m"
-          exit 1
-        end
-      end
-    end
-
-    def parse_as_csv(input, delimiter)
-      CSV.parse(input, col_sep: delimiter)
-         .delete_if do |i|
-           i == [] or i.all? nil
-         end
-    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)
-      if headers
-        if transpose
-          arr.map(&:first)
-        else
-          arr[0]
-        end
-      end
-    end
-
-    def get_series(arr, headers, transpose)
-      if transpose
-        if headers
-          arr.map { |row| row[1..-1] }
-        else
-          arr
-        end
-      elsif headers
-        transpose2(arr[1..-1])
-      else
-        transpose2(arr)
-      end
-    end
-  end
-end