my_help 0.6.2 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,5 @@
1
+ = my_help
2
+
3
+ Generate this with
4
+ my_help rdoc
5
+ After you have described your command line interface
metadata CHANGED
@@ -1,57 +1,71 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: my_help
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.6.2
4
+ version: 0.7.0
5
5
  platform: ruby
6
6
  authors:
7
- - Shigeto R. Nishitani
7
+ - Your Name Here
8
8
  autorequire:
9
- bindir: exe
9
+ bindir: bin
10
10
  cert_chain: []
11
- date: 2018-04-20 00:00:00.000000000 Z
11
+ date: 2018-04-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
- name: bundler
14
+ name: rake
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '1.11'
19
+ version: '0'
20
20
  type: :development
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "~>"
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: '1.11'
26
+ version: '0'
27
27
  - !ruby/object:Gem::Dependency
28
- name: rake
28
+ name: rdoc
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - "~>"
31
+ - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: '10.0'
33
+ version: '0'
34
34
  type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - "~>"
38
+ - - ">="
39
39
  - !ruby/object:Gem::Version
40
- version: '10.0'
40
+ version: '0'
41
41
  - !ruby/object:Gem::Dependency
42
- name: systemu
42
+ name: aruba
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - ">="
46
46
  - !ruby/object:Gem::Version
47
47
  version: '0'
48
- type: :runtime
48
+ type: :development
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - ">="
53
53
  - !ruby/object:Gem::Version
54
54
  version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: gli
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '='
60
+ - !ruby/object:Gem::Version
61
+ version: 2.17.1
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '='
67
+ - !ruby/object:Gem::Version
68
+ version: 2.17.1
55
69
  - !ruby/object:Gem::Dependency
56
70
  name: colorize
57
71
  requirement: !ruby/object:Gem::Requirement
@@ -66,68 +80,84 @@ dependencies:
66
80
  - - ">="
67
81
  - !ruby/object:Gem::Version
68
82
  version: '0'
69
- description: Emulating CUI(CLI) help, an user makes and displays his own helps.
70
- email:
71
- - shigeto_nishitani@me.com
83
+ description:
84
+ email: your@email.address.com
72
85
  executables:
73
- - e_h
74
- - emacs_help
75
- - m_t
76
86
  - my_help
77
- - my_todo
78
- - o_h
79
- - org_help
80
87
  extensions: []
81
- extra_rdoc_files: []
88
+ extra_rdoc_files:
89
+ - README.rdoc
90
+ - my_help.rdoc
82
91
  files:
83
92
  - ".dockerignore"
84
93
  - ".gitignore"
85
94
  - ".ruby-version"
86
95
  - ".travis.yml"
87
- - Dockerfile.template
88
96
  - Gemfile
89
97
  - Gemfile.lock
90
98
  - LICENSE.txt
99
+ - README.html
91
100
  - README.org
101
+ - README.rdoc
102
+ - README_en.org
92
103
  - Rakefile
