kaleidoscope 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kaleidoscope.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josh Smith
+
+MIT License
+
+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,131 @@
+# Kaleidoscope
+
+[![Gem Version](https://badge.fury.io/rb/kaleidoscope.png)][gem] [![Build Status](https://travis-ci.org/JoshSmith/kaleidoscope.png?branch=master)](https://travis-ci.org/JoshSmith/kaleidoscope) [![Dependency Status](https://gemnasium.com/JoshSmith/kaleidoscope.png)](https://gemnasium.com/JoshSmith/kaleidoscope) [![Code Climate](https://codeclimate.com/github/JoshSmith/kaleidoscope.png)](https://codeclimate.com/github/JoshSmith/kaleidoscope)
+
+Kaleidoscope is color search for Rails using Active Record and Paperclip. The intent behind it was to index a database of images by color for quick retrieval.
+
+Kaleidoscope works by running histograms on images and converting their top *n* colors (by frequency) into [L*a*b* color space](http://en.wikipedia.org/wiki/Lab_color_space) for a more approximate representation of human vision. Colors are then matched to a specified set of colors using Euclidean distance. The gem will store hexadecimal values of the image's original color and the matched color, along with the frequency of that color within the image (for sorting based on frequency) and the Euclidean distance (for sorting by tolerance).
+
+Since L*a*b* relies so heavily on lightness, matches for white, black, and grey will all be quite poor compared to other color types.
+
+Here's an example of what Kaleidoscope can do:
+
+![Kaleidoscope Example](http://cl.ly/image/3n2C16170i0k/Screen%20Shot%202013-02-05%20at%206.56.44%20PM.png)
+
+## Requirements
+
+### Paperclip
+
+Currently Kaleidoscope requires you to have [Paperclip](https://github.com/thoughtbot/paperclip) already run on the model you want indexed for color search.
+
+In the future, it would be nice if Paperclip were not a requirement and Kaleidoscope could work with, say, CarrierWave.
+
+### Image Processor
+
+[ImageMagick](http://www.imagemagick.org/) must be installed and Kaleidoscope must have access to it via [RMagick](https://github.com/rmagick/rmagick). To ensure that it does, on your command line, run `which convert` (one of the ImageMagick utilities). This will give you the path where that utility is installed. For example, it might return `/usr/local/bin/convert/`.
+
+If you're on Mac OS X, you'll want to run the following with Homebrew:
+
+```
+brew install imagemagick
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kaleidoscope'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kaleidoscope
+
+## Usage
+
+Generate your migration by specifying the Paperclip model, e.g. `Photo`:
+
+```bash
+rails generate kaleidoscope photo
+```
+
+This will generate the model `PhotoColor`.
+
+Alternatively, in your models:
+
+```ruby
+class Photo < ActiveRecord::Base
+  has_many :photo_colors
+end
+
+class PhotoColor < ActiveRecord::Base
+  belongs_to :photo
+
+  attr_accessible :photo_id, :distance, :frequency, :original_color, :reference_color
+end
+```
+
+And in your migrations:
+
+```ruby
+class AddPhotoColors < ActiveRecord::Migration
+  def change
+    create_table :photo_colors do |t|
+      t.integer :photo_id
+      t.string :original_color
+      t.string :reference_color
+      t.float :frequency
+      t.integer :distance
+
+      t.timestamps
+    end
+
+    add_index :photo_colors, :photo_id
+    add_index :photo_colors, :original_color
+    add_index :photo_colors, :reference_color
+    add_index :photo_colors, :frequency
+    add_index :photo_colors, :distance
+  end
+end
+```
+
+In your controller:
+
+```ruby
+def index
+  @photos = Photo.all.with_color(params[:color])
+end
+```
+
+To refresh the color database:
+
+```bash
+rake kaleidosocope:refresh
+```
+
+## Contributing
+
+Please submit pull requests! I'd love to feature you as a contributor. Here's a guide:
+
+1. Fork the repo.
+2. Run the tests. We only take pull requests with passing tests.
+3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test.
+4. Make the test pass.
+5. Push to your fork and submit a pull request.
+
+We'll review your changes, comment, and then accept or throw it back to you for improvement.
+
+### Syntax
+
+* Two spaces, no tabs.
+* No trailing whitespace.
+* Prefer &&/II over and/or.
+* a = b and not a=b
+* Follow conventions you see used in the source already.
+
+## TODO
+
+1. Enable Kaleidoscope to work without requiring Paperclip. Ideally, any database of images should be searchable and we don't want to be tied down to one specific gem.

data/Rakefile

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

data/kaleidoscope.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kaleidoscope/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "kaleidoscope"
+  gem.version       = Kaleidoscope::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Josh Smith"]
+  gem.email         = ["joshdotsmith@gmail.com"]
+  gem.description   = %q{Color search for Rails}
+  gem.summary       = %q{Kaleidoscope is color search for Rails using Active Record and Paperclip. The intent behind it was to index a database of images by color for quick retrieval.}
+  gem.homepage      = "https://github.com/JoshSmith/kaleidoscope"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.requirements << "ImageMagick"
+  gem.required_ruby_version = ">= 1.9.2"
+
+  gem.add_dependency('activerecord', '>= 3.0.0')
+  gem.add_dependency('activemodel', '>= 3.0.0')
+  gem.add_dependency('activesupport', '>= 3.0.0')
+
+  gem.add_dependency('rmagick', '>= 2.13.0')
+
+  gem.add_dependency('paperclip', '>= 3.3.0')
+
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('generator_spec')
+  gem.add_development_dependency('railties')
+  gem.add_development_dependency('rails')
+end

data/lib/generators/kaleidoscope/kaleidoscope_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators/active_record'
+
+class KaleidoscopeGenerator < ActiveRecord::Generators::Base
+  desc "Create a migration to add kaleidoscope models."
+
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def generate_migration
+    migration_template "kaleidoscope_migration.rb.erb", "db/migrate/#{migration_file_name}"
+  end
+
+  protected
+    def migration_name
+      "create_#{name.underscore}_colors"
+    end
+
+    def migration_file_name
+      "#{migration_name}.rb"
+    end
+
+    def migration_class_name
+      migration_name.camelize
+    end
+end

data/lib/generators/kaleidoscope/templates/kaleidoscope_migration.rb.erb

@@ -0,0 +1,19 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :<%= name.underscore %>_colors do |t|
+      t.integer :<%= name.underscore %>_id
+      t.string :original_color
+      t.string :reference_color
+      t.float :frequency
+      t.integer :distance
+
+      t.timestamps
+    end
+
+    add_index :<%= name.underscore %>_colors, :<%= name.underscore %>_id
+    add_index :<%= name.underscore %>_colors, :original_color
+    add_index :<%= name.underscore %>_colors, :reference_color
+    add_index :<%= name.underscore %>_colors, :frequency
+    add_index :<%= name.underscore %>_colors, :distance
+  end
+end

data/lib/kaleidoscope.rb

@@ -0,0 +1,6 @@
+require 'RMagick'
+require 'kaleidoscope/version'
+
+module Kaleidoscope
+  # Your code goes here...
+end

data/lib/kaleidoscope/version.rb

@@ -0,0 +1,3 @@
+module Kaleidoscope
+  VERSION = "0.0.1"
+end

data/lib/tasks/kaleidoscope.rake

@@ -0,0 +1,18 @@
+module Kaleidoscope
+  module Task
+    def self.obtain_class
+      class_name = ENV['CLASS'] || ENV['class']
+      raise "Must specify CLASS" unless class_name
+      class_name
+    end
+  end
+end
+
+namespace :kaleidoscope do
+  desc "Refreshes color data."
+  task :refresh => ["kaleidoscope:refresh"]
+
+  namespace :refresh do
+    desc "Refreshes color data for a given CLASS."
+  end
+end

data/spec/generator_spec.rb

@@ -0,0 +1,50 @@
+require 'rails'
+require 'spec_helper'
+require 'generator_spec/test_case'
+require 'generators/kaleidoscope/kaleidoscope_generator'
+
+describe 'TestMigration' do
+  include GeneratorSpec::TestCase
+  tests KaleidoscopeGenerator
+  destination File.expand_path("../tmp", __FILE__)
+  arguments %w(photo)
+
+  before do
+    prepare_destination
+    run_generator
+  end
+
+  it 'Should create a correct migration file' do
+    assert_migration 'db/migrate/create_photo_colors' do |migration|
+      assert_match /class CreatePhotoColors/, migration
+
+      assert_method :change, migration do |change|
+        expected = <<MIGRATION
+          create_table :photo_colors do |t|
+            t.integer :photo_id
+            t.string :original_color
+            t.string :reference_color
+            t.float :frequency
+            t.integer :distance
+
+            t.timestamps
+          end
+
+          add_index :photo_colors, :photo_id
+          add_index :photo_colors, :original_color
+          add_index :photo_colors, :reference_color
+          add_index :photo_colors, :frequency
+          add_index :photo_colors, :distance
+MIGRATION
+
+        assert_equal expected.squish, change.squish
+      end
+    end
+  end
+
+  it 'Should not create the migration without required arguments' do
+    prepare_destination
+    silence_stream(STDERR) { run_generator %w() }
+    assert_no_migration 'db/migrate/create_photo_colors'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+
+require 'active_support'
+require 'active_support/core_ext'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: kaleidoscope
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josh Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Color search for Rails
+email:
+- joshdotsmith@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kaleidoscope.gemspec
+- lib/generators/kaleidoscope/kaleidoscope_generator.rb
+- lib/generators/kaleidoscope/templates/kaleidoscope_migration.rb.erb
+- lib/kaleidoscope.rb
+- lib/kaleidoscope/version.rb
+- lib/tasks/kaleidoscope.rake
+- spec/generator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/JoshSmith/kaleidoscope
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- ImageMagick
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Kaleidoscope is color search for Rails using Active Record and Paperclip.
+  The intent behind it was to index a database of images by color for quick retrieval.
+test_files:
+- spec/generator_spec.rb
+- spec/spec_helper.rb