my_help 1.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564753efc9cef4daea1c31839b464b39f24c74cb79e3ca1eac262dbbfe059018
-  data.tar.gz: 73336ae571ed079bc34ac6b6bdf229ccca5e875e41ac668ff65998776f9ee2ac
+  metadata.gz: 4aea4b438a5be4715107a41097ff21fa7d35e8cebed822e9995594bc827c6305
+  data.tar.gz: b964ebdcc06a3e414d5535172a31b69018dbf1cb43db5641101c88f5457a4c91
 SHA512:
-  metadata.gz: f43172b79ddc338021d83f8791088a45fd573a7c8b090d12b7e2f85708c1b9863c6866809fc49969995af6233bd4b2869b388c9cb7e4b7597466ba1007b8a65e
-  data.tar.gz: 6886f5fd8276df5d4325e87c524c31fd236a6d0b45150571072b596c7b13abd7b6b4670d69d99deade5128348e30345c696e6c761074b9195ab0be1a0bea3006
+  metadata.gz: c6d3ce8dcdd71f8e01baecc483f56412791137ab455ba45750966321fb197f7941fd341720bedba55035a3c573d21fea1753d154977a2ddb7c44dfb8751694b0
+  data.tar.gz: 4fcb4b3440365f8364677a6b7aac6d06574cd781e89e277185b0eb54934d976b4df58da318e09c05686fbbe1fd93ca912f458c970d59bfb9445896f4f02568e0

data/.gitignore

@@ -4,7 +4,7 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
+/docs/
 /pkg/
 /spec/reports/
 /vendor/

data/.yardoc/checksums

@@ -1,5 +1,11 @@
-lib/my_help.rb ced6dd68eb7342dc65e8c8506359cb9a18f37fde
-lib/my_help/org2yml.rb 0246f80ac2e821e5778aff8395dabbd6fbedc1d6
-lib/my_help/version.rb 8107e9718a720a9369e085771ab7c04ecb5bb8dc
-lib/my_help/my_help_controll.rb ccf627da5074e19887d379130df76b0b3db845a2
-lib/my_help/tomo_help_controll.rb da39a3ee5e6b4b0d3255bfef95601890afd80709
+lib/my_help.rb 7539f0f58056d44d38352f868bfea4d6fb63a9ee
+lib/my_help/cli.rb 8cd7468e74ef89e8a9ee83e5e780b70b6e2874c4
+lib/my_help/init.rb ac83b0cbfd9394278da8e7bf83b089cb84e132e4
+lib/my_help/list.rb 30d4be2eb41e623abeeb6914ab9907ced97ed722
+lib/my_help/config.rb d7162fbe953828fc7e6a5aac89adf8678131068f
+lib/my_help/modify.rb 17a00a9f1b4126d9c067a320b47639e5a5fec845
+lib/my_help/git_cli.rb bb04396f0b9d54ecb13100fe5cde029f7dbb0ea7
+lib/my_help/md2hash.rb 35ebd32d3f545b40cd9ebb1972dc60d53b58b22a
+lib/my_help/org2yml.rb 334d0a7b648dc75b1d9504ec6d68937c70e96343
+lib/my_help/version.rb e82ec18cc8f885ee6c9b6846c3813e1eb96981a9
+lib/my_help/org2hash.rb 939fea903abb5247959d74e18afc8db30fb5f6c8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_help (1.0c)
+    my_help (1.2.2)
       colorize
       command_line
       thor

data/README.org

@@ -1,96 +1,80 @@
-# my_help
-#+AUTHOR:  Shigeto R. Nishitani
-#+EMAIL:     (concat "nishitani@kwansei.ac.jp")
-#+LANGUAGE:  jp
-#+OPTIONS:   H:4 toc:t num:2
-#+SETUPFILE: /Users/bob/.emacs.d/org-mode/theme-readtheorg.setup
-#+STARTUP: indent nolineimages
+#+STARTUP: indent nolineimages content
 #+OPTIONS: ^:{}
