rika 2.0.1-java → 2.0.3-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9885d200caf6116b8356a6eedf8c953aba4429e05d7a20d30a6c0a2281a9e57e
-  data.tar.gz: 9c71e6ae01ea608c45cb302627bea7ee3612058fbd237787d4aebc5ff07476b4
+  metadata.gz: d1ff6f1340908e2f573ac758ded769bf4a94db0835e06a436addf6dd9408b7ba
+  data.tar.gz: 6e99972c0cf72ab44b85e11847ed6685101c8498f2cd8c1a9a51237b2cc7ede2
 SHA512:
-  metadata.gz: 407fe5fe996b47c080a1a9282ae5b7c3bc48685f18ee243af81ecb6e567c5eef3dfec86b554ed3fd59d3735f8ba5af7712f9c5388f59a9a22905b0b0c8e01c73
-  data.tar.gz: 20e0f6c590f5d533866616e2cba8229d1d003959214e452702f19f5fc462b6afa3e4f2e1c8ce5feb30468f9207c0231b9778185333c91af4173c35970684bc2c
+  metadata.gz: eaf3905403a4a0f66ace5a9658f1aa0ba77f153d67e588f094fbbe426b7cd4c30640c3f21652b8312493e4ad827719d6ff1d83a613b6ae0ff9a73164b179fd4e
+  data.tar.gz: dda02d0f0377f54db2fe59535c4b59b073c5fdcae3f1f8c6e66506427e34c248b923c2b01683a6ea811ca4a1ed45305b96739611a119d7dd244895e28fe7dac4

data/Gemfile

@@ -6,11 +6,11 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'pry'
-  gem 'rake', '~> 13.0'
-  gem 'rspec', '~> 3.9'
-  gem 'rubocop'
-  gem 'rubocop-rspec'
-  gem 'simplecov', require: false
-  gem 'webrick', '~> 1.6'
+  gem 'pry', '~> 0.14', '>= 0.14.2'
+  gem 'rake', '~> 13.2', '>= 13.2.1'
+  gem 'rspec', '~> 3.13', '>= 3.13.0'
+  gem 'rubocop', '~> 1.65', '>= 1.65.1'
+  gem 'rubocop-rspec', '~> 3.0', '>= 3.0.3'
+  gem 'simplecov', '~>0.22', '>= 0.22.0', require: false
+  gem 'webrick', '~> 1.8', '>= 1.8.1'
 end

data/README.md

@@ -82,10 +82,14 @@ specify one or more filespecs or URL's as arguments:
 ```bash
 rika x.pdf https://github.com/keithrbennett/rika
 ```
