libera 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc099d4ec4b7e794ee9fcd8dbd057a1ccd04467c
+  data.tar.gz: 42e414654cab1579bdaad82e5fe6d70f97b0fd7a
+SHA512:
+  metadata.gz: 5e4e80f572b7e2bc9ac1febedd14693a956d818aa0ec999d486e11f74813df1029a2eaeed846c36d4fb7951d57c2c0981e50b6a9393c1daaa86b3114a504dd3f
+  data.tar.gz: d7bb316456adfd50f29e19c28eee08051c6bc2439ac41b98a6f550ee37031528ad89724225e20f6b5a424ea12c208dd9f0f9ada4ec035aff6e4999dc13c986c4

data/.gitignore

@@ -0,0 +1,24 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+.vagrant
+Vagrantfile
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in libera.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    libera (1.0.0)
+      fileutils (~> 1.0.2)
+      nokogiri (~> 1.8.2)
+      om (~> 3.1.1)
+      pdf-reader (~> 2.1.0)
+      rmagick (~> 2.16.0)
+      rtesseract (~> 2.2.0)
+      ruby-progressbar (~> 1.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.0.3)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    afm (0.2.2)
+    concurrent-ruby (1.0.5)
+    daemons (1.2.6)
+    diff-lcs (1.3)
+    fileutils (1.0.2)
+    hashery (2.1.2)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    om (3.1.1)
+      activemodel
+      activesupport
+      nokogiri (>= 1.4.2)
+      solrizer (~> 3.3)
+    pdf-reader (2.1.0)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    rake (10.5.0)
+    rmagick (2.16.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rtesseract (2.2.0)
+      nokogiri
+    ruby-progressbar (1.9.0)
+    ruby-rc4 (0.1.5)
+    solrizer (3.4.1)
+      activesupport
+      daemons
+      nokogiri
+      stomp
+      xml-simple
+    stomp (1.4.4)
+    thread_safe (0.3.6)
+    ttfunk (1.5.1)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    xml-simple (1.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  libera!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,52 @@
+# Libera
+
+Libera is a gem built for Charon - https://github.com/NEU-Libraries/charon - a digital humanities focused Samvera head.
+
+It's purpose is to take PDF files as input, and split them apart into individual page images for OCR and TEI generation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'libera'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install libera
+
+## Usage
+
+To use this gem at the command-line:
+
+```
+libera -p ./input.pdf
+```
+
+There are several adjustable parameters;
+
+* -p | --pdf_location (no default)
+* -w | --working_directory (default is a unique directory made in the directory you run libera)
+* -d | --density (default is 300)
+* -q | --quality (default is 100)
+* -f | --format_type (default is PNG)
+* -h | --help
+
+## 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/NEU-Libraries/libera.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+require 'libera'
+require 'optparse'
+require 'ruby-progressbar'
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: libera COMMAND [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "Commands"
+  opt.separator  "     pdf_location: pdf_location ./input.pdf"
+  opt.separator  "     working_dir: /tmp"
+  opt.separator  "     density: 300"
+  opt.separator  "     quality: 100"
+  opt.separator  "     format_type: png"
+  opt.separator  ""
+  opt.separator  "Options"
+  
+  opt.on("-p","--pdf_location PATH","What is the path to the PDF input file?") do |pdf_location|
+    Libera.configuration.pdf_location = pdf_location
+  end
+  
+  opt.on("-w","--working_directory PATH","Where will Libera produce output?") do |working_dir|
+    Libera.configuration.working_dir = working_dir
+  end
+  
+  opt.on("-d","--density INTEGER","What density should Libera convert to?") do |density|
+    Libera.configuration.density = density
+  end
+  
+  opt.on("-q","--quality INTEGER","What image quality should Libera convert to?") do |quality|
+    Libera.configuration.quality = quality
+  end
+  
+  opt.on("-f","--format_type EXTENSION","What image type should Libera convert to?") do |format_type|
+    Libera.configuration.format_type = format_type
+  end
+
+  opt.on("-h","--help","Help") do
+    puts opt_parser
+    exit
+  end
+end
+
+opt_parser.parse!
+
+parser = Libera::Parser.new
+
+parser.mk_working_dir
+ 
+file_list = []
+
+reader = PDF::Reader.new(Libera.configuration.pdf_location)
+page_count = reader.page_count - 1
+
+progressbar = ProgressBar.create(:title => "Pages", :starting_at => 0, :total => page_count + 1)
+ 
+page_list = Hash.new
+ 
+for i in 0..page_count
+  begin
+    pdf = Magick::ImageList.new(Libera.configuration.pdf_location + "[#{i}]") {self.density = Libera.configuration.density; self.quality = Libera.configuration.quality}
+    page_img = pdf.first
+
+    page_img.border!(0, 0, 'white')
+    page_img.alpha(Magick::DeactivateAlphaChannel)
+
+    file_name = "pdf-page-#{i}.#{Libera.configuration.format_type}"
+    file_path = "#{Libera.configuration.working_dir}/#{file_name}"
+    
+    file_list << file_path
+    page_img.write(file_path) {self.depth = 8}
+
+    txt = parser.parse_image(file_path, i)
+    page_list[file_name] = txt
+  ensure
+    pdf.destroy! && page_img.destroy!
+    progressbar.increment
+  end
+end
+
+parser.generate_tei(page_list)

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/libera.rb

@@ -0,0 +1,90 @@
+require 'libera/version'
+require 'libera/tei'
+
+require 'rmagick'
+require 'rtesseract'
+require 'pdf-reader'
+require 'tmpdir'
+require 'fileutils'
+
+include Magick
+
+module Libera
+  
+  class << self
+    # Simple attribute for configuration
+    attr_accessor :configuration
+  end
+  
+  # Allows for configuration by block
+  #
+  # Example:
+  #  MegaLotto.configure do |config|
+  #   config.drawing_count = 10
+  #  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+  
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+
+  # Undoes any configuration - this method was built for testing purposes
+  #
+  # Example:
+  #   Kataba.reset
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  class Configuration
+    # Example:
+    #   Libera.configuration.example = "..."
+    # attr_accessor :example_value
+    
+    attr_accessor :pdf_location
+    attr_accessor :working_dir
+    attr_accessor :density
+    attr_accessor :quality
+    attr_accessor :format_type
+
+    # Default configuration values
+    def initialize
+      @working_dir =  "libera-#{Time.now.to_f.to_s.gsub!('.','')}"   # Default value
+      @density =      300   # Default value
+      @quality =      100   # Default value
+      @format_type =  "png" # Default value
+    end
+  end
+  
+  class Parser
+    
+    def parse_image(image_path, i)
+      file_path = "#{Libera.configuration.working_dir}/pdf-page-#{i}"
+      `tesseract #{image_path} #{file_path} >> /dev/null 2>&1`
+      return File.read(file_path + ".txt")
+    end
+    
+    def generate_tei(page_list)
+      tei_path = "#{Libera.configuration.working_dir}/tei.xml"
+      tei_xml = Libera::Tei.new
+      
+      page_list.each do |k, v|
+        tei_xml.add_page_break(k)
+        tei_xml.add_anon_block(v)
+      end
+      
+      # write out xml to file
+      IO.write(tei_path, tei_xml.to_xml)
+    end
+    
+    def mk_working_dir
+      # Check if working dir exists - If not, make it
+      FileUtils.mkdir("#{Libera.configuration.working_dir}") unless File.exists? "#{Libera.configuration.working_dir}"
+    end
+  end
+  
+end

data/lib/libera/tei.rb

@@ -0,0 +1,85 @@
+require 'om'
+
+module Libera
+  class Tei
+    include OM::XML::Document
+    
+    set_terminology do |t|
+      t.root(:path => 'tei', :xmlns => 'http://www.tei-c.org/ns/1.0', :namespace_prefix => nil)
+      t.text(path: 'text'){
+        t.body(path: 'body'){
+          t.page_break(path: 'pb')
+          t.anon_block(path: 'ab')  
+        }  
+      }
+    end
+    
+    define_template :page_break do |xml, img_src|
+      xml.pb(:facs => img_src)
+    end
+    
+    define_template :anon_block do |xml, ab_text|
+      xml.ab do
+        xml.text(ab_text)
+      end
+    end
+    
+    def self.xml_template
+      builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.TEI("xmlns"=>"http://www.tei-c.org/ns/1.0") {
+          xml.teiHeader{
+            xml.fileDesc{
+              xml.titleStmt{
+                xml.title
+              }
+              xml.publicationStmt{
+                xml.p_
+              }
+              xml.sourceDesc{
+                xml.p_
+              }
+            }
+          }
+          xml.text_{
+            xml.body{
+              xml.ab
+            }
+          }
+        }
+      end
+        
+      return builder.doc
+    end
+    
+    def add_page_break(page_img)
+      # any anon breaks?
+      ab_count = self.find_by_terms(:text, :body, :anon_block).count
+      
+      if ab_count == 1 && self.find_by_terms(:text, :body, :anon_block).first.text.blank?
+        self.find_by_terms(:text, :body, :anon_block).first.remove
+        ab_count = 0
+      end
+      
+      if !(ab_count > 0)
+        # if not add to child of body
+        self.template_registry.add_child(self.find_by_terms(:text, :body => 0), :page_break, page_img)
+      else
+        # else add as sibling
+        self.template_registry.add_next_sibling(self.find_by_terms(:text, :body, :anon_block).last, :page_break, page_img)
+      end
+    end
+    
+    def add_anon_block(text)
+      if self.find_by_terms(:text, :body, :page_break).blank?
+        # Raise error, page break required
+        raise "Page Break not found, unable to add anon block"
+      end
+      
+      if self.find_by_terms(:text, :body, :page_break).count == 1
+        self.template_registry.add_next_sibling(self.find_by_terms(:text, :body, :page_break => 0).first, :anon_block, text)
+      else
+        self.template_registry.add_next_sibling(self.find_by_terms(:text, :body, :page_break).last, :anon_block, text)
+      end
+    end
+  end
+end

data/lib/libera/version.rb

@@ -0,0 +1,3 @@
+module Libera
+  VERSION = "1.0.0"
+end

data/libera.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "libera/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "libera"
+  spec.version       = Libera::VERSION
+  spec.authors       = ["David Cliff"]
+  spec.email         = ["dgcliff@northeastern.edu"]
+
+  spec.summary       = %q{A utility gem for processing PDFs for OCR and TEI}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/NEU-Libraries/libera"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  
+  spec.executables   = ["libera"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  
+  spec.add_dependency "rtesseract", "~> 2.2.0"
+  spec.add_dependency "rmagick", "~> 2.16.0"
+  spec.add_dependency "nokogiri", "~> 1.8.2"
+  spec.add_dependency "pdf-reader", "~> 2.1.0"
+  spec.add_dependency "om", "~> 3.1.1"
+  spec.add_dependency "fileutils", "~> 1.0.2"
+  spec.add_dependency "ruby-progressbar", "~> 1.9.0"
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: libera
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Cliff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-06 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rtesseract
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: om
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+description: 
+email:
+- dgcliff@northeastern.edu
+executables:
+- libera
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/libera
+- bin/setup
+- lib/libera.rb
+- lib/libera/tei.rb
+- lib/libera/version.rb
+- libera.gemspec
+homepage: https://github.com/NEU-Libraries/libera
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A utility gem for processing PDFs for OCR and TEI
+test_files: []