procreate-swatches 0.1.0

data/lib/procreate/swatches/parser.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'zip'
+
+module Procreate
+  module Swatches
+    #
+    # The class that handles the parsing of a +.swatches+ file to
+    # an instance of {Procreate::Swatches::Wrapper}.
+    #
+    class Parser
+      include CallableClass
+      include ColorsHelper
+
+      # @!method self.call
+      #   Creates a new instance of {Procreate::Swatches::Parser} and calls {#call}
+      #   Dynamically included by using {https://github.com/laurentzziu/callable_class CallableClass} gem.
+
+      # @!attribute [r] wrapper
+      #   @return [Procreate::Swatches::Wrapper]
+      attr_reader :wrapper
+
+      # @!attribute [r] file_path
+      #   @return [String] The path of the +.swatches+ file
+      attr_reader :file_path
+
+      #
+      # Initialize a new instance of {Procreate::Swatches::Parser}
+      #
+      # @param [String] file_path The path of the +.swatches+ file
+      #
+      # @raise [Procreate::Swatches::Errors::InvalidPath] Error raised when the provided path is invalid
+      # @raise [Procreate::Swatches::Errors::InvalidFormat] Error raised when the provided path contains a file with an invalid format (accepted format: +.swatches+)
+      #
+      def initialize(file_path)
+        @file_path = file_path
+
+        validate!
+      end
+
+      #
+      # Process the provided +.swatches+ file and wrap the content in
+      # a {Procreate::Swatches::Wrapper}
+      #
+      # @return [Procreate::Swatches::Wrapper] A wrapper instance for the +.swatches+ file
+      #
+      def call
+        unzip
+        wrap_colors
+      end
+
+      private
+
+      def unzip
+        zip_file = Zip::File.open(@file_path)
+        entry = zip_file.glob(SWATCHES_FILE_NAME).first
+        raw_content = entry.get_input_stream.read
+        @content = JSON.parse(raw_content).first
+      end
+
+      def wrap_colors
+        name = @content['name']
+        colors = @content['swatches']
+
+        colors = colors.compact.map do |color|
+          string = to_chroma_hsv(color)
+          Chroma::Color.new(string)
+        end
+
+        @wrapper = Wrapper.new(name, colors)
+      end
+
+      SWATCHES_FILE_REGEXP = /\.swatches\z/.freeze
+
+      def validate!
+        raise(Errors::InvalidPath) unless file_path.present? && File.exist?(file_path) && File.file?(file_path)
+
+        raise(Errors::InvalidFormat) unless file_path.match(SWATCHES_FILE_REGEXP).present?
+      end
+    end
+  end
+end

data/lib/procreate/swatches/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Procreate
+  module Swatches
+    # Current gem version
+    VERSION = '0.1.0'
+  end
+end

