my_help 0.6.2 → 0.7.0

data/README.org

@@ -1,3 +1,9 @@
+#+TITLE:  my_help README
+#+AUTHOR:  Shigeto R. Nishitani
+#+EMAIL:     (concat "nishitani@kwansei.ac.jp")
+#+LANGUAGE:  jp
+#+OPTIONS:   H:4 toc:t num:2
+#+SETUPFILE: /Users/bob/Github/org-html-themes/setup/theme-readtheorg.setup
 #+STARTUP: indent nolineimages
 #+OPTIONS: ^:{}
 
@@ -8,6 +14,7 @@
 
 CUI(CLA)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.
 
+
 * (my_helpで解決しようとする)問題点
   :PROPERTIES:
   :CUSTOM_ID: my_helpで解決しようとする問題点
@@ -50,14 +57,43 @@ RPGでレベル上げとかアイテムを貯めるようにして，
 ** インストール
 
 : $ gem install my_help
-です． installがうまくいくと，defaultでmy_help, my_todo, emacs_help, org_helpが入ります．
+です．
 
 ** 簡単な使用法
    :PROPERTIES:
    :CUSTOM_ID: 簡単な使用法
    :END:
 
-emacs_helpを動かしてみてください．
+まずは，
+#+begin_example
+> my_help
+NAME
+    my_help - make own help and list.
+
+SYNOPSIS
+    my_help [global options] command [command options] [arguments...]
+
+VERSION
+    0.7.0
+
+GLOBAL OPTIONS
+    --help    - Show this message
+    --version - Display the program version
+
+COMMANDS
+    delete - delete HELP_NAME help
+    edit   - edit HELP_NAME help
+    help   - Shows a list of commands or help for one command
+    list   - list all helps, specific HELP, or item
+     new   - make new HELP_NAME
+#+end_example
+としてください．このlistにargsやitemを加えて行くとわかると思います．
+
+: my_help list
+: my_help list emacs_help
+: my_help list emacs_help -f
+: my_help list emacs_help file
+として動かしてみてください．
 
 
 #+BEGIN_EXAMPLE
@@ -67,82 +103,22 @@ emacs_helpを動かしてみてください．
 -   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
-
-#+BEGIN_EXAMPLE
-    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 executables for all helps.
-        -c, --clean                      clean up exe dir.
-            --install_local              install local after edit helps
-            --delete NAME                delete NAME help
-#+END_EXAMPLE
-
-です．まず，-lでdefaultで入っているリストを見てください．
---addとか--editとかで，要素の追加や編集ができます．
-
-** alpine linuxのためのDockerfile
-   :PROPERTIES:
-   :CUSTOM_ID: alpine-linuxのためのdockerfile
-   :END:
-
-my_helpをalpine
-linux上で動作させるため、以下のDockerfileを作成しました。
-
-#+BEGIN_EXAMPLE
-    FROM alpine:3.7
-
-    ENV http_proxy <YOUR PROXY HERE>
-    ENV https_proxy <YOUR PROXY HERE>
-
-    RUN apk update && apk upgrade
-    RUN apk --update add \
-      openssh git build-base libffi libffi-dev \
-      ruby ruby-dev ruby-rake ruby-bundler
-
-    RUN git clone https://github.com/daddygongon/my_help.git
-    WORKDIR my_help
-
-    RUN bundle update
-    RUN bundle exec exe/my_help -m && rake install:local
+     , head           : head
+     , license        : license
+   -c, cursor         : cursor
+   -e, edit           : edit
+   -s, short_cut      : short_cut
+   -f, file           : file
+   -q, quit           : quit
+   -p, page           : page
+   -w, window         : window
+   -b, buffer         : buffer
+   -m, mode           : mode
+     , query_replace  : query_replace
+   -r, ruby-mode      : ruby-mode
+   -d, dired          : ファイラとして使う
 #+END_EXAMPLE
 
