my_help 0.8.5 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 256d8c9ec84045cb103f0de05567c4107d7b97c48b26bbd3697df3db009e5dbc
-  data.tar.gz: 5be179861617eff7530d061669d36d61e4f9de3bea0bb4f32c6ff2117bb5a28d
+  metadata.gz: 564753efc9cef4daea1c31839b464b39f24c74cb79e3ca1eac262dbbfe059018
+  data.tar.gz: 73336ae571ed079bc34ac6b6bdf229ccca5e875e41ac668ff65998776f9ee2ac
 SHA512:
-  metadata.gz: a5b5077ff038c414ffc5c6d13c8691d18d9706282931f406a5c36f6f61807699fa418628a0faa0a9dea422f6d17b7b3d53034edb9f71d349af5c88265d09bd04
-  data.tar.gz: 4050c4dda2c5e5f4e6ad0b43368a69963b5ef8e82eb8b522c119cdea2287f76efbd15f077ae86ff3a2e5b7b63e18685899e97be6632728844d885e1af520fa90
+  metadata.gz: f43172b79ddc338021d83f8791088a45fd573a7c8b090d12b7e2f85708c1b9863c6866809fc49969995af6233bd4b2869b388c9cb7e4b7597466ba1007b8a65e
+  data.tar.gz: 6886f5fd8276df5d4325e87c524c31fd236a6d0b45150571072b596c7b13abd7b6b4670d69d99deade5128348e30345c696e6c761074b9195ab0be1a0bea3006

data/'../test'/.my_help/.my_help_conf.yml

@@ -0,0 +1,2 @@
+---
+:editor: emacs

data/'../test'/.my_help/emacs.org

@@ -0,0 +1,50 @@
+#+STARTUP: indent nolineimages
+* head
+- Emacs key bind
+- 
+special key command
+-   c-f, While pressing the control key, press 'f'
+-   M-f, After pressing Esc key, press 'f'
+-   c-g, Operation interruption 
+-   c-x u, Undo operation(Undo)
+* license
+-      cc by Natsuko Kawabata, 2017
+
+* move cursor
+- c-f, move Forward,		  Move to forward or right
+- c-b, move Backward,   	  Move to back or left
+- c-a, go Ahead of line, 	  Move to the beginning of the line
+- c-e, go End of line,   	  Move to the end of the line
+- c-n, move Next line,      Move to next line
+- c-p, move Previous line,  Move to previous line
+* move page
+- c-v, move Vertical,          Move to next page
+- M-v, move reversive Vertical,Move to previous page
+- c-l, centerise Line,         Move to center on current line
+- M-<, move Top of file,    	 Move to the top of the file
+- M->, move Bottom of file,    Move to the end of the file
+* file operation file
+- c-x c-f, Find file, Find file
+- c-x c-s, Save file, Save file
+- c-x c-w, Write file NAME, Write a file with another name
+* edit operation
+- c-d, Delete char, Delete a letter
+- c-k, Kill line,   Delete a line，cut
+- c-y, Yank,        Paste
+- c-w, Kill region, Delete an area ，cut
+- 領域選択は，先頭 or 最後尾で c-space した後，最後尾 or 先頭へカーソル移動
+- c-s, forward incremental Search WORD, 前へ WORD を検索
+- c-r, Reverse incremental search WORD, 後へ WORD を検索
+- M-x query-replace WORD1 <ret> WORD2：対話的置換(y or n で可否選択)
+* window operation
+- c-x 2, 2 windows, Split into two windows 二つに分割
+- c-x 1, 1 windows, Integrate in a window
+- c-x 3, 3rd window sep, Split vertically
+- c-x o, Other windows, Move to the next window
+* buffer operation
+- すでに open して Emacs にバッファーされた file
+- c-x b, show Buffer,   Buffer list
+- c-x c-b, next Buffer, Move to next buffer
+* quit operation
+- c-x c-c, Quit Emacs, Save file and quit
+- c-z, suspend Emacs,  Pause，restart with fg

data/.gitignore

@@ -1,10 +1,17 @@
 /tmp
 .DS_Store
 /.bundle/
+/.yardoc
 /_yardoc/
 /coverage/
+/doc/
 /pkg/
+/spec/reports/
+/vendor/
+/tmp/
+/.tags
 *~
 \#*
+.\#*
 
-
+.ruby-version

data/.my_help/example2.org

@@ -0,0 +1,9 @@
+#+STARTUP: indent nolineimages overview
+* head
+- help_title example
+* license
+-      cc by Shigeto R. Nishitani, 2016-22
+* a_item : item_short_description
+- content_a
+* b_item
+- content_b

data/.rspec

@@ -1,4 +1,3 @@
---require spec_helper
 --format documentation
 --color
-
+--require spec_helper

data/.rspec_status

@@ -0,0 +1,13 @@
+example_id                  | status | run_time        |
+--------------------------- | ------ | --------------- |
+./spec/cli_spec.rb[1:1:1]   | passed | 0.31228 seconds |
+./spec/cli_spec.rb[1:2:1]   | passed | 0.31058 seconds |
+./spec/cli_spec.rb[1:3:1]   | passed | 0.31153 seconds |
+./spec/cli_spec.rb[1:4:1]   | passed | 0.2152 seconds  |
+./spec/cli_spec.rb[1:4:2]   | passed | 0.21003 seconds |
+./spec/cli_spec.rb[1:5:1]   | passed | 0.31109 seconds |
+./spec/cli_spec.rb[1:6:1]   | passed | 0.31433 seconds |
+./spec/cli_spec.rb[1:7:1]   | passed | 0.21002 seconds |
+./spec/cli_spec.rb[1:7:2]   | passed | 0.21031 seconds |
+./spec/cli_spec.rb[1:7:3]   | passed | 0.21089 seconds |
+./spec/my_help_spec.rb[1:1] | passed | 0.00078 seconds |

data/.yardoc/checksums

@@ -1,5 +1,5 @@
 lib/my_help.rb ced6dd68eb7342dc65e8c8506359cb9a18f37fde
-lib/my_help/org2yml.rb 4be5461e87290a6c8fa4ef802df8b64e8c63ca9a
-lib/my_help/version.rb 0c71ad78597c647364908e595140b5fb9af9e6a3
-lib/my_help/my_help_controll.rb fba5c56e7e7c716d4d34b6851a808e959ecdb773
+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

data/Gemfile

@@ -1,6 +1,11 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in my_help.gemspec
 gemspec
-gem 'ffi', '~> 1.9'
-gem 'aruba', '~> 0.14.12'
-gem 'command_line', '~> 1.1.0'
-gem 'color_echo'
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem 'aruba', '~> 2.1.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_help (0.8.4)
+    my_help (1.0c)
       colorize
       command_line
       thor
@@ -9,68 +9,75 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aruba (0.14.12)
-      childprocess (>= 0.6.3, < 4.0.0)
-      contracts (~> 0.9)
-      cucumber (>= 1.3.19)
-      ffi (~> 1.9)
-      rspec-expectations (>= 2.99)
-      thor (~> 0.19)
-    backports (3.15.0)
-    builder (3.2.3)
-    childprocess (3.0.0)
-    color_echo (3.1.1)
+    aruba (2.1.0)
+      bundler (>= 1.17, < 3.0)
+      childprocess (>= 2.0, < 5.0)
+      contracts (>= 0.16.0, < 0.18.0)
+      cucumber (>= 4.0, < 9.0)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    builder (3.2.4)
+    childprocess (4.1.0)
     colorize (0.8.1)
