simple-service 0.1.4
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.
- checksums.yaml +7 -0
- data/.gitignore +12 -0
- data/.rubocop.yml +100 -0
- data/.tm_properties +1 -0
- data/Gemfile +14 -0
- data/Makefile +9 -0
- data/README.md +68 -0
- data/Rakefile +6 -0
- data/VERSION +1 -0
- data/bin/bundle +105 -0
- data/bin/console +15 -0
- data/bin/rake +29 -0
- data/bin/rspec +29 -0
- data/doc/Simple.html +117 -0
- data/doc/Simple/Service.html +863 -0
- data/doc/Simple/Service/Action.html +1014 -0
- data/doc/Simple/Service/Action/Comment.html +451 -0
- data/doc/Simple/Service/Action/Comment/Extractor.html +347 -0
- data/doc/Simple/Service/Action/IndieHash.html +506 -0
- data/doc/Simple/Service/Action/MethodReflection.html +285 -0
- data/doc/Simple/Service/Action/Parameter.html +816 -0
- data/doc/Simple/Service/ArgumentError.html +128 -0
- data/doc/Simple/Service/ClassMethods.html +187 -0
- data/doc/Simple/Service/Context.html +379 -0
- data/doc/Simple/Service/ContextMissingError.html +124 -0
- data/doc/Simple/Service/ContextReadOnlyError.html +206 -0
- data/doc/Simple/Service/ExtraArguments.html +428 -0
- data/doc/Simple/Service/GemHelper.html +190 -0
- data/doc/Simple/Service/MissingArguments.html +426 -0
- data/doc/Simple/Service/NoSuchAction.html +433 -0
- data/doc/_index.html +286 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +146 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +146 -0
- data/doc/js/app.js +303 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +539 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/simple-service.rb +3 -0
- data/lib/simple/service.rb +143 -0
- data/lib/simple/service/action.rb +203 -0
- data/lib/simple/service/action/comment.rb +57 -0
- data/lib/simple/service/action/indie_hash.rb +37 -0
- data/lib/simple/service/action/method_reflection.rb +70 -0
- data/lib/simple/service/action/parameter.rb +42 -0
- data/lib/simple/service/context.rb +94 -0
- data/lib/simple/service/errors.rb +54 -0
- data/lib/simple/service/version.rb +29 -0
- data/log/.gitkeep +0 -0
- data/scripts/release +2 -0
- data/scripts/release.rb +91 -0
- data/scripts/stats +5 -0
- data/scripts/watch +2 -0
- data/simple-service.gemspec +25 -0
- data/spec/simple/service/action_invoke2_spec.rb +166 -0
- data/spec/simple/service/action_invoke_spec.rb +266 -0
- data/spec/simple/service/action_spec.rb +51 -0
- data/spec/simple/service/context_spec.rb +69 -0
- data/spec/simple/service/service_spec.rb +105 -0
- data/spec/simple/service/version_spec.rb +7 -0
- data/spec/spec_helper.rb +38 -0
- data/spec/support/spec_services.rb +50 -0
- metadata +130 -0
@@ -0,0 +1,146 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.20
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "README";
|
19
|
+
relpath = '';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="file_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="_index.html">Index</a> »
|
40
|
+
<span class="title">File: README</span>
|
41
|
+
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<div id="search">
|
45
|
+
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
47
|
+
href="class_list.html">
|
48
|
+
|
49
|
+
<svg width="24" height="24">
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
</svg>
|
54
|
+
</a>
|
55
|
+
|
56
|
+
</div>
|
57
|
+
<div class="clear"></div>
|
58
|
+
</div>
|
59
|
+
|
60
|
+
<div id="content"><div id='filecontents'><h1>simple-service – at your service!</h1>
|
61
|
+
|
62
|
+
<p>The <code>simple-service</code> ruby gem helps you turn your ruby source code into <em>"services".</em> A service is a module which provides interfaces to one or more methods (<em>"actions"</em>) that implement business logic.</p>
|
63
|
+
|
64
|
+
<p>While one could, of course, call any such method any way one wants, this gem lets you</p>
|
65
|
+
|
66
|
+
<ul>
|
67
|
+
<li>discover available services (their names, their parameters (name, type, default values), comments - see <code>Simple::Service.actions</code>;</li>
|
68
|
+
<li>an interface to "run" (or "execute") a service, with separation from any other parallel runs - see <code>Simple::Service.invoke</code> and <code>Simple::Service.invoke2</code>;</li>
|
69
|
+
<li>a semi-constant "<em>environment</em>" for the duration of an execution;</li>
|
70
|
+
<li><img src="https://badgen.net/badge/TODO/high?color=red" alt="TODO"> a normalized interface to check whether or not a specific service is allowed to run based on the current context.</li>
|
71
|
+
</ul>
|
72
|
+
|
73
|
+
<p>These features allow <em>simple-service</em> to serve as a building block for other tools. It is currently in used in:</p>
|
74
|
+
|
75
|
+
<ul>
|
76
|
+
<li><em>simple-httpd</em>: a simple web server</li>
|
77
|
+
<li><em>simple-cli</em>: the best way to build a ruby CLI.</li>
|
78
|
+
</ul>
|
79
|
+
|
80
|
+
<h2>Example</h2>
|
81
|
+
|
82
|
+
<h3>Defining a service</h3>
|
83
|
+
|
84
|
+
<p>A service module can define one or more services. The following example defines a single service:</p>
|
85
|
+
|
86
|
+
<pre class="code ruby"><code class="ruby"><span class='comment'># A service which constructs universes with different physics.
|
87
|
+
</span><span class='kw'>module</span> <span class='const'>GodMode</span>
|
88
|
+
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span>
|
89
|
+
|
90
|
+
<span class='comment'># Build a universe.
|
91
|
+
</span> <span class='comment'>#
|
92
|
+
</span> <span class='comment'># This comment will become part of the full description of the
|
93
|
+
</span> <span class='comment'># "build_universe" service
|
94
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_build_universe'>build_universe</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>c:</span> <span class='comma'>,</span> <span class='label'>pi:</span> <span class='float'>3.14</span><span class='comma'>,</span> <span class='label'>e:</span> <span class='float'>2.781</span><span class='rparen'>)</span>
|
95
|
+
<span class='comment'># at this point I realize that *I* am not God.
|
96
|
+
</span>
|
97
|
+
<span class='int'>42</span> <span class='comment'># Best try approach
|
98
|
+
</span> <span class='kw'>end</span>
|
99
|
+
<span class='kw'>end</span>
|
100
|
+
</code></pre>
|
101
|
+
|
102
|
+
<h3>Running a service</h3>
|
103
|
+
|
104
|
+
<p>To run the service one uses one of two different methods. If you have an <strong>anonymous array</strong> of arguments - think command line interface - you would call it like this:</p>
|
105
|
+
|
106
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span><span class='period'>.</span><span class='id identifier rubyid_invoke'><span class='object_link'><a href="Simple/Service.html#invoke-class_method" title="Simple::Service.invoke (method)">invoke</a></span></span> <span class='const'>GodMode</span><span class='comma'>,</span> <span class='symbol'>:build_universe</span><span class='comma'>,</span>
|
107
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>My Universe</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
108
|
+
<span class='label'>c:</span> <span class='float'>3e8</span>
|
109
|
+
</code></pre>
|
110
|
+
|
111
|
+
<p>If the calling site, however, has <strong>named arguments</strong> (in a Hash), one would invoke a service using <code>invoke2</code>. This is used for HTTPD integration (with <code>simple-httpd</code>.)</p>
|
112
|
+
|
113
|
+
<pre class="code ruby"><code class="ruby"> <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>My Universe</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>c:</span> <span class='int'>299792458</span><span class='rbrace'>}</span>
|
114
|
+
<span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span><span class='period'>.</span><span class='id identifier rubyid_invoke2'><span class='object_link'><a href="Simple/Service.html#invoke2-class_method" title="Simple::Service.invoke2 (method)">invoke2</a></span></span> <span class='const'>GodMode</span><span class='comma'>,</span>
|
115
|
+
<span class='symbol'>:build_universe</span><span class='comma'>,</span>
|
116
|
+
<span class='label'>args:</span> <span class='id identifier rubyid_args'>args</span>
|
117
|
+
</code></pre>
|
118
|
+
|
119
|
+
<p>Note that you must set a context during the execution; this is done by <code>with_context</code>. A <code>nil</code> context is a valid value which describes an empty context.</p>
|
120
|
+
|
121
|
+
<p>A full example could therefore look like:</p>
|
122
|
+
|
123
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span><span class='period'>.</span><span class='id identifier rubyid_with_context'><span class='object_link'><a href="Simple/Service.html#with_context-class_method" title="Simple::Service.with_context (method)">with_context</a></span></span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span> <span class='kw'>do</span>
|
124
|
+
<span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>My Universe</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>c:</span> <span class='int'>299792458</span><span class='rbrace'>}</span>
|
125
|
+
<span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span><span class='period'>.</span><span class='id identifier rubyid_invoke2'><span class='object_link'><a href="Simple/Service.html#invoke2-class_method" title="Simple::Service.invoke2 (method)">invoke2</a></span></span> <span class='const'>GodMode</span><span class='comma'>,</span>
|
126
|
+
<span class='symbol'>:build_universe</span><span class='comma'>,</span>
|
127
|
+
<span class='label'>args:</span> <span class='id identifier rubyid_args'>args</span>
|
128
|
+
<span class='kw'>end</span>
|
129
|
+
</code></pre>
|
130
|
+
|
131
|
+
<h2>History</h2>
|
132
|
+
|
133
|
+
<p>Historically, the <code>simple-cli</code> gem implemented an easy way to build a CLI application, and therefore needed a way to reflect on existing code to determine which methods to call, which arguments they support etc. Also, the <code>postjob</code> job queue calls a specific method based on its name and an arguments Array or Hash, which is being read from a database. Finally, when I tried to extent <code>postjob</code> with a HTTP interface I discovered that a similar feature would again be extremely useful.</p>
|
134
|
+
|
135
|
+
<p>I therefore extracted these features into a standalone gem.</p>
|
136
|
+
</div></div>
|
137
|
+
|
138
|
+
<div id="footer">
|
139
|
+
Generated on Tue Dec 3 13:46:26 2019 by
|
140
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
141
|
+
0.9.20 (ruby-2.5.1).
|
142
|
+
</div>
|
143
|
+
|
144
|
+
</div>
|
145
|
+
</body>
|
146
|
+
</html>
|
data/doc/file_list.html
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
|
+
<meta charset="utf-8" />
|
6
|
+
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
+
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
+
|
17
|
+
|
18
|
+
<title>File List</title>
|
19
|
+
<base id="base_target" target="_parent" />
|
20
|
+
</head>
|
21
|
+
<body>
|
22
|
+
<div id="content">
|
23
|
+
<div class="fixed_header">
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
25
|
+
<div id="full_list_nav">
|
26
|
+
|
27
|
+
<span><a target="_self" href="class_list.html">
|
28
|
+
Classes
|
29
|
+
</a></span>
|
30
|
+
|
31
|
+
<span><a target="_self" href="method_list.html">
|
32
|
+
Methods
|
33
|
+
</a></span>
|
34
|
+
|
35
|
+
<span><a target="_self" href="file_list.html">
|
36
|
+
Files
|
37
|
+
</a></span>
|
38
|
+
|
39
|
+
</div>
|
40
|
+
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<ul id="full_list" class="file">
|
45
|
+
|
46
|
+
|
47
|
+
<li id="object_README" class="odd">
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
49
|
+
</li>
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
</ul>
|
54
|
+
</div>
|
55
|
+
</body>
|
56
|
+
</html>
|
data/doc/frames.html
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<title>Documentation by YARD 0.9.20</title>
|
6
|
+
</head>
|
7
|
+
<script type="text/javascript" charset="utf-8">
|
8
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
|
+
var name = match ? match[1] : 'index.html';
|
10
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
11
|
+
window.top.location = name;
|
12
|
+
</script>
|
13
|
+
<noscript>
|
14
|
+
<h1>Oops!</h1>
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
16
|
+
</noscript>
|
17
|
+
</html>
|
data/doc/index.html
ADDED
@@ -0,0 +1,146 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.20
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "README";
|
19
|
+
relpath = '';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="_index.html">Index</a> »
|
40
|
+
<span class="title">File: README</span>
|
41
|
+
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<div id="search">
|
45
|
+
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
47
|
+
href="class_list.html">
|
48
|
+
|
49
|
+
<svg width="24" height="24">
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
</svg>
|
54
|
+
</a>
|
55
|
+
|
56
|
+
</div>
|
57
|
+
<div class="clear"></div>
|
58
|
+
</div>
|
59
|
+
|
60
|
+
<div id="content"><div id='filecontents'><h1>simple-service – at your service!</h1>
|
61
|
+
|
62
|
+
<p>The <code>simple-service</code> ruby gem helps you turn your ruby source code into <em>"services".</em> A service is a module which provides interfaces to one or more methods (<em>"actions"</em>) that implement business logic.</p>
|
63
|
+
|
64
|
+
<p>While one could, of course, call any such method any way one wants, this gem lets you</p>
|
65
|
+
|
66
|
+
<ul>
|
67
|
+
<li>discover available services (their names, their parameters (name, type, default values), comments - see <code>Simple::Service.actions</code>;</li>
|
68
|
+
<li>an interface to "run" (or "execute") a service, with separation from any other parallel runs - see <code>Simple::Service.invoke</code> and <code>Simple::Service.invoke2</code>;</li>
|
69
|
+
<li>a semi-constant "<em>environment</em>" for the duration of an execution;</li>
|
70
|
+
<li><img src="https://badgen.net/badge/TODO/high?color=red" alt="TODO"> a normalized interface to check whether or not a specific service is allowed to run based on the current context.</li>
|
71
|
+
</ul>
|
72
|
+
|
73
|
+
<p>These features allow <em>simple-service</em> to serve as a building block for other tools. It is currently in used in:</p>
|
74
|
+
|
75
|
+
<ul>
|
76
|
+
<li><em>simple-httpd</em>: a simple web server</li>
|
77
|
+
<li><em>simple-cli</em>: the best way to build a ruby CLI.</li>
|
78
|
+
</ul>
|
79
|
+
|
80
|
+
<h2>Example</h2>
|
81
|
+
|
82
|
+
<h3>Defining a service</h3>
|
83
|
+
|
84
|
+
<p>A service module can define one or more services. The following example defines a single service:</p>
|
85
|
+
|
86
|
+
<pre class="code ruby"><code class="ruby"><span class='comment'># A service which constructs universes with different physics.
|
87
|
+
</span><span class='kw'>module</span> <span class='const'>GodMode</span>
|
88
|
+
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span>
|
89
|
+
|
90
|
+
<span class='comment'># Build a universe.
|
91
|
+
</span> <span class='comment'>#
|
92
|
+
</span> <span class='comment'># This comment will become part of the full description of the
|
93
|
+
</span> <span class='comment'># "build_universe" service
|
94
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_build_universe'>build_universe</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>c:</span> <span class='comma'>,</span> <span class='label'>pi:</span> <span class='float'>3.14</span><span class='comma'>,</span> <span class='label'>e:</span> <span class='float'>2.781</span><span class='rparen'>)</span>
|
95
|
+
<span class='comment'># at this point I realize that *I* am not God.
|
96
|
+
</span>
|
97
|
+
<span class='int'>42</span> <span class='comment'># Best try approach
|
98
|
+
</span> <span class='kw'>end</span>
|
99
|
+
<span class='kw'>end</span>
|
100
|
+
</code></pre>
|
101
|
+
|
102
|
+
<h3>Running a service</h3>
|
103
|
+
|
104
|
+
<p>To run the service one uses one of two different methods. If you have an <strong>anonymous array</strong> of arguments - think command line interface - you would call it like this:</p>
|
105
|
+
|
106
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span><span class='period'>.</span><span class='id identifier rubyid_invoke'><span class='object_link'><a href="Simple/Service.html#invoke-class_method" title="Simple::Service.invoke (method)">invoke</a></span></span> <span class='const'>GodMode</span><span class='comma'>,</span> <span class='symbol'>:build_universe</span><span class='comma'>,</span>
|
107
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>My Universe</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
108
|
+
<span class='label'>c:</span> <span class='float'>3e8</span>
|
109
|
+
</code></pre>
|
110
|
+
|
111
|
+
<p>If the calling site, however, has <strong>named arguments</strong> (in a Hash), one would invoke a service using <code>invoke2</code>. This is used for HTTPD integration (with <code>simple-httpd</code>.)</p>
|
112
|
+
|
113
|
+
<pre class="code ruby"><code class="ruby"> <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>My Universe</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>c:</span> <span class='int'>299792458</span><span class='rbrace'>}</span>
|
114
|
+
<span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span><span class='period'>.</span><span class='id identifier rubyid_invoke2'><span class='object_link'><a href="Simple/Service.html#invoke2-class_method" title="Simple::Service.invoke2 (method)">invoke2</a></span></span> <span class='const'>GodMode</span><span class='comma'>,</span>
|
115
|
+
<span class='symbol'>:build_universe</span><span class='comma'>,</span>
|
116
|
+
<span class='label'>args:</span> <span class='id identifier rubyid_args'>args</span>
|
117
|
+
</code></pre>
|
118
|
+
|
119
|
+
<p>Note that you must set a context during the execution; this is done by <code>with_context</code>. A <code>nil</code> context is a valid value which describes an empty context.</p>
|
120
|
+
|
121
|
+
<p>A full example could therefore look like:</p>
|
122
|
+
|
123
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span><span class='period'>.</span><span class='id identifier rubyid_with_context'><span class='object_link'><a href="Simple/Service.html#with_context-class_method" title="Simple::Service.with_context (method)">with_context</a></span></span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span> <span class='kw'>do</span>
|
124
|
+
<span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>My Universe</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>c:</span> <span class='int'>299792458</span><span class='rbrace'>}</span>
|
125
|
+
<span class='const'><span class='object_link'><a href="Simple.html" title="Simple (module)">Simple</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Simple/Service.html" title="Simple::Service (module)">Service</a></span></span><span class='period'>.</span><span class='id identifier rubyid_invoke2'><span class='object_link'><a href="Simple/Service.html#invoke2-class_method" title="Simple::Service.invoke2 (method)">invoke2</a></span></span> <span class='const'>GodMode</span><span class='comma'>,</span>
|
126
|
+
<span class='symbol'>:build_universe</span><span class='comma'>,</span>
|
127
|
+
<span class='label'>args:</span> <span class='id identifier rubyid_args'>args</span>
|
128
|
+
<span class='kw'>end</span>
|
129
|
+
</code></pre>
|
130
|
+
|
131
|
+
<h2>History</h2>
|
132
|
+
|
133
|
+
<p>Historically, the <code>simple-cli</code> gem implemented an easy way to build a CLI application, and therefore needed a way to reflect on existing code to determine which methods to call, which arguments they support etc. Also, the <code>postjob</code> job queue calls a specific method based on its name and an arguments Array or Hash, which is being read from a database. Finally, when I tried to extent <code>postjob</code> with a HTTP interface I discovered that a similar feature would again be extremely useful.</p>
|
134
|
+
|
135
|
+
<p>I therefore extracted these features into a standalone gem.</p>
|
136
|
+
</div></div>
|
137
|
+
|
138
|
+
<div id="footer">
|
139
|
+
Generated on Tue Dec 3 13:46:26 2019 by
|
140
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
141
|
+
0.9.20 (ruby-2.5.1).
|
142
|
+
</div>
|
143
|
+
|
144
|
+
</div>
|
145
|
+
</body>
|
146
|
+
</html>
|
data/doc/js/app.js
ADDED
@@ -0,0 +1,303 @@
|
|
1
|
+
(function() {
|
2
|
+
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
6
|
+
|
7
|
+
function createSourceLinks() {
|
8
|
+
$('.method_details_list .source_code').
|
9
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
10
|
+
$('.toggleSource').toggle(function() {
|
11
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
12
|
+
$(this).text("Hide source");
|
13
|
+
},
|
14
|
+
function() {
|
15
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
16
|
+
$(this).text("View source");
|
17
|
+
});
|
18
|
+
}
|
19
|
+
|
20
|
+
function createDefineLinks() {
|
21
|
+
var tHeight = 0;
|
22
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
23
|
+
$('.toggleDefines').toggle(function() {
|
24
|
+
tHeight = $(this).parent().prev().height();
|
25
|
+
$(this).prev().css('display', 'inline');
|
26
|
+
$(this).parent().prev().height($(this).parent().height());
|
27
|
+
$(this).text("(less)");
|
28
|
+
},
|
29
|
+
function() {
|
30
|
+
$(this).prev().hide();
|
31
|
+
$(this).parent().prev().height(tHeight);
|
32
|
+
$(this).text("more...");
|
33
|
+
});
|
34
|
+
}
|
35
|
+
|
36
|
+
function createFullTreeLinks() {
|
37
|
+
var tHeight = 0;
|
38
|
+
$('.inheritanceTree').toggle(function() {
|
39
|
+
tHeight = $(this).parent().prev().height();
|
40
|
+
$(this).parent().toggleClass('showAll');
|
41
|
+
$(this).text("(hide)");
|
42
|
+
$(this).parent().prev().height($(this).parent().height());
|
43
|
+
},
|
44
|
+
function() {
|
45
|
+
$(this).parent().toggleClass('showAll');
|
46
|
+
$(this).parent().prev().height(tHeight);
|
47
|
+
$(this).text("show all");
|
48
|
+
});
|
49
|
+
}
|
50
|
+
|
51
|
+
function searchFrameButtons() {
|
52
|
+
$('.full_list_link').click(function() {
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
54
|
+
return false;
|
55
|
+
});
|
56
|
+
window.addEventListener('message', function(e) {
|
57
|
+
if (e.data === 'navEscape') {
|
58
|
+
$('#nav').slideUp(100);
|
59
|
+
$('#search a').removeClass('active inactive');
|
60
|
+
$(window).focus();
|
61
|
+
}
|
62
|
+
});
|
63
|
+
|
64
|
+
$(window).resize(function() {
|
65
|
+
if ($('#search:visible').length === 0) {
|
66
|
+
$('#nav').removeAttr('style');
|
67
|
+
$('#search a').removeClass('active inactive');
|
68
|
+
$(window).focus();
|
69
|
+
}
|
70
|
+
});
|
71
|
+
}
|
72
|
+
|
73
|
+
function toggleSearchFrame(id, link) {
|
74
|
+
var frame = $('#nav');
|
75
|
+
$('#search a').removeClass('active').addClass('inactive');
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
77
|
+
frame.slideUp(100);
|
78
|
+
$('#search a').removeClass('active inactive');
|
79
|
+
}
|
80
|
+
else {
|
81
|
+
$(id).addClass('active').removeClass('inactive');
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
83
|
+
frame.slideDown(100);
|
84
|
+
}
|
85
|
+
}
|
86
|
+
|
87
|
+
function linkSummaries() {
|
88
|
+
$('.summary_signature').click(function() {
|
89
|
+
document.location = $(this).find('a').attr('href');
|
90
|
+
});
|
91
|
+
}
|
92
|
+
|
93
|
+
function summaryToggle() {
|
94
|
+
$('.summary_toggle').click(function(e) {
|
95
|
+
e.preventDefault();
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
97
|
+
$('.summary_toggle').each(function() {
|
98
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
99
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
100
|
+
if (next.hasClass('compact')) {
|
101
|
+
next.toggle();
|
102
|
+
next.nextAll('ul.summary').first().toggle();
|
103
|
+
}
|
104
|
+
else if (next.hasClass('summary')) {
|
105
|
+
var list = $('<ul class="summary compact" />');
|
106
|
+
list.html(next.html());
|
107
|
+
list.find('.summary_desc, .note').remove();
|
108
|
+
list.find('a').each(function() {
|
109
|
+
$(this).html($(this).find('strong').html());
|
110
|
+
$(this).parent().html($(this)[0].outerHTML);
|
111
|
+
});
|
112
|
+
next.before(list);
|
113
|
+
next.toggle();
|
114
|
+
}
|
115
|
+
});
|
116
|
+
return false;
|
117
|
+
});
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
119
|
+
$('.summary_toggle').first().click();
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
121
|
+
}
|
122
|
+
|
123
|
+
function constantSummaryToggle() {
|
124
|
+
$('.constants_summary_toggle').click(function(e) {
|
125
|
+
e.preventDefault();
|
126
|
+
localStorage.summaryCollapsed = $(this).text();
|
127
|
+
$('.constants_summary_toggle').each(function() {
|
128
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
129
|
+
var next = $(this).parent().parent().nextAll('dl.constants').first();
|
130
|
+
if (next.hasClass('compact')) {
|
131
|
+
next.toggle();
|
132
|
+
next.nextAll('dl.constants').first().toggle();
|
133
|
+
}
|
134
|
+
else if (next.hasClass('constants')) {
|
135
|
+
var list = $('<dl class="constants compact" />');
|
136
|
+
list.html(next.html());
|
137
|
+
list.find('dt').each(function() {
|
138
|
+
$(this).addClass('summary_signature');
|
139
|
+
$(this).text( $(this).text().split('=')[0]);
|
140
|
+
if ($(this).has(".deprecated").length) {
|
141
|
+
$(this).addClass('deprecated');
|
142
|
+
};
|
143
|
+
});
|
144
|
+
// Add the value of the constant as "Tooltip" to the summary object
|
145
|
+
list.find('pre.code').each(function() {
|
146
|
+
console.log($(this).parent());
|
147
|
+
var dt_element = $(this).parent().prev();
|
148
|
+
var tooltip = $(this).text();
|
149
|
+
if (dt_element.hasClass("deprecated")) {
|
150
|
+
tooltip = 'Deprecated. ' + tooltip;
|
151
|
+
};
|
152
|
+
dt_element.attr('title', tooltip);
|
153
|
+
});
|
154
|
+
list.find('.docstring, .tags, dd').remove();
|
155
|
+
next.before(list);
|
156
|
+
next.toggle();
|
157
|
+
}
|
158
|
+
});
|
159
|
+
return false;
|
160
|
+
});
|
161
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
162
|
+
$('.constants_summary_toggle').first().click();
|
163
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
164
|
+
}
|
165
|
+
|
166
|
+
function generateTOC() {
|
167
|
+
if ($('#filecontents').length === 0) return;
|
168
|
+
var _toc = $('<ol class="top"></ol>');
|
169
|
+
var show = false;
|
170
|
+
var toc = _toc;
|
171
|
+
var counter = 0;
|
172
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
173
|
+
var i;
|
174
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
175
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
176
|
+
var lastTag = parseInt(tags[0][1], 10);
|
177
|
+
$(tags.join(', ')).each(function() {
|
178
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
179
|
+
if (this.id == "filecontents") return;
|
180
|
+
show = true;
|
181
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
182
|
+
if (this.id.length === 0) {
|
183
|
+
var proposedId = $(this).attr('toc-id');
|
184
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
185
|
+
else {
|
186
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
187
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
188
|
+
this.id = proposedId;
|
189
|
+
}
|
190
|
+
}
|
191
|
+
if (thisTag > lastTag) {
|
192
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
193
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
194
|
+
}
|
195
|
+
}
|
196
|
+
if (thisTag < lastTag) {
|
197
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
198
|
+
}
|
199
|
+
var title = $(this).attr('toc-title');
|
200
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
201
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
202
|
+
lastTag = thisTag;
|
203
|
+
});
|
204
|
+
if (!show) return;
|
205
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
206
|
+
$('#content').prepend(html);
|
207
|
+
$('#toc').append(_toc);
|
208
|
+
$('#toc .hide_toc').toggle(function() {
|
209
|
+
$('#toc .top').slideUp('fast');
|
210
|
+
$('#toc').toggleClass('hidden');
|
211
|
+
$('#toc .title small').toggle();
|
212
|
+
}, function() {
|
213
|
+
$('#toc .top').slideDown('fast');
|
214
|
+
$('#toc').toggleClass('hidden');
|
215
|
+
$('#toc .title small').toggle();
|
216
|
+
});
|
217
|
+
}
|
218
|
+
|
219
|
+
function navResizeFn(e) {
|
220
|
+
if (e.which !== 1) {
|
221
|
+
navResizeFnStop();
|
222
|
+
return;
|
223
|
+
}
|
224
|
+
|
225
|
+
sessionStorage.navWidth = e.pageX.toString();
|
226
|
+
$('.nav_wrap').css('width', e.pageX);
|
227
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
228
|
+
}
|
229
|
+
|
230
|
+
function navResizeFnStop() {
|
231
|
+
$(window).unbind('mousemove', navResizeFn);
|
232
|
+
window.removeEventListener('message', navMessageFn, false);
|
233
|
+
}
|
234
|
+
|
235
|
+
function navMessageFn(e) {
|
236
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
237
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
238
|
+
}
|
239
|
+
|
240
|
+
function navResizer() {
|
241
|
+
$('#resizer').mousedown(function(e) {
|
242
|
+
e.preventDefault();
|
243
|
+
$(window).mousemove(navResizeFn);
|
244
|
+
window.addEventListener('message', navMessageFn, false);
|
245
|
+
});
|
246
|
+
$(window).mouseup(navResizeFnStop);
|
247
|
+
|
248
|
+
if (sessionStorage.navWidth) {
|
249
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
250
|
+
}
|
251
|
+
}
|
252
|
+
|
253
|
+
function navExpander() {
|
254
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
255
|
+
function postMessage() {
|
256
|
+
if (done) return;
|
257
|
+
clearTimeout(timer);
|
258
|
+
var opts = { action: 'expand', path: pathId };
|
259
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
260
|
+
done = true;
|
261
|
+
}
|
262
|
+
|
263
|
+
window.addEventListener('message', function(event) {
|
264
|
+
if (event.data === 'navReady') postMessage();
|
265
|
+
return false;
|
266
|
+
}, false);
|
267
|
+
}
|
268
|
+
|
269
|
+
function mainFocus() {
|
270
|
+
var hash = window.location.hash;
|
271
|
+
if (hash !== '' && $(hash)[0]) {
|
272
|
+
$(hash)[0].scrollIntoView();
|
273
|
+
}
|
274
|
+
|
275
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
276
|
+
}
|
277
|
+
|
278
|
+
function navigationChange() {
|
279
|
+
// This works around the broken anchor navigation with the YARD template.
|
280
|
+
window.onpopstate = function() {
|
281
|
+
var hash = window.location.hash;
|
282
|
+
if (hash !== '' && $(hash)[0]) {
|
283
|
+
$(hash)[0].scrollIntoView();
|
284
|
+
}
|
285
|
+
};
|
286
|
+
}
|
287
|
+
|
288
|
+
$(document).ready(function() {
|
289
|
+
navResizer();
|
290
|
+
navExpander();
|
291
|
+
createSourceLinks();
|
292
|
+
createDefineLinks();
|
293
|
+
createFullTreeLinks();
|
294
|
+
searchFrameButtons();
|
295
|
+
linkSummaries();
|
296
|
+
summaryToggle();
|
297
|
+
constantSummaryToggle();
|
298
|
+
generateTOC();
|
299
|
+
mainFocus();
|
300
|
+
navigationChange();
|
301
|
+
});
|
302
|
+
|
303
|
+
})();
|