tesseract_ffi 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b299b8e91905a54a81999730de02ae2dbf5ed58cf2bbf826854c178fd5f33296
-  data.tar.gz: 8906f6a6dd21011c076c8d785f6ac99e2297112831f829a924a32f3763b09713
+  metadata.gz: f462f5b13af429c30a228b4b3aeedb26af935c7caa7cff1752c7647a03a78d19
+  data.tar.gz: 14bb8f67addf6c8e3b6961d09e5ae0992830ddf32be048e1eae92fcefc958f57
 SHA512:
-  metadata.gz: 9d11f40349117f99080ba4d3eb7f75c4c3d44941c6a3e4aaeec71f22b0ac8e6bc0a361e89c6c657a3fd864853300112883c42162ee5af89f20b841a3cb91f544
-  data.tar.gz: cb2e721f373141bd6f42ef97ebd39257a6735c1b34e241739cdc4cfcdf5f0d7c6747ad95df3b6aa13b12e8a49115081dda447c708c5a6b64718d9dc57c739d2c
+  metadata.gz: 31feb442ee485aadd9f5df19029aba9d6991702cb4635f9842826661ee3d001c72c5cd633e2c8172018318921e95157c17adb4fe9d9ce8a88e7a13a9cb1c9add
+  data.tar.gz: 2e4371431e1b7d3f19dd5f40fe4e3d9237f7b1ce056b066a9d16b89070bfdbaf1cf80b5a8ec41003c4fb19ed065aedb956baa98ddfdbbcb1f6d33519fe53d1f8

data/Gemfile.lock

@@ -4,7 +4,7 @@ GEM
     awesome_print (1.8.0)
     docile (1.3.2)
     ffi (1.13.1)
-    hocr_reader (0.1.0)
+    hocr_reader (0.2.0)
       nokogiri (~> 1.10.10)
     mini_portile2 (2.4.0)
     minitest (5.14.1)
@@ -13,7 +13,7 @@ GEM
       mini_portile2 (~> 2.4.0)
     rake (13.0.1)
     rdoc (6.2.1)
-    simplecov (0.18.5)
+    simplecov (0.19.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)

data/Rakefile

@@ -19,6 +19,12 @@ Rake::TestTask.new(:test_units) do |test|
   test.verbose = true
 end
 
