camalian 0.0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6d9583383ecf60a0cd259bcce471abe319f2b4390b52c53d63a2504f3dd020f
+  data.tar.gz: 6e5cb3a2c174539b91bae01fafad0e9ef658756bebc7809837cc0edb019cfacd
+SHA512:
+  metadata.gz: c79fb3ea3e499fee16fa36f8e10c640a54a1ddc3d0121a99d5053b7c28a60cfbe903f2600c59ec61997a42942f40b16298714904dfbbdb170dbbfa0adf23540b
+  data.tar.gz: 4d7a82621d0429c005f4d3743724bc2de51c7f57110416d50a1397de8d6a473e73ec25416f53533b12c500670709412cee6fd73b529fc68dfc044e5112f54578

data/.github/workflows/gpr-push.yml

@@ -0,0 +1,30 @@
+name: Github Packages Push
+
+on:
+  workflow_dispatch:
+  push:
+    tags: 
+      - '*'
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-16.04
+    strategy:
+      matrix:
+        ruby: [ '2.4', '2.5', '2.6', '2.7' ]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake
+

data/.github/workflows/rubygems-push.yml

@@ -0,0 +1,29 @@
+name: Ruby Gems Push
+
+on:
+  workflow_dispatch:
+  push:
+    tags: 
+      - '*'
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.idea/
+.idea/
+coverage/

data/.overcommit.yml

@@ -0,0 +1,33 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rubocop.yml

@@ -0,0 +1,37 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  NewCops: enable
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - r
+    - g
+    - b
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/PerceivedComplexity:
+  Max: 25
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*
+
+Metrics/AbcSize:
+  Max: 30
+  IgnoredMethods:
+    - build_components

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.3

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
+
+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 rake test
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,4 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in camalian.gemspec
 gemspec
+
+gem 'overcommit', require: false
+gem 'rubocop', '~> 1.3', require: false
+gem 'rubocop-daemon', require: false
+gem 'simplecov', require: false

data/README.md

@@ -1,12 +1,16 @@
 # Camalian
 
