RubyGems - procreate-swatches - Versions diffs - 0.1.0 - Mend

procreate-swatches 0.1.0

Files changed (51) hide show

checksums.yaml +7 -0
data/.codeclimate.yml +7 -0
data/.gitignore +16 -0
data/.rspec +2 -0
data/.rubocop.yml +8 -0
data/.ruby-version +1 -0
data/.travis.yml +19 -0
data/.yardopts +5 -0
data/CODE_OF_CONDUCT.md +74 -0
data/Gemfile +6 -0
data/Gemfile.lock +102 -0
data/LICENSE.txt +21 -0
data/README.md +230 -0
data/Rakefile +8 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/doc/Procreate/Swatches/ColorsHelper.html +693 -0
data/doc/Procreate/Swatches/Errors/InvalidFormat.html +220 -0
data/doc/Procreate/Swatches/Errors/InvalidPath.html +220 -0
data/doc/Procreate/Swatches/Errors.html +128 -0
data/doc/Procreate/Swatches/Exporter.html +754 -0
data/doc/Procreate/Swatches/Parser.html +622 -0
data/doc/Procreate/Swatches/Wrapper.html +1168 -0
data/doc/Procreate/Swatches.html +497 -0
data/doc/Procreate.html +128 -0
data/doc/_index.html +209 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +496 -0
data/doc/file.CODE_OF_CONDUCT.html +146 -0
data/doc/file.LICENSE.html +70 -0
data/doc/file.README.html +296 -0
data/doc/file_list.html +66 -0
data/doc/frames.html +17 -0
data/doc/index.html +296 -0
data/doc/js/app.js +292 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +275 -0
data/doc/top-level-namespace.html +110 -0
data/lib/procreate/swatches/colors_helper.rb +83 -0
data/lib/procreate/swatches/errors/invalid_format.rb +19 -0
data/lib/procreate/swatches/errors/invalid_path.rb +16 -0
data/lib/procreate/swatches/exporter.rb +131 -0
data/lib/procreate/swatches/parser.rb +82 -0
data/lib/procreate/swatches/version.rb +8 -0
data/lib/procreate/swatches/wrapper.rb +155 -0
data/lib/procreate/swatches.rb +60 -0
data/procreate-swatches.gemspec +41 -0
metadata +275 -0

data/doc/file.LICENSE.html ADDED Viewed

@@ -0,0 +1,70 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: LICENSE
+    &mdash; Documentation by YARD 0.9.16
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "LICENSE";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="file_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">File: LICENSE</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><div id='filecontents'>The MIT License (MIT)<br/><br/>Copyright (c) 2019 Florinel Gorgan<br/><br/>Permission is hereby granted, free of charge, to any person obtaining a copy<br/>of this software and associated documentation files (the &quot;Software&quot;), to deal<br/>in the Software without restriction, including without limitation the rights<br/>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br/>copies of the Software, and to permit persons to whom the Software is<br/>furnished to do so, subject to the following conditions:<br/><br/>The above copyright notice and this permission notice shall be included in<br/>all copies or substantial portions of the Software.<br/><br/>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br/>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br/>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br/>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br/>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br/>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br/>THE SOFTWARE.</div></div>
+      <div id="footer">
+  Generated on Sat Apr 27 09:32:32 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.4.3).
+</div>
+    </div>
+  </body>
+</html>

data/doc/file.README.html ADDED Viewed

