pdfh 4.0.1 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 833d681fc080cc70f16c365322eb3d6c9acdccfcc817ccd8cac317fa89b03b31
-  data.tar.gz: d818e4a7f2b65d06362525b5ecb94d534422d78ae8fa60357109603be6629467
+  metadata.gz: a5ef9e4932b73970339e621800eaadd8de7c0bbc07c4536ea4f360fc5227c27a
+  data.tar.gz: 9b02deb23b1522d0debb7a9b480b82b7e69c3bedf286743cd3e7a4c065bc6e97
 SHA512:
-  metadata.gz: 629936ffe78b2a1a9d8e405ac5ed1de5a7c4c2ae2022d8722888fa467e75b674961e51f381f7d5c62698a4b480a9405190f79ff57f6fe9ba38e0d781273590dc
-  data.tar.gz: 3a3658de5d2775ba4a5503847f374e82d42fc73c64cffe5d5fb723ee73953c1d027f27325be9b4e7f31be7766f8f6b715515c1623fbb381b528bd2489c6e7c14
+  metadata.gz: 9f694edb6bbe90f5cccb66d94bdf901983b9824f9de71e444065fa98aab75da4ab951965aed0b18de2246c60768e223035294b34d2c3459c251a5a7df2f13678
+  data.tar.gz: e2253c53cf4936b9422465ba0bbdf5a7a59b0fc8c0ec8b4bbb63e0bac5d613d80d8ccb490c218d6f7efc09eb16b077e9d13e65c958e6c3ce099cd0b905bf2280

data/.pre-commit-config.yaml

@@ -25,12 +25,6 @@ repos:
     hooks:
       - id: gitleaks
 
-  - repo: https://github.com/rubocop/rubocop
-    rev: v1.86.0
-    hooks:
-      - id: rubocop
-        args: [--parallel]
-
   - repo: https://github.com/compilerla/conventional-pre-commit
     rev: v4.4.0
     hooks:

data/AGENTS.md

@@ -43,10 +43,18 @@ Useful `mise` tasks (`mise.toml`):
 - `mise run test` (runs `bundle exec rspec --order random --format documentation`)
 - `mise run check` (runs lint + test)
 - `mise run bump[major|minor|tiny]`
-- `mise run pre` (runs `pre-commit run --all-files`)
+- `mise run pre` (runs `pre-commit run --all-files`; also runs `gitleaks` and `codespell`, which can block a commit independently of RuboCop/tests)
 - `mise run update` (runs `bundle update`)
 - `mise run release` (builds gem + pushes to RubyGems)
 
+Equivalent `just` recipes (`justfile`) are also available and wrap the same commands:
+
+- `just check` (lint + test)
+- `just test` / `just test-file spec/path_spec.rb:42`
+- `just lint` (runs `rubocop -a`, auto-fixes)
+- `just bump [major|minor|tiny]`
+- `just release`
+
 ## Repository Layout
 
 - `exe/pdfh` CLI entrypoint
@@ -59,7 +67,11 @@ Useful `mise` tasks (`mise.toml`):
 ## Processing Flow (High Level)
 
 ```text
-exe/pdfh → Main.start → OptParser → SettingsBuilder → SettingsValidator
+exe/pdfh → DependencyValidator (qpdf, pdftotext) → Main.start
+                                              ↓
+                                   OptParser (ARGV)
+                                              ↓
+                               SettingsBuilder → SettingsValidator
                                                             ↓
                                          DirectoryScanner.scan (finds *.pdf)
                                                             ↓
@@ -76,9 +88,9 @@ Key service objects in `lib/pdfh/services/`:
 - `PdfTextExtractor` — shells out `pdftotext -enc UTF-8 -layout`
 - `DocumentMatcher` — iterates `DocumentType`s; matches `re_id` then `re_date`
 - `DocumentManager` — creates dest dir, copies/renames PDF, copies companion files
-- `SettingsBuilder` — locates and parses `pdfh.yml`
+- `SettingsBuilder` — resolves config from env/known locations (`.yml`/`.yaml`), validates, and builds `Settings`
 - `SettingsValidator` — validates settings; raises `ArgumentError` on fatal errors, warns and skips on soft errors (e.g. missing lookup dirs)
-- `OptParser` — parses `ARGV` into `RunOptions`
+- `OptParser` — parses `ARGV` into `RunOptions`; supports `--list-types`, `-v/--verbose`, `-d/--dry`, `-V/--version`, `-h/--help`
 
 ## Code Style and Conventions
 
@@ -127,6 +139,7 @@ Side effects and IO:
 - File system changes are centralized in `DocumentManager`.
 - Respect `dry_run` / `--dry` to avoid writing files.
 - When copying/moving files, preserve metadata if possible (`FileUtils` with `preserve: true`).
+- After successful processing, source PDFs are moved to `*.bkp` in place (`DocumentManager#backup_original`).
 
 Testing:
 