93
- - bin/console
94
- - bin/setup
95
- - docs/README_en.org
96
- - docs/diff_against_org_mode.org
97
- - docs/path_setting.org
98
- - exe/e_h
99
- - exe/emacs_help
100
- - exe/m_t
101
- - exe/my_help
102
- - exe/my_todo
103
- - exe/o_h
104
- - exe/org_help
105
- - lib/emacs_help.rb
104
+ - Rakefile_gli
105
+ - before_gli/Dockerfile.template
106
+ - before_gli/Gemfile
107
+ - before_gli/Gemfile.lock
108
+ - before_gli/bin/console
109
+ - before_gli/bin/setup
110
+ - before_gli/exe/e_h
111
+ - before_gli/exe/emacs_help
112
+ - before_gli/exe/m_t
113
+ - before_gli/exe/my_help
114
+ - before_gli/exe/my_todo
115
+ - before_gli/exe/o_h
116
+ - before_gli/exe/org_help
117
+ - before_gli/lib/emacs_help.rb
118
+ - before_gli/lib/my_help.rb
119
+ - before_gli/lib/my_help/my_help_controll.rb
120
+ - before_gli/lib/my_help/org2yml.rb
121
+ - before_gli/lib/my_help/specific_help.rb
122
+ - before_gli/lib/my_help/test.rb
123
+ - before_gli/lib/my_help/version.rb
124
+ - before_gli/lib/my_help/yml2org.rb
125
+ - before_gli/lib/my_help_new.rb
126
+ - before_gli/lib/my_help_thor.rb
127
+ - before_gli/lib/specific_help.rb
128
+ - before_gli/lib/specific_help_bu.rb
129
+ - before_gli/lib/specific_help_opt.rb
130
+ - before_gli/lib/specific_help_thor.rb
131
+ - before_gli/lib/templates/emacs_help.org
132
+ - before_gli/lib/templates/my_todo.org
133
+ - before_gli/lib/templates/org_help.org
134
+ - before_gli/lib/templates/template_help.org
135
+ - before_gli/make_docker.sh
136
+ - before_gli/my_help.gemspec
137
+ - bin/my_help
106
138
  - lib/my_help.rb
139
+ - lib/my_help/my_help_controll.rb
107
140
  - lib/my_help/org2yml.rb
108
- - lib/my_help/test.rb
109
141
  - lib/my_help/version.rb
110
- - lib/my_help/yml2org.rb
111
- - lib/my_help_thor.rb
112
- - lib/specific_help.rb
113
- - lib/specific_help_bu.rb
114
- - lib/specific_help_opt.rb
115
- - lib/specific_help_thor.rb
116
142
  - lib/templates/emacs_help.org
117
143
  - lib/templates/my_todo.org
118
144
  - lib/templates/org_help.org
119
145
  - lib/templates/template_help.org
120
- - make_docker.sh
121
146
  - my_help.gemspec
122
- homepage: https://github.com/daddygongon/my_help
123
- licenses:
124
- - MIT
125
- metadata:
126
- yard.run: yri
147
+ - my_help.rdoc
148
+ homepage: http://your.website.com
149
+ licenses: []
150
+ metadata: {}
127
151
  post_install_message:
128
- rdoc_options: []
152
+ rdoc_options:
153
+ - "--title"
154
+ - my_help
155
+ - "--main"
156
+ - README.rdoc
157
+ - "-ri"
129
158
  require_paths:
130
159
  - lib
160
+ - lib
131
161
  required_ruby_version: !ruby/object:Gem::Requirement
132
162
  requirements:
133
163
  - - ">="
@@ -143,5 +173,5 @@ rubyforge_project:
143
173
  rubygems_version: 2.6.14
144
174
  signing_key:
145
175
  specification_version: 4
146
- summary: display emacs key bindings in Japanese.
176
+ summary: A description of your project
147
177
  test_files: []
