procreate-swatches 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec13bab1fc2489c184a2fbed315b935fb473142c
+  data.tar.gz: 1e4e30688706459e898957b487f238b5703fb778
+SHA512:
+  metadata.gz: 3189244ac5bb28fc3eeca118540133fb637bb5030f6fccddb260141fb603b68bedcd38be4e33c942adbc6b9ae8919397fa22ba7caef53352a7f6843dd24ae9b4
+  data.tar.gz: 7b3827654b0414752a0003f05186604eec9148fb416ff3d666096f6223fd00fa00d3386af8778f9e4ed0dc454743aade870cea41ab7bacbf98ec27948c5a6897

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+plugins:
+  rubymotion:
+    enabled: true
+  rubocop:
+    enabled: true
+    config:
+      file: .rubocop.yml

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.ruby-gemset
+
+.rubocop-https*
+
+.vscode

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+require: rubocop-performance
+inherit_from: https://raw.githubusercontent.com/laurentzziu/utils/master/gems/.rubocop.yml
+RSpec/InstanceVariable:
+  Enabled: false
+RSpec/BeforeAfterAll:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.3

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=5648e754d49f6154023cde47863ff91f98019493f6fd2b9be28619479a1bd248
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+notifications:
+  slack:
+    secure: IhsciBpwwC/HFIIfqM2D9vJDgoG45qz3cx4Tw8j5EUOvs55oboFNU0FN/4IPEqDPlEFx9C4p3FsF+/ajYZ3Cr/304rNMJx8eKX2Sx5iudJw2Psikslk8Ix+mmnCfGuhb1eqxa1wC7fA2UMifanCxX7nxdLKfu2EV23mJrBhhNtzrcB+CenKjLtzPfxhIWmp2nE7y+dh42fVnuiudc+ZT0638EajL03z0z2udipXzhIBk74lK043S5KATs2wGmxDXr4GxjyDfA8n4HBin4RRViNpOJGOnAbAqpSwkscm08eaKGRcFF+hSZIRUn7Qd6IXTm2qCZmVi09Z9/frtRI8rQfP5n/XCFSvEzDYMHebfJQbXrQ5e6eqcsmhHxT+TKiTfzQJ2WZsFUFqIXaBWwF2JCEatH12v2K688g5BBRs0trpk84mGD5lQFfA30hnQ9o15azIKPCk63E/9LOn1EiqTX1TH8MrV8tbktuZoagBJ9P1KXrkK/OQF0hRWx2RBEoDNZQhyYuQoy5x9P7jpQuCiP48i6liKJPLn683wNtzdoF2M2k1HCbH5/4lEl/+ZKBnIlCCkfhvjoEuXnyppdCYoIlqTSdDQLF0zP6yaRcy80mCqkhx9Y0ciGPbmjS2H+MwcYDgbVOPxNMCUg1hq3v+oUMEyXkx0BITsr2WSRddfN2U=

data/.yardopts

