pdf_outline_editor 0.1.0-java → 0.2.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4919cc4df58a6af4c74185a140a8845176b9afef34bed77558171361fbb299e
-  data.tar.gz: 3dd0368ac59022b051083b41b48dc48a21944e1d224d570574651d95298697a5
+  metadata.gz: db0e27ede890c9f281ca74ca4d832b3b6e7f40c6c0fbf6a328695efc6f8604ed
+  data.tar.gz: d022eae7b5f029b68e872387808a3939697374532b68c8adcef7e29fbee4c1b7
 SHA512:
-  metadata.gz: 9e523afaa754c0b56534e34dd65688416d6e6b109770890f8bc19b0a7fff8ae586c828e9fe35a2245ea0164582ccb7e96d590a2afe3d8b260158cc27bfd5ad5e
-  data.tar.gz: 77fbe6d6d9d8afaf5bd4eb78aa987a857ef1690e99e6a72379eb487820526aa5e47779a25f30f3f3cd09ca63a3c1697517f0330e9053a79cd0505b0a3a445b84
+  metadata.gz: bc3d9da6964efdeb79b574d0a557d4de66907ea0107a48d7e0391452385ba36291bc0ace1bcd3043299e18a9fb7df841a7c63fbe93f9681d318252b2fb84eb1a
+  data.tar.gz: d6f3f2bf0c82ecee7a6b8b7f8447de2cafbdf05f155c5bb0e1280cc67888654b3caf9874febdc4aa076f7c9de7e487c70dd54163276a8db52d7d9d203a475e7e

data/README.md

