phashion 1.0.1 → 1.0.2

data/CHANGES.md

@@ -1,6 +1,12 @@
 History
 =========
 
+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
 -------
 

data/README.md

@@ -4,37 +4,21 @@ 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
 -------------
 
-First you need to install pHash.  pHash requires three libraries: CImg, ffmpeg and libjpeg.  My system already came with libjpeg on it so I didn't have to do anything for it.  YMMV.
-
-Install CImg.h by downloading the latest version from http://cimg.sf.net and placing the CImg.h header file in /usr/local/include.
-
-If you are working with audio or video, you will need to install ffmpeg:
-
-    port install ffmpeg (OR)
-    brew install ffmpeg
-
-Alternatively you can configure pHash to not support audio/video:
+You install it just like any other Ruby gem:
 
-    ./configure --disable-audio-hash --disable-video-hash
+gem install phashion
 
-Download and install the latest pHash tarball from http://phash.org/download/.  With 0.9.0, there are several issues with OSX: I had to disable audio and video support to avoid compilation issues and modify `ph_num_threads` in pHash.cpp to avoid Linux-specific code:
+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.
 
-    ./configure --disable-audio-hash --disable-video-hash
-    
-    int ph_num_threads()
-    {
-    	int numCPU = 2;
-    	return numCPU;
-    }
-
-Finally, run `make && make install` to install the pHash binaries.
-
-Now you can install this gem:
-
-    gem install phashion
+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
 ---------
@@ -45,14 +29,6 @@ Usage
     img1.duplicate?(img2)
     --> true
 
-Left to the reader: add equality semantics so that duplicate images placed in a Ruby set are automatically removed:
-
-    set = Set.new
-    set << img1
-    set << img2
-    set.size
-    --> 1
-
 Author
 ==========
 

data/Rakefile

@@ -11,7 +11,7 @@ begin
     gem.homepage = "http://github.com/mperham/phashion"
     gem.authors = ["Mike Perham"]
     gem.add_development_dependency 'rake-compiler', '>= 0.7.0'
-    gem.version = '1.0.1'
+    gem.version = '1.0.2'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/ext/phashion_ext/extconf.rb

@@ -1,13 +1,45 @@
 require 'mkmf'
 
-$CFLAGS << " -x c++ #{ENV["CFLAGS"]}"
-$LIBS << " -lpHash #{ENV["LIBS"]}"
+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}"
 
-# TODO: need to figure this stuff out
-# dir_config 'pHash'
-# if !have_library('pHash', 'ph_dct_imagehash')
-#   puts "Unable to find pHash library, please use 'gem install phashion -- --with-pHash-dir=/phash/install/root'"
-#   exit 1
-# end
+Dir.chdir(HERE) do
+  if File.exist?("lib")
+    puts "pHash already built; run 'rake clean' first if you need to rebuild."
+  else
 
-create_makefile('phashion_ext')
+    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"
+end
+
+create_makefile 'phashion_ext'

data/lib/phashion.rb

@@ -1,5 +1,3 @@
-require 'rubygems'
-
 ##
 # Provides a clean and simple API to detect duplicate image files using
 # the pHash library under the covers.
@@ -9,7 +7,7 @@ require 'rubygems'
 # int ph_hamming_distance(ulong64 hasha, ulong64 hashb);
 
 module Phashion
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
   
   class Image
     SETTINGS = {

data/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{phashion}
+  s.version = "1.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Perham"]
+  s.date = %q{2010-06-04}
+  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",
+     "lib/phashion.rb",
+     "phashion.gemspec",
+     "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/mperham/phashion}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  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::RubyGemsVersion) >= 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/test/test_phashion.rb

@@ -10,6 +10,14 @@ class TestPhashion < Test::Unit::TestCase
     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}")}
@@ -21,10 +29,10 @@ class TestPhashion < Test::Unit::TestCase
   private
 
   def assert_duplicate(a, b)
-    raise ArgumentError, "#{a.filename} not dupe of #{b.filename}" unless a.duplicate?(b)
+    assert a.duplicate?(b), "#{a.filename} not dupe of #{b.filename}"
   end
 
   def assert_not_duplicate(a, b)
-    raise ArgumentError, "#{a.filename} dupe of #{b.filename}" if a.duplicate?(b)
+    assert !a.duplicate?(b), "#{a.filename} dupe of #{b.filename}"
   end  
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Mike Perham
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-20 00:00:00 -05:00
+date: 2010-06-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,12 +49,17 @@ files:
 - Rakefile
 - TODO.md
 - ext/phashion_ext/extconf.rb
+- ext/phashion_ext/pHash-0.9.0.tar.gz
 - ext/phashion_ext/phashion_ext.c
 - lib/phashion.rb
+- phashion.gemspec
 - 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