@@ -0,0 +1,5 @@
+--protected
+--no-private
+-
+LICENSE.txt
+CODE_OF_CONDUCT.md

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at florin@floringorgan.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+ruby '2.4.3'
+
+# Specify your gem's dependencies in procreate-swatches.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    procreate-swatches (0.1.0)
+      callable_class (~> 0.1.1)
+      chroma
+      rubyzip (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ansi (1.5.0)
+    ast (2.4.0)
+    callable_class (0.1.1)
+    chroma (0.2.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    hirb (0.7.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    rubyzip (1.2.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 2.0)
+  procreate-swatches!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  simplecov
+  simplecov-console
+
+RUBY VERSION
+   ruby 2.4.3p205
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Florinel Gorgan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,230 @@
+# Procreate::Swatches
+
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/gems/procreate-swatches/)
+[![Build Status](https://travis-ci.org/laurentzziu/procreate-swatches.svg?branch=master)](https://travis-ci.org/laurentzziu/procreate-swatches)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b82e0b6e6aade556abe0/maintainability)](https://codeclimate.com/github/laurentzziu/procreate-swatches/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b82e0b6e6aade556abe0/test_coverage)](https://codeclimate.com/github/laurentzziu/procreate-swatches/test_coverage)
+
+A gem to interact with [Procreate](https://procreate.art) `.swatches` files.
+
+This gem offers the possibility to:
+* parse an existing `.swatches` 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 `.swatches` file
+
+Behind the scenes, `Procreate::Swatches` uses the [Chroma gem](https://github.com/jfairbank/chroma) to wrap colors and provide a better experience in interacting with colors. For more in depth use cases, consult the documentation for `Chroma::Color`, available [here](https://www.rubydoc.info/gems/chroma/0.2.0/Chroma/Color).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'procreate-swatches'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install procreate-swatches
+
+## Usage
+
+Before using the gem, you have to require the main file:
+```ruby
+require 'procreate/swatches'
+```
+
+### Parsing
+
+The gem allows you to parse an existing `.swatches` file to a `Procreate::Swatches::Wrapper` instance, which will allow you to further manipulate the colors.
+
+_For full documentation, refer to [Procreate::Swatches::Parser documentation](https://www.rubydoc.info/gems/procreate-swatches/Procreate/Swatches/Parser)_
+
+__*Example 1*__
+```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
+```
+
+__*Example 2*__
+
+For ease of use, a `.call` method is available:
+```ruby
+file_path = '/file/path/to/palette.swatches'
+wrapper = Procreate::Swatches::Parser.call(file_path)
+```
+
+__*Example 3*__
+
+For convenience, a top-level method can be used to parse a `.swatches` file
+```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)
+```
+
+### Interacting with a wrapped palette
+
+_For full documentation, refer to [Procreate::Swatches::Wrapper documentation](https://www.rubydoc.info/gems/procreate-swatches/Procreate/Swatches/Wrapper)_
+
+After successfully converting a `.swatches` file to a `Procreate::Swatches::Wrapper` instance, you can further interact with the palette in a Ruby way.
+
+Using the `Procreate::Swatches::Wrapper`, you can access the name and the colors array of the `.swatches` file.
+
+```ruby
+wrapper.name
+# => "Snowy Landscape"
+
+wrapper.colors
+# => [hsv(195, 16%, 81%), hsv(288, 6%, 68%), hsv(232, 19%, 67%)]
+```
+
+By default, each color availabe in the colors array is an instance of Chroma::Color
+By providing a format parameter to the `#colors` method, you can retrieve the colors in one of the availabe formats (supported by Chroma::Color)
+```ruby
+# converting to hex
+wrapper.colors(format: :hex)
+# => ["#aec6cf", "#aba3ad", "#8a8fab"]
+```
+
+All the availabe formats for converting colors:
+```ruby
+wrapper.available_color_formats
+# => [:hsv, :hsl, :hex, :hex8, :rgb, :name]
+
+# the list is also available using
+Procreate::Swatches::Wrapper::AVAILABLE_COLOR_FORMATS
+```
+
+To add a new color to the wrapper's colors array, use the `push` or `<<` method
+```ruby
+wrapper.push("#aaa")
+# => [hsv(195, 16%, 81%), hsv(288, 6%, 68%), hsv(232, 19%, 67%), #aaa]
+wrapper << "#bbb"
+# => [hsv(195, 16%, 81%), hsv(288, 6%, 68%), hsv(232, 19%, 67%), #aaa, #bbb]
+```
+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 `Chroma::Color`
+
+For convenience, you can directly export a Procreate::Swatches::Wrapper instance to a `.swatches` file:
+```ruby
+wrapper.export
+# => "path/to/your/palette.swatches"
+
+# which is also aliased as
+wrapper.to_file
+# => "path/to/your/palette-1.swatches"
+```
+
+### Exporting
+
+_For full documentation, refer to [Procreate::Swatches::Exporter documentation](https://www.rubydoc.info/gems/procreate-swatches/Procreate/Swatches/Exporter)_
+
+You can easily export a `Procreate::Swatches::Wrapper` to a `.swatches` file.
+
+__*Example 1*__
+
+```ruby
+exporter = Procreate::Swatches::Exporter.new(wrapper, options)
+
+swatches_path = export.call
+# => "path/to/your/palette.swatches"
+```
+
+The `.swatches` path is also available afterwards, using the `swatches_path` attribute:
+```ruby
+exporter.swatches_path
+# => "path/to/your/palette.swatches"
+```
+
+__*Example 2*__
+
+For ease of use, a `.call` method is available:
+```ruby
+swatches_path = Procreate::Swatches::Exporter.call(wrapper, options)
+```
+
+__*Example 3*__
+
+For convenience, a top-level method can be used to export an array of colors to a `.swatches` file:
+```ruby
+name = 'Snowy landscape'
+colors = ["#aaa", "#bbb", "#ccc"]
+
+swatches_path = Procreate::Swatches.export(name, colors)
+# => "path/to/your/snowy_landscape.swatches"
+
+
+# which is also aliased as
+swatches_path = Procreate::Swatches.to_file(name, colors)
+# => "path/to/your/snowy_landscape-1.swatches"
+```
+
+#### Export options
+
+The `Procreate::Swatches::Exporter` class supports a number of options while exporting to a `.swatches` file.
+
+```ruby
+options = { export_directory: '/Users/username/Desktop' }
+
+swatches_path = Procreate::Swatches.to_file(name, colors, options)
+# => "/Users/username/Desktop/snowy_landscape.swatches"
+```
+
+```ruby
+options = {
+  export_directory = '/Users/username/Desktop',
+  file_name: 'gorgeous_palette'
+}
+
+swatches_path = Procreate::Swatches.to_file(name, colors, options)
+# => "/Users/username/Desktop/gorgeous_palette.swatches"
+```
+
+The default values for these options are:
+```ruby
+# The result of calling `Dir.pwd`, which returns the current working directory
+export_directory = Dir.pwd
+
+# The sanitized string of the `Procreate::Swatches::Wrapper` name
+file_name = wrapper.name
+```
+
+These options are supported on every method that can export a `.swatches` file:
+
+```ruby
+Procreate::Swatches::Exporter.new(wrapper, options).call
+
+Procreate::Swatches::Exporter.call(wrapper, options)
+
+Procreate::Swatches.to_file(name, colors, options)
+
+Procreate::Swatches.export(name, colors, options)
+
+wrapper.export(options)
+
+wrapper.to_file(options)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/laurentzziu/procreate-swatches>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `Procreate::Swatches` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/laurentzziu/procreate-swatches/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'procreate/swatches'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here