rails_dominant_colors 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3d29a8561ce7e4e3be8d53818c5957f1508f04ff890b4faa8c8b9c0753e5c5f
-  data.tar.gz: 7c4fb0ba739696b70076aacd6c9f00253bfdcb675a018da183aaac762228ae4b
+  metadata.gz: cc461431999b438497a0d90347db8c6925b3229ecc914bfc6f8a76649a145b6c
+  data.tar.gz: 9c2692cd8a7e6bad4289c72f9922ed9361c012646f6b0b8ee9752c4281d83fdc
 SHA512:
-  metadata.gz: 7320c72aa7112c3a1b4fda7da76f9fb5fd639155b3647b4b9ce7c5e9b4d2fd826da19cae61ffbb1bfcac2e3582a5bbe0c361b38a0cd5988061101392c5db6f76
-  data.tar.gz: f189a796a45c4f8653ec625e935fa7b78ec0d0e0536de81c6b5264a9ca3e754ec4725f1d0451699000b47302e74477b697ea2354a4e6b6e1e885986e3a3ccb44
+  metadata.gz: 853a1163cae3430115faff75aeb5fa9bb727b5e9fcfe8db3ed1dcd293f0c8e9db40ba42d216f9e4fb721a7133819f3c11bdd9652c3fab6df12ce03934cb71916
+  data.tar.gz: 71b484c448f706717d4c188ac296ab24b5a1ab6db5db7bcc267fb2e976af6eb17930732fdd27220cf51db5ff980662357d503b0b96eb43e2e44b56cbf3504701

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: ZNtqKdszxNXImMHT3tBJ3jI0UY8k7kJ6y

data/.rubocop.yml

@@ -8,13 +8,13 @@ Layout/EmptyLineAfterGuardClause:
 Layout/EmptyLinesAroundBlockBody:
   Enabled: false
 Metrics/MethodLength:
-  Max: 20
+  Max: 25
 Metrics/BlockLength:
   Max: 30
 Metrics/AbcSize:
-  Max: 20
+  Max: 25
 Metrics/CyclomaticComplexity:
-  Max: 20
+  Max: 25
 Style/RegexpLiteral:
   EnforcedStyle: percent_r
 Naming/MethodParameterName:

data/.travis.yml

@@ -1,6 +1,12 @@
 ---
+os: linux
 language: ruby
 cache: bundler
 rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4
+  - 2.5.5
+  - 2.6.3
+  - 2.7.0
+before_install: gem install bundler
+before_script:
+  - bundle install
+script: RAILS_ENV=test bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_dominant_colors (0.1.0)
+    rails_dominant_colors (0.2.0)
       mini_magick (~> 4.10)
 
 GEM
@@ -13,24 +13,24 @@ GEM
       term-ansicolor (~> 1.3)
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    json (2.3.0)
+    json (2.3.1)
     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)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       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)
+    rspec-support (3.9.3)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -40,7 +40,7 @@ GEM
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (1.0.1)
-    tins (1.24.1)
+    tins (1.25.0)
       sync
 
 PLATFORMS

data/README.md

@@ -1,16 +1,15 @@
 # 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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/83326d81b9112b45768f/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.
+A Ruby gem for extract the dominant color(s) from an image (remote image, locally image, base64 image etc...)
 
-TODO: Delete this and the text above, and describe your gem
+Get HEX(A) color(s), RGB(A) color(s) and HSL(A) color(s)
 
 ## Installation
 
@@ -30,18 +29,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+colors = 5 # Optional, number of colors (default: 5)
+
+dominant_colors = RailsDominantColors::Base64.new('data:image/png;base64,awesome-image', colors)
 
-## Development
+# or
 
-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.
+RailsDominantColors::Url.new('https://awesome-url.com/awesome-image.png', colors)
 
-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).
+# or
 
