despeck 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 39b755a474307d4ace2641ee3d6b7202eda4c8d5
-  data.tar.gz: 5cf5487d284c2e113b7b46cb866dfeb318495a37
+SHA256:
+  metadata.gz: 33f1c6c61bd3033e7bea34a95f83bedf3286e1ef9e0740417bee7d0c437a047c
+  data.tar.gz: 480a0a0f4a4b6a4b7df8c037d7199fcd0cc6f90dc4a20384650f882bb35a4909
 SHA512:
-  metadata.gz: b1e9a14709e077d5607445f4c46cb66323e783ac80134f12e20cc4d2e67ea3bd8882009bba5bed20e23a843b90d789cc5f8fb5f51d60cc9d5fbb582b7ab57df2
-  data.tar.gz: 33912c0cc1999c1a652be4404819d3ae09c89677ddbdc64cf77fb993746cbc0dc82490587b8ee48959b263d7e7019d30189b901aacbea7ade497f633f52b51e3
+  metadata.gz: c6b0b6f1e086ea4bdbc697ed0ed204688e4306239de9ad909d812cc89d32bbfeada413b01240a574cd53640d28e4805feb163b3d93b73a88cc15626922e2561e
+  data.tar.gz: 4bd2a99f218bb7ffa9bc15bbb2be2810d22923973659446e664d2260a6b0d91ae1aaceeb2d755c996834c482f19dfdf6180f152818624c19d8b760f0a3696ac8

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,75 @@
+
+name: ubuntu
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+  pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
+
+jobs:
+  rspec:
+    name: Ubuntu RSpec [ruby-${{ matrix.ruby }}&libvips-${{ matrix.libvips_version }}]
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4', '2.3' ]
+        libvips_version: ['8.6.5', '8.7.4']
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            libvips_version: ['8.6.5', '8.7.4']
+            experimental: true
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Setup Deps Package
+      run: |
+        sudo apt-get install -y libexpat1-dev gettext liblcms2-dev \
+          libmagickwand-dev libopenexr-dev libcfitsio-dev libgif-dev \
+          libgs-dev libgsf-1-dev libmatio-dev libopenslide-dev liborc-0.4-dev \
+          libpango1.0-dev libpoppler-glib-dev librsvg2-dev \
+          libwebp-dev libfftw3-dev libglib2.0-dev tesseract-ocr \
+          tesseract-ocr-chi-sim imagemagick \
+          libxslt-dev libxml2-dev
+    - name: Cache libvips
+      uses: actions/cache@v2
+      with:
+        path: ~/vips
+        key: ${{ runner.os }}-${{matrix.libvips_version}}-vips-${{ hashFiles('**/install-vips.sh') }}
+    - name: Setup Libvips
+      run: |
+        export LIBVIPS_VERSION=${{matrix.libvips_version}}
+        bash install-vips.sh --without-python
+    - name: Update gems
+      run: |
+        export NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+        export PATH=$HOME/vips/bin:$PATH
+        export LD_LIBRARY_PATH=$HOME/vips/lib:$LD_LIBRARY_PATH
+        export PKG_CONFIG_PATH=$HOME/vips/lib/pkgconfig:$PKG_CONFIG_PATH
+        gem uninstall bundler
+        gem install bundler -v '~> 1.16'
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+        cat Gemfile.lock
+    - name: Run specs
+      run: |
+        export PATH=$HOME/vips/bin:$PATH
+        export LD_LIBRARY_PATH=$HOME/vips/lib:$LD_LIBRARY_PATH
+        export PKG_CONFIG_PATH=$HOME/vips/lib/pkgconfig:$PKG_CONFIG_PATH
+        bundle exec rake
+    - name: Rubocop
+      run: |
+        export PATH=$HOME/vips/bin:$PATH
+        export LD_LIBRARY_PATH=$HOME/vips/lib:$LD_LIBRARY_PATH
+        export PKG_CONFIG_PATH=$HOME/vips/lib/pkgconfig:$PKG_CONFIG_PATH
+        bundle exec rubocop

data/README.adoc

