rtesseract 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: db992168bb87c6c4f3124403f9417c4cd46aca3e
-  data.tar.gz: b329a5ebc7316f28f63bcd7d84aa575cb661b3b9
+SHA256:
+  metadata.gz: 00e35fcd674159d47c7252be586ba214c42f374d1e671cab2ae8a47672237d92
+  data.tar.gz: e6601b67346092513af4399c49bb161b99afccb84f277395fe8f27417d2f61da
 SHA512:
-  metadata.gz: a74dc8fd03a678ecdff1425bc188173615da59b636cbe9ceb072353a1e4d3f2aa076b9787007ef9bfebb9c928e2a170d8c0149f864741c888c6d74ea04a78889
-  data.tar.gz: 97d3bfea1ae54841ce68427893e8e69fa358a3018ba80b8f06d23759abe0d89c81e481c5775699b3c0e98234fb39dfb898a42b833c48b8ac42128c7c7c292b88
+  metadata.gz: 92713fe105ad0b96ca28fc61f530c4dcfb8a6905aeb9d7206dfb951afab7f482e10b1ffc397f5d2e8cf86f9bd0a69be65e8da791ba0dd32655c29341bf0a67af
+  data.tar.gz: 4601e51dc96489292cfd0b54653f149bfcde9a830b3c3071ed2bc55778ab393405c267172ea06aa1e2ad3f64c615b845ba0aaf9a5317288555ee50e913bc196f

data/.document

@@ -1,5 +1,4 @@
 lib/**/*.rb
 bin/*
-- 
-features/**/*.feature
+-
 LICENSE.txt

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/coverage.data
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -1 +1,4 @@
+--format documentation
 --color
+--order rand
+--require spec_helper

data/.travis.yml

@@ -1,14 +1,16 @@
-sudo: required
-dist: trusty
+---
+
+sudo: false
+dist: bionic
 language: ruby
-addons:
-  apt:
-    packages:
-    - tesseract-ocr
+cache: bundler
+
+before_install:
+  - sudo add-apt-repository ppa:alex-p/tesseract-ocr -y
+  - sudo apt-get update -q
+  - sudo apt-get install tesseract-ocr tesseract-ocr-eng ghostscript -y
+  - gem install bundler -v 1.17.1
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.2
-  - 2.3.0
+  - 2.4.5
+  - 2.5.3

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 daniloj.dasilva@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,18 +1,6 @@
-source 'http://rubygems.org'
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-gem 'nokogiri'
+source "https://rubygems.org"
 
-group :development do
-  gem 'rspec'
-  gem 'rdoc'
-  gem 'bundler'
-  gem 'jeweler', '~> 2.1.1'
-  gem 'simplecov'
-  gem 'coveralls', require: false
-end
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-group :test do
-  gem 'rmagick'
-  gem 'mini_magick'
-end
+# Specify your gem's dependencies in rtesseract.gemspec
+gemspec

data/Gemfile.lock

