cr.rb 3.20.0 → 4.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e196f22fb8a93e8738b629b8da44a1710628bffb4770fa436f29a9c7ebed6c15
-  data.tar.gz: bcd54cc0b24e92a81c82603bff87af6aecb0716998401d45e212ba970777b433
+  metadata.gz: cf84244ffcf5db536a394a4c7c6ad9679485be53d56baf821bca8a228dd4241b
+  data.tar.gz: 13393a7e9fd9e86d021ef39e830de56ffa548c8159cf172af61c6631e1d2ee93
 SHA512:
-  metadata.gz: 833d426d0016dd24a5950eeeda9f84af407f24760fcabd4457d3a475abadd1abdf3d543742a180a319ba1ec2a986173e7b6cdb0c6d8761b6a4357be0c23599a6
-  data.tar.gz: d79bbb9de1a8744925eea222c4bc5326f074eb1d246e1566657970faead102b6d8ef6cd1e65b024d43fbd9ffcc26463a5d97432633fc2436eda7c2d29ddecbe6
+  metadata.gz: f0e9316fb7d0e073600e815292c6ef3279cec61275a94ded64ddde456784027eb15d62c239ce953f1036212a8429546240af33bba371667d3f4958a71c823afb
+  data.tar.gz: fa316a2e6003409ba527d7ebb86ba474ebc97a3982e79826ed117a4c52b0bb6b3cfaf9b254c135db44484e9faaaee43d7fe6c956dd536dc234a934b38cf3ddc2

data/bin/cr

@@ -4,7 +4,7 @@
 # File          : cr.rb
 # Authors       : ccmywish <ccmywish@qq.com>
 # Created on    : <2021-07-08>
-# Last modified : <2022-10-20>
+# Last modified : <2022-11-27>
 #
 # cr:
 #
@@ -18,13 +18,53 @@ require 'cr'
 require 'tomlrb'
 require 'fileutils'
 
-CRYPTIC_RESOLVER_HOME = File.expand_path("~/.cryptic-resolver")
-CRYPTIC_DEFAULT_DICTS = {
-  common:      "https://github.com/cryptic-resolver/cryptic_common.git",
-  computer:    "https://github.com/cryptic-resolver/cryptic_computer.git",
-  windows:     "https://github.com/cryptic-resolver/cryptic_windows.git",
-  electronics: "https://github.com/cryptic-resolver/cryptic_electronics.git"
-}
+CR_DEFAULT_LIBRARY = File.expand_path("~/.cryptic-resolver")
+
+$CR_DEFAULT_DICTS = [
+  "https://github.com/cryptic-resolver/cryptic_common.git",
+  "https://github.com/cryptic-resolver/cryptic_computer.git",
+  "https://github.com/cryptic-resolver/cryptic_windows.git",
+  "https://github.com/cryptic-resolver/cryptic_linux.git",
+  "https://github.com/cryptic-resolver/cryptic_electronics"
+]
+
+# The config file will override the default dicts, but not default library!
+if ENV['CRYPTIC_RESOLVER_CONFIG'] 
+  file = ENV['CRYPTIC_RESOLVER_CONFIG']
+  if test('f', file)
+    config = Tomlrb.load_file file 
+    
+    CR_EXTRA_LIBRARY ||= config['EXTRA_LIBRARY']
+
+    if config['DEFAULT_DICTS']
+      CR_DEFAULT_DICTS = config['DEFAULT_DICTS']
+    else
+      CR_DEFAULT_DICTS = $CR_DEFAULT_DICTS
+    end
+
+  else
+    puts "FATAL: Your CRYPTIC_RESOLVER_CONFIG is NOT a file!"
+    exit 1
+  end
+
+else
+  # if user doesn't specify, we use the hard-coded defaults
+  CR_EXTRA_LIBRARY = nil
+  CR_DEFAULT_DICTS = $CR_DEFAULT_DICTS
+end
+
+
+# This is used to display what you are pulling when adding dicts
+CR_DEFAULT_DICTS_USER_AND_NAMES = CR_DEFAULT_DICTS.map do |e|
+  user, repo = e.split('/').last(2)
+  repo = repo.split('.').first
+  user + '/' + repo
+end
+
+# Same with the pulled repo dirs' names in CR_DEFAULT_LIBRARY
+CR_DEFAULT_DICTS_NAMES = CR_DEFAULT_DICTS.map do |e|
+  e.split('/').last.split('.').first
+end
 
 
 ####################
