Skip to content
This repository was archived by the owner on Jul 30, 2021. It is now read-only.

Commit 73eb361

Browse files
committed
v1.3.1
1 parent bf4160f commit 73eb361

22 files changed

+335
-143
lines changed

Gemfile.lock

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
tls-map (1.3.0)
4+
tls-map (1.3.1)
55
docopt (~> 0.6)
66
paint (~> 2.2)
77
rexml (~> 3.2)

docs/CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22

33
## [Unreleased]
44

5+
## [1.3.1]
6+
57
Fixes:
68

79
- `JSON.load_file()` is only available since Ruby 3.0 so `Utils.json_load_file()` was created to bring compatibility with Ruby 2.X
810

11+
Chore:
12+
13+
- Convert `Utils` methods as module methods instead of instance methods
14+
915
## [1.3.0]
1016

1117
Additions:

docs/yard/TLSmap.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h2>
119119
<dt id="VERSION-constant" class="">VERSION =
120120

121121
</dt>
122-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.2.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
122+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.3.1</span><span class='tstring_end'>&#39;</span></span></pre></dd>
123123

124124
</dl>
125125

@@ -135,7 +135,7 @@ <h2>
135135
</div>
136136

137137
<div id="footer">
138-
Generated on Thu May 27 15:35:08 2021 by
138+
Generated on Wed Jun 9 15:38:55 2021 by
139139
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
140140
0.9.26 (ruby-3.0.1).
141141
</div>

docs/yard/TLSmap/App.html

+151-24
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,6 @@
8787

8888

8989

90-
<dl>
91-
<dt>Includes:</dt>
92-
<dd><span class='object_link'><a href="Utils.html" title="TLSmap::Utils (module)">Utils</a></span></dd>
93-
</dl>
94-
9590

9691

9792

@@ -100,7 +95,7 @@
10095
<dl>
10196
<dt>Defined in:</dt>
10297
<dd>lib/tls_map.rb<span class="defines">,<br />
103-
lib/tls_map/nss.rb,<br /> lib/tls_map/iana.rb,<br /> lib/tls_map/utils.rb,<br /> lib/tls_map/gnutls.rb,<br /> lib/tls_map/output.rb,<br /> lib/tls_map/openssl.rb,<br /> lib/tls_map/extractor.rb,<br /> lib/tls_map/ciphersuiteinfo.rb</span>
98+
lib/tls_map/nss.rb,<br /> lib/tls_map/iana.rb,<br /> lib/tls_map/gnutls.rb,<br /> lib/tls_map/output.rb,<br /> lib/tls_map/openssl.rb,<br /> lib/tls_map/extractor.rb,<br /> lib/tls_map/ciphersuiteinfo.rb</span>
10499
</dd>
105100
</dl>
106101

@@ -195,6 +190,29 @@ <h2>
195190
<li class="public ">
196191
<span class="summary_signature">
197192

193+
<a href="#bulk_search-instance_method" title="#bulk_search (instance method)">#<strong>bulk_search</strong>(critera, file, output = :all) &#x21d2; Array&lt;Hash&gt; </a>
194+
195+
196+
197+
</span>
198+
199+
200+
201+
202+
203+
204+
205+
206+
207+
<span class="summary_desc"><div class='inline'><p>Search for corresponding cipher algorithms in other libraries in bulk.</p>
208+
</div></span>
209+
210+
</li>
211+
212+
213+
<li class="public ">
214+
<span class="summary_signature">
215+
198216
<a href="#export-instance_method" title="#export (instance method)">#<strong>export</strong>(filename, format) &#x21d2; Object </a>
199217

200218

@@ -266,17 +284,6 @@ <h2>
266284
</ul>
267285

268286

269-
270-
271-
272-
273-
274-
275-
276-
277-
278-
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="TLSmap::Utils (module)">Utils</a></span></h3>
279-
<p class="inherited"><span class='object_link'><a href="Utils.html#tmpfile-instance_method" title="TLSmap::Utils#tmpfile (method)">#tmpfile</a></span></p>
280287
<div id="constructor_details" class="method_details_list">
281288
<h2>Constructor Details</h2>
282289

@@ -320,11 +327,11 @@ <h3 class="signature first" id="initialize-instance_method">
320327
<pre class="code"><span class="info file"># File 'lib/tls_map.rb', line 21</span>
321328

