cr.rb 4.1.4 → 4.1.5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cr.rb
 version: !ruby/object:Gem::Version
-  version: 4.1.4
+  version: 4.1.5
 platform: ruby
 authors:
 - Aoran Zeng
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tomlrb
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !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 `cr` is used to record and explain cryptic commands, acronyms(initialism), abbreviations and so forth in daily life.
   Not only can it be used in computer filed via our default sheet cryptic_computer, but also you can use this to manage your own knowledge base easily.
@@ -47,8 +61,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/cr
+- exe/cr
 - lib/cr.rb
+- lib/cr/counter.rb
 - lib/cr/version.rb
 homepage: https://github.com/cryptic-resolver/cr.rb
 licenses:
@@ -64,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/bin/cr

@@ -1,597 +0,0 @@
-#!/usr/bin/env ruby
-# ------------------------------------------------------
-# File          : cr.rb
-# Authors       : ccmywish <ccmywish@qq.com>
-# Created on    : <2021-07-08>
-# Last modified : <2023-03-22>
-#
-# cr:
-#
-#   This file is used to explain a CRyptic command
-# or an acronym's real meaning in computer world or
-# other fields.
-# ------------------------------------------------------
-
-require 'cr'
-
-class CrypticResolver::CliHandler
-
-  def initialize(args)
-    option = args.shift
-
-    case option when nil, '-h','--help' then help or exit end
-
-    reslvr = CrypticResolver::Resolver.new
-
-    reslvr.add_default_dicts_if_none_exists
-
-    case option
-    when '-l'   then reslvr.list_dicts
-    when '-c'   then reslvr.word_count
-    when '-u'   then reslvr.update_dicts
-    when '-s'   then reslvr.search_word args.shift
-    when '-a'   then reslvr.add_dict args.shift
-    when '-d'   then reslvr.del_dict args.shift
-    else reslvr.resolve_word option end
-  end
-
-
-  def help
-    puts <<~HELP
-    cr: Cryptic Resolver v#{CrypticResolver::GEM_VERSION}
-
-    Usage:
-      cr <keyword>   Search the keyword
-      cr emacs       => Edit macros: A feature-rich editor
-
-    Options:
-      -c             Print word count
-      -s <pattern>   Search words matched with pattern
-      -h             Print this help
-
-    Dictionaries:
-      -l                      List local dicts and official dicts
-      -u                      Update all dicts in Default library
-      -a <https://repo[.git]> Add a new dict
-      -a <user/repo>          Add a new dict from Github
-      -a <dict_name>          Add an official dict, use -l to see
-      -d <dict_name>          Delete a dict
-
-    HELP
-  end
-
-end
-
-
-class CrypticResolver::Resolver
-
-  # Notice that we only update the Default library, not Extra library
-  def update_dicts
-
-    @counter.count_def_lib(display: false)
-    old_wc = @counter.word_count_of_def_lib
-
-    puts "cr: Updating all dicts in Default library..."
-
-    begin
-    Dir.chdir DEFAULT_LIB_PATH do
-      if Gem.win_platform?
-        # Windows doesn't have fork
-        Dir.children(DEFAULT_LIB_PATH).each do |dict|
-          next if File.file? dict
-          puts "cr: Wait to update #{dict}..."
-          `git -C ./#{dict} pull -q`
-        end
-      else
-        # *nix
-        Dir.children(DEFAULT_LIB_PATH).each do |dict|
-          next if File.file? dict
-          fork do
-            puts "cr: Wait to update #{dict}..."
-          `git -C ./#{dict} pull -q`
-          end
-        end
-        Process.waitall
-      end # end if/else
-    end
-
-    rescue Interrupt
-    abort "cr: Cancel update"
-    end
-
-    puts "cr: Update done"
-
-    # clear
-    @counter.word_count_of_def_lib = 0
-    # recount
-    @counter.count_def_lib(display: false)
-
-    new_wc = @counter.word_count_of_def_lib
-    puts ; puts "#{new_wc - old_wc} words added in Default library"
-  end
-
-
-  def add_dict(repo)
-    if repo.nil?
-      abort bold(red("cr: Need an argument!"))
-    end
-
-    # Simplify adding dictionary
-    if !repo.start_with?("https://") and !repo.start_with?("git@")
-      if repo.include?('/')
-        repo = "https://github.com/#{repo}.git"
-      else
-        repo = "https://github.com/cryptic-resolver/cryptic_#{repo}.git"
-      end
-    end
-
-    begin
-    puts "cr: Adding new dictionary..."
-    `git -C #{DEFAULT_LIB_PATH} clone #{repo} -q`
-    rescue Interrupt
-    abort "cr: Cancel add dict"
-    end
-
-    puts "cr: Add new dictionary done"
-
-    # github/com/ccmywish/ruby_knowledge(.git)
-    dict = repo.split('/')[-1].delete_suffix('.git')
-    wc = @counter.count_dict_words(DEFAULT_LIB_PATH ,dict)
-    puts ; puts "#{wc} words added"
-  end
-
-
-  def del_dict(repo)
-    if repo.nil?
-      abort bold(red("cr: Need an argument!"))
-    end
-    Dir.chdir DEFAULT_LIB_PATH do
-      begin
-      # Dir.rmdir repo        # Can't rm a filled dir
-      # FileUtils.rmdir repo  # Can't rm a filled dir
-      FileUtils.rm_rf repo
-      puts "cr: Delete dictionary #{bold(green(repo))} done"
-      rescue Exception => e
-      puts bold(red("cr: #{e}"))
-      list_dicts
-      end
-    end
-  end
-
-
-  def load_sheet(library, dict, sheet_name)
-    file = library + "/#{dict}/#{sheet_name}.toml"
-    if File.exist? file
-      return Tomlrb.load_file file # gem 'tomlrb'
-      # return TOML.load_file file # gem 'toml'
-    else nil end
-  end
-
-
-=begin
-Pretty print the info of the given word
-
-A info looks like this
-  emacs = {
-    name = "Emacs"
-    desc = "edit macros"
-    more = "a feature-rich editor"
-    see  = ["Vim"]
-  }
-
-@param info [Hash] the information of the given word (mapped to a keyword in TOML)
-=end
-  def pp_info(info)
-    name = info['name'] || red("No name!")  # keyword `or` is invalid here in Ruby
-
-    desc = info['desc']
-    more = info['more']
-
-    if desc
-      puts "\n  #{name}: #{desc}"
-      print "\n  ",more,"\n" if more
-    else
-      puts "\n  #{name}"
-      print "\n  ",more,"\n" if more
-    end
-
-    if see_also = info['see']
-      print "\n", purple("SEE ALSO ")
-      if see_also.is_a?(Array)
-        last_ndx = see_also.size - 1
-        see_also.each_with_index do |x,i|
-          if last_ndx == i
-            print underline(x)  # Last word doesn't show space
-          else
-            print underline(x),' '
-          end
-        end
-      else
-        print underline(see_also)
-      end
-      puts
-    end
-    puts
-  end
-
-
-  # Print default cryptic_ dicts
-  def pp_dict(dict)
-    puts green("From: #{dict}")
-  end
-
-
-=begin
-  Used for synonym jump
-  Because we absolutely jump to a must-have word
-  So we can directly lookup to it
-
-  Notice that, we must jump to a specific word definition
-  So in the toml file, you must specify the precise word.
-  If it has multiple meanings, for example
-
-  [blah]
-  same = "xdg"  # this is wrong, because xdg has multiple
-                # definitions, and all of them specify a
-                # category
-
-  [blah]
-  same = "XDG downloader =>xdg.Download" # this is correct
-
-  [blah]
-  name = "BlaH" # You may want to display a better name first
-  same = "XDG downloader =>xdg.Download" # this is correct
-=end
-  def pp_same_info(library, dict, word, cache_content, same_key, own_name)
-
-    # If it's a synonym for anther word,
-    # we should lookup into this dict again, but maybe with a different file
-
-    # file name
-    x = word.chr.downcase
-
-=begin
-    dictionary maintainer must obey the rule for xxx.yyy word:
-    xxx should be lower case
-    yyy can be any case
-
-    Because yyy should clearly explain the category info, IBM is better than ibm
-    Implementation should not be too simple if we want to stress the function we
-    expect.
-
-    'jump to' will output to user, so this is important not only inside our sheet.
-
-      same = "XDM downloader=>xdm.Download"
-
-    We split 'same' key into two parts via spaceship symbol `=>`, first part will
-    output to user, the second part is for internal jump.
-=end
-    jump_to, same = same_key.split("=>")
-    same =  jump_to if same.nil?
-
-    unless own_name
-      own_name = word
-    end
-    puts blue(bold(own_name)) + ' redirects to ' + blue(bold(jump_to))
-
-=begin
-    As '.' is used to delimit a word and a category, what if
-    we jump to a dotted word?
-
-      [eg]
-      same = "e.g." # this must lead to a wrong resolution to
-                    # word 'e', category 'g'
-
-      All you need is to be like this:
-
-      [eg]
-      same = "'e.g.'" # cr will notice the single quote
-=end
-    if same =~ /^'(.*)'$/
-      same, category = $1, nil
-    else
-      same, category = same.split('.')
-    end
-
-    if same.chr == x
-      # No need to load another dictionary if match
-      sheet_content = cache_content
-    else
-      sheet_content = load_sheet(library, dict, same.chr.downcase)
-    end
-
-    if category.nil?
-      info = sheet_content[same]
-    else
-      info = sheet_content[same][category]
-    end
-
-    if info.nil?
-      puts red("WARN: Synonym jumps to the wrong place `#{same}`,
-      Please consider fixing this in `#{x}.toml` of the dictionary `#{dict}`")
-      # exit
-      return false
-    # double or more jumps
-    elsif same_key = info['same']
-      own_name = info['name']
-      return pp_same_info(library, dict, same, cache_content, same_key, own_name)
-    else
-      pp_info(info)
-      return true
-    end
-  end
-
-
-
-  #
-  # Lookup the given word in a sheet (a toml file) and also print.
-  # The core idea is that:
-  #
-  # 1. if the word is `same` with another synonym, it will directly jump to
-  #   a word in this dictionary, but maybe a different sheet.
-  #
-  # 2. load the toml file and check the given word
-  #   2.1 with no category specifier
-  #       [abcd]
-  #   2.2 with category specifier
-  #       [abcd.tYPe]
-  #
-  def lookup(library, dict, file, word)
-    sheet_content = load_sheet(library, dict, file)
-    return false if sheet_content.nil?
-
-    info = sheet_content[word]
-    return false if info.nil?
-
-    # Warn if the info is empty. For example:
-    #   emacs = { }
-    if info.size == 0
-      abort red("WARN: Lack of everything of the given word
-      Please consider fixing this in the dict `#{dict}`")
-    end
-
-    # Word with no category specifier
-    # We call this meaning as type 1
-    type_1_exist_flag = false
-
-    # if already jump, don't check the word itself
-    is_jump = false
-
-    # synonym info print
-    if same_key = info['same']
-      own_name = info['name']
-      pp_dict(dict)
-      pp_same_info(library, dict, word, sheet_content, same_key, own_name)
-      # It's also a type 1
-      type_1_exist_flag = true
-      is_jump = true
-    end
-
-    # normal info print
-    # To developer:
-    #   The word should at least has one of `desc` and `more`
-    #   But when none exists, this may not be considered wrong,
-    #   Because the type2 make the case too.
-    #
-    #   So, just ignore it, even if it's really a mistake(insignificant)
-    #   by dictionary maintainers.
-    #
-    if !is_jump && (info.has_key?('desc') || info.has_key?('more'))
-      pp_dict(dict)
-      pp_info(info)
-      type_1_exist_flag = true
-    end
-
-    # Meanings with category specifier
-    # We call this meaning as type 2
-    categories = info.keys - ["name", "desc", "more", "same", "see"]
-
-    if !categories.empty?
-
-      if type_1_exist_flag
-        print  blue(bold("OR")),"\n"
-      else
-        pp_dict(dict)
-      end
-
-      categories.each do |meaning|
-        info0 = sheet_content[word][meaning]
-        if same_key = info0['same']
-          own_name = info0['name']
-          pp_same_info(library, dict, word, sheet_content, same_key, own_name)
-        else
-          pp_info(info0)
-        end
-
-        # last meaning doesn't show this separate line
-        print  blue(bold("OR")),"\n" unless categories.last == meaning
-      end
-      return true
-    elsif type_1_exist_flag then return true
-    else return false end
-  end
-
-
-  #
-  # The main procedure of `cr`
-  #
-  #   1. Search the default library first
-  #   2. Search the extra library if it does exist
-  #
-  # The `search` is done via the `lookup` function. It will print
-  # the info while finding. If `lookup` always return false then
-  # means lacking of this word in our dicts. So a welcomed
-  # contribution is printed on the screen.
-  #
-  def resolve_word(word)
-
-    word = word.downcase # downcase! would lead to frozen error in Ruby 2.7.2
-    # The index is the toml file we'll look into
-    index = word.chr
-    case index
-    when '0'..'9'
-      index = '0-9'
-    end
-
-    # cache lookup's results
-    results = []
-
-    # First consider the default library
-    default = Dir.children(DEFAULT_LIB_PATH)
-    default.each do |dict|
-      results << lookup(DEFAULT_LIB_PATH,dict,index,word)
-    end
-
-    # Then is the extra library
-    if @extra_lib_path
-      extra = Dir.children(@extra_lib_path)
-      extra.each do |dict|
-        results << lookup(@extra_lib_path,dict,index,word)
-      end
-    end
-
-    unless results.include? true
-      puts <<~NotFound
-      cr: Not found anything.
-
-      You could
-
-      #{blue("case 1: Update all dicts")}
-
-        #{yellow("$cr -u")}
-
-      #{blue("case 2: List available official and feature dicts")}
-
-        #{yellow("$cr -l")}
-
-        #{yellow("$cr -a repo")} (Add a specific dict to default lib)
-
-      #{blue("case 3: Contribute to theses dicts")}
-
-        Visit: https://github.com/cryptic-resolver
-
-      NotFound
-    else return end
-  end
-
-
-  #
-  # Delegate to `search_word_internal`
-  #
-  def search_word(pattern)
-    found_or_not1 = false
-    found_or_not2 = false
-
-    found_or_not1 = search_word_internal(pattern, DEFAULT_LIB_PATH)
-    if @extra_lib_path
-      found_or_not2 = search_word_internal(pattern, @extra_lib_path)
-    end
-
-    if (found_or_not1 == false) && (found_or_not2 == false)
-      puts red("cr: No words match with #{pattern.inspect}") ; puts
-    end
-  end
-
-  #
-  # This `search_word_internal` routine is quite like `resolve_word`
-  # Notice:
-  #   We handle two cases
-  #
-  #   1. the 'pattern' is the regexp itself
-  #   2. the 'pattern' is like '/blah/'
-  #
-  #  The second is what Ruby and Perl users like to do, handle it!
-  #
-  def search_word_internal(pattern, library)
-
-    if pattern.nil?
-      abort bold(red("cr: Need an argument!"))
-    end
-
-    if pattern =~ /^\/(.*)\/$/
-      regexp = %r[#$1]
-    else
-      regexp = %r[#{pattern}]
-    end
-
-    found_or_not = false
-
-    # Try to match every word in all dicts
-    Dir.children(library).each do |dict|
-
-      path = File.join(library, dict)
-      next if File.file? path
-      sheets = Dir.children(path).select do
-        _1.end_with?('.toml')
-      end
-
-      similar_words_in_a_dict = []
-
-      sheets.each do |sheet|
-        sheet_content = load_sheet(library, dict, File.basename(sheet,'.toml'))
-
-        sheet_content.keys.each do
-          if _1 =~ regexp
-            found_or_not = true
-            similar_words_in_a_dict << _1
-          end
-        end
-      # end of each sheet in a dict
-      end
-
-      unless similar_words_in_a_dict.empty?
-        pp_dict(dict)
-        require 'ls_table'
-        LsTable.ls(similar_words_in_a_dict) do |e|
-          puts blue(e)
-        end
-        puts
-      end
-    end
-    return found_or_not
-  end
-
-
-  # 1. List Default library's dicts
-  # 2. List Extra   library's dicts
-  # 3. List official dicts
-  def list_dicts
-
-    def _do_the_same_thing
-      count = 0
-      Dir.children(".").each do |dict|
-        next if File.file? dict
-        count += 1
-        prefix = (count.to_s + '.').ljust 4
-        puts "  #{prefix}#{dict}"
-      end
-    end
-
-    Dir.chdir DEFAULT_LIB_PATH do
-      puts bold(green("Default library: #{DEFAULT_LIB_PATH}"))
-      _do_the_same_thing
-    end
-
-    if @extra_lib_path
-      puts
-      Dir.chdir @extra_lib_path do
-        puts bold(green("Extra library: #{@extra_lib_path}"))
-        _do_the_same_thing
-      end
-    end
-
-    puts ; puts bold(green("Official dictionaries: (Add it by 'cr -a xxx')"))
-    puts RECOMMENDED_DICTS
-  end
-
-
-  def word_count
-    @counter.count!(display: true)
-  end
-
-end
-
-####################
-# main: CLI Handling
-####################
-cli = CrypticResolver::CliHandler.new ARGV