@@ -46,31 +86,31 @@ def cyan(str)       "\e[36m#{str}\e[0m" end
 ####################
 
 def is_there_any_dict?
-  unless Dir.exist? CRYPTIC_RESOLVER_HOME
-    Dir.mkdir CRYPTIC_RESOLVER_HOME
+  unless Dir.exist? CR_DEFAULT_LIBRARY
+    Dir.mkdir CR_DEFAULT_LIBRARY
   end
 
-  !Dir.empty? CRYPTIC_RESOLVER_HOME 
+  !Dir.empty? CR_DEFAULT_LIBRARY 
 end
 
 
 def add_default_dicts_if_none_exists
   unless is_there_any_dict?
-    puts "cr: Adding default dictionaries..."
+    puts "cr: Adding default dicts..."
 
     begin
     if RUBY_PLATFORM.include? "mingw"
       # Windows doesn't have fork
-      CRYPTIC_DEFAULT_DICTS.each do |key, dict|
-        puts "cr: Pulling cryptic_#{key}..."
-        `git -C #{CRYPTIC_RESOLVER_HOME} clone #{dict} -q`
+      CR_DEFAULT_DICTS_USER_AND_NAMES.each_with_index do |name, i|
+        puts "cr: Pulling #{name}..."
+        `git -C #{CR_DEFAULT_LIBRARY} clone #{CR_DEFAULT_DICTS[i]} -q`
       end
     else
-      # *nix
-      CRYPTIC_DEFAULT_DICTS.each do |key, dict|
+      # *nix-like
+      CR_DEFAULT_DICTS_USER_AND_NAMES.each_with_index do |name, i|
         fork do 
-          puts "cr: Pulling cryptic_#{key}..."
-          `git -C #{CRYPTIC_RESOLVER_HOME} clone #{dict} -q`
+          puts "cr: Pulling #{name}..."
+          `git -C #{CR_DEFAULT_LIBRARY} clone #{CR_DEFAULT_DICTS[i]} -q`
         end
       end
       Process.waitall      
@@ -84,7 +124,7 @@ def add_default_dicts_if_none_exists
     puts "cr: Add done"
     word_count(p: false)
     puts 
-    puts "#{$WordCount} words added"
+    puts "#{$TwoLibWordCount} words added"
     
     # Really added
     return true
@@ -94,26 +134,27 @@ def add_default_dicts_if_none_exists
 end
 
 
+# Notice that we only update the Default library, not Extra library
 def update_dicts()
   return if add_default_dicts_if_none_exists
 
   word_count(p: false)
-  old_wc = [$DefaultWordCount, $WordCount-$DefaultWordCount, $WordCount]
+  old_wc = $DefaultLibWordCount
 
-  puts "cr: Updating all dictionaries..."
+  puts "cr: Updating all dicts in Default library..."
 
   begin
-  Dir.chdir CRYPTIC_RESOLVER_HOME do 
+  Dir.chdir CR_DEFAULT_LIBRARY do 
     
     if RUBY_PLATFORM.include? "mingw"
       # Windows doesn't have fork
-      Dir.children(CRYPTIC_RESOLVER_HOME).each do |dict|
+      Dir.children(CR_DEFAULT_LIBRARY).each do |dict|
         puts "cr: Wait to update #{dict}..."
         `git -C ./#{dict} pull -q`
       end
     else
       # *nix