322329
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
323-
<span class='ivar'>@iana_file</span> <span class='op'>=</span> <span class='id identifier rubyid_tmpfile'>tmpfile</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>iana</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#IANA_URL-constant" title="TLSmap::App::IANA_URL (constant)">IANA_URL</a></span></span><span class='rparen'>)</span>
324-
<span class='ivar'>@openssl_file</span> <span class='op'>=</span> <span class='id identifier rubyid_tmpfile'>tmpfile</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>openssl</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#OPENSSL_URL-constant" title="TLSmap::App::OPENSSL_URL (constant)">OPENSSL_URL</a></span></span><span class='rparen'>)</span>
325-
<span class='ivar'>@openssl_file2</span> <span class='op'>=</span> <span class='id identifier rubyid_tmpfile'>tmpfile</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>openssl</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#OPENSSL_URL2-constant" title="TLSmap::App::OPENSSL_URL2 (constant)">OPENSSL_URL2</a></span></span><span class='rparen'>)</span>
326-
<span class='ivar'>@gnutls_file</span> <span class='op'>=</span> <span class='id identifier rubyid_tmpfile'>tmpfile</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gnutls</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#GNUTLS_URL-constant" title="TLSmap::App::GNUTLS_URL (constant)">GNUTLS_URL</a></span></span><span class='rparen'>)</span>
327-
<span class='ivar'>@nss_file</span> <span class='op'>=</span> <span class='id identifier rubyid_tmpfile'>tmpfile</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nss</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#NSS_URL-constant" title="TLSmap::App::NSS_URL (constant)">NSS_URL</a></span></span><span class='rparen'>)</span>
330+
<span class='ivar'>@iana_file</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Utils.html" title="TLSmap::Utils (module)">Utils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tmpfile'><span class='object_link'><a href="Utils.html#tmpfile-class_method" title="TLSmap::Utils.tmpfile (method)">tmpfile</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>iana</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#IANA_URL-constant" title="TLSmap::App::IANA_URL (constant)">IANA_URL</a></span></span><span class='rparen'>)</span>
331+
<span class='ivar'>@openssl_file</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Utils.html" title="TLSmap::Utils (module)">Utils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tmpfile'><span class='object_link'><a href="Utils.html#tmpfile-class_method" title="TLSmap::Utils.tmpfile (method)">tmpfile</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>openssl</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#OPENSSL_URL-constant" title="TLSmap::App::OPENSSL_URL (constant)">OPENSSL_URL</a></span></span><span class='rparen'>)</span>
332+
<span class='ivar'>@openssl_file2</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Utils.html" title="TLSmap::Utils (module)">Utils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tmpfile'><span class='object_link'><a href="Utils.html#tmpfile-class_method" title="TLSmap::Utils.tmpfile (method)">tmpfile</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>openssl</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#OPENSSL_URL2-constant" title="TLSmap::App::OPENSSL_URL2 (constant)">OPENSSL_URL2</a></span></span><span class='rparen'>)</span>
333+
<span class='ivar'>@gnutls_file</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Utils.html" title="TLSmap::Utils (module)">Utils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tmpfile'><span class='object_link'><a href="Utils.html#tmpfile-class_method" title="TLSmap::Utils.tmpfile (method)">tmpfile</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>gnutls</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#GNUTLS_URL-constant" title="TLSmap::App::GNUTLS_URL (constant)">GNUTLS_URL</a></span></span><span class='rparen'>)</span>
334+
<span class='ivar'>@nss_file</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Utils.html" title="TLSmap::Utils (module)">Utils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tmpfile'><span class='object_link'><a href="Utils.html#tmpfile-class_method" title="TLSmap::Utils.tmpfile (method)">tmpfile</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nss</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#NSS_URL-constant" title="TLSmap::App::NSS_URL (constant)">NSS_URL</a></span></span><span class='rparen'>)</span>
328335

329336
<span class='ivar'>@tls_map</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
330337
<span class='id identifier rubyid_parse'>parse</span>
@@ -342,7 +349,127 @@ <h2>Instance Method Details</h2>
342349

343350

