image_hash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 829b739c1d457b27adc2ee184e6710395337bcd09bc410c9c639cb0840e92ca4
+  data.tar.gz: 59c137349c9e38fbb5523f68d7c7c5d1d5bb52b10658490f9e6d7d5d0ae6674a
+SHA512:
+  metadata.gz: 1ab3c4104284087f016c564053a61b4b332c752787bfabd31996c1e253985319a115845b26db12c796cddb12648b6facdd23fad2a3344c4d5d8103b53c49d126
+  data.tar.gz: 3f18bdda87c9b612527584f0bfd660819688f9923878f8ad0e89dbef6385f4c321b38f9ab9bb1a56736009f97661c6ea92d511d256b36dde094c8153c4b0753e

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+.rspec_status
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in image_hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tim Morgan
+
+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,49 @@
+# ImageHash
+
+This is a very simple Ruby library for calculating a perceptual hash of any image using ImageMagick.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'image_hash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install image_hash
+
+## Usage
+
+Create a new ImageHash instance, passing in the path to your image. Use the `#hash` method
+to get a compact hexadecimal hash representing the image:
+
+```ruby
+ImageHash.new('image1.jpg').hash        # => fce000101834b692
+ImageHash.new('image2.jpg').hash        # => fce000101834b693
+```
+
+If you would rather, you can get the binary hash with `#binary_hash`:
+
+```ruby
+ImageHash.new('image1.jpg').binary_hash # => 1111110011100000000000000001000000011000001101001011011010010010
+ImageHash.new('image2.jpg').binary_hash # => 1111110011100000000000000001000000011000001101001011011010010011
+```
+
+Easily compare two hashes using the `.distance` method:
+
+```ruby
+ImageHash.distance(
+  ImageHash.new('image1.jpg').hash,
+  ImageHash.new('image2.jpg').hash
+) # => 1
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/image_hash.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'image_hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'image_hash'
+  spec.version       = ImageHash::VERSION
+  spec.authors       = ['Tim Morgan']
+  spec.email         = ['tim@timmorgan.org']
+
+  spec.summary       = 'a simple perceptual hash library for images'
+  spec.description   = 'generate a perceptual hash of any image using ImageMagick and a very simple algorithm'
+  spec.homepage      = 'https://github.com/seven1m/image_hash_ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mini_magick'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/image_hash.rb

@@ -0,0 +1,80 @@
+require 'image_hash/version'
+require 'mini_magick'
+
+class ImageHash
+  def initialize(path)
+    @path = path
+  end
+
+  def binary_hash
+    binary.join
+  end
+
+  def hash
+    self.class.binary_to_hex(binary_hash)
+  end
+
+  def binary
+    scale_down
+    desaturate
+    pixels.map { |v| v > average_value ? 1 : 0 }
+  end
+
+  class << self
+    def hex_to_binary(hex)
+      nums = hex.each_char.each_slice(2)
+      bin_values = nums.map { |s| s.join.to_i(16).to_s(2).rjust(8, '0') }
+      bin_values.join
+    end
+
+    def binary_to_hex(binary)
+      bits = binary.each_char.map(&:to_i).each_slice(8)
+      hex_values = bits.map { |s| s.join.to_i(2).to_s(16).rjust(2, '0') }
+      hex_values.join
+    end
+
+    def binary_distance(s1, s2)
+      diffs = s1.each_char.zip(s2.each_char).map do |c1, c2|
+        c1 == c2 ? 0 : 1
+      end
+      diffs.inject(&:+)
+    end
+
+    def distance(s1, s2)
+      binary_distance(hex_to_binary(s1), hex_to_binary(s2))
+    end
+  end
+
+  private
+
+  def scale_down
+    image.resize('8x8!')
+  end
+
+  def desaturate
+    image.format('jpg', 0, colorspace: 'Gray')
+  end
+
+  def image
+    @image ||= MiniMagick::Image.open(@path)
+  end
+
+  def pixels
+    @pixels ||= image.get_pixels.flat_map do |row|
+      row.map { |r, g, b| rgb_to_value(r, g, b) }
+    end
+  end
+
+  def average_value
+    @average_value ||= pixels.inject(&:+) / pixels.size
+  end
+
+  def rgb_to_value(r, g, b)
+    r /= 255.0
+    g /= 255.0
+    b /= 255.0
+    max = [r, g, b].max
+    min = [r, g, b].min
+    (max + min) / 2.0
+  end
+end

data/lib/image_hash/version.rb

@@ -0,0 +1,3 @@
+class ImageHash
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: image_hash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: generate a perceptual hash of any image using ImageMagick and a very
+  simple algorithm
+email:
+- tim@timmorgan.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- image_hash.gemspec
+- lib/image_hash.rb
+- lib/image_hash/version.rb
+homepage: https://github.com/seven1m/image_hash_ruby
+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.7.6
+signing_key: 
+specification_version: 4
+summary: a simple perceptual hash library for images
+test_files: []