v0.4.5

- Add `help` to the subcommand.
- Use same method to display help in stdout or stderr.

.github/workflows/ci.yml

@@ -7,9 +7,9 @@ jobs:
     strategy:
       matrix:
         os:   [ 'ubuntu', 'macos' ]
-        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.1' ]
+        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2' ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

.github/workflows/doc.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1
+          ruby-version: ruby
       - name: Generate document
         run: gem install -N yard && yard doc
       - name: Publish Documentation on GitHub Pages

README.md

@@ -211,6 +211,14 @@ The following sub-commands are available.
 
 * Not yet supported.
 
+### YouPlot Configuration (youplotrc)
+
+You can specify default options in a configuration file in YAML format. For more information, enter the following command.
+
+```
+uplot --config
+```
+
 ## Tools that are useful to use with YouPlot
 
 * [csvtk](https://github.com/shenwei356/csvtk)

lib/youplot/command.rb

@@ -40,24 +40,6 @@ module YouPlot
         return
       end
 
-      # config command
-      if @command == :config
-        if ENV['MYYOUPLOTRC']
-          puts "config file : #{ENV['MYYOUPLOTRC']}"
-          puts parser.config.inspect
-        else
-          puts <<~EOS
-            You don't have a config file. The default config file paths are:
-            ./.youplot.yml, ./.youplotrc, ~/.youplot.yml, ~/.youplotrc
-            You can specify a config file with the environment variable MYYOUPLOTRC.
-            File format is YAML. For example:
-            width : 40
-            height : 20
-          EOS
-        end
-        return
-      end
-
       # progressive mode
       if options[:progressive]
         stop = false
@@ -178,9 +160,9 @@ module YouPlot
         @backend.barplot(data, params, count: true, reverse: options[:reverse])
       when :hist, :histogram
         @backend.histogram(data, params)
-      when :line, :lineplot
+      when :line, :lineplot, :l
         @backend.line(data, params, options[:fmt])
-      when :lines, :lineplots
+      when :lines, :lineplots, :ls
         @backend.lines(data, params, options[:fmt])
       when :scatter, :s
         @backend.scatter(data, params, options[:fmt])

lib/youplot/parser.rb

@@ -29,53 +29,59 @@ module YouPlot
       )
 
       @params = Parameters.new
-
-      if @config_file = find_config_file
-        ENV['MYYOUPLOTRC'] = @config_file
-        @config = read_config_file(config_file)
-        configure(config)
-      end
     end
 
-    def candidate_paths
+    def apply_config_file
+      return if !config_file && find_config_file.nil?
+
+      read_config_file
+      configure
+    end
+
+    def config_file_candidate_paths
+      # keep the order of the paths
       paths = []
       paths << ENV['MYYOUPLOTRC'] if ENV['MYYOUPLOTRC']
       paths << '.youplot.yml'
       paths << '.youplotrc'
-      paths << File.join(ENV['HOME'], '.youplotrc') if ENV['HOME']
-      paths << File.join(ENV['HOME'], '.youplot.yml') if ENV['HOME']
+      if ENV['HOME']
+        paths << File.join(ENV['HOME'], '.youplotrc')
+        paths << File.join(ENV['HOME'], '.youplot.yml')
+        paths << File.join(ENV['HOME'], '.config', 'youplot', 'youplotrc')
+        paths << File.join(ENV['HOME'], '.config', 'youplot', 'youplot.yml')
+      end
       paths
     end
 
     def find_config_file
-      config_file_path = nil
-      candidate_paths.each do |file|
+      config_file_candidate_paths.each do |file|
         path = File.expand_path(file)
-        if File.exist?(path)
-          config_file_path = path
-          break
-        end
+        next unless File.exist?(path)
+
+        @config_file = path
+        ENV['MYYOUPLOTRC'] = path
+        return @config_file
       end
-      config_file_path
+      nil
     end
 
-    def read_config_file(path)
+    def read_config_file
       require 'yaml'
-      YAML.load_file(path)
+      @config = YAML.load_file(config_file)
     end
 
-    def configure(config)
+    def configure
       option_members = @options.members
       param_members = @params.members
       # It would be more useful to be able to configure by plot type
       config.each do |k, v|
         k = k.to_sym
         if option_members.include?(k)
-          @options[k] = v
+          @options[k] ||= v
         elsif param_members.include?(k)
-          @params[k] = v
+          @params[k] ||= v
         else
-          raise Error, "Unknown option/param: #{k}"
+          raise Error, "Unknown option/param in config file: #{k}"
         end
       end
     end
@@ -154,6 +160,9 @@ module YouPlot
           puts parser.help
           exit if YouPlot.run_as_executable?
         end
+        parser.on('--config FILE', 'specify a config file') do |v|
+          @config_file = v
+        end
         parser.on('--debug', TrueClass, 'print preprocessed data') do |v|
           options[:debug] = v
         end
@@ -185,6 +194,7 @@ module YouPlot
               colors     color         show the list of available colors
 
           General options:
