whatoption 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0dceb90256c82b20eb0838c98b9aa75ed1747662d93b96232e20164e1279d3ff
+  data.tar.gz: 8a4c446c1961099ce494e2c669154d3bbc8d8c80294e4bc179ae6ae619f7d1fb
+SHA512:
+  metadata.gz: 5baf5062312181ecb72ffff8ac6aefda961c2f499648d4d94657495ad5febc5cdc427102172b2e29497ff2ee381b30638a18970c5bde608622e0fe0aedb553aa
+  data.tar.gz: 170829ba3140198e7e7bf711b5275450375258b56dca1c0577b87febd13a1ce811a730c16237094055f8c4f615c2fc32fd4047579bfaf6fc01386e8e32087ec3

data/bin/whatoption

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+# ---------------------------------------------------------------
+# File          : whatoption.rb
+# Authors       : ccmywish <ccmywish@qq.com>
+# Created on    : <2023-02-06>
+# Last modified : <2023-02-07>
+# Contributors  :
+#
+# whatoption:
+#
+#   Tells you what the option of the command means.
+#
+# ----------
+# Changelog:
+#
+# ~> v0.1.0
+# <2023-02-06> Create file
+# ---------------------------------------------------------------
+
+require 'whatoption'
+
+####################
+#      main
+####################
+
+class WhatOption::CliHandler
+
+  def initialize(argv)
+    if argv.empty?
+      help || return
+    end
+
+    case argv[0]
+    when '-h'
+      help || return
+    when '-v'
+      puts("WhatOption v#{WhatOption::VERSION}") || return
+    when '-u'
+      # This output will be hided into the return string
+      # `git -C #{WhatOption::OPTIONS_DATA_DIR} pull`
+
+      # So we use system()
+      puts cmd = "git -C #{WhatOption::OPTIONS_DATA_DIR} pull"
+      system cmd
+      return
+    end
+
+    if argv.size == 1
+      puts("Please input the option for command '#{argv[0]}'".red) || return
+    end
+
+    @option = ARGV[-1]    # Shouldn't detect where is begin with '-' or '--'
+                          # because some options are just single characters,
+                          # for example, 'tar x', this is to use subcommand as option
+                          # That's reasonable also.
+    @commands = ARGV[0...-1]
+
+    # p option
+    # p commands
+  end
+
+  # routine
+  def help
+    puts <<~HELP
+      Usage:
+
+        whatoption command subcommands option
+
+      Options:
+
+        -u          Update ~/.whatoption data
+        -h          Print this help
+        -v          Print version
+
+      Examples:
+
+        whatoption ruby -c
+        whatoption tar  x
+        whatoption git ls-files -z
+
+    HELP
+  end
+
+  # method
+  def work
+    # Because the initializer above will not always finish initializing
+    if (not @commands) || (not @option)
+      exit
+    end
+    option_info = WhatOption::OptionInfo.new @commands, @option
+    option_info.show
+  end
+
+end
+
+cli = WhatOption::CliHandler.new ARGV
+cli.work

data/lib/whatoption.rb

@@ -0,0 +1,121 @@
+# ---------------------------------------------------------------
+# File          : whatoption.rb
+# Authors       : ccmywish <ccmywish@qq.com>
+# Created on    : <2023-02-06>
+# Last modified : <2023-02-07>
+#
+# whatoption:
+#
+#   Lib file
+#
+# ----------
+# Changelog:
+#
+# ~> v0.1.0
+# <2023-02-06> Create file
+# ---------------------------------------------------------------
+
+module WhatOption
+
+  VERSION = "0.1.0"
+
+  require 'pathname'
+  OPTIONS_DATA_DIR = Pathname.new File.expand_path("~/.whatoption")
+
+  if not Dir.exist? OPTIONS_DATA_DIR
+    `git clone https://github.com/ccmywish/whatoption.toml #{OPTIONS_DATA_DIR}`
+  end
+
+
+  class OptionInfo
+
+    require 'colorator'
+
+=begin
+
+    attribute:
+
+      @commands         # all commands(including sub)
+      @calling_command  # the calling command itself
+      @sub_commands     # possible sub commands
+      @option           # the option we query
+
+      @file             # the target TOML file we will load in
+
+      @rec_option       # record field in toml file
+      @rec_desc         # record field in toml file
+
+=end
+
+
+    # method
+    def initialize(commands, option)
+      # Must clone, because we will delete in place later
+      @commands = commands.clone
+      @calling_command = commands[0]
+
+      commands.delete_at(0)
+      @sub_commands    = commands
+
+      @option = option
+    end
+
+
+    # routine
+    def load_sheet
+      # It's very interesting here, you have to put parentheses then 'commands.join()' is
+      # treated as a string.
+      # Without parentheses, the + is affected by OPTIONS_DATA_DIR,
+      # So first '+'s both side are Pathname
+      # And '+' is to add a '/' to component
+      @file = OPTIONS_DATA_DIR + (@commands.join('/') + ".toml")
+      if File.exist? @file
+        require 'tomlrb'
+        return Tomlrb.load_file @file
+      else
+        puts "File #@file not exist!"
+        nil
+      end
+    end
+
+
+    # routine
+    def resolve
+      sheet = load_sheet
+      if not sheet
+        exit 1
+      end
+
+      record = sheet[@option] ||
+        puts("Error: Option [#@option] is not recorded in #@file".red) ||
+        exit(1)
+      @rec_option = record['option'] ||
+        puts("Error: No field 'option' in #@file [#@calling_command]".red) ||
+        exit(1)
+      @rec_desc   = record['desc']   ||
+        puts("Error: No field 'desc' in #@file [#@calling_command]".red) ||
+        exit(1)
+    end
+
+
+    # method
+    def show
+      resolve
+
+      result_cmd = @calling_command.yellow
+      if not @sub_commands.empty?
+        result_cmd += ' ' + @sub_commands.join(' ').blue
+      end
+      result_cmd += ' ' + @rec_option.magenta
+      puts result_cmd
+
+      # newline description
+      print "\n  "
+      puts @rec_desc.green
+      puts
+    end
+
+  end
+
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: whatoption
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ccmywish
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tomlrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: colorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 'This command line tool `whatoption` is used to record and explain commands''
+  options, so there is no need to run the command itself to check what the help info
+  is. Besides, many options only have one character, which is sometimes not easily
+  understood by users to remember.
+
+  '
+email: ccmywish@qq.com
+executables:
+- whatoption
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/whatoption
+- lib/whatoption.rb
+homepage: https://github.com/ccmywish/whatoption
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ccmywish/whatoption/issues
+  source_code_uri: https://github.com/ccmywish/whatoption
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: 'whatoption: What does the option mean?'
+test_files: []