henkei 1.20.0 → 1.23.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca7e4a2903bba6a17a310d55d42ae8647bfa6857e27820394b4745d11a36393a
-  data.tar.gz: e78d60f55d368455ab7fa4007240961d95e98232df41b267d057535bfb9d9f63
+  metadata.gz: 97b9b37da4e96281569a16e469d23a00c41cd35bbd15e5a7c1d1025ea2862f46
+  data.tar.gz: 45a7c3ae645fc417ae6064a7237d87ae7e56c3c20392f83cad42f9fdafd569e8
 SHA512:
-  metadata.gz: bf5b4fa6bfaa408f0572e6a034f01a8d5bdcb629208ab17f143fc7dffee936cd012a2d839852c01d39a8006d890a6158ed7c798120e8d41b91f0b00850082056
-  data.tar.gz: 46461c2c92c1798f97fe8f1942d31eb0ca82867015fe8b7de186140da98e0d4377860852c15d61e0533d7515db2cbccfd687027a8a5887d6a677dbeb79d776f2
+  metadata.gz: c323d5f5c2056bedce26e05b40d70eecd4f4fff6f8ae24362dfc80952e788f33454b8a7be6a375c54001694e6a2fbe2d7dfb60392dc7324b865d056e99637d78
+  data.tar.gz: fe9c6ee2a7033d55d8ccc36a3d3a1cc78fd459654314096fa087c8373544deaa291952b0303db11f362a7f758028acf11692f7b25ca132d7cb4c6603a10a5a9d

data/.rubocop.yml

@@ -1,10 +1,31 @@
+AllCops:
+  NewCops: enable
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
-Metrics/LineLength:
-  Max: 120
-
 Metrics/MethodLength:
   Max: 15
 
@@ -13,3 +34,24 @@ Style/ClassVars:
 
 Style/DoubleNegation:
   Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/.travis.yml

@@ -1,13 +1,17 @@
 env:
   global:
     - CC_TEST_REPORTER_ID=bb96c1ff9dc66724c38fb4eb54486dd72dc88a7fd6e727c034b9cf8d747d069e
+  jobs:
+    - INCLUDE_RAILS=false
+    - INCLUDE_RAILS=true
 
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
   - 2.4
   - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
 
 before_install:
   - gem update bundler
@@ -22,7 +26,7 @@ before_script:
   - ./cc-test-reporter before-build
 
 script:
-  - rubocop
+  - bundle exec rubocop
   - bundle exec rspec
 
 after_script:

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in henkei.gemspec

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'henkei'
+
+require 'irb'
+IRB.start

data/henkei.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -13,6 +15,7 @@ Gem::Specification.new do |spec|
                        '(.doc, .docx, .pages, .odt, .rtf, .pdf) using Apache Tika toolkit'
   spec.homepage      = 'http://github.com/abrom/henkei'
   spec.license       = 'MIT'
+  spec.required_ruby_version = ['>= 2.4.0', '< 3.1.0']
 
   spec.files         = `git ls-files`.split("\n")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -20,11 +23,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'json', '>= 1.8', '< 3'
-  spec.add_runtime_dependency 'mime-types', '>= 1.23', '< 4'
+  spec.add_runtime_dependency 'mini_mime', '>= 0.1.1', '< 1'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rails', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '~> 0.53'
+  spec.add_development_dependency 'rubocop', '~> 0.71'
   spec.add_development_dependency 'simplecov', '~> 0.15'
 end

data/lib/henkei.rb

@@ -1,24 +1,49 @@
+# frozen_string_literal: true
+
 require 'henkei/version'
 require 'henkei/yomu'
+require 'henkei/configuration'
 
 require 'net/http'
-require 'mime/types'
+require 'mini_mime'
+
+# require 'mime/types' if available
+begin
+  require 'mime/types'
+rescue LoadError
+  nil
+end
+
 require 'time'
 require 'json'
 
 require 'socket'
 require 'stringio'
 
+require 'open3'
+
 # Read text and metadata from files and documents using Apache Tika toolkit
 class Henkei # rubocop:disable Metrics/ClassLength
   GEM_PATH = File.dirname(File.dirname(__FILE__))
-  JAR_PATH = File.join(Henkei::GEM_PATH, 'jar', 'tika-app-1.20.jar')
+  JAR_PATH = File.join(Henkei::GEM_PATH, 'jar', 'tika-app-1.23.jar')
   CONFIG_PATH = File.join(Henkei::GEM_PATH, 'jar', 'tika-config.xml')
   DEFAULT_SERVER_PORT = 9293 # an arbitrary, but perfectly cromulent, port
 
   @@server_port = nil
   @@server_pid = nil
 
