rails_dominant_colors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3d29a8561ce7e4e3be8d53818c5957f1508f04ff890b4faa8c8b9c0753e5c5f
+  data.tar.gz: 7c4fb0ba739696b70076aacd6c9f00253bfdcb675a018da183aaac762228ae4b
+SHA512:
+  metadata.gz: 7320c72aa7112c3a1b4fda7da76f9fb5fd639155b3647b4b9ce7c5e9b4d2fd826da19cae61ffbb1bfcac2e3582a5bbe0c361b38a0cd5988061101392c5db6f76
+  data.tar.gz: f189a796a45c4f8653ec625e935fa7b78ec0d0e0536de81c6b5264a9ca3e754ec4725f1d0451699000b47302e74477b697ea2354a4e6b6e1e885986e3a3ccb44

data/.gitignore

@@ -0,0 +1,24 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# IDE
+/.idea
+.idea/workspace.xml
+.rakeTasks
+.generators
+
+# Gem
+*.gem
+
+# Logs
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  IgnoredPatterns: ['(\A|\s)#']
+  Max: 120
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 20
+Metrics/BlockLength:
+  Max: 30
+Metrics/AbcSize:
+  Max: 20
+Metrics/CyclomaticComplexity:
+  Max: 20
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+Naming/MethodParameterName:
+  AllowedNames:
+    - 'r'
+    - 'g'
+    - 'b'
+    - 'a'
+    - 'h'
+    - 's'
+    - 'l'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_dominant_colors.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    rails_dominant_colors (0.1.0)
+      mini_magick (~> 4.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    json (2.3.0)
+    mini_magick (4.10.1)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.24.1)
+      sync
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls (~> 0.8)
+  rails_dominant_colors!
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 OpenGems
+
+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,48 @@
+# RailsDominantColors
+
+
+[![Gem Version](https://badge.fury.io/rb/rails_dominant_colors.svg)](https://badge.fury.io/rb/rails_dominant_colors)
+[![Maintainability](https://api.codeclimate.com/v1/badges/79cdc15c16da15562c25/maintainability)](https://codeclimate.com/github/OpenGems/rails_dominant_colors/maintainability)
+[![Build Status](https://travis-ci.org/OpenGems/rails_dominant_colors.svg?branch=master)](https://travis-ci.org/OpenGems/rails_dominant_colors)
+[![security](https://hakiri.io/github/OpenGems/rails_dominant_colors/master.svg)](https://hakiri.io/github/OpenGems/rails_dominant_colors/master)
+![Gem](https://img.shields.io/gem/dt/rails_dominant_colors)
+[![Coverage Status](https://coveralls.io/repos/github/OpenGems/rails_dominant_colors/badge.svg?branch=master)](https://coveralls.io/github/OpenGems/rails_dominant_colors?branch=master)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_dominant_colors`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_dominant_colors'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails_dominant_colors
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/rails_dominant_colors.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rails_dominant_colors'
+
+# 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

data/lib/rails_dominant_colors/base.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'mini_magick'
+
+module RailsDominantColors
+  class Base
+    InvalidBase64 = Class.new(StandardError)
+    FileNotFound = Class.new(StandardError)
+    UrlNotFound = Class.new(StandardError)
+    InvalidUrl = Class.new(StandardError)
+    NotAnImage = Class.new(StandardError)
+    EmptySource = Class.new(StandardError)
+
+    attr_reader(:source, :colors)
+
+    def initialize(source, opts = {})
+      @source = source
+      @colors = opts.fetch(:colors) { 5 }
+    end
+
+    def to_hex_alpha
+      @to_hex_alpha ||= sort_by_size.map { |x| x[:hex] }
+    end
+
+    def to_hex
+      @to_hex ||= sort_by_size.map { |x| x[:hex][0..6] }
+    end
+
+    def to_rgb_alpha
+      @to_rgb_alpha ||= sort_by_size.map { |x| [x[:r], x[:g], x[:b], x[:a]] }
+    end
+
+    def to_rgb
+      @to_rgb ||= sort_by_size.map { |x| [x[:r], x[:g], x[:b]] }
+    end
+
+    def to_hsl_alpha
+      @to_hsl_alpha ||= sort_by_size.map { |x| rgb_to_hsl(x[:r], x[:g], x[:b], x[:a]) }
+    end
+
+    def to_hsl
+      @to_hsl ||= sort_by_size.map { |x| rgb_to_hsl(x[:r], x[:g], x[:b]) }
+    end
+
+    def to_pct
+      @to_pct ||= sort_by_size.map { |x| ((x[:size].to_f / total) * 100).round(2) }
+    end
+
+    private
+
+    def extensions
+      @extensions ||= {
+        'image/png': '.png',
+        'image/jpeg': '.jpg',
+        'image/jpg': '.jpg',
+        'image/gif': '.gif',
+        'image/bmp': '.bmp',
+        'image/tiff': '.tif'
+      }
+    end
+
+    def image
+      @image ||= ::MiniMagick::Image.open(source)
+    end
+
+    def execute
+      @execute ||= image.run_command(
+        'convert',
+        image.path,
+        '-format',
+        '%c',
+        '-colors',
+        colors,
+        '-depth',
+        8,
+        '-alpha',
+        'on',
+        'histogram:info:'
+      )
+    end
+
+    def sort_by_size
+      @sort_by_size ||= parse.sort_by { |x| x[:size] }.reverse
+    end
+
+    def total
+      @total ||= sort_by_size.map { |x| x[:size] }.reduce(:+)
+    end
+
+    def parse
+      @parse ||= execute.split("\n").map { |l| l.gsub(%r{\s}, '') }.map do |l|
+        match = l.match(
+          %r{(?<size>[0-9]+):\((?<r>[0-9]+),(?<g>[0-9]+),(?<b>[0-9]+)[,]*(?<a>[0-9]+)\)(?<hex>#[0-9A-F]+)}
+        )
+        format_color(match)
+      end
+    end
+
+    def format_color(color)
+      {
+        size: color[:size].to_i,
+        r: color[:r].to_i,
+        g: color[:g].to_i,
+        b: color[:b].to_i,
+        a: (color[:a].to_f / 255).round(2),
+        hex: color[:hex]
+      }
+    end
+
+    # FIXME: refactor
+    def rgb_to_hsl(r, g, b, a = nil)
+      r /= 255.0
+      g /= 255.0
+      b /= 255.0
+
+      max = [r, g, b].max
+      min = [r, g, b].min
+
+      l = (max + min) / 2.0
+
+      if max == min
+        s = h = 0
+      else
+        d = max - min
+        s = l >= 0.5 ? d / (2.0 - max - min) : d / (max + min)
+        h = case max
+            when r then (g - b) / d + (g < b ? 6.0 : 0)
+            when g then (b - r) / d + 2.0
+            when b then (r - g) / d + 4.0
+            end
+        h /= 6.0
+      end
+
+      [(h * 360).round, (s * 100).round, (l * 100).round, a].compact
+    end
+  end
+end

data/lib/rails_dominant_colors/base64.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module RailsDominantColors
+  class Base64 < Base
+    def initialize(source, opts = {})
+      raise(EmptySource) if source.nil? || source.empty?
+
+      super(process(source), opts)
+    end
+
+    private
+
+    def process(source)
+      res = source.match(%r{data:(?<type>[-\w]+/[-\w+.]+)?;base64,(?<content>.*)})
+      raise(InvalidBase64) if res.nil?
+
+      content_type = res[:type].to_sym
+      extension = extensions[content_type]
+      raise(NotAnImage) if extension.nil?
+
+      tempfile(extension, ::Base64.decode64(res[:content]))
+    end
+
+    def tempfile(extension, body)
+      tempfile = Tempfile.open(['source', ".#{extension}"])
+      tempfile.write(body)
+      tempfile.close
+      tempfile.path
+    end
+  end
+end

data/lib/rails_dominant_colors/path.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsDominantColors
+  class Path < Base
+    def initialize(source, opts = {})
+      raise(EmptySource) if source.nil? || source.empty?
+      raise(FileNotFound) unless file_exist?(source)
+      raise(NotAnImage) unless file_is_image?(source)
+
+      super(source, opts)
+    end
+
+    private
+
+    def file_exist?(source)
+      File.exist?(source)
+    end
+
+    def file_is_image?(source)
+      extension = File.extname(source)
+      extensions.values.include?(extension)
+    end
+  end
+end

data/lib/rails_dominant_colors/url.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module RailsDominantColors
+  class Url < Base
+    def initialize(source, opts = {})
+      raise(EmptySource) if source.nil? || source.empty?
+
+      super(process(source), opts)
+    end
+
+    def process(source)
+      raise(InvalidUrl) unless valid_url?(source)
+
+      ri = remote_image(source)
+      content_type = ri.content_type.to_sym
+      extension = extensions[content_type]
+
+      raise(NotAnImage) if extension.nil?
+
+      tempfile(extension, ri.body)
+    end
+
+    private
+
+    def remote_image(url)
+      uri = uri(url)
+      req = Net::HTTP::Get.new(uri.to_s)
+      ssl = uri.scheme == 'https'
+      Net::HTTP.start(uri.host, uri.port, use_ssl: ssl) do |http|
+        http.request(req)
+      end
+    rescue StandardError
+      raise(UrlNotFound)
+    end
+
+    def valid_url?(url)
+      url =~ URI::DEFAULT_PARSER.make_regexp(%w[http https])
+    end
+
+    def uri(url)
+      URI.parse(url)
+    rescue StandardError
+      raise(InvalidUrl)
+    end
+
+    def tempfile(extension, body)
+      tempfile = Tempfile.open(['source', extension])
+      tempfile.write(body)
+      tempfile.close
+      tempfile.path
+    end
+  end
+end

data/lib/rails_dominant_colors/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsDominantColors
+  VERSION = '0.1.0'
+end

data/lib/rails_dominant_colors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rails_dominant_colors/base'
+require 'rails_dominant_colors/base64'
+require 'rails_dominant_colors/path'
+require 'rails_dominant_colors/url'
+
+module RailsDominantColors
+  class << self
+    def base64(source, opts = {})
+      RailsDominantColors::Base64.new(source, opts)
+    end
+
+    def url(source, opts = {})
+      RailsDominantColors::Url.new(source, opts)
+    end
+
+    def path(source, opts = {})
+      RailsDominantColors::Path.new(source, opts)
+    end
+  end
+end

data/rails_dominant_colors.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rails_dominant_colors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_dominant_colors'
+  spec.version       = RailsDominantColors::VERSION
+  spec.authors       = ['Boris BRESCIANI']
+  spec.email         = ['boris2bresciani@gmail.com']
+
+  spec.summary       = 'Extract the dominant color(s) from an image'
+  spec.description   = <<~TEXT
+    Extract the dominant color(s) from an image (remote image, locally image, base64 image etc...)
+    Convert to HEX(A), RGB(A), HSL(a)'
+  TEXT
+
+  spec.homepage      = 'https://github.com/OpenGems/rails_dominant_colors'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+
+  spec.add_dependency 'mini_magick', '~> 4.10'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: rails_dominant_colors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Boris BRESCIANI
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-02 00:00:00.000000000 Z
+dependencies:
+- !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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+description: |
+  Extract the dominant color(s) from an image (remote image, locally image, base64 image etc...)
+  Convert to HEX(A), RGB(A), HSL(a)'
+email:
+- boris2bresciani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_dominant_colors.rb
+- lib/rails_dominant_colors/base.rb
+- lib/rails_dominant_colors/base64.rb
+- lib/rails_dominant_colors/path.rb
+- lib/rails_dominant_colors/url.rb
+- lib/rails_dominant_colors/version.rb
+- rails_dominant_colors.gemspec
+homepage: https://github.com/OpenGems/rails_dominant_colors
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OpenGems/rails_dominant_colors
+  source_code_uri: https://github.com/OpenGems/rails_dominant_colors
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Extract the dominant color(s) from an image
+test_files: []