my_help 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0721dfa53bb1f947e0b402a2ba25ecc64e8ae1ef
-  data.tar.gz: 42b4f7f2de674d2f25bc6ac875de1f38761b79c2
+  metadata.gz: 9e2f60b5bfeb690fb60b2182ed234acb124b8444
+  data.tar.gz: a02e2a5b817c8eee662b35344f761d55c898c447
 SHA512:
-  metadata.gz: 972c547476053f85b68fe8b8ad179152788a8166c6e9557eaca234d8ff5301c48c007f25aa22d346b67c3e33b85c4aef9092f523ea888006b654445aae6a8b8b
-  data.tar.gz: cdd523e517803fa58e531dba1bb629abf57e67043ca34c7d0672722590042924aa613996bf8ceebb7c0fc577afd6302ddb7fd02333680389b3bca90509562ce6
+  metadata.gz: 4efe59537649255313f6c4a9e470915c9c2b89ac464a52ca6fe13f8440ddc08f035f7f89ea3ae6ddd27ba8fe38769f399679bf67b34098b1ce1077534f32a6d6
+  data.tar.gz: d0b5cfc652c07cf6edd490ea25be41c98547916eacf4b3abd4002cefc7ed57c1c92fc706f6a99d0a108adcb2143d08f85e6e41bbed0b2394a4184c7bec08618d

data/README.md

@@ -1,53 +1,49 @@
-# Name
+# 名前
 
 my_help
 
-# Summary
-
-This gem makes and supplies user specific helps, emulating CUI(CLI) help usage.
-
-# Target
-A very novice of learning some specific operation, such as CUI, shell, or emacs,
-has difficulty in remembering commands and grammers.
-If he has a key, he can easily remember all, but no key brings nothing.
-Especially a non-English-native has strong difficulty on the key rememebering.
-The problems are,
-
-- man(ual) is English
-- man is heavily documented
-- On web, search the same key word,
-- and read the same URI repeatedly
-- 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
-  - same format, looks, operation, and hierarchy
-- easily see, read
-- supplies editing and install commands.
-
-Wiki targets the whole engineer, my_help target the 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
-
-Different from the gem standard, fork and clone from Github.
+# 概要
+
+CUI(CLI)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
+
+# 問題点
+CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は，
+commandや文法を覚えるのに苦労します．少しのkey(とっかかり)があると
+思い出すんですが，うろ覚えでは間違えて路頭に迷います．問題点は，
+- manは基本的に英語
+- manualでは重たい
+- いつもおなじことをwebで検索して
+- 同じとこ見ている
+- memoしても，どこへ置いたか忘れる
+
+などです．
+
+# 特徴
+これらをgem環境として提供しようというのが，このgemの目的です．
+仕様としては，
+- userが自分にあったmanを作成
+- 雛形を提供
+  - おなじformat, looks, 操作, 階層構造
+- すぐに手が届く
+- それらを追加・修正・削除できる
+
+hikiでやろうとしていることの半分くらいはこのあたりのことなの
+かもしれません．memoソフトでは，検索が必要となりますが，my_helpは
+key(記憶のとっかかり)を提供することが目的です．
+
+# 使用法
+## インストール
+インストールですが，gemの標準とは違ったやり方になります．GithubからForkしてcloneします．
 ```
-github.com:daddygongon/my_help.git
+git clone git@github.com:daddygongon/my_help.git
 ```
-The following operations are performed under 'bundle'.
-The main reason of this disturbance is due the developer not to know the last command of 'rake install:local' from gem environment.  
-But the second reason is the on-going project to collect and supply the good helps for novices.
-We are planning to achieve it by using 'pull request' of Github.
+あとの作業はbundleを使って行います．
+
+これは，最後のrake install:localをコマンドから実行する方法がわからんかったからですが．．．
+- helpファイルのpush共有とかも考えるとこれがいいのかも．
+- home以下に置く方法と比較分析してください．
 
-Supplied commands are
+用意されているコマンドは，
 
 ```
 bob%  bundle exec exe/my_help
@@ -57,9 +53,9 @@ Usage: my_help [options]
     -e, --edit NAME                  NAME(例：test_help)をEdit編集.
     -i, --init NAME                  NAME(例：test_help)のtemplateを作成.
     -m, --make                       make and install:local all helps.
+    -c, --clean                      clean up exe dir.
 ```
-
-At first, see the list of supplied helps by the option of -l.
+です．まず，-lでdefaultで入っているリストを見てください．
 
 ```
 bob%  bundle exec exe/my_help -l
@@ -69,12 +65,10 @@ Specific help file:
   emacs_help
   test_help
 ```
-emacs_help, e_h, test_help, t_h are ready to use.
-Play them by a command such as 'bundle exec exe/e_h'.
+これで，CUIでemacs_help, e_h, test_help, t_hが用意されています．少し振る舞いに慣れてください．
 
-## Make own help
-The next step is making own help.  
-For this, -i NAME supplies new NAME help.
+## 独自のhelpを作る方法
+さて，独自のhelpを作る方法です．まずは，
 
 ```
 bob%  bundle exec exe/my_help -i new_help
@@ -85,18 +79,130 @@ bob%  bundle exec exe/my_help -i new_help
 cp /usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/my_help/template_help 
   /usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon/new_help
 ```
-it makes get ready the template of new_help in daddygongon dir.
-Edit it by -e new_help.
-Then -m make new_help and n_h in exe directory.
-
-## Activate own help
-For the last step, at the my_help directory, put the commands in as follows:
+で，new_helpというtemplateが用意されます．-e new_helpで編集してください．そのあと，-mすると自動でnew_helpがexeディレクトリーに追加されます．
 
+## 独自helpを使えるように
+最後，my_helpのdirectoryで
 ```
  git add -A
  git commit -m 'add new help'
  rake install:local
 ```
+してください．
+
+これで終わり．new_helpや短縮形のn_hでhelpが使えます．
+もし使えないときは，bin pathが通ってないので，terminalをnewしてください．
 
-That's it. You can use the new_help or short command of n_h on CUI.
-If not, restart the terminal to load the bin path.
+# userの独自helpの達成方法
+(rake my_helpでやっていたが，今は，my_help -mに移行)
+
+exe中のファイルをrakeで自動生成．
+./lib/daddygongon/にそれらのdataを保存．以下ではその名前から
+exe中に実行ファイルを自動生成させている．
+```
+lib/daddygongon/
+└── emacs_help
+
+exe
+├── e_h
+└── emacs_help
+```
+ということ．これは，
+```
+rake my_help
+```
+で実行される．これを
+```
+rake install:local
+```
+すれば必要とするhelpがlocalな環境で表示される．
+
+たくさんの実行ファイルを/usr/loca/binに置くことになるので，
+```
+gem uninstall my_help
+gem uninstall emacs_help
+```
+でそこをcleanにしておくことが望ましい．
+
+Rakefileの中身は以下の通り．
+```
+in Rakefile
+```
+
+```ruby
+desc "make own help from lib/daddygongon/files"
+task :my_help do
+  exe_cont="#!/usr/bin/env ruby\n"
+  user_name = 'daddygongon'
+  p entries=Dir.entries(File.join('.','lib',user_name))[2..-1]
+  entries.each{|file|
+    p file
+    p file_name=file.split('_')
+    target_files = [file, file_name[0][0]+"_"+file_name[1][0]]
+    p cont_name = File.join('lib',user_name,file)
+    exe_cont << "require 'my_help'\n"
+    exe_cont << "help_file = File.expand_path(\"../../#{cont_name}\", __FILE__)\n"
+    exe_cont << "MyHelp::Command.run(help_file, ARGV)\n"
+    target_files.each{|name|
+      p ''
+      p target=File.join('exe',name)
+      File.open(target,'w'){|file|
+        print exe_cont
+        file.print exe_cont
+      }
+      FileUtils.chmod('a+x', target, :verbose => true)
+    }
+  }
+end
+```
+
+実装方法は，emacs_helpに
+
+1. yaml形式でdataを入れ，command.runの入力ファイルとする
+1. hush形式でdataをいれ，それをrequireして使う
+
+かのどちらかで実装．speedとかdebugを比較・検証する必要あり．
+今の所，No.1の方を実装．No.2のためのhushデータは，
+
+```ruby
+require 'yaml'
+require 'pp'
+
+pp YAML.load(File.read(ARGV[0]))
+```
+
+```
+ruby test.rb lib/daddygongon/emacs_help
+```
+
+で構築できる．実装してみて．
+
+
+# どちらがいいか
+Rubyで日本語が使えるから，optionsを日本語にしてみた．
+```
+Usage: eh [options]
+    -v, --version                    show program Version.
+    -c, --カーソル                       Cursor移動
+    -p, --ページ                        Page移動
+    -f, --ファイル                       File操作
+    -e, --編集                         Edit操作
+    -w, --ウィンドウ                      Window操作
+    -b, --バッファ                       Buffer操作
+    -q, --終了                         終了操作
+```
+半角，全角がoptparseでは適切に判断できない様で，表示があまり揃っていない．
+しかし，初心者の振る舞いを見ているとわざわざ日本語に切り替えて打ち込むことは稀であり，
+key wordをhelpで参照してshort optionで入力している．そこで，
+```
+Usage: eh [options]
+    -v, --version      show program Version.
+    -c, --cursor       カーソル移動
+    -p, --page         ページ移動
+    -f, --file         ファイル操作
+    -e, --edit         編集操作
+    -w, --window       ウィンドウ操作
+    -b, --buffer       バッファ操作
+    -q, --quit         終了操作
+```
+としたほうがいいと提案する．アンケートを実施してみてほしい．

