ign-phashion 1.0.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.idea
+
+## PROJECT::SPECIFIC

data/CHANGES.md

@@ -0,0 +1,27 @@
+History
+=========
+
+1.0.3
+-------
+
+* Only add libjpeg to list of linked libraries when Ubuntu.
+
+1.0.2
+-------
+
+* Make installation much easier by distributing and building locally all the native dependencies.
+  This includes pHash 0.9.0 and CImg 1.3.4.
+
+1.0.1
+-------
+
+* Remove RubyInline, use standard Ruby extension infrastructure.
+* Update duplicate threshold constant based on wider image testing.
+* Make duplicate threshold variable so users can tune it based on their dataset.
+* Add Phashion::Image#fingerprint method which exposes an Image's 64-bit hash.
+
+
+1.0.0
+-------
+
+Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mike Perham
+
+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,40 @@
+Phashion
+===========
+
+Phashion is a Ruby wrapper around the pHash library, "perceptual hash", which detects duplicate
+and near duplicate multimedia files (images, audio, video).  The wrapper currently only supports images.
+
+[See an overview of Phashion on my blog](http://www.mikeperham.com/2010/05/21/detecting-duplicate-images-with-phashion/).
+
+Installation
+-------------
+
+You install it just like any other Ruby gem:
+
+    gem install phashion
+
+Phashion is somewhat involved to install as it has a few dependencies.  I've wrapped up those
+dependencies into a custom tarball that is built locally just for this gem so you don't have to
+do anything special.  See the code in `ext/phashion_ext` for more details.
+
+Because of this complexity, it is possible the gem install will fail on your platform.  I've tested
+it on Mac OSX 10.6 and Ubuntu 8.04 but please contact me if you have installation problems.
+
+Usage
+---------
+
+    require 'phashion'
+    img1 = Phashion::Image.new(filename1)
+    img2 = Phashion::Image.new(filename2)
+    img1.duplicate?(img2)
+    --> true
+
+Author
+==========
+
+Mike Perham, http://mikeperham.com, http://twitter.com/mperham, mperham AT gmail.com
+
+Copyright
+----------
+
+Copyright (c) 2010 Mike Perham. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ign-phashion"
+    gem.summary = %Q{Simple wrapper around the pHash library}
+    gem.description = gem.summary
+    gem.email = "mperham@gmail.com"
+    gem.homepage = "http://github.com/ign/phashion"
+    gem.authors = ["Mike Perham", "Bennett", "Thomas Nguyen"]
+    gem.add_development_dependency 'rake-compiler', '>= 0.7.0'
+    gem.version = '1.0.3'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "phashion"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+gem 'rake-compiler', '>= 0.7.0'
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new("phashion_ext")

data/TODO.md

@@ -0,0 +1,6 @@
+TODO
+=======
+
+- Add video and audio APIs (someone else will have to do this, I have no need for it).
+- Add broader support for the entire pHash API, include other types of hashes.  Currently
+  the image support hardcodes use of the DCT hash.

data/ext/phashion_ext/extconf.rb

@@ -0,0 +1,52 @@
+require 'mkmf'
+
+HERE = File.expand_path(File.dirname(__FILE__))
+BUNDLE = Dir.glob("#{HERE}/pHash-*.tar.gz").first
+BUNDLE_PATH = BUNDLE.gsub(".tar.gz", "")
+$CFLAGS = " -x c++ #{ENV["CFLAGS"]}"
+$includes = " -I#{HERE}/include"
+$libraries = " -L#{HERE}/lib"
+$LIBPATH = ["#{HERE}/lib"]
+$CFLAGS = "#{$includes} #{$libraries} #{$CFLAGS}"
+$LDFLAGS = "#{$libraries} #{$LDFLAGS}"
+
+Dir.chdir(HERE) do
+  if File.exist?("lib")
+    puts "pHash already built; run 'rake clean' first if you need to rebuild."
+  else
+
+    puts(cmd = "tar xzf #{BUNDLE} 2>&1")
+    raise "'#{cmd}' failed" unless system(cmd)
+
+    Dir.chdir(BUNDLE_PATH) do
+      puts(cmd = "env CFLAGS='#{$CFLAGS}' LDFLAGS='#{$LDFLAGS}' ./configure --prefix=#{HERE} --disable-audio-hash --disable-video-hash --disable-shared --with-pic 2>&1")
+      raise "'#{cmd}' failed" unless system(cmd)
+
+      puts(cmd = "make || true 2>&1")
+      raise "'#{cmd}' failed" unless system(cmd)
+
+      puts(cmd = "make install || true 2>&1")
+      raise "'#{cmd}' failed" unless system(cmd)
+
+      puts(cmd = "mv CImg.h ../include 2>&1")
+      raise "'#{cmd}' failed" unless system(cmd)
+    end
+
+    system("rm -rf #{BUNDLE_PATH}") unless ENV['DEBUG'] or ENV['DEV']
+  end
+
+  Dir.chdir("#{HERE}/lib") do
+    system("cp -f libpHash.a libpHash_gem.a")
+    system("cp -f libpHash.la libpHash_gem.la")
+  end
+  $LIBS = " -lpHash_gem -lstdc++"
+  case RUBY_PLATFORM
+    when /linux/
+      uname = `uname -a`
+      if uname =~ /Ubuntu/
+        $LIBS += " -ljpeg"
+      end
+  end
+end
+
+create_makefile 'phashion_ext'

data/ext/phashion_ext/phashion_ext.c

@@ -0,0 +1,35 @@
+#include "ruby.h"
+#include "pHash.h"
+
+static VALUE image_hash_for(VALUE self, VALUE _filename) {
+    char * filename = StringValuePtr(_filename);
+    ulong64 hash;
+    if (-1 == ph_dct_imagehash(filename, hash)) {
+      rb_raise(rb_eRuntimeError, "Unknown pHash error");
+    }
+    return ULL2NUM(hash);
+}
+
+
+static VALUE hamming_distance(VALUE self, VALUE a, VALUE b) {
+    int result = 0;
+    result = ph_hamming_distance(NUM2ULL(a), NUM2ULL(b));
+    if (-1 == result) {
+      rb_raise(rb_eRuntimeError, "Unknown pHash error");
+    }
+    return INT2NUM(result);
+}
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+  void Init_phashion_ext() {
+    VALUE c = rb_cObject;
+    c = rb_const_get(c, rb_intern("Phashion"));
+
+    rb_define_singleton_method(c, "hamming_distance", (VALUE(*)(ANYARGS))hamming_distance, 2);
+    rb_define_singleton_method(c, "image_hash_for", (VALUE(*)(ANYARGS))image_hash_for, 1);
+  }
+#ifdef __cplusplus
+}
+#endif

