chlog 0.9.0 → 1.6.1.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c501c040c85ebeba5c6171f5dfb6dcb6fddec08798166cd1beb0fce54dd27df
-  data.tar.gz: ec9bc451993d99992ae38d5ee2db80190e1fc55e5853d8665e6d31186be941cc
+  metadata.gz: 2ab687f94e5ae6381ae55993779ab02ca0d043f7f8a57924890cc5c891390a89
+  data.tar.gz: 1a4e1bc3f3b10aefbcd29c124b0e812e0dde7fd017740cc351d674074fe150b7
 SHA512:
-  metadata.gz: 2bc058d3d29b835fdfea8577cec9195e75b2b30069f2b8ca4e49f942a228b3de600c741fdf302701dc02579cb9db62685990297a0c330b69d8993ecd838b1ecb
-  data.tar.gz: d8517e795b3bb1e4d9b9666bbeabcf92ac987e3a280275644ac5779e03e8fd68149f62d28c3c447da38087ddf5c2a6f9de67d55350b18845cdb5a6f531f6407e
+  metadata.gz: 8891858162cf7e70148069d1802f50d12a60cfc63caac84a9d149e872ba19bb0a368cfa42b89fb12f43bfeca84bb13eafbfed52253a1d9d5e006515b7b40132f
+  data.tar.gz: 5d306384893f5ca1486c4decca64e727fb0e0ca7329d3a2499e9278ac4a1772064eef67f7b063b9c203413f9c8a6272d1975dc1cc4010d00c6f8db0f241095e4

data/bin/chlog