@@ -1,98 +1,58 @@
+PATH
+  remote: .
+  specs:
+    rtesseract (3.0.0)
+      nokogiri
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    addressable (2.4.0)
-    builder (3.2.2)
-    coveralls (0.8.13)
-      json (~> 1.8)
-      simplecov (~> 0.11.0)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
-      tins (~> 1.6.0)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.3.0)
-    github_api (0.13.1)
-      addressable (~> 2.4.0)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      multi_json (>= 1.7.5, < 2.0)
-      oauth2
-    hashie (3.4.3)
-    highline (1.7.8)
-    jeweler (2.1.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-      semver
-    json (1.8.3)
-    jwt (1.5.1)
-    mini_magick (4.5.1)
-    mini_portile2 (2.0.0)
-    multi_json (1.11.2)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    oauth2 (1.1.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0, < 1.5.2)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    rack (1.6.4)
-    rake (11.1.2)
-    rdoc (4.2.2)
-      json (~> 1.4)
-    rmagick (2.15.4)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    json (2.1.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    semver (1.0.1)
-    simplecov (0.11.2)
-      docile (~> 1.1.0)
-      json (~> 1.8)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    term-ansicolor (1.3.2)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.0)
       tins (~> 1.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tins (1.6.0)
+    thor (0.19.4)
+    tins (1.20.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
+  bundler (~> 1.17)
   coveralls
-  jeweler (~> 2.1.1)
-  mini_magick
-  nokogiri
-  rdoc
-  rmagick
-  rspec
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rtesseract!
   simplecov
 
 BUNDLED WITH
-   1.11.2
+   1.17.2

data/LICENSE.txt

@@ -1,20 +1,21 @@
-Copyright (c) 2014 Danilo Jeremias da Silva
+The MIT License (MIT)
 
-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:
+Copyright (c) 2018 Danilo Jeremias da Silva
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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 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.
+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,137 @@
+# RTesseract
+
+<a href='http://badge.fury.io/rb/rtesseract'>
+    <img src="https://badge.fury.io/rb/rtesseract.png" alt="Gem Version" />
+</a>
+<a href='https://travis-ci.org/dannnylo/rtesseract'>
+    <img src="https://travis-ci.org/dannnylo/rtesseract.png?branch=master" alt="Build Status" />
+</a>
+<a href='https://coveralls.io/r/dannnylo/rtesseract?branch=master'>
+    <img src="https://coveralls.io/repos/dannnylo/rtesseract/badge.png?branch=master" alt="Coverage Status" />
+</a>
+<a href='https://codeclimate.com/github/dannnylo/rtesseract'>
+    <img src="https://codeclimate.com/github/dannnylo/rtesseract.png" />
+</a>
+
+Ruby library for working with the Tesseract OCR.
+
+## Installation
+
+Check if tesseract ocr programs is installed:
+
+    $ tesseract --version
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rtesseract'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rtesseract
+
+## Usage
+
+It's very simple to use rtesseract.
+
+### Convert image to string
+
+```ruby
+  image = RTesseract.new("my_image.jpg")
+  image.to_s # Getting the value
+```
+
+### Convert image to searchable PDF
+
+```ruby
+  image = RTesseract.new("my_image.jpg")
+  image.to_pdf  # Getting open file of pdf
+```
+
+### Convert image to TSV
+
+```ruby
+  image = RTesseract.new("my_image.jpg")
+  image.to_tsv  # Getting open file of pdf
+```
+
+This will preserve the image colors, pictures and structure in the generated pdf.
+
+## Options
+
+### Language
+
+    ```ruby
+        RTesseract.new('test.jpg', lang: 'deu')
+    ```
+
+    * eng   - English
+    * deu   - German
+    * deu-f - German fraktur
+    * fra   - French
+    * ita   - Italian
+    * nld   - Dutch
+    * por   - Portuguese
+    * spa   - Spanish
+    * vie   - Vietnamese
+    * or any other supported by tesseract.
+
+    Note: Make sure you have installed the language to tesseract
+
+### Other options
+
+  ```ruby
+    RTesseract.new('test.jpg', config_file: :digits)  # Only digit recognition
+  ```
+
+  OR
+
+  ```ruby
+    RTesseract.new('test.jpg', config_file: 'digits quiet')
+  ```
+
+### BOUNDING BOX: TO GET WORDS WITH THEIR POSITIONS
+  ```ruby
+    RTesseract.new('test_words.png').to_box
+  ```
+
+  # => [
+  #   {:word => 'If',  :x_start=>52, :y_start=>13, :x_end=>63, :y_end=>27},
+  #   {:word => 'you', :x_start=>69, :y_start=>17, :x_end=>100, :y_end=>31},
+  #   {:word => 'are', :x_start=>108, :y_start=>17, :x_end=>136, :y_end=>27},
+  #   {:word => 'a', :x_start=>143, :y_start=>17, :x_end=>151, :y_end=>27},
+  #   {:word => 'friend,', :x_start=>158, :y_start=>13, :x_end=>214, :y_end=>29},
+  #   {:word => 'you', :x_start=>51, :y_start=>39, :x_end=>82, :y_end=>53},
+  #   {:word => 'speak', :x_start=>90, :y_start=>35, :x_end=>140, :y_end=>53},
+  #   {:word => 'the', :x_start=>146, :y_start=>35, :x_end=>174, :y_end=>49},
+  #   {:word => 'password,', :x_start=>182, :y_start=>35, :x_end=>267, :y_end=>53},
+  #   {:word => 'and', :x_start=>51, :y_start=>57, :x_end=>81, :y_end=>71},
+  #   {:word => 'the', :x_start=>89, :y_start=>57, :x_end=>117, :y_end=>71},
+  #   {:word => 'doors', :x_start=>124, :y_start=>57, :x_end=>172, :y_end=>71},
+  #   {:word => 'will', :x_start=>180, :y_start=>57, :x_end=>208, :y_end=>71},
+  #   {:word => 'open.', :x_start=>216, :y_start=>61, :x_end=>263, :y_end=>75}
+  # ]
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/dannnylo/rtesseract. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Rtesseract project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dannnylo/rtesseract/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,50 +1,6 @@
-# encoding: utf-8
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
-  exit e.status_code
-end
-require 'rake'
+RSpec::Core::RakeTask.new(:spec)
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = 'rtesseract'
-  gem.homepage = 'http://github.com/dannnylo/rtesseract'
-  gem.license = 'MIT'
-  gem.summary = 'Ruby library for working with the Tesseract OCR.'
-  gem.description = 'Ruby library for working with the Tesseract OCR.'
-  gem.email = 'dannnylo@gmail.com'
-  gem.authors = ['Danilo Jeremias da Silva']
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-desc 'Code coverage detail'
-task :simplecov do
-  ENV['COVERAGE'] = 'true'
-  Rake::Task['spec'].execute
-end
-
-task default: :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ''
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rtesseract #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task :default => :spec

data/bin/console

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

@@ -1,73 +1,28 @@
-# encoding: UTF-8
 require 'nokogiri'
-require 'fileutils'
+require 'tmpdir'
 
-# RTesseract
 class RTesseract
-  # Class to read char positions from an image
-  class Box < RTesseract
-    # Setting value as blank array
-    def initialize_hook
-      @value = []
+  module Box
+    def self.temp_dir
+      @file_path = Pathname.new(Dir.tmpdir)
     end
 
-    # Aditional options to config file
-    def config_hook
-      @options['tessedit_create_hocr'] = 1 # Split Words configuration
-    end
-
-    # Words converted
-    def words
-      convert if @value == []
-      @value
-    end
-
-    # Extension of file
-    def file_ext
-      '.hocr'
-    end
-
-    # Read the result file
-    def parse_file
-      html = Nokogiri::HTML(File.read(file_with_ext))
-      html.css('span.ocrx_word, span.ocr_word')
-    end
-
-    # Return words to value
-    def convert_text
-      text_objects =  []
-      parse_file.each { |word| text_objects << BoxParser.new(word).to_h }
-      @value = text_objects
-    end
+    def self.run(source, options)
+      name = "rtesseract_#{SecureRandom.uuid}"
+      options.tessedit_create_hocr = 1
 
-    # Move file html to hocr
-    def after_convert_hook
-      FileUtils.mv(file_with_ext('.html'), file_with_ext) rescue nil
-    end
+      RTesseract::Command.new(source, temp_dir.join(name).to_s, options).run
 
-    # Output value
-    def to_s
-      return @value.map { |word| word[:word] } if @value != []
-      if @processor.image?(@source) || @source.file?
-        convert
-        @value.map { |word| word[:word] }.join(' ')
-      else
-        fail RTesseract::ImageNotSelectedError.new(@source)
-      end
+      parse(temp_dir.join("#{name}.hocr").read)
     end
 
-    # Parse word data from html.
-    class BoxParser
-      def initialize(word_html)
-        @word = word_html
-        title = @word.attributes['title'].value.to_s
-        @attributes = title.gsub(';', '').split(' ')
-      end
+    def self.parse(content)
+      html = Nokogiri::HTML(content)
+      html.css('span.ocrx_word, span.ocr_word').map do |word|
+        @attributes = word.attributes['title'].value.to_s.gsub(';', '').split(' ')
 
-      # Hash of word and position
-      def to_h
         {
-          word: @word.text,
+          word: word.text,
           x_start: @attributes[1].to_i,
           y_start: @attributes[2].to_i,
           x_end: @attributes[3].to_i,
@@ -76,4 +31,4 @@ class RTesseract
       end
     end
   end
-end
+end

data/lib/rtesseract/check.rb

@@ -0,0 +1,14 @@
+
+class RTesseract
+  class << self
+    def tesseract_version
+      Open3.capture2e(RTesseract.config.command, "--version").first.to_s.match(/\d+.\d+/)[0].to_f
+    rescue Errno::ENOENT
+      0
+    end
+
+    def check_version!
+      raise RTesseract::Error.new('Tesseract OCR 3.5 or later not installed') if RTesseract.tesseract_version < 3.05
+    end
+  end
+end