+  def self.mimetype(content_type)
+    if Henkei.configuration.mime_library == 'mime/types' && defined?(MIME::Types)
+      warn '[DEPRECATION] `mime/types` is deprecated. Please use `mini_mime` instead.'\
+        ' Use Henkei.configure and assign "mini_mime" to `mime_library`.'
+      MIME::Types[content_type].first
+    else
+      MiniMime.lookup_by_content_type(content_type).tap do |object|
+        object.define_singleton_method(:extensions) { [extension] }
+      end
+    end
+  end
+
   # Read text or metadata from a data buffer.
   #
   #   data = File.read 'sample.pages'
@@ -32,7 +57,7 @@ class Henkei # rubocop:disable Metrics/ClassLength
     when :text then result
     when :html then result
     when :metadata then JSON.parse(result)
-    when :mimetype then MIME::Types[JSON.parse(result)['Content-Type']].first
+    when :mimetype then Henkei.mimetype(JSON.parse(result)['Content-Type'])
     end
   end
 
@@ -108,9 +133,8 @@ class Henkei # rubocop:disable Metrics/ClassLength
   def mimetype
     return @mimetype if defined? @mimetype
 
-    type = metadata['Content-Type'].is_a?(Array) ? metadata['Content-Type'].first : metadata['Content-Type']
-
-    @mimetype = MIME::Types[type].first
+    content_type = metadata['Content-Type'].is_a?(Array) ? metadata['Content-Type'].first : metadata['Content-Type']
+    @mimetype = Henkei.mimetype(content_type)
   end
 
   # Returns +true+ if the Henkei document was specified using a file path.
@@ -182,7 +206,7 @@ class Henkei # rubocop:disable Metrics/ClassLength
   def self.server(type, custom_port = nil)
     @@server_port = custom_port || DEFAULT_SERVER_PORT
 
-    @@server_pid = Process.spawn tika_command(type, true)
+    @@server_pid = Process.spawn(*tika_command(type, server: true))
     sleep(2) # Give the server 2 seconds to spin up.
     @@server_pid
   end
@@ -215,18 +239,14 @@ class Henkei # rubocop:disable Metrics/ClassLength
   # Provide the path to the Java binary
   #
   def self.java_path
-    ENV['JAVA_HOME'] ? ENV['JAVA_HOME'] + '/bin/java' : 'java'
+    ENV['JAVA_HOME'] ? "#{ENV['JAVA_HOME']}/bin/java" : 'java'
   end
   private_class_method :java_path
 
   # Internal helper for calling to Tika library directly
   #
   def self.client_read(type, data)
-    IO.popen tika_command(type), 'r+' do |io|
-      io.write data
-      io.close_write
-      io.read
-    end
+    Open3.capture2(*tika_command(type), stdin_data: data, binmode: true).first
   end
   private_class_method :client_read
 
@@ -246,7 +266,7 @@ class Henkei # rubocop:disable Metrics/ClassLength
     # tell Tika that we're done sending data
     s.shutdown(Socket::SHUT_WR)
 
-    resp = ''
+    resp = String.new ''
     loop do
       chunk = s.recv(65_536)
       break if chunk.empty? || !chunk
@@ -259,23 +279,22 @@ class Henkei # rubocop:disable Metrics/ClassLength
 
   # Internal helper for building the Java command to call Tika
   #
-  def self.tika_command(type, server = false)
-    command = ["#{java_path} -Djava.awt.headless=true -jar #{Henkei::JAR_PATH} --config=#{Henkei::CONFIG_PATH}"]
-    command << "--server --port #{@@server_port}" if server
-    command << switch_for_type(type)
-    command.join ' '
+  def self.tika_command(type, server: false)
+    command = [java_path, '-Djava.awt.headless=true', '-jar', Henkei::JAR_PATH, "--config=#{Henkei::CONFIG_PATH}"]
+    command += ['--server', '--port', @@server_port.to_s] if server
+    command + switch_for_type(type)
   end
   private_class_method :tika_command
 
   # Internal helper for building the Java command to call Tika
   #
   def self.switch_for_type(type)
-    case type
-    when :text then '-t'
-    when :html then '-h'
-    when :metadata then '-m -j'
-    when :mimetype then '-m -j'
-    end
+    {
+      text: ['-t'],
+      html: ['-h'],
+      metadata: %w[-m -j],
+      mimetype: %w[-m -j]
+    }[type]
   end
   private_class_method :switch_for_type
 end

