pdfh 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecddee5472149aa038427798c482557111e62070ebed5558fdffcde55417b325
-  data.tar.gz: 75ff53bc3429bc5303411a81d3922e3f0b6f4249bf66bae396e867cd0b4615a9
+  metadata.gz: 2cc0c0f6ba735b3d69c9f5bf32e6acc94b185b3606574834504634acad34f1e8
+  data.tar.gz: fd4bf05918b2631d2cb6335341704be2540d50cdcf5a395e7e85dd2206c865ca
 SHA512:
-  metadata.gz: 4c51ac8db9d6f9b56c1608289c7d7694b21af6856eb69e06b4fd203ff2824ed3884a1ef1c64cefea37ff1358614e41e3c55264134d9616d9d14819d36ed7241a
-  data.tar.gz: b3d382767616e4008997ce8050691c1e578b8a181ee2a36a4fb4f6a8ed912e93f65511967db2990efbbcd33d73ffdc21535a5163ad9e248225e5e0054548b570
+  metadata.gz: c58687eba046fb229b713a70650554a93473b22c9fe39c6d5427adde475187ec64a91031fb9b6ef6f22de9e516a5b5f75e7bdd6276657541127247395d53cec4
+  data.tar.gz: 0bc6756a6c83335f4afaad5708da797bd5d4e052542b12fa0ee030e23e66a779fe6303aa21eb6f63b6bba849291bf3a2f08a0a32ea1ea4b4f05ab14f2c3b976d

data/Gemfile.lock

@@ -1,131 +1,148 @@
 PATH
   remote: .
   specs:
-    pdfh (3.1.0)
+    pdfh (3.2.0)
       colorize (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.2)
+    activesupport (8.0.1)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ansi (1.5.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.7)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     blockenspiel (0.5.0)
     code-scanning-rubocop (0.6.1)
       rubocop (~> 1.0)
     coderay (1.1.3)
     colorize (1.1.0)
-    concurrent-ruby (1.2.3)
-    connection_pool (2.4.1)
-    debug (1.9.2)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    date (3.4.1)
+    debug (1.10.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    diff-lcs (1.5.1)
-    docile (1.4.0)
+    diff-lcs (1.6.0)
+    docile (1.4.1)
     drb (2.2.1)
-    factory_bot (6.4.6)
-      activesupport (>= 5.0.0)
-    i18n (1.14.4)
+    factory_bot (6.5.1)
+      activesupport (>= 6.1.0)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    io-console (0.7.2)
-    irb (1.13.0)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.6.6)
     method_source (1.1.0)