-      Dir.children(CRYPTIC_RESOLVER_HOME).each do |dict|
+      Dir.children(CR_DEFAULT_LIBRARY).each do |dict|
         fork do 
           puts "cr: Wait to update #{dict}..."
          `git -C ./#{dict} pull -q`
@@ -129,21 +170,17 @@ def update_dicts()
     exit 1
   end
 
-
   puts "cr: Update done"
 
   # clear
-  $DefaultWordCount, $WordCount = 0, 0
+  $DefaultLibWordCount = 0
   # recount
   word_count(p: false)
-  new_wc = [$DefaultWordCount, $WordCount-$DefaultWordCount, $WordCount]
-  diff = []
-  new_wc.each_with_index do 
-    diff[_2] = _1 - old_wc[_2]
-  end
+
+  new_wc = $DefaultLibWordCount
 
   puts
-  puts "#{diff.[]2} words added: default/#{diff.[]0} user/#{diff.[]1}"
+  puts "#{new_wc - old_wc} words added in Default library"
 
 end
 
@@ -155,16 +192,20 @@ def add_dict(repo)
   end
 
   # Ensure the cr home dir exists
-  FileUtils.mkdir_p(CRYPTIC_RESOLVER_HOME)
+  FileUtils.mkdir_p(CR_DEFAULT_LIBRARY)
 
   # Simplify adding dictionary
   if !repo.start_with?("https://") and !repo.start_with?("git@")
-    repo = "https://github.com/#{repo}.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 #{CRYPTIC_RESOLVER_HOME} clone #{repo} -q`
+    `git -C #{CR_DEFAULT_LIBRARY} clone #{repo} -q`
   rescue Interrupt
     puts "cr: Cancel add dict"
     exit 1
@@ -176,7 +217,7 @@ def add_dict(repo)
   dict = repo.split('/')[-1].delete_suffix('.git')
   count_dict_words(dict)
   puts
-  puts "#$WordCount words added"
+  puts "#$TwoLibWordCount words added"
 
 end
 
@@ -186,7 +227,7 @@ def del_dict(repo)
     puts bold(red("cr: Need an argument!"))
     exit -1
   end
-  Dir.chdir CRYPTIC_RESOLVER_HOME do 
+  Dir.chdir CR_DEFAULT_LIBRARY do 
     begin 
       # Dir.rmdir repo        # Can't rm a filled dir
       # FileUtils.rmdir repo  # Can't rm a filled dir
@@ -194,14 +235,14 @@ def del_dict(repo)
       puts "cr: Delete dictionary #{bold(green(repo))} done"
     rescue Exception => e
       puts bold(red("cr: #{e}"))
-      list_dictionaries
+      list_dicts
     end
   end
 end
 
 
-def load_sheet(dict, sheet_name)
-  file = CRYPTIC_RESOLVER_HOME + "/#{dict}/#{sheet_name}.toml" 
+def load_sheet(library, dict, sheet_name)
+  file = library + "/#{dict}/#{sheet_name}.toml" 
   
   if File.exist? file
     return Tomlrb.load_file file # gem 'tomlrb'
@@ -251,7 +292,7 @@ def pp_info(info)
   puts
 end
 
-# Print default cryptic_ dictionaries
+# Print default cryptic_ dicts
 def pp_dict(dict)
     puts green("From: #{dict}")
 end
@@ -279,7 +320,7 @@ end
 #   same = "XDG downloader <=>xdg.Download" # this is correct
 #
 #
-def pp_same_info(dict, word, cache_content, same_key, own_name)
+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
@@ -336,7 +377,7 @@ def pp_same_info(dict, word, cache_content, same_key, own_name)
     # No need to load another dictionary if match
     sheet_content = cache_content
   else
-    sheet_content = load_sheet(dict, same.chr.downcase)
+    sheet_content = load_sheet(library, dict, same.chr.downcase)
   end
 
   if category.nil?
@@ -353,7 +394,7 @@ def pp_same_info(dict, word, cache_content, same_key, own_name)
   # double or more jumps
   elsif same_key = info['same']
     own_name = info['name']