@@ -136,7 +149,9 @@ Testing:
 
 ## Configuration and Templates
 
-- Configuration is loaded from `$PDFH_CONFIG_FILE`, then CWD, `~/.config/`, then `~/`.
+- Configuration is loaded from `$PDFH_CONFIG_FILE`, then CWD, then `$XDG_CONFIG_HOME` (default `~/.config`), then `~/`.
+- Supported config file extensions are `.yml` and `.yaml`.
+- If no config file is found, `SettingsBuilder` creates a default template at `~/pdfh.yml`.
 - Document templates use `{placeholder}` tokens defined in `Document#rename_data`.
 - Date regex supports named captures `(?<m>...)` / `(?<y>...)` / `(?<d>...)` or positional captures.
 
@@ -149,8 +164,10 @@ Testing:
 - **v4 breaking change**: Config format changed in v4.0.0 — old configs are incompatible. `re_id` matches PDF *text content* (not filename). New placeholders: `{day}`, `{quarter}`, `{bimester}`, `{name}`.
 - **Multi-match behavior**: PDFs matching more than one `DocumentType` are silently skipped (see `Main.start`).
 - **`_unlocked` suffix**: `DocumentManager` strips `_unlocked` when locating companion files — legacy pattern from `qpdf` unlocking.
-- **Config search path**: `$PDFH_CONFIG_FILE` → CWD → `~/.config/` → `~/`. Error message does not list paths checked.
+- **First run side effect**: Missing config does not fail fast; it auto-creates `~/pdfh.yml` and continues from that template.
+- **Dependency mismatch risk**: `qpdf` is still checked at startup (`exe/pdfh`) even though normal v4 processing does not call it directly.
 - **Colorize in tests**: Logging output is colored via `colorize`; specs mock `Console` with shared context `"with silent console"` to suppress output.
+- **CI only lints, not tests**: `.github/workflows/rubocop-analysis.yml` is the only CI workflow and runs RuboCop only (via CodeQL/SARIF upload); RSpec is not run in CI. Always run `mise run test` locally — a green CI check does not mean tests pass.
 
 ## Suggested Workflow for Agents
 
@@ -159,6 +176,10 @@ Testing:
 - Run `mise run lint` and `mise run test` before finalizing changes.
 - Keep changes localized; avoid touching unrelated files.
 
+## Repo Etiquette
+
+- Commit messages must follow Conventional Commits format (e.g. `fix:`, `feat:`, `chore:`) — enforced by the `conventional-pre-commit` `commit-msg` hook in `.pre-commit-config.yaml`. Non-conforming messages are rejected.
+
 ## Examples
 
 Run a single spec:

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v4.0.3 - 2026-09-21
+
+- Centralize `_unlocked` suffix handling in `FileInfo#stem`
+- Upgrade gems
+
+## v4.0.2 - 2026-08-03
+
+- Skip `.bkp` files when copying companion files
+
+## v4.0.1 - 2026-03-24
+
+- Fix incorrect `require`
+
 ## v4.0.0 - 2026-03-21
 
 ### Breaking

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    pdfh (4.0.1)
+    pdfh (4.0.3)
       colorize (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.1.3)
+    activesupport (8.1.3.1)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -22,57 +22,58 @@ GEM
       uri (>= 0.13.1)
     ast (2.4.3)
     base64 (0.3.0)
-    bigdecimal (4.0.1)
+    bigdecimal (4.1.3)
     code-scanning-rubocop (0.6.1)
       rubocop (~> 1.0)
     colorize (1.1.0)
-    concurrent-ruby (1.3.6)
+    concurrent-ruby (1.3.8)
     connection_pool (3.0.2)
-    date (3.5.1)
     debug (1.11.1)
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.6.2)
     docile (1.4.1)
     drb (2.2.3)
-    erb (6.0.2)
-    factory_bot (6.5.6)
+    erb (6.0.7)
+    factory_bot (6.6.0)
       activesupport (>= 6.1.0)
-    i18n (1.14.8)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
-    io-console (0.8.2)
-    irb (1.17.0)
+    io-console (0.9.4)
+    irb (1.18.0)
       pp (>= 0.6.0)
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.19.2)
-    language_server-protocol (3.17.0.5)
+    json (3.0.2)
+    language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
-    minitest (6.0.2)
+    minitest (6.0.6)
       drb (~> 2.0)
       prism (~> 1.5)
-    parallel (1.27.0)
-    parser (3.3.10.2)
+    parallel (2.2.0)
+    parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
-    pp (0.6.3)
+    pp (0.6.4)
       prettyprint
     prettyprint (0.2.0)
     prism (1.9.0)
