eikon 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36e8f745d6f84055279d0d9adf4b76a5b7e6648ce38734f2827731eea2645edf
+  data.tar.gz: 99f6ff6e356b12111e3727cd177f86394ec0b71152da5424a9abf070c4fb2fb5
+SHA512:
+  metadata.gz: 12b9fe397af70be1011ecbd5ef8496f92002000baa11d5c3d8bfb667788d55243e25faf87d6f5285b3b11be1d7754be8552f5cf35b75e3de941760cfdc2addb4
+  data.tar.gz: 355edc37cd034eed86209ad6ea97d2d58727997bc049ae278a3ebb9a40e490a6547a88e9bee8a53d278260298f49de6c7cd1a94d242713d87490081055af85b4

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1.1
+        bundler-cache: true
+    - name: Lint with Rubocop
+      run: bundle exec rubocop
+  type-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1.1
+        bundler-cache: true
+    - name: Type check with Sorbet
+      run: bundle exec srb tc --ignore "/vendor"

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.byebug_history
+
+test/videos/*

data/.rubocop.yml

@@ -0,0 +1,57 @@
+require:
+  - rubocop-rails
+  - rubocop-performance
+
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+AllCops:
+  Exclude:
+    - db/schema.rb
+    - 'node_modules/**/*'
+    - 'redis-stable/**/*'
+    - 'bin/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 3.1
+
+# This sets us to use the standard Rails format instead of Rubocop's
+# opinionated Ruby style.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# This sets us to use the standard Rails format instead of Rubocop's
+# opinionated Ruby style.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Temporarily turn this off
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Lint/RescueException:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: true
+
+Rails/HasAndBelongsToMany:
+  Enabled: true
+
+Style/NumericPredicate:
+  Enabled: true
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: 'never'
+
+# This sets us to use the standard Rails format instead of Rubocop's
+# opinionated Ruby style.
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: 'around'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cguess@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in eikón.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "ruby-vips"
+gem "byebug"
+gem "ruby_jard"
+
+gem "rubocop", "~> 1.27", require: false
+gem "rubocop-rails", require: false # Rails specific styles
+gem "rubocop-rails_config", require: false # More Rails stuff
+
+gem "sorbet-static-and-runtime"
+
+group :development do
+  gem "tapioca", require: false
+end
+
+gem "terrapin"

data/Gemfile.lock