+              --config                 print config file info
               --help                   print command specific help menu
               --version                print the version of YouPlot
         MSG
@@ -192,10 +202,36 @@ module YouPlot
       # 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?
+        show_main_help
       end
+
+      main_parser.on('--config', 'show config file info') do
+        show_config_info
+      end
+    end
+
+    def show_main_help(out = $stdout)
+      out.puts main_parser.banner
+      out.puts
+      exit if YouPlot.run_as_executable?
+    end
+
+    def show_config_info
+      if ENV['MYYOUPLOTRC']
+        puts "config file : #{ENV['MYYOUPLOTRC']}"
+        puts config.inspect
+      else
+        puts <<~EOS
+          Configuration file not found.
+          It should be a YAML file, like this example:
+            width : 40
+            height : 20
+          By default, YouPlot will look for the configuration file in these locations:
+          #{config_file_candidate_paths.map { |s| '  ' + s }.join("\n")}
+          If you have the file elsewhere, you can specify its location with the `MYYOUPLOTRC` environment variable.
+        EOS
+      end
+      exit if YouPlot.run_as_executable?
     end
 
     def sub_parser_add_symbol
@@ -265,10 +301,13 @@ module YouPlot
       case command
 
       # If you type only `uplot` in the terminal.
+      # Output help to standard error output.
       when nil
-        warn main_parser.banner
-        warn "\n"
-        exit 1 if YouPlot.run_as_executable?
+        show_main_help($stderr)
+
+      # Output help to standard output.
+      when :help
+        show_main_help
 
       when :barplot, :bar
         sub_parser_add_symbol
@@ -291,14 +330,14 @@ module YouPlot
           params.nbins = v
         end
 
-      when :lineplot, :line
+      when :lineplot, :line, :l
         sub_parser_add_canvas
         sub_parser_add_grid
         sub_parser_add_fmt_yx
         sub_parser_add_ylim
         sub_parser_add_xlim
 
-      when :lineplots, :lines
+      when :lineplots, :lines, :ls
         sub_parser_add_canvas
         sub_parser_add_grid
         sub_parser_add_fmt_xyxy
@@ -327,16 +366,19 @@ module YouPlot
           options[:color_names] = v
         end
 
+      # Currently it simply displays the configuration file,
+      # but in the future this may be changed to open a text editor like Vim
+      # to edit the configuration file.
       when :config
+        show_config_info
 
       else
-        error_message = "uplot: unrecognized command '#{command}'"
-        if YouPlot.run_as_executable?
-          warn error_message
-          exit 1
-        else
-          raise Error, error_message
-        end
+        error_message = "YouPlot: unrecognized command '#{command}'"
+        raise Error, error_message unless YouPlot.run_as_executable?
+
+        warn error_message
+        exit 1
+
       end
     end
 
@@ -344,7 +386,7 @@ module YouPlot
       begin
         create_main_parser.order!(argv)
       rescue OptionParser::ParseError => e
-        warn "uplot: #{e.message}"
+        warn "YouPlot: #{e.message}"
         exit 1 if YouPlot.run_as_executable?
       end
 
@@ -353,7 +395,14 @@ module YouPlot
       begin
         create_sub_parser&.parse!(argv)
       rescue OptionParser::ParseError => e
-        warn "uplot: #{e.message}"
+        warn "YouPlot: #{e.message}"
+        exit 1 if YouPlot.run_as_executable?
+      end
+
+      begin
+        apply_config_file
+      rescue StandardError => e
+        warn "YouPlot: #{e.message}"
         exit 1 if YouPlot.run_as_executable?
       end
     end

lib/youplot/version.rb

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

test/youplot/iris_test.rb

@@ -69,6 +69,12 @@ class YouPlotIRISTest < Test::Unit::TestCase
     assert_equal fixture('iris-lineplot.txt'), @stderr_file.read
   end
 
+  # l is an undocumented alias of lineplot.
+  test :l do
+    YouPlot::Command.new(['l', '-H', '-d,', '-t', 'IRIS-LINEPLOT']).run
+    assert_equal fixture('iris-lineplot.txt'), @stderr_file.read
+  end
+
   test :lineplots do
     YouPlot::Command.new(['lineplots', '-H', '-d,', '-t', 'IRIS-LINEPLOTS']).run
     assert_equal fixture('iris-lineplots.txt'), @stderr_file.read
@@ -79,6 +85,12 @@ class YouPlotIRISTest < Test::Unit::TestCase
     assert_equal fixture('iris-lineplots.txt'), @stderr_file.read
   end
 
+  # ls is an undocumented alias of lineplots.
+  test :ls do
+    YouPlot::Command.new(['lines', '-H', '-d,', '-t', 'IRIS-LINEPLOTS']).run
+    assert_equal fixture('iris-lineplots.txt'), @stderr_file.read
+  end
+
   test :scatter do
     YouPlot::Command.new(['scatter', '-H', '-d,', '-t', 'IRIS-SCATTER']).run
     assert_equal fixture('iris-scatter.txt'), @stderr_file.read