data/lib/henkei/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Henkei monkey patch for configuration support
+class Henkei
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  # Handle Henkei configuration
+  class Configuration
+    attr_accessor :mime_library
+
+    def initialize
+      @mime_library = 'mime/types'
+    end
+  end
+end

data/lib/henkei/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Henkei
-  VERSION = '1.20.0'.freeze
+  VERSION = '1.23.2'
 end

data/lib/henkei/yomu.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 Yomu = Henkei

data/spec/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 SimpleCov.start
 

data/spec/henkei_spec.rb

@@ -1,6 +1,11 @@
-require 'helper.rb'
+# frozen_string_literal: true
+
+require 'helper'
 require 'henkei'
 
+# Some of the tests have been known to fail in weird and wonderful ways when `rails` is included
+require 'rails' if ENV['INCLUDE_RAILS'] == 'true'
+
 describe Henkei do
   let(:data) { File.read 'spec/samples/sample.docx' }
 
@@ -38,6 +43,16 @@ describe Henkei do
       )
       expect(mimetype.extensions).to include 'docx'
     end
+
+    context 'when passing in the `pipe-error.png` test file' do
+      let(:data) { File.read 'spec/samples/pipe-error.png' }
+
+      it 'returns an empty result' do
+        text = Henkei.read :text, data
+
+        expect(text).to eq ''
+      end
+    end
   end
 
   describe '.new' do
@@ -127,6 +142,23 @@ describe Henkei do
     specify '#metadata reads metadata' do
       expect(henkei.metadata['Content-Type']).to eq %w[application/vnd.apple.pages application/vnd.apple.pages]
     end
+
+    context 'when passing in the `pipe-error.png` test file' do
+      let(:henkei) { Henkei.new 'spec/samples/pipe-error.png' }
+
+      it '#text returns an empty result' do
+        expect(henkei.text).to eq ''
+      end
+
+      it '#html returns an empty body' do
+        expect(henkei.html).to include '<body/>'
+        expect(henkei.html).to include '<meta name="tiff:ImageWidth" content="792"/>'
+      end
+
+      it '#mimetype returns `image/png`' do
+        expect(henkei.mimetype.content_type).to eq 'image/png'
+      end
+    end
   end
 
   context 'initialized with a given URI' do
@@ -155,6 +187,18 @@ describe Henkei do
     end
   end
 
+  context 'when source is a remote PDF' do
+    let(:henkei) { Henkei.new 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf' }
+
+    specify '#text reads text' do
+      expect(henkei.text).to include 'Dummy PDF file'
+    end
+
+    specify '#metadata reads metadata' do
+      expect(henkei.metadata['Content-Type']).to eq 'application/pdf'
+    end
+  end
+
   context 'working as server mode' do
     specify '#starts and kills server' do
       begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: henkei
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.23.2
 platform: ruby
 authors:
 - Erol Fornoles
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-23 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -32,39 +32,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: mini_mime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: 0.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: 0.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,14 +113,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.71'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.71'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +139,8 @@ description: Read text and metadata from files and documents using Apache Tika t
 email:
 - erol.fornoles@gmail.com
 - a.bromwich@gmail.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -138,14 +153,17 @@ files:
 - NOTICE.txt
 - README.md
 - Rakefile
+- bin/console
 - henkei.gemspec
-- jar/tika-app-1.20.jar
+- jar/tika-app-1.23.jar
 - jar/tika-config.xml
 - lib/henkei.rb
+- lib/henkei/configuration.rb
 - lib/henkei/version.rb
 - lib/henkei/yomu.rb
 - spec/helper.rb
 - spec/henkei_spec.rb
+- spec/samples/pipe-error.png
 - spec/samples/sample filename with spaces.pages
 - spec/samples/sample-metadata-values-with-colons.doc
 - spec/samples/sample.docx
@@ -162,15 +180,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Read text and metadata from files and documents (.doc, .docx, .pages, .odt,
@@ -178,6 +198,7 @@ summary: Read text and metadata from files and documents (.doc, .docx, .pages, .
 test_files:
 - spec/helper.rb
 - spec/henkei_spec.rb
+- spec/samples/pipe-error.png
 - spec/samples/sample filename with spaces.pages
 - spec/samples/sample-metadata-values-with-colons.doc
 - spec/samples/sample.docx