-
-* 概要
-  :PROPERTIES:
-  :CUSTOM_ID: 概要
-  :END:
-
-CUI(CLA)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
-
-
-* (my_helpで解決しようとする)問題点
-  :PROPERTIES:
-  :CUSTOM_ID: my_helpで解決しようとする問題点
-  :END:
-
-CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は，
-commandや文法を覚えるのに苦労します．
-少しのkey(とっかかり)があると思い出すんですが，
-うろ覚えでは間違えて路頭に迷います．
-問題点は， 
-+ manは基本的に英語 
-+ manualでは重たい 
-+ いつもおなじことをwebで検索して 
-+ 同じとこ見ている 
-+ memoしても，どこへ置いたか忘れる
-などです．
-
-* 特徴
-  :PROPERTIES:
-  :CUSTOM_ID: 特徴
-  :END:
-
-これらをCLAとして提供しようというのが，このgemの目的です．
-仕様としては， 
-- userが自分にあったmanを作成 
-- 雛形を提供 
-- おなじformat, looks, 操作, 階層構造 
-- すぐに手が届く 
-- それらを追加・修正・削除できる
-
-memoソフトでは，検索が必要となりますが，my_helpは
-key(記憶のとっかかり)を提供することが目的です．
-RPGでレベル上げとかアイテムを貯めるようにして，
-プログラミングでスキルを発展させてください．
-
-VSCodeやGithub Copilotではcodeの候補を挙げてくれますが，
-物覚えの悪い作者は，人の名前をitem分けして，こそっと使っています．
-
-* 使用法
-  :PROPERTIES:
-  :CUSTOM_ID: 使用法
-  :END:
-** インストール
-
-: > gem install my_help
-です．
-
-** 簡単な使用法
-   :PROPERTIES:
-   :CUSTOM_ID: 簡単な使用法
-   :END:
-
-まずは，
-#+begin_src bash
+* Name
+- my_help :: manual like help for each user
+
+* Summary
+This gem makes and supplies user specific helps, emulating CUI(CLI) help
+usage.
+
+* Target
+A very novice of learning a specific operation, 
+such as CUI, shell, or emacs, 
+has a difficulty in remembering commands and grammers. 
+Some simple `key' reminds all, but no key brings nothing. 
+Especially a non-English-native has a strong difficulty 
+on the key remembering. 
+The problems are,
+-  a man(ual) is in English
+-  a man is heavily documented
+-  On web, searching the same key word,
+-  and reading the same URI repeatedly
+-  but a memo goes away somewhere...
+
+* Specs
+This gem aims to supply own help by gem environment. 
+Specs are, 
+- user makes his own help 
+- supplies a template 
+- a same format, looks, operation, and hierarchy 
+- easily see, read 
+- supplies editing and install commands.
+
+Wiki targets the whole engineer, my_help targets a specific person.
+Half of the wiki aim should be covered by my_help. 
+Making own manual is one of the best practices for remembering operations. 
+Memo applications are good, if you remember the key word. 
+my_help supplies the key for remembering the word.
+
+* Usage
+** Install
+
+: $ gem install my_help
+
+** Simple Usage
+At first, you can see the commands supplied by my_help.
+#+begin_example
 > my_help
-Commands:
-  my_help delete HELP             # delete HELP
-  my_help edit HELP               # edit HELP
-  my_help help [COMMAND]          # Describe available commands or one specific command
-  my_help list [HELP] [ITEM]      # list all helps, specific HELP, or ITEM
-  my_help new HELP                # make new HELP
-  my_help set_editor EDITOR_NAME  # set editor to EDITOR_NAME
-  my_help setup                   # set up the test database
-  my_help version                 # show version
-#+end_src
-としてください．このlistにNAMEやITEMを加えて行くとわかると思います．
-
-#+begin_src bash
-> my_help list
-> my_help list emacs
-> my_help list emacs -f
-> my_help list emacs file
-#+end_src
-として動かしてみてください．
-
-#+begin_src bash
+NAME
+    my_help - make own help and list.
+
+SYNOPSIS
+    my_help [global options] command [command options] [arguments...]
+
+VERSION
+    0.7.0
+
+GLOBAL OPTIONS
+    --help    - Show this message
+    --version - Display the program version
+
+COMMANDS
+    delete - delete HELP_NAME help
+    edit   - edit HELP_NAME help
+    help   - Shows a list of commands or help for one command
+    list   - list all helps, specific HELP, or item
+     new   - make new HELP_NAME
+#+end_example
+
+When you add HELP_NAME and item (-o)wo'
+
+: my_help list
+: my_help list emacs_help
+: my_help list emacs_help -f
+: my_help list emacs_help file
+
+
+#+BEGIN_EXAMPLE
 - emacsのキーバインド
 - 
 特殊キー操作
@@ -111,33 +95,16 @@ Commands:
      , query_replace  : query_replace
    -r, ruby-mode      : ruby-mode
    -d, dired          : ファイラとして使う
-#+end_src
-
-** my_helpがやっていること
-my_helpの個々のヘルプファイルは'~/.my_help'に置かれています．
-ヘルプファイルのフォーマットはEmacsのorg-modeです．
-これをEditorで叩いて編集したり，
-そこから情報を取り出したりしています．
-単にファイル操作を集約しているだけなのですが，
-これが面倒で．．．
-
-
-** 独自のhelpを作る方法
-独自のhelpを作る方法です．まずは，
-
-: $ my_help new new_help
+#+END_EXAMPLE
 
-で，new_helpというtemplateが用意されます．
-: $ my_help edit new_help
-で編集してください． Emacs org形式で，格納されています．
+** Make your own help
+For making your new help, you can do tha as follows:
+: my_help new new_help
 
-: $ my_help delete new_help
+A templeate is compied, then you can edit as 
+: my_help edit new_help
+The file is stored in emacs org mode.
 
-すると消されます．
-** editorの変更
-: $ my_help set_editor vim
-でeditorを変更できます．codeとかは確認していますが，
-それ以外で動いたり，動かなかったりを報告してください．
+You can delete if as follows:
+: my_help delete new_help
 
-OS Xで'emacs'とした時にGUI版が立ち上がって嫌だという場合は，
-'emacs -nw'として下さい．

data/README_j.org

@@ -0,0 +1,143 @@
+# my_help
+#+AUTHOR:  Shigeto R. Nishitani
+#+EMAIL:     (concat "nishitani@kwansei.ac.jp")
+#+LANGUAGE:  jp
+#+OPTIONS:   H:4 toc:t num:2
+#+SETUPFILE: /Users/bob/.emacs.d/org-mode/theme-readtheorg.setup
+#+STARTUP: indent nolineimages
+#+OPTIONS: ^:{}
+
+* 概要
+  :PROPERTIES:
+  :CUSTOM_ID: 概要
+  :END:
+
+CUI(CLA)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
+
+
+* (my_helpで解決しようとする)問題点
+  :PROPERTIES:
+  :CUSTOM_ID: my_helpで解決しようとする問題点
+  :END:
+
+CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は，
+commandや文法を覚えるのに苦労します．
+少しのkey(とっかかり)があると思い出すんですが，
+うろ覚えでは間違えて路頭に迷います．
+問題点は， 
++ manは基本的に英語 
++ manualでは重たい 
++ いつもおなじことをwebで検索して 
++ 同じとこ見ている 
++ memoしても，どこへ置いたか忘れる
+などです．
+
+* 特徴
+  :PROPERTIES:
+  :CUSTOM_ID: 特徴
+  :END:
+
+これらをCLAとして提供しようというのが，このgemの目的です．
+仕様としては， 
+- userが自分にあったmanを作成 
+- 雛形を提供 
+- おなじformat, looks, 操作, 階層構造 
+- すぐに手が届く 
+- それらを追加・修正・削除できる
+
+memoソフトでは，検索が必要となりますが，my_helpは
+key(記憶のとっかかり)を提供することが目的です．
+RPGでレベル上げとかアイテムを貯めるようにして，
+プログラミングでスキルを発展させてください．
+
+VSCodeやGithub Copilotではcodeの候補を挙げてくれますが，
+物覚えの悪い作者は，人の名前をitem分けして，こそっと使っています．
+
+* 使用法
+  :PROPERTIES:
+  :CUSTOM_ID: 使用法
+  :END:
+** インストール
+
+: > gem install my_help
+です．
+
+** 簡単な使用法
+   :PROPERTIES:
+   :CUSTOM_ID: 簡単な使用法
+   :END:
+
+まずは，
+#+begin_src bash
+> my_help
+Commands:
+  my_help delete HELP             # delete HELP
+  my_help edit HELP               # edit HELP
+  my_help help [COMMAND]          # Describe available commands or one specific command
+  my_help list [HELP] [ITEM]      # list all helps, specific HELP, or ITEM
+  my_help new HELP                # make new HELP
+  my_help set_editor EDITOR_NAME  # set editor to EDITOR_NAME
+  my_help setup                   # set up the test database
+  my_help version                 # show version
+#+end_src
+としてください．このlistにNAMEやITEMを加えて行くとわかると思います．
+
+#+begin_src bash
+> my_help list
+> my_help list emacs
+> my_help list emacs -f
+> my_help list emacs file
+#+end_src
+として動かしてみてください．
+
+#+begin_src bash
+- emacsのキーバインド
+- 
+特殊キー操作
+-   C-f, controlキーを押しながら    'f'
+-   M-f, escキーを押した後一度離して'f'
+-     操作の中断C-g, 操作の取り消し(Undo) C-x u
+     , head           : head
+     , license        : license
+   -c, cursor         : cursor
+   -e, edit           : edit
+   -s, short_cut      : short_cut
+   -f, file           : file
+   -q, quit           : quit
+   -p, page           : page
+   -w, window         : window
+   -b, buffer         : buffer
+   -m, mode           : mode
+     , query_replace  : query_replace
+   -r, ruby-mode      : ruby-mode
+   -d, dired          : ファイラとして使う
+#+end_src
+
+** my_helpがやっていること
+my_helpの個々のヘルプファイルは'~/.my_help'に置かれています．
+ヘルプファイルのフォーマットはEmacsのorg-modeです．
+これをEditorで叩いて編集したり，
+そこから情報を取り出したりしています．
+単にファイル操作を集約しているだけなのですが，
+これが面倒で．．．
+
+
+** 独自のhelpを作る方法
+独自のhelpを作る方法です．まずは，
+
+: $ my_help new new_help
+
+で，new_helpというtemplateが用意されます．
+: $ my_help edit new_help
+で編集してください． Emacs org形式で，格納されています．
+
+: $ my_help delete new_help
+
+すると消されます．
+** editorの変更
+: $ my_help set_editor vim
+でeditorを変更できます．codeとかは確認していますが，
+それ以外で動いたり，動かなかったりを報告してください．
+
+OS Xで'emacs'とした時にGUI版が立ち上がって嫌だという場合は，
+'emacs -nw'として下さい．

data/{docs/README.org → development_memo.org}

@@ -12,8 +12,48 @@
 #+TWITTER: off
 #+SETUPFILE: https://fniessen.github.io/org-html-themes/org/theme-readtheorg.setup
 
+* <2023-01-07 Sat> Thor
+いくつかのaliasをThorで実現したい
+- my_help -v
+- my_help --version
+という標準的なoption期待に答える．
+
+- [[https://marsbased.com/blog/2020/04/27/building-ruby-cli-thor/][author token, aliases sample]]
+- [[https://stackoverflow.com/questions/28504373/command-aliasing-in-thor][map]]
+なんかの記述があったが，
+- https://github.com/rails/thor/wiki
+で解決．やっぱり原典ね．
+
+あと，その後ろの方に，例文の引き方があって，
+- https://gist.github.com/search?l=ruby&q=.thor
+が便利なんがわかった．これは，使える．
+
+
 * <2023-01-06 Fri> get_configの置き場所
-thorのsubcommandを使って
+Thorのsubcommandを使ってclassを分けたが，共通で利用する
+get_configメソッドをどこに置くかで悩んだ．
+
+結局，
+#+begin_src ruby
+# git_cli.rb
+Module MyHelp
+  Module GetConfig
+  Class Git < Thor
+    include GetConfig
+...
+end
+# cli.rb
+Module MyHelp
+  Class CLI < Thor
+    include GetConfig
+...
+end
+# my_help.rb
+require_relative "my_help/git_cli"
+require_relative "my_help/cli"
+#+end_src 
+としている．
+専用のModuleを作成して，includeするという方法．
 * <2023-01-05 Thu> cli directory指定
 ** directory指定
 テスト環境と本番環境でのhelp_dirあるいはconfig_dir指定の