@@ -0,0 +1,183 @@
+PATH
+  remote: .
+  specs:
+    eikon (0.1.1)
+      ruby-vips (~> 2.1)
+      sorbet-runtime (>= 0.5.9204)
+      terrapin (~> 0.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    climate_control (0.2.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    ffi (1.15.5)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.16.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    nokogiri (1.13.4)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    rbi (0.0.14)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.19.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-packaging (0.5.1)
+      rubocop (>= 0.89, < 2.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.14.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rails_config (1.9.2)
+      railties (>= 5.0)
+      rubocop (>= 1.25.1)
+      rubocop-ast (>= 1.0.1)
+      rubocop-minitest (~> 0.15)
+      rubocop-packaging (~> 0.5)
+      rubocop-performance (~> 1.11)
+      rubocop-rails (~> 2.0)
+    ruby-progressbar (1.11.0)
+    ruby-vips (2.1.4)
+      ffi (~> 1.12)
+    ruby_jard (0.3.1)
+      byebug (>= 9.1, < 12.0)
+      pry (~> 0.13.0)
+      tty-screen (~> 0.8.1)
+    sorbet (0.5.9905)
+      sorbet-static (= 0.5.9905)
+    sorbet-runtime (0.5.9905)
+    sorbet-static (0.5.9905-universal-darwin-14)
+    sorbet-static (0.5.9905-universal-darwin-15)
+    sorbet-static (0.5.9905-universal-darwin-16)
+    sorbet-static (0.5.9905-universal-darwin-17)
+    sorbet-static (0.5.9905-universal-darwin-18)
+    sorbet-static (0.5.9905-universal-darwin-19)
+    sorbet-static (0.5.9905-universal-darwin-20)
+    sorbet-static (0.5.9905-universal-darwin-21)
+    sorbet-static (0.5.9905-x86_64-linux)
+    sorbet-static-and-runtime (0.5.9905)
+      sorbet (= 0.5.9905)
+      sorbet-runtime (= 0.5.9905)
+    spoom (1.1.11)
+      sorbet (>= 0.5.9204)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    tapioca (0.7.1)
+      bundler (>= 1.17.3)
+      pry (>= 0.12.2)
+      rbi (~> 0.0.0, >= 0.0.14)
+      sorbet-runtime (>= 0.5.9204)
+      sorbet-static (>= 0.5.9204)
+      spoom (~> 1.1.0, >= 1.1.4)
+      thor (>= 1.2.0)
+      yard-sorbet
+    terrapin (0.6.0)
+      climate_control (>= 0.0.3, < 1.0)
+    thor (1.2.1)
+    tty-screen (0.8.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    unparser (0.6.5)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.6.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  eikon!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rubocop (~> 1.27)
+  rubocop-rails
+  rubocop-rails_config
+  ruby-vips
+  ruby_jard
+  sorbet-static-and-runtime
+  tapioca
+  terrapin
+
+BUNDLED WITH
+   2.3.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Christopher Guess
+
+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,54 @@
+# Eikón
+
+This is an implementation of the DHash image matching algorithm in pure Ruby, as described here
+https://www.hackerfactor.com/blog/?/archives/529-Kind-of-Like-That.html. Its main use is reverse
+image searching.
+
+This library is fully types in Sorbet.
+
+## Installation
+
+This gem requires [libvips](https://www.libvips.org) for image processing and [ffmpeg](https://ffmpeg.org) for video work. On MacOS you can install them using [HomeBrew](https://brew.sh) quite easily. On Linux your distro's package manager should have them. On Windows it's probably more difficult, but I don't have access to a machine to test that.
+
+Once both libraries are installed you can install the gem with one of the following methods:
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eikon'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install eikon
+
+## Usage
+
+To process a still image and get a DHash
+`Eikon.dhash_for_image("./test/images/00001.jpg")`
+
+To process a video and get an array of DHashes:
+`Eikon.dhash_for_video("./test/videos/pexels-ron-lach-7121125.mp4")`
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/eikon. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/eikon/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Eikon project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/eikon/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eikon"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/eikon.gemspec

@@ -0,0 +1,34 @@
+require_relative "lib/eikon/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "eikon"
+  spec.version       = Eikon::VERSION
+  spec.authors       = ["Christopher Guess"]
+  spec.email         = ["cguess@gmail.com"]
+
+  spec.summary       = "A small pure-Ruby (for now) implementation of DHash"
+  spec.description   = "A small pure-Ruby (for now) implementation of DHash"
+  spec.homepage      = "https://www.github.com/cguess/eikon"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.github.com/cguess/eikon"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "ruby-vips", "~> 2.1"
+  spec.add_runtime_dependency "terrapin", "~> 0.6.0"
+  spec.add_runtime_dependency "sorbet-runtime", ">= 0.5.9204"
+end

data/lib/eikon/comparator.rb

@@ -0,0 +1,17 @@
+# typed: strict
+require "sorbet-runtime"
+
+module Eikon
+  class Comparator
+    extend T::Sig
+    sig { params(dhash_1: String, dhash_2: String).returns(Integer) }
+    def self.compare(dhash_1, dhash_2)
+      hamming_distance = 0
+      dhash_1.chars.each_with_index do |character, index|
+        hamming_distance += 1 if character != dhash_2.chars[index]
+      end
+
+      hamming_distance + (dhash_1.length - dhash_2.length).abs
+    end
+  end
+end

data/lib/eikon/image_processor.rb

@@ -0,0 +1,48 @@
+# typed: strict
+require "sorbet-runtime"
+
+module Eikon
+  class ImageProcessor
+    # This is an implementation of the algorithm described at http://hackerfactor.com/blog/index.php?/archives/529-Kind-of-Like-That.html
+
+    extend T::Sig
+
+    sig { returns(String) }
+    attr_reader :byte_array
+
+    sig { returns(String) }
+    attr_reader :filename
+
+    sig { params(filename: String).void }
+    def initialize(filename)
+      @filename = filename
+      @image = T.let(Vips::Image.new_from_file(filename), Vips::Image)
+      @byte_array = T.let("", String)
+    end
+
+    sig { returns(NilClass) }
+    def preprocess_image
+      # Black and white
+      @image = T.unsafe(@image).colourspace "b-w"
+      # For some reason thumbnail is only created via a buffer, so we save one quick
+      image_buffer = @image.write_to_buffer ".tiff"
+      # shrink image
+      @image = T.unsafe(Vips::Image).thumbnail_buffer(image_buffer, 9, height: 8, size: :force)
+      image_buffer = @image.write_to_buffer ".tiff"
+      @image = Vips::Image.new_from_buffer(image_buffer, "")
+
+      nil
+    end
+
+    sig { returns(NilClass) }
+    def generate_byte_array
+      for y in  0..7 do
+        for x in 0..7 do
+          @byte_array += T.unsafe(@image).getpoint(x, y)[0] < T.unsafe(@image).getpoint((x + 1), y)[0] ? "1" : "0"
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/eikon/version.rb

@@ -0,0 +1,4 @@
+# typed: true
+module Eikon
+  VERSION = "0.1.1".freeze
+end