-    command_line (1.1.0)
-    contracts (0.16.0)
-    cucumber (3.1.2)
-      builder (>= 2.1.2)
-      cucumber-core (~> 3.2.0)
-      cucumber-expressions (~> 6.0.1)
-      cucumber-wire (~> 0.0.1)
-      diff-lcs (~> 1.3)
-      gherkin (~> 5.1.0)
-      multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.1.2)
-    cucumber-core (3.2.1)
-      backports (>= 3.8.0)
-      cucumber-tag_expressions (~> 1.1.0)
-      gherkin (~> 5.0)
-    cucumber-expressions (6.0.1)
-    cucumber-tag_expressions (1.1.1)
-    cucumber-wire (0.0.1)
-    diff-lcs (1.3)
-    ffi (1.11.3)
-    gherkin (5.1.0)
-    multi_json (1.14.1)
-    multi_test (0.1.2)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    command_line (2.0.1)
+    contracts (0.16.1)
+    cucumber (8.0.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-ci-environment (~> 9.0, >= 9.0.4)
+      cucumber-core (~> 11.0, >= 11.0.0)
+      cucumber-cucumber-expressions (~> 15.1, >= 15.1.1)
+      cucumber-gherkin (~> 23.0, >= 23.0.1)
+      cucumber-html-formatter (~> 19.1, >= 19.1.0)
+      cucumber-messages (~> 18.0, >= 18.0.0)
+      diff-lcs (~> 1.5, >= 1.5.0)
+      mime-types (~> 3.4, >= 3.4.1)
+      multi_test (~> 1.1, >= 1.1.0)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-ci-environment (9.1.0)
+    cucumber-core (11.0.0)
+      cucumber-gherkin (~> 23.0, >= 23.0.1)
+      cucumber-messages (~> 18.0, >= 18.0.0)
+      cucumber-tag-expressions (~> 4.1, >= 4.1.0)
+    cucumber-cucumber-expressions (15.2.0)
+    cucumber-gherkin (23.0.1)
+      cucumber-messages (~> 18.0, >= 18.0.0)
+    cucumber-html-formatter (19.2.0)
+      cucumber-messages (~> 18.0, >= 18.0.0)
+    cucumber-messages (18.0.0)
+    cucumber-tag-expressions (4.1.0)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_test (1.1.0)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    thor (0.20.3)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    thor (1.2.1)
 
 PLATFORMS
-  ruby
+  arm64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
-  aruba (~> 0.14.12)
-  color_echo
-  command_line (~> 1.1.0)
-  ffi (~> 1.9)
+  aruba (~> 2.1.0)
   my_help!
-  rake
-  rspec
+  rake (~> 13.0)
+  rspec (~> 3.0)
 
 BUNDLED WITH
-   2.0.2
+   2.3.23

data/README.org

@@ -1,4 +1,4 @@
-#+TITLE:  my_help README
+# my_help
 #+AUTHOR:  Shigeto R. Nishitani
 #+EMAIL:     (concat "nishitani@kwansei.ac.jp")
 #+LANGUAGE:  jp
@@ -21,8 +21,10 @@ CUI(CLA)ヘルプのUsage出力を真似て，user独自のhelpを作成・提
   :END:
 
 CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は，
-commandや文法を覚えるのに苦労します．少しのkey(とっかかり)があると
-思い出すんですが，うろ覚えでは間違えて路頭に迷います．問題点は， 
+commandや文法を覚えるのに苦労します．
+少しのkey(とっかかり)があると思い出すんですが，
+うろ覚えでは間違えて路頭に迷います．
+問題点は， 
 + manは基本的に英語 
 + manualでは重たい 
 + いつもおなじことをwebで検索して 
@@ -35,7 +37,7 @@ commandや文法を覚えるのに苦労します．少しのkey(とっかかり
   :CUSTOM_ID: 特徴
   :END:
 
-これらをCLA環境として提供しようというのが，このgemの目的です．
+これらをCLAとして提供しようというのが，このgemの目的です．
 仕様としては， 
 - userが自分にあったmanを作成 
 - 雛形を提供 
@@ -48,6 +50,7 @@ key(記憶のとっかかり)を提供することが目的です．
 RPGでレベル上げとかアイテムを貯めるようにして，
 プログラミングでスキルを発展させてください．
 
+VSCodeやGithub Copilotではcodeの候補を挙げてくれますが，
 物覚えの悪い作者は，人の名前をitem分けして，こそっと使っています．
 
 * 使用法
@@ -56,7 +59,7 @@ RPGでレベル上げとかアイテムを貯めるようにして，
   :END:
 ** インストール
 
-: $ gem install my_help
+: > gem install my_help
 です．
 
 ** 簡単な使用法
@@ -65,8 +68,8 @@ RPGでレベル上げとかアイテムを貯めるようにして，
    :END:
 
 まずは，
-#+begin_example
-my_help                                                                          1559ms
+#+begin_src bash
+> my_help
 Commands:
   my_help delete HELP             # delete HELP
   my_help edit HELP               # edit HELP
@@ -76,17 +79,18 @@ Commands:
   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_example
+#+end_src
 としてください．このlistにNAMEやITEMを加えて行くとわかると思います．
 
-: my_help list
-: my_help list emacs
-: my_help list emacs -f
-: my_help list emacs file
+#+begin_src bash
+> my_help list
+> my_help list emacs
+> my_help list emacs -f
+> my_help list emacs file
+#+end_src
 として動かしてみてください．
 
-
-#+BEGIN_EXAMPLE
+#+begin_src bash
 - emacsのキーバインド
 - 
 特殊キー操作
@@ -107,31 +111,33 @@ Commands:
      , query_replace  : query_replace
    -r, ruby-mode      : ruby-mode
    -d, dired          : ファイラとして使う
-#+END_EXAMPLE
+#+end_src
+
+** my_helpがやっていること
+my_helpの個々のヘルプファイルは'~/.my_help'に置かれています．
+ヘルプファイルのフォーマットはEmacsのorg-modeです．
+これをEditorで叩いて編集したり，
+そこから情報を取り出したりしています．
+単にファイル操作を集約しているだけなのですが，
+これが面倒で．．．
+
 
 ** 独自のhelpを作る方法
 独自のhelpを作る方法です．まずは，
 
-: my_help new new_help
+: $ my_help new new_help
 
 で，new_helpというtemplateが用意されます．
-: my_help edit new_help
-で編集してください． emacs org形式で，格納されています．
+: $ my_help edit new_help
+で編集してください． Emacs org形式で，格納されています．
 
-: my_help delete new_help
+: $ my_help delete new_help
 
 すると消されます．
 ** editorの変更
-: my_help set_editor vim
+: $ my_help set_editor vim
 でeditorを変更できます．codeとかは確認していますが，
 それ以外で動いたり，動かなかったりを報告してください．
 
-* test
-
-以下は，開発者メモです．
-testは[[/Users/bob/github/ruby_docs/testing_frameworks/test_unit/README.org]]
-にあるのに従って書いています．
-
-「Rubyベストプラクティス」にあるmustを使ったextension
-を組み込んで，DSLにしている．
-[[https://github.com/practicingruby/rbp/blob/master/testing/test_unit_extensions.rb]]
+OS Xで'emacs'とした時にGUI版が立ち上がって嫌だという場合は，
+'emacs -nw'として下さい．

data/Rakefile

@@ -1,21 +1,32 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-require 'yard'
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.options = '-v'
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
-
-desc "make documents by yard"
+desc 'make documents by yard'
 task :yard do
-  YARD::Rake::YardocTask.new {|t|
-#    t.files=['**/*.md']
-#    t.options=['-t','mathjax']
-#    t.options=['--exclude','lib.rb','--files','**/*.org']
-  }
+  # api_output_dir = 'doc'
+  YARD::Rake::YardocTask.new do |t|
+    # t.options << '-o#{api_output_dir}' # output dir = doc_api
+    # t.files=['**/*.md']
+    t.options += ['--title', 'my_help']
+    # t.options=['--exclude','lib.rb','--files','**/*.org']
+    # see [[https://github.com/lsegal/yard/issues/66]] for the other options
+  end
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
 
+#task default: %i[test rubocop]
+task :default do
+  system "rake -T"
 end