+Rake::TestTask.new(:bench) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/performance/*_bench.rb'
+  test.verbose = true
+end
+
 task :default => :test
 
 

data/lib/tesseract_ffi.rb

@@ -2,8 +2,9 @@
 
 require 'ffi'
 require 'tesseract_ffi/version'
-require 'tesseract_ffi/conf_vars' # mix-in to tesseract
-require 'tesseract_ffi/oem' # mix-in to tesseract
+require 'tesseract_ffi/conf_vars'   # mix-in to tesseract
+require 'tesseract_ffi/oem'         # mix-in to tesseract
+require 'tesseract_ffi/rectangles'  # mix-in to tesseract
 require 'tesseract_ffi/tesseract'
 require 'tesseract_ffi/tess_exception'
 require 'tesseract_ffi/quick'

data/lib/tesseract_ffi/rectangles.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module TesseractFFI
+  # module Rectangles mixin for recognizing text blocks defined by rectangles
+  module Rectangles
+    def set_rectangle(x_coord, y_coord, width, height)
+      tess_set_rectangle(@handle, x_coord, y_coord, width, height)
+    end
+
+    def recognize_rectangle(x_coord, y_coord, width, height)
+      setup do
+        set_rectangle(x_coord, y_coord, width, height)
+        ocr
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def recognize_rectangles(rectangle_list)
+      @texts = []
+      @rectangle_list = nil
+      if valid_rectangle_list? rectangle_list
+        @rectangle_list = rectangle_list
+        setup do
+          @rectangle_list.each do |r|
+            set_rectangle(r[0], r[1], r[2], r[3])
+            ocr
+            @texts << @utf8_text.strip
+          end
+        end
+      end
+      @texts
+    end
+
+    def valid_rectangle_list?(list)
+      if list.is_a?(Array) && list.all? { |r| valid_rectangle?(r) }
+        true
+      else
+        msg = 'Tess Error Argument must be a list'
+        # copy the error message as we are not going to Setup
+        @errors << msg
+        raise TessException.new(error_msg: msg)
+      end
+    end
+
+    def valid_rectangle?(rectangle)
+      if rectangle.is_a?(Array) &&
+         rectangle.length == 4 &&
+         rectangle.all? { |r| r.is_a?(Integer) }
+        true
+      else
+        msg = 'Tesseract Error Argument must be array of 4 Integer'
+        @errors << msg
+        raise TessException.new(error_msg: msg)
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/tesseract_ffi/tesseract.rb

@@ -6,22 +6,29 @@ module TesseractFFI
     include TesseractFFI
     include ConfVars
     include OEM
+    include Rectangles
 
     attr_accessor :language, :file_name, :source_resolution
     attr_reader :utf8_text, :hocr_text, :errors
 
     def initialize(file_name: nil, language: 'eng', source_resolution: 72, oem: DEFAULT)
-      @language = language
-      raise TessException.new(error_msg: 'file_name must be provided') unless file_name
-
-      raise TessException.new(error_msg: "File #{file_name} not found") unless File.exist? file_name
+      unless file_name.is_a?(String) && File.exist?(file_name)
+        log 'Error: Tesseract needs a file ' + (file_name || 'no name given')
+        raise TessException.new(error_msg: 'file_name must be provided')
+      end
 
       @file_name = file_name
+      @language = language
       @source_resolution = source_resolution
       @oem = oem
       @errors = []
     end
 
+    # just output to console
+    def log(msg)
+      puts msg
+    end
+
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def setup
       @handle = tess_create
@@ -37,6 +44,7 @@ module TesseractFFI
       yield # run the block for recognition etc
     rescue TessException => e
       @errors << "Tesseract Error #{e.error[:error_msg]}"
+      log @errors
       raise
     ensure
       tess_end(@handle)
@@ -48,9 +56,7 @@ module TesseractFFI
       tess_set_source_resolution(@handle, @source_resolution)
       raise TessException.new(error_msg: 'Recognition Error') if tess_recognize(@handle, 0) != 0
 
-      @utf8_text = ''
-      text = tess_get_utf8(@handle, 0)
-      @utf8_text = text.encode('UTF-8') if text
+      @utf8_text = tess_get_utf8(@handle, 0)
       @hocr_text = tess_get_hocr(@handle, 0)
     end
 
@@ -67,28 +73,5 @@ module TesseractFFI
         TesseractFFI.tess_process_pages(@handle, @file_name, nil, 5000, pdf_renderer)
       end
     end
-
-    def set_rectangle(x_coord, y_coord, width, height)
-      tess_set_rectangle(@handle, x_coord, y_coord, width, height)
-    end
-
-    def recognize_rectangle(x_coord, y_coord, width, height)
-      setup do
-        set_rectangle(x_coord, y_coord, width, height)
-        ocr
-      end
-    end
-
-    def recognize_rectangles(rectangle_list)
-      texts = []
-      setup do
-        rectangle_list.each do |r|
-          set_rectangle(r[0], r[1], r[2], r[3])
-          ocr
-          texts << @utf8_text.strip
-        end
-      end
-      texts
-    end
   end
 end

data/lib/tesseract_ffi/version.rb

@@ -2,5 +2,5 @@
 
 # module with version
 module TesseractFFI
-  VERSION = '0.2.0'
+  VERSION = '0.7.0'
 end

data/tesseract_ffi.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/tesseract_ffi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tesseract_ffi"
+  spec.version       = TesseractFFI::VERSION
+  spec.authors       = ["David Verrier"]
+  spec.email         = ["dverrier@gmail.com"]
+
+  spec.summary       = %q{This is a Ruby-wrapper around the Tesseract C-API.}
+  spec.description   = %q{This wrapper around the C-API allows use of the legacy modes of the recognition engine.}
+  spec.homepage      = "https://github.com/dverrier/tesseract_ffi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dverrier/tesseract_ffi"
+  spec.metadata["changelog_uri"] = "https://github.com/dverrier/tesseract_ffi"
+
+  # 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.add_dependency "ffi"
+
+  spec.add_development_dependency "minitest", "~> 5.14.1"
+  spec.add_development_dependency "mocha", "~> 1.11.2"
+  spec.add_development_dependency "simplecov", "~> 0.18.5"
+  spec.add_development_dependency "awesome_print", "> 1.8.0"
+  spec.add_development_dependency "nokogiri","> 1.10.10"
+
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tesseract_ffi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.0
 platform: ruby
 authors:
 - David Verrier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -121,9 +121,11 @@ files:
 - lib/tesseract_ffi/conf_vars.rb
 - lib/tesseract_ffi/oem.rb
 - lib/tesseract_ffi/quick.rb
+- lib/tesseract_ffi/rectangles.rb
 - lib/tesseract_ffi/tess_exception.rb
 - lib/tesseract_ffi/tesseract.rb
 - lib/tesseract_ffi/version.rb
+- tesseract_ffi.gemspec
 - tmp/keep.txt
 homepage: https://github.com/dverrier/tesseract_ffi
 licenses: