my_help 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c85de893d1ac9d563a5de5fcd1ec127843e5a9c
-  data.tar.gz: 2e852f2c0f9db2f5dc8e39c53a18a4abad832281
+  metadata.gz: de61e9adad0db138c4d95c42f55c97af928af92e
+  data.tar.gz: 7edc1a0e052ff7a02eb9bb989a5d9c2ec34fa5ac
 SHA512:
-  metadata.gz: fcf3d32664f69135c8c59cdf360964e8cea96e6c0a74c02144a4e2a077a4c8d009a61779b4380266d92d6301f990702f764f8977dd89fa1418c7ae536ea3cae2
-  data.tar.gz: b606ba8b83ba316b9011ca3d25a907096f166381c006f4cd5e9ab5dce40d10c5a175abdda76c228dbcb283975ad6a039a56a577c89ae34a8e1d461900e363a19
+  metadata.gz: 1a8d9ddf15544917402ea9f43d5bfdb7ffd2141d3499888b4e37cdaff7943851c133fd8d574ab358eb2449c957a276ddabc03188b2d68433a43e89515ae04502
+  data.tar.gz: 54b905efdb5a76474595de06c83db99216b3d94e4baeedb7356ec99dadbeb01f096248ca1e4050cbfaa8e73ec614c8da86b0670a1e28f3a57fd4e633b82b5fd2

data/exe/r_h

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'specific_help'
+target_dir = File.join(ENV['HOME'],'.my_help')
+help_file = File.join(target_dir,'ruby_help')
+SpecificHelp::Command.run(help_file, ARGV)

data/exe/ruby_help

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'specific_help'
+target_dir = File.join(ENV['HOME'],'.my_help')
+help_file = File.join(target_dir,'ruby_help')
+SpecificHelp::Command.run(help_file, ARGV)

data/hikis/emacs_help.hiki

@@ -0,0 +1,51 @@
+<<<
+  
+特殊キー操作
+    c-f, controlキーを押しながら    'f'
+    M-f, escキーを押した後一度離して'f'
+      操作の中断c-g, 操作の取り消し(Undo) c-x u 
+
+カーソル移動cursor
+  c-f, move Forwrard,    前or右へ
+  c-b, move Backwrard,   後or左へ
+  c-a, go Ahead of line, 行頭へ
+  c-e, go End of line,   行末へ
+  c-n, move Next line,   次行へ
+  c-p, move Previous line, 前行へ
+
+ページ移動page
+  c-v, move Vertical,          次のページへ
+  M-v, move reversive Vertical,前のページへ
+  c-l, centerise Line,       現在行を中心に
+  M-<, move Top of file,    ファイルの先頭へ
+  M->, move Bottom of file, ファイルの最後尾へ
+
+ファイル操作file
+  c-x c-f, Find file, ファイルを開く
+  c-x c-s, Save file, ファイルを保存
+  c-x c-w, Write file NAME, ファイルを別名で書き込む
+
+編集操作editor
+  c-d, Delete char, 一字削除
+  c-k, Kill line,   一行抹消，カット
+  c-y, Yank,        ペースト
+  c-w, Kill region, 領域抹消，カット
+  領域選択は，先頭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
+  c-x 2, 2 windows, 二つに分割
+  c-x 1, 1 windows, 一つに戻す
+  c-x 3, 3rd window sep,縦線分割
+  c-x o, Other windows, 次の画面へ移動
+
+バッファー操作buffer(すでにopenしてemacsにバッファーされたfile)
+  c-x b, show Buffer,   バッファのリスト
+  c-x c-b, next Buffer, 次のバッファへ移動
+
+終了操作quit
+  c-x c-c, Quit emacs, ファイルを保存して終了
+  c-z, suspend emacs,  一時停止，fgで復活
+>>>

data/hikis/test_help.hiki

