artifactory-cleaner 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +4 -0
- data/.idea/.gitignore +2 -0
- data/.idea/checkstyle-idea.xml +16 -0
- data/.idea/dictionaries/jgitlin.xml +7 -0
- data/.idea/misc.xml +6 -0
- data/.idea/modules.xml +8 -0
- data/.idea/vcs.xml +6 -0
- data/.rspec +3 -0
- data/.rspec_status +39 -0
- data/.travis.yml +6 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +12 -0
- data/README.md +73 -0
- data/Rakefile +20 -0
- data/artifactory-cleaner.gemspec +43 -0
- data/artifactory-cleaner.iml +9 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/doc/rdoc/Artifactory.html +94 -0
- data/doc/rdoc/Artifactory/Cleaner.html +108 -0
- data/doc/rdoc/Artifactory/Cleaner/ArtifactBucket.html +504 -0
- data/doc/rdoc/Artifactory/Cleaner/ArtifactBucketCollection.html +570 -0
- data/doc/rdoc/Artifactory/Cleaner/ArtifactFilter.html +712 -0
- data/doc/rdoc/Artifactory/Cleaner/ArtifactFilterRule.html +519 -0
- data/doc/rdoc/Artifactory/Cleaner/CLI.html +625 -0
- data/doc/rdoc/Artifactory/Cleaner/Controller.html +1014 -0
- data/doc/rdoc/Artifactory/Cleaner/DiscoveredArtifact.html +400 -0
- data/doc/rdoc/Artifactory/Cleaner/DiscoveryWorker.html +466 -0
- data/doc/rdoc/Artifactory/Cleaner/Error.html +101 -0
- data/doc/rdoc/Artifactory/Cleaner/SpecHelpers.html +190 -0
- data/doc/rdoc/Artifactory/Cleaner/Util.html +157 -0
- data/doc/rdoc/CODE_OF_CONDUCT_md.html +228 -0
- data/doc/rdoc/Float.html +94 -0
- data/doc/rdoc/Gemfile.html +144 -0
- data/doc/rdoc/Gemfile_lock.html +217 -0
- data/doc/rdoc/Object.html +112 -0
- data/doc/rdoc/README_md.html +241 -0
- data/doc/rdoc/Rakefile.html +151 -0
- data/doc/rdoc/artifactory-cleaner_gemspec.html +173 -0
- data/doc/rdoc/artifactory-cleaner_iml.html +139 -0
- data/doc/rdoc/bin/setup.html +134 -0
- data/doc/rdoc/created.rid +219 -0
- data/doc/rdoc/css/fonts.css +167 -0
- data/doc/rdoc/css/rdoc.css +590 -0
- data/doc/rdoc/filterlist_yaml.html +149 -0
- data/doc/rdoc/filters/clean-amzn_yaml.html +133 -0
- data/doc/rdoc/filters/snapshots_yaml.html +137 -0
- data/doc/rdoc/filters/test-filter_yaml.html +137 -0
- data/doc/rdoc/filters/yum-test_yaml.html +141 -0
- data/doc/rdoc/fonts/Lato-Light.ttf +0 -0
- data/doc/rdoc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/rdoc/fonts/Lato-Regular.ttf +0 -0
- data/doc/rdoc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/rdoc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/rdoc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/rdoc/images/add.png +0 -0
- data/doc/rdoc/images/arrow_up.png +0 -0
- data/doc/rdoc/images/brick.png +0 -0
- data/doc/rdoc/images/brick_link.png +0 -0
- data/doc/rdoc/images/bug.png +0 -0
- data/doc/rdoc/images/bullet_black.png +0 -0
- data/doc/rdoc/images/bullet_toggle_minus.png +0 -0
- data/doc/rdoc/images/bullet_toggle_plus.png +0 -0
- data/doc/rdoc/images/date.png +0 -0
- data/doc/rdoc/images/delete.png +0 -0
- data/doc/rdoc/images/find.png +0 -0
- data/doc/rdoc/images/loadingAnimation.gif +0 -0
- data/doc/rdoc/images/macFFBgHack.png +0 -0
- data/doc/rdoc/images/package.png +0 -0
- data/doc/rdoc/images/page_green.png +0 -0
- data/doc/rdoc/images/page_white_text.png +0 -0
- data/doc/rdoc/images/page_white_width.png +0 -0
- data/doc/rdoc/images/plugin.png +0 -0
- data/doc/rdoc/images/ruby.png +0 -0
- data/doc/rdoc/images/tag_blue.png +0 -0
- data/doc/rdoc/images/tag_green.png +0 -0
- data/doc/rdoc/images/transparent.png +0 -0
- data/doc/rdoc/images/wrench.png +0 -0
- data/doc/rdoc/images/wrench_orange.png +0 -0
- data/doc/rdoc/images/zoom.png +0 -0
- data/doc/rdoc/index.html +166 -0
- data/doc/rdoc/js/darkfish.js +161 -0
- data/doc/rdoc/js/jquery.js +4 -0
- data/doc/rdoc/js/navigation.js +141 -0
- data/doc/rdoc/js/navigation.js.gz +0 -0
- data/doc/rdoc/js/search.js +109 -0
- data/doc/rdoc/js/search_index.js +1 -0
- data/doc/rdoc/js/search_index.js.gz +0 -0
- data/doc/rdoc/js/searcher.js +229 -0
- data/doc/rdoc/js/searcher.js.gz +0 -0
- data/doc/rdoc/results/archive-test-4_log.html +762 -0
- data/doc/rdoc/results/buckets-2020-01-31_txt.html +233 -0
- data/doc/rdoc/results/clean-test-2_log.html +598 -0
- data/doc/rdoc/results/clean-test-3_log.html +128 -0
- data/doc/rdoc/results/clean-test-5_log.html +2721 -0
- data/doc/rdoc/results/clean-test-6_log.html +135 -0
- data/doc/rdoc/results/clean-test-7_log.html +137 -0
- data/doc/rdoc/results/clean-test-8-real_log.html +131 -0
- data/doc/rdoc/results/clean-test-9_log.html +131 -0
- data/doc/rdoc/results/clean-test1_log.html +1759 -0
- data/doc/rdoc/results/yum-test_2020-01-31_log.html +2854 -0
- data/doc/rdoc/results/yum-test_dry-run_log.html +1074 -0
- data/doc/rdoc/table_of_contents.html +581 -0
- data/exe/artifactory-cleaner +12 -0
- data/lib/artifactory/cleaner.rb +17 -0
- data/lib/artifactory/cleaner/artifact_bucket.rb +102 -0
- data/lib/artifactory/cleaner/artifact_bucket_collection.rb +118 -0
- data/lib/artifactory/cleaner/artifact_filter.rb +146 -0
- data/lib/artifactory/cleaner/artifact_filter_rule.rb +81 -0
- data/lib/artifactory/cleaner/cli.rb +415 -0
- data/lib/artifactory/cleaner/controller.rb +466 -0
- data/lib/artifactory/cleaner/discovered_artifact.rb +71 -0
- data/lib/artifactory/cleaner/discovery_worker.rb +126 -0
- data/lib/artifactory/cleaner/util.rb +21 -0
- data/lib/artifactory/cleaner/version.rb +7 -0
- metadata +252 -0
@@ -0,0 +1,400 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>class Artifactory::Cleaner::DiscoveredArtifact - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<script type="text/javascript">
|
10
|
+
var rdoc_rel_prefix = "../../";
|
11
|
+
var index_rel_prefix = "../../";
|
12
|
+
</script>
|
13
|
+
|
14
|
+
<script src="../../js/jquery.js"></script>
|
15
|
+
<script src="../../js/darkfish.js"></script>
|
16
|
+
|
17
|
+
<link href="../../css/fonts.css" rel="stylesheet">
|
18
|
+
<link href="../../css/rdoc.css" rel="stylesheet">
|
19
|
+
|
20
|
+
|
21
|
+
|
22
|
+
<body id="top" role="document" class="class">
|
23
|
+
<nav role="navigation">
|
24
|
+
<div id="project-navigation">
|
25
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
26
|
+
<h2>
|
27
|
+
<a href="../../index.html" rel="home">Home</a>
|
28
|
+
</h2>
|
29
|
+
|
30
|
+
<div id="table-of-contents-navigation">
|
31
|
+
<a href="../../table_of_contents.html#pages">Pages</a>
|
32
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
33
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
34
|
+
</div>
|
35
|
+
</div>
|
36
|
+
|
37
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
38
|
+
<form action="#" method="get" accept-charset="utf-8">
|
39
|
+
<div id="search-field-wrapper">
|
40
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
41
|
+
aria-autocomplete="list" aria-controls="search-results"
|
42
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
43
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<ul id="search-results" aria-label="Search Results"
|
47
|
+
aria-busy="false" aria-expanded="false"
|
48
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
49
|
+
</form>
|
50
|
+
</div>
|
51
|
+
|
52
|
+
</div>
|
53
|
+
|
54
|
+
|
55
|
+
|
56
|
+
<div id="class-metadata">
|
57
|
+
|
58
|
+
<div id="parent-class-section" class="nav-section">
|
59
|
+
<h3>Parent</h3>
|
60
|
+
|
61
|
+
|
62
|
+
<p class="link">Artifactory::Resource::Artifact
|
63
|
+
|
64
|
+
</div>
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
<!-- Method Quickref -->
|
69
|
+
<div id="method-list-section" class="nav-section">
|
70
|
+
<h3>Methods</h3>
|
71
|
+
|
72
|
+
<ul class="link-list" role="directory">
|
73
|
+
|
74
|
+
<li ><a href="#method-c-earliest_date_from">::earliest_date_from</a>
|
75
|
+
|
76
|
+
<li ><a href="#method-c-latest_date_from">::latest_date_from</a>
|
77
|
+
|
78
|
+
<li ><a href="#method-i-earliest_date">#earliest_date</a>
|
79
|
+
|
80
|
+
<li ><a href="#method-i-filename">#filename</a>
|
81
|
+
|
82
|
+
<li ><a href="#method-i-last_downloaded">#last_downloaded</a>
|
83
|
+
|
84
|
+
<li ><a href="#method-i-latest_date">#latest_date</a>
|
85
|
+
|
86
|
+
<li ><a href="#method-i-to_s">#to_s</a>
|
87
|
+
|
88
|
+
</ul>
|
89
|
+
</div>
|
90
|
+
|
91
|
+
</div>
|
92
|
+
</nav>
|
93
|
+
|
94
|
+
<main role="main" aria-labelledby="class-Artifactory::Cleaner::DiscoveredArtifact">
|
95
|
+
<h1 id="class-Artifactory::Cleaner::DiscoveredArtifact" class="class">
|
96
|
+
class Artifactory::Cleaner::DiscoveredArtifact
|
97
|
+
</h1>
|
98
|
+
|
99
|
+
<section class="description">
|
100
|
+
|
101
|
+
<p>An Artifact discovered during a repository search</p>
|
102
|
+
|
103
|
+
<p>This class is a wrapper of Artifactory::Resource::Artifact because the
|
104
|
+
parent class does not have a concept of `last_downloaded` nor the most
|
105
|
+
recent date for any action on an Artifact. These are important to deciding
|
106
|
+
if an Artifcat should be deleted</p>
|
107
|
+
|
108
|
+
</section>
|
109
|
+
|
110
|
+
|
111
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
122
|
+
<header>
|
123
|
+
<h3>Public Class Methods</h3>
|
124
|
+
</header>
|
125
|
+
|
126
|
+
|
127
|
+
<div id="method-c-earliest_date_from" class="method-detail ">
|
128
|
+
|
129
|
+
<div class="method-heading">
|
130
|
+
<span class="method-name">earliest_date_from</span><span
|
131
|
+
class="method-args">(artifact)</span>
|
132
|
+
|
133
|
+
<span class="method-click-advice">click to toggle source</span>
|
134
|
+
|
135
|
+
</div>
|
136
|
+
|
137
|
+
|
138
|
+
<div class="method-description">
|
139
|
+
|
140
|
+
<p>Given an Artifactory::Resource::Artifact, return the value of the earliest
|
141
|
+
date property on that object</p>
|
142
|
+
|
143
|
+
<p>Designed to answer the question “what's the first time anything
|
144
|
+
happened to a given Artifact?”, this method returns the earliest (longest
|
145
|
+
ago) date from the given artifact's created, last modified and last
|
146
|
+
downloaded timestamps.</p>
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
<div class="method-source-code" id="earliest_date_from-source">
|
152
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovered_artifact.rb, line 48</span>
|
153
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">earliest_date_from</span>(<span class="ruby-identifier">artifact</span>)
|
154
|
+
[
|
155
|
+
<span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">created</span>,
|
156
|
+
<span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">last_modified</span>,
|
157
|
+
<span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:last_downloaded</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">last_downloaded</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>,
|
158
|
+
].<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">first</span>
|
159
|
+
<span class="ruby-keyword">end</span></pre>
|
160
|
+
</div>
|
161
|
+
|
162
|
+
</div>
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
</div>
|
168
|
+
|
169
|
+
|
170
|
+
<div id="method-c-latest_date_from" class="method-detail ">
|
171
|
+
|
172
|
+
<div class="method-heading">
|
173
|
+
<span class="method-name">latest_date_from</span><span
|
174
|
+
class="method-args">(artifact)</span>
|
175
|
+
|
176
|
+
<span class="method-click-advice">click to toggle source</span>
|
177
|
+
|
178
|
+
</div>
|
179
|
+
|
180
|
+
|
181
|
+
<div class="method-description">
|
182
|
+
|
183
|
+
<p>Given an Artifactory::Resource::Artifact, return the value of the latest
|
184
|
+
date property on that object</p>
|
185
|
+
|
186
|
+
<p>Designed to answer the question “what's the most recent interaction
|
187
|
+
with a given Artifact?”, this method returns the latest (most recent) date
|
188
|
+
from the given artifact's created, last modified and last downloaded
|
189
|
+
timestamps.</p>
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
<div class="method-source-code" id="latest_date_from-source">
|
195
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovered_artifact.rb, line 62</span>
|
196
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">latest_date_from</span>(<span class="ruby-identifier">artifact</span>)
|
197
|
+
[
|
198
|
+
<span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">created</span>,
|
199
|
+
<span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">last_modified</span>,
|
200
|
+
<span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:last_downloaded</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">artifact</span>.<span class="ruby-identifier">last_downloaded</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>,
|
201
|
+
].<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">last</span>
|
202
|
+
<span class="ruby-keyword">end</span></pre>
|
203
|
+
</div>
|
204
|
+
|
205
|
+
</div>
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
</div>
|
211
|
+
|
212
|
+
|
213
|
+
</section>
|
214
|
+
|
215
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
216
|
+
<header>
|
217
|
+
<h3>Public Instance Methods</h3>
|
218
|
+
</header>
|
219
|
+
|
220
|
+
|
221
|
+
<div id="method-i-earliest_date" class="method-detail ">
|
222
|
+
|
223
|
+
<div class="method-heading">
|
224
|
+
<span class="method-name">earliest_date</span><span
|
225
|
+
class="method-args">()</span>
|
226
|
+
|
227
|
+
<span class="method-click-advice">click to toggle source</span>
|
228
|
+
|
229
|
+
</div>
|
230
|
+
|
231
|
+
|
232
|
+
<div class="method-description">
|
233
|
+
|
234
|
+
<p>What's the earliest Time of any of the date/time properties on this
|
235
|
+
object?</p>
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
<div class="method-source-code" id="earliest_date-source">
|
241
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovered_artifact.rb, line 19</span>
|
242
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">earliest_date</span>
|
243
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">earliest_date_from</span>(<span class="ruby-keyword">self</span>)
|
244
|
+
<span class="ruby-keyword">end</span></pre>
|
245
|
+
</div>
|
246
|
+
|
247
|
+
</div>
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
</div>
|
253
|
+
|
254
|
+
|
255
|
+
<div id="method-i-filename" class="method-detail ">
|
256
|
+
|
257
|
+
<div class="method-heading">
|
258
|
+
<span class="method-name">filename</span><span
|
259
|
+
class="method-args">()</span>
|
260
|
+
|
261
|
+
<span class="method-click-advice">click to toggle source</span>
|
262
|
+
|
263
|
+
</div>
|
264
|
+
|
265
|
+
|
266
|
+
<div class="method-description">
|
267
|
+
|
268
|
+
<p>The filename componet (basename) of this artifact's URL</p>
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
<div class="method-source-code" id="filename-source">
|
274
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovered_artifact.rb, line 31</span>
|
275
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">filename</span>
|
276
|
+
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">uri</span>)
|
277
|
+
<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">path</span>)
|
278
|
+
<span class="ruby-keyword">end</span></pre>
|
279
|
+
</div>
|
280
|
+
|
281
|
+
</div>
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
</div>
|
287
|
+
|
288
|
+
|
289
|
+
<div id="method-i-last_downloaded" class="method-detail ">
|
290
|
+
|
291
|
+
<div class="method-heading">
|
292
|
+
<span class="method-name">last_downloaded</span><span
|
293
|
+
class="method-args">()</span>
|
294
|
+
|
295
|
+
<span class="method-click-advice">click to toggle source</span>
|
296
|
+
|
297
|
+
</div>
|
298
|
+
|
299
|
+
|
300
|
+
<div class="method-description">
|
301
|
+
|
302
|
+
<p>Time representing the date and time this artifact was last downloaded by a
|
303
|
+
client (presumably to be installed)</p>
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
<div class="method-source-code" id="last_downloaded-source">
|
309
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovered_artifact.rb, line 15</span>
|
310
|
+
<span class="ruby-identifier">attribute</span> <span class="ruby-value">:last_downloaded</span>
|
311
|
+
</pre>
|
312
|
+
</div>
|
313
|
+
|
314
|
+
</div>
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
</div>
|
320
|
+
|
321
|
+
|
322
|
+
<div id="method-i-latest_date" class="method-detail ">
|
323
|
+
|
324
|
+
<div class="method-heading">
|
325
|
+
<span class="method-name">latest_date</span><span
|
326
|
+
class="method-args">()</span>
|
327
|
+
|
328
|
+
<span class="method-click-advice">click to toggle source</span>
|
329
|
+
|
330
|
+
</div>
|
331
|
+
|
332
|
+
|
333
|
+
<div class="method-description">
|
334
|
+
|
335
|
+
<p>What's the most recent Time of any of the date/time properties on this
|
336
|
+
object?</p>
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
<div class="method-source-code" id="latest_date-source">
|
342
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovered_artifact.rb, line 25</span>
|
343
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">latest_date</span>
|
344
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">latest_date_from</span>(<span class="ruby-keyword">self</span>)
|
345
|
+
<span class="ruby-keyword">end</span></pre>
|
346
|
+
</div>
|
347
|
+
|
348
|
+
</div>
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
</div>
|
354
|
+
|
355
|
+
|
356
|
+
<div id="method-i-to_s" class="method-detail ">
|
357
|
+
|
358
|
+
<div class="method-heading">
|
359
|
+
<span class="method-name">to_s</span><span
|
360
|
+
class="method-args">()</span>
|
361
|
+
|
362
|
+
<span class="method-click-advice">click to toggle source</span>
|
363
|
+
|
364
|
+
</div>
|
365
|
+
|
366
|
+
|
367
|
+
<div class="method-description">
|
368
|
+
|
369
|
+
<p>A string representation of this artifact</p>
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
<div class="method-source-code" id="to_s-source">
|
375
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovered_artifact.rb, line 38</span>
|
376
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
|
377
|
+
<span class="ruby-node">"#<DiscoveredArtifact #{filename} last accessed #{latest_date}>"</span>
|
378
|
+
<span class="ruby-keyword">end</span></pre>
|
379
|
+
</div>
|
380
|
+
|
381
|
+
</div>
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
</div>
|
387
|
+
|
388
|
+
|
389
|
+
</section>
|
390
|
+
|
391
|
+
</section>
|
392
|
+
</main>
|
393
|
+
|
394
|
+
|
395
|
+
<footer id="validator-badges" role="contentinfo">
|
396
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
397
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.0.1.
|
398
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
399
|
+
</footer>
|
400
|
+
|
@@ -0,0 +1,466 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>class Artifactory::Cleaner::DiscoveryWorker - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<script type="text/javascript">
|
10
|
+
var rdoc_rel_prefix = "../../";
|
11
|
+
var index_rel_prefix = "../../";
|
12
|
+
</script>
|
13
|
+
|
14
|
+
<script src="../../js/jquery.js"></script>
|
15
|
+
<script src="../../js/darkfish.js"></script>
|
16
|
+
|
17
|
+
<link href="../../css/fonts.css" rel="stylesheet">
|
18
|
+
<link href="../../css/rdoc.css" rel="stylesheet">
|
19
|
+
|
20
|
+
|
21
|
+
|
22
|
+
<body id="top" role="document" class="class">
|
23
|
+
<nav role="navigation">
|
24
|
+
<div id="project-navigation">
|
25
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
26
|
+
<h2>
|
27
|
+
<a href="../../index.html" rel="home">Home</a>
|
28
|
+
</h2>
|
29
|
+
|
30
|
+
<div id="table-of-contents-navigation">
|
31
|
+
<a href="../../table_of_contents.html#pages">Pages</a>
|
32
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
33
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
34
|
+
</div>
|
35
|
+
</div>
|
36
|
+
|
37
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
38
|
+
<form action="#" method="get" accept-charset="utf-8">
|
39
|
+
<div id="search-field-wrapper">
|
40
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
41
|
+
aria-autocomplete="list" aria-controls="search-results"
|
42
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
43
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<ul id="search-results" aria-label="Search Results"
|
47
|
+
aria-busy="false" aria-expanded="false"
|
48
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
49
|
+
</form>
|
50
|
+
</div>
|
51
|
+
|
52
|
+
</div>
|
53
|
+
|
54
|
+
|
55
|
+
|
56
|
+
<div id="class-metadata">
|
57
|
+
|
58
|
+
<div id="parent-class-section" class="nav-section">
|
59
|
+
<h3>Parent</h3>
|
60
|
+
|
61
|
+
|
62
|
+
<p class="link"><a href="../../Object.html">Object</a>
|
63
|
+
|
64
|
+
</div>
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
<!-- Method Quickref -->
|
69
|
+
<div id="method-list-section" class="nav-section">
|
70
|
+
<h3>Methods</h3>
|
71
|
+
|
72
|
+
<ul class="link-list" role="directory">
|
73
|
+
|
74
|
+
<li ><a href="#method-c-new">::new</a>
|
75
|
+
|
76
|
+
<li ><a href="#method-i-alive-3F">#alive?</a>
|
77
|
+
|
78
|
+
<li ><a href="#method-i-kill">#kill</a>
|
79
|
+
|
80
|
+
<li ><a href="#method-i-running-3F">#running?</a>
|
81
|
+
|
82
|
+
<li ><a href="#method-i-shutdown">#shutdown</a>
|
83
|
+
|
84
|
+
<li ><a href="#method-i-start">#start</a>
|
85
|
+
|
86
|
+
<li ><a href="#method-i-stop">#stop</a>
|
87
|
+
|
88
|
+
<li ><a href="#method-i-to_s">#to_s</a>
|
89
|
+
|
90
|
+
<li ><a href="#method-i-working-3F">#working?</a>
|
91
|
+
|
92
|
+
</ul>
|
93
|
+
</div>
|
94
|
+
|
95
|
+
</div>
|
96
|
+
</nav>
|
97
|
+
|
98
|
+
<main role="main" aria-labelledby="class-Artifactory::Cleaner::DiscoveryWorker">
|
99
|
+
<h1 id="class-Artifactory::Cleaner::DiscoveryWorker" class="class">
|
100
|
+
class Artifactory::Cleaner::DiscoveryWorker
|
101
|
+
</h1>
|
102
|
+
|
103
|
+
<section class="description">
|
104
|
+
|
105
|
+
<p>Helper class representing Threads spawned to discover Artifacts</p>
|
106
|
+
|
107
|
+
</section>
|
108
|
+
|
109
|
+
|
110
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
121
|
+
<header>
|
122
|
+
<h3>Public Class Methods</h3>
|
123
|
+
</header>
|
124
|
+
|
125
|
+
|
126
|
+
<div id="method-c-new" class="method-detail ">
|
127
|
+
|
128
|
+
<div class="method-heading">
|
129
|
+
<span class="method-name">new</span><span
|
130
|
+
class="method-args">(processing_queues, artifactory_client)</span>
|
131
|
+
|
132
|
+
<span class="method-click-advice">click to toggle source</span>
|
133
|
+
|
134
|
+
</div>
|
135
|
+
|
136
|
+
|
137
|
+
<div class="method-description">
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
<div class="method-source-code" id="new-source">
|
145
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovery_worker.rb, line 6</span>
|
146
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">processing_queues</span>, <span class="ruby-identifier">artifactory_client</span>)
|
147
|
+
<span class="ruby-ivar">@running</span> = <span class="ruby-keyword">false</span>
|
148
|
+
<span class="ruby-ivar">@working</span> = <span class="ruby-keyword">false</span>
|
149
|
+
<span class="ruby-ivar">@thread</span> = <span class="ruby-keyword">nil</span>
|
150
|
+
<span class="ruby-ivar">@queues</span> = <span class="ruby-identifier">processing_queues</span>
|
151
|
+
<span class="ruby-ivar">@artifactory_client</span> = <span class="ruby-identifier">artifactory_client</span>
|
152
|
+
<span class="ruby-keyword">end</span></pre>
|
153
|
+
</div>
|
154
|
+
|
155
|
+
</div>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
</div>
|
161
|
+
|
162
|
+
|
163
|
+
</section>
|
164
|
+
|
165
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
166
|
+
<header>
|
167
|
+
<h3>Public Instance Methods</h3>
|
168
|
+
</header>
|
169
|
+
|
170
|
+
|
171
|
+
<div id="method-i-alive-3F" class="method-detail ">
|
172
|
+
|
173
|
+
<div class="method-heading">
|
174
|
+
<span class="method-name">alive?</span><span
|
175
|
+
class="method-args">()</span>
|
176
|
+
|
177
|
+
<span class="method-click-advice">click to toggle source</span>
|
178
|
+
|
179
|
+
</div>
|
180
|
+
|
181
|
+
|
182
|
+
<div class="method-description">
|
183
|
+
|
184
|
+
<p>Is the Thread for this worker alive?</p>
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
<div class="method-source-code" id="alive-3F-source">
|
190
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovery_worker.rb, line 33</span>
|
191
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">alive?</span>
|
192
|
+
<span class="ruby-ivar">@thread</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@thread</span>.<span class="ruby-identifier">alive?</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
|
193
|
+
<span class="ruby-keyword">end</span></pre>
|
194
|
+
</div>
|
195
|
+
|
196
|
+
</div>
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
</div>
|
202
|
+
|
203
|
+
|
204
|
+
<div id="method-i-kill" class="method-detail method-alias">
|
205
|
+
|
206
|
+
<div class="method-heading">
|
207
|
+
<span class="method-name">kill</span><span
|
208
|
+
class="method-args">()</span>
|
209
|
+
|
210
|
+
</div>
|
211
|
+
|
212
|
+
|
213
|
+
<div class="method-description">
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
</div>
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
<div class="aliases">
|
226
|
+
Alias for: <a href="DiscoveryWorker.html#method-i-stop">stop</a>
|
227
|
+
</div>
|
228
|
+
|
229
|
+
</div>
|
230
|
+
|
231
|
+
|
232
|
+
<div id="method-i-running-3F" class="method-detail ">
|
233
|
+
|
234
|
+
<div class="method-heading">
|
235
|
+
<span class="method-name">running?</span><span
|
236
|
+
class="method-args">()</span>
|
237
|
+
|
238
|
+
<span class="method-click-advice">click to toggle source</span>
|
239
|
+
|
240
|
+
</div>
|
241
|
+
|
242
|
+
|
243
|
+
<div class="method-description">
|
244
|
+
|
245
|
+
<p>Is this <a href="DiscoveryWorker.html">DiscoveryWorker</a> running,
|
246
|
+
listening to the queue and processing requests</p>
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
<div class="method-source-code" id="running-3F-source">
|
252
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovery_worker.rb, line 16</span>
|
253
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">running?</span>
|
254
|
+
<span class="ruby-ivar">@running</span>
|
255
|
+
<span class="ruby-keyword">end</span></pre>
|
256
|
+
</div>
|
257
|
+
|
258
|
+
</div>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
</div>
|
264
|
+
|
265
|
+
|
266
|
+
<div id="method-i-shutdown" class="method-detail ">
|
267
|
+
|
268
|
+
<div class="method-heading">
|
269
|
+
<span class="method-name">shutdown</span><span
|
270
|
+
class="method-args">(timeout = 300)</span>
|
271
|
+
|
272
|
+
<span class="method-click-advice">click to toggle source</span>
|
273
|
+
|
274
|
+
</div>
|
275
|
+
|
276
|
+
|
277
|
+
<div class="method-description">
|
278
|
+
|
279
|
+
<p>Stop the Thread and re-join the parent</p>
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
<div class="method-source-code" id="shutdown-source">
|
285
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovery_worker.rb, line 51</span>
|
286
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">shutdown</span>(<span class="ruby-identifier">timeout</span> = <span class="ruby-value">300</span>)
|
287
|
+
<span class="ruby-ivar">@running</span> = <span class="ruby-keyword">false</span>
|
288
|
+
<span class="ruby-ivar">@thread</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">timeout</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@thread</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@thread</span>.<span class="ruby-identifier">alive?</span>
|
289
|
+
<span class="ruby-keyword">end</span></pre>
|
290
|
+
</div>
|
291
|
+
|
292
|
+
</div>
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
</div>
|
298
|
+
|
299
|
+
|
300
|
+
<div id="method-i-start" class="method-detail ">
|
301
|
+
|
302
|
+
<div class="method-heading">
|
303
|
+
<span class="method-name">start</span><span
|
304
|
+
class="method-args">()</span>
|
305
|
+
|
306
|
+
<span class="method-click-advice">click to toggle source</span>
|
307
|
+
|
308
|
+
</div>
|
309
|
+
|
310
|
+
|
311
|
+
<div class="method-description">
|
312
|
+
|
313
|
+
<p>Start the <a href="DiscoveryWorker.html">DiscoveryWorker</a> and begin
|
314
|
+
processing from the queue</p>
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
<div class="method-source-code" id="start-source">
|
320
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovery_worker.rb, line 39</span>
|
321
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start</span>
|
322
|
+
<span class="ruby-ivar">@running</span> = <span class="ruby-keyword">true</span>
|
323
|
+
<span class="ruby-ivar">@thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span>
|
324
|
+
<span class="ruby-keyword">while</span> <span class="ruby-identifier">running?</span>
|
325
|
+
<span class="ruby-identifier">process</span> <span class="ruby-ivar">@queues</span>.<span class="ruby-identifier">incoming</span>.<span class="ruby-identifier">pop</span>(<span class="ruby-keyword">false</span>)
|
326
|
+
<span class="ruby-keyword">end</span>
|
327
|
+
<span class="ruby-keyword">end</span>
|
328
|
+
<span class="ruby-keyword">self</span>
|
329
|
+
<span class="ruby-keyword">end</span></pre>
|
330
|
+
</div>
|
331
|
+
|
332
|
+
</div>
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
</div>
|
338
|
+
|
339
|
+
|
340
|
+
<div id="method-i-stop" class="method-detail ">
|
341
|
+
|
342
|
+
<div class="method-heading">
|
343
|
+
<span class="method-name">stop</span><span
|
344
|
+
class="method-args">()</span>
|
345
|
+
|
346
|
+
<span class="method-click-advice">click to toggle source</span>
|
347
|
+
|
348
|
+
</div>
|
349
|
+
|
350
|
+
|
351
|
+
<div class="method-description">
|
352
|
+
|
353
|
+
<p>Forcibly kill the Thread and destroy it</p>
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
<div class="method-source-code" id="stop-source">
|
359
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovery_worker.rb, line 58</span>
|
360
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stop</span>
|
361
|
+
<span class="ruby-ivar">@running</span> = <span class="ruby-keyword">false</span>
|
362
|
+
<span class="ruby-ivar">@thread</span>.<span class="ruby-identifier">kill</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@thread</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@thread</span>.<span class="ruby-identifier">alive?</span>
|
363
|
+
<span class="ruby-ivar">@thread</span> = <span class="ruby-keyword">nil</span>
|
364
|
+
<span class="ruby-keyword">end</span></pre>
|
365
|
+
</div>
|
366
|
+
|
367
|
+
</div>
|
368
|
+
|
369
|
+
|
370
|
+
<div class="aliases">
|
371
|
+
Also aliased as: <a href="DiscoveryWorker.html#method-i-kill">kill</a>
|
372
|
+
</div>
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
</div>
|
377
|
+
|
378
|
+
|
379
|
+
<div id="method-i-to_s" class="method-detail ">
|
380
|
+
|
381
|
+
<div class="method-heading">
|
382
|
+
<span class="method-name">to_s</span><span
|
383
|
+
class="method-args">()</span>
|
384
|
+
|
385
|
+
<span class="method-click-advice">click to toggle source</span>
|
386
|
+
|
387
|
+
</div>
|
388
|
+
|
389
|
+
|
390
|
+
<div class="method-description">
|
391
|
+
|
392
|
+
<p>String representation of this <a
|
393
|
+
href="DiscoveryWorker.html">DiscoveryWorker</a> and it's status</p>
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
<div class="method-source-code" id="to_s-source">
|
399
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovery_worker.rb, line 67</span>
|
400
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
|
401
|
+
<span class="ruby-node">"#<#{self.class}:#{self.object_id}; #{running? ? 'running' : 'not running'}, #{working? ? 'working' : 'idle'}, #{alive? ? 'alive' : 'dead'}>"</span>
|
402
|
+
<span class="ruby-keyword">end</span></pre>
|
403
|
+
</div>
|
404
|
+
|
405
|
+
</div>
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
</div>
|
411
|
+
|
412
|
+
|
413
|
+
<div id="method-i-working-3F" class="method-detail ">
|
414
|
+
|
415
|
+
<div class="method-heading">
|
416
|
+
<span class="method-name">working?</span><span
|
417
|
+
class="method-args">()</span>
|
418
|
+
|
419
|
+
<span class="method-click-advice">click to toggle source</span>
|
420
|
+
|
421
|
+
</div>
|
422
|
+
|
423
|
+
|
424
|
+
<div class="method-description">
|
425
|
+
|
426
|
+
<p>Is this <a href="DiscoveryWorker.html">DiscoveryWorker</a> currently
|
427
|
+
processing a request?</p>
|
428
|
+
|
429
|
+
<p>when <a href="DiscoveryWorker.html#method-i-running-3F">running?</a> is
|
430
|
+
true and <a href="DiscoveryWorker.html#method-i-working-3F">working?</a> is
|
431
|
+
not, then the worker is idle, blocked, waiting for an action.</p>
|
432
|
+
|
433
|
+
<p>when <a href="DiscoveryWorker.html#method-i-working-3F">working?</a> is
|
434
|
+
true, there will be at least one more result pushed to the outgoing queue
|
435
|
+
when the current request finishes</p>
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
<div class="method-source-code" id="working-3F-source">
|
441
|
+
<pre><span class="ruby-comment"># File lib/artifactory/cleaner/discovery_worker.rb, line 27</span>
|
442
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">working?</span>
|
443
|
+
<span class="ruby-ivar">@working</span>
|
444
|
+
<span class="ruby-keyword">end</span></pre>
|
445
|
+
</div>
|
446
|
+
|
447
|
+
</div>
|
448
|
+
|
449
|
+
|
450
|
+
|
451
|
+
|
452
|
+
</div>
|
453
|
+
|
454
|
+
|
455
|
+
</section>
|
456
|
+
|
457
|
+
</section>
|
458
|
+
</main>
|
459
|
+
|
460
|
+
|
461
|
+
<footer id="validator-badges" role="contentinfo">
|
462
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
463
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.0.1.
|
464
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
465
|
+
</footer>
|
466
|
+
|