my_help 1.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73b21875275f91d6aaa1b7a2a274a2319e1eb86df4e843913cf3a9e818fc211b
-  data.tar.gz: 7472056b4622cead820d9e69c3da7350cda7d06746c89797c2dcddba34baad35
+  metadata.gz: d4a86f6d2f3dabef582a9c43dca24554b1dda2f5d773d0f7f8c9907c1dd205f8
+  data.tar.gz: 7010d97c58171b9606db261705a93deb7d6f23e546baeb32d25869e99ec1bfc7
 SHA512:
-  metadata.gz: 87585a0384723ea7f1ff5d623593413ba1d33e6d7c4564fcf97756c883b8f40bfbf74d0b4d4412b87b491956fe51781dcbd4c82afbc40cf71a17b7efc084ae87
-  data.tar.gz: 82e066659953bc7a72e3a1638769c7de01c70e24853e2dffd9635c657689339aa9aa07d69867d88d79dfd9dddd1f65b59d616301eb75daf71e9afbef2d28a448
+  metadata.gz: 1e0aaf779bb22e17ebd06d6d4277e323619b054120cb56ba8eab1e33c33d1ab2f8df9b71245f769276ce3c2de7d7c99804c5fd55710164cbef20eb063d8f235e
+  data.tar.gz: ec825103b28a678f0dcc7f2c94ec9afdfc836f69deae5b763279b61bb38ace3295a4be45f04956d87b118f95ce8af964cf89c629f5288ea9bc6cc42164228f90

data/.yardoc/checksums

@@ -1,11 +1,11 @@
 lib/my_help.rb 7539f0f58056d44d38352f868bfea4d6fb63a9ee
-lib/my_help/cli.rb 8cd7468e74ef89e8a9ee83e5e780b70b6e2874c4
+lib/my_help/cli.rb c2a482691a6e9183e393110da8a552d477cf856e
 lib/my_help/init.rb ac83b0cbfd9394278da8e7bf83b089cb84e132e4
-lib/my_help/list.rb 30d4be2eb41e623abeeb6914ab9907ced97ed722
-lib/my_help/config.rb d7162fbe953828fc7e6a5aac89adf8678131068f
+lib/my_help/list.rb a63c0f1366a7c162d2c5e16e70f37f7ebb32cf8e
+lib/my_help/config.rb be52fb39c0656febb6d230aa50e7b7a6804c7cc4
 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/version.rb 618ac9ac5ac451afc28fc6bae7bd657fc71a915a
 lib/my_help/org2hash.rb 939fea903abb5247959d74e18afc8db30fb5f6c8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_help (1.0c)
+    my_help (1.2.3)
       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/Rakefile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-
+require 'yard'
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
@@ -30,3 +30,22 @@ RuboCop::RakeTask.new
 task :default do
   system "rake -T"
 end
+
+require "colorize"
+require 'command_line/global'
+
+desc 'git auto'
+task :git_auto do
+  print "Input comments: "
+  comment = STDIN.gets.chomp 
+  comment = comment == "" ? "auto pull and push" : comment.gsub("\'", "\\'")
+  ["git add -A",
+   "git commit -m '#{comment}'",
+   "git pull origin main",
+   "git push origin main"].each do |comm|
+    puts comm.cyan
+    res = command_line comm
+    puts res.stdout.green
+  end
+end
+

data/development_memo.org

