my_help 0.3.2 → 0.3.3

data/lib/my_help/#test.rb#

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+require 'yaml'
+require 'pp'
+yaml =<<EOF
+: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, ��Ւ�������뒤��̒̾��ǒ�񒤭������
+EOF
+pp data=YAML.load(yaml)
+print YAML.dump(data)
+
+
+data0={:new_item=>
+  {:opts=>{:short=>"-n", :long=>"--new_item", :desc=>"new item"},
+   :title=>"new_item",
+   :cont=>
+    ["new cont"]}}
+
+print YAML.dump(data0)

data/lib/my_help/.#test.rb

@@ -0,0 +1 @@
+bob@bob.local.71520

data/lib/my_help/test.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+require 'yaml'
+require 'pp'
+yaml =<<EOF
+: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, ファイルを別名で書き込む
+EOF
+pp data=YAML.load(yaml)
+print YAML.dump(data)
+
+
+data0={:new_item=>
+  {:opts=>{:short=>"-n", :long=>"--new_item", :desc=>"new item"},
+   :title=>"new_item",
+   :cont=>
+    ["new cont"]}}
+
+print YAML.dump(data0)

data/lib/my_help/version.rb

@@ -1,3 +1,3 @@
 module MyHelp
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/lib/my_help.rb

@@ -16,18 +16,18 @@ module MyHelp
 
     def initialize(argv=[])
       @argv = argv
-      @source_dir = File.expand_path("../../lib/daddygongon", __FILE__)
-      @target_dir = File.join(ENV['HOME'],'.my_help')
+      @default_help_dir = File.expand_path("../../lib/daddygongon", __FILE__)
+      @local_help_dir = File.join(ENV['HOME'],'.my_help')
       set_help_dir_if_not_exists
     end
 
     def set_help_dir_if_not_exists
