pdfh 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae203433b71f3129de5d62505e63d8d1435b0463c82a22820b76e8ea8536de1c
-  data.tar.gz: 61ac5f4219b353778a0e9bc3b749050e0f535926583ad8d6e74325b5cecfe51b
+  metadata.gz: ecddee5472149aa038427798c482557111e62070ebed5558fdffcde55417b325
+  data.tar.gz: 75ff53bc3429bc5303411a81d3922e3f0b6f4249bf66bae396e867cd0b4615a9
 SHA512:
-  metadata.gz: f5559496bf4652bbd0f63d3d8f056c9e39e248b7a18daae0669b5c3323f288f52ecf5bd15466de0025d948095ad04e46f1896ca367facdafe7a4c4eae48335a9
-  data.tar.gz: c7fdff58c2c3c42a550e9bd8a3acf376ac958fa60de2588c5e212f67199799f47724b75d0a540317069944bd881f99d857fd3a6880e480e75c66abad75704c7b
+  metadata.gz: 4c51ac8db9d6f9b56c1608289c7d7694b21af6856eb69e06b4fd203ff2824ed3884a1ef1c64cefea37ff1358614e41e3c55264134d9616d9d14819d36ed7241a
+  data.tar.gz: b3d382767616e4008997ce8050691c1e578b8a181ee2a36a4fb4f6a8ed912e93f65511967db2990efbbcd33d73ffdc21535a5163ad9e248225e5e0054548b570

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pdfh (3.0.3)
+    pdfh (3.1.0)
       colorize (~> 1.1.0)
 
 GEM
@@ -20,7 +20,7 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
+    bigdecimal (3.1.7)
     blockenspiel (0.5.0)
     code-scanning-rubocop (0.6.1)
       rubocop (~> 1.0)
@@ -28,7 +28,7 @@ GEM
     colorize (1.1.0)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    debug (1.9.1)
+    debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.5.1)
@@ -39,16 +39,16 @@ GEM
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
-    irb (1.12.0)
-      rdoc
+    irb (1.13.0)
+      rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
-    method_source (1.0.0)
-    minitest (5.22.2)
+    method_source (1.1.0)
+    minitest (5.22.3)
     mutex_m (0.2.0)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -58,11 +58,11 @@ GEM
       stringio
     racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.1.0)
-    rdoc (6.6.2)
+    rake (13.2.1)
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
     regexp_parser (2.9.0)
-    reline (0.4.3)
+    reline (0.5.5)
       io-console (~> 0.5)
     rexml (3.2.6)
     rspec (3.13.0)
@@ -80,7 +80,7 @@ GEM
     rspec-support (3.13.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.62.1)
+    rubocop (1.63.4)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -91,21 +91,24 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
     rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
-    rubocop-performance (1.20.2)
+    rubocop-performance (1.21.0)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.27.1)
+    rubocop-rspec (2.29.2)
       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)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -148,4 +151,4 @@ DEPENDENCIES
   versionomy (~> 0.5)
 
 BUNDLED WITH
-   2.5.6
+   2.5.10

data/README.md

@@ -18,20 +18,22 @@ gem install pdfh
 You need to install pdf handling dependencies in order to use this gem.
 
 #### macOS
+
 ```bash
 brew install qpdf # for qpdf
 brew install xpdf # for pdftotext
 ```
 
 #### Fedora
+
 ```bash
 sudo dnf install -y qpdf poppler-utils
 ```
 
 ## 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 your home folder. `pdfh.yml`
+
 ```yaml
 ---
 lookup_dirs:       # Directories where all pdf's are going to be analyzed
@@ -42,25 +44,22 @@ document_types:
     re_file: '.*MyBankReg\.pdf'           # Regular expression to match its filename
     re_date: 'al \d{1,2} de (\w+) del? (\d+)' # Date regular expresion
     pwd: base64string                     # [OPTIONAL] Password if the document is protected
-    store_path: "{YEAR}/bank_docs"        # Relative path to copy this document
+    store_path: "{year}/bank_docs"        # Relative path to copy this document
     name_template: '{period} {subtype}'   # Template for new filename when copied
     sub_types:                            # [OPTIONAL] In case your need an extra category
       - name: Account1                       # Regular expresion to match this subtype
         month_offset: -1                     # [OPTIONAL] Integer (signed) value to adjust month
 ```
 
-Store Path supported placeholders:
-* `{YEAR}` 2022
+**Store Path** and **Name Template** supported placeholders:
 
