henkei 1.17.3 → 1.17.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d629bcc0d435522497e749752307e6c33844d29
-  data.tar.gz: 490b5e0c89b43f4ec83434e3861c85d69de7a8bd
+  metadata.gz: 4215a4071c7a618e66330cb7eca8873eae851b7b
+  data.tar.gz: 488366df7fdf1863272dc121b7fa74f077036352
 SHA512:
-  metadata.gz: 6f4e76efb3cf67bca58db9e6dc074511af3e8661b5c03800bbf28cce9939b01774c33aaa65ae24df5e46a5346cda97347e17add23e934cbaf0cbaf7c48e73246
-  data.tar.gz: 21cf99d84f4428f3db892aabc5827f02c848e70bb693080ac33789f4ea66d64de03f88856af7e89c14a4b783a038e33c5fba7ad6229e316f99be2cc2c0ab5fa1
+  metadata.gz: 21ba327a8c1139b586944ca1d28e35158c66386a721da9fc6cb71d400f52e9f339931d17f39a3e1b2344e65f65a7ccddeeff84e515dc6c5d491e4005749071f4
+  data.tar.gz: 880bd8f6721d5c6659da8d10aac9949a582d670bdd18b64de16089c738c57c64fe7499d5405e0af736571317f79dedcf783b8ba0389b9794b90cbc939548916c

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/ClassVars:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false

data/.travis.yml

@@ -4,8 +4,6 @@ env:
 
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
   - 2.1.10
   - 2.2.7
   - 2.3.6
@@ -15,12 +13,17 @@ rvm:
 before_install:
   - gem update bundler
 
+install:
+  - bundle install --jobs=3 --retry=3
+  - gem install rubocop
+
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
   - ./cc-test-reporter before-build
 
 script:
+  - rubocop
   - bundle exec rspec
 
 after_script:

data/Rakefile

@@ -5,4 +5,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new 'spec'
 
-task :default => :spec
+task default: :spec

data/henkei.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'henkei/version'
 
 Gem::Specification.new do |spec|
@@ -9,20 +9,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Erol Fornoles', 'Andrew Bromwich']
   spec.email         = %w[erol.fornoles@gmail.com a.bromwich@gmail.com]
   spec.description   = 'Read text and metadata from files and documents using Apache Tika toolkit'
-  spec.summary       = 'Read text and metadata from files and documents (.doc, .docx, .pages, .odt, .rtf, .pdf) using Apache Tika toolkit'
+  spec.summary       = 'Read text and metadata from files and documents ' \
+                       '(.doc, .docx, .pages, .odt, .rtf, .pdf) using Apache Tika toolkit'
   spec.homepage      = 'http://github.com/abrom/henkei'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split("\n")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'mime-types', '>= 1.23', '< 4'
   spec.add_runtime_dependency 'json', '>= 1.8', '< 3'
+  spec.add_runtime_dependency 'mime-types', '>= 1.23', '< 4'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   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 'simplecov', '~> 0.15'
 end

data/lib/henkei.rb

@@ -9,7 +9,8 @@ require 'json'
 require 'socket'
 require 'stringio'
 
-class Henkei
+# 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.17.jar')
   CONFIG_PATH = File.join(Henkei::GEM_PATH, 'jar', 'tika-config.xml')
@@ -25,17 +26,13 @@ class Henkei
   #   metadata = Henkei.read :metadata, data
   #
   def self.read(type, data)
-    result = @@server_pid ? server_read(type, data) : client_read(type, data)
+    result = @@server_pid ? server_read(data) : client_read(type, data)
 
     case type
-    when :text
-      result
-    when :html
-      result
-    when :metadata
-      JSON.parse(result)
-    when :mimetype
-      MIME::Types[JSON.parse(result)['Content-Type']].first
+    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
     end
   end
 
@@ -55,17 +52,17 @@ class Henkei
   #
   def initialize(input)
     if input.is_a? String
-      if File.exists? input
+      if File.exist? input
         @path = input
-      elsif input =~ URI::regexp
+      elsif input =~ URI::DEFAULT_PARSER.make_regexp
         @uri = URI.parse input
       else
-        raise Errno::ENOENT.new "missing file or invalid URI - #{input}"
+        raise Errno::ENOENT, "missing file or invalid URI - #{input}"
       end
     elsif input.respond_to? :read
       @stream = input
     else
-      raise TypeError.new "can't read from #{input.class.name}"
+      raise TypeError, "can't read from #{input.class.name}"
     end
   end
 
@@ -112,7 +109,7 @@ class Henkei
     return @mimetype if defined? @mimetype
 
     type = metadata['Content-Type'].is_a?(Array) ? metadata['Content-Type'].first : metadata['Content-Type']
-    
+
     @mimetype = MIME::Types[type].first
   end
 
@@ -123,12 +120,8 @@ class Henkei
   #
   def creation_date
     return @creation_date if defined? @creation_date
