libera 1.0.0 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc099d4ec4b7e794ee9fcd8dbd057a1ccd04467c
-  data.tar.gz: 42e414654cab1579bdaad82e5fe6d70f97b0fd7a
+SHA256:
+  metadata.gz: d4a0c59927db8d8362d9d53ba4658cf0eeddb6034a8dd7122602aadc84187bdc
+  data.tar.gz: 75252c43da0a14a65c1403c32ab572d333860dc847666b79c8b6dd3f0e5fe1ba
 SHA512:
-  metadata.gz: 5e4e80f572b7e2bc9ac1febedd14693a956d818aa0ec999d486e11f74813df1029a2eaeed846c36d4fb7951d57c2c0981e50b6a9393c1daaa86b3114a504dd3f
-  data.tar.gz: d7bb316456adfd50f29e19c28eee08051c6bc2439ac41b98a6f550ee37031528ad89724225e20f6b5a424ea12c208dd9f0f9ada4ec035aff6e4999dc13c986c4
+  metadata.gz: 2323ec7e6ac8ff52c16f5b92f6b4787388ff8a38f27ae29061fc721078ea11a82871bab031c7e6136d9ede5c1aab0c3394f2ab499be7a065dabf4bbc6dc697ea
+  data.tar.gz: 709c1e1e7f864e149846cc5458009a9204b0f34abd57be20a8d168b991f8dbbf5145f00b7aa659800d273585f7185badb1807806f0ae9109477f5a96f16652bf

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.8

data/Dockerfile

@@ -0,0 +1,15 @@
+FROM ruby:2.5
+RUN apt-get update -qq && apt-get install -y \
+  ghostscript \
+  libgs-dev \
+  imagemagick \
+  tesseract-ocr
+RUN rm -f /usr/local/lib/ruby/gems/2.5.0/specifications/default/fileutils-1.0.2.gemspec
+RUN useradd -ms /bin/bash libera
+USER libera
+RUN mkdir -p /home/libera/source
+WORKDIR /home/libera/source
+COPY --chown=libera:libera . /home/libera/source
+RUN /home/libera/source/bin/setup
+RUN gem build libera.gemspec
+RUN gem install libera-1.0.4.gem

data/Gemfile.lock

@@ -1,67 +1,68 @@
 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)
+    libera (1.0.6)
+      fileutils (~> 1)
+      nokogiri (~> 1)
+      om (~> 3.1)
+      pdf-reader (~> 2.1)
+      rmagick (~> 2.16)
+      rtesseract (~> 2.2)
+      ruby-progressbar (~> 1.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
     Ascii85 (1.0.3)
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activesupport (5.2.0)
+    activemodel (6.1.1)
+      activesupport (= 6.1.1)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     afm (0.2.2)
-    concurrent-ruby (1.0.5)
-    daemons (1.2.6)
-    diff-lcs (1.3)
-    fileutils (1.0.2)
+    concurrent-ruby (1.1.7)
+    daemons (1.3.1)
+    diff-lcs (1.4.4)
+    fileutils (1.5.0)
     hashery (2.1.2)
-    i18n (1.0.1)
+    i18n (1.8.7)
       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
+    minitest (5.14.3)
+    nokogiri (1.11.1-x86_64-linux)
+      racc (~> 1.4)
+    om (3.2.0)
+      activemodel (>= 5.1, < 7)
       activesupport
       nokogiri (>= 1.4.2)
       solrizer (~> 3.3)
-    pdf-reader (2.1.0)
+    pdf-reader (2.4.1)
       Ascii85 (~> 1.0.0)
       afm (~> 0.2.1)
       hashery (~> 2.0)
       ruby-rc4
       ttfunk
-    rake (10.5.0)
+    racc (1.5.2)
+    rake (13.0.3)
     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)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
     rtesseract (2.2.0)
       nokogiri
-    ruby-progressbar (1.9.0)
+    ruby-progressbar (1.11.0)
     ruby-rc4 (0.1.5)
     solrizer (3.4.1)
       activesupport
@@ -69,21 +70,20 @@ GEM
       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)
+    stomp (1.4.10)
+    ttfunk (1.7.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    xml-simple (1.1.8)
+    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.16)
   libera!
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake (~> 13)
+  rspec (~> 3)
 
 BUNDLED WITH
-   1.16.1
+   2.2.6

data/README.md

