netlinx-src 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/doc/NetLinx.html +39 -39
  3. data/doc/NetLinx/Rake.html +39 -39
  4. data/doc/NetLinx/Rake/MkZip.html +50 -49
  5. data/doc/NetLinx/Rake/Pack.html +50 -49
  6. data/doc/NetLinx/Rake/RmZip.html +50 -49
  7. data/doc/NetLinx/Rake/SrcIgnore.html +50 -49
  8. data/doc/NetLinx/Rake/Unpack.html +50 -49
  9. data/doc/NetLinx/SRC.html +38 -38
  10. data/doc/NetLinx/SRC/Package.html +61 -60
  11. data/doc/_index.html +28 -31
  12. data/doc/class_list.html +24 -31
  13. data/doc/created.rid +2 -0
  14. data/doc/css/full_list.css +32 -31
  15. data/doc/css/style.css +251 -91
  16. data/doc/file.README.html +28 -31
  17. data/doc/file.license.html +28 -31
  18. data/doc/file_list.html +29 -31
  19. data/doc/frames.html +7 -16
  20. data/doc/images/add.png +0 -0
  21. data/doc/images/arrow_up.png +0 -0
  22. data/doc/images/brick.png +0 -0
  23. data/doc/images/brick_link.png +0 -0
  24. data/doc/images/bug.png +0 -0
  25. data/doc/images/bullet_black.png +0 -0
  26. data/doc/images/bullet_toggle_minus.png +0 -0
  27. data/doc/images/bullet_toggle_plus.png +0 -0
  28. data/doc/images/date.png +0 -0
  29. data/doc/images/delete.png +0 -0
  30. data/doc/images/find.png +0 -0
  31. data/doc/images/loadingAnimation.gif +0 -0
  32. data/doc/images/macFFBgHack.png +0 -0
  33. data/doc/images/package.png +0 -0
  34. data/doc/images/page_green.png +0 -0
  35. data/doc/images/page_white_text.png +0 -0
  36. data/doc/images/page_white_width.png +0 -0
  37. data/doc/images/plugin.png +0 -0
  38. data/doc/images/ruby.png +0 -0
  39. data/doc/images/tag_blue.png +0 -0
  40. data/doc/images/tag_green.png +0 -0
  41. data/doc/images/transparent.png +0 -0
  42. data/doc/images/wrench.png +0 -0
  43. data/doc/images/wrench_orange.png +0 -0
  44. data/doc/images/zoom.png +0 -0
  45. data/doc/index.html +28 -31
  46. data/doc/js/app.js +106 -77
  47. data/doc/js/darkfish.js +155 -0
  48. data/doc/js/full_list.js +170 -135
  49. data/doc/js/navigation.js +142 -0
  50. data/doc/js/search.js +94 -0
  51. data/doc/js/search_index.js +1 -0
  52. data/doc/js/searcher.js +228 -0
  53. data/doc/method_list.html +113 -83
  54. data/doc/rdoc.css +595 -0
  55. data/doc/table_of_contents.html +43 -0
  56. data/doc/top-level-namespace.html +34 -36
  57. metadata +51 -17
  58. data/doc/NetLinx/ProjectPackage.html +0 -868
  59. data/doc/NetLinx/Rake/DelZip.html +0 -337
  60. data/doc/NetLinx/Rake/ToZip.html +0 -337
  61. data/doc/NetLinx/Rake/Zip.html +0 -326
@@ -0,0 +1,43 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>Table of Contents - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "./";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
21
+
22
+
23
+ <body class="indexpage">
24
+ <h1>Table of Contents - RDoc Documentation</h1>
25
+
26
+
27
+ <h2 id="classes">Classes/Modules</h2>
28
+ <ul>
29
+
30
+ </ul>
31
+
32
+ <h2 id="methods">Methods</h2>
33
+ <ul>
34
+
35
+ </ul>
36
+
37
+
38
+ <footer id="validator-badges">
39
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
40
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
41
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
42
+ </footer>
43
+
@@ -1,12 +1,12 @@
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">
1
+ <!DOCTYPE html>
2
+ <html>
4
3
  <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
6
  <title>
7
7
  Top Level Namespace
8
8
 
9
- &mdash; Documentation by YARD 0.8.7.6
9
+ &mdash; Documentation by YARD 0.9.12
10
10
 
11
11
  </title>
12
12
 
@@ -15,9 +15,8 @@
15
15
  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