@@ -0,0 +1,196 @@
+image:https://github.com/despeck/despeck/workflows/ubuntu/badge.svg["Build status (Ubuntu)", link="https://github.com/despeck/despeck/actions?workflow=ubuntu"]
+image:https://badge.fury.io/rb/despeck.svg["Gem Version", link="https://badge.fury.io/rb/despeck"]
+
+= Despeck
+
+Remove unwanted stamps or watermarks from scanned images
+
+`despeck` is a Ruby gem that helps you remove unwanted stamps or watermarks from
+scanned images/PDFs, primarily prior to OCR.
+
+Its image processing operations are based on `libvips` via the
+https://github.com/jcupitt/ruby-vips[ruby-vips] Ruby-bindings.
+
+It can be used to:
+
+* detect uniform watermarks from a series of images,
+* output a watermark pattern file (image, mask) that describes a watermark pattern, and
+* remove a specified watermark pattern from input images regardless of the
+  location of the watermark on these images.
+
+Assumptions on input:
+
+* The input may be a single image, or a PDF of multiple pages of images.
+* In the case of multiple pages, not all pages may have the watermark.
+* The input images are assumed to be purely monochrome text-based.
+* The watermarks are colored. For example, if the watermark is a "`GREEN SQUARE PATTERN`", for all
+  the pages that contain this mark, `despeck` will attempt to detect this pattern
+  and remove them.
+
+== Installation
+
+=== General
+
+Install gem manually:
+
+[source,sh]
+----
+$ gem install despeck
+----
+
+Or add it to your `Gemfile`:
+
+[source,ruby]
+----
+gem 'despeck'
+----
+
+and then run `bundle install`
+
+=== OCR functions
+
+To be able to extract text via `despeck ocr` command, you'll need to install:
+
+* Tesseract (3.x)
+* ImageMagick (6.x)
+* Desired languages
+
+==== MacOS
+
+To install Tesseract itself (with all languages pre-installed):
+
+[source,sh]
+----
+$ brew install tesseract --all-languages
+----
+
+Or you can install Tesseract with some languages manually:
+
+[source,sh]
+----
+$ brew install tesseract
+$ mkdir -p ~/Downloads/tessdata
+$ cd ~/Downloads/tessdata
+$ wget https://github.com/tesseract-ocr/tessdata/raw/3.04.00/chi_sim.traineddata
+----
+
+To install ImageMagick:
+
+[source,sh]
+----
+$ brew install imagemagick@6
+$ echo 'export PATH="/usr/local/opt/imagemagick@6/bin:$PATH"' >> ~/.bash_profile
+$ export PKG_CONFIG_PATH=/usr/local/opt/imagemagick@6/lib/pkgconfig
+----
+
+The full list of languages trained data can be found here (note, they're different for different Tesseract versions):
+
+https://github.com/tesseract-ocr/tesseract/wiki/Data-Files#data-files-for-version-304305
+
+==== Ubuntu/Debian
+
+[source,sh]
+----
+$ apt-get install tesseract-ocr tesseract-ocr-chi-sim imagemagick
+----
+
+==== FAQ
+
+> **I'm getting the following error:**
+>
+> 'convert': No such file or directory @ rb_sysopen - /var/folders/2t/xmdrn2sd2lv2w49dv0zw9_q00000gp/T/1521805124.661379908.txt (RTesseract::ConversionError)
+
+
+*This error means you don't have the appropriate Tesseract language installed (or Tesseract is unable to find that language). See language installation instructions above.*
+
+
+
+== Usage (Command Line)
+
+Getting actual help:
+
+[source,sh]
+----
+# To show general help
+despeck -h
+despeck remove -h
+despeck ocr -h
+despeck despeck -h
+----
+
+=== All-in-one (aka Despeck)
+
+If you need to remove watermark and extract OCR text, you may want to use:
+
+[source,sh]
+----
+$ bundle exec despeck despeck -l chi_sim input.jpg
+----
+
+This is the same as two following commands:
+
+[source,sh]
+----
+$ bundle exec despeck remove input.jpg output.jpg
+$ bundle exec despeck ocr -l chi_sim output.jpg
+----
+
+=== Remove watermark
+
+To remove watermark:
+
+[source,sh]
+----
+$ despeck remove /path/to/input.jpg /path/to/output.jpg
+----
+
+With the command above, Despeck will try to find the watermark colour, and apply best filter settings to remove the watermark. It may be wrong, so you can pass several parameters to help Despeck with that:
+
+[source,sh]
+----
+$ despeck remove --color 00FF00 --sensitivity 120 --black-const -60 --add-contrast /path/to/input.pdf /path/to/output.pdf
+----
+
+A lit of available options:
+
+* `--color 00FF00` - to say watermark is ~ green.
+* `--sensitivity 120` - increases sensitivity (if with default 100 watermark is still visible).
+* `--black-const -60` - by default, Despeck tries to improve text quality by increasing black by -110. This may be too much for you, so you can reduce that number.
+* `--add-contrast` - disabled by default, increases output image's contrast.
+* `--accurate` - disabled by default. Applies filters to the area with watermark only, preserving the rest of the image untouched.
+* `--debug` - shows debug information during command execution.
+
+==== "Accurate" option
+
+By default, `despeck` applies colour filters to the entire image and tries to improve the quality of the image by increasing contrast and cleaning the image.
+
+It may decrease the original image quality in some cases, so there is the `--accurate` option, which forces `despeck` to apply `despeck` filters only to the area where watermark was found, leaving the rest of the image intact.
+
+For example:
+
+===== Original image
+
+image::readme_images/watermarked.jpg[Original image]
+
+===== Despecked with default options
+
+image::readme_images/defaults.jpg[Despecked with defaults]
+
+===== Despecked with --accurate option
+
+image::readme_images/accurate.jpg[Despecked with --accurate option]
+
+== Usage
+
+*(still under development)*
+
+[source,ruby]
+----
+wr = Despeck::WatermarkRemover.new(black_const: -90, resize: 0.01)
+# => #<Despeck::WatermarkRemover:0x007f935b5a1a68 @add_contrast=true, @black_const=-110, @watermark_color=nil, @resize=0.1, @sensitivity=100>
+image = Vips::Image.new_from_file("/path/to/image.jpg")
+# => #<Image 4816x6900 uchar, 3 bands, srgb>
+output_image = wr.remove_watermark(image)
+# => #<Image 4816x6900 float, 3 bands, b-w>
+output_image.write_to_file('/path/to/output.jpg')
+----

data/bin/console

@@ -1,6 +1,5 @@
-# frozen_string_literal: true
-
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'despeck'

data/despeck.gemspec

@@ -21,22 +21,20 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_dependency 'clamp', '~> 1.2'
+  spec.add_dependency 'clamp', '~> 1.3'
   spec.add_dependency 'pdf-reader', '~> 2.1'
-  spec.add_dependency 'prawn', '~> 2.2'
-  spec.add_dependency 'rmagick', '~> 2'
-  spec.add_dependency 'rtesseract', '~> 2.2'
+  spec.add_dependency 'prawn', '~> 2.3'
+  spec.add_dependency 'rmagick', '~> 4.0'
+  spec.add_dependency 'rtesseract', '~> 3.1'
   spec.add_dependency 'ruby-vips', '~> 2.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'rubocop', '~> 0.90.0'
 end

data/{bin → exe}/despeck

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'despeck'
-
+require 'despeck/installation_post_message'
+Despeck::InstallationPostMessage.build
 Despeck::CLI.run

data/install-vips.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 vips_site=https://github.com/jcupitt/libvips/releases/download
-version=$VIPS_VERSION_MAJOR.$VIPS_VERSION_MINOR.$VIPS_VERSION_MICRO
+version=$LIBVIPS_VERSION
 
 set -e
 
@@ -9,18 +9,23 @@ set -e
 # we could check the configure params as well I guess
 if [ -d "$HOME/vips/bin" ]; then
   installed_version=$($HOME/vips/bin/vips --version)
-  escaped_version="$VIPS_VERSION_MAJOR\.$VIPS_VERSION_MINOR\.$VIPS_VERSION_MICRO"
   echo "Need vips-$version"
   echo "Found $installed_version"
-  if [[ "$installed_version" =~ ^vips-$escaped_version ]]; then
+  if [[ "$installed_version" =~ ^vips-$version ]]; then
     echo "Using cached directory"
     exit 0
   fi
 fi
 
 rm -rf $HOME/vips
-wget $vips_site/v$version/vips-$version.tar.gz
+echo 'Downloading libvips source'
+wget $vips_site/v$version/vips-$version.tar.gz >/dev/null 2>&1
+echo 'Extracting'
 tar xf vips-$version.tar.gz
 cd vips-$version
-CXXFLAGS=-D_GLIBCXX_USE_CXX11_ABI=0 ./configure --prefix=$HOME/vips $*
-make && make install
+echo 'Configuring'
+CXXFLAGS=-D_GLIBCXX_USE_CXX11_ABI=0 ./configure --prefix=$HOME/vips $* >/dev/null 2>&1
+echo 'Make'
+make >/dev/null 2>&1
+echo 'Install'
+make install >/dev/null 2>&1

data/lib/commands/despeck_and_ocr.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Despeck
+  module Commands
+    # Subcommand that removes watermarks & returns OCR text
+    class DespeckAndOcr < Clamp::Command
+      parameter 'input_file', 'Input file - either PDF or image',
+                attribute_name: :input_file
+      option ['-l', '--lang'],
+             'LANGUAGE',
+             'One of supported Tesseract languages (`eng` by default)',
+             default: :eng
+
+      def execute
+        extension = File.extname(input_file)
+        temp_image = Tempfile.new(['despecked', extension])
+        `bundle exec despeck remove #{input_file} #{temp_image.path}`
+        input_image = temp_image.size.zero? ? input_file : temp_image.path
+        puts `bundle exec despeck ocr -l #{lang} #{input_image}`
+      end
+    end
+  end
+end

data/lib/commands/remove.rb

@@ -42,11 +42,11 @@ module Despeck
         Despeck.apply_logger_level(debug?)
 
         if input_file.end_with?('.pdf')
-          images =
-            PdfTools.pdf_to_images(input_file).map do |image|
-              remove_watermark_from_image(image, nil)
-            end
-          PdfTools.images_to_pdf(images, output_file)
+          origin_images = PdfTools.pdf_to_images(input_file)
+          images = origin_images.map do |image|
+            remove_watermark_from_image(image, nil)
+          end
+          PdfTools.images_to_pdf(images, output_file, origin_images)
         else
           remove_watermark_from_image(input_file, output_file)
         end
@@ -57,10 +57,10 @@ module Despeck
       def remove_watermark_from_image(input, output)
         wr =
           WatermarkRemover.new(
-            add_contrast:    add_contrast?,
-            accurate:        accurate?,
-            black_const:     black_const,
-            sensitivity:     sensitivity,
+            add_contrast: add_contrast?,
+            accurate: accurate?,
+            black_const: black_const,
+            sensitivity: sensitivity,
             watermark_color: color
           )
 

data/lib/despeck.rb

@@ -4,11 +4,11 @@ require 'clamp'
 require 'benchmark'
 require 'pdf-reader'
 require 'prawn'
-require 'pry'
 require 'vips'
 require 'rmagick'
 require 'rtesseract'
 
+require_relative 'commands/despeck_and_ocr'
 require_relative 'commands/remove'
 require_relative 'commands/ocr'
 

data/lib/despeck/cli.rb

@@ -8,6 +8,11 @@ module Despeck
       exit(0)
     end
 
+    subcommand(
+      'despeck',
+      'Extract text from the despecked image or pdf',
+      Despeck::Commands::DespeckAndOcr
+    )
     subcommand('remove', 'Remove watermark', Despeck::Commands::Remove)
     subcommand('ocr', 'Extract text from the image', Despeck::Commands::Ocr)
   end

data/lib/despeck/installation_post_message.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Despeck
+  # Print notes from the installation
+  module InstallationPostMessage
+    module_function
+
+    def build
+      if %w[1 true TRUE].include?(
+        ENV.fetch('DESPECK_SKIP_INSTALL_NOTES', false)
+      )
+        return
+      end
+
+      require 'vips'
+      return print_notes unless vips_check_passed?
+    end
+
+    def vips_support_pdf?
+      begin
+        Vips::Image.pdfload
+      rescue Vips::Error => e
+        if e.message =~ /class "pdfload" not found/
+          notes << <<~DOC
+            - Libvips installed without PDF support, make sure you
+              have PDFium/poppler-glib installed before installing
+              despeck. For more detail install instruction go to
+              this page https://libvips.github.io/libvips/install.html
+          DOC
+          return false
+        end
+      end
+      true
+    end
+
+    def vips_version_supported?
+      version_only = Vips.version_string.match(/(\d+\.\d+\.\d+)/)[0]
+      return true if version_only > '8.6.5'
+
+      notes << <<~DOC
+        - Your libvips version is should be minimal at 8.6.5
+          Please rebuild/reinstall your libvips to >= 8.6.5 .
+      DOC
+      false
+    end
+
+    def vips_check_passed?
+      passed = true
+      passed = false unless vips_version_supported?
+      passed = false unless vips_support_pdf?
+      passed
+    end
+
+    def notes
+      @notes ||= []
+    end
+
+    def print_notes
+      return if notes.empty?
+
+      puts <<~NOTES
+        #{hr '='}
+          Despeck Installation Notes :
+        #{hr '-'}
+        #{notes.uniq.join("\n")}
+          To Skip this notes `export DESPECK_SKIP_INSTALL_NOTES=1`
+        #{hr '='}
+      NOTES
+      @error_message = []
+      false
+    end
+
+    def hr(line = '-')
+      (line * 50)
+    end
+  end
+end

data/lib/despeck/ocr.rb

@@ -3,14 +3,36 @@
 module Despeck
   # Extracts text of desired language from the image
   class Ocr
-    attr_reader :lang, :image_path
+    attr_reader :lang, :source_path
 
-    def initialize(image)
-      @image_path = image
+    def initialize(path)
+      @source_path = path
     end
 
     def text(lang: :eng)
-      RTesseract.new(image_path, lang: lang).to_s
+      if source_path.end_with?('.pdf')
+        res = ''
+        for_each_page_image do |path|
+          res += RTesseract.new(path, lang: lang).to_s
+        end
+        res
+      else
+        RTesseract.new(source_path, lang: lang).to_s
+      end
+    end
+
+    private
+
+    def for_each_page_image
+      paths = []
+      Despeck::PdfTools
+        .pdf_to_images(source_path).each do |pic|
+          tempfile = Tempfile.new(['despeck_page', '.jpg'])
+          pic.write_to_file(tempfile.path)
+          yield tempfile.path
+        end
+
+      paths
     end
   end
 end

data/lib/despeck/pdf_tools.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'tempfile'
 
 module Despeck
   # Read/Write PDF files
@@ -15,16 +16,16 @@ module Despeck
         images
       end
 
-      def images_to_pdf(images, pdf_path)
+      def images_to_pdf(images, pdf_path, origin_images = [])
         doc = nil
 
-        for_each_image_file(images) do |path, page_size, pic_size, layout|
+        for_each_image_file(images,
+                            origin_images) do |path, pg_size, pic_size, layout|
           if doc
-            doc.start_new_page(size: page_size, layout: layout)
+            doc.start_new_page(size: pg_size, layout: layout)
           else
-            doc = Prawn::Document.new(page_size: page_size, page_layout: layout)
+            doc = Prawn::Document.new(page_size: pg_size, page_layout: layout)
           end
-
           doc.image(path, position: :left, vposition: :top, fit: pic_size)
         end
 
@@ -43,10 +44,11 @@ module Despeck
 
       private
 
-      def for_each_image_file(images)
-        images.each do |pic|
+      def for_each_image_file(images, origin_images)
+        images.each_with_index do |picture, i|
           tempfile = Tempfile.new(['despeck', '.jpg'])
-          pic.write_to_file(tempfile.path)
+          pic = picture || origin_images[i]
+          picture.write_to_file(tempfile.path)
 
           page_size = pdf_size(pic)
           layout = page_size.max == page_size.first ? :landscape : :portrait

data/lib/despeck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Despeck
-  VERSION = '0.3.0'
+  VERSION = '0.4.2'
 end

data/lib/despeck/watermark_remover.rb

@@ -50,9 +50,9 @@ module Despeck
 
       no_watermark = no_watermark.colourspace('b-w').bandjoin(mask.invert)
 
-      output_image
-        .bandjoin(mask)
-        .composite(no_watermark, 'over')
+      output_image = output_image.colourspace('srgb') if output_image.bands < 3
+      output_image = output_image.bandjoin(mask) if output_image.bands == 3
+      output_image.composite(no_watermark, 'over')
     end
 
     def __remove_watermark__(image)
@@ -86,7 +86,7 @@ module Despeck
     def grayscale_algorithm(image, pr_color)
       rgb_params = greyscale_params(pr_color)
       rgb_params << 0 if image.bands == 4
-      image.recomb(rgb_params)
+      image.recomb([rgb_params])
     end
 
     def greyscale_params(pr_color)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: despeck
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rmagick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rtesseract
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: ruby-vips
   requirement: !ruby/object:Gem::Requirement
@@ -96,20 +96,6 @@ dependencies:
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -128,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -156,40 +142,37 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 0.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 0.90.0
 description: Removes stamps and watermarks from scanned images for OCR, 'removes specks'
 email:
 - open.source@ribose.com
 executables:
-- console
 - despeck
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ubuntu.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- OCR.md
-- README.md
+- README.adoc
 - ROADMAP.adoc
 - Rakefile
 - bin/console
-- bin/despeck
 - bin/setup
 - despeck.gemspec
+- exe/despeck
 - install-vips.sh
+- lib/commands/despeck_and_ocr.rb
 - lib/commands/ocr.rb
 - lib/commands/remove.rb
 - lib/despeck.rb
@@ -197,12 +180,16 @@ files:
 - lib/despeck/colour_checker.rb
 - lib/despeck/dominant_color.rb
 - lib/despeck/dominant_color_v2.rb
+- lib/despeck/installation_post_message.rb
 - lib/despeck/logger.rb
 - lib/despeck/ocr.rb
 - lib/despeck/pdf_tools.rb
 - lib/despeck/version.rb
 - lib/despeck/watermark_mask.rb
 - lib/despeck/watermark_remover.rb
+- readme_images/accurate.jpg
+- readme_images/defaults.jpg
+- readme_images/watermarked.jpg
 - sensitivities.txt
 homepage: https://github.com/riboseinc/despeck
 licenses:
@@ -223,8 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Removes stamps and watermarks from scanned images for OCR, 'removes specks'

data/.ruby-version

@@ -1 +0,0 @@
-2.3.3

data/.travis.yml

@@ -1,58 +0,0 @@
-sudo: false
-
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-    - VIPS_VERSION_MAJOR=8
-    - VIPS_VERSION_MINOR=5
-    - VIPS_VERSION_MICRO=7
-    - PATH=$HOME/vips/bin:$PATH
-    - LD_LIBRARY_PATH=$HOME/vips/lib:$LD_LIBRARY_PATH
-    - PKG_CONFIG_PATH=$HOME/vips/lib/pkgconfig:$PKG_CONFIG_PATH
-
-dist: trusty
-
-addons:
-  apt:
-    packages:
-      - libexpat1-dev
-      - gettext
-      - liblcms2-dev
-      - libmagickwand-dev
-      - libopenexr-dev
-      - libcfitsio3-dev
-      - libgif-dev
-      - libgs-dev
-      - libgsf-1-dev
-      - libmatio-dev
-      - libopenslide-dev
-      - liborc-0.4-dev
-      - libpango1.0-dev
-      - libpoppler-glib-dev
-      - librsvg2-dev
-      - libwebp-dev
-        # missing on trusty, unfortunately
-        # - libwebpmux2
-      - libfftw3-dev
-      - libglib2.0-dev
-
-cache:
-  directories:
-    - $HOME/vips
-
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-
-script:
-  - bundle exec rspec spec
-  - bundle exec rubocop
-
-gemfile:
-  - Gemfile
-
-before_install:
-  - uname -a
-  - bash install-vips.sh --without-python

data/OCR.md

@@ -1,36 +0,0 @@
-# OCR with Despeck
-
-To make OCR work, you need to install the following tools:
-
-* Tesseract (version 3.x)
-* ImageMagick (version 6.x)
-
-## Installation
-
-### MacOS
-
-To install tesseract itself:
-
-```sh
-$ brew install tesseract --all-languages
-$ brew install imagemagick
-```
-
-Or you can install tesseract with some languages manually:
-
-```sh
-$ brew install tesseract wget imagemagick
-$ mkdir -p ~/Downloads/tessdata
-$ cd ~/Downloads/tessdata
-$ wget https://github.com/tesseract-ocr/tessdata/raw/3.04.00/chi_sim.traineddata
-```
-
-The full list of languages trained data can be found here (note, they're different for different Tesseract versions):
-
-https://github.com/tesseract-ocr/tesseract/wiki/Data-Files#data-files-for-version-304305
-
-### Ubuntu/Debian
-
-```sh
-$ apt-get install tesseract-ocr tesseract-ocr-chi-sim imagemagick
-```

data/README.md

@@ -1,96 +0,0 @@
-[![Gem Version](https://badge.fury.io/rb/despeck.svg)](https://badge.fury.io/rb/despeck)
-[![Build Status](https://travis-ci.org/riboseinc/despeck.svg?branch=master)](https://travis-ci.org/riboseinc/despeck)
-
-# Despeck
-
-Remove unwanted stamps or watermarks from scanned images
-
-`despeck` is a Ruby gem that helps you remove unwanted stamps or watermarks from
-scanned images/PDFs, primarily prior to OCR.
-
-Its image processing operations are based on libvips via the
-https://github.com/jcupitt/ruby-vips[ruby-vips] Ruby-bindings.
-
-It can be used to:
-
-* detect uniform watermarks from a series of images,
-* output a watermark pattern file (image, mask) that describes a watermark pattern, and
-* remove a specified watermark pattern from input images regardless of the
-  location of the watermark on these images.
-
-Assumptions on input:
-
-* The input may be a single image, or a PDF of multiple pages of images
-* In the case of multiple pages, not all pages may have the watermark
-* The input images are assumed to be purely monochrome text-based.
-* The watermarks are colored. For example, if the watermark is a GREEN SQUARE PATTERN, for all
-  the pages that contain this mark, despeck will attempt to detect this pattern
-  and remove them
-
-## Installation
-
-Install gem manually
-
-```
-$ gem install despeck
-```
-
-Or add it to your `Gemfile`
-
-```
-gem 'despeck'
-```
-
-and then run `bundle install`
-
-## OCR
-
-To be able to extract text via `despeck ocr` command, you'll need to install:
-
-* Tesseract (3.x)
-* ImageMagick (6.x)
-* Desired languages
-
-Installation instruction can be found here: [OCR tools installation guide](./OCR.md)
-
-## Usage (Command Line)
-
-Getting actual help:
-
-```sh
-# To show general help
-despeck -h
-despeck remove -h
-```
-
-To remove watermark:
-
-```sh
-$ despeck remove /path/to/input.jpg /path/to/output.jpg
-```
-
-With the command above, Despeck will try to find the watermark colour, and apply best filter settings to remove the watermark. It may be wrong, so you can pass several parameters to help Despeck with that:
-
-```sh
-$ despec remove --color 00FF00 --sensitivity 120 --black-const -60 --add-contrast /path/to/input.pdf /path/to/output.pdf
-```
-
-* `--color 00FF00` - to say watermark is ~ green.
-* `--sensitivity 120` - increases sensitivity (if with default 100 watermark is still visible).
-* `--black-const -60` - by default, Despeck tries to improve text quality by increasing black by -110. This may be too much for you, so you can reduce that number.
-* `--add-contrast` - disabled by default, increases output image's contrast.
-* `--accurate` - disabled by default. Applies filters to the area with watermark only, preserving the rest of the image untouched.
-
-## Usage
-
-*(still under development)*
-
-```ruby
-wr = Despeck::WatermarkRemover.new(black_const: -90, resize: 0.01)
-# => #<Despeck::WatermarkRemover:0x007f935b5a1a68 @add_contrast=true, @black_const=-110, @watermark_color=nil, @resize=0.1, @sensitivity=100>
-image = Vips::Image.new_from_file("/path/to/image.jpg")
-# => #<Image 4816x6900 uchar, 3 bands, srgb>
-output_image = wr.remove_watermark(image)
-# => #<Image 4816x6900 float, 3 bands, b-w>
-output_image.write_to_file('/path/to/output.jpg')
-```