data/lib/procreate/swatches/wrapper.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Procreate
+  module Swatches
+    #
+    # Wrapper class for the name and colors of a +.swatches+ file.
+    #
+    class Wrapper
+      include ColorsHelper
+
+      # @!attribute name
+      #   @return [String] Name of the swatches palette
+      attr_accessor :name
+      # @!attribute [w] colors
+      #   @return [Array<Chroma::Color, String>] Colors array
+      attr_writer :colors
+
+      # The default name, used in case a custom name is not provided
+      DEFAULT_SWATCHES_NAME = 'My beautiful palette'
+
+      #
+      # Initialize a new instance of {Procreate::Swatches::Wrapper}
+      #
+      # @param [String] name Name of the swatches palette
+      # @param [Array<Chroma::Color, String>] colors Colors array. Each color will be converted to a {https://github.com/jfairbank/chroma Chroma::Color} instance.
+      #
+      def initialize(name, colors)
+        @name = name.present? ? name : DEFAULT_SWATCHES_NAME
+
+        @colors ||= []
+        Array(colors).each { |color| add_color(color) }
+      end
+
+      #
+      # Add a new color to the colors array.
+      # It will be converted to a {https://github.com/jfairbank/chroma Chroma::Color} instance.
+      #
+      # @param [Chroma::Color, String] color Color in a supported format.
+      #
+      # @return [Array<Chroma::Color>] The current colors available in the wrapper.
+      #
+      def <<(color)
+        add_color(color)
+      end
+
+      alias push <<
+
+      #
+      # Remove the last color from the colors array.
+      #
+      # @return [Array<Chroma::Color>] The current colors available in the wrapper.
+      #
+      def pop
+        @colors.pop
+      end
+
+      # Available formats to return the colors as. These types are supported by {https://github.com/jfairbank/chroma Chroma::Color}
+      AVAILABLE_COLOR_FORMATS = %i[hsv hsl hex hex8 rgb name].freeze
+
+      #
+      # Returns the list of available color formats a color
+      # can be retrieved into.
+      #
+      # @return [Array<Symbol>] The list of available formats a color can be retrived into.
+      #
+      def available_color_formats
+        AVAILABLE_COLOR_FORMATS
+      end
+
+      #
+      # Attribute reader for colors.
+      # It supports returning the colors in different formats.
+      # If not format is provided, an array of {https://github.com/jfairbank/chroma Chroma::Color}s is returned.
+      # If an invalid format is provided, it will fallback to the default format.
+      #
+      # @param [String, Symbol] format Format to return the colors array in.
+      #
+      # @return [Array<Chroma::Color>] Return an array of {https://github.com/jfairbank/chroma Chroma::Color} when no format is provided. This is the default option.
+      # @return [Array<String>] Return an array of +Strings+, in the specified format.
+      #
+      def colors(format: nil)
+        format = format.to_sym unless format.nil?
+        format = nil unless format.in?(AVAILABLE_COLOR_FORMATS)
+
+        return @colors if format.nil?
+
+        @colors.map do |color|
+          color.send("to_#{format}")
+        end
+      end
+
+      #
+      # Convert the wrapper to the JSON format needed to create a
+      # +.swatches+ file.
+      # A maximum of 30 ({Procreate::Swatches::ColorsHelper::SWATCHES_MAX_SIZE}) colors is returned.
+      # This is a limitation of Procreate.
+      #
+      # @return [String] Wrapper content, in JSON format.
+      #
+      def to_json(*_args)
+        [
+          {
+            name: @name,
+            swatches: colors_to_json
+          }
+        ].to_json
+      end
+
+      alias to_swatches to_json
+      alias to_procreate to_json
+
+      #
+      # Export the wrapper to a +.swatches+ file
+      #
+      # @param [<Type>] options All options suported by {Procreate::Swatches::Exporter#initialize}
+      #
+      # @return [String] swatches_path Path of the exported +.swatches+ file
+      #
+      def to_file(options = {})
+        Exporter.call(self, options)
+      end
+
+      alias export to_file
+
+      # @todo Check if the colors array is the same (regardless of order)
+      #
+      # Wrapper file comparison.
+      # It check for the same class, name and colors array
+      #
+      # @param [Procreate::Swatches::Wrapper] other Another wrapper instance
+      #
+      # @return [Boolean] The wrappers are equal
+      #
+      def ==(other)
+        other.is_a?(self.class) && name == other.name && colors == other.colors
+      end
+
+      private
+
+      def add_color(color)
+        color = prepare_color_for_push(color)
+
+        @colors << color unless color.nil?
+
+        @colors
+      end
+
+      def colors_to_json
+        @colors.first(SWATCHES_MAX_SIZE).map do |color|
+          to_swatches_json(color)
+        end
+      end
+    end
+  end
+end