-    return pp_same_info(dict, same, cache_content, same_key, own_name)
+    return pp_same_info(library, dict, same, cache_content, same_key, own_name)
   else
     pp_info(info)
     return true
@@ -375,8 +416,8 @@ end
 #   2.2 with category specifier
 #       [abcd.tYPe]
 #
-def lookup(dict, file, word)
-  sheet_content = load_sheet(dict, file) 
+def lookup(library, dict, file, word)
+  sheet_content = load_sheet(library, dict, file) 
   return false if sheet_content.nil?
 
   info = sheet_content[word]
@@ -391,7 +432,6 @@ def lookup(dict, file, word)
   end
 
 
-
   # Word with no category specifier
   # We call this meaning as type 1
   type_1_exist_flag = false
@@ -403,7 +443,7 @@ def lookup(dict, file, word)
   if same_key = info['same']
     own_name = info['name']
     pp_dict(dict)
-    pp_same_info(dict, word, sheet_content, same_key, own_name)
+    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
@@ -440,7 +480,7 @@ def lookup(dict, file, word)
       info0 = sheet_content[word][meaning]
       if same_key = info0['same']
         own_name = info0['name']
-        pp_same_info(dict, word, sheet_content, same_key, own_name)
+        pp_same_info(library, dict, word, sheet_content, same_key, own_name)
       else
         pp_info(info0)
       end
@@ -459,15 +499,16 @@ end
 
 #
 # The main procedure of `cr`
-#   1. Search the default's first dict first
-#   2. Search the rest dictionaries in the cryptic dictionaries default dir
+#
+#   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 dictionaries. So a welcomed
+# means lacking of this word in our dicts. So a welcomed
 # contribution is printed on the screen.
 #
-def solve_word(word)
+def resolve_word(word)
   
   add_default_dicts_if_none_exists
 
@@ -478,21 +519,22 @@ def solve_word(word)
   when '0'..'9' 
     index = '0123456789'
   end
-  
-  # Default's first should be 1st to consider
-  first_dict = "cryptic_" + CRYPTIC_DEFAULT_DICTS.keys[0].to_s # When Ruby3, We can use DICTS.key(0)
 
-  # cache lookup results
+  # cache lookup's results
   results = []
-  results << lookup(first_dict,index,word)
-  # return if result == true # We should consider all dicts
-
-  # Then else
-  rest = Dir.children(CRYPTIC_RESOLVER_HOME)
-  rest.delete first_dict
-  rest.each do |dict|
-    results << lookup(dict,index,word)
-    # continue if result == false # We should consider all dicts
+  
+  # First consider the default library
+  default = Dir.children(CR_DEFAULT_LIBRARY)
+  default.each do |dict|
+    results << lookup(CR_DEFAULT_LIBRARY,dict,index,word)
+  end
+  
+  # Then is the extra library
+  if CR_EXTRA_LIBRARY
+    extra = Dir.children(CR_EXTRA_LIBRARY)
+    extra.each do |dict|
+      results << lookup(CR_EXTRA_LIBRARY,dict,index,word)
+    end
   end
 
   unless results.include? true
@@ -518,7 +560,7 @@ end
 
 
 #
-# The search word process is quite like `solve_word``
+# This `search_word` routine is quite like `resolve_word`
 # Notice:
 #   We handle two cases
 #   
@@ -545,10 +587,10 @@ def search_word(pattern)
   found = false
 
   #
-  # Try to match every word in all dictionaries
+  # Try to match every word in all dicts
   #
-  Dir.children(CRYPTIC_RESOLVER_HOME).each do |dict|
-    sheets = Dir.children(File.join(CRYPTIC_RESOLVER_HOME, dict)).select do
+  Dir.children(CR_DEFAULT_LIBRARY).each do |dict|
+    sheets = Dir.children(File.join(CR_DEFAULT_LIBRARY, dict)).select do
       _1.end_with?('.toml')
     end
 
@@ -584,19 +626,21 @@ end
 
 def help
   word_count(p: false)