@@ -4,8 +4,37 @@ Libera is a gem built for Charon - https://github.com/NEU-Libraries/charon - a d
 
 It's purpose is to take PDF files as input, and split them apart into individual page images for OCR and TEI generation.
 
+## Docker
+
+Whilst there are installation instructions below for work as a developer, often times there are significant environmental challenges to software setup. To that end, Libera can  be run in Docker. Install Docker as instructed here - https://docs.docker.com/install/
+
+Then pull down the libera container image;
+
+    docker pull nakatomi/libera
+
+To share the PDF with the application, you'll need to bind mount a directory to the container. If you run into permission errors or an empty directory issue, you'll need to consult the variances that can occur based on host operating system - https://docs.docker.com/storage/bind-mounts/
+
+An example of how to run the container, use a bind mount, and instruct libera is below
+
+    docker run -ti --mount type=bind,source=/c/Libera,target=/home/libera/work_dir nakatomi/libera libera -p /home/libera/work_dir/dsg.pdf -w /home/libera/work_dir
+
+In the above example, the mounted host directory ```/c/Libera``` becomes ```/home/libera/work_dir``` inside the container. In this use case, we use the same directory to deliver the PDF ```dsg.pdf``` as well as use it for where the produced artifacts are then made.
+
+The last section of the above is the same as if you'd run Libera in your home operating system
+
+    libera -p /home/libera/work_dir/dsg.pdf -w /home/libera/work_dir
+
 ## Installation
 
+There are some programs that are required for Libera to work;
+
+* Tesseract - https://github.com/tesseract-ocr/tesseract
+* ImageMagick - https://www.imagemagick.org
+
+Tesseract 3.03 and ImageMagick 6.7.7-10 were the versions used in the development of this gem.
+
+Both should be available through package managers such as APT, Yum, Homebrew etc.
+
 Add this line to your application's Gemfile:
 
 ```ruby

data/lib/libera.rb

@@ -83,7 +83,7 @@ module Libera
     
     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}"
+      FileUtils.mkdir_p("#{Libera.configuration.working_dir}") unless File.exists? "#{Libera.configuration.working_dir}"
     end
   end
   

data/lib/libera/tei.rb

@@ -5,7 +5,7 @@ module Libera
     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.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')
@@ -14,6 +14,14 @@ module Libera
       }
     end
     
+    define_template :text do |xml|
+      xml.text_
+    end
+    
+    define_template :body do |xml|
+      xml.body
+    end
+    
     define_template :page_break do |xml, img_src|
       xml.pb(:facs => img_src)
     end
@@ -51,7 +59,33 @@ module Libera
       return builder.doc
     end
     
+    def add_text
+      begin
+        self.template_registry.add_child(self.ng_xml.root, :text)
+      rescue NoMethodError
+        raise "Unable to add XML node to base template"
+      end
+    end
+    
+    def add_body
+      begin
+        self.template_registry.add_child(self.find_by_terms(:text => 0), :body)
+      rescue NoMethodError
+        raise "Unable to add XML node to base template"
+      end
+    end
+    
     def add_page_break(page_img)
+      # any text?
+      if self.find_by_terms(:text => 0).blank?
+        self.add_text
+      end
+      
+      # any body?
+      if self.find_by_terms(:text, :body => 0).blank?
+        self.add_body
+      end
+      
       # any anon breaks?
       ab_count = self.find_by_terms(:text, :body, :anon_block).count
       

data/lib/libera/version.rb

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

data/libera.gemspec

@@ -17,22 +17,22 @@ 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        = "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"
+  #spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 13"
+  spec.add_development_dependency "rspec", "~> 3"
+
+  spec.add_dependency "rtesseract", "~> 2.2"
+  spec.add_dependency "rmagick", "~> 2.16"
+  spec.add_dependency "nokogiri", "~> 1"
+  spec.add_dependency "pdf-reader", "~> 2.1"
+  spec.add_dependency "om", "~> 3.1"
+  spec.add_dependency "fileutils", "~> 1"
+  spec.add_dependency "ruby-progressbar", "~> 1.9"
 end

metadata

@@ -1,155 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: libera
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.6
 platform: ruby
 authors:
 - David Cliff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2021-01-19 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'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rtesseract
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rmagick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: '2.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: '2.16'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: om
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: fileutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '1.9'
 description: 
 email:
 - dgcliff@northeastern.edu
@@ -160,7 +146,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -193,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: A utility gem for processing PDFs for OCR and TEI