carrierwave-color 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b934eea908ecbe77e1131bec424d0697c2565c0a
+  data.tar.gz: 44874d042c751d49c88e06d35bf13ac47b371ef5
+SHA512:
+  metadata.gz: 6509d6720f23b2704a953102bb93582f8c76f6300cd82cc09ce07b65e11d45e6852e65f026b0543f9cb56b88019fe0f2ebc5d3015dd726ec07d38365ec193fac
+  data.tar.gz: 4c17e7564c4cd70b9af6018beb0b7467d0fe0498be6c5dffe3635e469272fd87017cd2aa7cf87e4c0ad3f3483a08e2f76c1e34e7be6e4894587a52f0bb53350f

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/README.md

@@ -0,0 +1,111 @@
+CarrierWave Color
+=================
+
+Add the dominant color of an image to your database whenever you upload it
+with the CarrierWave gem on your Rails app.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "carrierwave-color"
+```
+
+And then call:
+
+```sh
+$ bundle
+```
+
+Add a processor to your uploader
+--------------------------------
+
+In your uploader, include the module and call the processor:
+
+```ruby
+class PhotoUploader < CarrierWave::Uploader::Base
+  include include CarrierWave::Color
+
+  process :store_dominant_color
+
+  # …
+end
+```
+
+Add a dominant color attribute
+------------------------------
+
+To store the color, you need an attribute on the Rails model where you attach
+your uploader. Call it `{uploader}_dominant_color`.
+
+For example if you have the following model:
+
+```ruby
+class Article
+  mount_uploader :photo, PhotoUploader
+end
+```
+
+Then you would need to add a `photo_dominant_color` column to the `articles`
+table. You could create a migration by executing:
+
+```sh
+$ rails g migration AddPhotoDominantColorToArticles photo_dominant_color
+$ rake db:migrate
+```
+
+Using your dominant color
+-------------------------
+
+An easy way of using your dominant colors is to put them as a background to your
+image tags:
+
+```erb
+<%= image_tag(article.photo.url(:thumb), style: "background: #{article.photo_dominant_color}") %>
+```
+
+For example, on [cults3d](http://cults3d.com):
+
+![Cults 3D Animated Screenshot with dominant colors during image load](doc/example-cults3d.gif)
+
+Resizing
+--------
+
+If you do any resizing or if you have several versions of your uploader,
+store the color on the smallest so that processing goes faster. For example:
+
+```ruby
+# …
+version :medium do
+  process resize_to_fill: [200, 200]
+end
+
+version :thumb, from_version: :medium do
+  process resize_to_fill: [42, 42]
+  process :store_dominant_color
+end
+# …
+```
+
+Dominant color from a palette
+-----------------------------
+
+If you wish to find the dominant color from a selection of colors, you can use
+the following processor with a `{uploader}_palette_color` field on your model:
+
+```rb
+process store_palette_color: ['ff0000', '00ff00', '0000ff']
+```
+
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/sunny/carrierwave-color/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/carrierwave-color.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'carrierwave/color/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrierwave-color"
+  spec.version       = CarrierWave::Color::VERSION
+  spec.authors       = ["Sunny Ripert"]
+  spec.email         = ["sunny@sunfox.org"]
+  spec.summary       = "Store the dominant color of an image with CarrierWave"
+  spec.description   = "Store the dominant color of the images when you " \
+                       "upload them to your Rails application using the " \
+                       "CarrierWave gem."
+  spec.homepage      = "https://github.com/sunny/carrierwave-color"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "colorscore"
+end

data/lib/carrierwave/color/detection.rb

@@ -0,0 +1,26 @@
+require "colorscore"
+
+module CarrierWave
+  module Color
+    module Detection
+      class Error < StandardError
+      end
+
+      module_function
+
+      def dominant_html(path)
+        histogram = Colorscore::Histogram.new(path, 1)
+        color = histogram.colors.first
+        color && color.html
+      end
+
+      def dominant_from_palette_html(path, palette_hexes)
+        histogram = Colorscore::Histogram.new(path)
+        palette = Colorscore::Palette.from_hex(palette_hexes)
+        scores = palette.scores(histogram.scores, 1)
+        _score, color = scores.first
+        color.html
+      end
+    end
+  end
+end

data/lib/carrierwave/color/version.rb

@@ -0,0 +1,5 @@
+module CarrierWave
+  module Color
+    VERSION = "1.0.0"
+  end
+end

data/lib/carrierwave/color.rb

@@ -0,0 +1,15 @@
+require "carrierwave/color/detection"
+
+module CarrierWave
+  module Color
+    def store_dominant_color
+      color = Detection.dominant_html(current_path)
+      model.send "#{mounted_as}_dominant_color=", color
+    end
+
+    def store_palette_color(palette = Colorscore::Palette::DEFAULT)
+      color = Detection.dominant_from_palette_html(current_path, palette)
+      model.send "#{mounted_as}_palette_color=", color
+    end
+  end
+end

data/spec/detection_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module CarrierWave
+  module Color
+    RSpec.describe Detection do
+      let(:path) { File.expand_path('../fixtures/red-rainbow.jpg', __FILE__) }
+
+      describe ".dominant_html" do
+        it "returns the correct hex code" do
+          expect(Detection.dominant_html(path)).to eq("#700503")
+        end
+      end
+
+      describe ".dominant_from_palette_html" do
+        it "returns the correct hex code" do
+          palette = %w(ff0000 00ff00 0000ff)
+          result = Detection.dominant_from_palette_html(path, palette)
+          expect(result).to eq("#ff0000")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "rspec"
+
+require "carrierwave/color"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-color
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sunny Ripert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorscore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Store the dominant color of the images when you upload them to your Rails
+  application using the CarrierWave gem.
+email:
+- sunny@sunfox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- carrierwave-color.gemspec
+- lib/carrierwave/color.rb
+- lib/carrierwave/color/detection.rb
+- lib/carrierwave/color/version.rb
+- spec/detection_spec.rb
+- spec/fixtures/red-rainbow.jpg
+- spec/spec_helper.rb
+homepage: https://github.com/sunny/carrierwave-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.4.5
+signing_key: 
+specification_version: 4
+summary: Store the dominant color of an image with CarrierWave
+test_files: []