16
 
17
17
  <script type="text/javascript" charset="utf-8">
18
- hasFrames = window.top.frames.main ? true : false;
18
+ pathId = "";
19
19
  relpath = '';
20
- framesUrl = "frames.html#!top-level-namespace.html";
21
20
  </script>
22
21
 
23
22
 
@@ -28,58 +27,56 @@
28
27
 
29
28
  </head>
30
29
  <body>
31
- <div id="header">
32
- <div id="menu">
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">
33
38
 
34
39
  <a href="_index.html">Index</a> &raquo;
35
40
 
36
41
 
37
42
  <span class="title">Top Level Namespace</span>
38
43
 
39
-
40
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
44
  </div>
42
45
 
43
- <div id="search">
46
+ <div id="search">
44
47
 
45
48
  <a class="full_list_link" id="class_list_link"
46
49
  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
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
58
56
  </a>
59
57
 
60
58
  </div>
61
- <div class="clear"></div>
62
- </div>
59
+ <div class="clear"></div>
60
+ </div>
63
61
 
64
- <iframe id="search_frame"></iframe>
65
-
66
- <div id="content"><h1>Top Level Namespace
62
+ <div id="content"><h1>Top Level Namespace
67
63
 
68
64
 
69
65
 
70
66
  </h1>
67
+ <div class="box_info">
68
+
71
69
 
72
- <dl class="box">
73
70
 
74
71
 
75
-
76
72
 
77
-
78
73
 
79
74
 
75
+
80
76
 
81
- </dl>
82
- <div class="clear"></div>
77
+
78
+
79
+ </div>
83
80
 
84
81
  <h2>Defined Under Namespace</h2>
85
82
  <p class="children">
@@ -102,11 +99,12 @@
102
99
 
103
100
  </div>
104
101
 
105
- <div id="footer">
106
- Generated on Wed Feb 25 10:34:58 2015 by
102
+ <div id="footer">
103
+ Generated on Tue Feb 13 20:59:53 2018 by
107
104
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
108
- 0.8.7.6 (ruby-2.1.3).
105
+ 0.9.12 (ruby-2.1.8).
109
106
  </div>
110
107
 
108
+ </div>
111
109
  </body>
112
110
  </html>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: netlinx-src
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Alex McLain
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-02-25 00:00:00.000000000 Z
11
+ date: 2018-02-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rubyzip
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '1.1'
19
+ version: '1.2'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '1.1'
26
+ version: '1.2'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: netlinx-workspace
29
29
  requirement: !ruby/object:Gem::Requirement
@@ -50,42 +50,48 @@ dependencies:
50
50
  requirements:
51
51
  - - "~>"
52
52
  - !ruby/object:Gem::Version
53
- version: '10.4'
53
+ version: '12.3'
54
54
  type: :development
55
55
  prerelease: false
56
56
  version_requirements: !ruby/object:Gem::Requirement
57
57
  requirements:
58
58
  - - "~>"
59
59
  - !ruby/object:Gem::Version
60
- version: '10.4'
60
+ version: '12.3'
61
61
  - !ruby/object:Gem::Dependency
62
62
  name: yard
63
63
  requirement: !ruby/object:Gem::Requirement
64
64
  requirements:
65
65
  - - "~>"
66
66
  - !ruby/object:Gem::Version
67
- version: 0.8.7
67
+ version: '0.9'
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: 0.9.11
68
71
  type: :development
69
72
  prerelease: false
70
73
  version_requirements: !ruby/object:Gem::Requirement
71
74
  requirements:
72
75
  - - "~>"
73
76
  - !ruby/object:Gem::Version
74
- version: 0.8.7
77
+ version: '0.9'
78
+ - - ">="
79
+ - !ruby/object:Gem::Version
80
+ version: 0.9.11
75
81
  - !ruby/object:Gem::Dependency
76
82
  name: rspec
77
83
  requirement: !ruby/object:Gem::Requirement
78
84
  requirements:
79
85
  - - "~>"
80
86
  - !ruby/object:Gem::Version
81
- version: '3.2'
87
+ version: '3.7'
82
88
  type: :development
83
89
  prerelease: false
84
90
  version_requirements: !ruby/object:Gem::Requirement
85
91
  requirements:
86
92
  - - "~>"
87
93
  - !ruby/object:Gem::Version
