rtesseract 2.2.0 → 3.0.0

data/README.rdoc

@@ -1,156 +0,0 @@
-= rtesseract
-{<img src="https://badge.fury.io/rb/rtesseract.png" alt="Gem Version" />}[http://badge.fury.io/rb/rtesseract]
-{<img src="https://travis-ci.org/dannnylo/rtesseract.png?branch=master" alt="Build Status" />}[https://travis-ci.org/dannnylo/rtesseract]
-{<img src="https://coveralls.io/repos/dannnylo/rtesseract/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/dannnylo/rtesseract?branch=master]
-{<img src="https://codeclimate.com/github/dannnylo/rtesseract.png" />}[https://codeclimate.com/github/dannnylo/rtesseract]
-
-
-Ruby library for working with the Tesseract OCR.
-
-== REQUIREMENTS:
-
-To work properly rtesseract are needed:
-* Tesseract - Program
-* ImageMagick - Program
-* RMagick or mini_magick - Gem
-
-Atention: Version 1.0.0 works fine with Ruby 2.0 and tesseract 3.0 and lower versions of rtesseract works fine with Ruby 1.8 and tesseract 2.0.4.
-
-PDF support requires a newer version of tesseract, specifically V.3.03 or above.
-
-== EXAMPLE USAGE
-
-It's very simple to use rtesseract:
-
-=== CONVERT IMAGE TO STRING
-
-  image = RTesseract.new("my_image.jpg")
-  image.to_s # Getting the value
-
-=== CONVERT IMAGE TO SEARCHABLE PDF
-
-  image = RTesseract.new("my_image.jpg")
-  image.to_pdf  # Getting the pdf path
-  image.to_s    # Still can get the value only.
-  # ...
-  # some stuff
-  # ...
-  image.clean   # to delete file once finished
-
-This will preserve the image colors, pictures and structure in the generated pdf.
-
-=== CHANGE THE IMAGE
-
-  image = RTesseract.new("my_image.jpg")
-  image.source = "new_image.png"
-  image.to_s
-
-=== TRANSFORM THE IMAGE
-
-  image = RTesseract.read("my_image.jpg") do |img|
-    img = img.white_threshold(245)
-    img = img.quantize(256,Magick::GRAYColorspace)
-  end
-  image.to_s
-
-=== CONVERT PARTS OF IMAGE TO STRING
-
-  mix_block = RTesseract::Mixed.new("test.jpg") do |image|
-    image.area(28,  19, 25, 25)
-    image.area(180, 22, 20, 28)
-    image.area(218, 22, 24, 28)
-    image.area(248, 24, 22, 22)
-  end
-  mix_block.to_s
-
-  OR
-
-  mix_block = RTesseract::Mixed.new("test.jpg",{:areas => [
-    {:x => 28,  :y=>19, :w=>25, :h=>25 },
-    {:x => 180,  :y=>22, :w=>20, :h=>28},
-    {:x => 218,  :y=>22, :w=>24, :h=>28},
-    {:x => 248,  :y=>24, :w=>22, :h=>22}
-  ]})
-  mix_block.to_s
-
-=== OPTIONS
-
-Processors Options  (_Rmagick_ is default)
-
-  RTesseract.new("test.jpg", :processor => "mini_magick")
-
-  Note: For non process the image use NoneProcessor
-
-  RTesseract.new("test.jpg", :processor => "none")
-
-Or you can config default processor first:
-
-  RTesseract.configure do |config|
-    config.processor = "mini_magick"
-  end
-
-  RTesseract.new("test.jpg") # It will use mini_magick by default
-
-Language Options
-
-  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
-
-  RTesseract.new("test.jpg", options: :digits)  # Only digit recognition
-
-  OR
-
-  RTesseract.new("test.jpg", options: [:digits, :quiet])
-
-=== BOUNDING BOX: TO GET WORDS WITH THEIR POSITIONS
-
-  RTesseract::Box.new('test_words.png').words
-  # => [
-  #   {: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}
-  # ]
-
-== Contributing to rtesseract
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-
-== Links
-
-* Github - http://github.com/dannnylo/rtesseract
-* Rubygems - http://rubygems.org/gems/rtesseract
-
-== Copyright
-
-Copyright (c) 2014 Danilo Jeremias da Silva. See LICENSE.txt for
-further details.

data/VERSION

@@ -1 +0,0 @@
-2.2.0

data/lib/processors/mini_magick.rb

@@ -1,43 +0,0 @@
-# encoding: UTF-8
-# RTesseract class
-class RTesseract
-  # Processor Module
-  module Processor
-    # Add to rtesseract a image manipulation with MiniMagick
-    module MiniMagickProcessor
-      # Setup Processor
-      def self.setup
-        require 'mini_magick'
-      end
-
-      # Check if is this Processor
-      def self.a_name?(name)
-        %w(mini_magick MiniMagickProcessor).include?(name.to_s)
-      end
-
-      # Convert Image to Tiff
-      def self.image_to_tif(source, points = {})
-        tmp_file = Tempfile.new(['', '.tif'])
-        cat = source.is_a?(Pathname) ? read_with_processor(source.to_s) : source
-        cat.format('tif') do |c|
-          c.compress 'None'
-          c.alpha 'off' if MiniMagick.cli != :graphicsmagick
-        end
-        cat.crop("#{points[:w]}x#{points[:h]}+#{points[:x]}+#{points[:y]}") if points.is_a?(Hash) && points.values.compact != []
-        cat.alpha 'off' if MiniMagick.cli != :graphicsmagick
-        cat.write tmp_file.path.to_s
-        tmp_file
-      end
-
-      # Cast instance of image
-      def self.read_with_processor(path)
-        MiniMagick::Image.open(path.to_s)
-      end
-
-      # Check if is a MiniMagick image
-      def self.image?(object)
-        object.class == MiniMagick::Image
-      end
-    end
-  end
-end

data/lib/processors/none.rb

@@ -1,34 +0,0 @@
-# encoding: UTF-8
-# RTesseract class
-class RTesseract
-  # Processor Module
-  module Processor
-    # Add to rtesseract a image without manipulation
-    module NoneProcessor
-      # Setup Processor
-      def self.setup
-      end
-
-      # Check if is this Processor
-      def self.a_name?(name)
-        %w(none NoneProcessor).include?(name.to_s)
-      end
-
-      # Convert Image to Tiff
-      def self.image_to_tif(source, _points = {})
-        tmp_file = Tempfile.new(['', '.tif'])
-        tmp_file.write(read_with_processor(source))
-        tmp_file
-      end
-
-      # Cast instance of image
-      def self.read_with_processor(path)
-        File.read(path)
-      end
-
-      # Check if is a image
-      def self.image?(*)
-      end
-    end
-  end
-end

data/lib/processors/rmagick.rb

@@ -1,46 +0,0 @@
-# encoding: UTF-8
-# RTesseract class
-class RTesseract
-  # Processor Module
-  module Processor
-    # Add to rtesseract a image manipulation with RMagick
-    module RMagickProcessor
-      # Setup Processor
-      def self.setup
-        require 'rmagick'
-      rescue LoadError
-        # :nocov:
-        require 'RMagick'
-        # :nocov:
-      end
-
-      # Check if is this Processor
-      def self.a_name?(name)
-        %w(rmagick RMagickProcessor).include?(name.to_s)
-      end
-
-      # Convert Image to Tiff
-      def self.image_to_tif(source, points = {})
-        tmp_file = Tempfile.new(['', '.tif'])
-        cat = source.is_a?(Pathname) ? read_with_processor(source.to_s) : source
-        cat.crop!(points[:x], points[:y], points[:w], points[:h]) if points.is_a?(Hash) && points.values.compact != []
-        cat.alpha Magick::DeactivateAlphaChannel
-        cat.write(tmp_file.path.to_s) do
-          # self.depth = 16
-          self.compression = Magick::NoCompression
-        end
-        tmp_file
-      end
-
-      # Cast instance of image
-      def self.read_with_processor(path)
-        Magick::Image.read(path.to_s).first
-      end
-
-      # Check if is a RMagick image
-      def self.image?(object)
-        object.class == Magick::Image
-      end
-    end
-  end
-end

data/lib/rtesseract/blob.rb

@@ -1,34 +0,0 @@
-# Blob methods
-class RTesseract
-  # Read image from memory blob
-  def self.read(src = nil, options = {})
-    fail RTesseract::ImageNotSelectedError if src.nil?
-    processor = RTesseract::Processor.choose_processor!(options[:processor])
-    image = processor.read_with_processor(src.to_s)
-    yield(image)
-    object = RTesseract.new('', options).from_blob(image.to_blob)
-    object
-  end
-
-  # Read image from memory blob
-  def read
-    image = @processor.read_with_processor(@source.to_s)
-    new_image = yield(image)
-    from_blob(new_image.to_blob, File.extname(@source.to_s))
-    self
-  end
-
-  # Read image from memory blob
-  def from_blob(blob, ext = '')
-    blob_file = Tempfile.new(['blob', ext], encoding: 'ascii-8bit')
-    blob_file.binmode.write(blob)
-    blob_file.rewind
-    blob_file.flush
-    self.source = blob_file.path
-    convert
-    RTesseract::Utils.remove_files([blob_file])
-    self
-  rescue => error
-    raise RTesseract::ConversionError.new(error), error, caller
-  end
-end

data/lib/rtesseract/box_char.rb

@@ -1,31 +0,0 @@
-# encoding: UTF-8
-# RTesseract
-class RTesseract
-  # Class to read char positions from an image
-  class BoxChar < Box
-    def config_hook
-      @options['tessedit_create_boxfile'] = 1 # Split chars
-    end
-
-    alias_method :characters, :words
-
-    # Extension of file
-    def file_ext
-      '.box'
-    end
-
-    # Read the result file
-    def parse_file
-      File.read(file_with_ext).to_s
-    end
-
-    def convert_text
-      text_objects = []
-      parse_file.each_line do |line|
-        char, x_start, y_start, x_end, y_end, _word = line.split(' ')
-        text_objects << { char: char, x_start: x_start.to_i, y_start: y_start.to_i, x_end: x_end.to_i, y_end: y_end.to_i }
-      end
-      @value = text_objects
-    end
-  end
-end

data/lib/rtesseract/errors.rb

@@ -1,21 +0,0 @@
-# RTesseract
-class RTesseract
-  # Class of error with storage of normal errors
-  class ErrorWithMemory < StandardError
-    attr_accessor :old_error
-
-    def initialize(stored_error = nil)
-      @old_error = stored_error
-    end
-  end
-
-  class ConversionError < ErrorWithMemory; end
-  class ImageNotSelectedError < ErrorWithMemory; end
-  class TempFilesNotRemovedError < ErrorWithMemory; end
-  
-  class TesseractVersionError < StandardError 
-    def initialize 
-      super "Tesseract version is unknown or below 3.03 which is required for pdf output."
-    end
-  end
-end

data/lib/rtesseract/mixed.rb

@@ -1,54 +0,0 @@
-# encoding: UTF-8
-# RTesseract
-class RTesseract
-  # Class to read an image from specified areas
-  class Mixed
-    attr_reader :areas
-
-    def initialize(src = '', options = {})
-      @source  = Pathname.new src
-      @options = options
-      @value   = ''
-      @areas = options.delete(:areas) || []
-      yield self if block_given?
-    end
-
-    # Add areas
-    def area(points)
-      @value = ''
-      @areas << points
-    end
-
-    # Clear areas
-    def clear_areas
-      @areas = []
-    end
-
-    # Convert parts of image to string
-    def convert
-      @value = []
-      @areas.each_with_object(RTesseract.new(@source.to_s, @options.dup)) do |area, image|
-        image.crop!(area)
-        @value << image.to_s
-      end
-    rescue => error
-      raise RTesseract::ConversionError.new(error), error, caller
-    end
-
-    # Output value
-    def to_s
-      return @value if @value != ''
-      if @source.file?
-        convert
-        @value.join
-      else
-        fail RTesseract::ImageNotSelectedError.new(@source)
-      end
-    end
-
-    # Remove spaces and break-lines
-    def to_s_without_spaces
-      to_s.delete(' ').delete("\n").delete("\r")
-    end
-  end
-end

data/lib/rtesseract/processor.rb

@@ -1,19 +0,0 @@
-# RTesseract
-class RTesseract
-  # Processor managment
-  module Processor
-    # Return the processor
-    def self.choose_processor!(processor)
-      processor =
-      if RTesseract::Processor::MiniMagickProcessor.a_name?(processor.to_s)
-        MiniMagickProcessor
-      elsif RTesseract::Processor::NoneProcessor.a_name?(processor.to_s)
-        NoneProcessor
-      else
-        RMagickProcessor
-      end
-      processor.setup
-      processor
-    end
-  end
-end