artifactory-cleaner 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (117) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +4 -0
  3. data/.idea/.gitignore +2 -0
  4. data/.idea/checkstyle-idea.xml +16 -0
  5. data/.idea/dictionaries/jgitlin.xml +7 -0
  6. data/.idea/misc.xml +6 -0
  7. data/.idea/modules.xml +8 -0
  8. data/.idea/vcs.xml +6 -0
  9. data/.rspec +3 -0
  10. data/.rspec_status +39 -0
  11. data/.travis.yml +6 -0
  12. data/CODE_OF_CONDUCT.md +74 -0
  13. data/Gemfile +12 -0
  14. data/README.md +73 -0
  15. data/Rakefile +20 -0
  16. data/artifactory-cleaner.gemspec +43 -0
  17. data/artifactory-cleaner.iml +9 -0
  18. data/bin/console +14 -0
  19. data/bin/setup +8 -0
  20. data/doc/rdoc/Artifactory.html +94 -0
  21. data/doc/rdoc/Artifactory/Cleaner.html +108 -0
  22. data/doc/rdoc/Artifactory/Cleaner/ArtifactBucket.html +504 -0
  23. data/doc/rdoc/Artifactory/Cleaner/ArtifactBucketCollection.html +570 -0
  24. data/doc/rdoc/Artifactory/Cleaner/ArtifactFilter.html +712 -0
  25. data/doc/rdoc/Artifactory/Cleaner/ArtifactFilterRule.html +519 -0
  26. data/doc/rdoc/Artifactory/Cleaner/CLI.html +625 -0
  27. data/doc/rdoc/Artifactory/Cleaner/Controller.html +1014 -0
  28. data/doc/rdoc/Artifactory/Cleaner/DiscoveredArtifact.html +400 -0
  29. data/doc/rdoc/Artifactory/Cleaner/DiscoveryWorker.html +466 -0
  30. data/doc/rdoc/Artifactory/Cleaner/Error.html +101 -0
  31. data/doc/rdoc/Artifactory/Cleaner/SpecHelpers.html +190 -0
  32. data/doc/rdoc/Artifactory/Cleaner/Util.html +157 -0
  33. data/doc/rdoc/CODE_OF_CONDUCT_md.html +228 -0
  34. data/doc/rdoc/Float.html +94 -0
  35. data/doc/rdoc/Gemfile.html +144 -0
  36. data/doc/rdoc/Gemfile_lock.html +217 -0
  37. data/doc/rdoc/Object.html +112 -0
  38. data/doc/rdoc/README_md.html +241 -0
  39. data/doc/rdoc/Rakefile.html +151 -0
  40. data/doc/rdoc/artifactory-cleaner_gemspec.html +173 -0
  41. data/doc/rdoc/artifactory-cleaner_iml.html +139 -0
  42. data/doc/rdoc/bin/setup.html +134 -0
  43. data/doc/rdoc/created.rid +219 -0
  44. data/doc/rdoc/css/fonts.css +167 -0
  45. data/doc/rdoc/css/rdoc.css +590 -0
  46. data/doc/rdoc/filterlist_yaml.html +149 -0
  47. data/doc/rdoc/filters/clean-amzn_yaml.html +133 -0
  48. data/doc/rdoc/filters/snapshots_yaml.html +137 -0
  49. data/doc/rdoc/filters/test-filter_yaml.html +137 -0
  50. data/doc/rdoc/filters/yum-test_yaml.html +141 -0
  51. data/doc/rdoc/fonts/Lato-Light.ttf +0 -0
  52. data/doc/rdoc/fonts/Lato-LightItalic.ttf +0 -0
  53. data/doc/rdoc/fonts/Lato-Regular.ttf +0 -0
  54. data/doc/rdoc/fonts/Lato-RegularItalic.ttf +0 -0
  55. data/doc/rdoc/fonts/SourceCodePro-Bold.ttf +0 -0
  56. data/doc/rdoc/fonts/SourceCodePro-Regular.ttf +0 -0
  57. data/doc/rdoc/images/add.png +0 -0
  58. data/doc/rdoc/images/arrow_up.png +0 -0
  59. data/doc/rdoc/images/brick.png +0 -0
  60. data/doc/rdoc/images/brick_link.png +0 -0
  61. data/doc/rdoc/images/bug.png +0 -0
  62. data/doc/rdoc/images/bullet_black.png +0 -0
  63. data/doc/rdoc/images/bullet_toggle_minus.png +0 -0
  64. data/doc/rdoc/images/bullet_toggle_plus.png +0 -0
  65. data/doc/rdoc/images/date.png +0 -0
  66. data/doc/rdoc/images/delete.png +0 -0
  67. data/doc/rdoc/images/find.png +0 -0
  68. data/doc/rdoc/images/loadingAnimation.gif +0 -0
  69. data/doc/rdoc/images/macFFBgHack.png +0 -0
  70. data/doc/rdoc/images/package.png +0 -0
  71. data/doc/rdoc/images/page_green.png +0 -0
  72. data/doc/rdoc/images/page_white_text.png +0 -0
  73. data/doc/rdoc/images/page_white_width.png +0 -0
  74. data/doc/rdoc/images/plugin.png +0 -0
  75. data/doc/rdoc/images/ruby.png +0 -0
  76. data/doc/rdoc/images/tag_blue.png +0 -0
  77. data/doc/rdoc/images/tag_green.png +0 -0
  78. data/doc/rdoc/images/transparent.png +0 -0
  79. data/doc/rdoc/images/wrench.png +0 -0
  80. data/doc/rdoc/images/wrench_orange.png +0 -0
  81. data/doc/rdoc/images/zoom.png +0 -0
  82. data/doc/rdoc/index.html +166 -0
  83. data/doc/rdoc/js/darkfish.js +161 -0
  84. data/doc/rdoc/js/jquery.js +4 -0
  85. data/doc/rdoc/js/navigation.js +141 -0
  86. data/doc/rdoc/js/navigation.js.gz +0 -0
  87. data/doc/rdoc/js/search.js +109 -0
  88. data/doc/rdoc/js/search_index.js +1 -0
  89. data/doc/rdoc/js/search_index.js.gz +0 -0
  90. data/doc/rdoc/js/searcher.js +229 -0
  91. data/doc/rdoc/js/searcher.js.gz +0 -0
  92. data/doc/rdoc/results/archive-test-4_log.html +762 -0
  93. data/doc/rdoc/results/buckets-2020-01-31_txt.html +233 -0
  94. data/doc/rdoc/results/clean-test-2_log.html +598 -0
  95. data/doc/rdoc/results/clean-test-3_log.html +128 -0
  96. data/doc/rdoc/results/clean-test-5_log.html +2721 -0
  97. data/doc/rdoc/results/clean-test-6_log.html +135 -0
  98. data/doc/rdoc/results/clean-test-7_log.html +137 -0
  99. data/doc/rdoc/results/clean-test-8-real_log.html +131 -0
  100. data/doc/rdoc/results/clean-test-9_log.html +131 -0
  101. data/doc/rdoc/results/clean-test1_log.html +1759 -0
  102. data/doc/rdoc/results/yum-test_2020-01-31_log.html +2854 -0
  103. data/doc/rdoc/results/yum-test_dry-run_log.html +1074 -0
  104. data/doc/rdoc/table_of_contents.html +581 -0
  105. data/exe/artifactory-cleaner +12 -0
  106. data/lib/artifactory/cleaner.rb +17 -0
  107. data/lib/artifactory/cleaner/artifact_bucket.rb +102 -0
  108. data/lib/artifactory/cleaner/artifact_bucket_collection.rb +118 -0
  109. data/lib/artifactory/cleaner/artifact_filter.rb +146 -0
  110. data/lib/artifactory/cleaner/artifact_filter_rule.rb +81 -0
  111. data/lib/artifactory/cleaner/cli.rb +415 -0
  112. data/lib/artifactory/cleaner/controller.rb +466 -0
  113. data/lib/artifactory/cleaner/discovered_artifact.rb +71 -0
  114. data/lib/artifactory/cleaner/discovery_worker.rb +126 -0
  115. data/lib/artifactory/cleaner/util.rb +21 -0
  116. data/lib/artifactory/cleaner/version.rb +7 -0
  117. metadata +252 -0
@@ -0,0 +1,570 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class Artifactory::Cleaner::ArtifactBucketCollection - 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
+ <div id="includes-section" class="nav-section">
67
+ <h3>Included Modules</h3>
68
+
69
+ <ul class="link-list">
70
+
71
+
72
+ <li><span class="include">Enumerable</span>
73
+
74
+
75
+ </ul>
76
+ </div>
77
+
78
+ <div id="extends-section" class="nav-section">
79
+ <h3>Extended With Modules</h3>
80
+
81
+ <ul class="link-list">
82
+
83
+
84
+ <li><span class="extend">Forwardable</span>
85
+
86
+
87
+ </ul>
88
+ </div>
89
+
90
+ <!-- Method Quickref -->
91
+ <div id="method-list-section" class="nav-section">
92
+ <h3>Methods</h3>
93
+
94
+ <ul class="link-list" role="directory">
95
+
96
+ <li ><a href="#method-c-new">::new</a>
97
+
98
+ <li ><a href="#method-i-3C-3C">#&lt;&lt;</a>
99
+
100
+ <li ><a href="#method-i-5B-5D">#[]</a>
101
+
102
+ <li ><a href="#method-i-add">#add</a>
103
+
104
+ <li ><a href="#method-i-artifact_count">#artifact_count</a>
105
+
106
+ <li ><a href="#method-i-bucket">#bucket</a>
107
+
108
+ <li ><a href="#method-i-bucket_sizes">#bucket_sizes</a>
109
+
110
+ <li ><a href="#method-i-clear">#clear</a>
111
+
112
+ <li ><a href="#method-i-define_buckets">#define_buckets</a>
113
+
114
+ <li ><a href="#method-i-report">#report</a>
115
+
116
+ </ul>
117
+ </div>
118
+
119
+ </div>
120
+ </nav>
121
+
122
+ <main role="main" aria-labelledby="class-Artifactory::Cleaner::ArtifactBucketCollection">
123
+ <h1 id="class-Artifactory::Cleaner::ArtifactBucketCollection" class="class">
124
+ class Artifactory::Cleaner::ArtifactBucketCollection
125
+ </h1>
126
+
127
+ <section class="description">
128
+
129
+ <p>Organize Artifacts by age bucket for analysis</p>
130
+
131
+ <p>An <a
132
+ href="ArtifactBucketCollection.html">Artifactory::Cleaner::ArtifactBucketCollection</a>
133
+ represents “age buckets” used for analyzing Artifact usage. Artifacts are
134
+ grouped into buckets of time to aid in developing an archive strategy. This
135
+ class maintains a list of buckets and handles the logic for sorting
136
+ Artifacts into those buckets.</p>
137
+
138
+ <p><a
139
+ href="ArtifactBucketCollection.html">Artifactory::Cleaner::ArtifactBucketCollection</a>
140
+ is largely just an Array of <a
141
+ href="ArtifactBucket.html">Artifactory::Cleaner::ArtifactBucket</a>
142
+ instances, with logic to sort and select them and logic to distribute
143
+ Artifactory::Resource::Artifact instances into the proper <a
144
+ href="ArtifactBucket.html">Artifactory::Cleaner::ArtifactBucket</a></p>
145
+
146
+ </section>
147
+
148
+
149
+ <section id="5Buntitled-5D" class="documentation-section">
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
160
+ <header>
161
+ <h3>Public Class Methods</h3>
162
+ </header>
163
+
164
+
165
+ <div id="method-c-new" class="method-detail ">
166
+
167
+ <div class="method-heading">
168
+ <span class="method-name">new</span><span
169
+ class="method-args">(buckets = [30,60,90,180,365,730,1095,nil])</span>
170
+
171
+ <span class="method-click-advice">click to toggle source</span>
172
+
173
+ </div>
174
+
175
+
176
+ <div class="method-description">
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <div class="method-source-code" id="new-source">
184
+ <pre><span class="ruby-comment"># File lib/artifactory/cleaner/artifact_bucket_collection.rb, line 21</span>
185
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">buckets</span> = [<span class="ruby-value">30</span>,<span class="ruby-value">60</span>,<span class="ruby-value">90</span>,<span class="ruby-value">180</span>,<span class="ruby-value">365</span>,<span class="ruby-value">730</span>,<span class="ruby-value">1095</span>,<span class="ruby-keyword">nil</span>])
186
+ <span class="ruby-ivar">@buckets</span> = []
187
+ <span class="ruby-identifier">define_buckets</span>(<span class="ruby-identifier">buckets</span>)
188
+ <span class="ruby-keyword">end</span></pre>
189
+ </div>
190
+
191
+ </div>
192
+
193
+
194
+
195
+
196
+ </div>
197
+
198
+
199
+ </section>
200
+
201
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
202
+ <header>
203
+ <h3>Public Instance Methods</h3>
204
+ </header>
205
+
206
+
207
+ <div id="method-i-3C-3C" class="method-detail method-alias">
208
+
209
+ <div class="method-heading">
210
+ <span class="method-name">&lt;&lt;</span><span
211
+ class="method-args">(artifact)</span>
212
+
213
+ </div>
214
+
215
+
216
+ <div class="method-description">
217
+
218
+
219
+
220
+
221
+
222
+
223
+ </div>
224
+
225
+
226
+
227
+
228
+ <div class="aliases">
229
+ Alias for: <a href="ArtifactBucketCollection.html#method-i-add">add</a>
230
+ </div>
231
+
232
+ </div>
233
+
234
+
235
+ <div id="method-i-5B-5D" class="method-detail method-alias">
236
+
237
+ <div class="method-heading">
238
+ <span class="method-name">[]</span><span
239
+ class="method-args">(age)</span>
240
+
241
+ </div>
242
+
243
+
244
+ <div class="method-description">
245
+
246
+
247
+
248
+
249
+
250
+
251
+ </div>
252
+
253
+
254
+
255
+
256
+ <div class="aliases">
257
+ Alias for: <a href="ArtifactBucketCollection.html#method-i-bucket">bucket</a>
258
+ </div>
259
+
260
+ </div>
261
+
262
+
263
+ <div id="method-i-add" class="method-detail ">
264
+
265
+ <div class="method-heading">
266
+ <span class="method-name">add</span><span
267
+ class="method-args">(artifact)</span>
268
+
269
+ <span class="method-click-advice">click to toggle source</span>
270
+
271
+ </div>
272
+
273
+
274
+ <div class="method-description">
275
+
276
+ <p>Add a new artifact to this collection</p>
277
+
278
+ <p>Given an Artifactory::Resource::Artifact `artifact`, find the proper <a
279
+ href="ArtifactBucket.html">ArtifactBucket</a> within this <a
280
+ href="ArtifactBucketCollection.html">ArtifactBucketCollection</a> and add
281
+ the artifact ton that bucket</p>
282
+
283
+ <p>Aliased as `&lt;&lt;`</p>
284
+
285
+
286
+
287
+
288
+ <div class="method-source-code" id="add-source">
289
+ <pre><span class="ruby-comment"># File lib/artifactory/cleaner/artifact_bucket_collection.rb, line 81</span>
290
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add</span>(<span class="ruby-identifier">artifact</span>)
291
+ <span class="ruby-identifier">age</span> = (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-constant">Artifactory</span><span class="ruby-operator">::</span><span class="ruby-constant">Cleaner</span><span class="ruby-operator">::</span><span class="ruby-constant">DiscoveredArtifact</span>.<span class="ruby-identifier">latest_date_from</span>(<span class="ruby-identifier">artifact</span>))<span class="ruby-operator">/</span>(<span class="ruby-value">3600</span><span class="ruby-operator">*</span><span class="ruby-value">24</span>)
292
+
293
+ <span class="ruby-keyword">if</span> (<span class="ruby-identifier">bucket</span> = <span class="ruby-ivar">@buckets</span>.<span class="ruby-identifier">find</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">b</span><span class="ruby-operator">|</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">covers?</span> <span class="ruby-identifier">age</span>})
294
+ <span class="ruby-identifier">bucket</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">artifact</span>
295
+ <span class="ruby-keyword">else</span>
296
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">RangeError</span>, <span class="ruby-node">&quot;No bucket available for an artifact of age #{age.floor} days&quot;</span>
297
+ <span class="ruby-keyword">end</span>
298
+ <span class="ruby-keyword">self</span>
299
+ <span class="ruby-keyword">end</span></pre>
300
+ </div>
301
+
302
+ </div>
303
+
304
+
305
+ <div class="aliases">
306
+ Also aliased as: <a href="ArtifactBucketCollection.html#method-i-3C-3C">&lt;&lt;</a>
307
+ </div>
308
+
309
+
310
+
311
+ </div>
312
+
313
+
314
+ <div id="method-i-artifact_count" class="method-detail ">
315
+
316
+ <div class="method-heading">
317
+ <span class="method-name">artifact_count</span><span
318
+ class="method-args">()</span>
319
+
320
+ <span class="method-click-advice">click to toggle source</span>
321
+
322
+ </div>
323
+
324
+
325
+ <div class="method-description">
326
+
327
+ <p>Total number of Artifacts within this collection</p>
328
+
329
+ <p>Returns the sum of the length of all buckets within this collection</p>
330
+
331
+
332
+
333
+
334
+ <div class="method-source-code" id="artifact_count-source">
335
+ <pre><span class="ruby-comment"># File lib/artifactory/cleaner/artifact_bucket_collection.rb, line 70</span>
336
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">artifact_count</span>
337
+ <span class="ruby-ivar">@buckets</span>.<span class="ruby-identifier">reduce</span>(<span class="ruby-value">0</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">sum</span>, <span class="ruby-identifier">bkt</span><span class="ruby-operator">|</span> <span class="ruby-identifier">sum</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">bkt</span>.<span class="ruby-identifier">length</span> }
338
+ <span class="ruby-keyword">end</span></pre>
339
+ </div>
340
+
341
+ </div>
342
+
343
+
344
+
345
+
346
+ </div>
347
+
348
+
349
+ <div id="method-i-bucket" class="method-detail ">
350
+
351
+ <div class="method-heading">
352
+ <span class="method-name">bucket</span><span
353
+ class="method-args">(age)</span>
354
+
355
+ <span class="method-click-advice">click to toggle source</span>
356
+
357
+ </div>
358
+
359
+
360
+ <div class="method-description">
361
+
362
+ <p>Accessor for a bucket of a given age</p>
363
+
364
+ <p>Returns the bucket which covers the period `age` (represented as an
365
+ artifact age, in days)</p>
366
+
367
+ <p>Aliased as `[]`</p>
368
+
369
+
370
+
371
+
372
+ <div class="method-source-code" id="bucket-source">
373
+ <pre><span class="ruby-comment"># File lib/artifactory/cleaner/artifact_bucket_collection.rb, line 99</span>
374
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bucket</span>(<span class="ruby-identifier">age</span>)
375
+ <span class="ruby-ivar">@buckets</span>.<span class="ruby-identifier">find</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">b</span><span class="ruby-operator">|</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">covers?</span> <span class="ruby-identifier">age</span>}
376
+ <span class="ruby-keyword">end</span></pre>
377
+ </div>
378
+
379
+ </div>
380
+
381
+
382
+ <div class="aliases">
383
+ Also aliased as: <a href="ArtifactBucketCollection.html#method-i-5B-5D">[]</a>
384
+ </div>
385
+
386
+
387
+
388
+ </div>
389
+
390
+
391
+ <div id="method-i-bucket_sizes" class="method-detail ">
392
+
393
+ <div class="method-heading">
394
+ <span class="method-name">bucket_sizes</span><span
395
+ class="method-args">()</span>
396
+
397
+ <span class="method-click-advice">click to toggle source</span>
398
+
399
+ </div>
400
+
401
+
402
+ <div class="method-description">
403
+
404
+ <p>Return an Array containing the bucket sizes of this collection.</p>
405
+
406
+ <p>Returns the `max` property from every bucket within this collection, thus
407
+ representing the bucket sizes this collection contains (as a properly
408
+ configured <a
409
+ href="ArtifactBucketCollection.html">ArtifactBucketCollection</a> has the
410
+ min of each bucket set to the max of the previous bucket, thus covering an
411
+ entire time range)</p>
412
+
413
+
414
+
415
+
416
+ <div class="method-source-code" id="bucket_sizes-source">
417
+ <pre><span class="ruby-comment"># File lib/artifactory/cleaner/artifact_bucket_collection.rb, line 62</span>
418
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bucket_sizes</span>
419
+ <span class="ruby-ivar">@buckets</span>.<span class="ruby-identifier">map</span> <span class="ruby-operator">&amp;</span><span class="ruby-value">:max</span>
420
+ <span class="ruby-keyword">end</span></pre>
421
+ </div>
422
+
423
+ </div>
424
+
425
+
426
+
427
+
428
+ </div>
429
+
430
+
431
+ <div id="method-i-clear" class="method-detail ">
432
+
433
+ <div class="method-heading">
434
+ <span class="method-name">clear</span><span
435
+ class="method-args">()</span>
436
+
437
+ <span class="method-click-advice">click to toggle source</span>
438
+
439
+ </div>
440
+
441
+
442
+ <div class="method-description">
443
+
444
+ <p>Remove all Artifacts from this collection</p>
445
+
446
+ <p>Calls `clear` on every bucket within this collection</p>
447
+
448
+
449
+
450
+
451
+ <div class="method-source-code" id="clear-source">
452
+ <pre><span class="ruby-comment"># File lib/artifactory/cleaner/artifact_bucket_collection.rb, line 32</span>
453
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clear</span>
454
+ <span class="ruby-ivar">@buckets</span>.<span class="ruby-identifier">each</span> <span class="ruby-operator">&amp;</span><span class="ruby-value">:clear</span>
455
+ <span class="ruby-keyword">end</span></pre>
456
+ </div>
457
+
458
+ </div>
459
+
460
+
461
+
462
+
463
+ </div>
464
+
465
+
466
+ <div id="method-i-define_buckets" class="method-detail ">
467
+
468
+ <div class="method-heading">
469
+ <span class="method-name">define_buckets</span><span
470
+ class="method-args">(bucket_list)</span>
471
+
472
+ <span class="method-click-advice">click to toggle source</span>
473
+
474
+ </div>
475
+
476
+
477
+ <div class="method-description">
478
+
479
+ <p>Adjust the bucket sizes within this collection</p>
480
+
481
+ <p>Given an Enumerable of ages (as integer values of days) define buckets
482
+ representing those periods within this collection. This method is similar
483
+ to the constructor: provide an Enumerable where each value represents a
484
+ bucket size and new buckets will be added to this collection representing
485
+ the ages (in days) contained within `bucket_list`</p>
486
+
487
+ <p>TODO: This will not update older buckets or move artifacts around, so if
488
+ buckets were already defined then this method may result in an invalid
489
+ configuration, E.G. overlapping buckets or artifacts which are no longer in
490
+ the desired buckets. For best results, call this method on an <a
491
+ href="ArtifactBucketCollection.html">ArtifactBucketCollection</a> for which
492
+ you already know the bucket sizes and to which no artifacts have yet been
493
+ added</p>
494
+
495
+
496
+
497
+
498
+ <div class="method-source-code" id="define_buckets-source">
499
+ <pre><span class="ruby-comment"># File lib/artifactory/cleaner/artifact_bucket_collection.rb, line 48</span>
500
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_buckets</span>(<span class="ruby-identifier">bucket_list</span>)
501
+ <span class="ruby-identifier">last_size</span> = <span class="ruby-value">0</span>
502
+ <span class="ruby-identifier">bucket_list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">size</span><span class="ruby-operator">|</span>
503
+ <span class="ruby-ivar">@buckets</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-constant">Artifactory</span><span class="ruby-operator">::</span><span class="ruby-constant">Cleaner</span><span class="ruby-operator">::</span><span class="ruby-constant">ArtifactBucket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">last_size</span>,<span class="ruby-identifier">size</span>)
504
+ <span class="ruby-identifier">last_size</span> = <span class="ruby-identifier">size</span>
505
+ <span class="ruby-keyword">end</span>
506
+ <span class="ruby-keyword">end</span></pre>
507
+ </div>
508
+
509
+ </div>
510
+
511
+
512
+
513
+
514
+ </div>
515
+
516
+
517
+ <div id="method-i-report" class="method-detail ">
518
+
519
+ <div class="method-heading">
520
+ <span class="method-name">report</span><span
521
+ class="method-args">()</span>
522
+
523
+ <span class="method-click-advice">click to toggle source</span>
524
+
525
+ </div>
526
+
527
+
528
+ <div class="method-description">
529
+
530
+ <p>Human-readable summary of this collection</p>
531
+
532
+ <p>Returns a string summarizing each bucket within this collection: how many
533
+ packages and what filesize each bucket contains. Used when analyzing
534
+ artifact searches: artifacts discovered from a search are placed into an <a
535
+ href="ArtifactBucketCollection.html">ArtifactBucketCollection</a> and then
536
+ this report can be produced to describe how old the artifacts are and where
537
+ opportunities for cleaning exist.</p>
538
+
539
+
540
+
541
+
542
+ <div class="method-source-code" id="report-source">
543
+ <pre><span class="ruby-comment"># File lib/artifactory/cleaner/artifact_bucket_collection.rb, line 111</span>
544
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">report</span>
545
+ <span class="ruby-identifier">buckets</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">bucket</span><span class="ruby-operator">|</span>
546
+ <span class="ruby-node">&quot;#{bucket.length} packages between #{bucket.min} and #{bucket.max} days, totaling #{Artifactory::Cleaner::Util::filesize bucket.filesize}&quot;</span>
547
+ }.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;\n&quot;</span>)
548
+ <span class="ruby-keyword">end</span></pre>
549
+ </div>
550
+
551
+ </div>
552
+
553
+
554
+
555
+
556
+ </div>
557
+
558
+
559
+ </section>
560
+
561
+ </section>
562
+ </main>
563
+
564
+
565
+ <footer id="validator-badges" role="contentinfo">
566
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
567
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.0.1.
568
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
569
+ </footer>
570
+