@@ -0,0 +1,296 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: README
+    &mdash; Documentation by YARD 0.9.16
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "README";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="file_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">File: README</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><div id='filecontents'><h1 id="procreateswatches">Procreate::Swatches</h1>
+<p>A gem to interact with <a href="https://procreate.art">Procreate</a> <code>.swatches</code> files.</p>
+<p>This gem offers the possibility to:
+* parse an existing <code>.swatches</code> color palette to an object and extract the colors in various color formats
+* generate a Procreate color palette from an array of colors and export it to a <code>.swatches</code> file</p>
+<p>Behind the scenes, <code>Procreate::Swatches</code> uses the <a href="https://github.com/jfairbank/chroma">Chroma gem</a> to wrap colors and provide a better experience in interacting with colors. For more in depth use cases, consult the documentation for <code>Chroma::Color</code>, available <a href="https://www.rubydoc.info/gems/chroma/0.2.0/Chroma/Color">here</a>.</p>
+<h2 id="installation">Installation</h2>
+<p>Add this line to your application’s Gemfile:</p>
+<p><code>ruby
+gem 'procreate-swatches'
+</code></p>
+<p>And then execute:</p>
+<pre class="code ruby"><code class="ruby">$ bundle
+</code></pre>
+<p>Or install it yourself as:</p>
+<pre class="code ruby"><code class="ruby">$ gem install procreate-swatches
+</code></pre>
+<h2 id="usage">Usage</h2>
+<p>Before using the gem, you have to require the main file:
+<code>ruby
+require 'procreate/swatches'
+</code></p>
+<h3 id="parsing">Parsing</h3>
+<p>The gem allows you to parse an existing <code>.swatches</code> file to a <code>Procreate::Swatches::Wrapper</code> instance, which will allow you to further manipulate the colors.</p>
+<p><em>For full documentation, refer to <a href="https://www.rubydoc.info/gems/procreate-swatches/Procreate/Swatches/Parser">Procreate::Swatches::Parser documentation</a></em></p>
+<p><strong><em>Example 1</em></strong>
+<code>ruby
+file_path = '/file/path/to/palette.swatches'
+# Initialize a new instance of `Procreate::Swatches::Parser` with the file path to the `.swatches` file
+parser = Procreate::Swatches::Parser.new(file_path)
+# Use the method `#call` to parse the file; this will return an instance of `Procreate::Swatches::Wrapper`
+wrapper = parser.call
+</code></p>
+<p><strong><em>Example 2</em></strong></p>
+<p>For ease of use, a <code>.call</code> method is available:
+<code>ruby
+file_path = '/file/path/to/palette.swatches'
+wrapper = Procreate::Swatches::Parser.call(file_path)
+</code></p>
+<p><strong><em>Example 3</em></strong></p>
+<p>For convenience, a top-level method can be used to parse a <code>.swatches</code> file
+<code>ruby
+file_path = '/file/path/to/palette.swatches'
+wrapper = Procreate::Swatches.parse(file_path)
+# which is also aliased as `.from_file`
+wrapper = Procreate::Swatches.from_file(file_path)
+</code></p>
+<h3 id="interacting-with-a-wrapped-palette">Interacting with a wrapped palette</h3>
+<p><em>For full documentation, refer to <a href="https://www.rubydoc.info/gems/procreate-swatches/Procreate/Swatches/Wrapper">Procreate::Swatches::Wrapper documentation</a></em></p>
+<p>After successfully converting a <code>.swatches</code> file to a <code>Procreate::Swatches::Wrapper</code> instance, you can further interact with the palette in a Ruby way.</p>
+<p>Using the <code>Procreate::Swatches::Wrapper</code>, you can access the name and the colors array of the <code>.swatches</code> file.</p>
+<p>```ruby
+wrapper.name
+# =&gt; “Snowy Landscape”</p>
+<p>wrapper.colors
+# =&gt; [hsv(195, 16%, 81%), hsv(288, 6%, 68%), hsv(232, 19%, 67%)]
+```</p>
+<p>By default, each color availabe in the colors array is an instance of Chroma::Color
+By providing a format parameter to the <code>#colors</code> method, you can retrieve the colors in one of the availabe formats (supported by Chroma::Color)
+<code>ruby
+# converting to hex
+wrapper.colors(format: :hex)
+# =&gt; ["#aec6cf", "#aba3ad", "#8a8fab"]
+</code></p>
+<p>All the availabe formats for converting colors:
+```ruby
+wrapper.available_color_formats
+# =&gt; [:hsv, :hsl, :hex, :hex8, :rgb, :name]</p>
+<h1 id="the-list-is-also-available-using">the list is also available using</h1>
+<p>Procreate::Swatches::Wrapper::AVAILABLE_COLOR_FORMATS
+```</p>
+<p>To add a new color to the wrapper’s colors array, use the <code>push</code> or <code>&lt;&lt;</code> method
+<code>ruby
+wrapper.push("#aaa")
+# =&gt; [hsv(195, 16%, 81%), hsv(288, 6%, 68%), hsv(232, 19%, 67%), #aaa]
+wrapper &lt;&lt; "#bbb"
+# =&gt; [hsv(195, 16%, 81%), hsv(288, 6%, 68%), hsv(232, 19%, 67%), #aaa, #bbb]
+</code>
+This will add the color to the array (if valid) and return the colors array, including the newly-added color. Note that each color is an instance of <code>Chroma::Color</code></p>
+<p>For convenience, you can directly export a Procreate::Swatches::Wrapper instance to a <code>.swatches</code> file:
+```ruby
+wrapper.export
+# =&gt; “path/to/your/palette.swatches”</p>
+<h1 id="which-is-also-aliased-as">which is also aliased as</h1>
+<p>wrapper.to_file
+# =&gt; “path/to/your/palette-1.swatches”
+```</p>
+<h3 id="exporting">Exporting</h3>
+<p><em>For full documentation, refer to <a href="https://www.rubydoc.info/gems/procreate-swatches/Procreate/Swatches/Exporter">Procreate::Swatches::Exporter documentation</a></em></p>
+<p>You can easily export a <code>Procreate::Swatches::Wrapper</code> to a <code>.swatches</code> file.</p>
+<p><strong><em>Example 1</em></strong></p>
+<p>```ruby
+exporter = Procreate::Swatches::Exporter.new(wrapper, options)</p>
+<p>swatches_path = export.call
+# =&gt; “path/to/your/palette.swatches”
+```</p>
+<p>The <code>.swatches</code> path is also available afterwards, using the <code>swatches_path</code> attribute:
+<code>ruby
+exporter.swatches_path
+# =&gt; "path/to/your/palette.swatches"
+</code></p>
+<p><strong><em>Example 2</em></strong></p>
+<p>For ease of use, a <code>.call</code> method is available:
+<code>ruby
+swatches_path = Procreate::Swatches::Exporter.call(wrapper, options)
+</code></p>
+<p><strong><em>Example 3</em></strong></p>
+<p>For convenience, a top-level method can be used to export an array of colors to a <code>.swatches</code> file:
+```ruby
+name = ‘Snowy landscape’
+colors = [“#aaa”, “#bbb”, “#ccc”]</p>
+<p>swatches_path = Procreate::Swatches.export(name, colors)
+# =&gt; “path/to/your/snowy_landscape.swatches”</p>
+<h1 id="which-is-also-aliased-as-1">which is also aliased as</h1>
+<p>swatches_path = Procreate::Swatches.to_file(name, colors)
+# =&gt; “path/to/your/snowy_landscape-1.swatches”
+```</p>
+<h4 id="export-options">Export options</h4>
+<p>The <code>Procreate::Swatches::Exporter</code> class supports a number of options while exporting to a <code>.swatches</code> file.</p>
+<p>```ruby
+options = { export_directory: ‘/Users/username/Desktop’ }</p>
+<p>swatches_path = Procreate::Swatches.to_file(name, colors, options)
+# =&gt; “/Users/username/Desktop/snowy_landscape.swatches”
+```</p>
+<p>```ruby
+options = {
+  export_directory = ‘/Users/username/Desktop’,
+  file_name: ‘gorgeous_palette’
+}</p>
+<p>swatches_path = Procreate::Swatches.to_file(name, colors, options)
+# =&gt; “/Users/username/Desktop/gorgeous_palette.swatches”
+```</p>
+<p>The default values for these options are:
+```ruby
+# The result of calling <code>Dir.pwd</code>, which returns the current working directory
+export_directory = Dir.pwd</p>
+<h1 id="the-sanitized-string-of-the-procreateswatcheswrapper-name">The sanitized string of the <code>Procreate::Swatches::Wrapper</code> name</h1>
+<p>file_name = wrapper.name
+```</p>
+<p>These options are supported on every method that can export a <code>.swatches</code> file:</p>
+<p>```ruby
+Procreate::Swatches::Exporter.new(wrapper, options).call</p>
+<p>Procreate::Swatches::Exporter.call(wrapper, options)</p>
+<p>Procreate::Swatches.to_file(name, colors, options)</p>
+<p>Procreate::Swatches.export(name, colors, options)</p>
+<p>wrapper.export(options)</p>
+<p>wrapper.to_file(options)
+```</p>
+<h2 id="development">Development</h2>
+<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake spec</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
+<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
+<h2 id="contributing">Contributing</h2>
+<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/laurentzziu/procreate-swatches">https://github.com/laurentzziu/procreate-swatches</a>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="http://contributor-covenant.org">Contributor Covenant</a> code of conduct.</p>
+<h2 id="license">License</h2>
+<p>The gem is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
+<h2 id="code-of-conduct">Code of Conduct</h2>
+<p>Everyone interacting in the <code>Procreate::Swatches</code> project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the <a href="https://github.com/laurentzziu/procreate-swatches/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
+</div></div>
+      <div id="footer">
+  Generated on Sat Apr 27 09:32:32 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.4.3).
+</div>
+    </div>
+  </body>
+</html>