data/lib/procreate/swatches.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'chroma'
+require 'callable_class'
+require 'json'
+require 'active_support/all'
+
+require 'procreate/swatches/version'
+
+require 'procreate/swatches/errors/invalid_format'
+require 'procreate/swatches/errors/invalid_path'
+
+require 'procreate/swatches/colors_helper'
+require 'procreate/swatches/wrapper'
+require 'procreate/swatches/parser'
+require 'procreate/swatches/exporter'
+
+# All things {https://procreate.art Procreate} tools.
+module Procreate
+  #
+  # Interact with +.swatches+ files ({https://procreate.art Procreate}) and manipulate them.
+  #
+  module Swatches
+    # Internal name of the +.swatches+ file.
+    # Used for both parsing and exporting +.swatches+ files.
+    SWATCHES_FILE_NAME = 'Swatches.json'
+    class << self
+      #
+      # Parse a +.swatches+ file from the provided file path
+      #
+      # @param [String] file_path A file path to the +.swatches+ file
+      #
+      # @return [Procreate::Swatches::Wrapper] wrapper A wrapper instance to be further manipulated
+      #
+      def parse(file_path)
+        Parser.call(file_path)
+      end
+
+      #
+      # Export an array of colors to a +.swatches+ file, with the possibility to provide a custom palette name.
+      #
+      # @param [String] name Preferred name for the exported +.swatches+ file palette. Visible instance the Procreate app.
+      # @param [Array<String, Chroma::Color>] colors An array of valid color strings or {https://github.com/jfairbank/chroma Chroma::Color} instances
+      # @param [Hash] options Options for exporting the wrapper
+      # @option options [String] :export_directory ('Dir.pwd') The export directory for the +.swatches+ file
+      # @option options [String] :file_name ('Wrapper#name') Custom file name for the exported +.swatches+ file. If none is provided, the +name+ of the +wrapper+ instance is used
+      #
+      # @return [String] swatches_path Path of the exported +.swatches+ file
+      #
+      def export(name, colors, options = {})
+        wrapper = Wrapper.new(name, colors)
+
+        Exporter.call(wrapper, options)
+      end
+
+      alias from_file parse
+      alias to_file export
+    end
+  end
+end

data/procreate-swatches.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'procreate/swatches/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'procreate-swatches'
+  spec.version       = Procreate::Swatches::VERSION
+  spec.authors       = ['Florinel Gorgan']
+  spec.email         = ['florin@floringorgan.com']
+
+  spec.summary       = 'A gem to interact with Procreate .swatches files.'
+  spec.description   = 'A gem to interact with Procreate .swatches files.'
+  spec.homepage      = 'https://github.com/laurentzziu/procreate-swatches'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'callable_class', '~> 0.1.1'
+  spec.add_dependency 'chroma'
+  spec.add_dependency 'rubyzip', '>= 1.0.0'
+
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-console'
+end

metadata

@@ -0,0 +1,275 @@
+--- !ruby/object:Gem::Specification
+name: procreate-swatches
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florinel Gorgan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: callable_class
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: chroma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to interact with Procreate .swatches files.
+email:
+- florin@floringorgan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doc/Procreate.html
+- doc/Procreate/Swatches.html
+- doc/Procreate/Swatches/ColorsHelper.html
+- doc/Procreate/Swatches/Errors.html
+- doc/Procreate/Swatches/Errors/InvalidFormat.html
+- doc/Procreate/Swatches/Errors/InvalidPath.html
+- doc/Procreate/Swatches/Exporter.html
+- doc/Procreate/Swatches/Parser.html
+- doc/Procreate/Swatches/Wrapper.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.CODE_OF_CONDUCT.html
+- doc/file.LICENSE.html
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/procreate/swatches.rb
+- lib/procreate/swatches/colors_helper.rb
+- lib/procreate/swatches/errors/invalid_format.rb
+- lib/procreate/swatches/errors/invalid_path.rb
+- lib/procreate/swatches/exporter.rb
+- lib/procreate/swatches/parser.rb
+- lib/procreate/swatches/version.rb
+- lib/procreate/swatches/wrapper.rb
+- procreate-swatches.gemspec
+homepage: https://github.com/laurentzziu/procreate-swatches
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A gem to interact with Procreate .swatches files.
+test_files: []