my_help 1.2 → 1.2.3

data/lib/my_help/cli.rb

@@ -13,10 +13,14 @@ module MyHelp
       end
     end
 
+    package_name 'my_help'
+    map "-v" => :version
+    map "--version" => :version
+
     desc "version", "show version"
 
     def version
-      puts VERSION
+      print "my_help #{VERSION}"
     end
 
     desc "git [pull|push]", "git operations"
@@ -26,6 +30,7 @@ module MyHelp
 
     def init(*args)
       config = get_config # for using methods in Config
+
       #config.ask_default
       init = Init.new(config)
       raise "Local help dir exist." if init.help_dir_exist?
@@ -102,5 +107,6 @@ module MyHelp
       name = $stdin.gets.chomp
       puts("Hello #{name}.")
     end
+
   end
 end

data/lib/my_help/config.rb

@@ -12,7 +12,7 @@ module MyHelp
       @config = {
         template_dir: File.expand_path("../templates", __dir__),
         local_help_dir: local_help_dir,
-        conf_file: File.join(local_help_dir, ".my_help_conf.yml"),
+        conf_file: File.join(conf_path, ".my_help_conf.yml"),
         editor: ENV["EDITOR"] || "emacs",
         ext: ".org",
         verbose: false,

data/lib/my_help/list.rb

@@ -8,7 +8,7 @@ module MyHelp
     def initialize(path = "", ext = ".org", layer = 1)
       @path = path
       @ext = ext
-      p @layer = layer
+      @layer = layer
     end
 
     def list(help_options = "", level = 0)
@@ -34,8 +34,10 @@ module MyHelp
       Dir.glob(files).inject("") do |out, file|
         #        p [out, file]
         help_info = read_help(file)
-        out << "%10s: %s\n" % [help_info[:name],
-                               help_info[:items]["head"].split("\n")[0]]
+        head = help_info[:items]["head"] ?
+                 help_info[:items]["head"].split("\n")[0] :
+                 ''
+        out << "%10s: %s\n" % [help_info[:name], head]
       end
     end
 

data/lib/my_help/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyHelp
-  VERSION = "1.2"
+  VERSION = "1.2.3"
 end

data/lib/templates/example.org

@@ -1,9 +1,7 @@
 #+STARTUP: indent nolineimages overview
-* head
-- help_title example
-* license
--      cc by Shigeto R. Nishitani, 2016-22
+* head: help_title example
+* license:      cc by Shigeto R. Nishitani, 2016-23
 * a_item : item_short_description
 - content_a
 * b_item
-- content_b
+- content_b

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_help
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.2.3
 platform: ruby
 authors:
 - Shigeto R. Nishiani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -104,36 +104,9 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.org
-- README_en.org
+- README_j.org
 - Rakefile
-- doc/MyHelp.html
-- doc/MyHelp/CLI.html
-- doc/MyHelp/Config.html
-- doc/MyHelp/Control.html
-- doc/MyHelp/Error.html
-- doc/MyHelp/GetConfig.html
-- doc/MyHelp/Git.html
-- doc/MyHelp/Init.html
-- doc/MyHelp/List.html
-- doc/MyHelp/Md2Hash.html
-- doc/MyHelp/Modify.html
-- doc/MyHelp/Org2Hash.html
-- doc/Org2Yaml.html
-- doc/OrgToYaml.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
+- development_memo.org
 - exe/my_help
 - lib/my_help.rb
 - lib/my_help/cli.rb
@@ -150,12 +123,6 @@ files:
 - lib/templates/example.md
 - lib/templates/example.org
 - my_help.gemspec
-- pkg/my_help-0.8.6.gem
-- pkg/my_help-0.9.0.gem
-- pkg/my_help-1.0b.gem
-- pkg/my_help-1.0c.gem
-- pkg/my_help-1.1.gem
-- pkg/my_help-1.1a.gem
 - tmp.txt
 homepage: https://github.com/daddygongon/my_help
 licenses:

data/README_en.org

@@ -1,131 +0,0 @@
-* 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
-