88
- version: '3.2'
94
+ version: '3.7'
89
95
  - !ruby/object:Gem::Dependency
90
96
  name: rspec-its
91
97
  requirement: !ruby/object:Gem::Requirement
@@ -151,20 +157,17 @@ extra_rdoc_files: []
151
157
  files:
152
158
  - README.md
153
159
  - doc/NetLinx.html
154
- - doc/NetLinx/ProjectPackage.html
155
160
  - doc/NetLinx/Rake.html
156
- - doc/NetLinx/Rake/DelZip.html
157
161
  - doc/NetLinx/Rake/MkZip.html
158
162
  - doc/NetLinx/Rake/Pack.html
159
163
  - doc/NetLinx/Rake/RmZip.html
160
164
  - doc/NetLinx/Rake/SrcIgnore.html
161
- - doc/NetLinx/Rake/ToZip.html
162
165
  - doc/NetLinx/Rake/Unpack.html
163
- - doc/NetLinx/Rake/Zip.html
164
166
  - doc/NetLinx/SRC.html
165
167
  - doc/NetLinx/SRC/Package.html
166
168
  - doc/_index.html
167
169
  - doc/class_list.html
170
+ - doc/created.rid
168
171
  - doc/css/common.css
169
172
  - doc/css/full_list.css
170
173
  - doc/css/style.css
@@ -172,11 +175,43 @@ files:
172
175
  - doc/file.license.html
173
176
  - doc/file_list.html
174
177
  - doc/frames.html
178
+ - doc/images/add.png
179
+ - doc/images/arrow_up.png
180
+ - doc/images/brick.png
181
+ - doc/images/brick_link.png
182
+ - doc/images/bug.png
183
+ - doc/images/bullet_black.png
184
+ - doc/images/bullet_toggle_minus.png
185
+ - doc/images/bullet_toggle_plus.png
186
+ - doc/images/date.png
187
+ - doc/images/delete.png
188
+ - doc/images/find.png
189
+ - doc/images/loadingAnimation.gif
190
+ - doc/images/macFFBgHack.png
191
+ - doc/images/package.png
192
+ - doc/images/page_green.png
193
+ - doc/images/page_white_text.png
194
+ - doc/images/page_white_width.png
195
+ - doc/images/plugin.png
196
+ - doc/images/ruby.png
197
+ - doc/images/tag_blue.png
198
+ - doc/images/tag_green.png
199
+ - doc/images/transparent.png
200
+ - doc/images/wrench.png
201
+ - doc/images/wrench_orange.png
202
+ - doc/images/zoom.png
175
203
  - doc/index.html
176
204
  - doc/js/app.js
205
+ - doc/js/darkfish.js
177
206
  - doc/js/full_list.js
178
207
  - doc/js/jquery.js
208
+ - doc/js/navigation.js
209
+ - doc/js/search.js
210
+ - doc/js/search_index.js
211
+ - doc/js/searcher.js
179
212
  - doc/method_list.html
213
+ - doc/rdoc.css
214
+ - doc/table_of_contents.html
180
215
  - doc/top-level-namespace.html
181
216
  - lib/netlinx/rake/src.rb
182
217
  - lib/netlinx/rake/src/mkzip.rb
@@ -189,7 +224,7 @@ files:
189
224
  - license.txt
190
225
  homepage: https://github.com/amclain/netlinx-src
191
226
  licenses:
192
- - Apache 2.0
227
+ - Apache-2.0
193
228
  metadata: {}
194
229
  post_install_message:
195
230
  rdoc_options: []
@@ -207,9 +242,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
207
242
  version: '0'
208
243
  requirements: []
209
244
  rubyforge_project:
210
- rubygems_version: 2.4.6
245
+ rubygems_version: 2.6.13
211
246
  signing_key:
212
247
  specification_version: 4
213
248
  summary: A toolset for working with NetLinx source code packages (.src).
214
249
  test_files: []
215
- has_rdoc:
@@ -1,868 +0,0 @@
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: NetLinx::ProjectPackage
8
-
9
- &mdash; Documentation by YARD 0.8.7.4
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#!NetLinx/ProjectPackage.html";
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 (P)</a> &raquo;
35
- <span class='title'><span class='object_link'><a href="../NetLinx.html" title="NetLinx (module)">NetLinx</a></span></span>
36
- &raquo;
37
- <span class="title">ProjectPackage</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: NetLinx::ProjectPackage
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">NetLinx::ProjectPackage</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/netlinx/project_package.rb</dd>
98
-
99
- </dl>
100
- <div class="clear"></div>
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
- <h2>
111
- Instance 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="#copy_to_zip-instance_method" title="#copy_to_zip (instance method)">- (Object) <strong>copy_to_zip</strong> </a>
121
-
122
-
123
-
124
- </span>
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
- <span class="summary_desc"><div class='inline'>
135
- <p>Copy the NetLinx .src file to .zip for easy browsing without unpacking.</p>
136
- </div></span>
137
-
138
- </li>
139
-
140
-
141
- <li class="public ">
142
- <span class="summary_signature">
143
-
144
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (ProjectPackage) <strong>initialize</strong>(**kvargs) </a>
145
-
146
-
147
-
148
- </span>
149
-
150
-
151
- <span class="note title constructor">constructor</span>
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
- <span class="summary_desc"><div class='inline'>
161
- <p>Parameters:.</p>
162
- </div></span>
163
-
164
- </li>
165
-
166
-
167
- <li class="public ">
168
- <span class="summary_signature">
169
-
170
- <a href="#load_exclusions-instance_method" title="#load_exclusions (instance method)">- (Object) <strong>load_exclusions</strong> </a>
171
-
172
-
173
-
174
- </span>
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
- <span class="summary_desc"><div class='inline'>
185
- <p>Load a list of file exclusions (glob format) from .srcignore.</p>
186
- </div></span>
187
-
188
- </li>
189
-
190
-
191
- <li class="public ">
192
- <span class="summary_signature">
193
-
194
- <a href="#make_srcignore-instance_method" title="#make_srcignore (instance method)">- (Object) <strong>make_srcignore</strong> </a>
195
-
196
-
197
-
198
- </span>
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
- <span class="summary_desc"><div class='inline'>
209
- <p>Create a standard .srcignore file in the current directory.</p>
210
- </div></span>
211
-
212
- </li>
213
-
214
-
215
- <li class="public ">
216
- <span class="summary_signature">
217
-
218
- <a href="#make_warning_file-instance_method" title="#make_warning_file (instance method)">- (Object) <strong>make_warning_file</strong> </a>
219
-
220
-
221
-
222
- </span>
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
- <span class="summary_desc"><div class='inline'>
233
- <p>Returns a string for the unpack warning file.</p>
234
- </div></span>
235
-
236
- </li>
237
-
238
-
239
- <li class="public ">
240
- <span class="summary_signature">
241
-
242
- <a href="#pack-instance_method" title="#pack (instance method)">- (Object) <strong>pack</strong> </a>
243
-
244
-
245
-
246
- </span>
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
- <span class="summary_desc"><div class='inline'>
257
- <p>Pack the project into a NetLinx .src package.</p>
258
- </div></span>
259
-
260
- </li>
261
-
262
-
263
- <li class="public ">
264
- <span class="summary_signature">
265
-
266
- <a href="#remove_zip-instance_method" title="#remove_zip (instance method)">- (Object) <strong>remove_zip</strong> </a>
267
-
268
-
269
-
270
- </span>
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
- <span class="summary_desc"><div class='inline'>
281
- <p>Remove the .zip version of this NetLinx .src file if it exists.</p>
282
- </div></span>
283
-
284
- </li>
285
-
286
-
287
- <li class="public ">
288
- <span class="summary_signature">
289
-
290
- <a href="#unpack-instance_method" title="#unpack (instance method)">- (Object) <strong>unpack</strong>(dir = nil) </a>
291
-
292
-
293
-
294
- </span>
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
- <span class="summary_desc"><div class='inline'>
305
- <p>Unpack a NetLinx .src project package.</p>
306
- </div></span>
307
-
308
- </li>
309
-
310
-
311
- </ul>
312
-
313
-
314
- <div id="constructor_details" class="method_details_list">
315
- <h2>Constructor Details</h2>
316
-
317
- <div class="method_details first">
318
- <h3 class="signature first" id="initialize-instance_method">
319
-
320
- - (<tt><span class='object_link'><a href="" title="NetLinx::ProjectPackage (class)">ProjectPackage</a></span></tt>) <strong>initialize</strong>(**kvargs)
321
-
322
-
323
-
324
-
325
-
326
- </h3><div class="docstring">
327
- <div class="discussion">
328
-
329
- <p>Parameters:</p>
330
-
331
- <pre class="code ruby"><code class="ruby">Mode:
332
- :standard - Intelligently package all files pertaining to a
333
- NetLinx project.
334
-
335
- :classic - Emulates the AMX file packager, including only .axs
336
- and .axi files in the package. Also mimicks the same folder
337
- structure.</code></pre>
338
-
339
-
340
- </div>
341
- </div>
342
- <div class="tags">
343
-
344
-
345
- </div><table class="source_code">
346
- <tr>
347
- <td>
348
- <pre class="lines">
349
-
350
-
351
- 16
352
- 17
353
- 18
354
- 19
355
- 20
356
- 21</pre>
357
- </td>
358
- <td>
359
- <pre class="code"><span class="info file"># File 'lib/netlinx/project_package.rb', line 16</span>
360
-
361
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='op'>**</span><span class='id identifier rubyid_kvargs'>kvargs</span>
362
- <span class='ivar'>@file</span> <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:file</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
363
- <span class='ivar'>@mode</span> <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:mode</span><span class='comma'>,</span> <span class='symbol'>:standard</span>
364
-
365
- <span class='ivar'>@warning_file</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_FILE_EXTRACTION_WARNING.txt</span><span class='tstring_end'>&#39;</span></span>
366
- <span class='kw'>end</span></pre>
367
- </td>
368
- </tr>
369
- </table>
370
- </div>
371
-
372
- </div>
373
-
374
-
375
- <div id="instance_method_details" class="method_details_list">
376
- <h2>Instance Method Details</h2>
377
-
378
-
379
- <div class="method_details first">
380
- <h3 class="signature first" id="copy_to_zip-instance_method">
381
-
382
- - (<tt>Object</tt>) <strong>copy_to_zip</strong>
383
-
384
-
385
-
386
-
387
-
388
- </h3><div class="docstring">
389
- <div class="discussion">
390
-
391
- <p>Copy the NetLinx .src file to .zip for easy browsing without unpacking.</p>
392
-
393
-
394
- </div>
395
- </div>
396
- <div class="tags">
397
-
398
-
399
- </div><table class="source_code">
400
- <tr>
401
- <td>
402
- <pre class="lines">
403
-
404
-
405
- 64
406
- 65
407
- 66</pre>
408
- </td>
409
- <td>
410
- <pre class="code"><span class="info file"># File 'lib/netlinx/project_package.rb', line 64</span>
411
-
412
- <span class='kw'>def</span> <span class='id identifier rubyid_copy_to_zip'>copy_to_zip</span>
413
- <span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_cp'>cp</span> <span class='ivar'>@file</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@file</span><span class='embexpr_end'>}</span><span class='tstring_content'>.zip</span><span class='tstring_end'>&quot;</span></span>
414
- <span class='kw'>end</span></pre>
415
- </td>
416
- </tr>
417
- </table>
418
- </div>
419
-
420
- <div class="method_details ">
421
- <h3 class="signature " id="load_exclusions-instance_method">
422
-
423
- - (<tt>Object</tt>) <strong>load_exclusions</strong>
424
-
425
-
426
-
427
-
428
-
429
- </h3><div class="docstring">
430
- <div class="discussion">
431
-
432
- <p>Load a list of file exclusions (glob format) from .srcignore.</p>
433
-
434
-
435
- </div>
436
- </div>
437
- <div class="tags">
438
-
439
-
440
- </div><table class="source_code">
441
- <tr>
442
- <td>
443
- <pre class="lines">
444
-
445
-
446
- 54
447
- 55
448
- 56
449
- 57
450
- 58
451
- 59
452
- 60
453
- 61</pre>
454
- </td>
455
- <td>
456
- <pre class="code"><span class="info file"># File 'lib/netlinx/project_package.rb', line 54</span>
457
-
458
- <span class='kw'>def</span> <span class='id identifier rubyid_load_exclusions'>load_exclusions</span>
459
- <span class='kw'>return</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.srcignore</span><span class='tstring_end'>&#39;</span></span>
460
-
461
- <span class='id identifier rubyid_lines'>lines</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.srcignore</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:strip</span><span class='rparen'>)</span><span class='period'>
462
- </span><span class='id identifier rubyid_ .reject'> .reject</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_l'>l</span><span class='op'>|</span> <span class='id identifier rubyid_l'>l</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='rbrace'>}</span> <span class='comment'># Remove empty lines.
463
- </span><span class='period'> .</span><span class='id identifier rubyid_reject'>reject</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_l'>l</span><span class='op'>|</span> <span class='id identifier rubyid_l'>l</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>#</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span> <span class='comment'># Remove commented lines.
464
- </span><span class='period'> .</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_l'>l</span><span class='op'>|</span> <span class='id identifier rubyid_l'>l</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_l'>l</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>**/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_l'>l</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span> <span class='comment'># Append **/ if a specific path isn&#39;t referenced.
465
- </span><span class='kw'>end</span></pre>
466
- </td>
467
- </tr>
468
- </table>
469
- </div>
470
-
471
- <div class="method_details ">
472
- <h3 class="signature " id="make_srcignore-instance_method">
473
-
474
- - (<tt>Object</tt>) <strong>make_srcignore</strong>
475
-
476
-
477
-
478
-
479
-
480
- </h3><div class="docstring">
481
- <div class="discussion">
482
-
483
- <p>Create a standard .srcignore file in the current directory. Raises
484
- exception if file exists.</p>
485
-
486
-
487
- </div>
488
- </div>
489
- <div class="tags">
490
-
491
- <p class="tag_title">Raises:</p>
492
- <ul class="raise">
493
-
494
- <li>
495
-
496
-
497
- <span class='type'>(<tt>IOError</tt>)</span>
498
-
499
-
500
-
501
- </li>
502
-
503
- </ul>
504
-
505
- </div><table class="source_code">
506
- <tr>
507
- <td>
508
- <pre class="lines">
509
-
510
-
511
- 75
512
- 76
513
- 77
514
- 78
515
- 79
516
- 80
517
- 81
518
- 82
519
- 83
520
- 84
521
- 85
522
- 86
523
- 87
524
- 88
525
- 89
526
- 90
527
- 91
528
- 92
529
- 93
530
- 94
531
- 95
532
- 96
533
- 97
534
- 98
535
- 99
536
- 100
537
- 101
538
- 102
539
- 103
540
- 104
541
- 105
542
- 106
543
- 107
544
- 108
545
- 109
546
- 110
547
- 111
548
- 112
549
- 113
550
- 114</pre>
551
- </td>
552
- <td>
553
- <pre class="code"><span class="info file"># File 'lib/netlinx/project_package.rb', line 75</span>
554
-
555
- <span class='kw'>def</span> <span class='id identifier rubyid_make_srcignore'>make_srcignore</span>
556
- <span class='id identifier rubyid_raise'>raise</span> <span class='const'>IOError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A .srcignore file already exists in this directory.</span><span class='tstring_end'>&quot;</span></span> \
557
- <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.srcignore</span><span class='tstring_end'>&#39;</span></span>
558
-
559
- <span class='id identifier rubyid_string'>string</span> <span class='op'>=</span> <span class='heredoc_beg'>&lt;&lt;-EOS</span>
560
- <span class='tstring_content'># --------------------------------------------------- #
561
- # Files to exclude from .SRC package (glob format). #
562
- # --------------------------------------------------- #
563
-
564
- # AMX
565
-
566
- *.src
567
- *.tp4
568
-
569
- # Graphics
570
-
571
- *.ai
572
- *.bmp
573
- *.eps
574
- *.gif
575
- *.jpg
576
- *.jpeg
577
- *.png
578
- *.psd
579
- *.svg
580
-
581
- # Archives
582
-
583
- *.gz
584
- *.tar
585
- *.zip
586
-
587
- # Documentation
588
-
589
- *.pdf
590
-
591
- </span><span class='heredoc_end'>EOS
592
- </span>
593
- <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.srcignore</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_string'>string</span>
594
- <span class='kw'>end</span></pre>
595
- </td>
596
- </tr>
597
- </table>
598
- </div>
599
-
600
- <div class="method_details ">
601
- <h3 class="signature " id="make_warning_file-instance_method">
602
-
603
- - (<tt>Object</tt>) <strong>make_warning_file</strong>
604
-
605
-
606
-
607
-
608
-
609
- </h3><div class="docstring">
610
- <div class="discussion">
611
-
612
- <p>Returns a string for the unpack warning file.</p>
613
-
614
-
615
- </div>
616
- </div>
617
- <div class="tags">
618
-
619
-
620
- </div><table class="source_code">
621
- <tr>
622
- <td>
623
- <pre class="lines">
624
-
625
-
626
- 117
627
- 118
628
- 119
629
- 120
630
- 121
631
- 122
632
- 123
633
- 124
634
- 125
635
- 126
636
- 127
637
- 128
638
- 129
639
- 130
640
- 131
641
- 132
642
- 133
643
- 134
644
- 135
645
- 136
646
- 137
647
- 138
648
- 139
649
- 140
650
- 141
651
- 142
652
- 143
653
- 144
654
- 145
655
- 146</pre>
656
- </td>
657
- <td>
658
- <pre class="code"><span class="info file"># File 'lib/netlinx/project_package.rb', line 117</span>
659
-
660
- <span class='kw'>def</span> <span class='id identifier rubyid_make_warning_file'>make_warning_file</span>
661
- <span class='heredoc_beg'>&lt;&lt;-EOS</span><span class='period'>
662
- </span><span class='id identifier rubyid_ .gsub'> .gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\r\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># Format for readability in Notepad.
663
- </span><span class='tstring_content'># ---------------------------------------------------------------------- #
664
- # WARNING: This archive should be unpacked with the netlinx-src utility #
665
- # ---------------------------------------------------------------------- #
666
-
667
- Download
668
- --------
669
-
670
- http://sourceforge.net/p/netlinx-src/wiki/Home/
671
-
672
-
673
- About
674
- -----
675
-
676
- netlinx-src is a third-party utility for creating and extracting NetLinx
677
- .src source code package files. Unlike the standard utility that ships
678
- with NetLinx Studio, netlinx-src will retain the project&#39;s folder
679
- structure when the project is extracted. This becomes increasingly more
680
- important based on the number of files a project contains.
681
-
682
- Packaging a project with netlinx-src is also more comprehensive than
683
- using the standard utility. Not only is netlinx-src courteous enough
684
- to package files necessary for maintenance of the system (IR libraries,
685
- Duet modules, NetLinx modules, etc.), it also features a fine-grained
686
- file exclusion list that can prevent bulky touch panel files or graphics
687
- from filling up the disk space on the master.
688
- </span><span class='heredoc_end'>EOS
689
- </span><span class='kw'>end</span></pre>
690
- </td>
691
- </tr>
692
- </table>
693
- </div>
694
-
695
- <div class="method_details ">
696
- <h3 class="signature " id="pack-instance_method">
697
-
698
- - (<tt>Object</tt>) <strong>pack</strong>
699
-
700
-
701
-
702
-
703
-
704
- </h3><div class="docstring">
705
- <div class="discussion">
706
-
707
- <p>Pack the project into a NetLinx .src package.</p>
708
-
709
-
710
- </div>
711
- </div>
712
- <div class="tags">
713
-
714
-
715
- </div><table class="source_code">
716
- <tr>
717
- <td>
718
- <pre class="lines">
719
-
720
-
721
- 24
722
- 25
723
- 26
724
- 27
725
- 28
726
- 29
727
- 30
728
- 31
729
- 32
730
- 33
731
- 34
732
- 35
733
- 36
734
- 37
735
- 38
736
- 39
737
- 40</pre>
738
- </td>
739
- <td>
740
- <pre class="code"><span class="info file"># File 'lib/netlinx/project_package.rb', line 24</span>
741
-
742
- <span class='kw'>def</span> <span class='id identifier rubyid_pack'>pack</span>
743
- <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='ivar'>@file</span> <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span> <span class='ivar'>@file</span>
744
-
745
- <span class='id identifier rubyid_files'>files</span> <span class='op'>=</span> <span class='const'>Dir</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>**/*</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>-</span> <span class='const'>Dir</span><span class='lbracket'>[</span><span class='ivar'>@file</span><span class='rbracket'>]</span>
746
-
747
- <span class='comment'># Exclude ignored files.
748
- </span> <span class='id identifier rubyid_exclusions'>exclusions</span> <span class='op'>=</span> <span class='id identifier rubyid_load_exclusions'>load_exclusions</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span> <span class='const'>Dir</span><span class='lbracket'>[</span><span class='id identifier rubyid_e'>e</span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span>
749
- <span class='id identifier rubyid_files'>files</span> <span class='op'>=</span> <span class='id identifier rubyid_files'>files</span> <span class='op'>-</span> <span class='id identifier rubyid_exclusions'>exclusions</span>
750
-
751
- <span class='const'>Zip</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span> <span class='ivar'>@file</span><span class='comma'>,</span> <span class='const'>Zip</span><span class='op'>::</span><span class='const'>File</span><span class='op'>::</span><span class='const'>CREATE</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_zip'>zip</span><span class='op'>|</span>
752
- <span class='id identifier rubyid_files'>files</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_file'>file</span><span class='op'>|</span> <span class='id identifier rubyid_zip'>zip</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_file'>file</span> <span class='rbrace'>}</span>
753
-
754
- <span class='id identifier rubyid_zip'>zip</span><span class='period'>.</span><span class='id identifier rubyid_get_output_stream'>get_output_stream</span><span class='lparen'>(</span><span class='ivar'>@warning_file</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span>
755
- <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_make_warning_file'>make_warning_file</span>
756
- <span class='rbrace'>}</span>
757
- <span class='kw'>end</span>
758
- <span class='kw'>end</span></pre>
759
- </td>
760
- </tr>
761
- </table>
762
- </div>
763
-
764
- <div class="method_details ">
765
- <h3 class="signature " id="remove_zip-instance_method">
766
-
767
- - (<tt>Object</tt>) <strong>remove_zip</strong>
768
-
769
-
770
-
771
-
772
-
773
- </h3><div class="docstring">
774
- <div class="discussion">
775
-
776
- <p>Remove the .zip version of this NetLinx .src file if it exists.</p>
777
-
778
-
779
- </div>
780
- </div>
781
- <div class="tags">
782
-
783
-
784
- </div><table class="source_code">
785
- <tr>
786
- <td>
787
- <pre class="lines">
788
-
789
-
790
- 69
791
- 70
792
- 71</pre>
793
- </td>
794
- <td>
795
- <pre class="code"><span class="info file"># File 'lib/netlinx/project_package.rb', line 69</span>
796
-
797
- <span class='kw'>def</span> <span class='id identifier rubyid_remove_zip'>remove_zip</span>
798
- <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@file</span><span class='embexpr_end'>}</span><span class='tstring_content'>.zip</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@file</span><span class='embexpr_end'>}</span><span class='tstring_content'>.zip</span><span class='tstring_end'>&quot;</span></span>
799
- <span class='kw'>end</span></pre>
800
- </td>
801
- </tr>
802
- </table>
803
- </div>
804
-
805
- <div class="method_details ">
806
- <h3 class="signature " id="unpack-instance_method">
807
-
808
- - (<tt>Object</tt>) <strong>unpack</strong>(dir = nil)
809
-
810
-
811
-
812
-
813
-
814
- </h3><div class="docstring">
815
- <div class="discussion">
816
-
817
- <p>Unpack a NetLinx .src project package. Unpacks to the given directory, if
818
- provided.</p>
819
-
820
-
821
- </div>
822
- </div>
823
- <div class="tags">
824
-
825
-
826
- </div><table class="source_code">
827
- <tr>
828
- <td>
829
- <pre class="lines">
830
-
831
-
832
- 44
833
- 45
834
- 46
835
- 47
836
- 48
837
- 49
838
- 50
839
- 51</pre>
840
- </td>
841
- <td>
842
- <pre class="code"><span class="info file"># File 'lib/netlinx/project_package.rb', line 44</span>
843
-
844
- <span class='kw'>def</span> <span class='id identifier rubyid_unpack'>unpack</span> <span class='id identifier rubyid_dir'>dir</span> <span class='op'>=</span> <span class='kw'>nil</span>
845
- <span class='const'>Zip</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span> <span class='ivar'>@file</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_zip'>zip</span><span class='op'>|</span>
846
- <span class='id identifier rubyid_zip'>zip</span><span class='period'>.</span><span class='id identifier rubyid_each_entry'>each_entry</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span>
847
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_dir'>dir</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_dir'>dir</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
848
- <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_extract'>extract</span> <span class='id identifier rubyid_path'>path</span> <span class='kw'>unless</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='ivar'>@warning_file</span>
849
- <span class='kw'>end</span>
850
- <span class='kw'>end</span>
851
- <span class='kw'>end</span></pre>
852
- </td>
853
- </tr>
854
- </table>
855
- </div>
856
-
857
- </div>
858
-
859
- </div>
860
-
861
- <div id="footer">
862
- Generated on Fri May 9 14:50:55 2014 by
863
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
864
- 0.8.7.4 (ruby-2.0.0).
865
- </div>
866
-
867
- </body>
868
- </html>