-Name Template supported placeholders:
-
-* `{original}` Original filename
-* `{period}` 2022-01
-* `{year}` 2022
-* `{month}` 01
-* `{type}` document_type.name
-* `{subtype}` subtype.name if matched
-* `{extra}` day if provided/matched
+- `{original}` Original filename
+- `{period}` 2022-01
+- `{year}` 2022
+- `{month}` 01
+- `{type}` document_type.name
+- `{subtype}` subtype.name if matched
+- `{extra}` day if provided/matched
 
 ## Development
 
@@ -77,6 +76,7 @@ gem install pdfh-*
 ```
 
 ### Conventional Commits
+
 ```bash
 npm install -g @commitlint/cli @commitlint/config-conventional
 commitlint --from origin --to @

data/lib/pdfh/models/document.rb

@@ -3,8 +3,6 @@
 module Pdfh
   # Handles the PDF detected by the rules
   class Document
-    IDENT = 12
-
     attr_reader :text, :type, :file, :extra, :period
 
     # @param file [String]
@@ -40,12 +38,17 @@ module Pdfh
 
     # @return [void]
     def print_info_line(property, info)
-      Pdfh.ident_print property, info.to_s, color: :light_blue, width: IDENT
+      Pdfh.ident_print property, info.to_s, color: :light_blue, width: 12
     end
 
     # @return [String]
     def file_name_only
-      File.basename(@file, File.extname(@file))
+      File.basename(@file, file_extension)
+    end
+
+    # @return [String]
+    def file_extension
+      File.extname(@file)
     end
 
     # @return [String]
@@ -83,12 +86,13 @@ module Pdfh
 
     # @return [String]
     def new_name
-      type.generate_new_name(rename_data)
+      new_name = type.generate_new_name(rename_data)
+      "#{new_name}#{file_extension}"
     end
 
     # @return [String]
     def store_path
-      @type.store_path.gsub("{YEAR}", period.year.to_s)
+      type.generate_path(rename_data)
     end
 
     # @return [String]
@@ -99,6 +103,7 @@ module Pdfh
       "#{type.print_cmd} #{relative_path}"
     end
 
+    # @return [String (frozen)]
     def companion_files(join: false)
       return @companion unless join
 

data/lib/pdfh/models/document_type.rb

@@ -11,11 +11,11 @@ module Pdfh
       self.re_file = Regexp.new(re_file)
       self.re_date = Regexp.new(re_date)
       self.sub_types = extract_subtype(sub_types) if sub_types
-      @rename_validator = RenameValidator.new(name_template)
-      return if @rename_validator.valid?
+      @path_validator = RenameValidator.new(store_path)
+      @name_validator = RenameValidator.new(name_template)
+      return if @path_validator.valid? && @name_validator.valid?
 
-      errors = @rename_validator.unknown.join(", ")
-      raise ArgumentError, "Document type #{name.inspect} has invalid :name_template. Tokens not recognized: #{errors}"
+      raise_validators_error
     end
 
     # removes special characters from string and replaces spaces with dashes
@@ -43,7 +43,13 @@ module Pdfh
     # @param values [Hash{Symbol->String}
     # @return [String]
     def generate_new_name(values)
-      @rename_validator.name(values)
+      @name_validator.gsub(values)
+    end
+
+    # @param values [Hash{Symbol->String}
+    # @return [String]
+    def generate_path(values)
+      @path_validator.gsub(values)
     end
 
     private
@@ -62,5 +68,14 @@ module Pdfh
         DocumentSubType.new(name: name, month_offset: offset)
       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}"
+    end
   end
 end

data/lib/pdfh/utils/rename_validator.rb

@@ -13,13 +13,13 @@ module Pdfh
       "extra"    => "Extra data extracted from date_re"
     }.freeze
 
-    attr_reader :name_template, :all, :unknown, :valid
+    attr_reader :template, :all, :unknown, :valid
 
-    # @param name_template [String]
+    # @param template [String]
     # @return [self]
-    def initialize(name_template)
-      @name_template = name_template
-      @all = name_template.scan(/{(\w+)}/).flatten
+    def initialize(template)
+      @template = template
+      @all = template.scan(/{([^}]+)}/).flatten.map(&:downcase)
       @unknown = all - types
       @valid = all - unknown
     end
@@ -34,11 +34,17 @@ module Pdfh
       unknown.empty?
     end
 
+    # @return [String]
+    def unknown_list
+      unknown.join(", ")
+    end
+
     # @param values [Hash{Symbol->String}]
     # @return [String (frozen)]
-    def name(values)
-      new_name = name_template.gsub("{", "%{") % values
-      "#{new_name}.pdf"
+    def gsub(values)
+      template
+        .gsub(/\{([^}]+)}/, &:downcase) # convert all text between {} to lowercase
+        .gsub("{", "%{") % values
     end
   end
 end

data/lib/pdfh/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfh
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Isaias Piña
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: Organize PDF files