344351
<div class="method_details first">
345-
<h3 class="signature first" id="export-instance_method">
352+
<h3 class="signature first" id="bulk_search-instance_method">
353+
354+
#<strong>bulk_search</strong>(critera, file, output = :all) &#x21d2; <tt>Array&lt;Hash&gt;</tt>
355+
356+
357+
358+
359+
360+
</h3><div class="docstring">
361+
<div class="discussion">
362+
<p>Search for corresponding cipher algorithms in other libraries in bulk</p>
363+
364+
365+
</div>
366+
</div>
367+
<div class="tags">
368+
<p class="tag_title">Parameters:</p>
369+
<ul class="param">
370+
371+
<li>
372+
373+
<span class='name'>critera</span>
374+
375+
376+
<span class='type'>(<tt>Symbol</tt>)</span>
377+
378+
379+
380+
&mdash;
381+
<div class='inline'><p>The type of <code>term</code>.
382+
Accepted values: <code>:codepoint</code>, <code>:iana</code>, <code>:openssl</code>, <code>:gnutls</code>, <code>:nss</code>.</p>
383+
</div>
384+
385+
</li>
386+
387+
<li>
388+
389+
<span class='name'>file</span>
390+
391+
392+
<span class='type'>(<tt>String</tt>)</span>
393+
394+
395+
396+
&mdash;
397+
<div class='inline'><p>File containing the cipher algorithm names, one per line.</p>
398+
</div>
399+
400+
</li>
401+
402+
<li>
403+
404+
<span class='name'>output</span>
405+
406+
407+
<span class='type'>(<tt>Symbol</tt>)</span>
408+
409+
410+
<em class="default">(defaults to: <tt>:all</tt>)</em>
411+
412+
413+
&mdash;
414+
<div class='inline'><p>The corresponding type to be included in the return value.
415+
Accepted values: <code>:all</code> (default), <code>:codepoint</code>, <code>:iana</code>, <code>:openssl</code>,
416+
<code>:gnutls</code>, <code>:nss</code>.</p>
417+
</div>
418+
419+
</li>
420+
421+
</ul>
422+
423+
<p class="tag_title">Returns:</p>
424+
<ul class="return">
425+
426+
<li>
427+
428+
429+
<span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
430+
431+
432+
433+
&mdash;
434+
<div class='inline'><p>The corresponding type, same as <span class='object_link'><a href="#search-instance_method" title="TLSmap::App#search (method)">#search</a></span> return value
435+
but one per line stored in an array.</p>
436+
</div>
437+
438+
</li>
439+
440+
</ul>
441+
442+
</div><table class="source_code">
443+
<tr>
444+
<td>
445+
<pre class="lines">
446+
447+
448+
67
449+
68
450+
69
451+
70
452+
71
453+
72
454+
73</pre>
455+
</td>
456+
<td>
457+
<pre class="code"><span class="info file"># File 'lib/tls_map.rb', line 67</span>
458+
459+
<span class='kw'>def</span> <span class='id identifier rubyid_bulk_search'>bulk_search</span><span class='lparen'>(</span><span class='id identifier rubyid_critera'>critera</span><span class='comma'>,</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_output'>output</span> <span class='op'>=</span> <span class='symbol'>:all</span><span class='rparen'>)</span>
460+
<span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
461+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_foreach'>foreach</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_line'>line</span><span class='op'>|</span>
462+
<span class='id identifier rubyid_res'>res</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='id identifier rubyid_critera'>critera</span><span class='comma'>,</span> <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span><span class='comma'>,</span> <span class='id identifier rubyid_output'>output</span><span class='rparen'>)</span><span class='rparen'>)</span>
463+
<span class='kw'>end</span>
464+
<span class='id identifier rubyid_res'>res</span>
465+
<span class='kw'>end</span></pre>
466+
</td>
467+
</tr>
468+
</table>
469+
</div>
470+
471+
<div class="method_details ">
472+
<h3 class="signature " id="export-instance_method">
346473

347474
#<strong>export</strong>(filename, format) &#x21d2; <tt>Object</tt>
348475

@@ -559,7 +686,7 @@ <h3 class="signature " id="search-instance_method">
559686
</div>
560687

561688
<div id="footer">
562-
Generated on Thu May 27 15:35:09 2021 by
689+
Generated on Wed Jun 9 15:38:55 2021 by
563690
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
564691
0.9.26 (ruby-3.0.1).
565692
</div>

0 commit comments

Comments
 (0)