vivlio-starter-pdf 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65b529f996ccbfdab12d4a410404206e4580126c6e75dcbc1b45fb88c6044241
-  data.tar.gz: 6b8b71dbf5f5f622cca5dc4328016a71b0c29b3fa72dacb83914daae5abd4ac8
+  metadata.gz: e62753237dedde7804b194cc7a2c06e0ca662f3b7fe2e002478880908fd02357
+  data.tar.gz: fcc0002eb6f708ee15e15e9a641c0dadca9ace84b557eff8f47cae2a303dcc8c
 SHA512:
-  metadata.gz: 01cd3cebf924395a018536bfff12940f6990c1051c2a782c48ff56bfb397c3c363d26c33c2b6e6abfdead321e884e0a9ec2da4189f4cbc656271d25c95c3d309
-  data.tar.gz: 4dc1e2d408d87ebd5738fc697338de5c55d7f8f62d6f38224774e263c392fb4a70e67ebb2f9354c3d76a747229f204c151173c1852f7a481d0d4149713f3e550
+  metadata.gz: 9e4a64d5e1e49dea7345e0411621bc09ee9d0e89de0413d56f7e894443510bcb68a18a47083e56fdece15352ec29a087abcfb1830852ebd8ae5a9d4db673f351
+  data.tar.gz: 27f71113236fdec22d5982fccdcf66527a5b1e4b389344dadc8bf3893a82f4ae6d5305b216f45dde7230c412c08e6f719f84a43d59889aee20135e1764cff8b8

data/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2026-06-10
+
+### Changed
+- 本体側に合わせ、lib/vivlio_starter/cli/pdf/配下にファイル構成を調整した。
+
 ## [1.0.1] - 2026-03-21
 
 ### Added

data/Rakefile

@@ -10,3 +10,18 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+# gem のアンインストール → ビルド → インストールを一括実行
+task :reinstall do
+  gemspec = Dir['*.gemspec'].first
+  raise 'gemspec が見つかりません' unless gemspec
+
+  require_relative 'lib/vivlio_starter/pdf/version'
+  version = VivlioStarter::Pdf::VERSION
+  gem_name = 'vivlio-starter-pdf'
+  gem_file = "#{gem_name}-#{version}.gem"
+
+  sh "gem uninstall #{gem_name} --version #{version} --executables --ignore-dependencies 2>/dev/null || true"
+  sh "gem build #{gemspec}"
+  sh "gem install #{gem_file}"
+end

data/exe/vivlio-starter-pdf

@@ -1,52 +1,50 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'vivlio/starter/pdf'
+require 'vivlio_starter/pdf'
 
 # vivlio-starter-pdf CLI
 # Provides basic version information for debugging and user confirmation
 
-module Vivlio
-  module Starter
-    module PDF
-      class CLI
-        def self.run(args = [])
-          case args[0]
-          when '--version', '-v'
-            puts "vivlio-starter-pdf #{VERSION}"
-          when '--help', '-h', nil
-            puts <<~HELP
-              vivlio-starter-pdf #{VERSION} - Advanced PDF processor for vivlio-starter
-              
-              Usage:
-                vivlio-starter-pdf [options]
-              
-              Options:
-                --version, -v  Print version and exit
-                --help, -h     Print this help and exit
-              
-              Description:
-                vivlio-starter-pdf is an AGPL-licensed plugin for vivlio-starter
-                that provides advanced PDF processing capabilities including:
-                - PDF to Markdown conversion using HexaPDF
-                - Japanese OCR support with Tesseract
-                - Image extraction and precise positioning
-                - PDF outline generation and hidden pagination
-              
-              This is a plugin and should be used through vivlio-starter:
-                vs pdf:read document.pdf
-              
-              For more information, visit: https://github.com/Atelier-Mirai/vivlio-starter-pdf
-            HELP
-          else
-            puts "Error: Unknown option '#{args[0]}'"
-            puts "Use 'vivlio-starter-pdf --help' for usage information."
-            exit 1
-          end
+module VivlioStarter
+  module Pdf
+    class CLI
+      def self.run(args = [])
+        case args[0]
+        when '--version', '-v'
+          puts "vivlio-starter-pdf #{VERSION}"
+        when '--help', '-h', nil
+          puts <<~HELP
+            vivlio-starter-pdf #{VERSION} - Advanced PDF processor for vivlio-starter
+
+            Usage:
+              vivlio-starter-pdf [options]
+
+            Options:
+              --version, -v  Print version and exit
+              --help, -h     Print this help and exit
+
+            Description:
+              vivlio-starter-pdf is an AGPL-licensed plugin for vivlio-starter
+              that provides advanced PDF processing capabilities including:
+              - PDF to Markdown conversion using HexaPDF
+              - Japanese OCR support with Tesseract
+              - Image extraction and precise positioning
+              - PDF outline generation and hidden pagination
+
+            This is a plugin and should be used through vivlio-starter:
+              vs pdf:read document.pdf
+
+            For more information, visit: https://github.com/Atelier-Mirai/vivlio-starter-pdf
+          HELP
+        else
+          puts "Error: Unknown option '#{args[0]}'"
+          puts "Use 'vivlio-starter-pdf --help' for usage information."
+          exit 1
         end
       end
     end
   end
 end
 
