shrine-color 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7d2d6bf761232e62fdc34b0e1378dfa8288aab5
+  data.tar.gz: a15371b69e211694cb0c642bf95ef8664c2d482a
+SHA512:
+  metadata.gz: cd31b407cef673b5c6b454bbdb404c70aaec79433ed7f1b34a08e826a344f819daf53836675c49bf81c5d7a82cb9c4a43d4e23d39bbed82d9d6b60a53aabccd0
+  data.tar.gz: 8836c647e54b2bc93e4cab88e30b6e524bdabdb623abbf9d986990183464deaae60cdcf625406c4fa9173b0d63b5f0ec028c91c469836df8d0c00d63d0e19cfa

data/.gitignore

@@ -0,0 +1,4 @@
+vendor/
+t.rb
+public/
+.bundle/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    shrine-color (0.1)
+      jnylen-colorscore (>= 0.1.1)
+      shrine (>= 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    color (1.8)
+    diff-lcs (1.2.5)
+    down (2.3.6)
+    jnylen-colorscore (0.1.1)
+      color
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    shrine (2.2.0)
+      down (>= 2.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  rake (~> 11.1)
+  rspec (~> 3.0)
+  shrine-color!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Joakim Nylén
+
+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,61 @@
+Shrine Color
+=================
+
+Get the dominant color of an image using colorscore (updated version by me). This can be used as a background color while an image is loading or search by color.
+
+This is based on carrierwave-color by Sunny Ripert (sunny).
+
+Requirements
+------------
+
+This gem requires imagemagick (convert) and grabs colors via a command line.
+So mini_magick, etc. isn't required.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "shrine-color"
+```
+
+And then call:
+
+```sh
+$ bundle
+```
+
+Add the plugin to your uploader
+--------------------------------
+
+In your uploader, include the module and call the processor:
+
+```ruby
+class ImageUploader < Shrine
+  # plugin add_metadata should be loaded automagically.
+  # otherwise add it here
+  plugin :color
+
+  # dominant color
+  add_metadata :dominant_color do |io, context|
+    dominant_color(io.path)
+  end
+
+  # palette color with version and own array of colors.
+  add_metadata :palette_color do |io, context|
+    if context[:version] == :small
+      palette_color(io.path, ['ff0000', '00ff00', '0000ff'])
+    end
+  end
+end
+```
+
+You can now use the code below to get a color:
+```ruby
+## Dominant color
+photo.image[:small].metadata["dominant_color"]
+# or
+photo.image[:small].dominant_color
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/shrine/plugins/color.rb

@@ -0,0 +1,44 @@
+require "colorscore"
+
+class Shrine
+  module Plugins
+    # text text text
+    module Color
+      def self.load_dependencies(uploader, *)
+        uploader.plugin :add_metadata
+      end
+
+      module InstanceMethods
+        DEFAULT_PALETTE_HEXES = ["660000", "990000", "cc0000", "cc3333", "ea4c88", "993399",
+                   "663399", "333399", "0066cc", "0099cc", "66cccc", "77cc33",
+                   "669900", "336600", "666600", "999900", "cccc33", "ffff00",
+                   "ffcc33", "ff9900", "ff6600", "cc6633", "996633", "663300",
+                   "000000", "999999", "cccccc", "ffffff"]
+
+        # Returns the most dominant color in HEX in an image.
+        def dominant_color(io_path)
+          histogram = Colorscore::Histogram.new(io_path, :colors => 1)
+          color = histogram.colors.first
+          color && color.html # html = hex
+        end
+
+        # Matches the dominant color to the closest color in the array provided
+        def palette_color(io_path, palette_hexes = DEFAULT_PALETTE_HEXES)
+          histogram = Colorscore::Histogram.new(io_path)
+          palette = Colorscore::Palette.from_hex(palette_hexes)
+
+          histogram_scores = histogram.scores
+          return nil if histogram_scores.first.last.nil?
+
+          scores = palette.scores(histogram_scores, 1)
+          _score, color = scores.first
+          color.html
+        end
+
+      end
+
+    end
+
+    register_plugin(:color, Color)
+  end
+end

data/shrine-color.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "shrine-color"
+  spec.version       = "0.2.0"
+  spec.authors       = ["Joakim Nylen"]
+  spec.email         = ["me@jnylen.nu"]
+  spec.summary       = "Return the dominant color of an image in Shrine."
+  spec.description   = "Return the dominant color of an image in Shrine."
+  spec.homepage      = "https://github.com/jnylen/shrine-color"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "shrine", ">= 2.0"
+  spec.add_dependency "jnylen-colorscore", ">= 0.1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/shrine/color_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Shrine::Plugins::Color do
+  before do
+    @uploader = uploader { plugin :color }
+  end
+
+  describe ":dominant_color" do
+    it "extracts dominant_color from files via add_metadata" do
+      @uploader.class.add_metadata(:dominant_color) { |io, context| dominant_color(io.path) }
+      uploaded_file = @uploader.upload(File.open("spec/fixtures/bora.jpg"))
+      expect(uploaded_file.metadata.fetch("dominant_color")).to eq("#48839f")
+    end
+  end
+
+  describe ":palette_color" do
+    it "extracts palette_color from files with default hexes via add_metadata" do
+      @uploader.class.add_metadata(:palette_color) { |io, context| palette_color(io.path) }
+      uploaded_file = @uploader.upload(File.open("spec/fixtures/bora.jpg"))
+      expect(uploaded_file.metadata.fetch("palette_color")).to eq("#333399")
+    end
+
+    it "extracts palette_color from files with custom hexes via add_metadata" do
+      @uploader.class.add_metadata(:palette_color) { |io, context| palette_color(io.path, ['ff0000', '00ff00', '0000ff']) }
+      uploaded_file = @uploader.upload(File.open("spec/fixtures/bora.jpg"))
+      expect(uploaded_file.metadata.fetch("palette_color")).to eq("#0000ff")
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'shrine'
+require 'shrine/plugins/add_metadata'
+require 'shrine/plugins/color'
+require 'shrine/storage/file_system'
+
+def uploader(storage_key = :store, &block)
+  uploader_class = Class.new(Shrine)
+  uploader_class.storages[:cache] = Shrine::Storage::FileSystem.new("/tmp", prefix: "uploads")
+  uploader_class.storages[:store] = Shrine::Storage::FileSystem.new("/tmp", prefix: "uploads")
+  uploader_class.class_eval(&block) if block
+  uploader_class.new(storage_key)
+end
+
+def attacher(*args, &block)
+  uploader = uploader(*args, &block)
+  Object.send(:remove_const, "User") if defined?(User) # for warnings
+  user_class = Object.const_set("User", Struct.new(:avatar_data, :id))
+  user_class.include uploader.class[:avatar]
+  user_class.new.avatar_attacher
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: shrine-color
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Joakim Nylen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jnylen-colorscore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !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'
+description: Return the dominant color of an image in Shrine.
+email:
+- me@jnylen.nu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/shrine/plugins/color.rb
+- shrine-color.gemspec
+- spec/fixtures/bora.jpg
+- spec/shrine/color_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jnylen/shrine-color
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Return the dominant color of an image in Shrine.
+test_files: []