@@ -0,0 +1,47 @@
+!template_helpの出力結果
+
+<<<
+  ヘルプのサンプル雛形.
+    headに常に表示される内容を記述.
+
+単元
+  c-f, move Forwrard,    前or右へ
+  フォーマットは自由です.
+
+単元2
+  c-f, move Forwrard,    前or右へ
+  フォーマットは自由です.
+>>>
+
+!template_helpの中身
+helpの実態は~/.my_helpに保存されたYAML形式のfileです．書き方はコメントを参照ください．
+
+<<< yaml
+---
+#start header, which appears every time.
+:head:         #never change
+- "ヘルプのサンプル雛形.\n"  #describe the contents breafly.
+- "  headに常に表示される内容を記述.\n" #head '- ' is necessary
+
+# start the first item
+:item:         #change snake word
+  :opts:          #never change
+    :short: "-i"      #change short option
+    :long: "--item"   #change long option
+    :desc: 単元(item) #describe what for in help list
+  :title: "\n単元\n"  #describe what for in each help
+  :cont:              #the following lines are appeared.
+  - c-f, move Forwrard,    前or右へ  #top '  - ' are necessary for yaml format
+  - フォーマットは自由です. 
+
+# start the second item... and so on.
+:item2: 
+  :opts: 
+    :short: "-j" 
+    :long: "--item2"
+    :desc: 単元2(item2)
+  :title: "\n単元2\n"
+  :cont:
+  - c-f, move Forwrard,    前or右へ
+  - フォーマットは自由です. 
+>>>

data/lib/daddygongon/emacs_help

@@ -1,5 +1,6 @@
 ---
 :head:
+- "emacsのキーバインド\n"
 - "\n特殊キー操作\n"
 - "  c-f, controlキーを押しながら    'f'\n"
 - "  M-f, escキーを押した後一度離して'f'\n"
@@ -52,7 +53,7 @@
     :desc: Edit操作
   :title: |2-
 
-    編集操作editor
+    編集操作edit
   :cont:
   - c-d, Delete char, 一字削除
   - c-k, Kill line,   一行抹消，カット
@@ -82,7 +83,7 @@
     :desc: Buffer操作
   :title: |2-
 
-    バッファー操作buffer
+    バッファー操作buffer(すでにopenしてemacsにバッファーされたfile)
   :cont:
   - c-x b, show Buffer,   バッファのリスト
   - c-x c-b, next Buffer, 次のバッファへ移動

data/lib/my_help/template_help

@@ -1,17 +1,21 @@
 ---
-:head:
-- "TODO: ヘルプ内容の概略.\n"
-- "  常に表示される内容を記述.\n"
-- "  下を参照して変更してください．\n"
-:item: 
-  :opts: 
-    :short: "-i" 
-    :long: "--item"
-    :desc: 単元(item)
-  :title: "\n単元\n"
-  :cont:
-  - c-f, move Forwrard,    前or右へ
-  - フォーマットは自由です. ','があるときは2文字下げ，ないときは4文字下げ
+#start header, which appears every time.
+:head:         #never change
+- "ヘルプのサンプル雛形.\n"  #describe the contents breafly.
+- "  headに常に表示される内容を記述.\n" #head '- ' is necessary
+
+# start the first item
+:item:         #change snake word
+  :opts:          #never change
+    :short: "-i"      #change short option
+    :long: "--item"   #change long option
+    :desc: 単元(item) #describe what for in help list
+  :title: "\n単元\n"  #describe what for in each help
+  :cont:              #the following lines are appeared.
+  - c-f, move Forwrard,    前or右へ  #top '  - ' are necessary for yaml format
+  - フォーマットは自由です. 
+
+# start the second item... and so on.
 :item2: 
   :opts: 
     :short: "-j" 

data/lib/my_help/version.rb

@@ -1,3 +1,3 @@
 module MyHelp
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/my_help.rb

@@ -4,6 +4,7 @@ require "yaml"
 require "fileutils"
 #require "emacs_help/version"
 require "my_help/version"
+require "systemu"
 #require "emacs_help"
 
 module MyHelp
@@ -22,9 +23,8 @@ module MyHelp
 
     def set_help_dir_if_not_exists
       return if File::exists?(@target_dir)