data/README_en.md

@@ -0,0 +1,102 @@
+# Name
+
+my_help
+
+# Summary
+
+This gem makes and supplies user specific helps, emulating CUI(CLI) help usage.
+
+# Target
+A very novice of learning some specific operation, such as CUI, shell, or emacs,
+has difficulty in remembering commands and grammers.
+If he has a key, he can easily remember all, but no key brings nothing.
+Especially a non-English-native has strong difficulty on the key rememebering.
+The problems are,
+
+- man(ual) is English
+- man is heavily documented
+- On web, search the same key word,
+- and read the same URI repeatedly
+- 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
+  - same format, looks, operation, and hierarchy
+- easily see, read
+- supplies editing and install commands.
+
+Wiki targets the whole engineer, my_help target the 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
+
+Different from the gem standard, fork and clone from Github.
+```
+github.com:daddygongon/my_help.git
+```
+The following operations are performed under 'bundle'.
+The main reason of this disturbance is due the developer not to know the last command of 'rake install:local' from gem environment.  
+But the second reason is the on-going project to collect and supply the good helps for novices.
+We are planning to achieve it by using 'pull request' of Github.
+
+Supplied commands are
+
+```
+bob%  bundle exec exe/my_help
+Usage: my_help [options]
+    -v, --version                    show program Version.
+    -l, --list                       個別(specific)ヘルプのList表示.
+    -e, --edit NAME                  NAME(例：test_help)をEdit編集.
+    -i, --init NAME                  NAME(例：test_help)のtemplateを作成.
+    -m, --make                       make and install:local all helps.
+```
+
+At first, see the list of supplied helps by the option of -l.
+
+```
+bob%  bundle exec exe/my_help -l
+"/usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon"
+["-l"]
+Specific help file:
+  emacs_help
+  test_help
+```
+emacs_help, e_h, test_help, t_h are ready to use.
+Play them by a command such as 'bundle exec exe/e_h'.
+
+## Make own help
+The next step is making own help.  
+For this, -i NAME supplies new NAME help.
+
+```
+bob%  bundle exec exe/my_help -i new_help
+"/usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon"
+["-i", "new_help"]
+"/usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon/new_help"
+"/usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/my_help/template_help"
+cp /usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/my_help/template_help 
+  /usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon/new_help
+```
+it makes get ready the template of new_help in daddygongon dir.
+Edit it by -e new_help.
+Then -m make new_help and n_h in exe directory.
+
+## Activate own help
+For the last step, at the my_help directory, put the commands in as follows:
+
+```
+ git add -A
+ git commit -m 'add new help'
+ rake install:local
+```
+
+That's it. You can use the new_help or short command of n_h on CUI.
+If not, restart the terminal to load the bin path.