-  user_words = $WordCount - $DefaultWordCount
   puts <<-HELP
-cr: Cryptic Resolver v#{CR_GEM_VERSION} (#{$WordCount} words: default/#{$DefaultWordCount} user/#{user_words})
+cr: Cryptic Resolver v#{CR_GEM_VERSION} (#{$TwoLibWordCount} words: Default lib/#{$DefaultLibWordCount} && Extra lib/#{$ExtraLibWordCount})
 
-usage:
+Usage:
 
-  cr emacs          => Edit macros: a feature-rich editor
+  cr emacs          => Edit macros: A feature-rich editor
   cr -c             => Print word count
-  cr -l             => List local dictionaries
-  cr -u             => Update all dictionaries
-  cr -a repo.git    => Add a new dictionary
-  cr -a user/repo   => Add a new dictionary on Github
-  cr -d cryptic_xx  => Delete a dictionary
+  cr -l             => List local dicts and official dicts
+  cr -u             => Update all dicts in default library
+  
+  cr -a repo.git    => Add a new dict
+  cr -a user/repo   => Add a new dict from Github
+  cr -a  reponame   => Add an official dict from Github
+
+  cr -d cryptic_xx  => Delete a dict
   cr -s pattern     => Search words matched with pattern
   cr -v             => Print version
   cr -h             => Print this help
@@ -613,91 +657,95 @@ def print_version
 end
 
 
-def list_dictionaries
-  Dir.chdir CRYPTIC_RESOLVER_HOME do 
-    Dir.children(CRYPTIC_RESOLVER_HOME).each_with_index do |dict,i|
+#
+# 1. List Default library's dicts
+# 2. List Extra   library's dicts
+# 3. List official dicts
+# 
+def list_dicts
+  Dir.chdir CR_DEFAULT_LIBRARY do 
+    puts blue("=> Default library: #{CR_DEFAULT_LIBRARY}")
+    Dir.children(CR_DEFAULT_LIBRARY).each_with_index do |dict,i|
       puts "#{blue(i+1)}. #{bold(green(dict))}"
     end
   end
+
+  if CR_EXTRA_LIBRARY 
+    puts
+    Dir.chdir CR_EXTRA_LIBRARY do 
+      puts blue("=> Extra library: #{CR_EXTRA_LIBRARY}")
+      Dir.children(CR_EXTRA_LIBRARY).each_with_index do |dict,i|
+        puts "#{blue(i+1)}. #{bold(green(dict))}"
+      end
+    end
+  end
+
+  puts
+  puts blue("=> Official dicts: (Add it by 'cr -a xxx')")
+  puts CR_OFFICIAL_DICTS
+
 end
 
 
-# All dictionaries word count
-$WordCount = 0
-# Default dictionaries word count
-$DefaultWordCount = 0
+# Two libraries word count (Default library + Extra library)
+$TwoLibWordCount = 0
+# Default library word count
+$DefaultLibWordCount = 0
+#  Extra  library word count
+$ExtraLibWordCount   = 0
 
-def count_dict_words(dict)
+def count_dict_words(library, dict)
   
-  dict_dir = CRYPTIC_RESOLVER_HOME + "/#{dict}"
+  dict_dir = library + "/#{dict}"
   
   wc = 0
 
   Dir.children(dict_dir).each do |entry|
     next unless entry.end_with?('.toml')
-    sheet_content = load_sheet(dict, entry.delete_suffix('.toml'))
+    sheet_content = load_sheet(library, dict, entry.delete_suffix('.toml'))
     count = sheet_content.keys.count
-  
-    # puts "#{entry}: #{count}"
+
     wc = wc + count
   end
-
-  $WordCount += wc
-
   return wc
-
 end
 
 
 def word_count(p:)
-
   # Always check before Dir.children (this method creates dir if not exists)
   is_there_any_dict?
 
