Phash

Phashion replacement without native extension (however it currently relies on libvips). Compatible with pHash 0.9.6.

Requirements

• libvips (see requirements for ruby-vips)
• Ruby 3.0.0 or later

Installation

bundle add phash-rb

If bundler is not being used to manage dependencies, install the gem by executing:

gem install phash-rb

Usage

If you're using Phashion replace Phashion::Image with Phash::Image.

Public interface is the same as Phashion::Image.

require 'phash'

img1 = Phash::Image.new(filename1)
img2 = Phash::Image.new(filename2)
img1.duplicate?(img2) # true

Optionally, you can set the minimum Hamming distance in the second argument, an options Hash:

img1.duplicate?(img2, threshold: 5) # true

img1.duplicate?(img2, threshold: 0) # false

We also support the fingerprint method for storing Phash fingerprints in the database.

require 'phash'

Phash::Image.new(filename1).fingerprint # 3714852948054213970

Fingerprint is also available in a command phash:

$ phash test/fixtures/test.jpg
3714852948054213970

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/khasinski/phash-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Phash project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.