data/Rakefile

@@ -72,3 +72,17 @@ task :my_help do
     }
   }
 end
+
+desc "make hiki documents"
+task :mk_hiki do
+  p entries=Dir.entries(File.join('.','hikis'))[2..-1]
+  hiki_dir='/Users/bob/Sites/nishitani0/Internal/data/text'
+  entries.each{|file|
+    next if file[0]=='#' or file[-1]=='~'
+    p src=File.join('.','hikis',file)
+    p file_name='MyHelp_'+File.basename(file,'.hiki')
+    p des=File.join(hiki_dir,file_name)
+    FileUtils::Verbose.cp(src,des)
+    FileUtils::Verbose.chmod('a+w',des)
+  }
+end

data/exe/#emacs_help#

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'specific_help'
+
+help_file = '/Users/bob/MultiScaleModeling/2016/my_help/lib/daddygongon/emacs_help'
+SpecificHelp::Command.run(help_file, ARGV)

data/exe/e_h

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require 'specific_help'
-help_file = '/Users/bob/Github/my_help/lib/daddygongon/emacs_help'
+target_dir = File.expand_path("../../lib/daddygongon", __FILE__)
+help_file = File.join(target_dir,'emacs_help')
 SpecificHelp::Command.run(help_file, ARGV)

data/exe/emacs_help

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require 'specific_help'
-help_file = '/Users/bob/Github/my_help/lib/daddygongon/emacs_help'
+target_dir = File.expand_path("../../lib/daddygongon", __FILE__)
+help_file = File.join(target_dir,'emacs_help')
 SpecificHelp::Command.run(help_file, ARGV)

data/exe/my_help

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-
 require "my_help"
+
 MyHelp::Command.run(ARGV)

data/exe/t_h

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require 'specific_help'
-help_file = '/Users/bob/Github/my_help/lib/daddygongon/test_help'
+target_dir = File.expand_path("../../lib/daddygongon", __FILE__)
+help_file = File.join(target_dir,'test_help')
 SpecificHelp::Command.run(help_file, ARGV)

data/exe/test_help

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require 'specific_help'
-help_file = '/Users/bob/Github/my_help/lib/daddygongon/test_help'
+target_dir = File.expand_path("../../lib/daddygongon", __FILE__)
+help_file = File.join(target_dir,'test_help')
 SpecificHelp::Command.run(help_file, ARGV)

data/hikis/README_ja.hiki

@@ -35,7 +35,11 @@ key(記憶のとっかかり)を提供することが目的です．
 !!インストール
 インストールですが，gemの標準とは違ったやり方になります．GithubからForkしてcloneします．
  git clone git@github.com:daddygongon/my_help.git
-あとの作業はbundleを使って行います．これは，最後のrake install:localをコマンドから実行する方法がわからんかったからですが．．．helpファイルのpush共有とかも考えるとこれがいいのかも．
+あとの作業はbundleを使って行います．
+
+これは，最後のrake install:localをコマンドから実行する方法がわからんかったからですが．．．
+* helpファイルのpush共有とかも考えるとこれがいいのかも．
+* home以下に置く方法と比較分析してください．
 
 用意されているコマンドは，
 

data/lib/my_help/version.rb

@@ -1,3 +1,3 @@
 module MyHelp
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/my_help.rb

@@ -15,8 +15,7 @@ module MyHelp
 
     def initialize(argv=[])
       @argv = argv