-    minitest (5.22.3)
-    mutex_m (0.2.0)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    minitest (5.25.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
-    pry (0.14.2)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    psych (5.1.2)
+    psych (5.2.3)
+      date
       stringio
-    racc (1.7.3)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    rdoc (6.6.3.1)
+    rdoc (6.12.0)
       psych (>= 4.0.0)
-    regexp_parser (2.9.0)
-    reline (0.5.5)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
       io-console (~> 0.5)
-    rexml (3.2.6)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
+    rspec-support (3.13.2)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.63.4)
+    rubocop (1.73.2)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.1)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
+    rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
-    rubocop-performance (1.21.0)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (2.29.2)
+    rubocop-factory_bot (2.27.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-performance (1.24.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (2.31.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
       rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.3)
-      rubocop (~> 1.40)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-console (0.9.1)
+    simplecov-console (0.9.3)
       ansi
       simplecov
       terminal-table
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.0)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
+    stringio (3.1.5)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
     versionomy (0.5.0)
       blockenspiel (~> 0.5)
 
@@ -151,4 +168,4 @@ DEPENDENCIES
   versionomy (~> 0.5)
 
 BUNDLED WITH
-   2.5.10
+   2.6.5

data/README.md

@@ -30,9 +30,19 @@ brew install xpdf # for pdftotext
 sudo dnf install -y qpdf poppler-utils
 ```
 
+#### Arch
+
+```bash
+sudo pacman -S qpdf poppler
+```
+
 ## Usage
 
-After installing this gem you need to create your configuration file on your home folder. `pdfh.yml`
+After installing this gem you need to create your configuration file on any of the following directories:
+
+- `~/.config/pdfh.yml`
+- `~/pdfh.yml`
+- or configure `PDFH_CONFIG_FILE` environment variable
 
 ```yaml
 ---
@@ -84,7 +94,7 @@ commitlint --from origin --to @
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/iax7/pdfh. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/iax7/pdfh>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -97,7 +107,7 @@ Everyone interacting in the Pdfh project’s codebases, issue trackers, chat roo
 <!-- Links -->
 [rubocop-img]: https://github.com/iax7/pdfh/actions/workflows/rubocop-analysis.yml/badge.svg
 [rubocop-url]: https://github.com/iax7/pdfh/actions/workflows/rubocop-analysis.yml
-[ruby-img]: https://img.shields.io/badge/ruby-3.3-blue?style=flat&logo=ruby&logoColor=CC342D&labelColor=white
+[ruby-img]: https://img.shields.io/badge/ruby-3.4-blue?style=flat&logo=ruby&logoColor=CC342D&labelColor=white
 [ruby-url]: https://www.ruby-lang.org/en/
 [cc-img]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=00&labelColor=fff
 [cc-url]: https://conventionalcommits.org

data/exe/pdfh

@@ -9,7 +9,7 @@ require "pdfh"
 def validate_installed(*apps)
   found_app = []
   apps.each_with_object(found_app) do |app, result|
-    _stdout, _stderr, status = Open3.capture3("command -v #{app}")
+    _stdout, _stderr, status = Open3.capture3("which #{app}")
     puts "Missing #{app} command." unless status.success?
     result << status.success?
   end

data/lib/pdfh/main.rb

@@ -22,6 +22,7 @@ module Pdfh
         Pdfh.create_settings_file
         exit(1)
       rescue StandardError => e
+        Pdfh.backtrace_print e if Pdfh.verbose?
         Pdfh.error_print(e.message)
       end
 

data/lib/pdfh/models/document.rb

@@ -12,14 +12,18 @@ module Pdfh
     def initialize(file, type, text)
       @file = file
       @type = type
-      Pdfh.debug "=== Document Type: #{type.name} =============================="
       @text = text
+    end
+
+    # @return [void]
+    def process
+      Pdfh.debug "=== Document Type: #{type.name} =============================="
       Pdfh.debug "~~~~~~~~~~~~~~~~~~ Finding a subtype"
       @sub_type = type.sub_type(@text)
       Pdfh.debug "  SubType: #{@sub_type}"
       @companion = search_companion_files
 
-      month, year, @extra = match_data
+      month, year, @extra = match_date(@sub_type&.re_date || @type.re_date)
       @period = DocumentPeriod.new(day: extra, month: month, month_offset: @sub_type&.month_offset, year: year)
       Pdfh.debug "  Period: #{@period.inspect}"
     end
@@ -32,7 +36,6 @@ module Pdfh
       print_info_line "New Name", new_name
       print_info_line "Store Path", store_path
       print_info_line "Extra files", companion_files(join: true)
-      print_info_line "Print CMD", print_cmd
       print_info_line "Processed?", "No (in Dry mode)" if Pdfh.dry?
     end
 
@@ -95,14 +98,6 @@ module Pdfh
       type.generate_path(rename_data)
     end
 
-    # @return [String]
-    def print_cmd
-      return "N/A" if type.print_cmd.nil? || type.print_cmd.empty?
-
-      relative_path = File.join(store_path, new_name)
-      "#{type.print_cmd} #{relative_path}"
-    end
-
     # @return [String (frozen)]
     def companion_files(join: false)
       return @companion unless join
@@ -125,16 +120,17 @@ module Pdfh
     # named matches can appear in any order with names 'd', 'm' and 'y'
     # unnamed matches needs to be in order month, year
     # @return [Array] - format [month, year, day]
-    def match_data
+    # @param regex [RegularExpression]
+    def match_date(regex)
       Pdfh.debug "~~~~~~~~~~~~~~~~~~ Match Data RegEx"
-      Pdfh.debug "  Using regex: #{@type.re_date}"
-      Pdfh.debug "        named:   #{@type.re_date.named_captures}"
-      matched = @type.re_date.match(@text)
+      Pdfh.debug "  Using regex: #{regex}"
+      Pdfh.debug "        named:   #{regex.named_captures}"
+      matched = regex.match(@text)
       raise ReDateError unless matched
 
       Pdfh.debug "     captured: #{matched.captures}"
 
-      return matched.captures.map(&:downcase) if @type.re_date.named_captures.empty?
+      return matched.captures.map(&:downcase) if regex.named_captures.empty?
 
       extra = matched.captures.size > 2 ? matched[:d] : nil
       [matched[:m].downcase, matched[:y], extra]

data/lib/pdfh/models/document_sub_type.rb

@@ -2,5 +2,5 @@
 
 module Pdfh
   # Provides a way to divide document type by subtypes, for different name, and month adjustments
-  DocumentSubType = Struct.new(:name, :month_offset, keyword_init: true)
+  DocumentSubType = Struct.new(:name, :month_offset, :re_date, keyword_init: true)
 end

data/lib/pdfh/models/document_type.rb

@@ -2,15 +2,17 @@
 
 module Pdfh
   # Represents a type of document that can be processed by pdfh
-  DocumentType = Struct.new(:name, :re_file, :re_date, :pwd, :store_path, :name_template, :sub_types, :print_cmd,
-                            keyword_init: true) do
+  class DocumentType
+    attr_reader :name, :re_file, :re_date, :pwd, :store_path, :name_template, :sub_types
+
+    # @param args [Hash]
     # @return [self]
     def initialize(args)
-      super
-      self.name_template ||= "{original}"
-      self.re_file = Regexp.new(re_file)
-      self.re_date = Regexp.new(re_date)
-      self.sub_types = extract_subtype(sub_types) if sub_types
+      args.each { |k, v| instance_variable_set(:"@#{k}", v) }
+      @name_template ||= "{original}"
+      @re_file = Regexp.new(re_file)
+      @re_date = Regexp.new(re_date)
+      @sub_types = extract_subtypes(sub_types) if sub_types&.any?
       @path_validator = RenameValidator.new(store_path)
       @name_validator = RenameValidator.new(name_template)
       return if @path_validator.valid? && @name_validator.valid?
@@ -18,6 +20,11 @@ module Pdfh
       raise_validators_error
     end
 
+    # @return [Hash{Symbol->any}]
+    def to_h
+      instance_variables.to_h { |var| [var.to_s.delete_prefix("@"), instance_variable_get(var)] }
+    end
+
     # removes special characters from string and replaces spaces with dashes
     # @example usage
     #   "Test This?%&".gid
@@ -27,6 +34,7 @@ module Pdfh
       name.downcase.gsub(/[^0-9A-Za-z\s]/, "").tr(" ", "-")
     end
 
+    # search the subtype name in the pdf document
     # @return [DocumentSubType]
     def sub_type(text)
       # Regexp.new(st.name).match?(name)
@@ -54,28 +62,34 @@ module Pdfh
 
     private
 
+    attr_accessor :path_validator, :name_validator
+
     # @return [boolean]
     def base64?
       pwd.is_a?(String) && Base64.strict_encode64(Base64.decode64(pwd)) == pwd
     end
 
-    # @param sub_types [Array]
-    # @return [DocumentSubType]
-    def extract_subtype(sub_types)
+    # @param sub_types [Array<Hash{Symbol->String}>]
+    # @return [Array<DocumentSubType>]
+    def extract_subtypes(sub_types)
       sub_types.map do |st|
-        name = st[:name]
-        offset = st[:month_offset].to_i
-        DocumentSubType.new(name: name, month_offset: offset)
+        data = {
+          name: st[:name],
+          month_offset: st[:month_offset].to_i,
+          re_date: st[:re_date] && Regexp.new(st[:re_date])
+        }.compact
+        DocumentSubType.new(data)
       end
     end
 
     # @raise [ArgumentError] when called
     # @return [void]
     def raise_validators_error
-      template = "has invalid %<1>s. Unknown tokens: %<2>s"
-      path_errors = format(template, :store_path, @path_validator.unknown_list) unless @path_validator.valid?
-      name_errors = format(template, :name_template, @name_validator.unknown_list) unless @name_validator.valid?
-      raise ArgumentError, "Document type #{name.inspect} #{path_errors} #{name_errors}"
+      template = "has invalid %<field>s[Unknown tokens=%<error>s]"
+      errors = []
+      errors << format(template, field: :store_path, error: path_validator.unknown_list) unless path_validator.valid?
+      errors << format(template, field: :name_template, error: name_validator.unknown_list) unless name_validator.valid?
+      raise ArgumentError, "Document type #{name.inspect} #{errors.join(", ")}"
     end
   end
 end

data/lib/pdfh/models/settings.rb

@@ -57,6 +57,7 @@ module Pdfh
         result.store(doc_type.gid, doc_type)
       rescue ArgumentError => e
         Pdfh.error_print e.message, exit_app: false
+        Pdfh.backtrace_print e if Pdfh.verbose?
       end
     end
   end

data/lib/pdfh/utils/console.rb

@@ -41,6 +41,14 @@ module Pdfh
       exit 1 if exit_app
     end
 
+    # @param e [StandardError]
+    # @return [void]
+    def backtrace_print(e)
+      e.backtrace&.each do |line|
+        output "  ↳ #{line.sub("#{Dir.pwd}/", "")}".colorize(:light_black)
+      end
+    end
+
     # @param message [String]
     # @return [void]
     def warn_print(message)

data/lib/pdfh/utils/pdf_file_handler.rb

@@ -25,6 +25,7 @@ module Pdfh
       raise IOError, "File #{file} not found" unless File.exist?(file)
 
       @document = Document.new(file, type, extract_text)
+      document.process
       document.print_info
       write_pdf(base_path)
 

data/lib/pdfh/utils/settings_builder.rb

@@ -3,13 +3,17 @@
 module Pdfh
   # Loads or creates a default settings yaml file
   class SettingsBuilder
-    CONFIG_FILE_LOCATIONS = [Dir.pwd, File.expand_path("~")].freeze
+    CONFIG_FILE_LOCATIONS = [Dir.pwd, ENV.fetch("XDG_CONFIG_HOME", "~/.config"), "~"].freeze
     SUPPORTED_EXTENSIONS = %w[yml yaml].freeze
+    ENV_VAR = "PDFH_CONFIG_FILE"
 
     class << self
       # @return [Pdfh::Settings]
       def build
-        config_file = search_config_file
+        env_config_file = ENV.fetch(ENV_VAR, nil)
+        raise "File path in #{ENV_VAR} not found" if env_config_file && !File.exist?(env_config_file)
+
+        config_file = env_config_file || search_config_file
         file_hash = YAML.load_file(config_file, symbolize_names: true)
         Pdfh.debug "Loaded configuration file: #{config_file}"
 
@@ -42,7 +46,8 @@ module Pdfh
       # Gets the first settings file found, or creates a new one
       # @return [String]
       def search_config_file
-        CONFIG_FILE_LOCATIONS.each do |dir|
+        CONFIG_FILE_LOCATIONS.each do |dir_string|
+          dir = File.expand_path(dir_string)
           SUPPORTED_EXTENSIONS.each do |ext|
             path = File.join(dir, "#{config_file_name}.#{ext}")
             return path if File.exist?(path)

data/lib/pdfh/version.rb

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

data/lib/pdfh.rb

@@ -45,6 +45,6 @@ module Pdfh
   class << self
     extend Forwardable
     def_delegators :@options, :verbose?, :dry?, :file_mode?
-    def_delegators :@console, :ident_print, :warn_print, :error_print, :headline, :debug, :info, :print_options
+    def_delegators :@console, :ident_print, :warn_print, :error_print, :backtrace_print, :headline, :debug, :info, :print_options
   end
 end

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4.2"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pdfh
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Isaias Piña
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -37,7 +36,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -67,6 +65,7 @@ files:
 - lib/pdfh/utils/rename_validator.rb
 - lib/pdfh/utils/settings_builder.rb
 - lib/pdfh/version.rb
+- mise.toml
 - pdfh.gemspec
 homepage: https://github.com/iax7/pdfh
 licenses:
@@ -77,7 +76,6 @@ metadata:
   source_code_uri: https://github.com/iax7/pdfh
   changelog_uri: https://github.com/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,8 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Organize PDF files
 test_files: []

data/.tool-versions

@@ -1 +0,0 @@
-ruby 3.3.0