RubyGems - my_help - Versions diffs - 1.2.2 → 1.2.3 - Mend

my_help 1.2.2 → 1.2.3

Files changed (39) hide show

checksums.yaml +4 -4
data/.yardoc/checksums +4 -4
data/.yardoc/objects/root.dat +0 -0
data/Gemfile.lock +1 -1
data/Rakefile +20 -1
data/lib/my_help/cli.rb +1 -0
data/lib/my_help/config.rb +1 -1
data/lib/my_help/list.rb +5 -3
data/lib/my_help/version.rb +1 -1
data/lib/templates/example.org +3 -5
metadata +2 -30
data/doc/MyHelp/CLI.html +0 -749
data/doc/MyHelp/Config.html +0 -693
data/doc/MyHelp/Control.html +0 -1127
data/doc/MyHelp/Error.html +0 -124
data/doc/MyHelp/GetConfig.html +0 -196
data/doc/MyHelp/Git.html +0 -291
data/doc/MyHelp/Init.html +0 -449
data/doc/MyHelp/List.html +0 -577
data/doc/MyHelp/Md2Hash.html +0 -632
data/doc/MyHelp/Modify.html +0 -393
data/doc/MyHelp/Org2Hash.html +0 -542
data/doc/MyHelp.html +0 -135
data/doc/Org2Yaml.html +0 -497
data/doc/OrgToYaml.html +0 -497
data/doc/_index.html +0 -230
data/doc/class_list.html +0 -51
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -58
data/doc/css/style.css +0 -497
data/doc/file.README.html +0 -181
data/doc/file_list.html +0 -56
data/doc/frames.html +0 -17
data/doc/index.html +0 -181
data/doc/js/app.js +0 -314
data/doc/js/full_list.js +0 -216
data/doc/js/jquery.js +0 -4
data/doc/method_list.html +0 -451
data/doc/top-level-namespace.html +0 -112

data/doc/MyHelp/Config.html DELETED Viewed