data/doc/file_list.html ADDED Viewed

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    <title>File List</title>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <div id="content">
+      <div class="fixed_header">
+        <h1 id="full_list_header">File List</h1>
+        <div id="full_list_nav">
+            <span><a target="_self" href="class_list.html">
+              Classes
+            </a></span>
+            <span><a target="_self" href="method_list.html">
+              Methods
+            </a></span>
+            <span><a target="_self" href="file_list.html">
+              Files
+            </a></span>
+        </div>
+        <div id="search">Search: <input type="text" /></div>
+      </div>
+      <ul id="full_list" class="file">
+  <li id="object_README" class="odd">
+    <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
+  </li>
+  <li id="object_LICENSE" class="even">
+    <div class="item"><span class="object_link"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></span></div>
+  </li>
+  <li id="object_CODE_OF_CONDUCT" class="odd">
+    <div class="item"><span class="object_link"><a href="file.CODE_OF_CONDUCT.html" title="CODE_OF_CONDUCT">CODE_OF_CONDUCT</a></span></div>
+  </li>
+      </ul>
+    </div>
+  </body>
+</html>

data/doc/frames.html ADDED Viewed

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+	<title>Documentation by YARD 0.9.16</title>
+</head>
+<script type="text/javascript" charset="utf-8">
+  var match = unescape(window.location.hash).match(/^#!(.+)/);
+  var name = match ? match[1] : 'index.html';
+  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
+  window.top.location = name;
+</script>
+<noscript>
+  <h1>Oops!</h1>
+  <h2>YARD requires JavaScript!</h2>
+</noscript>
+</html>