- 
-    if metadata['Creation-Date']
-      @creation_date = Time.parse(metadata['Creation-Date'])
-    else
-      nil
-    end
+    return unless metadata['Creation-Date']
+    @creation_date = Time.parse(metadata['Creation-Date'])
   end
 
   # Returns +true+ if the Henkei document was specified using a file path.
@@ -182,19 +175,19 @@ class Henkei
   #
   #  type :html, :text or :metadata
   #  custom_port e.g. 9293
-  #   
+  #
   #  Henkei.server(:text, 9294)
   #
-  def self.server(type, custom_port=nil)
+  def self.server(type, custom_port = nil)
     @@server_port = custom_port || DEFAULT_SERVER_PORT
-    
+
     @@server_pid = Process.spawn tika_command(type, true)
     sleep(2) # Give the server 2 seconds to spin up.
     @@server_pid
   end
 
   # Kills server started by Henkei.server
-  # 
+  #
   #  Always run this when you're done, or else Tika might run until you kill it manually
   #  You might try putting your extraction in a begin..rescue...ensure...end block and
   #    putting this method in the ensure block.
@@ -209,11 +202,11 @@ class Henkei
   #  end
   #
   def self.kill_server!
-    if @@server_pid
-      Process.kill('INT', @@server_pid)
-      @@server_pid = nil
-      @@server_port = nil
-    end
+    return unless @@server_pid
+
+    Process.kill('INT', @@server_pid)
+    @@server_pid = nil
+    @@server_port = nil
   end
 
   ### Private class methods
@@ -238,12 +231,12 @@ class Henkei
 
   # Internal helper for calling to running Tika server
   #
-  def self.server_read(_, data)
+  def self.server_read(data)
     s = TCPSocket.new('localhost', @@server_port)
     file = StringIO.new(data, 'r')
 
-    while 1
-      chunk = file.read(65536)
+    loop do
+      chunk = file.read(65_536)
       break unless chunk
       s.write(chunk)
     end
@@ -252,8 +245,8 @@ class Henkei
     s.shutdown(Socket::SHUT_WR)
 
     resp = ''
-    while 1
-      chunk = s.recv(65536)
+    loop do
+      chunk = s.recv(65_536)
       break if chunk.empty? || !chunk
       resp << chunk
     end

data/lib/henkei/version.rb

@@ -1,3 +1,3 @@
 class Henkei
-  VERSION = '1.17.3'
+  VERSION = '1.17.4'.freeze
 end

data/spec/henkei_spec.rb

@@ -12,27 +12,31 @@ describe Henkei do
     it 'reads text' do
       text = Henkei.read :text, data
 
-      expect( text ).to include 'The quick brown fox jumped over the lazy cat.'
+      expect(text).to include 'The quick brown fox jumped over the lazy cat.'
     end
 
     it 'reads metadata' do
       metadata = Henkei.read :metadata, data
 
-      expect( metadata['Content-Type'] ).to eql 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+      expect(metadata['Content-Type']).to(
+        eq 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+      )
     end
 
     it 'reads metadata values with colons as strings' do
       data = File.read 'spec/samples/sample-metadata-values-with-colons.doc'
       metadata = Henkei.read :metadata, data
 
-      expect( metadata['dc:title'] ).to eql 'problem: test'
+      expect(metadata['dc:title']).to eq 'problem: test'
     end
 
     it 'reads mimetype' do
       mimetype = Henkei.read :mimetype, data
 
-      expect( mimetype.content_type ).to eql 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
-      expect( mimetype.extensions ).to include 'docx'
+      expect(mimetype.content_type).to(
+        eq 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+      )
+      expect(mimetype.extensions).to include 'docx'
     end
   end
 
@@ -44,47 +48,47 @@ describe Henkei do
     it 'accepts a root path' do
       henkei = Henkei.new 'spec/samples/sample.pages'
 
-      expect( henkei ).to be_path
-      expect( henkei ).not_to be_uri
-      expect( henkei ).not_to be_stream
+      expect(henkei).to be_path
+      expect(henkei).not_to be_uri
+      expect(henkei).not_to be_stream
     end
 
     it 'accepts a relative path' do
       henkei = Henkei.new 'spec/samples/sample.pages'
 
-      expect( henkei ).to be_path
-      expect( henkei ).not_to be_uri
-      expect( henkei ).not_to be_stream
+      expect(henkei).to be_path
+      expect(henkei).not_to be_uri
+      expect(henkei).not_to be_stream
     end
 
     it 'accepts a path with spaces' do
       henkei = Henkei.new 'spec/samples/sample filename with spaces.pages'
 
-      expect( henkei ).to be_path
-      expect( henkei ).not_to be_uri
-      expect( henkei ).not_to be_stream
+      expect(henkei).to be_path
+      expect(henkei).not_to be_uri
+      expect(henkei).not_to be_stream
     end
 
     it 'accepts a URI' do
       henkei = Henkei.new 'http://svn.apache.org/repos/asf/poi/trunk/test-data/document/sample.docx'
 