@@ -1,693 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: MyHelp::Config
-    &mdash; Documentation by YARD 0.9.28
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" />
-<script type="text/javascript">
-  pathId = "MyHelp::Config";
-  relpath = '../';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../_index.html">Index (C)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../MyHelp.html" title="MyHelp (module)">MyHelp</a></span></span>
-     &raquo;
-    <span class="title">Config</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Class: MyHelp::Config
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">Object</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">MyHelp::Config</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/my_help/config.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>make @config from default and load yaml as shown <a href="https://stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem">stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem</a></p>
-  </div>
-</div>
-<div class="tags">
-</div>
-  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#config-instance_method" title="#config (instance method)">#<strong>config</strong>  &#x21d2; Object </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute config.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#valid_config_keys-instance_method" title="#valid_config_keys (instance method)">#<strong>valid_config_keys</strong>  &#x21d2; Object </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute valid_config_keys.</p>
-</div></span>
-</li>
-  </ul>
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(sym)  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#configure-instance_method" title="#configure (instance method)">#<strong>configure</strong>(opts = nil)  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Configure through hash.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#configure_with-instance_method" title="#configure_with (instance method)">#<strong>configure_with</strong>(path)  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Configure through yaml file.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(conf_path = nil)  &#x21d2; Config </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>
-<p>Configuration defaults.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#save_config-instance_method" title="#save_config (instance method)">#<strong>save_config</strong>  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>save config in  @<a href=":conf_file">config</a>.</p>
-</div></span>
-</li>
-    </ul>
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <h3 class="signature first" id="initialize-instance_method">
-    #<strong>initialize</strong>(conf_path = nil)  &#x21d2; <tt><span class='object_link'><a href="" title="MyHelp::Config (class)">Config</a></span></tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Configuration defaults</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 9</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_conf_path'>conf_path</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_conf_path'>conf_path</span> <span class='op'>||=</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HOME</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_local_help_dir'>local_help_dir</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_conf_path'>conf_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.my_help</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
-  <span class='ivar'>@config</span> <span class='op'>=</span> <span class='lbrace'>{</span>
-    <span class='label'>template_dir:</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>../templates</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid___dir__'>__dir__</span><span class='rparen'>)</span><span class='comma'>,</span>
-    <span class='label'>local_help_dir:</span> <span class='id identifier rubyid_local_help_dir'>local_help_dir</span><span class='comma'>,</span>
-    <span class='label'>conf_file:</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_local_help_dir'>local_help_dir</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.my_help_conf.yml</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
-    <span class='label'>editor:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>EDITOR</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>emacs</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-    <span class='label'>ext:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.org</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-    <span class='label'>verbose:</span> <span class='kw'>false</span><span class='comma'>,</span>
-  <span class='rbrace'>}</span>
-  <span class='ivar'>@valid_config_keys</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
-  <span class='id identifier rubyid_configure_with'>configure_with</span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:conf_file</span><span class='rbracket'>]</span><span class='rparen'>)</span>
-  <span class='comment'>#      YAML.dump(@config, File.open(@config[:conf_file], &#39;w&#39;))
-</span>  <span class='comment'># no good for multiple testers.
-</span><span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id=""></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="config-instance_method">
-    #<strong>config</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns the value of attribute config.</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-64
-65
-66</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 64</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
-  <span class='ivar'>@config</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id=""></span>
-      <div class="method_details ">
-  <h3 class="signature " id="valid_config_keys-instance_method">
-    #<strong>valid_config_keys</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns the value of attribute valid_config_keys.</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-7
-8
-9</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 7</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_valid_config_keys'>valid_config_keys</span>
-  <span class='ivar'>@valid_config_keys</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="[]-instance_method">
-    #<strong>[]</strong>(sym)  &#x21d2; <tt>Object</tt>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-66
-67
-68</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 66</span>
-<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span>
-  <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='id identifier rubyid_sym'>sym</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="configure-instance_method">
-    #<strong>configure</strong>(opts = nil)  &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Configure through hash</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 27</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>==</span> <span class='kw'>nil</span>
-  <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
-    <span class='kw'>if</span> <span class='ivar'>@valid_config_keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
-      <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span>
-    <span class='kw'>elsif</span> <span class='id identifier rubyid_k'>k</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
-      <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Valid key words are follows:</span><span class='tstring_end'>&quot;</span></span>
-      <span class='id identifier rubyid_p'>p</span> <span class='ivar'>@valid_config_keys</span>
-    <span class='kw'>else</span>
-      <span class='id identifier rubyid_raise'>raise</span> <span class='const'>KeyError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error: keyword &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; is invalid</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-                         <span class='label'>receiver:</span> <span class='ivar'>@config</span><span class='comma'>,</span>
-                         <span class='label'>key:</span> <span class='id identifier rubyid_k'>k</span><span class='rparen'>)</span>
-    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-  <span class='ivar'>@config</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="configure_with-instance_method">
-    #<strong>configure_with</strong>(path)  &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Configure through yaml file</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 45</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_configure_with'>configure_with</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
-  <span class='kw'>begin</span>
-    <span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_safe_load'>safe_load</span><span class='lparen'>(</span><span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span>
-                            <span class='label'>permitted_classes:</span> <span class='lbracket'>[</span><span class='const'>Symbol</span><span class='rbracket'>]</span><span class='rparen'>)</span>
-  <span class='kw'>rescue</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>ENOENT</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
-    <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>WARNING: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_content'>.\nUsing default conf.</span><span class='tstring_end'>&quot;</span></span>
-    <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_message'>message</span> <span class='kw'>if</span> <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:verbose</span><span class='rbracket'>]</span>
-  <span class='kw'>rescue</span> <span class='const'>Psych</span><span class='op'>::</span><span class='const'>SyntaxError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
-    <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>WARNING: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_content'>.\nUsing default conf.</span><span class='tstring_end'>&quot;</span></span>
-    <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_message'>message</span> <span class='kw'>if</span> <span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:verbose</span><span class='rbracket'>]</span>
-  <span class='kw'>end</span>
-  <span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="save_config-instance_method">
-    #<strong>save_config</strong>  &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>save config in  @<a href=":conf_file">config</a></p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-60
-61
-62</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/my_help/config.rb', line 60</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_save_config'>save_config</span><span class='lparen'>(</span><span class='rparen'>)</span>
-  <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='lbracket'>[</span><span class='symbol'>:conf_file</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Fri Jan  6 13:07:57 2023 by
-  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.2).
-</div>
-    </div>
-  </body>
-</html>