-Vivlio::Starter::PDF::CLI.run(ARGV)
+VivlioStarter::Pdf::CLI.run(ARGV)

data/lib/vivlio_starter/cli/pdf/enhanced_provider.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require "hexapdf"
+require_relative "utilities"
+require_relative "log_helper"
+require_relative "outline_writer"
+
+module VivlioStarter
+  module Pdf
+    # vivlio-starter 本体から呼び出される HexaPDF ベースのプロバイダ
+    #
+    # 隠しノンブル書き込み・PDF アウトライン付与など、
+    # Enhanced Mode 固有の PDF 操作を提供する。
+    class EnhancedProvider
+      # 隠しノンブルに使用するフォント名
+      FONT_NAME = "Helvetica"
+      # 隠しノンブルのフォントサイズ（pt）
+      FONT_SIZE_PT = 6
+
+      # PDF のページ数を取得する
+      def page_count(pdf_path)
+        Utilities.page_count(pdf_path)
+      end
+
+      # 空白ページ PDF が存在しなければ生成する
+      def ensure_blank_page_pdf(path, width_pt, height_pt)
+        Utilities.ensure_blank_page_pdf(path, width_pt, height_pt)
+      end
+
+      # PDF の各ページに隠しノンブル（ページ番号）を書き込む
+      # 奇数ページは左端、偶数ページは右端に 90° 回転して配置する
+      # @param pdf_path [String] 対象 PDF のパス
+      # @param bleed_pt [Float] 塗り足し幅（pt）
+      # @return [Boolean] 成功なら true
+      def stamp_nombre!(pdf_path, bleed_pt:)
+        return false unless File.exist?(pdf_path)
+
+        document = HexaPDF::Document.open(pdf_path)
+        total = document.pages.count
+        return false if total.zero?
+
+        LogHelper.log_action("[NombreStamper] 隠しノンブルを書き込みます（#{total} ページ）[Enhanced Mode]…")
+
+        document.pages.each_with_index do |page, idx|
+          stamp_page(page, idx + 1, bleed_pt: bleed_pt.to_f)
+        end
+
+        document.write(pdf_path, optimize: true)
+        LogHelper.log_success("[NombreStamper] 隠しノンブル書き込み完了（#{total} ページ）")
+        true
+      rescue StandardError => e
+        LogHelper.log_error("[NombreStamper] 隠しノンブル書き込みに失敗: #{e.message}")
+        false
+      end
+
+      # PDF にアウトライン（しおり）を付与する
+      # OutlineWriter を使い、階層構造を HexaPDF のアウトラインツリーに変換する
+      # @param pdf_path [String] 対象 PDF のパス
+      # @param items [Array<Hash>] アウトライン項目（:level, :text, :page）
+      # @param max_level [Integer] アウトラインの最大階層深度
+      # @return [Boolean] 成功なら true
+      def add_outline!(pdf_path, items, max_level:)
+        return false unless File.exist?(pdf_path)
+
+        document = HexaPDF::Document.open(pdf_path)
+        writer = OutlineWriter.new(document, max_level:, on_skip: method(:log_outline_skip))
+        inserted = writer.write(items)
+        if inserted.zero?
+          LogHelper.log_warn("[OutlineWriter] 有効なアウトライン項目が存在しないためスキップしました")
+          return false
+        end
+
+        document.write(pdf_path, optimize: true)
+        LogHelper.log_success("[OutlineWriter] PDF にアウトラインを #{inserted} 件追加しました")
+        true
+      rescue StandardError => e
+        LogHelper.log_error("[OutlineWriter] PDF アウトライン付与に失敗: #{e.message}")
+        false
+      end
+
+      private
+
+      # 1 ページに隠しノンブルを描画する
+      # 奇数ページは左端 90°、偶数ページは右端 -90° に回転配置する
+      def stamp_page(page, page_number, bleed_pt:)
+        canvas = page.canvas(type: :overlay)
+        box = page.box(:media)
+
+        canvas.font(FONT_NAME, size: FONT_SIZE_PT)
+        canvas.fill_color(0)
+
+        x_offset = bleed_pt / 2.0
+        y_center = box.height / 2.0
+
+        if page_number.odd?
+          draw_rotated_text(canvas, page_number.to_s, x: x_offset, y: y_center, angle: 90)
+        else
+          draw_rotated_text(canvas, page_number.to_s, x: box.width - x_offset, y: y_center, angle: -90)
+        end
+      end
+
+      # キャンバス上の指定座標にテキストを回転描画する
+      def draw_rotated_text(canvas, text, x:, y:, angle:)
+        canvas
+          .save_graphics_state
+          .translate(x, y)
+          .rotate(angle)
+          .text(text, at: [0, 0])
+          .restore_graphics_state
+      end
+
+      # OutlineWriter のスキップ通知をログに出力するコールバック
+      def log_outline_skip(message)
+        LogHelper.log_warn("[OutlineWriter] #{message}")
+      end
+    end
+  end
+end