data/ign-phashion.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ign-phashion}
+  s.version = "1.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Perham", "Bennett", "Thomas Nguyen"]
+  s.date = %q{2010-12-14}
+  s.description = %q{Simple wrapper around the pHash library}
+  s.email = %q{mperham@gmail.com}
+  s.extensions = ["ext/phashion_ext/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGES.md",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "TODO.md",
+     "ext/phashion_ext/extconf.rb",
+     "ext/phashion_ext/pHash-0.9.0.tar.gz",
+     "ext/phashion_ext/phashion_ext.c",
+     "ign-phashion.gemspec",
+     "lib/phashion.rb",
+     "test/86x86-0a1e.jpeg",
+     "test/86x86-83d6.jpeg",
+     "test/86x86-a855.jpeg",
+     "test/avatar.jpg",
+     "test/b32aade8c590e2d776c24f35868f0c7a588f51e1.jpeg",
+     "test/df9cc82f5b32d7463f36620c61854fde9d939f7f.jpeg",
+     "test/e7397898a7e395c2524978a5e64de0efabf08290.jpeg",
+     "test/helper.rb",
+     "test/test_phashion.rb"
+  ]
+  s.homepage = %q{http://github.com/ign/phashion}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple wrapper around the pHash library}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_phashion.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake-compiler>, [">= 0.7.0"])
+    else
+      s.add_dependency(%q<rake-compiler>, [">= 0.7.0"])
+    end
+  else
+    s.add_dependency(%q<rake-compiler>, [">= 0.7.0"])
+  end
+end
+

data/lib/phashion.rb

@@ -0,0 +1,33 @@
+##
+# Provides a clean and simple API to detect duplicate image files using
+# the pHash library under the covers.
+#
+# The C API:
+# int ph_dct_imagehash(const char *file, ulong64 &hash);
+# int ph_hamming_distance(ulong64 hasha, ulong64 hashb);
+
+module Phashion
+  VERSION = '1.0.2'
+  
+  class Image
+    SETTINGS = {
+      :dupe_threshold => 15
+    }
+    
+    attr_reader :filename
+    def initialize(filename)
+      @filename = filename
+    end
+    
+    def duplicate?(other)
+      Phashion.hamming_distance(fingerprint, other.fingerprint) < SETTINGS[:dupe_threshold]
+    end
+    
+    def fingerprint
+      @hash ||= Phashion.image_hash_for(@filename)
+    end
+  end
+  
+end
+
+require 'phashion_ext'

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'test/unit'
+require 'phashion'
+
+class Test::Unit::TestCase
+end

data/test/test_phashion.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+class TestPhashion < Test::Unit::TestCase
+
+  def test_duplicate_detection
+    files = %w(86x86-0a1e.jpeg 86x86-83d6.jpeg 86x86-a855.jpeg)
+    images = files.map {|f| Phashion::Image.new("#{File.dirname(__FILE__) + '/../test/'}#{f}")}
+    assert_duplicate images[0], images[1]
+    assert_duplicate images[1], images[2]
+    assert_duplicate images[0], images[2]
+  end
+
+  def test_duplicate_detection_2
+    files = %w(b32aade8c590e2d776c24f35868f0c7a588f51e1.jpeg df9cc82f5b32d7463f36620c61854fde9d939f7f.jpeg e7397898a7e395c2524978a5e64de0efabf08290.jpeg)
+    images = files.map {|f| Phashion::Image.new("#{File.dirname(__FILE__) + '/../test/'}#{f}")}
+    assert_duplicate images[0], images[1]
+    assert_duplicate images[1], images[2]
+    assert_duplicate images[0], images[2]
+  end
+
+  def test_not_duplicate
+    files = %w(86x86-0a1e.jpeg 86x86-83d6.jpeg 86x86-a855.jpeg avatar.jpg)
+    images = files.map {|f| Phashion::Image.new("#{File.dirname(__FILE__) + '/../test/'}#{f}")}
+    assert_not_duplicate images[0], images[3]
+    assert_not_duplicate images[1], images[3]
+    assert_not_duplicate images[2], images[3]
+  end
+
+  private
+
+  def assert_duplicate(a, b)
+    assert a.duplicate?(b), "#{a.filename} not dupe of #{b.filename}"
+  end
+
+  def assert_not_duplicate(a, b)
+    assert !a.duplicate?(b), "#{a.filename} dupe of #{b.filename}"
+  end  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: ign-phashion
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 3
+  version: 1.0.3
+platform: ruby
+authors: 
+- Mike Perham
+- Bennett
+- Thomas Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-14 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 7
+        - 0
+        version: 0.7.0
+  type: :development
+  version_requirements: *id001
+description: Simple wrapper around the pHash library
+email: mperham@gmail.com
+executables: []
+
+extensions: 
+- ext/phashion_ext/extconf.rb
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- CHANGES.md
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- ext/phashion_ext/extconf.rb
+- ext/phashion_ext/pHash-0.9.0.tar.gz
+- ext/phashion_ext/phashion_ext.c
+- ign-phashion.gemspec
+- lib/phashion.rb
+- test/86x86-0a1e.jpeg
+- test/86x86-83d6.jpeg
+- test/86x86-a855.jpeg
+- test/avatar.jpg
+- test/b32aade8c590e2d776c24f35868f0c7a588f51e1.jpeg
+- test/df9cc82f5b32d7463f36620c61854fde9d939f7f.jpeg
+- test/e7397898a7e395c2524978a5e64de0efabf08290.jpeg
+- test/helper.rb
+- test/test_phashion.rb
+has_rdoc: true
+homepage: http://github.com/ign/phashion
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple wrapper around the pHash library
+test_files: 
+- test/helper.rb
+- test/test_phashion.rb