dupe-magick 1.0.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tim Koopmans
+
+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.rdoc

@@ -0,0 +1,17 @@
+= dupe-magick
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Tim Koopmans. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dupe-magick"
+    gem.summary = %Q{Detect image duplicates with RMagick}
+    gem.description = %Q{If you need to look for duplicates which can't otherwise be found via md5 checksums e.g. images of different formats or slightly lossy, then this gem can compare or find duplicates based on euclidian distances between points in an 8x8x8 RGB vector cube.}
+    gem.email = "tim.koops@gmail.com"
+    gem.homepage = "http://github.com/90kts/dupe-magick"
+    gem.authors = ["Tim Koopmans"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # 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|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dupe-magick #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/dupes

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'dupe-magick'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: dupes [options]"
+  opts.separator ""
+  opts.separator "Specific options:"
+  opts.on("-s source-file", "--source-file", String, 
+  "Specify source file to base search on") do |s|
+    options[:source_file] = s || nil
+  end
+  opts.on("-t target-path", "--target-path", String, 
+    "Specify target path to conduct search in") do |t|
+      options[:target_path] = t
+  end              
+  end.parse!
+
+comparison = DupeMagick.new
+comparison.find_duplicates(options[:source_file], options[:target_path])

data/lib/dupe-magick.rb

@@ -0,0 +1,146 @@
+#!/usr/bin/env ruby 
+require 'RMagick'
+require 'progressbar'
+require 'base64'
+
+class DupeMagick
+
+  attr_accessor :source_vector, :target_vector, :source_cube, :target_cube, :distance
+
+  def compare_images(source, target, params)
+    source_image = process_image(source, params)
+    target_image = process_image(target, params)
+    @source_vector = create_vector_from_image(source_image)
+    @source_cube = create_cube_from_vector(@source_vector)
+    @target_vector = create_vector_from_image(target_image)
+    @target_cube = create_cube_from_vector(@target_vector)
+    @distance = calculate_euclidian_distance(@source_cube, @target_cube)
+    puts "Images are " + euclidian_plain_language(@distance) + ", score: " + @distance.to_i.to_s
+    @distance.to_i
+  end
+
+  def find_duplicates(source_file, target_path)
+    source_image = process_image(source_file, {:geometry => '8x8!'})
+    @source_vector = create_vector_from_image(source_image)
+    @source_cube = create_cube_from_vector(@source_vector)
+    files = files_in_directory(target_path)
+    files.each do |target|
+      target_image = process_image(target, {:geometry => '8x8!'})
+      @target_vector = create_vector_from_image(target_image)
+      @target_cube = create_cube_from_vector(@target_vector)
+      @distance = calculate_euclidian_distance(@source_cube, @target_cube)
+      puts "Images are " + euclidian_plain_language(@distance) + ", score: " + @distance.to_i.to_s
+    end
+  end
+
+  def serialize(obj)
+    # for storing image data as a blob in mysql etc
+    Base64.encode64(Marshal.dump(obj))
+  end
+
+  def deserialize(obj)
+    # for retrieving image data from a blob in mysql etc
+    Base64.decode64(Marshal.load(obj))
+  end
+
+  private
+
+  def read_image(file)
+    Magick::Image.read(file).first
+  end
+
+  def files_in_directory(path)
+    Dir[path]
+  end
+
+  def do_make_progress_bar (title, total)
+    ProgressBar.new(title, total)
+  end
+
+  def process_image(image, params)
+    # read image
+    image = read_image(image)
+
+    # normalize image
+    image = image.normalize
+   
+    # strip off 10% border 
+    image = image.excerpt((image.columns * 10/100).to_i, (image.rows * 10/100).to_i,
+      (image.columns * 90/100).to_i, (image.rows * 90/100).to_i)
+    
+    # optionally quantize image to 32 colours
+    image = image.quantize(32, Magick::RGBColorspace) if params[:quantize]
+    
+    # optionally blur image  
+    image = image.gaussian_blur(0.0, params[:blur_radius]) if params[:blur]
+    
+    # change geometry of image
+    image = image.change_geometry(params[:geometry]) { |cols, rows, img| img.resize!(cols, rows)}
+
+    image
+  end
+
+  def create_vector_from_image(image)
+    image.export_pixels(0, 0, image.columns, image.rows, "RGB")
+  end
+
+  def create_cube_from_vector(vector)
+    # create cube 8x8x8 for each channel
+    cube = Hash.new
+    cube[:r]  = Hash.new 0
+    cube[:g]  = Hash.new 0
+    cube[:b]  = Hash.new 0
+    array_mod(vector, 3, 0).each { |r| cube[:r][which_bin(r)] += 1 } 
+    array_mod(vector, 3, 1).each { |g| cube[:g][which_bin(g)] += 1 } 
+    array_mod(vector, 3, 2).each { |b| cube[:b][which_bin(b)] += 1 }
+    cube
+  end
+
+  def which_bin(channel)
+    case channel
+      when 0..8191      then 1
+      when 8192..16383  then 2
+      when 16384..24575 then 3
+      when 24576..32767 then 4
+      when 32768..40959 then 5
+      when 40960..49151 then 6
+      when 49152..57343 then 7
+      when 57344..65535 then 8
+    end
+  end
+
+  def array_mod(arr, mod, offset = 0)
+    arr.shift(offset)
+    out_arr = []
+    arr.each_with_index do |val, idx|
+      out_arr << val if idx % mod == 0
+    end
+    out_arr
+  end
+  
+  def calculate_euclidian_distance(source_cube, target_cube)
+    sum = Hash.new 0
+    1.upto(8) do |r|
+      1.upto(8) do |g|
+        1.upto(8) do |b|
+          sum[:r] += (target_cube[:r][r] - source_cube[:r][r])**2 
+          sum[:g] += (target_cube[:g][g] - source_cube[:g][g])**2 
+          sum[:b] += (target_cube[:b][b] - source_cube[:b][b])**2 
+        end
+      end
+    end
+    Math.sqrt(sum[:r] + sum[:g] + sum[:b])
+  end
+
+  def euclidian_plain_language(distance)
+    case distance
+      when 0       then "identical"
+      when 1..50   then "similar"
+      when 51..150 then "possibly similar"
+      else "different" 
+    end
+  end
+
+end
+
+

data/lib/progressbar.rb

@@ -0,0 +1,236 @@
+#
+# Ruby/ProgressBar - a text progress bar library
+#
+# Copyright (C) 2001-2005 Satoru Takabayashi <satoru@namazu.org>
+#     All rights reserved.
+#     This is free software with ABSOLUTELY NO WARRANTY.
+#
+# You can redistribute it and/or modify it under the terms
+# of Ruby's license.
+#
+
+class ProgressBar
+  VERSION = "0.9"
+
+  def initialize (title, total, out = STDERR)
+    @title = title
+    @total = total
+    @out = out
+    @terminal_width = 80
+    @bar_mark = "o"
+    @current = 0
+    @previous = 0
+    @finished_p = false
+    @start_time = Time.now
+    @previous_time = @start_time
+    @title_width = 14
+    @format = "%-#{@title_width}s %3d%% %s %s"
+    @format_arguments = [:title, :percentage, :bar, :stat]
+    clear
+    show
+  end
+  attr_reader   :title
+  attr_reader   :current
+  attr_reader   :total
+  attr_accessor :start_time
+
+  private
+  def fmt_bar
+    bar_width = do_percentage * @terminal_width / 100
+    sprintf("|%s%s|", 
+            @bar_mark * bar_width, 
+            " " *  (@terminal_width - bar_width))
+  end
+
+  def fmt_percentage
+    do_percentage
+  end
+
+  def fmt_stat
+    if @finished_p then elapsed else eta end
+  end
+
+  def fmt_stat_for_file_transfer
+    if @finished_p then 
+      sprintf("%s %s %s", bytes, transfer_rate, elapsed)
+    else 
+      sprintf("%s %s %s", bytes, transfer_rate, eta)
+    end
+  end
+
+  def fmt_title
+    @title[0,(@title_width - 1)] + ":"
+  end
+
+  def convert_bytes (bytes)
+    if bytes < 1024
+      sprintf("%6dB", bytes)
+    elsif bytes < 1024 * 1000 # 1000kb
+      sprintf("%5.1fKB", bytes.to_f / 1024)
+    elsif bytes < 1024 * 1024 * 1000  # 1000mb
+      sprintf("%5.1fMB", bytes.to_f / 1024 / 1024)
+    else
+      sprintf("%5.1fGB", bytes.to_f / 1024 / 1024 / 1024)
+    end
+  end
+
+  def transfer_rate
+    bytes_per_second = @current.to_f / (Time.now - @start_time)
+    sprintf("%s/s", convert_bytes(bytes_per_second))
+  end
+
+  def bytes
+    convert_bytes(@current)
+  end
+
+  def format_time (t)
+    t = t.to_i
+    sec = t % 60
+    min  = (t / 60) % 60
+    hour = t / 3600
+    sprintf("%02d:%02d:%02d", hour, min, sec);
+  end
+
+  # ETA stands for Estimated Time of Arrival.
+  def eta
+    if @current == 0
+      "ETA:  --:--:--"
+    else
+      elapsed = Time.now - @start_time
+      eta = elapsed * @total / @current - elapsed;
+      sprintf("ETA:  %s", format_time(eta))
+    end
+  end
+
+  def elapsed
+    elapsed = Time.now - @start_time
+    sprintf("Time: %s", format_time(elapsed))
+  end
+  
+  def eol
+    if @finished_p then "\n" else "\r" end
+  end
+
+  def do_percentage
+    if @total.zero?
+      100
+    else
+      @current  * 100 / @total
+    end
+  end
+
+  def get_width
+    # FIXME: I don't know how portable it is.
+    default_width = 80
+    begin
+      tiocgwinsz = 0x5413
+      data = [0, 0, 0, 0].pack("SSSS")
+      if @out.ioctl(tiocgwinsz, data) >= 0 then
+        rows, cols, xpixels, ypixels = data.unpack("SSSS")
+        if cols >= 0 then cols else default_width end
+      else
+        default_width
+      end
+    rescue Exception
+      default_width
+    end
+  end
+
+  def show
+    arguments = @format_arguments.map {|method| 
+      method = sprintf("fmt_%s", method)
+      send(method)
+    }
+    line = sprintf(@format, *arguments)
+
+    width = get_width
+    if line.length == width - 1 
+      @out.print(line + eol)
+      @out.flush
+    elsif line.length >= width
+      @terminal_width = [@terminal_width - (line.length - width + 1), 0].max
+      if @terminal_width == 0 then @out.print(line + eol) else show end
+    else # line.length < width - 1
+      @terminal_width += width - line.length + 1
+      show
+    end
+    @previous_time = Time.now
+  end
+
+  def show_if_needed
+    if @total.zero?
+      cur_percentage = 100
+      prev_percentage = 0
+    else
+      cur_percentage  = (@current  * 100 / @total).to_i
+      prev_percentage = (@previous * 100 / @total).to_i
+    end
+
+    # Use "!=" instead of ">" to support negative changes
+    if cur_percentage != prev_percentage || 
+        Time.now - @previous_time >= 1 || @finished_p
+      show
+    end
+  end
+
+  public
+  def clear
+    @out.print "\r"
+    @out.print(" " * (get_width - 1))
+    @out.print "\r"
+  end
+
+  def finish
+    @current = @total
+    @finished_p = true
+    show
+  end
+
+  def finished?
+    @finished_p
+  end
+
+  def file_transfer_mode
+    @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
+  end
+
+  def format= (format)
+    @format = format
+  end
+
+  def format_arguments= (arguments)
+    @format_arguments = arguments
+  end
+
+  def halt
+    @finished_p = true
+    show
+  end
+
+  def inc (step = 1)
+    @current += step
+    @current = @total if @current > @total
+    show_if_needed
+    @previous = @current
+  end
+
+  def set (count)
+    if count < 0 || count > @total
+      raise "invalid count: #{count} (total: #{@total})"
+    end
+    @current = count
+    show_if_needed
+    @previous = @current
+  end
+
+  def inspect
+    "#<ProgressBar:#{@current}/#{@total}>"
+  end
+end
+
+class ReversedProgressBar < ProgressBar
+  def do_percentage
+    100 - super
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dupe-magick'
+
+class Test::Unit::TestCase
+end

data/test/test_dupe-magick.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class TestDupeMagick < Test::Unit::TestCase
+  should "compare two identical images and return a euclidian distance of 0" do
+    comparison = DupeMagick.new
+    path = File.expand_path(File.dirname(__FILE__))
+    assert_equal 0, comparison.compare_images(
+      path + "/" + "images/first_wife.png", 
+      path + "/" + "images/second_wife.jpg", 
+      {
+        :geometry => '8x8!'
+      }
+    )
+  end
+
+  should "compare two possibly similar images and return a euclidian distance of 104" do
+    comparison = DupeMagick.new
+    path = File.expand_path(File.dirname(__FILE__))
+    assert_equal 104, comparison.compare_images(
+      path + "/" + "images/first_wife.png", 
+      path + "/" + "images/bright_wife.png", 
+      {
+        :geometry => '8x8!'
+      }
+    )
+  end
+
+  should "compare two different images and return a euclidian distance of 531" do
+    comparison = DupeMagick.new
+    path = File.expand_path(File.dirname(__FILE__))
+    assert_equal 531, comparison.compare_images(
+      path + "/" + "images/first_wife.png", 
+      path + "/" + "images/different.jpg", 
+      {
+        :geometry => '8x8!'
+      }
+    )
+  end
+
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: dupe-magick
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Koopmans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-15 00:00:00 +11:00
+default_executable: dupes
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: If you need to look for duplicates which can't otherwise be found via md5 checksums e.g. images of different formats or slightly lossy, then this gem can compare or find duplicates based on euclidian distances between points in an 8x8x8 RGB vector cube.
+email: tim.koops@gmail.com
+executables: 
+- dupes
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/dupes
+- lib/dupe-magick.rb
+- lib/progressbar.rb
+- test/helper.rb
+- test/images/bright_wife.png
+- test/images/dark_wife.png
+- test/images/different.jpg
+- test/images/first_wife.png
+- test/images/second_wife.jpg
+- test/images/third_wife.jpg
+- test/test_dupe-magick.rb
+has_rdoc: true
+homepage: http://github.com/90kts/dupe-magick
+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: Detect image duplicates with RMagick
+test_files: 
+- test/helper.rb
+- test/test_dupe-magick.rb