data/lib/vivlio_starter/cli/pdf/log_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module VivlioStarter
+  module Pdf
+    # Logging helper that integrates with vivlio-starter CLI when available
+    module LogHelper
+      module_function
+
+      def log_action(message)
+        dispatch(:log_action, message) { puts(message) }
+      end
+
+      def log_info(message)
+        dispatch(:log_info, message) { puts(message) }
+      end
+
+      def log_success(message)
+        dispatch(:log_success, message) { puts(message) }
+      end
+
+      def log_warn(message)
+        dispatch(:log_warn, message) { warn(message) }
+      end
+
+      def log_error(message)
+        dispatch(:log_error, message) { warn(message) }
+      end
+
+      def dispatch(method, message)
+        if defined?(VivlioStarter::CLI::Common)
+          VivlioStarter::CLI::Common.public_send(method, message)
+        else
+          yield if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/vivlio_starter/cli/pdf/outline_writer.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "hexapdf"
+
+module VivlioStarter
+  module Pdf
+    # Internal helper responsible for translating outline entries into HexaPDF structures.
+    class OutlineWriter
+      # @param doc [HexaPDF::Document] target document
+      # @param max_level [Integer] maximum depth allowed in the outline tree
+      # @param on_skip [Proc,nil] callback triggered when an entry is ignored
+      def initialize(doc, max_level:, on_skip: nil)
+        @doc = doc
+        @max_level = max_level.to_i.clamp(1, 6)
+        @page_count = @doc.pages.count
+        @on_skip = on_skip
+      end
+
+      # Writes the given +items+ into the document outline.
+      # @param items [Array<Hash>] entries with :level, :text, :page
+      # @return [Integer] number of inserted outline nodes
+      def write(items)
+        return 0 if @page_count.zero?
+
+        normalized = Array(items).filter_map { normalize_entry(it) }
+        return 0 if normalized.empty?
+
+        outline_root = rebuild_outline_root
+        stack = [{ level: 0, node: outline_root }]
+        inserted = 0
+
+        normalized.each do |entry|
+          parent = parent_for(entry[:level], stack)
+          destination = resolve_destination(entry[:page])
+          unless destination
+            warn_skip("page #{entry[:page]} is outside 1-#{@page_count}")
+            next
+          end
+
+          item = parent.add_item(entry[:text], destination:, open: entry[:level] < @max_level)
+          stack << { level: entry[:level], node: item }
+          inserted += 1
+        end
+
+        if inserted.zero?
+          @doc.catalog.delete(:Outlines)
+          return 0
+        end
+
+        inserted
+      end
+
+      private
+
+      # Normalizes a raw hash into a consistent entry structure.
+      def normalize_entry(raw)
+        text = fetch(raw, :text, fetch(raw, :title, nil)).to_s.strip
+        warn_skip("missing title for outline entry: #{raw.inspect}") if text.empty?
+        return nil if text.empty?
+
+        page = fetch(raw, :page, nil).to_i
+        if page <= 0
+          warn_skip("invalid page for outline entry: #{raw.inspect}")
+          return nil
+        end
+
+        level = fetch(raw, :level, 1).to_i
+        level = 1 if level < 1
+        level = @max_level if level > @max_level
+
+        { text:, page:, level: }
+      end
+
+      # Fetches a value from the entry by symbol or string key.
+      def fetch(raw, key, fallback)
+        if raw.respond_to?(:[]) && (raw[key] || raw[key.to_s])
+          raw[key] || raw[key.to_s]
+        else
+          fallback
+        end
+      end
+
+      # Returns the proper parent node for the requested level.
+      def parent_for(level, stack)
+        while stack.last[:level] >= level
+          break if stack.size == 1
+          stack.pop
+        end
+        stack.last[:node]
+      end
+
+      # Resolves the destination page for an entry.
+      def resolve_destination(page_number)
+        index = page_number.to_i - 1
+        return nil unless index.between?(0, @page_count - 1)
+
+        @doc.pages[index]
+      rescue StandardError
+        nil
+      end
+
+      # Recreates an empty outline root before inserting new nodes.
+      def rebuild_outline_root
+        @doc.catalog.delete(:Outlines)
+        outline_root = @doc.add({ Type: :Outlines }, type: :Outlines)
+        @doc.catalog[:Outlines] = outline_root
+        outline_root
+      end
+
+      # Emits skip notifications through the provided callback.
+      def warn_skip(message)
+        @on_skip&.call(message)
+      end
+    end
+  end
+end