camalian 0.0.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6d00dedccb6e595bdc20ada99a24660c6ae5dd3d
-  data.tar.gz: 5c0dbce2351031926ae80fd502d96f14899c83c6
+SHA256:
+  metadata.gz: df3efad40b55f5cc45e321d93c23077296b7367de0ea54dfb663b666c6c47b2f
+  data.tar.gz: d1d99748916c16c4b13e247427ae54a166623893cdfdd9322978fa16d8ab85f4
 SHA512:
-  metadata.gz: e7cf381751a54732d7a08474333accca30b0b5284c0916373f88c739e1951f4557469c5c5611d719200e29d5c1c5403aa87d7143395fbf3e96b311d55d66a9d2
-  data.tar.gz: bf78a507dcec731e88d8fe13c0f6e5e962529bf644d5fb49b9d760518ebf1352c25108a4f1e3ee4fab726c663b773bdcb0ff3aa6a975b359c4f9771a4dbad57c
+  metadata.gz: a3e0d48d911fdd7fe75a5fb5bcb2b7963e509eb7297f924be57ecd806ff36db462d347e2d1159d4d28031c077e5cb39a1e0df1716614e00311fb4f192f694722
+  data.tar.gz: '08f12c2b89f583d56fc327fe20f6d283a042d0bd435152fe29cec944b1e5ca187b56daa2f4601cdb88da2627fa41c445516c02db819cbe14b2ea408d036a76fa'

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-latest
+    strategy:
+      matrix:
+        ruby: ["2.5", "2.6", "2.7"]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/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,10 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in camalian.gemspec
 gemspec
+
+gem 'rubocop', '~> 1.3', require: false
+gem 'rubocop-daemon', require: false
+gem 'simplecov', require: false

data/README.md

@@ -1,12 +1,16 @@
 # Camalian
 
+[![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', '~> 0.0.2'
+    gem 'camalian', '~> 0.2.1'
 
 And then execute:
 
@@ -18,10 +22,46 @@ Or install it yourself as:
 
 ## Usage
 
-    image = Camalian::load('file_path')
-    colors = image.prominent_colors(15)
-    colors = colors.sort_similar_colors
-    colors.light_colors(0, 40)
+```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,10 +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
+desc 'Run tests'
+task default: :test

data/camalian.gemspec

@@ -1,27 +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      = "https://github.com/nazarhussain/camalian"
-  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.requirements  = 'ImageMagick'
+  spec.add_dependency 'chunky_png', '~> 1.3', '>= 1.3.14'
 
-  spec.add_dependency "cocaine"
-  spec.add_dependency "rmagick", "~> 2.15.4"
-  spec.add_dependency "oily_png", "~> 1.2.0"
+  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.5'
 end

data/lib/camalian.rb

@@ -1,25 +1,31 @@
-require "oily_png"
-require "tempfile"
-require "open-uri"
-require "cocaine"
-require "chunky_png_patch/color"
+# frozen_string_literal: true
 
-require "camalian/version"
-require "camalian/color"
-require "camalian/palette"
-require "camalian/image"
+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
 
-module Camalian
   class << self
     def options
-      convert = `which convert`.strip
       @options ||= {
-          :image_magick_path  => convert.length > 0 ? convert : '/usr/bin/convert',
-          :color_count        => 8,
+        color_count: 8,
+        quantization: Camalian::QUANTIZATION_HISTOGRAM
       }
     end
 
-    def load(image_path)      
+    def load(image_path)
       Image.new(image_path)
     end
   end

data/lib/camalian/color.rb

@@ -1,15 +1,22 @@
+# frozen_string_literal: true
+
 module Camalian
+  # Camalian color object
   class Color
-
     attr_reader :r, :g, :b, :h, :s, :l, :hsv
 
-    def initialize(*value)
-      if value.size == 1
-        rgb = extract_rgb(value.first)
-        build_components(rgb[0], rgb[1], rgb[2])
-      elsif value.size == 3
-        build_components(value[0], value[1], value[2])
-      end
+    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
@@ -20,22 +27,28 @@ module Camalian
       "##{r.to_s(16).rjust(2, '0')}#{g.to_s(16).rjust(2, '0')}#{b.to_s(16).rjust(2, '0')}"
     end
 
-    def distance(color)
-      [(self.h - color.h) % 360, (color.h - self.h) % 360].min
+    # Used for array uniqueness
+    def hash
+      "#{r}#{g}#{b}".to_i
     end
 
-    def extract_rgb(color_hash)
-      color_hash = color_hash[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)
-      [r, g, b]
+    # 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)
+    def build_components(r, g, b)
       @r = r
       @g = g
       @b = b
@@ -50,21 +63,21 @@ module Camalian
 
       @l = (cmax + cmin) / 2.0
 
-      if delta == 0
+      if delta.zero?
         @h = 0
       elsif cmax == ri
         @h = 60 * (((gi - bi) / delta) % 6)
       elsif cmax == gi
-        @h = 60 * (((bi - ri)/ delta) + 2)
+        @h = 60 * (((bi - ri) / delta) + 2)
       elsif cmax == bi
-        @h = 60 * (((ri - gi)/ delta) + 4)
+        @h = 60 * (((ri - gi) / delta) + 4)
       end
 
-      if (delta == 0)
-        @s = 0
-      else
-        @s = delta / ( 1 - (2*@l -1).abs )
-      end
+      @s = if delta.zero?
+             0
+           else
+             delta / (1 - (2 * @l - 1).abs)
+           end
 
       @h = @h.round(2)
       @s = (@s * 100).round(2)
@@ -72,22 +85,22 @@ module Camalian
 
       # HSV Calculation
       # Hue calculation
-      if delta == 0
+      if delta.zero?
         @hsv = [0]
       elsif cmax == ri
         @hsv = [60 * (((gi - bi) / delta) % 6)]
       elsif cmax == gi
-        @hsv = [60 * (((bi - ri)/ delta) + 2)]
+        @hsv = [60 * (((bi - ri) / delta) + 2)]
       elsif cmax == bi
-        @hsv = [60 * (((ri - gi)/ delta) + 4)]
+        @hsv = [60 * (((ri - gi) / delta) + 4)]
       end
 
       # Saturation calculation
-      if (cmax == 0)
-        @hsv  << 0
-      else
-        @hsv << delta / cmax
-      end
+      @hsv << if cmax.zero?
+                0
+              else
+                delta / cmax
+              end
 
       # Value calculation
       @hsv << cmax