-プロキシは適宜書き換えてください。
-ビルド時のアカウントに関するエラーを除けば大体は問題なく動作しています。
-
-#+BEGIN_SRC sh
-    # build an image named 'my-help'
-    $ docker build -t my-help .
-    ...
-
-    # run a container
-    $ docker run -it --rm my-help:latest emacs_help
-#+END_SRC
-
 ** 独自のhelpを作る方法
    :PROPERTIES:
    :CUSTOM_ID: 独自のhelpを作る方法
@@ -150,87 +126,12 @@ linux上で動作させるため、以下のDockerfileを作成しました。
 
 さて，独自のhelpを作る方法です．まずは，
 
-: my_help -i new_help
-
-で，new_helpというtemplateが用意されます．-e
-new_helpで編集してください． emacs org形式で，格納されています．サンプルが，
-
-にあります．このあと，-mすると自動でnew_helpがexeディレクトリーに追加されます．
-
-* userの独自helpの達成方法
-  :PROPERTIES:
-  :CUSTOM_ID: userの独自helpの達成方法
-  :END:
-
-exe中のファイルをrakeで自動生成． @target_dirにそれらのdataを保存．
-その名前からexe中に実行ファイルを自動生成させている．
-
-#+BEGIN_EXAMPLE
-    lib/daddygongon/
-    └── emacs_help
-
-    exe
-    ├── e_h
-    └── emacs_help
-#+END_EXAMPLE
-
-ということ．これは，
-
-: my_help -m
-で実行される．
+: my_help new new_help
 
-たくさんの実行ファイルをgemのINSTALLATION DIRに置くことになるので，あらたなmy_helpを作成するときには
-
-: gem uninstall my_help
-
-でそのdirをcleanにしておくことが望ましい．下のuninstallの項目を参照．
-
-* uninstall
-  :PROPERTIES:
-  :CUSTOM_ID: uninstall
-  :END:
+で，new_helpというtemplateが用意されます．
+: my_help edit new_help
+で編集してください． emacs org形式で，格納されています．
 
