youplot 0.3.4 → 0.4.2

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