@@ -0,0 +1,532 @@
+#!/usr/bin/env ruby
+# ------------------------------------------------------
+# File          : chlog.rb
+# Authors       : ccmywish <ccmywish@qq.com>
+# Created on    : <2022-03-18>
+# Last modified : <2022-04-09>
+#
+# chlog:
+#
+#   Maintain your project's Changelog on the cli.
+#
+# ------------------------------------------------------
+
+puts __FILE__
+puts $0
+
+CHLOG_VERSION = "1.6.1.alpha"
+
+require 'date'
+$today = Date.today.to_s
+
+UNRELEASED_TITLE = "## [Unreleased](#) (#$today)"
+
+CHLOG_TEMPLATE = <<EOT
+# Changelog
+
+#{UNRELEASED_TITLE}
+
+<br>
+
+## [Initialize](#) (#$today)
+
+<br>
+
+<hr>
+
+This Changelog is maintained with [chlog](https://github.com/ccmywish/chlog)
+
+EOT
+
+$Changelog_file = `git rev-parse --show-toplevel`.chomp + '/CHANGELOG.md'
+
+def get_changelog
+  file = $Changelog_file
+  if File.exists? file
+    return File.read file
+  else
+    puts "chlog: Auto generate #$Changelog_file"
+    File.write(file, CHLOG_TEMPLATE)
+    return File.read file
+  end
+end
+
+
+def help
+  puts <<EOH
+chlog (v#{CHLOG_VERSION}): Help maintain the Changelog of your projects
+
+usage:
+
+  chlog                  => Generate CHANGELOG.md in git root
+  chlog -g (-m) (--sub)  => Reuse last commit log (m category / sub category)
+  chlog (--sub) log      => Determine main category(fallback Enhancements) (/ sub category) add log  
+  chlog -n (--sub) log   => Add log to New features (/ sub category)
+  chlog -e (--sub) log   => Add log to Enhancements (/ sub category)
+  chlog -b (--sub) log   => Add log to Bug fixes    (/ sub category)
+  chlog -s (--sub) log   => Add log to Security     (/ sub category)
+  chlog -c (--sub) log   => Add log to Compatibility(/ sub category)
+  chlog -d (--sub) log   => Add log to Deprecations (/ sub category)
+  chlog -r v3.14         => Release version to v3.14
+
+EOH
+
+end
+
+def match_unreleased?(str)
+  str =~ /^## \[Unreleased\]\(.*\) \(\d{4}-\d\d-\d\d\)/
+end
+
+def match_unreleased_fail!(str)
+  unless match_unreleased?(str)
+    puts "chlog: Unmathed format with chlog" 
+    # "#{lns[1][1..]}"
+    puts "       Unreleased version must be the third line.", ""
+    exit -1
+  end
+end
+
+def match_new_features?(str)
+  str =~ /^### New features:/
+end
+
+def match_enhancements?(str)
+  str =~ /^### Enhancements:/
+end
+
+def match_bug_fixes?(str)
+  str =~ /^### Bug fixes:/
+end
+
+def match_security?(str)
+  str =~ /^### Security:/
+end
+
+def match_compatibility?(str)
+  str =~ /^### Compatibility:/
+end
+
+def match_deprecations?(str)
+  str =~ /^### Deprecations:/
+end
+
+
+def next_version_index(lns_array)
+  nvi = lns_array[3..].each_with_index {break _2 if _1.start_with?("## [") }
+  nvi += 3
+end
+
+def next_category_index(lns_array)
+  nci = lns_array[3...nvi].each_with_index {break _2 if _1.start_with?("### ") }
+  
+  # The not match return value is not nil!! But an array!!
+  if nci.is_a(Integer)
+    nci += 3
+  else
+    nil
+  end
+end
+
+
+#
+#  ### New features:
+#   
+#  - xaaaaa
+#  - xbbbbb
+#  - xccccc    [-> this]
+#
+def find_main_category_last_list_item_index(lns, 
+                                            main_cat_index, 
+                                            first_lower_order_category_index)
+  mci = main_cat_index
+  nci = first_lower_order_category_index
+  
+  list_i = lns[mci+2..nci].each_with_index do 
+    break _2 if _1  !~  /^- .*/
+  end
+  list_i += mci+2 - 1
+end
+
+
+
+$order_table = [
+  :match_new_features?,
+  :match_enhancements?,
+  :match_bug_fixes?,
+  :match_security?,
+  :match_compatibility?,
+  :match_deprecations?
+]
+
+
+def first_lower_order_category_index(lns_array, category_order)
+
+  o = category_order
+
+  nvi = next_version_index(lns_array)
+  
+  while o < $order_table.size
+    lns_array[0...nvi].each_with_index do
+      if send($order_table[o], _1)
+        return _2
+      end
+    end
+    o += 1
+  end
+
+  # Next version above 
+  return (nvi - 2)
+end
+
+
+
+#
+# A meta function: do the real work other 6 functions delegate
+#
+# This function detect the main category, and then handle the 
+# sub category.
+# 
+def meta_add_to_a_category(log, main_category_order, category)
+
+  content = get_changelog
+  lns = content.lines
+
+  match_unreleased_fail!(lns[2])
+
+  nvi = next_version_index(lns)
+  # To find the existing category line
+  main_cat_i = lns[0...nvi].each_with_index do
+    # Adjust to index of the order table 
+    break _2 if send($order_table[main_category_order-1], _1)
+  end
+
+  #
+  # Always update to latest time when making a log
+  #
+  # We must add a "\n" because every element of the array
+  #   is a sentence with a trailing newline, then they can
+  #   be 'joined' to a working long string
+  #
+  lns[2] = UNRELEASED_TITLE + "\n"
+
+  f_l_o_c_i = first_lower_order_category_index(lns, main_category_order)
+
+  if main_cat_i.class != Integer
+  ################################################################################
+  # The main category not exists
+  ################################################################################
+
+
+    ########################################
+    if $sub_category
+    
+    # Because the main category not exists,
+    #   nor does the sub category
+    #
+    sub_cat_i = f_l_o_c_i 
+    to_wr = lns[0...sub_cat_i].join + "### #{category}:\n\n" + "**#{$sub_category}**\n\n" + '  - ' + log + "\n\n"
+    File.write($Changelog_file, to_wr + lns[sub_cat_i..].join)
+    
+    puts "chlog: Add log to #{category}/#{$sub_category}"
+    return 
+    end # end of if $sub_category
+    ########################################
+
+
+    # situation: no sub category 
+    
+    # Not need adjust to the index of the order table
+    log_loc = f_l_o_c_i
+    puts "chlog: Add '#{category}' category"
+    to_wr = lns[0...(log_loc)].join + "### #{category}:\n\n" + '- ' + log + "\n"
+    File.write($Changelog_file, to_wr + lns[log_loc-1..].join)
+  
+  else
+  ################################################################################
+  # The main category exists
+  ################################################################################
+    
+
+    ########################################
+    if $sub_category
+    
+    # from first list item to next main cat
+    #   search if sub cat already exists
+    sub_cat_i = lns[main_cat_i+2...f_l_o_c_i].each_with_index do 
+      break _2 if _1 =~ /^\*\*#{$sub_category}\*\*/
+    end
+
+    if !sub_cat_i.is_a?(Integer)
+    # the sub category not exists
+    
+      sub_cat_i = 2 + find_main_category_last_list_item_index(lns,main_cat_i,f_l_o_c_i) 
+      to_wr = lns[0...sub_cat_i].join + "**#{$sub_category}**\n\n" + '  - ' + log + "\n\n"
+      File.write($Changelog_file, to_wr + lns[sub_cat_i..].join)
+    else
+    # the sub category exists  
+
+      sub_cat_i +=  main_cat_i+2
+      to_wr = lns[0..sub_cat_i+1].join + '  - ' + log + "\n"
+      File.write($Changelog_file, to_wr + lns[sub_cat_i+2..].join)
+    end
+
+    puts "chlog: Add log to #{category}/#{$sub_category}"
+    return 
+    end # end of if $sub_category
+    ########################################
+
+
+
+    # situation: no sub category 
+
+    to_wr = lns[0..main_cat_i+1].join + '- ' + log + "\n"
+    
+    # main category list should be separated with
+    # sub category
+    if lns[main_cat_i+2] =~ /\*\*.*/
+      to_wr += "\n"
+    end
+    File.write($Changelog_file, to_wr + lns[main_cat_i+2..].join)
+  end
+  puts "chlog: Add log to #{category}"
+end
+
+
+#
+# main category order: 1
+#
+def add_to_new_features(log)
+  meta_add_to_a_category(log, 1, "New features")
+end
+
+#
+# main category order: 2
+#
+def add_to_enhancements(log)
+  meta_add_to_a_category(log, 2, "Enhancements")
+end
+
+#
+# main_category_order: 3
+#
+def add_to_bug_fixes(log)
+  meta_add_to_a_category(log, 3, "Bug fixes")
+end
+
+#
+# main_category_order: 4
+#
+def add_to_security(log)
+  meta_add_to_a_category(log, 4, "Security")
+end
+
+#
+# main_category_order: 5
+#
+def add_to_compatibility(log)
+  meta_add_to_a_category(log, 5, "Compatibility")
+end
+
+#
+# The last of order table
+# main_category_order: 6
+#
+def add_to_deprecations(log)
+  meta_add_to_a_category(log, 6, "Deprecations")
+end
+
+
+#
+# Release a version
+#
+def release_new_version(ver)
+  if ver.nil?
+    puts "chlog: No version supplied! "
+    puts "       Use chlog -r <version>!",""
+    exit 1
+  end
+
+  content = get_changelog
+  lns = content.lines
+
+  match_unreleased_fail!(lns[2])
+
+  header = <<EOF
+# Changelog
+
+## [Unreleased](#) (#$today)
+
+<br>
+
+EOF
+  
+  new_version = "## [#{ver}](#) (#$today)\n"
+  new_cont = header + new_version + lns[3..].join('')
+  File.write($Changelog_file, new_cont)
+  puts "Release #{ver} in changelog!"
+end
+
+
+def add_log_sensitive(log)
+
+  # Be careful the when statements order
+  # Match the case you want first
+  case log
+  when /deprecat/i, /^remove/i, /^not/i                then add_to_deprecations(log)
+  when /^new/i, /^add/i, /new feature/i, /^support/i   then add_to_new_features(log)
+  when /^fix/i, /repair/i, /bug/i                      then add_to_bug_fixes(log)
+  when /compatible/i, /compatibility/i                 then add_to_compatibility(log)
+  when /security/i, /secure/i, /cve/i                  then add_to_security(log)
+  when /feature/i, /update/i, /problem/i, /issue/i     then add_to_enhancements(log)
+  else
+    add_to_enhancements(log)
+  end
+end
+
+
+#
+# reuse git commit log
+#
+def add_with_git(first, second)
+
+  main_category = nil
+
+  if first =~ /^-([nebscd])$/
+    main_category = $1
+  elsif first =~ /^--(.*)/
+    $sub_category = $1
+  end
+
+  if second =~ /^-([nebscd])$/
+    main_category = $1
+  elsif second =~ /^--(.*)/
+    $sub_category = $1
+  end
+
+
+  gitlog = `git log --oneline -n 1`
+  log = gitlog.split(' ')
+  log = log[1..].join(' ')
+  puts "last commit: #{log}"
+
+  if $sub_category.nil?
+    puts "What sub category? Input or leave it blank"
+    print '>'
+    sub = STDIN.gets.chomp
+    case sub
+    when ''
+      $sub_category = nil
+    else
+      $sub_category = sub
+    end
+  end
+
+  if main_category.nil?
+    puts "What main category? Input number or leave it blank to auto determine"
+    puts <<~EOC
+    ----------------
+    1. New features
+    2. Enhancements
+    3. Bug fixes
+    4. Security
+    5. Compatibility
+    6. Deprecations
+    ----------------
+    EOC
+  
+    print '>'
+    case STDIN.gets.chomp
+    when '1'      then add_to_new_features(log)
+    when '2'      then add_to_enhancements(log)
+    when '3'      then add_to_bug_fixes(log)
+    when '4'      then add_to_security(log)
+    when '5'      then add_to_compatibility(log)
+    when '6'      then add_to_deprecations(log)
+    else
+      add_log_sensitive(log)
+    end
+  else
+    tbl = {
+      'n' => :add_to_new_features,
+      'e' => :add_to_enhancements,
+      'b' => :add_to_bug_fixes,
+      's' => :add_to_security,
+      'c' => :add_to_compatibility,
+      'd' => :add_to_deprecations
+    }
+    send(tbl[main_category], log)
+  end
+
+  # Auto commit
+  files = `git diff --exit-code --name-only`
+  files = files.split
+  if (files.size == 1) && (files[0] == "CHANGELOG.md")
+    puts "chlog: Able to commit the new Changelog, input y/yes/blank to agree, or others to refuse"
+    print '>'
+    case STDIN.gets.chomp.downcase
+    when '', 'yes', 'y'
+      system("git add #$Changelog_file && git commit -m 'Update the Changelog' ")
+    else
+      "do nothing" 
+    end
+  end
+end
+
+
+#############
+#    main
+#############
+
+if __FILE__ == $0
+
+if $*.size == 0
+  if File.exists? $Changelog_file
+    puts "chlog: Already exists Changelog (#$Changelog_file)"
+    puts "       Use chlog -h to see options"
+  else
+    get_changelog
+  end
+  exit
+end
+
+action = $*[0]
+if $*[1] =~ /--(.*)/
+  puts "-> DEBUG: #$1"
+  $sub_category = $1 
+  log = $*[2..].join(' ')
+else
+  $sub_category = nil
+  log = $*[1..].join(' ')
+end
+
+
+case action
+when "-h", "--help" then help()
+when "-n" then add_to_new_features(log)
+when "-e" then add_to_enhancements(log)
+when "-b" then add_to_bug_fixes(log)
+when "-s" then add_to_security(log)
+when "-c" then add_to_compatibility(log)
+when "-d" then add_to_deprecations(log)
+when "-r" then release_new_version($*[1])
+when "-g" then add_with_git($*[1], $*[2])
+else
+  if action =~ /^-[^-]*$/
+    puts "chlog: Unknown option!"
+    exit 1
+  else
+    if $*[0] =~ /^--(.*)/
+      $sub_category = $1 
+      log = $*[1..].join(' ')
+    else
+      $sub_category = nil
+      log = $*[0..].join(' ')
+    end
+    puts "chlog: Auto determine log category"
+    add_log_sensitive(log)
+  end
+end
+
+
+# end main 
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: chlog
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.6.1.alpha
 platform: ruby
 authors:
-- Aoran Zeng
-autorequire:
-bindir: exe
+- ccmywish
+autorequire: 
+bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: highline
-  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'
+date: 2022-04-09 00:00:00.000000000 Z
+dependencies: []
 description: 'This command line tool `chlog` helps generate and maintain the Changelog
   of your projects.
 
@@ -34,16 +20,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- exe/chlog
-- lib/chlog.rb
-- lib/chlog/version.rb
+- bin/chlog
 homepage: https://github.com/ccmywish/chlog
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ccmywish/chlog/issues
   source_code_uri: https://github.com/ccmywish/chlog
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -54,12 +38,12 @@ 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.4.8
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
-summary: Help maintain Changelog on the command line!
+summary: 'chlog: help maintain Changelog'
 test_files: []

data/exe/chlog

@@ -1,82 +0,0 @@
-#!/usr/bin/env ruby
-# ------------------------------------------------------
-# File          : chlog.rb
-# Authors       : Aoran Zeng <ccmywish@qq.com>
-# Created on    : <2022-03-18>
-# Last modified : <2023-05-09>
-#
-# chlog:
-#
-#   Maintain your project's Changelog on the cli.
-# ------------------------------------------------------
-
-require 'chlog'
-
-module Chlog::CLI
-
-  def self.run
-
-    args = $*.dup
-
-    if args.size == 0
-      help or exit
-    end
-
-    action = args[0]
-
-    case action
-    when "-h", "--help" then help or exit end
-
-    logger = Chlog::Logger.new
-
-    case action
-    when "-g" then exit logger.generate_changelog
-    when "-r" then exit logger.release_new_version(args[1])
-    end
-
-    if args[1] =~ /^--(.*)/
-      logger.sub_category = $1
-      logger.log = args[2..].join(' ')
-    else
-      logger.sub_category = nil
-      logger.log = args[1..].join(' ')
-    end
-
-    case action
-    when /-[nebscd]/
-      logger.take_action(action)
-    else
-      # action =~ /^-[^-]*$/
-      abort "chlog: Unknown option!"
-    end
-  end
-
-
-  def self.help
-    puts <<~EOH
-    chlog (v#{Chlog::GEM_VERSION}): Help maintain the Changelog of your projects
-
-    Usage:
-
-      chlog -g               Generate CHANGELOG.md in git root
-      chlog -r <3.14>        Release version to v3.14
-
-    Add log:
-
-      chlog <-main category> [--sub category] <log>
-
-    Main Category:
-
-      -n    Add log to New features
-      -e    Add log to Enhancements
-      -b    Add log to Bug fixes
-      -s    Add log to Security
-      -c    Add log to Compatibility
-      -d    Add log to Deprecations
-
-    EOH
-  end
-
-end
-
-Chlog::CLI.run

data/lib/chlog/version.rb

@@ -1,16 +0,0 @@
-# ---------------------------------------------------------------
-# File          : version.rb
-# Authors       : Aoran Zeng <ccmywish@qq.com>
-# Created on    : <2023-05-09>
-# Last modified : <2023-05-09>
-#
-# version:
-#
-#   Lib version
-# ---------------------------------------------------------------
-
-module Chlog
-
-  GEM_VERSION = "0.9.0"
-
-end

data/lib/chlog.rb

@@ -1,417 +0,0 @@
-# ------------------------------------------------------
-# File          : chlog.rb
-# Authors       : Aoran Zeng <ccmywish@qq.com>
-# Created on    : <2022-04-15>
-# Last modified : <2023-05-09>
-#
-# chlog:
-#
-#   Maintain your project's Changelog on the cli.
-# ------------------------------------------------------
-
-require_relative 'chlog/version'
-
-class Chlog::Logger
-
-  attr_accessor :sub_category,  # 存储次标题
-                :log,           # 存储log
-                :highline       # HighLine 实例
-                :changelog      # CHANGELOG.md 位置
-
-
-  def initialize
-    require 'highline'
-    @highline = HighLine.new
-
-    require 'open3'
-    # Prevent current directory is not git directory
-    Open3.popen3("git rev-parse --show-toplevel") do |i, o, err, t|
-      if err.read.include?("fatal: not a git repository")
-        puts "chlog: Not a git directory!" or exit(false)
-      else
-        @changelog = `git rev-parse --show-toplevel`.chomp + '/CHANGELOG.md'
-      end
-    end
-  end
-
-  require 'date'
-  TODAY = Date.today.to_s
-
-  UNRELEASED_TITLE = "## [Unreleased](#) (#{TODAY})"
-
-  TEMPLATE = <<~EOT
-    # Changelog
-
-    #{UNRELEASED_TITLE}
-
-    <br>
-
-    ## [Initialize](#) (#{TODAY})
-
-    <br>
-
-    <hr>
-
-    This Changelog is maintained with [chlog](https://github.com/ccmywish/chlog)
-
-  EOT
-
-
-  def generate_changelog
-    file = @changelog
-    if File.exist? file
-      puts "chlog: Already exists Changelog (#@changelog)" or return false
-    else
-      File.write(file, TEMPLATE)
-      puts "chlog: Generate #@changelog OK!" or return true
-    end
-  end
-
-
-  def get_changelog
-    file = @changelog
-    if File.exist? file
-      return File.read file
-    else
-      abort "chlog: No Changelog exists, use 'chlog -g' to generate!"
-    end
-  end
-
-end
-
-
-class Chlog::Logger
-
-  def match_unreleased?(str)
-    str =~ /^## \[Unreleased\]\(.*\) \(\d{4}-\d\d-\d\d\)/
-  end
-
-  def match_unreleased_fail!(str)
-    unless match_unreleased?(str)
-      puts  "chlog: Unmatched format with chlog"
-      puts
-      # "#{lns[1][1..]}"
-      abort "Unreleased version must be the third line"
-    end
-  end
-
-  def match_new_features?(str)
-    str =~ /^### New features:/
-  end
-
-  def match_enhancements?(str)
-    str =~ /^### Enhancements:/
-  end
-
-  def match_bug_fixes?(str)
-    str =~ /^### Bug fixes:/
-  end
-
-  def match_security?(str)
-    str =~ /^### Security:/
-  end
-
-  def match_compatibility?(str)
-    str =~ /^### Compatibility:/
-  end
-
-  def match_deprecations?(str)
-    str =~ /^### Deprecations:/
-  end
-
-
-  def next_version_index(lns_array)
-    nvi = lns_array[3..].each_with_index {break _2 if _1.start_with?("## [") }
-    nvi += 3
-  end
-
-  def next_category_index(lns_array)
-    nci = lns_array[3...nvi].each_with_index {break _2 if _1.start_with?("### ") }
-
-    # The not match return value is not nil!! But an array!!
-    if nci.is_a(Integer) then nci += 3
-    else nil end
-  end
-
-=begin
-### New features:
-
-- xaaaaa
-- xbbbbb
-- xccccc    [-> this]
-=end
-  def find_main_category_last_list_item_index(lns,
-                                              main_cat_index,
-                                              first_lower_order_category_index)
-    mci = main_cat_index
-    nci = first_lower_order_category_index
-
-    list_i = lns[mci+2..nci].each_with_index do
-      break _2 if _1  !~  /^- .*/
-    end
-    list_i += mci+2 - 1
-  end
-
-
-  LIST__Feature = %w[
-    new_features  enhancements    bug_fixes
-    security      compatibility  deprecations
-  ]
-
-  # New features
-  # Enhancements
-  # Bug fixes
-  # Security
-  # Compatibility
-  # Deprecations
-  LIST__Main_Category = LIST__Feature.map do
-    _1.split('_').join(' ').capitalize
-  end
-
-  # match_new_features?
-  # match_enhancements?
-  # match_ ...
-  LIST__Match_Method = LIST__Feature.map do
-    ('match_' + _1 + '?').to_sym
-  end
-
-=begin
-  {
-    1 => :add_to_new_features,
-    2 => :add_to_enhancements,
-    ...
-  }
-=end
-  HASH__Order_To_AddTo_Method = ([1,2,3,4,5,6].zip LIST__Feature.map {|m| ('add_to_' + m).to_sym }).to_h
-
-
-
-  def take_action(action)
-    options = "nebscd"
-
-=begin
-    {
-      "-n" => "new_features", "-e" => "enhancements",  "-b" => "bug_fixes",
-      "-s" => "security",     "-c" => "compatibility", "-d" => "deprecations"
-    }
-=end
-    action_table = options.chars.map do |op|
-      '-' + op
-    end.zip(LIST__Feature).to_h
-
-    public_send "add_to_#{action_table[action]}"
-  end
-
-
-  def first_lower_order_category_index(lns_array, category_order)
-
-    o = category_order
-
-    nvi = next_version_index(lns_array)
-
-    while o < LIST__Match_Method.size
-      lns_array[0...nvi].each_with_index do
-        return _2 if send(LIST__Match_Method[o], _1)
-      end
-      o += 1
-    end
-
-    # Next version above
-    return (nvi - 2)
-  end
-
-
-  # A meta function: do the real work other 6 functions delegate
-  #
-  # This function detect the main category, and then handle the
-  # sub category.
-  def meta_add_to_a_category(log, main_category_order, category)
-
-    content = get_changelog
-    lns = content.lines
-
-    match_unreleased_fail!(lns[2])
-
-    nvi = next_version_index(lns)
-    # To find the existing category line
-    main_cat_i = lns[0...nvi].each_with_index do
-      # Adjust to index of the order table
-      break _2 if send(LIST__Match_Method[main_category_order-1], _1)
-    end
-
-    #
-    # Always update to latest time when making a log
-    #
-    # We must add a "\n" because every element of the array
-    #   is a sentence with a trailing newline, then they can
-    #   be 'joined' to a working long string
-    #
-    lns[2] = UNRELEASED_TITLE + "\n"
-
-    f_l_o_c_i = first_lower_order_category_index(lns, main_category_order)
-
-    if main_cat_i.class != Integer
-    ################################################################################
-    # The main category not exists
-    ################################################################################
-
-
-      ########################################
-      if @sub_category
-
-      # Because the main category not exists,
-      #   nor does the sub category
-      #
-      sub_cat_i = f_l_o_c_i
-      to_wr = lns[0...sub_cat_i].join + "### #{category}:\n\n" + "**#{@sub_category}**\n\n" + '  - ' + log + "\n\n"
-      File.write(@changelog, to_wr + lns[sub_cat_i..].join)
-
-      puts "chlog: Add log to #{category}/#{@sub_category}"
-      return
-      end # end of if @sub_category
-      ########################################
-
-      # situation: no sub category
-
-      # Not need adjust to the index of the order table
-      log_loc = f_l_o_c_i
-      puts "chlog: Add '#{category}' category"
-      to_wr = lns[0...(log_loc)].join + "### #{category}:\n\n" + '- ' + log + "\n"
-      File.write(@changelog, to_wr + lns[log_loc-1..].join)
-
-  else
-  ################################################################################
-  # The main category exists
-  ################################################################################
-
-
-    ########################################
-    if @sub_category
-
-    # from first list item to next main cat
-    #   search if sub cat already exists
-    sub_cat_i = lns[main_cat_i+2...f_l_o_c_i].each_with_index do
-      break _2 if _1 =~ /^\*\*#{@sub_category}\*\*/
-    end
-
-    if !sub_cat_i.is_a?(Integer)
-    # the sub category not exists
-
-      sub_cat_i = 2 + find_main_category_last_list_item_index(lns,main_cat_i,f_l_o_c_i)
-      to_wr = lns[0...sub_cat_i].join + "**#{@sub_category}**\n\n" + '  - ' + log + "\n\n"
-      File.write(@changelog, to_wr + lns[sub_cat_i..].join)
-    else
-    # the sub category exists
-
-      sub_cat_i +=  main_cat_i+2
-      to_wr = lns[0..sub_cat_i+1].join + '  - ' + log + "\n"
-      File.write(@changelog, to_wr + lns[sub_cat_i+2..].join)
-    end
-
-    puts "chlog: Add log to #{category}/#{@sub_category}"
-    return
-    end # end of if @sub_category
-    ########################################
-
-
-
-    # situation: no sub category
-
-    to_wr = lns[0..main_cat_i+1].join + '- ' + log + "\n"
-
-    # main category list should be separated with
-    # sub category
-    if lns[main_cat_i+2] =~ /\*\*.*/
-      to_wr += "\n"
-    end
-    File.write(@changelog, to_wr + lns[main_cat_i+2..].join)
-  end
-
-  puts "chlog: Add log to #{category}"
-end
-
-
-
-  # main category order: 1
-  def add_to_new_features
-    meta_add_to_a_category(@log, 1, "New features")
-  end
-
-  # main category order: 2
-  def add_to_enhancements
-    meta_add_to_a_category(@log, 2, "Enhancements")
-  end
-
-  # main_category_order: 3
-  def add_to_bug_fixes
-    meta_add_to_a_category(@log, 3, "Bug fixes")
-  end
-
-  # main_category_order: 4
-  def add_to_security
-    meta_add_to_a_category(@log, 4, "Security")
-  end
-
-  # main_category_order: 5
-  def add_to_compatibility
-    meta_add_to_a_category(@log, 5, "Compatibility")
-  end
-
-  # The last of order table
-  # main_category_order: 6
-  def add_to_deprecations
-    meta_add_to_a_category(@log, 6, "Deprecations")
-  end
-
-  # Release a version
-  def release_new_version(ver)
-    if ver.nil?
-      puts "chlog: No version supplied!"; puts; abort "Use chlog -r <version>!"
-    end
-
-    if !ver.downcase.start_with?('v') and ver[0].match? /\d/
-      ver = 'v' + ver
-    end
-
-    content = get_changelog
-    lns = content.lines
-
-    match_unreleased_fail!(lns[2])
-
-    header = <<~EOF
-      # Changelog
-
-      ## [Unreleased](#) (#{TODAY})
-
-      <br>
-
-    EOF
-
-    new_version = "## [#{ver}](#) (#{TODAY})\n"
-    new_cont = header + new_version + lns[3..].join('')
-    File.write(@changelog, new_cont)
-    puts "chlog: Release #{ver} in Changelog!" or return true
-  end
-
-
-  # Help user interactively
-  def ask_user_category
-    category = @highline.choose do |menu|
-      menu.index_color  = :rgb_77bbff
-      menu.prompt = "What main category?"
-      # return number!!! not string!!!
-      menu.choices(*LIST__Main_Category)
-    end
-
-    option = LIST__Main_Category.index(category)
-
-    if @sub_category.nil?
-      sub = @highline.ask "What sub category? [NIL/sub]"
-      case sub
-      when '' then @sub_category = nil
-      else @sub_category = sub end
-    end
-    return option
-  end
-
-end