-      expect( henkei ).to be_uri
-      expect( henkei ).not_to be_path
-      expect( henkei ).not_to be_stream
+      expect(henkei).to be_uri
+      expect(henkei).not_to be_path
+      expect(henkei).not_to be_stream
     end
 
     it 'accepts a stream or object that can be read' do
       File.open 'spec/samples/sample.pages', 'r' do |file|
         henkei = Henkei.new file
 
-        expect( henkei ).to be_stream
-        expect( henkei ).not_to be_path
-        expect( henkei ).not_to be_uri
+        expect(henkei).to be_stream
+        expect(henkei).not_to be_path
+        expect(henkei).not_to be_uri
       end
     end
 
     it 'refuses a path to a missing file' do
-      expect { Henkei.new 'test/sample/missing.pages'}.to raise_error Errno::ENOENT
+      expect { Henkei.new 'test/sample/missing.pages' }.to raise_error Errno::ENOENT
     end
 
     it 'refuses other objects' do
@@ -94,23 +98,22 @@ describe Henkei do
     end
   end
 
-
   describe '.creation_date' do
     let(:henkei) { Henkei.new 'spec/samples/sample.pages' }
     it 'should return Time' do
-      expect( henkei.creation_date ).to be_a Time
+      expect(henkei.creation_date).to be_a Time
     end
   end
 
   describe '.java' do
     specify 'with no specified JAVA_HOME' do
-      expect( Henkei.send(:java_path) ).to eql 'java'
+      expect(Henkei.send(:java_path)).to eq 'java'
     end
 
     specify 'with a specified JAVA_HOME' do
       ENV['JAVA_HOME'] = '/path/to/java/home'
 
-      expect( Henkei.send(:java_path) ).to eql '/path/to/java/home/bin/java'
+      expect(Henkei.send(:java_path)).to eq '/path/to/java/home/bin/java'
     end
   end
 
@@ -118,11 +121,11 @@ describe Henkei do
     let(:henkei) { Henkei.new 'spec/samples/sample.pages' }
 
     specify '#text reads text' do
-      expect( henkei.text).to include 'The quick brown fox jumped over the lazy cat.'
+      expect(henkei.text).to include 'The quick brown fox jumped over the lazy cat.'
     end
 
     specify '#metadata reads metadata' do
-      expect( henkei.metadata['Content-Type'] ).to eql ['application/vnd.apple.pages', 'application/vnd.apple.pages']
+      expect(henkei.metadata['Content-Type']).to eq %w[application/vnd.apple.pages application/vnd.apple.pages]
     end
   end
 
@@ -130,11 +133,13 @@ describe Henkei do
     let(:henkei) { Henkei.new 'http://svn.apache.org/repos/asf/poi/trunk/test-data/document/sample.docx' }
 
     specify '#text reads text' do
-      expect( henkei.text ).to include 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit.'
+      expect(henkei.text).to include 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit.'
     end
 
     specify '#metadata reads metadata' do
-      expect( henkei.metadata['Content-Type'] ).to eql 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+      expect(henkei.metadata['Content-Type']).to(
+        eq 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+      )
     end
   end
 
@@ -142,11 +147,11 @@ describe Henkei do
     let(:henkei) { Henkei.new File.open('spec/samples/sample.pages', 'rb') }
 
     specify '#text reads text' do
-      expect( henkei.text ).to include 'The quick brown fox jumped over the lazy cat.'
+      expect(henkei.text).to include 'The quick brown fox jumped over the lazy cat.'
     end
 
     specify '#metadata reads metadata' do
-      expect( henkei.metadata['Content-Type'] ).to eql ['application/vnd.apple.pages', 'application/vnd.apple.pages']
+      expect(henkei.metadata['Content-Type']).to eq %w[application/vnd.apple.pages application/vnd.apple.pages]
     end
   end
 
@@ -171,9 +176,15 @@ describe Henkei do
     specify '#runs samples through server mode' do
       begin
         Henkei.server(:text)
-        expect(Henkei.new('spec/samples/sample.pages').text).to include 'The quick brown fox jumped over the lazy cat.'
-        expect(Henkei.new('spec/samples/sample filename with spaces.pages').text).to include 'The quick brown fox jumped over the lazy cat.'
-        expect(Henkei.new('spec/samples/sample.docx').text).to include 'The quick brown fox jumped over the lazy cat.'
+        expect(Henkei.new('spec/samples/sample.pages').text).to(
+          include 'The quick brown fox jumped over the lazy cat.'
+        )
+        expect(Henkei.new('spec/samples/sample filename with spaces.pages').text).to(
+          include 'The quick brown fox jumped over the lazy cat.'
+        )
+        expect(Henkei.new('spec/samples/sample.docx').text).to(
+          include 'The quick brown fox jumped over the lazy cat.'
+        )
       ensure
         Henkei.kill_server!
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: henkei
 version: !ruby/object:Gem::Version
-  version: 1.17.3
+  version: 1.17.4
 platform: ruby
 authors:
 - Erol Fornoles
@@ -12,45 +12,45 @@ cert_chain: []
 date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '1.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '1.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.23'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.23'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE