procreate-swatches 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +7 -0
  2. data/.codeclimate.yml +7 -0
  3. data/.gitignore +16 -0
  4. data/.rspec +2 -0
  5. data/.rubocop.yml +8 -0
  6. data/.ruby-version +1 -0
  7. data/.travis.yml +19 -0
  8. data/.yardopts +5 -0
  9. data/CODE_OF_CONDUCT.md +74 -0
  10. data/Gemfile +6 -0
  11. data/Gemfile.lock +102 -0
  12. data/LICENSE.txt +21 -0
  13. data/README.md +230 -0
  14. data/Rakefile +8 -0
  15. data/bin/console +14 -0
  16. data/bin/setup +8 -0
  17. data/doc/Procreate/Swatches/ColorsHelper.html +693 -0
  18. data/doc/Procreate/Swatches/Errors/InvalidFormat.html +220 -0
  19. data/doc/Procreate/Swatches/Errors/InvalidPath.html +220 -0
  20. data/doc/Procreate/Swatches/Errors.html +128 -0
  21. data/doc/Procreate/Swatches/Exporter.html +754 -0
  22. data/doc/Procreate/Swatches/Parser.html +622 -0
  23. data/doc/Procreate/Swatches/Wrapper.html +1168 -0
  24. data/doc/Procreate/Swatches.html +497 -0
  25. data/doc/Procreate.html +128 -0
  26. data/doc/_index.html +209 -0
  27. data/doc/class_list.html +51 -0
  28. data/doc/css/common.css +1 -0
  29. data/doc/css/full_list.css +58 -0
  30. data/doc/css/style.css +496 -0
  31. data/doc/file.CODE_OF_CONDUCT.html +146 -0
  32. data/doc/file.LICENSE.html +70 -0
  33. data/doc/file.README.html +296 -0
  34. data/doc/file_list.html +66 -0
  35. data/doc/frames.html +17 -0
  36. data/doc/index.html +296 -0
  37. data/doc/js/app.js +292 -0
  38. data/doc/js/full_list.js +216 -0
  39. data/doc/js/jquery.js +4 -0
  40. data/doc/method_list.html +275 -0
  41. data/doc/top-level-namespace.html +110 -0
  42. data/lib/procreate/swatches/colors_helper.rb +83 -0
  43. data/lib/procreate/swatches/errors/invalid_format.rb +19 -0
  44. data/lib/procreate/swatches/errors/invalid_path.rb +16 -0
  45. data/lib/procreate/swatches/exporter.rb +131 -0
  46. data/lib/procreate/swatches/parser.rb +82 -0
  47. data/lib/procreate/swatches/version.rb +8 -0
  48. data/lib/procreate/swatches/wrapper.rb +155 -0
  49. data/lib/procreate/swatches.rb +60 -0
  50. data/procreate-swatches.gemspec +41 -0
  51. metadata +275 -0