@@ -1,9 +1,11 @@
-# `pdf_outline_editor`
+# pdf\_outline\_editor
 
 [![Build Status](https://travis-ci.org/healthypackrat/pdf_outline_editor.svg?branch=master)](https://travis-ci.org/healthypackrat/pdf_outline_editor)
 
 This gem provides a command to get/set PDF outlines from a JSON/YAML definition file.
 
+Useful for [PDF files which don't have outlines](https://github.com/healthypackrat/pdf-outlines).
+
 ## Requirements
 
 - JRuby
@@ -16,7 +18,7 @@ $ jgem install pdf_outline_editor
 
 ## Usage
 
-First, generate outlines definition file by running `init` command:
+First, generate an outlines definition file by running `init` command:
 
 ```
 $ pdf_outline_editor init -f json > toc.json
@@ -38,9 +40,9 @@ $ pdf_outline_editor load input.pdf toc.json output.pdf
 
 ## Development
 
-Run `bin/jruby-ng-server` in a new terminal window for faster loading.
+Run `bin/rspec` to run the specs.
 
-Then run `bin/rspec` to run the specs.
+Run `bin/rubocop` to check formattings.
 
 ## Contributing
 

data/exe/pdf_outline_editor

@@ -1,11 +1,12 @@
 #!/usr/bin/env jruby
+# frozen_string_literal: true
 
-require "pdf_outline_editor"
+require 'pdf_outline_editor'
 
 begin
   runner = PdfOutlineEditor::Runner.new(ARGV)
   runner.run
-rescue PdfOutlineEditor::Error => error
-  warn error.message
+rescue PdfOutlineEditor::Error => e
+  warn e.message
   exit 1
 end

data/lib/pdf_outline_editor/commands/dump_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module PdfOutlineEditor
@@ -8,7 +10,7 @@ module PdfOutlineEditor
       def initialize(argv)
         @parser = nil
 
-        @output_formats = [:json, :yaml]
+        @output_formats = %i[json yaml]
         @output_format = :json
 
         @input_pdf_path = nil
@@ -22,9 +24,7 @@ module PdfOutlineEditor
         Dumper.open(@input_pdf_path) do |dumper|
           outlines = dumper.dump
 
-          if outlines
-            puts send("convert_to_#{@output_format}", outlines)
-          end
+          puts send("convert_to_#{@output_format}", outlines) if outlines
         end
       end
 
@@ -35,7 +35,7 @@ module PdfOutlineEditor
 
         @parser = OptionParser.new
 
-        @parser.banner = "Usage: #{File.basename($0)} dump [options] <input-pdf-path>"
+        @parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} dump [options] <input-pdf-path>"
 
         desc = "Output format (default: #{@output_format}; one of #{@output_formats.join(', ')})"
         @parser.on('-f', '--format=FORMAT', @output_formats, desc) do |value|

data/lib/pdf_outline_editor/commands/init_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module PdfOutlineEditor
@@ -8,7 +10,7 @@ module PdfOutlineEditor
       def initialize(argv)
         @parser = nil
 
-        @output_formats = [:json, :yaml]
+        @output_formats = %i[json yaml]
         @output_format = :json
 
         parser.parse!(argv)
@@ -42,7 +44,7 @@ module PdfOutlineEditor
 
         @parser = OptionParser.new
 
-        @parser.banner = "Usage: #{File.basename($0)} init [options]"
+        @parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} init [options]"
 
         desc = "Output format (default: #{@output_format}; one of #{@output_formats.join(', ')})"
         @parser.on('-f', '--format=FORMAT', @output_formats, desc) do |value|

data/lib/pdf_outline_editor/commands/load_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module PdfOutlineEditor
@@ -29,20 +31,24 @@ module PdfOutlineEditor
 
         @parser = OptionParser.new
 
-        @parser.banner = "Usage: #{File.basename($0)} load <input-pdf-path> <input-outlines-path> <output-pdf-path>"
+        @parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} load <input-pdf-path> <input-outlines-path> <output-pdf-path>"
 
         @parser
       end
 
       def handle_args(argv)
         @input_pdf_path = argv.shift
+
         raise Error, 'missing input pdf path' unless @input_pdf_path
 
         input_outlines_path = argv.shift
+
         raise Error, 'missing input outlines path' unless input_outlines_path
+
         @outlines = parse_outlines(input_outlines_path)
 
         @output_pdf_path = argv.shift
+
         raise Error, 'missing output pdf path' unless @output_pdf_path
       end
 
@@ -51,11 +57,9 @@ module PdfOutlineEditor
 
         method_name = "parse_#{ext}_outlines"
 
-        if respond_to?(method_name, true)
-          send(method_name, path)
-        else
-          raise Error, "unknown extension: #{ext}"
-        end
+        raise Error, "unknown extension: #{ext}" unless respond_to?(method_name, true)
+
+        send(method_name, path)
       end
 
       def parse_json_outlines(path)

data/lib/pdf_outline_editor/dumper.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module PdfOutlineEditor
   class Dumper
     java_import org.apache.pdfbox.pdmodel.PDDocument
 
     JavaFile = java.io.File
+    IOException = java.io.IOException
 
     def self.open(input_pdf_path)
       dumper = new(input_pdf_path)
@@ -19,8 +22,8 @@ module PdfOutlineEditor
     def initialize(input_pdf_path)
       begin
         @doc = PDDocument.load(JavaFile.new(input_pdf_path))
-      rescue
-        raise Error, $!.message
+      rescue IOException => e
+        raise Error, e.message
       end
 
       @pages = @doc.pages
@@ -31,18 +34,16 @@ module PdfOutlineEditor
     def dump
       root_outline = @doc.document_catalog.document_outline
 
-      if root_outline
-        traverse(root_outline)
-      else
-        nil
-      end
+      return unless root_outline
+
+      traverse(root_outline)
     end
 
     def close
-      unless @closed
-        @doc.close
-        @closed = true
-      end
+      return if @closed
+
+      @doc.close
+      @closed = true
     end
 
     private

data/lib/pdf_outline_editor/loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PdfOutlineEditor
   class Loader
     java_import org.apache.pdfbox.pdmodel.PDDocument
@@ -6,6 +8,7 @@ module PdfOutlineEditor
     java_import org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
 
     JavaFile = java.io.File
+    IOException = java.io.IOException
 
     def self.open(input_pdf_path)
       loader = new(input_pdf_path)
@@ -22,17 +25,19 @@ module PdfOutlineEditor
     def initialize(input_pdf_path)
       begin
         @doc = PDDocument.load(JavaFile.new(input_pdf_path))
-      rescue
-        raise Error, $!.message
+      rescue IOException => e
+        raise Error, e.message
       end
 
+      @doc.set_all_security_to_be_removed(true)
+
       @pages = @doc.pages.to_a
 
       @closed = false
     end
 
     def load(entries)
-      root_outline =  PDDocumentOutline.new
+      root_outline = PDDocumentOutline.new
 
       @doc.document_catalog.document_outline = root_outline
 
@@ -46,10 +51,10 @@ module PdfOutlineEditor
     end
 
     def close
-      unless @closed
-        @doc.close
-        @closed = true
-      end
+      return if @closed
+
+      @doc.close
+      @closed = true
     end
 
     private

data/lib/pdf_outline_editor/runner.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module PdfOutlineEditor
   class Runner
     class << self
-      _known_commands = {}
+      known_commands = {}
 
       define_method :known_commands do
-        _known_commands
+        known_commands
       end
 
       define_method :register_command do |key, klass|
-        _known_commands[key] = klass
+        known_commands[key] = klass
       end
     end
 
@@ -23,20 +25,16 @@ module PdfOutlineEditor
     end
 
     def run
-      if @argv.empty?
-        raise Error, "missing a command: available commands are #{Runner.known_commands.keys.sort.join(', ')}"
-      end
+      raise Error, "missing a command: available commands are #{Runner.known_commands.keys.sort.join(', ')}" if @argv.empty?
 
       command_name = @argv.shift
 
       command_class = Runner.known_commands[command_name.to_sym]
 
-      if command_class
-        command = command_class.new(@argv)
-        command.run
-      else
-        raise Error, "unknown command: #{command_name}"
-      end
+      raise Error, "unknown command: #{command_name}" unless command_class
+
+      command = command_class.new(@argv)
+      command.run
     end
 
     private
@@ -46,7 +44,7 @@ module PdfOutlineEditor
 
       @parser = OptionParser.new
 
-      @parser.banner = "Usage: #{File.basename($0)} <command> <args>"
+      @parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} <command> <args>"
 
       @parser.version = VERSION
 

data/lib/pdf_outline_editor/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PdfOutlineEditor
-  VERSION = "0.1.0"
+  VERSION = '0.2.1'
 end

data/lib/pdf_outline_editor.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'java'
 
-require_relative '../vendor/pdfbox/pdfbox-app-2.0.13.jar'
+require_relative '../vendor/pdfbox/pdfbox-app-2.0.25.jar'
 
 require 'pdf_outline_editor/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf_outline_editor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: java
 authors:
 - healthypackrat
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-31 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   name: rake
   prerelease: false
   type: :development
@@ -37,7 +37,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -70,11 +70,12 @@ files:
 - lib/pdf_outline_editor/loader.rb
 - lib/pdf_outline_editor/runner.rb
 - lib/pdf_outline_editor/version.rb
-- vendor/pdfbox/pdfbox-app-2.0.13.jar
+- vendor/pdfbox/pdfbox-app-2.0.25.jar
 homepage: https://github.com/healthypackrat/pdf_outline_editor
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -90,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.2.29
 signing_key:
 specification_version: 4
 summary: Set PDF outlines from a JSON/YAML definition file