@@ -0,0 +1,242 @@
+#+qiita_teams: 5e172c4b5167abe35a3e
+#+qiita_private: 6487b0b54e4eda26e9f6
+#+OPTIONS: ^:{}
+#+STARTUP: indent nolineimages
+#+TITLE: my_help 開発メモ
+#+AUTHOR: Shigeto R. Nishitani
+#+EMAIL:     (concat "shigeto_nishitani@mac.com")
+#+LANGUAGE:  jp
+#+OPTIONS:   H:4 toc:t num:2
+# +OPTIONS:   toc:nil
+#+TAG: ruby, test, my_help
+#+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を使って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指定の
+差異の吸収メモ．
+- --help_dirでcliはhelp_dirを指定できる．
+  - 全て変更したはず．
+  - configが混乱しやすい．．．config[:ext]なんかを自動で返すといいが．
+- rspec/unitでは
+  - config_spec.rb, modify_spec.rbではtmp_confをtemp_dirに作成
+  - list_spec.rbではtemplates_pathを絶対パスで参照
+
+** Thorでのdirectory指定の変更
+Thorのdirectory指定をしっかりやってみる．
+
+#+begin_src bash
+bundle exec rspec --format documentation -e list spec/cli_spec.rb --help_dir='./tmp/.my_Help'
+invalid option: --help_dir=./tmp/.my_Help
+
+Please use --help for a listing of valid options
+#+end_src
+これはだめ．なぜなら，--help_dirはmy_helpのlistのoptionであって，
+rspecは解釈してくれない．
+
+ここは，cli_spec.rbで
+#+begin_src ruby
+    temp_dir = Dir.pwd
+    let(:help_name) { "example" }
+    let(:help_dir) { File.join(temp_dir, "lib", "templates") }
+
+    it "list with name" do
+      run_command("my_help list #{help_name} a_item --help_dir=#{help_dir}")
+      stop_all_commands
+      expect(last_command_started).to have_output(/a_item/)
+    end
+#+end_src
+とすべき．
+
+そうすると
+#+begin_src bash
+bundle exec exe/my_help list --help_dir='/Users/bob/git_hub/my_help/lib/templates'
+#+end_src
+でも動く．
+そうしておいて，optionsを移動．
+
+今は，
+#+begin_src bash
+> bundle exec exe/my_help help list
+Usage:
+  my_help list [HELP] [ITEM]
+
+Options:
+  [--help-dir=HELP_DIR]  
+  [--layer=N]            
+
+list helps
+#+end_src
+となっていたが，
+
+#+begin_src bash
+bundle exec exe/my_help
+Commands:
+  my_help delete [HELP]       # delete HELP
+  my_help edit [HELP]         # edit help
+...
+Options:
+  [--help-dir=HELP_DIR]  
+#+end_src
+とclass_optionとすることで，共通して指定できるように変更．
+
+* <2022-12-15 Thu> subcommand and options
+- [[https://hawksnowlog.blogspot.com/2020/09/ruby-thor-tutorial.html#hello-thor][Ruby thor で CLI ツールの開発に入門してみる]]
+
+* <2022-12-15 Thu> rspecでerror
+Arubaでrspecするとpwd directoryが/tmp/arubaになる？
+そうすると今のままではrspecが通らなくなる．
+example2.orgの置き場が不定．
+spec側で強引に作るか．．．
+
+それもsmartにしたいよね．
+newでは後ろにoptionがあって，#{temp_dir}での作成とできるが，
+これをその他のoptionsでやるのは難しそう．
+
+** 解決！！
+Arubaだけの問題なので，テストの時用にhelp_dirを
+Thorのoptionとして引けるようにした．
+#+begin_src ruby -n
+    desc "list [HELP] [ITEM]", "list helps"
+    option :help_dir, :type => :string
+    # use method_options [[https://github.com/rails/thor/wiki/Method-Options]]
+    def list(*args)
+      config = get_config(args).config
+      help_dir = options["help_dir"] || config[:local_help_dir]
+      puts List.new(help_dir,
+                    config[:ext]).list(*args.join(" "))
+    end
+...
+  context "list command" do
+    temp_dir = Dir.pwd
+    let(:help_name) { "example" }
+    let(:help_dir) { File.join(temp_dir, "lib", "templates") }
+
+    it "list with name" do
+      run_command("my_help list #{help_name} a_item --help_dir=#{help_dir}")
+      stop_all_commands
+      expect(last_command_started).to have_output(/a_item/)
+    end
+  end
+
+#+end_src
+
+* <2021-10-18 月> conf_pathの追加
+my_help.confの場所を指定するconf_pathをnewで指定できるようにする．
+
+#+begin_src diff -n -i
+> git diff
+--- a/lib/my_help/my_help_controll.rb
++++ b/lib/my_help/my_help_controll.rb
+@@ -5,13 +5,14 @@ require 'yaml'
+ module MyHelp
+   class Control
+     attr_accessor :local_help_dir, :editor
+-    def initialize()
++    def initialize(conf_path=nil)
+       # for configuration setups
+       # see https://stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem
+-
++      @conf_path = conf_path || ENV['HOME']
+       @template_dir = File.expand_path("../../templates", __FILE__)
+       @exe_dir = File.expand_path("../../exe", __FILE__)
+-      @local_help_dir = File.join(ENV['HOME'],'.my_help')
++      @local_help_dir = File.join(@conf_path, '.my_help')
++      @conf_file = File.join(@local_help_dir, '.my_help_conf.yml')
+       @editor = ENV['EDITOR'] || 'emacs' #'code', 'emacs' #'vim' #default editor
+       # @mini_account = File
+       set_help_dir_if_not_exists
+@@ -28,9 +29,6 @@ module MyHelp
+     end
+ 
+     def load_conf
+-      file_name = '.my_help_conf.yml'
+-      # @conf_file = File.join(Dir.pwd, file_name)
+-      @conf_file = File.join(@local_help_dir, file_name)
+       begin
+         conf = YAML.load_file(@conf_file)
+         @editor = conf[:editor]
+#+end_src
+
+変更箇所は次の通り．
+- initializeはconf_pathを受け取るが，指定されてない時はnil
+- これを@conf_pathに受け渡すが，defaultをENV['HOME']に指定
+- これでデフォルトのconfigurationを変更していく
+  やり方は，
+  [[https://stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem][Where to place/access config file in gem?]]
+  を参照する．
+
+これによってTest::unitでのtest環境独自のmy_help環境を構築することが
+できる．
+
+* <2021-11-08 月> conf_pathをactivate
+testが進んできたので，conf_pathをactivateした．
+そのためのテストが必要かも．
+
+1. ENV['HOME']で指定した時と．．．
+1. pwdで何もない時のoptionsがどうなっている？
+
+#+begin_src yaml
+config:
+  :template_dir: "/Users/bob/git_hub/my_help/lib/templates"
+  :local_help_dir: "/Users/bob/git_hub/my_help/test/.my_help"
+  :conf_file: "/Users/bob/git_hub/my_help/test/.my_help/.my_help_conf.yml"
+  :editor: emacs
+#+end_src
+
+* <2021-11-08 月> bundle exec exe/my_help editでエラー
+#+begin_src shell
+Could not find ffi-1.15.4 in any of the sources
+Run `bundle install` to install missing gems.
+#+end_src
+とのエラー．
+なんだろう．
+
+さらに，command_lineで呼ぶと，
+: emacs: standard input is not a tty
+というエラーが出る．これまたなんだろう？？？
+
+