data/doc/Procreate/Swatches/Parser.html ADDED
@@ -0,0 +1,622 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Procreate::Swatches::Parser
8
+
9
+ &mdash; Documentation by YARD 0.9.16
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Procreate::Swatches::Parser";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (P)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Procreate.html" title="Procreate (module)">Procreate</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Swatches.html" title="Procreate::Swatches (module)">Swatches</a></span></span>
41
+ &raquo;
42
+ <span class="title">Parser</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
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>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Procreate::Swatches::Parser
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Procreate::Swatches::Parser</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+ <dl>
91
+ <dt>Includes:</dt>
92
+ <dd>CallableClass, <span class='object_link'><a href="ColorsHelper.html" title="Procreate::Swatches::ColorsHelper (module)">ColorsHelper</a></span></dd>
93
+ </dl>
94
+
95
+
96
+
97
+
98
+
99
+
100
+ <dl>
101
+ <dt>Defined in:</dt>
102
+ <dd>lib/procreate/swatches/parser.rb</dd>
103
+ </dl>
104
+
105
+ </div>
106
+
107
+ <h2>Overview</h2><div class="docstring">
108
+ <div class="discussion">
109
+
110
+ <p>The class that handles the parsing of a <code>.swatches</code> file to an
111
+ instance of <span class='object_link'><a href="Wrapper.html" title="Procreate::Swatches::Wrapper (class)">Wrapper</a></span>.</p>
112
+
113
+
114
+ </div>
115
+ </div>
116
+ <div class="tags">
117
+
118
+
119
+ </div>
120
+
121
+
122
+ <h2>Constant Summary</h2>
123
+
124
+ <h3 class="inherited">Constants included
125
+ from <span class='object_link'><a href="ColorsHelper.html" title="Procreate::Swatches::ColorsHelper (module)">ColorsHelper</a></span></h3>
126
+ <p class="inherited"><span class='object_link'><a href="ColorsHelper.html#SELECTED_KEYS-constant" title="Procreate::Swatches::ColorsHelper::SELECTED_KEYS (constant)">ColorsHelper::SELECTED_KEYS</a></span>, <span class='object_link'><a href="ColorsHelper.html#SWATCHES_ALPHA-constant" title="Procreate::Swatches::ColorsHelper::SWATCHES_ALPHA (constant)">ColorsHelper::SWATCHES_ALPHA</a></span>, <span class='object_link'><a href="ColorsHelper.html#SWATCHES_COLOR_SPACE-constant" title="Procreate::Swatches::ColorsHelper::SWATCHES_COLOR_SPACE (constant)">ColorsHelper::SWATCHES_COLOR_SPACE</a></span>, <span class='object_link'><a href="ColorsHelper.html#SWATCHES_MAX_SIZE-constant" title="Procreate::Swatches::ColorsHelper::SWATCHES_MAX_SIZE (constant)">ColorsHelper::SWATCHES_MAX_SIZE</a></span></p>
127
+
128
+
129
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
130
+ <ul class="summary">
131
+
132
+ <li class="public ">
133
+ <span class="summary_signature">
134
+
135
+ <a href="#file_path-instance_method" title="#file_path (instance method)">#<strong>file_path</strong> &#x21d2; Object </a>
136
+
137
+
138
+
139
+ </span>
140
+
141
+
142
+
143
+
144
+ <span class="note title readonly">readonly</span>
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+ <span class="summary_desc"><div class='inline'>
155
+ <p>Returns the value of attribute file_path.</p>
156
+ </div></span>
157
+
158
+ </li>
159
+
160
+
161
+ <li class="public ">
162
+ <span class="summary_signature">
163
+
164
+ <a href="#wrapper-instance_method" title="#wrapper (instance method)">#<strong>wrapper</strong> &#x21d2; Object </a>
165
+
166
+
167
+
168
+ </span>
169
+
170
+
171
+
172
+
173
+ <span class="note title readonly">readonly</span>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'>
184
+ <p>Returns the value of attribute wrapper.</p>
185
+ </div></span>
186
+
187
+ </li>
188
+
189
+
190
+ </ul>
191
+
192
+
193
+
194
+
195
+
196
+ <h2>
197
+ Class Method Summary
198
+ <small><a href="#" class="summary_toggle">collapse</a></small>
199
+ </h2>
200
+
201
+ <ul class="summary">
202
+
203
+ <li class="public ">
204
+ <span class="summary_signature">
205
+
206
+ <a href="#call-class_method" title="call (class method)">.<strong>call</strong> &#x21d2; Object </a>
207
+
208
+
209
+
210
+ </span>
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+ <span class="summary_desc"><div class='inline'>
221
+ <p>Creates a new instance of <span class='object_link'><a href="" title="Procreate::Swatches::Parser (class)">Parser</a></span> and calls <span class='object_link'><a href="#call-instance_method" title="Procreate::Swatches::Parser#call (method)">#call</a></span>
222
+ Dynamically included by using
223
+ <a href="https://github.com/laurentzziu/callable_class" target="_parent" title="CallableClass">CallableClass</a> gem.</p>
224
+ </div></span>
225
+
226
+ </li>
227
+
228
+
229
+ </ul>
230
+
231
+ <h2>
232
+ Instance Method Summary
233
+ <small><a href="#" class="summary_toggle">collapse</a></small>
234
+ </h2>
235
+
236
+ <ul class="summary">
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong> &#x21d2; Procreate::Swatches::Wrapper </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+ <span class="summary_desc"><div class='inline'>
256
+ <p>Process the provided <code>.swatches</code> file and wrap the content in a
257
+ <span class='object_link'><a href="Wrapper.html" title="Procreate::Swatches::Wrapper (class)">Wrapper</a></span>.</p>
258
+ </div></span>
259
+
260
+ </li>
261
+
262
+
263
+ <li class="public ">
264
+ <span class="summary_signature">
265
+
266
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(file_path) &#x21d2; Parser </a>
267
+
268
+
269
+
270
+ </span>
271
+
272
+
273
+ <span class="note title constructor">constructor</span>
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+ <span class="summary_desc"><div class='inline'>
283
+ <p>Initialize a new instance of <span class='object_link'><a href="" title="Procreate::Swatches::Parser (class)">Parser</a></span>.</p>
284
+ </div></span>
285
+
286
+ </li>
287
+
288
+
289
+ </ul>
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ColorsHelper.html" title="Procreate::Swatches::ColorsHelper (module)">ColorsHelper</a></span></h3>
302
+ <p class="inherited"><span class='object_link'><a href="ColorsHelper.html#prepare_color_for_push-instance_method" title="Procreate::Swatches::ColorsHelper#prepare_color_for_push (method)">#prepare_color_for_push</a></span>, <span class='object_link'><a href="ColorsHelper.html#to_chroma_hsv-instance_method" title="Procreate::Swatches::ColorsHelper#to_chroma_hsv (method)">#to_chroma_hsv</a></span>, <span class='object_link'><a href="ColorsHelper.html#to_color_json-instance_method" title="Procreate::Swatches::ColorsHelper#to_color_json (method)">#to_color_json</a></span>, <span class='object_link'><a href="ColorsHelper.html#to_swatches_json-instance_method" title="Procreate::Swatches::ColorsHelper#to_swatches_json (method)">#to_swatches_json</a></span></p>
303
+
304
+ <div id="constructor_details" class="method_details_list">
305
+ <h2>Constructor Details</h2>
306
+
307
+ <div class="method_details first">
308
+ <h3 class="signature first" id="initialize-instance_method">
309
+
310
+ #<strong>initialize</strong>(file_path) &#x21d2; <tt><span class='object_link'><a href="" title="Procreate::Swatches::Parser (class)">Parser</a></span></tt>
311
+
312
+
313
+
314
+
315
+
316
+ </h3><div class="docstring">
317
+ <div class="discussion">
318
+
319
+ <p>Initialize a new instance of <span class='object_link'><a href="" title="Procreate::Swatches::Parser (class)">Procreate::Swatches::Parser</a></span></p>
320
+
321
+
322
+ </div>
323
+ </div>
324
+ <div class="tags">
325
+ <p class="tag_title">Parameters:</p>
326
+ <ul class="param">
327
+
328
+ <li>
329
+
330
+ <span class='name'>file_path</span>
331
+
332
+
333
+ <span class='type'>(<tt>String</tt>)</span>
334
+
335
+
336
+
337
+ &mdash;
338
+ <div class='inline'>
339
+ <p>The path of the <code>.swatches</code> file</p>
340
+ </div>
341
+
342
+ </li>
343
+
344
+ </ul>
345
+
346
+ <p class="tag_title">Raises:</p>
347
+ <ul class="raise">
348
+
349
+ <li>
350
+
351
+
352
+ <span class='type'>(<tt><span class='object_link'><a href="Errors/InvalidPath.html" title="Procreate::Swatches::Errors::InvalidPath (class)">Procreate::Swatches::Errors::InvalidPath</a></span></tt>)</span>
353
+
354
+
355
+
356
+ &mdash;
357
+ <div class='inline'>
358
+ <p>Error raised when the provided path is invalid</p>
359
+ </div>
360
+
361
+ </li>
362
+
363
+ <li>
364
+
365
+
366
+ <span class='type'>(<tt><span class='object_link'><a href="Errors/InvalidFormat.html" title="Procreate::Swatches::Errors::InvalidFormat (class)">Procreate::Swatches::Errors::InvalidFormat</a></span></tt>)</span>
367
+
368
+
369
+
370
+ &mdash;
371
+ <div class='inline'>
372
+ <p>Error raised when the provided path contains a file with an invalid format
373
+ (accepted format: <code>.swatches</code>)</p>
374
+ </div>
375
+
376
+ </li>
377
+
378
+ </ul>
379
+
380
+ </div><table class="source_code">
381
+ <tr>
382
+ <td>
383
+ <pre class="lines">
384
+
385
+
386
+ 35
387
+ 36
388
+ 37
389
+ 38
390
+ 39</pre>
391
+ </td>
392
+ <td>
393
+ <pre class="code"><span class="info file"># File 'lib/procreate/swatches/parser.rb', line 35</span>
394
+
395
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span>
396
+ <span class='ivar'>@file_path</span> <span class='op'>=</span> <span class='id identifier rubyid_file_path'>file_path</span>
397
+
398
+ <span class='id identifier rubyid_validate!'>validate!</span>
399
+ <span class='kw'>end</span></pre>
400
+ </td>
401
+ </tr>
402
+ </table>
403
+ </div>
404
+
405
+ </div>
406
+
407
+ <div id="instance_attr_details" class="attr_details">
408
+ <h2>Instance Attribute Details</h2>
409
+
410
+
411
+ <span id=""></span>
412
+ <div class="method_details first">
413
+ <h3 class="signature first" id="file_path-instance_method">
414
+
415
+ #<strong>file_path</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
416
+
417
+
418
+
419
+
420
+
421
+ </h3><div class="docstring">
422
+ <div class="discussion">
423
+
424
+ <p>Returns the value of attribute file_path</p>
425
+
426
+
427
+ </div>
428
+ </div>
429
+ <div class="tags">
430
+
431
+
432
+ </div><table class="source_code">
433
+ <tr>
434
+ <td>
435
+ <pre class="lines">
436
+
437
+
438
+ 25
439
+ 26
440
+ 27</pre>
441
+ </td>
442
+ <td>
443
+ <pre class="code"><span class="info file"># File 'lib/procreate/swatches/parser.rb', line 25</span>
444
+
445
+ <span class='kw'>def</span> <span class='id identifier rubyid_file_path'>file_path</span>
446
+ <span class='ivar'>@file_path</span>
447
+ <span class='kw'>end</span></pre>
448
+ </td>
449
+ </tr>
450
+ </table>
451
+ </div>
452
+
453
+
454
+ <span id=""></span>
455
+ <div class="method_details ">
456
+ <h3 class="signature " id="wrapper-instance_method">
457
+
458
+ #<strong>wrapper</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
459
+
460
+
461
+
462
+
463
+
464
+ </h3><div class="docstring">
465
+ <div class="discussion">
466
+
467
+ <p>Returns the value of attribute wrapper</p>
468
+
469
+
470
+ </div>
471
+ </div>
472
+ <div class="tags">
473
+
474
+
475
+ </div><table class="source_code">
476
+ <tr>
477
+ <td>
478
+ <pre class="lines">
479
+
480
+
481
+ 21
482
+ 22
483
+ 23</pre>
484
+ </td>
485
+ <td>
486
+ <pre class="code"><span class="info file"># File 'lib/procreate/swatches/parser.rb', line 21</span>
487
+
488
+ <span class='kw'>def</span> <span class='id identifier rubyid_wrapper'>wrapper</span>
489
+ <span class='ivar'>@wrapper</span>
490
+ <span class='kw'>end</span></pre>
491
+ </td>
492
+ </tr>
493
+ </table>
494
+ </div>
495
+
496
+ </div>
497
+
498
+
499
+ <div id="class_method_details" class="method_details_list">
500
+ <h2>Class Method Details</h2>
501
+
502
+
503
+ <div class="method_details first">
504
+ <h3 class="signature first" id="call-class_method">
505
+
506
+ .<strong>call</strong> &#x21d2; <tt>Object</tt>
507
+
508
+
509
+
510
+
511
+
512
+ </h3><div class="docstring">
513
+ <div class="discussion">
514
+
515
+ <p>Creates a new instance of <span class='object_link'><a href="" title="Procreate::Swatches::Parser (class)">Procreate::Swatches::Parser</a></span> and calls <span class='object_link'><a href="#call-instance_method" title="Procreate::Swatches::Parser#call (method)">#call</a></span>
516
+ Dynamically included by using
517
+ <a href="https://github.com/laurentzziu/callable_class" target="_parent" title="CallableClass">CallableClass</a> gem.</p>
518
+
519
+
520
+ </div>
521
+ </div>
522
+ <div class="tags">
523
+
524
+
525
+ </div><table class="source_code">
526
+ <tr>
527
+ <td>
528
+ <pre class="lines">
529
+
530
+
531
+ </pre>
532
+ </td>
533
+ <td>
534
+ <pre class="code"><span class="info file"># File 'lib/procreate/swatches/parser.rb', line 15</span>
535
+
536
+ </pre>
537
+ </td>
538
+ </tr>
539
+ </table>
540
+ </div>
541
+
542
+ </div>
543
+
544
+ <div id="instance_method_details" class="method_details_list">
545
+ <h2>Instance Method Details</h2>
546
+
547
+
548
+ <div class="method_details first">
549
+ <h3 class="signature first" id="call-instance_method">
550
+
551
+ #<strong>call</strong> &#x21d2; <tt><span class='object_link'><a href="Wrapper.html" title="Procreate::Swatches::Wrapper (class)">Procreate::Swatches::Wrapper</a></span></tt>
552
+
553
+
554
+
555
+
556
+
557
+ </h3><div class="docstring">
558
+ <div class="discussion">
559
+
560
+ <p>Process the provided <code>.swatches</code> file and wrap the content in a
561
+ <span class='object_link'><a href="Wrapper.html" title="Procreate::Swatches::Wrapper (class)">Wrapper</a></span></p>
562
+
563
+
564
+ </div>
565
+ </div>
566
+ <div class="tags">
567
+
568
+ <p class="tag_title">Returns:</p>
569
+ <ul class="return">
570
+
571
+ <li>
572
+
573
+
574
+ <span class='type'>(<tt><span class='object_link'><a href="Wrapper.html" title="Procreate::Swatches::Wrapper (class)">Procreate::Swatches::Wrapper</a></span></tt>)</span>
575
+
576
+
577
+
578
+ &mdash;
579
+ <div class='inline'>
580
+ <p>A wrapper instance for the <code>.swatches</code> file</p>
581
+ </div>
582
+
583
+ </li>
584
+
585
+ </ul>
586
+
587
+ </div><table class="source_code">
588
+ <tr>
589
+ <td>
590
+ <pre class="lines">
591
+
592
+
593
+ 47
594
+ 48
595
+ 49
596
+ 50</pre>
597
+ </td>
598
+ <td>
599
+ <pre class="code"><span class="info file"># File 'lib/procreate/swatches/parser.rb', line 47</span>
600
+
601
+ <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
602
+ <span class='id identifier rubyid_unzip'>unzip</span>
603
+ <span class='id identifier rubyid_wrap_colors'>wrap_colors</span>
604
+ <span class='kw'>end</span></pre>
605
+ </td>
606
+ </tr>
607
+ </table>
608
+ </div>
609
+
610
+ </div>
611
+
612
+ </div>
613
+
614
+ <div id="footer">
615
+ Generated on Sat Apr 27 09:32:32 2019 by
616
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
617
+ 0.9.16 (ruby-2.4.3).
618
+ </div>
619
+
620
+ </div>
621
+ </body>
622
+ </html>