-## Contributing
+RailsDominantColors::Path.new('/awesome/path/awesome-image.png', colors)
+
+# and
+
+dominant_colors.to_hex # => ["#FF007F", "#000000", "#1C000F", "#A0004F", "#000000"]
+dominant_colors.to_hex_alpha # => ["#FF007FFF", "#00000000", "#1C000FFE", "#A0004FFF", "#0000005F"]
+
+dominant_colors.to_rgb # => [[255, 0, 127], [0, 0, 0], [28, 0, 15], [160, 0, 79], [0, 0, 0]]
+dominant_colors.to_rgb_alpha # => [[255, 0, 127, 1.0], [0, 0, 0, 0.0], [28, 0, 15, 1.0], [160, 0, 79, 1.0], [0, 0, 0, 0.37]]
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_dominant_colors.
+dominant_colors.to_hsl # => [[330, 100, 50], [0, 0, 0], [328, 100, 5], [330, 100, 31], [0, 0, 0]]
+dominant_colors.to_hsl_alpha # => [[330, 100, 50, 1.0], [0, 0, 0, 0.0], [328, 100, 5, 1.0], [330, 100, 31, 1.0], [0, 0, 0, 0.37]]
+
+# Awesome bonus
+dominant_colors.to_pct # => [52.16, 37.45, 9.93, 0.35, 0.1]
+
+```
+
+
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/OpenGems/rails_dominant_colors. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
 
 ## License
 

data/lib/rails_dominant_colors.rb

@@ -7,16 +7,16 @@ require 'rails_dominant_colors/url'
 
 module RailsDominantColors
   class << self
-    def base64(source, opts = {})
-      RailsDominantColors::Base64.new(source, opts)
+    def base64(source, colors = 5)
+      RailsDominantColors::Base64.new(source, colors)
     end
 
-    def url(source, opts = {})
-      RailsDominantColors::Url.new(source, opts)
+    def url(source, colors = 5)
+      RailsDominantColors::Url.new(source, colors)
     end
 
-    def path(source, opts = {})
-      RailsDominantColors::Path.new(source, opts)
+    def path(source, colors = 5)
+      RailsDominantColors::Path.new(source, colors)
     end
   end
 end

data/lib/rails_dominant_colors/base.rb

@@ -13,9 +13,9 @@ module RailsDominantColors
 
     attr_reader(:source, :colors)
 
-    def initialize(source, opts = {})
+    def initialize(source, colors)
       @source = source
-      @colors = opts.fetch(:colors) { 5 }
+      @colors = colors
     end
 
     def to_hex_alpha
@@ -35,11 +35,24 @@ module RailsDominantColors
     end
 
     def to_hsl_alpha
-      @to_hsl_alpha ||= sort_by_size.map { |x| rgb_to_hsl(x[:r], x[:g], x[:b], x[:a]) }
+      @to_hsl_alpha ||= sort_by_size.map do |x|
+        rgb_to_hsl(
+          x[:r] / 255.0,
+          x[:g] / 255.0,
+          x[:b] / 255.0,
+          x[:a]
+        )
+      end
     end
 
     def to_hsl
-      @to_hsl ||= sort_by_size.map { |x| rgb_to_hsl(x[:r], x[:g], x[:b]) }
+      @to_hsl ||= sort_by_size.map do |x|
+        rgb_to_hsl(
+          x[:r] / 255.0,
+          x[:g] / 255.0,
+          x[:b] / 255.0
+        )
+      end
     end
 
     def to_pct
@@ -107,14 +120,8 @@ module RailsDominantColors
       }
     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
+      min, max = min_max(r, g, b)
 
       l = (max + min) / 2.0
 
@@ -131,6 +138,16 @@ module RailsDominantColors
         h /= 6.0
       end
 
+      format_hsl(h, s, l, a)
+    end
+
+    def min_max(r, g, b)
+      max = [r, g, b].max
+      min = [r, g, b].min
+      [min, max]
+    end
+
+    def format_hsl(h, s, l, a)
       [(h * 360).round, (s * 100).round, (l * 100).round, a].compact
     end
   end

data/lib/rails_dominant_colors/base64.rb

@@ -4,10 +4,10 @@ require 'base64'
 
 module RailsDominantColors
   class Base64 < Base
-    def initialize(source, opts = {})
+    def initialize(source, colors)
       raise(EmptySource) if source.nil? || source.empty?
 
-      super(process(source), opts)
+      super(process(source), colors)
     end
 
     private

data/lib/rails_dominant_colors/path.rb

@@ -2,12 +2,12 @@
 
 module RailsDominantColors
   class Path < Base
-    def initialize(source, opts = {})
+    def initialize(source, colors)
       raise(EmptySource) if source.nil? || source.empty?
       raise(FileNotFound) unless file_exist?(source)
       raise(NotAnImage) unless file_is_image?(source)
 
-      super(source, opts)
+      super(source, colors)
     end
 
     private

data/lib/rails_dominant_colors/url.rb

@@ -4,10 +4,10 @@ require 'net/http'
 
 module RailsDominantColors
   class Url < Base
-    def initialize(source, opts = {})
+    def initialize(source, colors)
       raise(EmptySource) if source.nil? || source.empty?
 
-      super(process(source), opts)
+      super(process(source), colors)
     end
 
     def process(source)

data/lib/rails_dominant_colors/version.rb

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

data/rails_dominant_colors.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   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)'
+    Get HEX(A) color(s), RGB(A) color(s), HSL(A) color(s)
   TEXT
 
   spec.homepage      = 'https://github.com/OpenGems/rails_dominant_colors'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_dominant_colors
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Boris BRESCIANI
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,13 +96,14 @@ dependencies:
         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)'
+  Get HEX(A) color(s), RGB(A) color(s), HSL(A) color(s)
 email:
 - boris2bresciani@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -127,7 +128,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/OpenGems/rails_dominant_colors
   source_code_uri: https://github.com/OpenGems/rails_dominant_colors
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Extract the dominant color(s) from an image
 test_files: []