my_help 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c13f6d7b2fd61e64e2722bde2a1c0f0d49aa59af
-  data.tar.gz: db0c737b6266ee5e8ffef2d2b2cddaad35c31140
+  metadata.gz: 7d034615843f2ce0ae8ca406736a276595f02489
+  data.tar.gz: a6068a28a01c640c442f427369c77f030b9cb400
 SHA512:
-  metadata.gz: 309261c3ecc2e6a86fa25fe890a122738150812006f8380c5a39d46beab18324ef3b16982425251ef60562e4f583704f28839986df1dfb37c128461d7a0527ff
-  data.tar.gz: 714e9fb5f2771eb1305d57b3eb61501a9e9149220c9f9966dab4770c8e5b8f4db5052d45ea9d7d249cfbe420ebad460bd7ee90bbc02a8903a4a34a886e5f0e2b
+  metadata.gz: 98b472efcaf1106fd365d7bc2017b0c48c41e182c9bf0ca5f73a03a6e5152b56b2bf4c8a814a8c0701898b1b8f5dd99ce3514b72d51049b572d088ea053bbb34
+  data.tar.gz: b122d71ae12ab654c3079aa09404f451aff465bc6cc8ec8ad95007e5fc1a86a1cd20916183d8d77fc21c079bd7af3b4169b3a7fd334a8ce098edc994817e364f

data/.gitignore

@@ -1,37 +1,11 @@
-
-# コメントは `#'
-
-# .svn フォルダ
-# ディレクトリは最後にスラッシュ
-.svn/
-
-# vim のバックアップファイル
-# * は展開される
-*.swp
-
-# /tmp のように '/' から始めれば
-# カレントディレクトリの tmp のみ無視
-# /hoge/tmp などは無視されない
 /tmp
-.ipynb_checkpoints/
 .DS_Store
 /.bundle/
-.yardoc/
-/Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
-/docs/
 /pkg/
-/spec/reports/
-/tmp/
 *~
 \#*
 
 Dockerfile
 
-# $ git rm -r --cached .
-# $ git add .
-# $ git commit -m ".gitignore is now working"
-# $ git push origin master
-

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    my_help (0.6.1)
+      colorize
+      systemu
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.14.5)
+      childprocess (>= 0.6.3, < 0.10.0)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    backports (3.11.1)
+    builder (3.2.3)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    colorize (0.8.1)
+    contracts (0.16.0)
+    cucumber (3.1.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.1.0)
+      cucumber-expressions (~> 5.0.4)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.1.0)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (>= 5.0.0)
+    cucumber-expressions (5.0.13)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    ffi (1.9.23)
+    gherkin (5.0.0)
+    multi_json (1.13.1)
+    multi_test (0.1.2)
+    rake (10.5.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    systemu (2.6.5)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 0.14.2)
+  bundler (~> 1.11)
+  my_help!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/README.org

@@ -6,7 +6,7 @@
   :CUSTOM_ID: 概要
   :END:
 
-CUI(CLI)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
+CUI(CLA)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
 
 * (my_helpで解決しようとする)問題点
   :PROPERTIES:
@@ -28,7 +28,7 @@ commandや文法を覚えるのに苦労します．少しのkey(とっかかり
   :CUSTOM_ID: 特徴
   :END:
 
-これらをgem環境として提供しようというのが，このgemの目的です．
+これらをCLA環境として提供しようというのが，このgemの目的です．
 仕様としては， 
 - userが自分にあったmanを作成 
 - 雛形を提供 
@@ -36,8 +36,7 @@ commandや文法を覚えるのに苦労します．少しのkey(とっかかり
 - すぐに手が届く 
 - それらを追加・修正・削除できる
 
-hikiでやろうとしていることの半分くらいはこのあたりのことなの
-かもしれません．memoソフトでは，検索が必要となりますが，my_helpは
+memoソフトでは，検索が必要となりますが，my_helpは
 key(記憶のとっかかり)を提供することが目的です．
 RPGでレベル上げとかアイテムを貯めるようにして，
 プログラミングでスキルを発展させてください．
@@ -48,81 +47,49 @@ RPGでレベル上げとかアイテムを貯めるようにして，
   :PROPERTIES:
   :CUSTOM_ID: 使用法
   :END:
+** インストール
+
+: $ gem install my_help
+です． installがうまくいくと，defaultでmy_help, my_todo, emacs_help, org_helpが入ります．
 
 ** 簡単な使用法
    :PROPERTIES:
    :CUSTOM_ID: 簡単な使用法
    :END:
 
-#+BEGIN_QUOTE
-  $ gem install my_help
-#+END_QUOTE
-
-でも installがうまくいくと，defaultでmy_help, my_todo,
-emacs_helpが入ります．
-
 emacs_helpを動かしてみてください．
 
+
 #+BEGIN_EXAMPLE
-    emacsのキーバインド
-
-    特殊キー操作
-      c-f, controlキーを押しながら    'f'
-      M-f, escキーを押した後一度離して'f'
-        操作の中断c-g, 操作の取り消し(Undo) c-x u
-         cc by Shigeto R. Nishitani, 2016
-    Usage: e_h [options]
-        -v, --version                    show program Version.
-        -c, --cursor                     Cursor移動
-        -e, --編集                         Edit操作
-        -f, --ファイル                       File操作
-        -q, --終了                         終了操作
-        -p, --ページ                        Page移動
-        -w, --ウィンドウ                      Window操作
-        -b, --バッファ                       Buffer操作
-        -m, --mode                       モード切り替え
-            --edit                       edit help contents
-            --to_hiki                    convert to hikidoc format
-            --all                        display all helps
-            --store [item]               store [item] in back
-            --remove [item]              remove [item] in back
-            --add [item]                 add new [item]
+- emacsのキーバインド
+- 
+特殊キー操作
+-   C-f, controlキーを押しながら    'f'
+-   M-f, escキーを押した後一度離して'f'
+-     操作の中断C-g, 操作の取り消し(Undo) C-x u
+-      cc by Shigeto R. Nishitani, 2016
+Usage: emacs_help [options]
+    -v, --version                    show program Version.
+    -c, --cursor                     cursor
+    -e                               edit
+    -s, --short_cut                  short_cut
+    -f, --file                       file
+        --quit                       quit
+    -p, --page                       page
+    -w, --window                     window
+    -b, --buffer                     buffer
+    -m, --mode                       mode
+    -q, --query_replace              query_replace
+    -r, --ruby-mode                  ruby-mode
+    -d, --dired                      dired
+        --edit                       edit help contents
+        --all                        display all helps
+        --store [item]               store [item] in backfile
+        --remove [item]              remove [item] and store in backfile
+        --add [item]                 add new [item]
+        --backup_list [val]          show last [val] backup list
 #+END_EXAMPLE
 
-** インストール
-   :PROPERTIES:
-   :CUSTOM_ID: インストール
-   :END:
-
-インストールですが，gemの標準とは違ったやり方になります．GithubからForkしてcloneします．
->$ git clone git@github.com:daddygongon/my_help.git
-
-あとの作業はbundleを使って行います．
-
-これは，最後のrake
-install:localをコマンドから実行する方法がわからんかったからですが．．．
-- helpファイルのpush共有とかも考えるとこれがいいのかも． -
-home以下に置く方法と比較分析してください． -
-lib/daddygongonにあたらしいhelpを置くようにしていましたが，helpに個人情報を入れるとgit
-pushでさらしてしまうので，やめました．
-
-まずは，
-
-#+BEGIN_QUOTE
-  $ bundle update
-#+END_QUOTE
-
-でmy_help.gemspecに記述されている必要なgemsがbundleされます．
-
-Could not locate
-Gemfileとエラーが出た場合は、Gemfileのある場所を探し、その配下に移動してから再びコマンドを入力する．
-
-用意されているコマンドは，
-
-#+BEGIN_QUOTE
-  $ bundle exec exe/my_help
-#+END_QUOTE
-
 #+BEGIN_EXAMPLE
     Usage: my_help [options]
         -v, --version                    show program Version.
@@ -136,20 +103,6 @@ Gemfileとエラーが出た場合は、Gemfileのある場所を探し、その
 #+END_EXAMPLE
 
 です．まず，-lでdefaultで入っているリストを見てください．
-
-#+BEGIN_QUOTE
-  $ bundle exec exe/my_help -l
-#+END_QUOTE
-
-#+BEGIN_EXAMPLE
-    "/usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon"
-    ["-l"]
-    Specific help file:
-      emacs_help
-#+END_EXAMPLE
-
-これで，CUIでemacs_help, e_hが用意されています．
-これをいじって挙動に馴染んでください．
 --addとか--editとかで，要素の追加や編集ができます．
 
 ** alpine linuxのためのDockerfile
@@ -197,66 +150,18 @@ linux上で動作させるため、以下のDockerfileを作成しました。
 
 さて，独自のhelpを作る方法です．まずは，
 
-#+BEGIN_QUOTE
-  $ bundle exec exe/my_help -i new_help
-#+END_QUOTE
-
-"/Users/bob/.my_help/new_help"
-"/Users/bob/Github/my_help/lib/daddygongon/template_help"
-
-#+BEGIN_QUOTE
-  $ cp /Users/bob/Github/my_help/lib/daddygongon/template_help
-  /Users/bob/.my_help/new_help
-#+END_QUOTE
+: my_help -i new_help
 
 で，new_helpというtemplateが用意されます．-e
-new_helpで編集してください． YAML形式で，格納されています．サンプルが，
-
-#+BEGIN_EXAMPLE
-    my_help/lib/daddygongon
-#+END_EXAMPLE
+new_helpで編集してください． emacs org形式で，格納されています．サンプルが，
 
 にあります．このあと，-mすると自動でnew_helpがexeディレクトリーに追加されます．
 
-** 独自helpを使えるように
-   :PROPERTIES:
-   :CUSTOM_ID: 独自helpを使えるように
-   :END:
-
-これは，
-
-#+BEGIN_QUOTE
-  $ bundle exec exe/my_help -m
-#+END_QUOTE
-
-で自動的に行われるように修正しましたが，gem環境によっては正常にinstallできません．その場合は，以下にしたがって，手動で/usr/local/binなどにinstallする必要があります．my_helpのdirectoryで
-
-#+BEGIN_QUOTE
-  $ git add -A
-#+END_QUOTE
-
-#+BEGIN_QUOTE
-  $ git commit -m 'add new help'
-#+END_QUOTE
-
-#+BEGIN_QUOTE
-  $ rake install:local
-#+END_QUOTE
-
-してください．さらにlocalへのinstallにはsudoがいるかもしれませ．
-
-これで終わり．new_helpや短縮形のn_hでhelpが使えます．
-もし使えないときは，bin
-pathが通ってないので，terminalをnewしてください．
-
 * userの独自helpの達成方法
   :PROPERTIES:
   :CUSTOM_ID: userの独自helpの達成方法
   :END:
 
--  rake my_helpでやっていたが，今は，my_help -mに移行
--  @target dirをmy_help/lib/daddygongonからENV['HOME']/.my_helpに変更
-
 exe中のファイルをrakeで自動生成． @target_dirにそれらのdataを保存．
 その名前からexe中に実行ファイルを自動生成させている．
 
@@ -271,146 +176,24 @@ exe中のファイルをrakeで自動生成． @target_dirにそれらのdataを
 
 ということ．これは，
 
-#+BEGIN_QUOTE
-  $ my_help -m
-#+END_QUOTE
-
-で実行される．これを
-
-#+BEGIN_QUOTE
-  $ rake install:local
-#+END_QUOTE
+: my_help -m
+で実行される．
 
-すれば必要とするhelpがlocalな環境でbin dirに移され，CUI
-commandとして実行可能になる．
+たくさんの実行ファイルをgemのINSTALLATION DIRに置くことになるので，あらたなmy_helpを作成するときには
 
-たくさんの実行ファイルを/usr/loca/binに置くことになるので，あらたなmy_helpを作成するときには
-
-#+BEGIN_QUOTE
-  $ gem uninstall my_help
-#+END_QUOTE
-
-#+BEGIN_QUOTE
-  $ gem uninstall emacs_help
-#+END_QUOTE
+: gem uninstall my_help
 
 でそのdirをcleanにしておくことが望ましい．下のuninstallの項目を参照．
 
--mでやっている中身は以下の通り．
-
-#+BEGIN_SRC ruby
-        def make_help
-          Dir.entries(@target_dir)[2..-1].each{|file|
-            next if file[0]=='#' or file[-1]=='~'
-            exe_cont="#!/usr/bin/env ruby\nrequire 'specific_help'\n"
-            exe_cont << "help_file = File.join(ENV['HOME'],'.my_help','#{file}')\n"
-            exe_cont << "SpecificHelp::Command.run(help_file, ARGV)\n"
-            [file, short_name(file)].each{|name|
-              p target=File.join('exe',name)
-              File.open(target,'w'){|file| file.print exe_cont}
-              FileUtils.chmod('a+x', target, :verbose => true)
-            }
-          }
-          install_local
-        end
-
-        def install_local
-          #中略
-          system "git add -A"
-          system "git commit -m 'update exe dirs'"
-          system "Rake install:local"
-        end
-#+END_SRC
-
-実装方法は，emacs_helpに
-
-1. yaml形式でdataを入れ，command.runの入力ファイルとする
-2. hush形式でdataをいれ，それをrequireして使う
-
-かのどちらかで実装．speedとかdebugを比較・検証する必要あり．
-今の所，No.1の方を実装．No.2のためのhushデータは，
-
-#+BEGIN_SRC ruby
-    # -*- coding: utf-8 -*-
-    require 'yaml'
-    require 'pp'
-    yaml =<<EOF
-    :file:
-      :opts:
-        :short: "-f"
-      :cont:
-      - c-x c-f, Find file, ファイルを開く
-      - c-x c-s, Save file, ファイルを保存
-    EOF
-    pp data=YAML.load(yaml)
-    print YAML.dump(data)
-
-
-    data0={:file=>
-      {:opts=>{:short=>"-f", :long=>"--ファイル", :desc=>"File操作"},
-       :title=>"ファイル操作file",
-       :cont=>
-        ["c-x c-f, Find file, ファイルを開く
-         c-x c-s, Save file, ファイルを保存
-         c-x c-w, Write file NAME, ファイルを別名で書き込む"]}}
-
-    print YAML.dump(data0)
-#+END_SRC
-
-#+BEGIN_EXAMPLE
-    ruby test.rb lib/daddygongon/emacs_help
-#+END_EXAMPLE
-
-で構築できる．実装してみて．
-
-* どちらがいいか
-  :PROPERTIES:
-  :CUSTOM_ID: どちらがいいか
-  :END:
-
-Rubyで日本語が使えるから，optionsを日本語にしてみた．
-
-#+BEGIN_EXAMPLE
-    Usage: eh [options]
-        -v, --version                    show program Version.
-        -c, --カーソル                       Cursor移動
-        -p, --ページ                        Page移動
-        -f, --ファイル                       File操作
-        -e, --編集                         Edit操作
-        -w, --ウィンドウ                      Window操作
-        -b, --バッファ                       Buffer操作
-        -q, --終了                         終了操作
-#+END_EXAMPLE
-
-半角，全角がoptparseでは適切に判断できない様で，表示があまり揃っていない．
-しかし，初心者の振る舞いを見ているとわざわざ日本語に切り替えて打ち込むことは稀であり，
-key wordをhelpで参照してshort optionで入力している．そこで，
-
-#+BEGIN_EXAMPLE
-    Usage: eh [options]
-        -v, --version      show program Version.
-        -c, --cursor       カーソル移動
-        -p, --page         ページ移動
-        -f, --file         ファイル操作
-        -e, --edit         編集操作
-        -w, --window       ウィンドウ操作
-        -b, --buffer       バッファ操作
-        -q, --quit         終了操作
-#+END_EXAMPLE
-
-としたほうがいいと提案する．アンケートを実施してみてほしい．
-
 * uninstall
   :PROPERTIES:
   :CUSTOM_ID: uninstall
   :END:
 
 my_help -mでinstallするとEXECUTABLE DIRECTORYにhelpのexec
-filesが自動で追加される． ~/.my_helpを修正したときには，あらかじめ
+filesが自動で追加される． ~/.my_helpを手で修正したときには，あらかじめ
 
-#+BEGIN_QUOTE
-  $ gem unistall my_help
-#+END_QUOTE
+: unistall my_help
 
 でそれらをuninstallしておくと良い．
 
@@ -451,33 +234,3 @@ Removing new_help Removing r_h Removing ruby_help Removing t_h
 Removing template_help Successfully uninstalled my_help-0.3.2 ```
 #+END_QUOTE
 
-* Rakefile 
-
-幾つかの環境設定用のtoolがRakefileに用意されている．
-
-#+BEGIN_EXAMPLE
-  # add .yml mode on ~/.emacs.d/init.el
-  $ rake add_yml
-  # clean up exe dir
-  $ rake clean_exe
-  # add .yml on all help files
-  $ rake to_yml
-#+END_EXAMPLE
-
-- add_yml, to_ymlは3.6から4.0へ移行する時に行ったhelpファイルの拡張子変更，
-- 3.6では拡張子なしで4.0では'.yml'，に対する対応のために用意したツール．
-- add_ymlは~/.my_help/*_helpファイルを全て~/.my_help/*_help.ymlに変える．
-- to_ymlは~/.emacs.d/init.elに'.yml'の設定が書き込まれていない時，ruby-modeでemacsを起動するsciptを埋め込む．
-
-clean_exeは，githubへuploadする時に，開発者個人のexeファイルをrmして整頓する．
-* development memo
-** <2018-03-14 Wed>全てをorgへ変更．
-どこにメモを置いたか忘れた．
-
-今は，元データのフォーマットとしてorgとyamlが混ざっている．
-編集に慣れてくると，orgのほうが柔軟性があって良さそう．
-codeはそのためグタグタ．そのうちに治るでしょう．
-yamlのhead, licenseを別扱いにしているのが原因．
-全部，orgにした方が良さそうな気がしてきた．．．
-data, codeが綺麗だし，今後のorgへの移行を考えると正しそう．．．
-