-my_help -mでinstallするとEXECUTABLE DIRECTORYにhelpのexec
-filesが自動で追加される． ~/.my_helpを手で修正したときには，あらかじめ
-
-: unistall my_help
-
-でそれらをuninstallしておくと良い．
-
-#+BEGIN_QUOTE
-  $ gem uninstall my_help
-
-Select gem to uninstall: 
-1. my_help-0.1.0 
-2. my_help-0.2.0 
-3. my_help-0.2.1 
-4. my_help-0.2.2 
-5. my_help-0.2.3 
-6. my_help-0.3.0 
-7. my_help-0.3.1 
-8. my_help-0.3.2 
-9. All versions
-
-> 9 
-Successfully uninstalled my_help-0.1.0 Successfully
-uninstalled my_help-0.2.0 Remove executables: #my_help#
-
-in addition to the gem? [Yn] Y 
-Removing #my_help# Successfully
-uninstalled my_help-0.2.1 Successfully uninstalled my_help-0.2.2
-Successfully uninstalled my_help-0.2.3 Successfully uninstalled
-my_help-0.3.0 Remove executables: test_help
-
-in addition to the gem? [Yn] Y 
-Removing test_help Successfully
-uninstalled my_help-0.3.1 Remove executables: e_h, emacs_help, m_h,
-member_help, my_help, n_h, new_help, r_h, ruby_help, t_h,
-template_help
-
-in addition to the gem? [Yn] Y 
-Removing e_h Removing emacs_help
-Removing m_h Removing member_help Removing my_help Removing n_h
-Removing new_help Removing r_h Removing ruby_help Removing t_h
-Removing template_help Successfully uninstalled my_help-0.3.2 ```
-#+END_QUOTE
+: my_help delete new_help
 
+すると消されます．

data/README.rdoc

@@ -0,0 +1,6 @@
+= my_help
+
+Describe your project here
+
+:include:my_help.rdoc
+

data/README_en.org

@@ -0,0 +1,131 @@
+* Name
+  :PROPERTIES:
+  :CUSTOM_ID: name
+  :END:
+
+my\_help
+
+* Summary
+  :PROPERTIES:
+  :CUSTOM_ID: summary
+  :END:
+
+This gem makes and supplies user specific helps, emulating CUI(CLI) help
+usage.
+
+* Target
+  :PROPERTIES:
+  :CUSTOM_ID: target
+  :END:
+
+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
+  :PROPERTIES:
+  :CUSTOM_ID: specs
+  :END:
+
+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
+  :PROPERTIES:
+  :CUSTOM_ID: 使用法
+  :END:
+** Install
+
+: $ gem install my_help
+
+** Simple Usage
+   :PROPERTIES:
+   :CUSTOM_ID: 簡単な使用法
+   :END:
+
+At first, you can see the commands supplied by my_help.
+#+begin_example
+> my_help
+NAME
+    my_help - make own help and list.
+
+SYNOPSIS
+    my_help [global options] command [command options] [arguments...]
+
+VERSION
+    0.7.0
+
+GLOBAL OPTIONS
+    --help    - Show this message
+    --version - Display the program version
+
+COMMANDS
+    delete - delete HELP_NAME help
+    edit   - edit HELP_NAME help
+    help   - Shows a list of commands or help for one command
+    list   - list all helps, specific HELP, or item
+     new   - make new HELP_NAME
+#+end_example
+
+When you add HELP_NAME and item (-o)wo'
+
+: my_help list
+: my_help list emacs_help
+: my_help list emacs_help -f
+: my_help list emacs_help file
+
+
+#+BEGIN_EXAMPLE
+- emacsのキーバインド
+- 
+特殊キー操作
+-   C-f, controlキーを押しながら    'f'
+-   M-f, escキーを押した後一度離して'f'
+-     操作の中断C-g, 操作の取り消し(Undo) C-x u
+     , head           : head
+     , license        : license
+   -c, cursor         : cursor
+   -e, edit           : edit
+   -s, short_cut      : short_cut
+   -f, file           : file
+   -q, quit           : quit
+   -p, page           : page
+   -w, window         : window
+   -b, buffer         : buffer
+   -m, mode           : mode
+     , query_replace  : query_replace
+   -r, ruby-mode      : ruby-mode
+   -d, dired          : ファイラとして使う
+#+END_EXAMPLE
+
+** Make your own help
+   :PROPERTIES:
+   :CUSTOM_ID: 独自のhelpを作る方法
+   :END:
+
+For making your new help, you can do tha as follows:
+: my_help new new_help
+
+A templeate is compied, then you can edit as 
+: my_help edit new_help
+The file is stored in emacs org mode.
+
+You can delete if as follows:
+: my_help delete new_help
+

data/Rakefile_gli

@@ -0,0 +1,44 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('my_help.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/bin/my_help

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'my_help'
+
+include GLI::App
+
+program_desc 'make own help and list.'
+
+version MyHelp::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'list all helps, specific HELP, or item'
+arg_name 'HELP_NAME, ITEM'
+command :list do |c|
+  c.action do |global_options,options,args|
+    p args
+    file, item = args
+    if file.nil?
+      $control.list_all
+    elsif item.nil?
+      $control.list_help(file)
+    else
+      $control.show_item(file, item)
+    end
+  end
+end
+
+desc 'edit HELP_NAME help'
+arg_name 'HELP_NAME'
+command :edit do |c|
+  c.action do |global_options,options,args|
+    p args
+    $control.edit_help(args[0]) 
+  end
+end
+
+desc 'make new HELP_NAME help'
+arg_name 'HELP_NAME'
+command :new do |c|
+  c.action do |global_options,options,args|
+    $control.init_help(args[0])
+  end
+end
+
+desc 'delete HELP_NAME help'
+arg_name 'HELP_NAME'
+command :delete do |c|
+  c.action do |global_options,options,args|
+    $control.delete_help(args[0])
+  end
+end
+
+pre do |global,command,options,args|
+  $control = MyHelp::Control.new()
+  true
+end
+
+post do |global,command,options,args|
+end
+
+on_error do |exception|
+  true
+end
+
+exit run(ARGV)