-      return if File::exists?(@target_dir)
-      FileUtils.mkdir_p(@target_dir, :verbose=>true)
-      Dir.entries(@source_dir).each{|file|
-        file_path=File.join(@target_dir,file)
+      return if File::exists?(@local_help_dir)
+      FileUtils.mkdir_p(@local_help_dir, :verbose=>true)
+      Dir.entries(@default_help_dir).each{|file|
+        file_path=File.join(@local_help_dir,file)
         next if File::exists?(file_path)
-        FileUtils.cp((File.join(@source_dir,file)),@target_dir,:verbose=>true)
+        FileUtils.cp((File.join(@default_help_dir,file)),@local_help_dir,:verbose=>true)
       }
     end
 
@@ -44,6 +44,7 @@ module MyHelp
         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('--delete NAME','delete NAME help'){|file| delete_help(file)}
       end
       begin
         command_parser.parse!(@argv)
@@ -53,13 +54,29 @@ module MyHelp
       exit
     end
 
+    def delete_help(file)
+      del_files=[]
+      del_files << File.join(@local_help_dir,file)
+       exe_dir=File.join(File.expand_path('../..',@default_help_dir),'exe')
+       del_files << File.join(exe_dir,file)
+      p del_files << File.join(exe_dir,short_name(file))
+      print "Are you sure to delete these files?[yes]"
+      if gets.chomp=='yes' then
+        del_files.each{|file| FileUtils.rm(file,:verbose=>true)}
+      end
+    end
+
+    USER_INST_DIR="USER INSTALLATION DIRECTORY:"
+    INST_DIR="INSTALLATION DIRECTORY:"
     def install_local
-      Dir.chdir(File.expand_path('../..',@source_dir))
+      Dir.chdir(File.expand_path('../..',@default_help_dir))
       p pwd_dir = Dir.pwd
       # check that the working dir should not the gem installed dir,
       # which destroys itself.
-      inst_dir="USER INSTALLATION DIRECTORY:"
-      status, stdout, stderr = systemu "gem env|grep '#{inst_dir}'"
+      status, stdout, stderr = systemu "gem env|grep '#{USER_INST_DIR}'"
+      if stdout==""
+        status, stdout, stderr = systemu "gem env|grep '#{INST_DIR}'"
+      end
       p system_inst_dir = stdout.split(': ')[1].chomp
       if pwd_dir == system_inst_dir
         puts "Download my_help from github, and using bundle for edit helps\n"
@@ -77,8 +94,7 @@ module MyHelp
     end
 
     def make_help
-      Dir.entries(@target_dir)[2..-1].each{|file|
-        next if file[0]=='#' or file[-1]=='~'
+      local_help_entries.each{|file|
         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"
@@ -92,8 +108,7 @@ module MyHelp
     end
 
     def clean_exe
-      Dir.entries(@target_dir)[2..-1].each{|file|
-        next if file[0]=='#' or file[-1]=='~'
+      local_help_entries.each{|file|
         next if file.include?('emacs_help') or file.include?('e_h')
         next if file.include?('template_help') or file.include?('t_h')
         [file, short_name(file)].each{|name|
@@ -104,27 +119,36 @@ module MyHelp
     end
 
     def init_help(file)
-      p target_help=File.join(@target_dir,file)
+      p target_help=File.join(@local_help_dir,file)
       if File::exists?(target_help)
         puts "File exists. rm it first to initialize it."
         exit
       end
-      p template = File.join(@source_dir,'template_help')
+      p template = File.join(@default_help_dir,'template_help')
       FileUtils::Verbose.cp(template,target_help)
     end
 
     def edit_help(file)
-      p target_help=File.join(@target_dir,file)
+      p target_help=File.join(@local_help_dir,file)
       system "emacs #{target_help}"
     end
 
+    def local_help_entries
+      entries= []
+      Dir.entries(@local_help_dir).each{|file|
+        next unless file.include?('_')
+        next if file[0]=='#' or file[-1]=='~' or file[0]=='.'
+        entries << file
+      }
+      return entries
+    end
+
     def list_helps
       print "Specific help file:\n"
-      Dir.entries(@target_dir)[2..-1].each{|file|
-        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]}\n"
+      local_help_entries.each{|file|
+        file_path=File.join(@local_help_dir,file)
+        help = YAML.load(File.read(file_path))
+        print "  #{file}\t:#{help[:head][0]}\n"
       }
     end
   end

data/lib/my_help.rb~

@@ -0,0 +1,155 @@
+# -*- coding: utf-8 -*-
+require "optparse"
+require "yaml"
+require "fileutils"
+#require "emacs_help/version"
+require "my_help/version"
+require "systemu"
+#require "emacs_help"
+
+module MyHelp
+  class Command
+
+    def self.run(argv=[])
+      new(argv).execute
+    end
+
+    def initialize(argv=[])
+      @argv = argv
+      @default_help_dir = File.expand_path("../../lib/daddygongon", __FILE__)
+      @local_help_dir = File.join(ENV['HOME'],'.my_help')
+      set_help_dir_if_not_exists
+    end
+
+    def set_help_dir_if_not_exists
+      return if File::exists?(@local_help_dir)
+      FileUtils.mkdir_p(@local_help_dir, :verbose=>true)
+      Dir.entries(@default_help_dir).each{|file|
+        file_path=File.join(@local_help_dir,file)
+        next if File::exists?(file_path)
+        FileUtils.cp((File.join(@default_help_dir,file)),@local_help_dir,:verbose=>true)
+      }
+    end
+
+    def execute
+      @argv << '--help' if @argv.size==0
+      command_parser = OptionParser.new do |opt|
+        opt.on('-v', '--version','show program Version.') { |v|
+          opt.version = MyHelp::VERSION
+          puts opt.ver
+        }
+        opt.on('-l', '--list', 'list specific helps'){list_helps}
+        opt.on('-e NAME', '--edit NAME', 'edit NAME help(eg test_help)'){|file| edit_help(file)}
+        opt.on('-i NAME', '--init NAME', 'initialize NAME help(eg test_help).'){|file| init_help(file)}
+        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('--delete NAME','delete NAME help'){|file| delete_help(file)}
+      end
+      begin
+        command_parser.parse!(@argv)
+      rescue=> eval
+        p eval
+      end
+      exit
+    end
+
+    def delete_help(file)
+      del_files=[]
+      del_files << File.join(@local_help_dir,file)
+       exe_dir=File.join(File.expand_path('../..',@default_help_dir),'exe')
+       del_files << File.join(exe_dir,file)
+      p del_files << File.join(exe_dir,short_name(file))
+      print "Are you sure to delete these files?[yes]"
+      if gets.chomp=='yes' then
+        del_files.each{|file| FileUtils.rm(file,:verbose=>true)}
+      end
+    end
+
+    USER_INST_DIR="USER INSTALLATION DIRECTORY:"
+    INST_DIR="INSTALLATION DIRECTORY:"
+    def install_local
+      Dir.chdir(File.expand_path('../..',@default_help_dir))
+      p pwd_dir = Dir.pwd
+      # check that the working dir should not the gem installed dir,
+      # which destroys itself.
+      status, stdout, stderr = systemu "gem env|grep '#{USER_INST_DIR}'"
+      if stdout==""
+        status, stdout, stderr = systemu "gem env|grep '#{INST_DIR}'"
+      end
+      p system_inst_dir = stdout.split(': ')[1].chomp
+      if pwd_dir == system_inst_dir
+        puts "Download my_help from github, and using bundle for edit helps\n"
+        puts "Read README in detail.\n"
+        exit
+      end
+      system "git add -A"
+      system "git commit -m 'update exe dirs'"
+      system "Rake install:local"
+    end
+
+    def short_name(file)
+      file_name=file.split('_')
+      return file_name[0][0]+"_"+file_name[1][0]
+    end
+
+    def make_help
+      local_help_entries.each{|file|
+        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 clean_exe
+      local_help_entries.each{|file|
+        next if file.include?('emacs_help') or file.include?('e_h')
+        next if file.include?('template_help') or file.include?('t_h')
+        [file, short_name(file)].each{|name|
+          p target=File.join('exe',name)
+          FileUtils::Verbose.rm(target)
+        }
+      }
+    end
+
+    def init_help(file)
+      p target_help=File.join(@local_help_dir,file)
+      if File::exists?(target_help)
+        puts "File exists. rm it first to initialize it."
+        exit
+      end
+      p template = File.join(@default_help_dir,'template_help')
+      FileUtils::Verbose.cp(template,target_help)
+    end
+
+    def edit_help(file)
+      p target_help=File.join(@local_help_dir,file)
+      system "emacs #{target_help}"
+    end
+
+    def local_help_entries
+      entries= []
+      Dir.entries(@local_help_dir).each{|file|
+        next unless file.include?('_')
+        next if file[0]=='#' or file[-1]=='~'
+        entries << file
+      }
+      return entries
+    end
+
+    def list_helps
+      print "Specific help file:\n"
+      local_help_entries.each{|file|
+        file_path=File.join(@local_help_dir,file)
+        help = YAML.load(File.read(file_path))
+        print "  #{file}\t:#{help[:head][0]}\n"
+      }
+    end
+  end
+end

data/lib/specific_help.rb

@@ -3,7 +3,6 @@ require "optparse"
 require "yaml"
 require "my_help/version"
 
-
 module SpecificHelp
   class Command
 
@@ -15,13 +14,18 @@ module SpecificHelp
       @source_file = file
       @help_cont = YAML.load(File.read(file))
       @help_cont[:head].each{|line| print line.chomp+"\n" }
-      @help_cont[:license].each{|line| print line } if @help_cont[:license] != nil
-      print "---\n" #separater
+      @help_cont[:license].each{|line| print "#{line.chomp}\n" } if @help_cont[:license] != nil
       @argv = argv
     end
 
     def execute
-      @argv << '--help' if @argv.size==0
+      if @argv.size==0
+        if @source_file.include?('todo')
+          @argv << '--all' 
+        else
+          @argv << '--help' 
+        end
+      end
       command_parser = OptionParser.new do |opt|
         opt.on('-v', '--version','show program Version.') { |v|
           opt.version = MyHelp::VERSION
@@ -30,10 +34,14 @@ module SpecificHelp
         @help_cont.each_pair{|key,val|
           next if key==:head or key==:license
           opts = val[:opts]
-          opt.on(opts[:short],opts[:long],opts[:desc]) {disp_from_help_cont(key)}
+          opt.on(opts[:short],opts[:long],opts[:desc]) {disp_help(key)}
         }
         opt.on('--edit','edit help contents'){edit_help}
         opt.on('--to_hiki','convert to hikidoc format'){to_hiki}
+        opt.on('--all','display all helps'){all_help}
+        opt.on('--store [item]','store [item] in backfile'){|item| store(item)}
+        opt.on('--remove [item]','remove [item] and store in backfile'){|item| remove(item) }
+        opt.on('--add [item]','add new [item]'){|item| add(item) }
       end
 #      begin
       command_parser.parse!(@argv)
@@ -43,34 +51,83 @@ module SpecificHelp
       exit
     end
 
+    def mk_backup_file(file)
+      path = File.dirname(file)
+      base = File.basename(file)
+      backup= File.join(path,"."+base)
+      FileUtils.touch(backup) unless File.exists?(backup)
+      return backup
+    end
+
+    def store(item)
+      backup=mk_backup_file(@source_file)
+      store_item = @help_cont[item.to_sym]
+      p store_name = item+"_"+Time.now.strftime("%Y%m%d_%H%M%S")
+      cont = {store_name.to_sym => store_item}
+      File.open(backup,'a'){|file| file.print(YAML.dump(cont))}
+    end
+
+    def add(item='new_item')
+      new_item={:opts=>{:short=>'-'+item[0], :long=>'--'+item, :desc=>item},
+          :title=>item, :cont=> [item]}
+      @help_cont[item.to_sym]=new_item
+      File.open(@source_file,'w'){|file| file.print YAML.dump(@help_cont)}
+    end
+
+    def remove(item)
+      store(item)
+      @help_cont.delete(item.to_sym)
+      File.open(@source_file,'w'){|file| file.print YAML.dump(@help_cont)}
+    end
+
     def edit_help
       system("emacs #{@source_file}")
     end
 
     def to_hiki
-      puts '<<<'
       @help_cont.each_pair{|key,val|
         if key==:head or key==:license
-          disp(val)
+          hiki_disp(val)
         else
-          items =@help_cont[key]
-          puts items[:title]
-          disp(items[:cont])
+          hiki_help(key)
         end
       }
-      puts '>>>'
     end
 
-    def disp(lines)
-      lines.each{|line|
-        puts "  #{line}"
+    def all_help
+      @help_cont.each_pair{|key,val|
+        if key==:head or key==:license
+          disp(val)
+        else
+          disp_help(key)
+        end
       }
     end
 
-    def disp_from_help_cont(key_word)
+    def hiki_help(key_word)
+      items =@help_cont[key_word]
+      puts "\n!!"+items[:title]+"\n"
+      hiki_disp(items[:cont])
+    end
+
+    def hiki_disp(lines)
+      lines.each{|line| puts "*#{line}"}
+    end
+
+    def disp_help(key_word)
+      print_separater
       items =@help_cont[key_word]
       puts items[:title]
       disp(items[:cont])
+      print_separater
+    end
+
+    def disp(lines)
+      lines.each{|line| puts "  *#{line}"}
+    end
+
+    def print_separater
+      print "---\n"
     end
   end
 end

data/my_help.wiki/Home.md

@@ -30,6 +30,11 @@ commandや文法を覚えるのに苦労します．少しのkey(とっかかり
 hikiでやろうとしていることの半分くらいはこのあたりのことなの
 かもしれません．memoソフトでは，検索が必要となりますが，my_helpは
 key(記憶のとっかかり)を提供することが目的です．
+RPGでレベル上げとかアイテムを貯めるようにして，
+プログラミングでスキルを発展させてください．
+
+物覚えの悪い作者は，人の名前をitem分けして，こそっと使っています．
+
 
 # 使用法
 ## インストール
@@ -56,6 +61,7 @@ Usage: my_help [options]
     -m, --make                       make executables for all helps.
     -c, --clean                      clean up exe dir.
         --install_local              install local after edit helps
+        --delete NAME                delete NAME help
 ```
 です．まず，-lでdefaultで入っているリストを見てください．
 
@@ -65,9 +71,35 @@ bob%  bundle exec exe/my_help -l
 ["-l"]
 Specific help file:
   emacs_help
-  test_help
 ```
-これで，CUIでemacs_help, e_h, template_help, t_hが用意されています．少し振る舞いに慣れてください．
+これで，CUIでemacs_help, e_hが用意されています．
+
+```
+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]
+```
+少し振る舞いに慣れてください．
 
 ## 独自のhelpを作る方法
 さて，独自のhelpを作る方法です．まずは，
@@ -78,7 +110,12 @@ bob%  bundle exec exe/my_help -i new_help
 "/Users/bob/Github/my_help/lib/daddygongon/template_help"
 cp /Users/bob/Github/my_help/lib/daddygongon/template_help /Users/bob/.my_help/new_help
 ```
-で，new_helpというtemplateが用意されます．-e new_helpで編集してください．そのあと，-mすると自動でnew_helpがexeディレクトリーに追加されます．
+で，new_helpというtemplateが用意されます．-e new_helpで編集してください．
+YAML形式で，格納されています．サンプルが，
+```
+my_help/lib/daddygongon
+```
+にあります．このあと，-mすると自動でnew_helpがexeディレクトリーに追加されます．
 
 ## 独自helpを使えるように
 (これは，-mで自動的に行われるように修正されています)
@@ -98,8 +135,8 @@ cp /Users/bob/Github/my_help/lib/daddygongon/template_help /Users/bob/.my_help/n
 - @target dirをmy_help/lib/daddygongonからENV['HOME']/.my_helpに変更
 
 exe中のファイルをrakeで自動生成．
-@target_dirにそれらのdataを保存．以下ではその名前から
-exe中に実行ファイルを自動生成させている．
+@target_dirにそれらのdataを保存．
+その名前からexe中に実行ファイルを自動生成させている．
 ```
 lib/daddygongon/
 └── emacs_help
@@ -123,34 +160,32 @@ rake install:local
 gem uninstall my_help
 gem uninstall emacs_help
 ```
-でそのdirをcleanにしておくことが望ましい．
+でそのdirをcleanにしておくことが望ましい．下のuninstallの項目を参照．
 
-中身は以下の通り．
+-mでやっている中身は以下の通り．
 ```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
+    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)
+        }
       }
-      FileUtils.chmod('a+x', target, :verbose => true)
-    }
-  }
-end
+      install_local
+    end
+
+    def install_local
+      #中略
+      system "git add -A"
+      system "git commit -m 'update exe dirs'"
+      system "Rake install:local"
+    end
+
 ```
 
 実装方法は，emacs_helpに
@@ -162,10 +197,30 @@ end
 今の所，No.1の方を実装．No.2のためのhushデータは，
 
 ```ruby
+# -*- coding: utf-8 -*-
 require 'yaml'
 require 'pp'
-
-pp YAML.load(File.read(ARGV[0]))
+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)
 ```
 
 ```