-    psych (5.3.1)
-      date
-      stringio
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.1)
-    rdoc (7.2.0)
+    rake (13.4.2)
+    rbs (4.2.0)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
       erb
-      psych (>= 4.0.0)
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
       tsort
-    regexp_parser (2.11.3)
-    reline (0.6.3)
+    regexp_parser (2.13.0)
+    reline (0.7.0)
       io-console (~> 0.5)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
@@ -87,33 +88,34 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.86.0)
-      json (~> 2.3)
+    rubocop (1.91.0)
+      json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
       rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.1)
+    rubocop-ast (1.50.0)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
     rubocop-factory_bot (2.28.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
-    rubocop-performance (1.26.1)
+    rubocop-performance (1.27.0)
       lint_roller (~> 1.1)
-      rubocop (>= 1.75.0, < 2.0)
+      rubocop (>= 1.89.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.9.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.81)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
     simplecov (0.22.0)
@@ -122,13 +124,12 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    stringio (3.2.0)
     tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.2.0)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
     uri (1.1.1)
 
 PLATFORMS
@@ -150,4 +151,4 @@ DEPENDENCIES
   simplecov (~> 0.22)
 
 BUNDLED WITH
-  4.0.9
+  4.0.21

data/lib/pdfh/services/document_manager.rb

@@ -4,8 +4,6 @@ module Pdfh
   module Services
     # Manages the documents, rename, move, etc.
     class DocumentManager
-      PDF_UNLOCKED_MAGIC_SUFFIX = "_unlocked"
-
       # @param document [Document]
       # @param base_path [String]
       # @param dry_run [Boolean]
@@ -86,19 +84,22 @@ module Pdfh
         FileUtils.mv(source_file, backup_file) unless dry_run?
       end
 
-      # Finds companion files by removing the _unlocked suffix from the PDF name if present.
-      # This allows PDFs unlock by qpdf to locate their original companion files (e.g., .xml, .txt)
-      # that were never renamed with the _unlocked suffix.
+      # Finds companion files by using the document's clean stem, which already has the
+      # `_unlocked` suffix removed (see Pdfh::FileInfo#stem). This allows PDFs unlocked by
+      # qpdf to locate their original companion files (e.g., .xml, .txt) that were never
+      # renamed with the `_unlocked` suffix.
+      # Excludes PDF files and `.bkp` backup files (already-processed PDFs renamed by +backup_original+).
       #
-      # @return [Array<String>] array of non-PDF files with the same base name
+      # @return [Array<String>] array of non-PDF, non-backup files with the same base name
       # @example
       #   # If document is "cuenta_unlocked.pdf", searches for "cuenta.*"
-      #   # Returns ["cuenta.xml", "cuenta.txt"] (excluding "cuenta.pdf")
+      #   # Returns ["cuenta.xml", "cuenta.txt"] (excluding "cuenta.pdf" and "cuenta.pdf.bkp")
       def companion_files
         @companion_files ||= begin
-          base_name = document.file_info.stem.delete_suffix(PDF_UNLOCKED_MAGIC_SUFFIX)
+          base_name = document.file_info.stem
           Dir.glob(File.join(document.file_info.dir, "#{base_name}.*")).reject do |file|
-            File.extname(file) == ".pdf"
+            ext = File.extname(file)
+            ext == ".pdf" || file.end_with?(".bkp")
           end
         end
       end

data/lib/pdfh/utils/file_info.rb

@@ -4,6 +4,10 @@ module Pdfh
   # Encapsulates file system metadata for a PDF file path.
   # Responsible for all file name derivations (extension, base name, backup name, etc.).
   class FileInfo
+    # Magic suffix added by qpdf when unlocking a PDF. Treated as noise: it is
+    # never part of the real document name.
+    PDF_UNLOCKED_MAGIC_SUFFIX = "_unlocked"
+
     # @param file_path [String] Absolute or relative path to the PDF file
     # @return [self]
     def initialize(file_path)
@@ -13,9 +17,9 @@ module Pdfh
     # @return [String] Full path to the file
     attr_reader :path
 
-    # @return [String] File name without extension (e.g., "cuenta")
+    # @return [String] File name without extension or the `_unlocked` magic suffix (e.g., "cuenta")
     def stem
-      File.basename(@path, extension)
+      File.basename(@path, extension).delete_suffix(PDF_UNLOCKED_MAGIC_SUFFIX)
     end
     alias name_only stem
 

data/lib/pdfh/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pdfh
-  VERSION = "4.0.1"
+  VERSION = "4.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdfh
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.3
 platform: ruby
 authors:
 - Isaias Piña
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Organize PDF files
 test_files: []