+
+> [!NOTE]
+> If running `rika` produces an error indicating that the JRuby interpreter cannot be found, try preceding it with `jruby`, e.g. `jruby rika x.pdf`.
+
 Here is the help text:
 
 ```
-Rika v2.0.1 (Tika v2.9.0) - https://github.com/keithrbennett/rika
+Rika v2.0.2 (Tika v2.9.0) - https://github.com/keithrbennett/rika
 
 Usage: rika [options] <file or url> [...file or url...]
 Output formats are: [a]wesome_print, [t]o_s, [i]nspect, [j]son), [J] for pretty json, and [y]aml.
@@ -98,7 +102,7 @@ Values for the text, metadata, and as_array boolean options may be specified as
     -m, --[no-]metadata [FLAG]       Output metadata (default: true)
     -t, --[no-]text [FLAG]           Output text (default: true)
     -k, --[no-]key-sort [FLAG]       Sort metadata keys case insensitively (default: true)
-    -s, --[no-]source [FLAG]         Output document source file or URL
+    -s, --[no-]source [FLAG]         Output document source file or URL (default: false)
     -a, --[no-]as-array [FLAG]       Output all parsed results as an array (default: false)
     -v, --version                    Output version
     -h, --help                       Output help
@@ -245,6 +249,14 @@ rexe -in -oJ -mb 'downcase \
 This gem has been tested with JRuby managed by rvm.  It should work with other Ruby version managers and
 without any version manager at all, but those configurations have not been tested.
 
+## Using the Tika Java Jar File Directly
+
+Rika provides only the most common Tika use cases.  You may want to dig deeper than Rika does into the massive amount
+of functionality provided by the Tika library. You can do so by bypassing Rika altogether and using the Tika jar file
+directly in your own JRuby code. In addition. Tika provides its own command line application that can be called as, 
+for example, `java -jar $TIKA_JAR_FILESPEC --help`. This Tika command line application has finer grained control
+over some Tika options, but is missing some conveniences provided by the Rika command line application.
+
 ## Other Tika Resources
 
 * The Apache Tika wiki is at https://cwiki.apache.org/confluence/display/tika.
@@ -265,3 +277,8 @@ without any version manager at all, but those configurations have not been teste
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Acknowledgments
+
+Many thanks to the brilliant and dedicated developers who have worked to build Apache Tika since its inception many years ago.
+

data/RELEASE_NOTES.md

@@ -1,5 +1,15 @@
 ## Release Notes
 
+### v2.0.3
+
+* Fix parsing of empty files so they do not halt parsing of all files.
+* Update gem dependencies.
+
+#### v2.0.2
+
+* Now prints source name on line with header and footer lines.
+* Improve help text.
+
 #### v2.0.1
 
 * Fix license specification in gemspec, update copyright name and year.

data/lib/rika/cli/args_parser.rb

@@ -72,7 +72,7 @@ class ArgsParser
         options[:key_sort] = (v.nil? ? true : v)
       end
 
-      opts.on('-s', '--[no-]source [FLAG]', TrueClass, 'Output document source file or URL') do |v|
+      opts.on('-s', '--[no-]source [FLAG]', TrueClass, 'Output document source file or URL (default: false)') do |v|
         options[:source] = (v.nil? ? true : v)
       end
 

data/lib/rika/cli/rika_command.rb

@@ -32,6 +32,13 @@ class RikaCommand
       puts result_array_output
     else
       targets.each do |target|
+        # If we don't do this, Tika will raise an org.apache.tika.exception.ZeroByteFileException
+        # TODO: Do same for URL?
+        if File.file?(target) && File.zero?(target)
+          $stderr.puts("\n\nFile empty!: #{target}\n\n")
+          next
+        end
+
         result = Rika.parse(target, max_content_length: max_content_length, key_sort: options[:key_sort])
         puts single_document_output(target, result)
       end
@@ -71,6 +78,20 @@ class RikaCommand
     h
   end
 
+  # Outputs the source file or URL in the form of:
+  # -------------------------------------------------------------------------------
+  # Source: path/to/file.ext
+  # -------------------------------------------------------------------------------
+  # @param [String] source document source identifier
+  # @return multiline string as displayed above
+  private def source_output_string(source)
+    <<~STRING
+      -------------------------------------------------------------------------------
+      Source: #{source}
+      -------------------------------------------------------------------------------
+    STRING
+  end
+
   # Builds the string representation of the result of parsing a single document
   # @param [String] target the target document
   # @param [ParseResult] result the parse result
@@ -80,7 +101,7 @@ class RikaCommand
       metadata_formatter.(result_hash(result))
     else
       sio = StringIO.new
-      sio << "Source: #{target}\n"                        if options[:source]
+      sio << source_output_string(target)                 if options[:source]
       sio << metadata_formatter.(result.metadata) << "\n" if options[:metadata]
       sio << text_formatter.(result.content) << "\n"      if options[:text]
       sio.string

data/lib/rika/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rika
-  VERSION = '2.0.1'
+  VERSION = '2.0.3'
 end

data/rika.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ['lib']
-  gem.add_dependency 'awesome_print'
+  gem.add_dependency 'awesome_print', '~> 1.9', '>= 1.9.2'
   gem.platform = 'java'
   gem.license = 'MIT'
   gem.metadata['rubygems_mfa_required'] = 'true'

data/spec/fixtures/something.txt

@@ -0,0 +1 @@
+something

data/spec/rika/cli/rika_command_spec.rb

@@ -117,4 +117,39 @@ describe RikaCommand do
       expect(output).to include('sample help text')
     end
   end
+
+  describe '#source_output_string' do
+    let(:rika_command) { described_class.new([]) }
+    let(:sample_filespec) { 'path/to/file.ext' }
+    let(:sample_output_string) { rika_command.send(:source_output_string, sample_filespec) }
+    let(:sample_output_lines) { sample_output_string.lines.map(&:chomp) }
+    let(:header_trailer_line) { '-' * 79 }
+
+    specify 'it has a header and trailer line' do
+      expect(sample_output_lines[0]).to eq(header_trailer_line)
+      expect(sample_output_lines[2]).to eq(header_trailer_line)
+    end
+
+    specify 'information line is well formed' do
+      line = sample_output_lines[1]
+      expect(line).to match("Source: #{sample_filespec}")
+    end
+  end
+
+  describe 'empty file behavior' do
+    let(:empty_file_path) { fixture_path('empty.txt') }
+    let(:something_file_path) { fixture_path('something.txt') } # containts "something"
+
+    specify 'parsing an empty file outputs a message to stderr' do
+      expect {
+        described_class.new([empty_file_path]).call
+      }.to output("\n\nFile empty!: #{empty_file_path}\n\n").to_stderr
+    end
+
+    specify 'parsing an empty file does not interrupt parsing of subsequent files' do
+      expect {
+        described_class.new([empty_file_path, something_file_path]).call
+      }.to output(/something/).to_stdout
+    end
+  end
 end

data/spec/rika/parser_spec.rb

@@ -161,10 +161,6 @@ describe Rika::Parser do
       expect(pdf_parse_result.content.lines[1]).to include(quote_first_line)
     end
 
-    it 'returns no content for an image' do
-      expect(image_parse_result.content).to be_empty
-    end
-
     it 'only returns max content length from a text file' do
       expect(Rika.parse(fixture_path('document.txt'), max_content_length: 8).content).to eq('Stopping')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rika
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: java
 authors:
 - Richard Nyström
@@ -9,22 +9,28 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.9.2
   name: awesome_print
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.9.2
 description: A JRuby wrapper for Apache Tika to extract text and metadata from files
   of various formats.
 email:
@@ -60,6 +66,7 @@ files:
 - spec/fixtures/document.docx
 - spec/fixtures/document.pdf
 - spec/fixtures/document.txt
+- spec/fixtures/empty.txt
 - spec/fixtures/en.txt
 - spec/fixtures/es.txt
 - spec/fixtures/fr.txt
@@ -67,6 +74,7 @@ files:
 - spec/fixtures/image_jpg_without_extension
 - spec/fixtures/lang_cant_be_determined.txt
 - spec/fixtures/ru.txt
+- spec/fixtures/something.txt
 - spec/fixtures/tiny.txt
 - spec/fixtures/unknown.bin
 - spec/rika/cli/args_parser_spec.rb