shear 0.1.1

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v0.1.0
+
+* Initial release.
+
+### v0.1.1
+
+* Fix runtime dependencies.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shear.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,173 @@
+PATH
+  remote: .
+  specs:
+    shear (0.1.1)
+      activesupport (>= 4.2)
+      faraday (~> 0.17)
+      faraday_middleware (~> 0.14)
+      google-cloud-vision (~> 1.0)
+      patron (~> 0.6)
+      rake (>= 10, < 14)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.14.0)
+      faraday (>= 0.7.4, < 1.0)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    gapic-common (0.3.4)
+      google-protobuf (~> 3.12, >= 3.12.2)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      googleapis-common-protos-types (>= 1.0.4, < 2.0)
+      googleauth (~> 0.9)
+      grpc (~> 1.25)
+    google-cloud-core (1.5.0)
+      google-cloud-env (~> 1.0)
+      google-cloud-errors (~> 1.0)
+    google-cloud-env (1.3.3)
+      faraday (>= 0.17.3, < 2.0)
+    google-cloud-errors (1.0.1)
+    google-cloud-vision (1.0.0)
+      google-cloud-core (~> 1.5)
+      google-cloud-vision-v1 (~> 0.0)
+      google-cloud-vision-v1p3beta1 (~> 0.0)
+    google-cloud-vision-v1 (0.2.5)
+      gapic-common (~> 0.3)
+      google-cloud-errors (~> 1.0)
+    google-cloud-vision-v1p3beta1 (0.2.5)
+      gapic-common (~> 0.3)
+      google-cloud-errors (~> 1.0)
+    google-protobuf (3.12.4)
+    googleapis-common-protos (1.3.10)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos-types (>= 1.0.5, < 2.0)
+      grpc (~> 1.27)
+    googleapis-common-protos-types (1.0.5)
+      google-protobuf (~> 3.11)
+    googleauth (0.13.1)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.14)
+    grpc (1.30.2)
+      google-protobuf (~> 3.12)
+      googleapis-common-protos-types (~> 1.0)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    json (2.3.1)
+    jwt (2.2.1)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.7)
+    memoist (0.16.2)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    os (1.1.1)
+    patron (0.13.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    shellany (0.0.1)
+    signet (0.14.0)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tins (1.25.0)
+      sync
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  coveralls (~> 0.8)
+  guard-rspec (~> 4.7)
+  pry (~> 0.13)
+  rspec (~> 3.4)
+  shear!
+  webmock (~> 3.8)
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2020 Buda.com SpA
+
+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,45 @@
+# Shear
+
+A tool used to extract data from a given structured document image
+
+## Installation
+
+```bash
+$ gem install shear
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem "shear"
+```
+
+```bash
+bundle install
+```
+
+## Usage
+
+You can check the [wiki](https://github.com/budacom/shear/wiki) to learn how to use Shear.
+
+## Demo
+
+Check the [official shear-demo](https://shear-demo.herokuapp.com/) for a live example of shear. Also check the demo's code on the [shear-demo repository](https://github.com/budacom/shear-demo).
+
+## Testing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+This gem was created by [Antonio López](https://github.com/alopez7) and [Buda.com SpA](https://www.buda.com/).
+
+Shear is maintained by [Buda.com SpA](https://www.buda.com/).
+
+## License
+
+Shear is a free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shear"
+
+# 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

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/lib/shear.rb

@@ -0,0 +1,13 @@
+require 'shear/bounding_box_utils'
+require 'shear/template'
+require 'shear/template_match'
+require "shear/version"
+require 'shear/word_collection'
+require 'utils/vision_utils'
+require 'stencils/base_stencil'
+require 'stencils/example_back_stencil'
+require 'stencils/example_front_stencil'
+require 'stencils/stencil_group'
+
+module Shear
+end

data/lib/shear/bounding_box_utils.rb

@@ -0,0 +1,64 @@
+module Shear
+  module BoundingBoxUtils
+    extend self
+
+    def vertex_in_aabb?(aabb, vertex)
+      return false if vertex[0] < aabb[:min][0]
+      return false if vertex[0] > aabb[:max][0]
+      return false if vertex[1] < aabb[:min][1]
+      return false if vertex[1] > aabb[:max][1]
+
+      true
+    end
+
+    def edges_touch?(edge1, edge2) # rubocop:disable AbcSize, MethodLength
+      ax = edge1[0][0].to_f
+      ay = edge1[0][1].to_f
+      bx = edge1[1][0].to_f
+      by = edge1[1][1].to_f
+
+      cx = edge2[0][0].to_f
+      cy = edge2[0][1].to_f
+      dx = edge2[1][0].to_f
+      dy = edge2[1][1].to_f
+
+      return false if ((cx - dx) * (ay - by) - (cy - dy) * (ax - bx)).zero?
+
+      alpha_numerator = (by - dy) * (cx - dx) - (bx - dx) * (cy - dy)
+      alpha = alpha_numerator / ((ax - bx) * (cy - dy) - (ay - by) * (cx - dx))
+      beta_numerator = (dy - by) * (ax - bx) - (dx - bx) * (ay - by)
+      beta = beta_numerator / ((cx - dx) * (ay - by) - (cy - dy) * (ax - bx))
+
+      return false if alpha.negative? || alpha > 1
+      return false if beta.negative? || beta > 1
+
+      true
+    end
+
+    def collides?(aabb, box) # rubocop:disable AbcSize
+      # Checks if one point of the box is inside the aabb or if edges touch
+      # Ignores case when aabb is inside box since is highly unprobable
+
+      box.each { |vertex| return true if vertex_in_aabb?(aabb, vertex) }
+
+      box.each_index do |vertex1|
+        vertex2 = (vertex1 + 1) % 4
+        edge1 = [box[vertex1], box[vertex2]]
+
+        edge2 = [aabb[:min], [aabb[:min][0], aabb[:max][1]]]
+        return true if edges_touch?(edge1, edge2)
+
+        edge2 = [aabb[:min], [aabb[:max][0], aabb[:min][1]]]
+        return true if edges_touch?(edge1, edge2)
+
+        edge2 = [aabb[:max], [aabb[:max][0], aabb[:min][1]]]
+        return true if edges_touch?(edge1, edge2)
+
+        edge2 = [aabb[:max], [aabb[:min][0], aabb[:max][1]]]
+        return true if edges_touch?(edge1, edge2)
+      end
+
+      false
+    end
+  end
+end

data/lib/shear/template.rb

@@ -0,0 +1,187 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+module Shear
+  class Template
+    def self.build(&_block)
+      template = new
+      _block.call(template)
+      template.seal
+      template
+    end
+
+    attr_reader :sealed, :fixtures, :exclusions
+
+    def initialize
+      @sealed = false
+      @fixtures = []
+      @exclusions = {}
+    end
+
+    def set(_word, at: nil, label: nil, filter: nil)
+      raise 'template sealed' if @sealed
+
+      @fixtures << [_word, at, label, filter]
+    end
+
+    def set_exclusion(_field_name, _excluded_word)
+      raise 'template sealed' if @sealed
+
+      @exclusions[_field_name] = Set[] if !@exclusions.include?(_field_name)
+      @exclusions[_field_name] << I18n.transliterate(_excluded_word).upcase
+    end
+
+    def get_exclusions(_field_name)
+      @exclusions.include?(_field_name) ? @exclusions[_field_name] : Set[]
+    end
+
+    def seal
+      @sealed = true
+    end
+
+    def match(_word_collection)
+      filtered_words_collection = filter_words(_word_collection)
+      return nil if should_discard_stencil?(filtered_words_collection.words)
+
+      recursive_match(filtered_words_collection, [], 0)
+    end
+
+    private
+
+    def should_discard_stencil?(_words)
+      return true if should_discard_stencil_by_discard_fixture?(_words)
+      return true if should_discard_stencil_by_unique_fixture?(_words)
+
+      false
+    end
+
+    def should_discard_stencil_by_discard_fixture?(_words)
+      discard_fixtures_tl =
+        @fixtures
+        .select { |f| f[3] == 'discard' }
+        .map { |f| I18n.transliterate(f[0]).upcase }
+      return true if _words.any? { |w| discard_fixtures_tl.include? w[:tl_word] }
+
+      false
+    end
+
+    def should_discard_stencil_by_unique_fixture?(_words)
+      unique_fixtures_tl =
+        @fixtures.select { |f| f[3] == 'unique' }.map { |f| I18n.transliterate(f[0]).upcase }
+      unique_fixture_words =
+        _words.map { |w| w[:tl_word] }.select { |tl_w| unique_fixtures_tl.include? tl_w }
+      return true if unique_fixture_words.uniq.length != unique_fixture_words.length
+
+      false
+    end
+
+    def filter_words(_word_collection)
+      filtered_words = reject_words_with_duplicate_bounding_box(_word_collection.words)
+      filtered_words = select_big_words_with_larger_bounding_box(filtered_words)
+      filtered_words = select_words_with_high_confidence(filtered_words)
+      WordCollection.new(filtered_words)
+    end
+
+    def reject_words_with_duplicate_bounding_box(_words)
+      _words.uniq { |w| [w[:original_bounding_box], w[:tl_word]] }
+    end
+
+    def select_big_words_with_larger_bounding_box(_words)
+      big_fixtures_tl =
+        @fixtures.select { |f| f[3] == 'big' }.map { |f| I18n.transliterate(f[0]).upcase }
+      big_fixture_words = _words.select { |w| big_fixtures_tl.include? w[:tl_word] }
+      non_big_fixture_words = _words - big_fixture_words
+      filtered_big_words =
+        big_fixture_words
+        .sort_by { |w| distance(w[:original_bounding_box][0], w[:original_bounding_box][1]) }
+        .reverse
+        .uniq { |w| w[:tl_word] }
+      non_big_fixture_words + filtered_big_words
+    end
+
+    def select_words_with_high_confidence(_words)
+      confidence_fixtures_tl =
+        @fixtures.select { |f| f[3] == 'confidence' }.map { |f| I18n.transliterate(f[0]).upcase }
+      confidence_fixture_words = _words.select { |w| confidence_fixtures_tl.include? w[:tl_word] }
+      non_confidence_fixture_words = _words - confidence_fixture_words
+      filtered_confidence_words =
+        confidence_fixture_words
+        .sort_by { |w| w[:conf] }
+        .reverse
+        .uniq { |w| w[:tl_word] }
+      non_confidence_fixture_words + filtered_confidence_words
+    end
+
+    def recursive_match(_words, _result, _fixture_index) # rubocop:disable all
+      word_indexes = []
+      while word_indexes.empty?
+        return calculate_match(_words, _result) if _fixture_index == @fixtures.length
+
+        word, _, _, word_filter = @fixtures[_fixture_index]
+        word_indexes = _words.search(word)
+        _fixture_index += 1 if word_indexes.empty? || word_filter == 'discard'
+      end
+      return calculate_match(_words, _result) if _fixture_index == @fixtures.length
+
+      word_indexes.inject(nil) do |best_match, word_index|
+        new_result = _result + [[word_index, _fixture_index]]
+        match = recursive_match(_words, new_result, _fixture_index + 1)
+        next match if best_match.nil?
+        next best_match if match.nil?
+
+        match.error < best_match.error ? match : best_match
+      end
+    end
+
+    def calculate_match(_words, _result) # rubocop:disable AbcSize, MethodLength
+      # select 3 points and calculate transformation matrix (solve T for W * T = F)
+
+      return nil if _result.length <= 3
+
+      word_loc1 = _words.original_location(_result.first[0]) + [1]
+      word_loc2 = _words.original_location(_result.second[0]) + [1]
+      word_loc3 = _words.original_location(_result.third[0]) + [1]
+
+      matrix_w = Matrix[word_loc1, word_loc2, word_loc3]
+      matrix_f = Matrix[
+        @fixtures[_result.first[1]][1] + [1],
+        @fixtures[_result.second[1]][1] + [1],
+        @fixtures[_result.third[1]][1] + [1]
+      ]
+
+      raise "Found locations are collinear" if matrix_w.singular?
+
+      transform = (matrix_w.inverse * matrix_f).transpose
+
+      # transform collection
+
+      norm_words = _words.clone.transform! transform
+
+      # calculate error mean(distance_from_fixture ^ 2)
+
+      errors = _result[3..-1].each.map do |index_pair|
+        distance(norm_words.location(index_pair[0]), @fixtures[index_pair[1]][1])
+      end
+
+      TemplateMatch.new(
+        load_labeled_points(_result, norm_words), norm_words, mean_sq_error(errors), transform
+      )
+    end
+
+    def load_labeled_points(_result, _words)
+      Hash[_result.each.map do |index_pair|
+        fixture_label = @fixtures[index_pair[1]][2]
+        word_location = _words.location(index_pair[0])
+        [fixture_label, word_location] if fixture_label
+      end.reject(&:nil?)]
+    end
+
+    def distance(_pt1, _pt2)
+      Math.sqrt((_pt2[0].to_d - _pt1[0])**2 + (_pt2[1].to_d - _pt1[1])**2)
+    end
+
+    def mean_sq_error(_errors)
+      _errors.sum { |e| e * e } / _errors.count
+    end
+  end
+end