-      FileUtils.mkdir_p(@target_dir)
-      helps =Dir.entries(@source_dir)
-      helps[2..-1].each{|file|
+      FileUtils.mkdir_p(@target_dir, :verbose=>true)
+      Dir.entries(@source_dir).each{|file|
         file_path=File.join(@target_dir,file)
         next if File::exists?(file_path)
         FileUtils.cp((File.join(@source_dir,file)),@target_dir,:verbose=>true)
@@ -41,10 +41,9 @@ module MyHelp
         opt.on('-l', '--list', '個別(specific)ヘルプのList表示.'){list_helps}
         opt.on('-e NAME', '--edit NAME', 'NAME(例：test_help)をEdit編集.'){|file| edit_help(file)}
         opt.on('-i NAME', '--init NAME', 'NAME(例：test_help)のtemplateを作成.'){|file| init_help(file)}
-        opt.on('-m', '--make', 'make and install:local all helps.'){make_help}
+        opt.on('-m', '--make', 'make executables for all helps.'){make_help}
         opt.on('-c', '--clean', 'clean up exe dir.'){clean_exe}
         opt.on('--install_local','install local after edit helps'){install_local}
-#        opt.on('--initialize','initialize local help directory'){initialize_local}
       end
       begin
         command_parser.parse!(@argv)
@@ -55,8 +54,16 @@ module MyHelp
     end
 
     def install_local
-      Dir.chdir(File.expand_path('../..',@target_dir))
-      p Dir.pwd
+      Dir.chdir(File.expand_path('../..',@source_dir))
+      p pwd_dir = Dir.pwd
+      # check that the working dir should not the gem installed dir
+      inst_dir="USER INSTALLATION DIRECTORY:"
+      status, stdout, stderr = systemu "gem env|grep '#{inst_dir}'"
+      p system_inst_dir = stdout.split(': ')[1].chomp
+      if pwd_dir == system_inst_dir
+        "download my_help from github, and using bundle for edit helps"
+        exit
+      end
       system "git add -A"
       system "git commit -m 'update exe dirs'"
       system "Rake install:local"
@@ -95,6 +102,10 @@ module MyHelp
 
     def init_help(file)
       p target_help=File.join(@target_dir,file)
+      if File::exists?(target_help)
+        puts "File exists. rm it first to initialize it."
+        exit
+      end
       p template = File.join(File.dirname(@source_dir),'my_help','template_help')
       FileUtils::Verbose.cp(template,target_help)
     end
@@ -107,7 +118,10 @@ module MyHelp
     def list_helps
       print "Specific help file:\n"
       Dir.entries(@target_dir)[2..-1].each{|file|
-        print "  "+file+"\n"
+        next if file[0]=='#' or file[-1]=='~'
+        file_path=File.join(@target_dir,file)
+        help_cont = YAML.load(File.read(file_path))
+        print "  #{file}\t:#{help_cont[:head][0][0..-1]}"
       }
     end
   end

data/lib/specific_help.rb

@@ -40,15 +40,17 @@ module SpecificHelp
     end
 
     def to_hiki
-      puts '>>>'
+      puts '<<<'
       @help_cont.each_pair{|key,val|
-        p key,val
-#        opts = val[:opts]
-#        puts opts[:short].to_s,opts[:long].to_s,opts[:desc].to_s
-        items =@help_cont[key]
-        puts items[:title]
-        disp(items[:cont])
+        if key==:head
+          disp(val)
+        else
+          items =@help_cont[key]
+          puts items[:title]
+          disp(items[:cont])
+        end
       }
+      puts '>>>'
     end
 
     def disp(lines)

data/my_help.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "hiki2md"
   spec.add_development_dependency "mathjax-yard"
   spec.add_development_dependency "hiki2latex"
-
+  spec.add_dependency "systemu"
 end

data/my_help.wiki/emacs_help.md

@@ -0,0 +1,51 @@
+```
+  
+特殊キー操作
+    c-f, controlキーを押しながら    'f'
+    M-f, escキーを押した後一度離して'f'
+      操作の中断c-g, 操作の取り消し(Undo) c-x u 
+
+カーソル移動cursor
+  c-f, move Forwrard,    前or右へ
+  c-b, move Backwrard,   後or左へ
+  c-a, go Ahead of line, 行頭へ
+  c-e, go End of line,   行末へ
+  c-n, move Next line,   次行へ
+  c-p, move Previous line, 前行へ
+
+ページ移動page
+  c-v, move Vertical,          次のページへ
+  M-v, move reversive Vertical,前のページへ
+  c-l, centerise Line,       現在行を中心に
+  M-<, move Top of file,    ファイルの先頭へ
+  M->, move Bottom of file, ファイルの最後尾へ
+
+ファイル操作file
+  c-x c-f, Find file, ファイルを開く
+  c-x c-s, Save file, ファイルを保存
+  c-x c-w, Write file NAME, ファイルを別名で書き込む
+
+編集操作editor
+  c-d, Delete char, 一字削除
+  c-k, Kill line,   一行抹消，カット
+  c-y, Yank,        ペースト
+  c-w, Kill region, 領域抹消，カット
+  領域選択は，先頭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
+  c-x 2, 2 windows, 二つに分割
+  c-x 1, 1 windows, 一つに戻す
+  c-x 3, 3rd window sep,縦線分割
+  c-x o, Other windows, 次の画面へ移動
+
+バッファー操作buffer(すでにopenしてemacsにバッファーされたfile)
+  c-x b, show Buffer,   バッファのリスト
+  c-x c-b, next Buffer, 次のバッファへ移動
+
+終了操作quit
+  c-x c-c, Quit emacs, ファイルを保存して終了
+  c-z, suspend emacs,  一時停止，fgで復活
+```

data/my_help.wiki/test_help.md

@@ -0,0 +1,47 @@
+# template_helpの出力結果
+
+```
+  ヘルプのサンプル雛形.
+    headに常に表示される内容を記述.
+
+単元
+  c-f, move Forwrard,    前or右へ
+  フォーマットは自由です.
+
+単元2
+  c-f, move Forwrard,    前or右へ
+  フォーマットは自由です.
+```
+
+# template_helpの中身
+helpの実態は~/.my_helpに保存されたYAML形式のfileです．書き方はコメントを参照ください．
+
+```yaml
+---
+#start header, which appears every time.
+:head:         #never change
+- "ヘルプのサンプル雛形.\n"  #describe the contents breafly.
+- "  headに常に表示される内容を記述.\n" #head '- ' is necessary
+
+# start the first item
+:item:         #change snake word
+  :opts:          #never change
+    :short: "-i"      #change short option
+    :long: "--item"   #change long option
+    :desc: 単元(item) #describe what for in help list
+  :title: "\n単元\n"  #describe what for in each help
+  :cont:              #the following lines are appeared.
+  - c-f, move Forwrard,    前or右へ  #top '  - ' are necessary for yaml format
+  - フォーマットは自由です. 
+
+# start the second item... and so on.
+:item2: 
+  :opts: 
+    :short: "-j" 
+    :long: "--item2"
+    :desc: 単元2(item2)
+  :title: "\n単元2\n"
+  :cont:
+  - c-f, move Forwrard,    前or右へ
+  - フォーマットは自由です. 
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_help
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Shigeto R. Nishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2016-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: systemu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Emulating CUI(CLI) help, an user makes and displays his own helps.
 email:
 - shigeto_nishitani@me.com
@@ -117,6 +131,8 @@ executables:
 - m_h
 - member_help
 - my_help
+- r_h
+- ruby_help
 - t_h
 - test_help
 extensions: []
@@ -138,13 +154,16 @@ files:
 - exe/m_h
 - exe/member_help
 - exe/my_help
+- exe/r_h
+- exe/ruby_help
 - exe/t_h
 - exe/test_help
 - hikis/README_en.hiki
 - hikis/README_ja.hiki
+- hikis/emacs_help.hiki
+- hikis/test_help.hiki
 - latexes/handout_pre.tex
 - lib/daddygongon/emacs_help
-- lib/daddygongon/test_help
 - lib/my_help.rb
 - lib/my_help/template_help
 - lib/my_help/version.rb
@@ -153,6 +172,8 @@ files:
 - my_help.wiki/Home.md
 - my_help.wiki/README_en.md
 - my_help.wiki/README_ja.md
+- my_help.wiki/emacs_help.md
+- my_help.wiki/test_help.md
 homepage: https://github.com/daddygongon/my_help
 licenses:
 - MIT

data/lib/daddygongon/test_help

@@ -1,39 +0,0 @@
----
-:head:
-- "人の名前を覚えるためのメモ\n"
-:senior: 
-  :opts: 
-    :short: "-4" 
-    :long: "--senior"
-    :desc: 4回生
-  :title: "\n4回生\n"
-  :cont:
-  - eringi, sakigits, narita, yamamoto, murakami, nasu, koki, yamane
-:junior: 
-  :opts: 
-    :short: "-j" 
-    :long: "--junior"
-    :desc: 3回生
-  :title: "\n3回生\n"
-  :cont:
-  - 栃木 琢冶   バイク，マグナ
-  - 丸毛(marumo) 崇史（浅野）       メルモちゃん，奈良香芝，サッカー観戦，リバプール
-  - 辻 脩人(大崎)                   大阪，塾のバイト，アニメ，
-  - 宮下 優理（西谷）               熊本，ジャグリング
-  - 和田 創熙souki(いのくち)        加古川，バイク，ninja250
-  - 大八木 利治(北村)               嵐山，野球観戦，ラーメン(極鶏)，テニス
-  - 藤村 尚輝(巳波)                 西宮，スマホゲーム
-  - 影山 八哉(西谷)                 川西，サッカー，漫画，ボード
-:ruby-kansai: 
-  :opts: 
-    :short: "-r" 
-    :long: "--ruby"
-    :desc: ruby関西のメンツ
-  :title: "\nruby関西のメンツ\n"
-  :cont:
-  - ひがきさん
-  - 船原まさお (@steps107)
-  - 小林慎治 京都大学 大学院情報学研究科EHR
-  - 
-
-