@@ -1,13 +0,0 @@
1
- FROM alpine:3.7
2
-
3
- RUN apk update && apk upgrade
4
- RUN apk --update add \
5
- openssh git build-base libffi libffi-dev \
6
- ruby ruby-dev ruby-rake ruby-bundler
7
-
8
- # RUN git clone https://github.com/daddygongon/my_help.git
9
- COPY . ~/my_help
10
- WORKDIR ~/my_help
11
-
12
- RUN bundle update
13
- RUN bundle exec exe/my_help -m && rake install:local
@@ -1,14 +0,0 @@
1
- #!/usr/bin/env ruby
2
-
3
- require "bundler/setup"
4
- require "my_help"
5
-
6
- # You can add fixtures and/or initialization code here to make experimenting
7
- # with your gem easier. You can also use a different console, if you like.
8
-
9
- # (If you use this, don't forget to add pry to your Gemfile!)
10
- # require "pry"
11
- # Pry.start
12
-
13
- require "irb"
14
- IRB.start
data/bin/setup DELETED
@@ -1,8 +0,0 @@
1
- #!/usr/bin/env bash
2
- set -euo pipefail
3
- IFS=$'\n\t'
4
- set -vx
5
-
6
- bundle install
7
-
8
- # Do any other automated setup that you need to do here
@@ -1,164 +0,0 @@
1
- * Name
2
- :PROPERTIES:
3
- :CUSTOM_ID: name
4
- :END:
5
-
6
- my\_help
7
-
8
- * Summary
9
- :PROPERTIES:
10
- :CUSTOM_ID: summary
11
- :END:
12
-
13
- This gem makes and supplies user specific helps, emulating CUI(CLI) help
14
- usage.
15
-
16
- * Target
17
- :PROPERTIES:
18
- :CUSTOM_ID: target
19
- :END:
20
-
21
- A very novice of learning some specific operation, such as CUI, shell,
22
- or emacs, has difficulty in remembering commands and grammers. If he has
23
- a key, he can easily remember all, but no key brings nothing. Especially
24
- a non-English-native has strong difficulty on the key rememebering. The
25
- problems are,
26
-
27
- - man(ual) is English
28
- - man is heavily documented
29
- - On web, search the same key word,
30
- - and read the same URI repeatedly
31
- - memo goes away somewhere...
32
-
33
- * Specs
34
- :PROPERTIES:
35
- :CUSTOM_ID: specs
36
- :END:
37
-
38
- This gem aims to supply own help by gem environment. Specs are, - user
39
- makes his own help - supplies a template - same format, looks,
40
- operation, and hierarchy - easily see, read - supplies editing and
41
- install commands.
42
-
43
- Wiki targets the whole engineer, my\_help target the specific person.
44
- Half of the wiki aim should be covered by my\_help. Making own manual is
45
- one of the best practices for remembering operations. Memo applications
46
- are good, if you remember the key word. my\_help supplies the key for
47
- remembering the word.
48
-
49
- * Usage
50
- :PROPERTIES:
51
- :CUSTOM_ID: usage
52
- :END:
53
-
54
- ** Install
55
- :PROPERTIES:
56
- :CUSTOM_ID: install
57
- :END:
58
-
59
- Different from the gem standard, fork and clone from Github.
60
-
61
- #+BEGIN_EXAMPLE
62
- github.com:daddygongon/my_help.git
63
- #+END_EXAMPLE
64
-
65
- The following operations are performed under 'bundle'. The main reason
66
- of this disturbance is due the developer not to know the last command of
67
- 'rake install:local' from gem environment.\\
68
- But the second reason is the on-going project to collect and supply the
69
- good helps for novices. We are planning to achieve it by using 'pull
70
- request' of Github.
71
-
72
- Supplied commands are
73
-
74
- #+BEGIN_EXAMPLE
75
- bob% bundle exec exe/my_help
76
- Usage: my_help [options]
77
- -v, --version show program Version.
78
- -l, --list list specific helps
79
- -e, --edit NAME edit NAME help(eg test_help)
80
- -i, --init NAME initialize NAME help(eg test_help).
81
- -m, --make make executables for all helps.
82
- -c, --clean clean up exe dir.
83
- --install_local install local after edit helps
84
- --delete NAME delete NAME help
85
- #+END_EXAMPLE
86
-
87
- At first, see the list of supplied helps by the option of -l.
88
-
89
- #+BEGIN_EXAMPLE
90
- bob% bundle exec exe/my_help -l
91
- "/usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon"
92
- ["-l"]
93
- Specific help file:
94
- emacs_help
95
- test_help
96
- #+END_EXAMPLE
97
-
98
- emacs\_help, e\_h, test\_help, t\_h are ready to use. Play them by a
99
- command such as 'bundle exec exe/e\_h'.
100
-
101
- emacsのキーバインド
102
-
103
- #+BEGIN_EXAMPLE
104
- 特殊キー操作
105
- c-f, controlキーを押しながら 'f'
106
- M-f, escキーを押した後一度離して'f'
107
- 操作の中断c-g, 操作の取り消し(Undo) c-x u
108
- cc by Shigeto R. Nishitani, 2016
109
- Usage: e_h [options]
110
- -v, --version show program Version.
111
- -c, --cursor Cursor移動
112
- -e, --編集 Edit操作
113
- -f, --ファイル File操作
114
- -q, --終了 終了操作
115
- -p, --ページ Page移動
116
- -w, --ウィンドウ Window操作
117
- -b, --バッファ Buffer操作
118
- -m, --mode モード切り替え
119
- --edit edit help contents
120
- --to_hiki convert to hikidoc format
121
- --all display all helps
122
- --store [item] store [item] in back
123
- --remove [item] remove [item] in back
124
- --add [item] add new [item]
125
- #+END_EXAMPLE
126
-
127
- ** Make own help
128
- :PROPERTIES:
129
- :CUSTOM_ID: make-own-help
130
- :END:
131
-
132
- The next step is making own help.\\
133
- For this, -i NAME supplies new NAME help.
134
-
135
- #+BEGIN_EXAMPLE
136
- bob% bundle exec exe/my_help -i new_help
137
- "/usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon"
138
- ["-i", "new_help"]
139
- "/usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon/new_help"
140
- "/usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/my_help/template_help"
141
- cp /usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/my_help/template_help
142
- /usr/local/lib/ruby/gems/2.2.0/gems/my_help-0.2.1/lib/daddygongon/new_help
143
- #+END_EXAMPLE
144
-
145
- it makes get ready the template of new\_help in ~/.my\_help directory.
146
- Edit it by -e new\_help. Then -m makes new\_help and n\_h in exe
147
- directory.
148
-
149
- ** Activate own help (which is automatically done by -m)
150
- :PROPERTIES:
151
- :CUSTOM_ID: activate-own-help-which-is-automatically-done-by--m
152
- :END:
153
-
154
- For the last step, at the my\_help directory, put the commands in as
155
- follows:
156
-
157
- #+BEGIN_EXAMPLE
158
- git add -A
159
- git commit -m 'add new help'
160
- rake install:local
161
- #+END_EXAMPLE
162
-
163
- That's it. You can use the new\_help or short command of n\_h on CUI. If
164
- not, restart the terminal to load the bin path.⏎
@@ -1,38 +0,0 @@
1
- * emacsのorg-modeとかぶるところがたくさんある.
2
- :PROPERTIES:
3
- :CUSTOM_ID: emacsのorg-modeとかぶるところがたくさんある
4
- :END:
5
-
6
- ** 共通点
7
- :PROPERTIES:
8
- :CUSTOM_ID: 共通点
9
- :END:
10
-
11
- - 軽い,
12
- - 保存場所の共通化でどこでも立ち上がる
13
- - 標準(mark dowon)的な記述言語
14
- - todoとmemoが同じ環境
15
- - カラー表示
16
- - emacsでの編集
17
- - リスト,バックアップ, などだれでも考えることは同じなんや.
18
-
19
- でも,
20
-
21
- ** 相違点
22
- :PROPERTIES:
23
- :CUSTOM_ID: 相違点
24
- :END:
25
-
26
- 1. shellかemacsか
27
- 2. emacs以外で使える
28
- 3. org-mode独自のコマンドを覚えなくても使える
29
- 4. rubyでのcoding
30
- 5. ymlデータの共有 なんかがあります.
31
-
32
- つまり,my\_helpの使用想定としては, - emacsを使いたくないexpert -
33
- org-modeを覚えていないnovice - memoなんかをチューンアップしたいrubyist
34
- というところです.
35
-
36
- まあ,my\_help開発に全く意義がないと否定しないでください.
37
- これらの人を対象として, - EDITOR設定を反映 -
38
- orgへのymlからの変換機能の提供 - githubでの公開 を行っています.