-  # real dicts in user's directory
-  locals = []
-  Dir.children(CRYPTIC_RESOLVER_HOME).each do |dict|
-    locals << dict
-  end
-
-  # pre-defined default
-  defaults = CRYPTIC_DEFAULT_DICTS.keys.map do |s|
-    "cryptic_#{s}"
-  end
-
-  # user may delete some default dicts
-  defaults &= locals
+  default_lib = Dir.children(CR_DEFAULT_LIBRARY)
+  extra_lib   = Dir.children(CR_EXTRA_LIBRARY)
 
-  unless defaults.empty?
-    puts(bold(green("Default dicts: "))) if p
-    defaults.each do |s|
-      wc = count_dict_words(s)
-      $DefaultWordCount += wc
+  # Count default library
+  unless default_lib.empty?
+    puts(bold(green("Default library: "))) if p
+    default_lib.each do |s|
+      wc = count_dict_words(CR_DEFAULT_LIBRARY,s)
+      $DefaultLibWordCount += wc
       # With color, ljust not works, so we disable color
       puts("  #{s.ljust(17)}: #{wc}") if p
     end
   end
 
-  users = locals - defaults
-  user_words = 0
-  unless users.empty?
+  # Count extra library
+  unless extra_lib.empty?
     wc = 0
-    puts(bold(blue("\nUser's dict:"))) if p
-    users.each do |s|
-      wc = count_dict_words(s)
-      # no need to add to $WordCount，
-      # because it's done in `count_dict_words` func
+    puts(bold(blue("\nExtra library:"))) if p
+    extra_lib.each do |s|
+      wc = count_dict_words(CR_EXTRA_LIBRARY,s)
+      $ExtraLibWordCount += wc
       puts("  #{s.ljust(17)}: #{wc}") if p
     end
-
-    user_words = $WordCount - $DefaultWordCount
+    $TwoLibWordCount = $DefaultLibWordCount + $ExtraLibWordCount
   end
 
   if p 
   puts
-  puts "#{$DefaultWordCount.to_s.rjust(4)} words in default dictionaries"
-  puts "#{user_words.to_s.rjust(4)} words in user's  dictionaries"
-  puts "#{$WordCount.to_s.rjust(4)} words altogether"
+  puts "#{$DefaultLibWordCount.to_s.rjust(4)} words in Default library"
+  puts "#{$ExtraLibWordCount.to_s.rjust(4)  } words in  Extra  library"
+  puts "#{$TwoLibWordCount.to_s.rjust(4)    } words altogether"
   end
 end
 
@@ -711,7 +759,7 @@ case arg
 when nil    then help
 when '-v'   then print_version
 when '-h'   then help
-when '-l'   then list_dictionaries
+when '-l'   then list_dicts
 when '-c'   then word_count(p: true)
 when '-u'   then update_dicts   
 when '-s'   then search_word ARGV.shift
@@ -720,6 +768,6 @@ when '-d'   then del_dict ARGV.shift
 when '--help' 
   help
 else
-  solve_word arg
+  resolve_word arg
 end
  

data/lib/cr.rb

@@ -2,12 +2,27 @@
 # File          : cr.rb
 # Authors       : ccmywish <ccmywish@qq.com>
 # Created on    : <2022-04-15>
-# Last modified : <2022-10-20>
+# Last modified : <2022-11-27>
 #
 # cr:
 #
-#   This file is just a lib
+#   This file is the lib of `cr.rb``
 #
 # ------------------------------------------------------
 
-CR_GEM_VERSION = "3.20.0"
+CR_GEM_VERSION = "4.0.0.alpha.1"
+
+
+CR_OFFICIAL_DICTS = <<-EOF
+Default:
+  common       computer    windows
+  linux       electronics
+
+Field:
+   economy     medicine     math 
+  mechanical   science
+
+Specific:
+    dos         x86        signal
+
+EOF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cr.rb
 version: !ruby/object:Gem::Version
-  version: 3.20.0
+  version: 4.0.0.alpha.1
 platform: ruby
 authors:
 - ccmywish
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2022-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tomlrb
@@ -66,9 +66,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key: