naether 0.12.1 → 0.12.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,979 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Naether::sMav
8
+
9
+ &mdash; Documentation by YARD 0.8.7.2
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (s)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Naether.html" title="Naether (module)">Naether</a></span></span>
36
+ &raquo;
37
+ <span class="title">sMav</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Naether::sMav
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Naether::sMav</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/naether/maven.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Class Method Summary
112
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#create_from_notation-class_method" title="create_from_notation (class method)">+ (Object) <strong>create_from_notation</strong>(f create) </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'></div></span>
135
+
136
+ </li>
137
+
138
+
139
+ <li class="public ">
140
+ <span class="summary_signature">
141
+
142
+ <a href="#create_from_pom-class_method" title="create_from_pom (class method)">+ (Naether::Maven) <strong>create_from_pom</strong>(e_from_p) </a>
143
+
144
+
145
+
146
+ </span>
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+ <span class="summary_desc"><div class='inline'></div></span>
157
+
158
+ </li>
159
+
160
+
161
+ </ul>
162
+
163
+ <h2>
164
+ Instance Method Summary
165
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
166
+ </h2>
167
+
168
+ <ul class="summary">
169
+
170
+ <li class="public ">
171
+ <span class="summary_signature">
172
+
173
+ <a href="#build_pom-instance_method" title="#build_pom (instance method)">- (String) <strong>build_pom</strong> </a>
174
+
175
+
176
+
177
+ </span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>Pom xml.</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#dependencies%3D-instance_method" title="#dependencies= (instance method)">- (Object) <strong>dependencies=</strong>(pe # ) </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'></div></span>
212
+
213
+ </li>
214
+
215
+
216
+ <li class="public ">
217
+ <span class="summary_signature">
218
+
219
+ <a href="#final_name-instance_method" title="#final_name (instance method)">- (Object) <strong>final_name</strong> </a>
220
+
221
+
222
+
223
+ </span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'></div></span>
234
+
235
+ </li>
236
+
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#invoke-instance_method" title="#invoke (instance method)">- (Object) <strong>invoke</strong>(* ) </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+ <span class="summary_desc"><div class='inline'></div></span>
256
+
257
+ </li>
258
+
259
+
260
+ <li class="public ">
261
+ <span class="summary_signature">
262
+
263
+ <a href="#load_naether-instance_method" title="#load_naether (instance method)">- (Object) <strong>load_naether</strong>(tories ) </a>
264
+
265
+
266
+
267
+ </span>
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+ <span class="summary_desc"><div class='inline'>
278
+ <p>Load dependencies and remote repo from a <span class='object_link'><a href="../Naether.html" title="Naether (module)">Naether</a></span> instance.</p>
279
+ </div></span>
280
+
281
+ </li>
282
+
283
+
284
+ <li class="public ">
285
+ <span class="summary_signature">
286
+
287
+ <a href="#notation%3D-instance_method" title="#notation= (instance method)">- (Object) <strong>notation=</strong>(tion ) </a>
288
+
289
+
290
+
291
+ </span>
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ <span class="summary_desc"><div class='inline'></div></span>
302
+
303
+ </li>
304
+
305
+
306
+ <li class="public ">
307
+ <span class="summary_signature">
308
+
309
+ <a href="#repositories%3D-instance_method" title="#repositories= (instance method)">- (Object) <strong>repositories=</strong>(@param [Arra) </a>
310
+
311
+
312
+
313
+ </span>
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+ <span class="summary_desc"><div class='inline'></div></span>
324
+
325
+ </li>
326
+
327
+
328
+ <li class="public ">
329
+ <span class="summary_signature">
330
+
331
+ <a href="#version-instance_method" title="#version (instance method)">- (Object) <strong>version</strong> </a>
332
+
333
+
334
+
335
+ </span>
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+ <span class="summary_desc"><div class='inline'>
346
+ <p>return [String] version.</p>
347
+ </div></span>
348
+
349
+ </li>
350
+
351
+
352
+ <li class="public ">
353
+ <span class="summary_signature">
354
+
355
+ <a href="#write_pom-instance_method" title="#write_pom (instance method)">- (Object) <strong>write_pom</strong>(er.getRem) </a>
356
+
357
+
358
+
359
+ </span>
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+ <span class="summary_desc"><div class='inline'></div></span>
370
+
371
+ </li>
372
+
373
+
374
+ </ul>
375
+
376
+
377
+
378
+
379
+ <div id="class_method_details" class="method_details_list">
380
+ <h2>Class Method Details</h2>
381
+
382
+
383
+ <div class="method_details first">
384
+ <h3 class="signature first" id="create_from_notation-class_method">
385
+
386
+ + (<tt>Object</tt>) <strong>create_from_notation</strong>(f create)
387
+
388
+
389
+
390
+
391
+
392
+ </h3><div class="docstring">
393
+ <div class="discussion">
394
+
395
+
396
+ </div>
397
+ </div>
398
+ <div class="tags">
399
+
400
+
401
+ <p class="tag_title">See Also:</p>
402
+ <ul class="see">
403
+
404
+ <li><a href="https://github.com/mguymon/naether/wiki/Notations" target="_parent" title="https://github.com/mguymon/naether/wiki/Notations">https://github.com/mguymon/naether/wiki/Notations</a></li>
405
+
406
+ </ul>
407
+
408
+ </div><table class="source_code">
409
+ <tr>
410
+ <td>
411
+ <pre class="lines">
412
+
413
+
414
+ 41
415
+ 42
416
+ 43
417
+ 44</pre>
418
+ </td>
419
+ <td>
420
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 41</span>
421
+
422
+ er/wiki/Notations
423
+ def create_from_notation( notation )
424
+ maven = Maven.new
425
+ mav</pre>
426
+ </td>
427
+ </tr>
428
+ </table>
429
+ </div>
430
+
431
+ <div class="method_details ">
432
+ <h3 class="signature " id="create_from_pom-class_method">
433
+
434
+ + (<tt>Naether::Maven</tt>) <strong>create_from_pom</strong>(e_from_p)
435
+
436
+
437
+
438
+
439
+
440
+ </h3><div class="docstring">
441
+ <div class="discussion">
442
+
443
+
444
+ </div>
445
+ </div>
446
+ <div class="tags">
447
+
448
+ <p class="tag_title">Returns:</p>
449
+ <ul class="return">
450
+
451
+ <li>
452
+
453
+
454
+ <span class='type'>(<tt>Naether::Maven</tt>)</span>
455
+
456
+
457
+
458
+ </li>
459
+
460
+ </ul>
461
+
462
+ </div><table class="source_code">
463
+ <tr>
464
+ <td>
465
+ <pre class="lines">
466
+
467
+
468
+ 32
469
+ 33
470
+ 34</pre>
471
+ </td>
472
+ <td>
473
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 32</span>
474
+
475
+ aven]
476
+ def create_from_pom( pom_path )
477
+ maven = Maven.new( po</pre>
478
+ </td>
479
+ </tr>
480
+ </table>
481
+ </div>
482
+
483
+ </div>
484
+
485
+ <div id="instance_method_details" class="method_details_list">
486
+ <h2>Instance Method Details</h2>
487
+
488
+
489
+ <div class="method_details first">
490
+ <h3 class="signature first" id="build_pom-instance_method">
491
+
492
+ - (<tt>String</tt>) <strong>build_pom</strong>
493
+
494
+
495
+
496
+
497
+
498
+ </h3><div class="docstring">
499
+ <div class="discussion">
500
+
501
+ <p>Returns pom xml</p>
502
+
503
+
504
+ </div>
505
+ </div>
506
+ <div class="tags">
507
+
508
+ <p class="tag_title">Returns:</p>
509
+ <ul class="return">
510
+
511
+ <li>
512
+
513
+
514
+ <span class='type'>(<tt>String</tt>)</span>
515
+
516
+
517
+
518
+ &mdash;
519
+ <div class='inline'>
520
+ <p>pom xml</p>
521
+ </div>
522
+
523
+ </li>
524
+
525
+ </ul>
526
+
527
+ </div><table class="source_code">
528
+ <tr>
529
+ <td>
530
+ <pre class="lines">
531
+
532
+
533
+ 137
534
+ 138</pre>
535
+ </td>
536
+ <td>
537
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 137</span>
538
+
539
+ <span class='id identifier rubyid_oad_naether'>oad_naether</span><span class='lparen'>(</span> <span class='id identifier rubyid_naether'>naether</span> <span class='rparen'>)</span>
540
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_dependen'>dependen</span></pre>
541
+ </td>
542
+ </tr>
543
+ </table>
544
+ </div>
545
+
546
+ <div class="method_details ">
547
+ <h3 class="signature " id="dependencies=-instance_method">
548
+
549
+ - (<tt>Object</tt>) <strong>dependencies=</strong>(pe
550
+ #
551
+ )
552
+
553
+
554
+
555
+
556
+
557
+ </h3><div class="docstring">
558
+ <div class="discussion">
559
+
560
+
561
+ </div>
562
+ </div>
563
+ <div class="tags">
564
+ <p class="tag_title">Parameters:</p>
565
+ <ul class="param">
566
+
567
+ <li>
568
+
569
+ <span class='name'>dependencies</span>
570
+
571
+
572
+ <span class='type'>(<tt>Array</tt>)</span>
573
+
574
+
575
+
576
+ </li>
577
+
578
+ </ul>
579
+
580
+
581
+ </div><table class="source_code">
582
+ <tr>
583
+ <td>
584
+ <pre class="lines">
585
+
586
+
587
+ 110
588
+ 111
589
+ 112
590
+ 113</pre>
591
+ </td>
592
+ <td>
593
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 110</span>
594
+
595
+ param [String] scope
596
+ #
597
+ def add_dependency( notation, scope = nil )
598
+ @</pre>
599
+ </td>
600
+ </tr>
601
+ </table>
602
+ </div>
603
+
604
+ <div class="method_details ">
605
+ <h3 class="signature " id="final_name-instance_method">
606
+
607
+ - (<tt>Object</tt>) <strong>final_name</strong>
608
+
609
+
610
+
611
+
612
+
613
+ </h3><table class="source_code">
614
+ <tr>
615
+ <td>
616
+ <pre class="lines">
617
+
618
+
619
+ 171
620
+ 172
621
+ 173
622
+ 174
623
+ 175</pre>
624
+ </td>
625
+ <td>
626
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 171</span>
627
+
628
+ p )
629
+ end
630
+ goals = opts
631
+
632
+ po</pre>
633
+ </td>
634
+ </tr>
635
+ </table>
636
+ </div>
637
+
638
+ <div class="method_details ">
639
+ <h3 class="signature " id="invoke-instance_method">
640
+
641
+ - (<tt>Object</tt>) <strong>invoke</strong>(* )
642
+
643
+
644
+
645
+
646
+
647
+ </h3><table class="source_code">
648
+ <tr>
649
+ <td>
650
+ <pre class="lines">
651
+
652
+
653
+ 152
654
+ 153
655
+ 154
656
+ 155
657
+ 156
658
+ 157
659
+ 158
660
+ 159
661
+ 160
662
+ 161
663
+ 162
664
+ 163
665
+ 164
666
+ 165
667
+ 166
668
+ 167
669
+ 168
670
+ 169
671
+ 170
672
+ 171
673
+ 172
674
+ 173
675
+ 174
676
+ 175
677
+ 176</pre>
678
+ </td>
679
+ <td>
680
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 152</span>
681
+
682
+ build_pom()
683
+ @project.toXml()
684
+ end
685
+
686
+
687
+ # Write Maven Pom
688
+ #
689
+ # @param [String] file_path
690
+ def write_pom( file_path )
691
+ @project.writePom( file_path )
692
+ end
693
+
694
+ # Invoke a Maven goal
695
+ #
696
+ # @params [Array] Goals names
697
+ def invoke( *opts )
698
+ #defaults
699
+ config = {
700
+ # Checks ENV for maven home, otherwise defaults /usr/share/maven
701
+ :maven_home =&gt; ENV['maven.home'] || ENV['MAVEN_HOME'] || '/usr/share/maven',
702
+ :local_repo =&gt; File.expand_path('~/.m2/repository')
703
+ }
704
+
705
+ if opts.last.is_a? Hash
706
+ config = config.merge( o</pre>
707
+ </td>
708
+ </tr>
709
+ </table>
710
+ </div>
711
+
712
+ <div class="method_details ">
713
+ <h3 class="signature " id="load_naether-instance_method">
714
+
715
+ - (<tt>Object</tt>) <strong>load_naether</strong>(tories )
716
+
717
+
718
+
719
+
720
+
721
+ </h3><div class="docstring">
722
+ <div class="discussion">
723
+
724
+ <p>Load dependencies and remote repo from a <span class='object_link'><a href="../Naether.html" title="Naether (module)">Naether</a></span> instance</p>
725
+
726
+
727
+ </div>
728
+ </div>
729
+ <div class="tags">
730
+
731
+
732
+ </div><table class="source_code">
733
+ <tr>
734
+ <td>
735
+ <pre class="lines">
736
+
737
+
738
+ 129
739
+ 130
740
+ 131
741
+ 132
742
+ 133
743
+ 134
744
+ 135
745
+ 136
746
+ 137</pre>
747
+ </td>
748
+ <td>
749
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 129</span>
750
+
751
+ positories( repositories )
752
+ end
753
+
754
+ # Get the version
755
+ #
756
+ # return [String] version
757
+ def version()
758
+ return @project.getVersion()
759
+ end</pre>
760
+ </td>
761
+ </tr>
762
+ </table>
763
+ </div>
764
+
765
+ <div class="method_details ">
766
+ <h3 class="signature " id="notation=-instance_method">
767
+
768
+ - (<tt>Object</tt>) <strong>notation=</strong>(tion
769
+ )
770
+
771
+
772
+
773
+
774
+
775
+ </h3><div class="docstring">
776
+ <div class="discussion">
777
+
778
+
779
+ </div>
780
+ </div>
781
+ <div class="tags">
782
+
783
+
784
+ <p class="tag_title">See Also:</p>
785
+ <ul class="see">
786
+
787
+ <li><a href="https://github.com/mguymon/naether/wiki/Notations" target="_parent" title="https://github.com/mguymon/naether/wiki/Notations">https://github.com/mguymon/naether/wiki/Notations</a></li>
788
+
789
+ </ul>
790
+
791
+ </div><table class="source_code">
792
+ <tr>
793
+ <td>
794
+ <pre class="lines">
795
+
796
+
797
+ 64
798
+ 65</pre>
799
+ </td>
800
+ <td>
801
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 64</span>
802
+
803
+ [String] notation
804
+ # @see https://github.com/mguymon/naether/wiki/Not</pre>
805
+ </td>
806
+ </tr>
807
+ </table>
808
+ </div>
809
+
810
+ <div class="method_details ">
811
+ <h3 class="signature " id="repositories=-instance_method">
812
+
813
+ - (<tt>Object</tt>) <strong>repositories=</strong>(@param [Arra)
814
+
815
+
816
+
817
+
818
+
819
+ </h3><div class="docstring">
820
+ <div class="discussion">
821
+
822
+
823
+ </div>
824
+ </div>
825
+ <div class="tags">
826
+ <p class="tag_title">Parameters:</p>
827
+ <ul class="param">
828
+
829
+ <li>
830
+
831
+ <span class='name'>repositories</span>
832
+
833
+
834
+ <span class='type'>(<tt>Array</tt>)</span>
835
+
836
+
837
+
838
+ &mdash;
839
+ <div class='inline'>
840
+ <p>of urls</p>
841
+ </div>
842
+
843
+ </li>
844
+
845
+ </ul>
846
+
847
+
848
+ </div><table class="source_code">
849
+ <tr>
850
+ <td>
851
+ <pre class="lines">
852
+
853
+
854
+ 117
855
+ 118
856
+ 119
857
+ 120</pre>
858
+ </td>
859
+ <td>
860
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 117</span>
861
+
862
+ encies
863
+ #
864
+ # @param [Array] dependencies
865
+ def dependencies=(dependencies)</pre>
866
+ </td>
867
+ </tr>
868
+ </table>
869
+ </div>
870
+
871
+ <div class="method_details ">
872
+ <h3 class="signature " id="version-instance_method">
873
+
874
+ - (<tt>Object</tt>) <strong>version</strong>
875
+
876
+
877
+
878
+
879
+
880
+ </h3><div class="docstring">
881
+ <div class="discussion">
882
+
883
+ <p>return [String] version</p>
884
+
885
+
886
+ </div>
887
+ </div>
888
+ <div class="tags">
889
+
890
+
891
+ </div><table class="source_code">
892
+ <tr>
893
+ <td>
894
+ <pre class="lines">
895
+
896
+
897
+ 124
898
+ 125
899
+ 126</pre>
900
+ </td>
901
+ <td>
902
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 124</span>
903
+
904
+ <span class='const'>Set</span> <span class='id identifier rubyid_repositories'>repositories</span>
905
+ <span class='comment'>#
906
+ </span><span class='comment'># @param [Array] reposit</span></pre>
907
+ </td>
908
+ </tr>
909
+ </table>
910
+ </div>
911
+
912
+ <div class="method_details ">
913
+ <h3 class="signature " id="write_pom-instance_method">
914
+
915
+ - (<tt>Object</tt>) <strong>write_pom</strong>(er.getRem)
916
+
917
+
918
+
919
+
920
+
921
+ </h3><div class="docstring">
922
+ <div class="discussion">
923
+
924
+
925
+ </div>
926
+ </div>
927
+ <div class="tags">
928
+ <p class="tag_title">Parameters:</p>
929
+ <ul class="param">
930
+
931
+ <li>
932
+
933
+ <span class='name'>file_path</span>
934
+
935
+
936
+ <span class='type'>(<tt>String</tt>)</span>
937
+
938
+
939
+
940
+ </li>
941
+
942
+ </ul>
943
+
944
+
945
+ </div><table class="source_code">
946
+ <tr>
947
+ <td>
948
+ <pre class="lines">
949
+
950
+
951
+ 145
952
+ 146
953
+ 147
954
+ 148</pre>
955
+ </td>
956
+ <td>
957
+ <pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 145</span>
958
+
959
+ naether.resolver.getRemoteRepositoryUrls()
960
+ end
961
+
962
+ # Crea</pre>
963
+ </td>
964
+ </tr>
965
+ </table>
966
+ </div>
967
+
968
+ </div>
969
+
970
+ </div>
971
+
972
+ <div id="footer">
973
+ Generated on Wed Oct 02 21:56:40 2013 by
974
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
975
+ 0.8.7.2 (ruby-1.9.3).
976
+ </div>
977
+
978
+ </body>
979
+ </html>