-TODO: Write a gem description
+[![Gem Version](https://badge.fury.io/rb/camalian.svg)](https://badge.fury.io/rb/camalian)
+![Ruby](https://github.com/nazarhussain/camalian/workflows/build/badge.svg?branch=master) 
+[![Maintainability](https://api.codeclimate.com/v1/badges/5495a2c122469d81b6c5/maintainability)](https://codeclimate.com/github/nazarhussain/camalian/maintainability)
+
+Ruby gem to extract color palettes from images and play with their saturation
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'camalian'
+    gem 'camalian', '~> 0.2.0'
 
 And then execute:
 
@@ -18,7 +22,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+image = Camalian::load('file_path')
+colors = image.prominent_colors(15)
+colors = colors.sort_similar_colors
+colors.light_colors(0, 40)
+```
+
+You can find a working example with detail explanation and reference code here on [this link](https://basicdrift.com/color-extraction-library-build-color-search-engine-fdf369678d5a). Here we will build a functional color based image search engine in Ruby on Rails.
+
+NOTE: Since its a compute intensive operation so for production use its suggested to use under a background job and not within a request/response cycle.
+
+## Quantization Algorithms
+
+Currently following algorithms are implemented.
+
+### Histogram
+
+Its a most common algorithm for color quantization and used different bucket technique to group the colors together. You can read more about this [technique here](https://en.wikipedia.org/wiki/Color_histogram). It can be accessed by `Camalian::QUANTIZATION_HISTOGRAM` constant. This is used as default method as well.
+
+### K Means
+
+This algorithm uses color distancing in RGB space to group the similar colors. You can learn more about this [technique here](https://en.wikipedia.org/wiki/K-means_clustering). It can be accessed by `Camalian::QUANTIZATION_K_MEANS` constant.  
+
+### Median Cut
+
+This algorithm uses color highest color range to determine the median and split colors to groups. The output consists of average color of such color groups.  Since these algorithm don't use actual colors and instead average, so you will may not exact matching pixel in the image. This algorithm is nice to be used with image compression, where similarity and compression is important than having same pixel colors. You can learn more about this [technique here](https://tpgit.github.io/UnOfficialLeptDocs/leptonica/color-quantization.html) . It can be accessed by `Camalian::QUANTIZATION_MEDIAN_CUT` constant.  
+
+
+You can set default quantization method globally as: 
+
+```ruby
+Camalian.options[:quantization] = Camalian::QUANTIZATION_K_MEANS
+```
+
+or you can set at the time of extracting colors by.
+
+```ruby
+image = Camalian::load('file_path')
+colors = image.prominent_colors(15, quantization: Camalian::QUANTIZATION_K_MEANS)
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,13 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc 'Run tests'
+task default: :test

data/camalian.gemspec

@@ -1,21 +1,28 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'camalian/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "camalian"
+  spec.name          = 'camalian'
   spec.version       = Camalian::VERSION
-  spec.authors       = ["Nazar Hussain"]
-  spec.email         = ["nazarhussain@gmail.com"]
-  spec.description   = %q{Library used to deal with colors and images}
-  spec.summary       = %q{Library used to deal with colors and images. You can extract colors from images.}
-  spec.homepage      = "http://www.nazarhussain.com"
-  spec.license       = "MIT"
+  spec.authors       = ['Nazar Hussain']
+  spec.email         = ['nazarhussain@gmail.com']
+  spec.description   = 'Library used to deal with colors and images'
+  spec.summary       = 'Library used to deal with colors and images. You can extract colors from images.'
+  spec.homepage      = 'https://github.com/nazarhussain/camalian'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'chunky_png', '~> 1.3', '>= 1.3.14'
+
+  spec.add_development_dependency 'minitest', '~> 5.14', '>= 5.14.2'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
 
+  spec.required_ruby_version = '>= 2.4'
 end

data/lib/camalian.rb

@@ -1,5 +1,32 @@
-require "camalian/version"
+# frozen_string_literal: true
 
-module Camalian
-  # Your code goes here...
+require 'chunky_png'
+require 'tempfile'
+require 'open-uri'
+
+require 'camalian/version'
+require 'camalian/color'
+require 'camalian/palette'
+require 'camalian/image'
+require 'camalian/quantization/histogram'
+require 'camalian/quantization/k_means'
+require 'camalian/quantization/median_cut'
+
+module Camalian # :nodoc:
+  QUANTIZATION_HISTOGRAM = Camalian::Quantization::Histogram
+  QUANTIZATION_K_MEANS = Camalian::Quantization::KMeans
+  QUANTIZATION_MEDIAN_CUT = Camalian::Quantization::MedianCut
+
+  class << self
+    def options
+      @options ||= {
+        color_count: 8,
+        quantization: Camalian::QUANTIZATION_HISTOGRAM
+      }
+    end
+
+    def load(image_path)
+      Image.new(image_path)
+    end
+  end
 end

data/lib/camalian/color.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Camalian
+  # Camalian color object
+  class Color
+    attr_reader :r, :g, :b, :h, :s, :l, :hsv
+
+    def initialize(r, g, b)
+      build_components(r, g, b)
+    end
+
+    def self.from_hex(hex_value)
+      color_hash = hex_value[0..6]
+      color_hash = color_hash[1..6] if color_hash[0] == '#'
+      r = color_hash[0..1].to_i(16)
+      g = color_hash[2..3].to_i(16)
+      b = color_hash[4..5].to_i(16)
+
+      Color.new(r, g, b)
+    end
+
+    def to_s
+      "red=#{r} green=#{g} blue=#{b} hue=#{h} saturation=#{s} lightness=#{l}"
+    end
+
+    def to_hex
+      "##{r.to_s(16).rjust(2, '0')}#{g.to_s(16).rjust(2, '0')}#{b.to_s(16).rjust(2, '0')}"
+    end
+
+    # Used for array uniqueness
+    def hash
+      "#{r}#{g}#{b}".to_i
+    end
+
+    # Used for object comparison
+    def ==(other)
+      r == other.r && g == other.g && b == other.b
+    end
+    alias eql? ==
+
+    def hue_distance(color)
+      [(h - color.h) % 360, (color.h - h) % 360].min
+    end
+
+    def rgb_distance(color)
+      Math.sqrt(((r - color.r)**2) + ((g - color.g)**2) + ((b - color.b)**2))
+    end
+
+    private
+
+    def build_components(r, g, b)
+      @r = r
+      @g = g
+      @b = b
+
+      ri = @r / 255.0
+      gi = @g / 255.0
+      bi = @b / 255.0
+
+      cmax = [ri, gi, bi].max
+      cmin = [ri, gi, bi].min
+      delta = cmax - cmin
+
+      @l = (cmax + cmin) / 2.0
+
+      if delta.zero?
+        @h = 0
+      elsif cmax == ri
+        @h = 60 * (((gi - bi) / delta) % 6)
+      elsif cmax == gi
+        @h = 60 * (((bi - ri) / delta) + 2)
+      elsif cmax == bi
+        @h = 60 * (((ri - gi) / delta) + 4)
+      end
+
+      @s = if delta.zero?
+             0
+           else
+             delta / (1 - (2 * @l - 1).abs)
+           end
+
+      @h = @h.round(2)
+      @s = (@s * 100).round(2)
+      @l = (@l * 100).round(2)
+
+      # HSV Calculation
+      # Hue calculation
+      if delta.zero?
+        @hsv = [0]
+      elsif cmax == ri
+        @hsv = [60 * (((gi - bi) / delta) % 6)]
+      elsif cmax == gi
+        @hsv = [60 * (((bi - ri) / delta) + 2)]
+      elsif cmax == bi
+        @hsv = [60 * (((ri - gi) / delta) + 4)]
+      end
+
+      # Saturation calculation
+      @hsv << if cmax.zero?
+                0
+              else
+                delta / cmax
+              end
+
+      # Value calculation
+      @hsv << cmax
+
+      @hsv = [@hsv[0].round(2), (@hsv[1] * 100).round(2), (@hsv[2] * 100).round(2)]
+    end
+  end
+end

data/lib/camalian/image.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Camalian
+  # Load image into Camalian
+  class Image
+    attr_accessor :src_file_path
+
+    def initialize(file_path)
+      @src_file_path = file_path
+    end
+
+    def prominent_colors(count = Camalian.options[:color_count],
+                         quantization: Camalian.options[:quantization],
+                         optimal: true)
+      image = ::ChunkyPNG::Image.from_file(@src_file_path)
+
+      colors = image.pixels.map do |val|
+        Color.new(
+          ChunkyPNG::Color.r(val),
+          ChunkyPNG::Color.g(val),
+          ChunkyPNG::Color.b(val)
+        )
+      end
+
+      quantize = quantization.new
+
+      palette = quantize.process(colors, count)
+
+      retry_count = 1
+      while !optimal && palette.size < count
+        palette = quantize.process(colors, count + retry_count)
+        retry_count += 1
+      end
+
+      palette
+    end
+  end
+end

data/lib/camalian/palette.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Camalian
+  # Collection of colors with some useful features
+  class Palette < Array
+    def self.from_hex(hex_values)
+      new(hex_values.map { |v| Color.from_hex(v) })
+    end
+
+    def sort_by_lightness
+      Palette.new(sort_by(&:l).reverse)
+    end
+
+    def sort_by_hue
+      Palette.new(sort_by(&:h).reverse)
+    end
+
+    def sort_similar_colors
+      Palette.new(sort_by(&:hsv))
+    end
+
+    def sort_by_saturation
+      Palette.new(sort_by(&:s).reverse)
+    end
+
+    def average_color
+      r = map(&:r).inject(&:+)
+      g = map(&:g).inject(&:+)
+      b = map(&:b).inject(&:+)
+      size = self.size
+
+      Color.new(r / size, g / size, b / size)
+    end
+
+    def light_colors(limit1, limit2)
+      min = [limit1, limit2].min
+      max = [limit1, limit2].max
+      table = dup
+      Palette.new(table.delete_if { |color| color.l > max or color.l < min })
+    end
+
+    def to_hex
+      map(&:to_hex)
+    end
+  end
+end

data/lib/camalian/quantization/histogram.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Camalian
+  module Quantization
+    class Histogram # :nodoc:
+      def process(colors, count)
+        bucket_size = (255.0 / count).ceil
+        buckets = {}
+
+        colors.each do |color|
+          key = bucket_key(color, bucket_size)
+          buckets[key] ||= Palette.new
+          buckets[key].push(color)
+        end
+
+        Palette.new(buckets.map { |_, value| value.average_color }[0...count])
+      end
+
+      private
+
+      def bucket_key(color, bucket_size)
+        "#{color.r / bucket_size}:#{color.g / bucket_size}:#{color.b / bucket_size}"
+      end
+    end
+  end
+end

data/lib/camalian/quantization/k_means.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Camalian
+  module Quantization
+    class KMeans # :nodoc:
+      INIT_TRIES = 10
+
+      def process(colors, count)
+        # Its faster to extract unique colors once
+        colors = colors.uniq
+        means = initial_means(colors, count)
+
+        done = false
+
+        until done
+          groups = group_by_means(colors, means)
+          new_means = groups.map do |group|
+            Palette.new(group).average_color
+          end
+          common = means & new_means
+
+          done = common.size == means.size
+          means = new_means
+        end
+
+        Palette.new(means)
+      end
+
+      private
+
+      def initial_means(colors, count)
+        count = colors.size if count > colors.size
+        means = []
+        tries = 0
+        while means.size != count && tries < INIT_TRIES
+          (count - means.size).times { means << colors[rand(colors.size)] }
+          means.uniq!
+          tries += 1
+        end
+
+        means
+      end
+
+      def group_by_means(pixels, means)
+        groups = {}
+
+        pixels.each do |p|
+          distances = means.map { |m| p.rgb_distance(m) }
+          min_distance_index = distances.index(distances.min)
+
+          groups[min_distance_index] ||= []
+          groups[min_distance_index] << p
+        end
+
+        groups.values
+      end
+    end
+  end
+end

data/lib/camalian/quantization/median_cut.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Camalian
+  module Quantization
+    class MedianCut # :nodoc:
+      SplitInfo = Struct.new(:range, :group_index, :color, keyword_init: true)
+      def process(colors, count)
+        # Its faster to extract unique colors once
+        colors = colors.uniq
+        groups = [colors]
+        limit = [count, colors.size].min
+
+        loop do
+          split_info = determine_group_split(groups)
+          group1, group2 = split_group(groups[split_info.group_index], split_info)
+          groups.reject!.each_with_index { |_g, index| index == split_info.group_index }
+          groups << group1 unless group1.empty?
+          groups << group2 unless group2.empty?
+
+          break if groups.size >= limit
+        end
+
+        palletes = groups.map { |g| Palette.new(g.uniq) }
+        average_colors = palletes.map(&:average_color)
+
+        Palette.new(average_colors[0...count])
+      end
+
+      private
+
+      def determine_group_split(groups)
+        stats = []
+
+        groups.each_with_index do |group, index|
+          reds = group.map(&:r)
+          greens = group.map(&:g)
+          blues = group.map(&:b)
+
+          ranges = []
+          ranges << SplitInfo.new(group_index: index, range: reds.max - reds.min, color: :r) unless reds.empty?
+          ranges << SplitInfo.new(group_index: index, range: greens.max - greens.min, color: :g) unless greens.empty?
+          ranges << SplitInfo.new(group_index: index, range: blues.max - blues.min, color: :b) unless blues.empty?
+
+          stats << ranges.max_by(&:range)
+        end
+
+        stats.max_by(&:range)
+      end
+
+      def split_group(group, split_info)
+        split_color = split_info.color
+        colors = group.sort_by { |pixel| pixel.send split_color }
+
+        return [[colors[0]], [colors[1]]] if colors.size == 2
+
+        median_index = colors.size / 2
+        median_value = colors[median_index].send split_color
+
+        group1 = []
+        group2 = []
+
+        colors.each do |color|
+          if color.send(split_color) <= median_value
+            group1 << color
+          else
+            group2 << color
+          end
+        end
+
+        [group1, group2]
+      end
+    end
+  end
+end

data/lib/camalian/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Camalian
-  VERSION = "0.0.1"
+  VERSION = '0.2.0'
 end

data/test/color_test.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'camalian'
+
+describe Camalian::Color do
+  before do
+    @color = Camalian::Color.new(120, 255, 30)
+  end
+
+  describe 'Color initialized with 120, 255, 30 rgb values' do
+    it 'hex value must be #78ff1e' do
+      _(@color.to_hex).must_equal '#78ff1e'
+    end
+
+    it 'hsl color components must ' do
+      _([@color.h.to_i, @color.s.to_i, @color.l.to_i]).must_equal [96, 100, 55]
+    end
+
+    it 'hsv color components must ' do
+      _(@color.hsv.map(&:to_i)).must_equal [96, 88, 100]
+    end
+  end
+
+  describe 'initialized with 1 integer rgb value' do
+    it 'must have leading zero' do
+      _(Camalian::Color.new(7, 7, 7).to_hex).must_equal '#070707'
+    end
+  end
+end

data/test/palette_test.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'camalian'
+
+describe Camalian::Palette do
+  before do
+    mixed_colors = %w[#2560a2 #4dd915 #1530db #49cc23 #45c031 #3da84d #1d48be #399c5b #359069 #318478 #2d7886 #296c94
+                      #2154b0 #193ccc #41b43f].freeze
+
+    @palette = Camalian::Palette.from_hex(mixed_colors)
+  end
+
+  it 'initialize palette with correct size' do
+    _(@palette.size).must_equal 15
+  end
+
+  describe '#sort_by_lightness' do
+    it 'sort colors by lightness ' do
+      _(@palette.sort_by_lightness.to_hex).must_equal ['#41b43f', '#45c031', '#1530db', '#49cc23', '#4dd915',
+                                                       '#193ccc', '#3da84d', '#1d48be', '#399c5b', '#2154b0',
+                                                       '#2560a2', '#359069', '#296c94', '#318478', '#2d7886']
+    end
+  end
+
+  describe '#sort_by_hue' do
+    it 'sort colors by hue' do
+      _(@palette.sort_by_hue.to_hex).must_equal ['#1530db', '#193ccc', '#1d48be', '#2154b0', '#2560a2', '#296c94',
+                                                 '#2d7886', '#318478', '#359069', '#399c5b', '#3da84d', '#41b43f',
+                                                 '#45c031', '#49cc23', '#4dd915']
+    end
+  end
+
+  describe '#sort_by_saturation' do
+    it 'sort colors by saturation' do
+      _(@palette.sort_by_saturation.to_hex).must_equal ['#1530db', '#4dd915', '#193ccc', '#1d48be', '#49cc23',
+                                                        '#2154b0', '#2560a2', '#45c031', '#296c94', '#2d7886',
+                                                        '#41b43f', '#3da84d', '#399c5b', '#359069', '#318478']
+    end
+  end
+
+  describe '#sort_similar_colors' do
+    it 'sort colors by hsv' do
+      _(@palette.sort_similar_colors.to_hex).must_equal ['#4dd915', '#49cc23', '#45c031', '#41b43f', '#3da84d',
+                                                         '#399c5b', '#359069', '#318478', '#2d7886', '#296c94',
+                                                         '#2560a2', '#2154b0', '#1d48be', '#193ccc', '#1530db']
+    end
+  end
+
+  describe '#average_color' do
+    it 'return one average color' do
+      _(@palette.average_color.to_hex).must_equal '#318477'
+    end
+  end
+
+  describe '#light_colors' do
+    it 'extract light colors in provided limit' do
+      _(@palette.light_colors(40, 90).to_hex).must_equal ['#4dd915', '#1530db', '#49cc23', '#45c031', '#3da84d',
+                                                          '#1d48be', '#399c5b', '#2154b0', '#193ccc', '#41b43f']
+    end
+  end
+end

data/test/quantization/histogram_test.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'camalian'
+
+describe Camalian::Quantization::Histogram do
+  describe 'palette with 15 colors extracted' do
+    before do
+      @image = Camalian.load(File.join(File.dirname(__FILE__), '../assets/palette.png'))
+      @palette = @image.prominent_colors(15, optimal: false, quantization: Camalian::QUANTIZATION_HISTOGRAM)
+    end
+
+    it 'must have 15 colors' do
+      _(@palette.size).must_equal 15
+    end
+
+    it 'sort similar colors in order' do
+      _(@palette.sort_similar_colors.map(&:to_hex)).must_equal PALLET_IMAGE_COLORS
+    end
+  end
+
+  it 'should extract distinct colors' do
+    colors = %w[#FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::Histogram.new.process(colors, 3)
+
+    _(result.size).must_equal 3
+    _(result).must_equal colors
+  end
+
+  it 'should extract distinct colors lesser than pixels' do
+    colors = %w[#FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::Histogram.new.process(colors, 2)
+
+    _(result.size).must_equal 2
+  end
+
+  it 'should extract distinct colors not more than pixels' do
+    colors = %w[#FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::Histogram.new.process(colors, 4)
+
+    _(result.size).must_equal 3
+  end
+
+  it 'should extract same color' do
+    colors = %w[#FF0000 #FF0000 #FF0000].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::Histogram.new.process(colors, 3)
+
+    _(result.size).must_equal 1
+    _(result.to_hex).must_equal ['#ff0000']
+  end
+
+  it 'should extract multiple colors' do
+    colors = %w[#FF0000 #FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::Histogram.new.process(colors, 3)
+
+    _(result.size).must_equal 3
+    _(result.to_hex).must_equal %w[#ff0000 #00ff00 #0000ff]
+  end
+end

data/test/quantization/k_means_test.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'camalian'
+
+describe Camalian::Quantization::KMeans do
+  describe 'palette with 15 colors extracted' do
+    before do
+      @image = Camalian.load(File.join(File.dirname(__FILE__), '../assets/palette.png'))
+      @palette = @image.prominent_colors(15, optimal: false, quantization: Camalian::QUANTIZATION_K_MEANS)
+    end
+
+    it 'must have 15 colors' do
+      _(@palette.size).must_equal 15
+    end
+
+    it 'sort similar colors in order' do
+      _(@palette.sort_similar_colors.map(&:to_hex)).must_equal PALLET_IMAGE_COLORS
+    end
+  end
+
+  it 'should extract distinct colors' do
+    colors = %w[#FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::KMeans.new.process(colors, 3)
+
+    _(result.size).must_equal 3
+    _(result).must_equal colors
+  end
+
+  it 'should extract distinct colors lesser than pixels' do
+    colors = %w[#FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::KMeans.new.process(colors, 2)
+
+    _(result.size).must_equal 2
+  end
+
+  it 'should extract distinct colors not more than pixels' do
+    colors = %w[#FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::KMeans.new.process(colors, 4)
+
+    _(result.size).must_equal 3
+  end
+
+  it 'should extract same color' do
+    colors = %w[#FF0000 #FF0000 #FF0000].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::KMeans.new.process(colors, 3)
+
+    _(result.size).must_equal 1
+    _(result.to_hex).must_equal ['#ff0000']
+  end
+
+  it 'should extract multiple colors' do
+    colors = %w[#FF0000 #FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::KMeans.new.process(colors, 3)
+
+    _(result.size).must_equal 3
+    _(result.to_hex).must_equal %w[#ff0000 #00ff00 #0000ff]
+  end
+end

data/test/quantization/median_cut_test.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'camalian'
+
+describe Camalian::Quantization::MedianCut do
+  describe 'palette with 15 colors extracted' do
+    before do
+      @image = Camalian.load(File.join(File.dirname(__FILE__), '../assets/palette.png'))
+      @palette = @image.prominent_colors(15, optimal: false, quantization: Camalian::QUANTIZATION_MEDIAN_CUT)
+    end
+
+    it 'must have 15 colors' do
+      _(@palette.size).must_equal 15
+    end
+
+    it 'sort similar colors in order' do
+      _(@palette.sort_similar_colors.map(&:to_hex)).must_equal ['#4dd915', '#49cc23', '#45c031', '#41b43f', '#3da84d',
+                                                                '#399c5b', '#359069', '#318478', '#2d7886', '#296c94',
+                                                                '#2560a2', '#2154b0', '#1d48be', '#193ccc', '#1530db']
+    end
+  end
+
+  it 'should extract distinct colors' do
+    colors = %w[#FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::MedianCut.new.process(colors, 3)
+
+    _(result.size).must_equal 3
+    _(result.to_hex.sort).must_equal colors.map(&:to_hex).sort
+  end
+
+  it 'should extract distinct colors lesser than pixels' do
+    colors = %w[#FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::MedianCut.new.process(colors, 2)
+
+    _(result.size).must_equal 2
+  end
+
+  it 'should extract distinct colors not more than pixels' do
+    colors = %w[#FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::MedianCut.new.process(colors, 4)
+
+    _(result.size).must_equal 3
+  end
+
+  it 'should extract same color' do
+    colors = %w[#FF0000 #FF0000 #FF0000].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::MedianCut.new.process(colors, 3)
+
+    _(result.size).must_equal 1
+    _(result.to_hex).must_equal ['#ff0000']
+  end
+
+  it 'only: should extract multiple colors' do
+    colors = %w[#FF0000 #FF0000 #00FF00 #0000FF].map { |c| Camalian::Color.from_hex(c) }
+    result = Camalian::Quantization::MedianCut.new.process(colors, 3)
+
+    _(result.size).must_equal 3
+    _(result.to_hex).must_equal ['#ff0000', '#0000ff', '#00ff00']
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'camalian'
+
+PALLET_IMAGE_COLORS = %w[#4dd915 #49cc23 #45c031 #41b43f #3da84d #399c5b #359069 #318478 #2d7886 #296c94 #2560a2
+                         #2154b0 #1d48be #193ccc #1530db].freeze

metadata

@@ -1,16 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: camalian
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Nazar Hussain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-12 00:00:00.000000000 Z
-dependencies: []
+date: 2021-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.14
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
 description: Library used to deal with colors and images
 email:
 - nazarhussain@gmail.com
@@ -18,38 +77,63 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/gpr-push.yml"
+- ".github/workflows/ruby.yml"
+- ".github/workflows/rubygems-push.yml"
+- ".gitignore"
+- ".overcommit.yml"
+- ".rubocop.yml"
+- ".tool-versions"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - camalian.gemspec
 - lib/camalian.rb
+- lib/camalian/color.rb
+- lib/camalian/image.rb
+- lib/camalian/palette.rb
+- lib/camalian/quantization/histogram.rb
+- lib/camalian/quantization/k_means.rb
+- lib/camalian/quantization/median_cut.rb
 - lib/camalian/version.rb
-homepage: http://www.nazarhussain.com
+- test/assets/palette.png
+- test/color_test.rb
+- test/palette_test.rb
+- test/quantization/histogram_test.rb
+- test/quantization/k_means_test.rb
+- test/quantization/median_cut_test.rb
+- test/test_helper.rb
+homepage: https://github.com/nazarhussain/camalian
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.0.3.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Library used to deal with colors and images. You can extract colors from
   images.
-test_files: []
+test_files:
+- test/assets/palette.png
+- test/color_test.rb
+- test/palette_test.rb
+- test/quantization/histogram_test.rb
+- test/quantization/k_means_test.rb
+- test/quantization/median_cut_test.rb
+- test/test_helper.rb