-      p @target_dir = File.expand_path("../../lib/daddygongon", __FILE__)
-      p @argv
+      @target_dir = File.expand_path("../../lib/daddygongon", __FILE__)
     end
 
     def execute
@@ -40,39 +39,32 @@ module MyHelp
       exit
     end
 
+    def short_name(file)
+      file_name=file.split('_')
+      return file_name[0][0]+"_"+file_name[1][0]
+    end
+
     def make_help
-      p entries=Dir.entries(@target_dir)[2..-1]
-      entries.each{|file|
-        p file
+      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"
-        p file_name=file.split('_')
-        target_files = [file, file_name[0][0]+"_"+file_name[1][0]]
-        target = File.join(@target_dir,file)
-        exe_cont << "help_file = '#{target}'\n"
+#        exe_cont << "help_file = '#{File.join(@target_dir,file)}'\n"
+#        exe_cont << @target_dir
+        exe_cont << 'target_dir = File.expand_path("../../lib/daddygongon", __FILE__)'+"\n"
+        exe_cont << "help_file = File.join(target_dir,'#{file}')\n"
         exe_cont << "SpecificHelp::Command.run(help_file, ARGV)\n"
-        target_files.each{|name|
-          print "\n"
+        [file, short_name(file)].each{|name|
           p target=File.join('exe',name)
-          File.open(target,'w'){|file|
-            print exe_cont
-            file.print exe_cont
-          }
+          File.open(target,'w'){|file| file.print exe_cont}
           FileUtils.chmod('a+x', target, :verbose => true)
         }
       }
     end
 
     def clean_exe
-      p entries=Dir.entries(@target_dir)[2..-1]
-      entries.each{|file|
-        p file
+      Dir.entries(@target_dir)[2..-1].each{|file|
         next if file[0]=='#' or file[-1]=='~'
-        p file_name=file.split('_')
-        target_files = [file, file_name[0][0]+"_"+file_name[1][0]]
-        target = File.join(@target_dir,file)
-        target_files.each{|name|
-          print "\n"
+        [file, short_name(file)].each{|name|
           p target=File.join('exe',name)
           FileUtils::Verbose.rm(target)
         }

data/my_help.wiki/Home.md

@@ -37,7 +37,11 @@ key(記憶のとっかかり)を提供することが目的です．
 ```
 git clone git@github.com:daddygongon/my_help.git
 ```
-あとの作業はbundleを使って行います．これは，最後のrake install:localをコマンドから実行する方法がわからんかったからですが．．．helpファイルのpush共有とかも考えるとこれがいいのかも．
+あとの作業はbundleを使って行います．
+
+これは，最後のrake install:localをコマンドから実行する方法がわからんかったからですが．．．
+- helpファイルのpush共有とかも考えるとこれがいいのかも．
+- home以下に置く方法と比較分析してください．
 
 用意されているコマンドは，
 

data/my_help.wiki/README_ja.md

@@ -37,7 +37,11 @@ key(記憶のとっかかり)を提供することが目的です．
 ```
 git clone git@github.com:daddygongon/my_help.git
 ```
-あとの作業はbundleを使って行います．これは，最後のrake install:localをコマンドから実行する方法がわからんかったからですが．．．helpファイルのpush共有とかも考えるとこれがいいのかも．
+あとの作業はbundleを使って行います．
+
+これは，最後のrake install:localをコマンドから実行する方法がわからんかったからですが．．．
+- helpファイルのpush共有とかも考えるとこれがいいのかも．
+- home以下に置く方法と比較分析してください．
 
 用意されているコマンドは，
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_help
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Shigeto R. Nishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-29 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,6 +112,7 @@ description: Emulating CUI(CLI) help, an user makes and displays his own helps.
 email:
 - shigeto_nishitani@me.com
 executables:
+- "#emacs_help#"
 - e_h
 - emacs_help
 - my_help
@@ -127,9 +128,11 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- README_en.md
 - Rakefile
 - bin/console
 - bin/setup
+- exe/#emacs_help#
 - exe/e_h
 - exe/emacs_help
 - exe/my_help