pdfh 0.1.9 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14832944087c61f4949fe3fd42cdb848ebfd8a8931826cbd3e4fc111f5813a31
-  data.tar.gz: 16c139cc38b766307fe4fe9a21b740161af8fffcc05b5c8397cfdde843b1b943
+  metadata.gz: ce33aa4da82a840716b3af1e3ae8a755075c991afd361da6916ba3418c523ba4
+  data.tar.gz: 49618addd2323056b8312b9a8bba29947623fcdfd4813c671a34078e7fe8ff57
 SHA512:
-  metadata.gz: b0c320fcead6ae5e09a37ba17100837d392017b73fa0cd54b5d4126bebc52bd07f009457af741128df8197c67fb52d82eee2422a16b6240930f9e72ff795a950
-  data.tar.gz: 335af04d4f5753d39e4464be53a24986f89dff1cc1e9fa2866e8340680317337cf3b24eb043cdbcdef5051fa47d45dcfe67ab685b289173dc42e789d5014e3c6
+  metadata.gz: 5d64fbcff7d7aed4a3e085ec42c6980be840abddce68faa50d064074957262e6e475cb803b379a71ed8b9d86f6d3a821f7aacc8610fcc3745c61ba8df97c3abc
+  data.tar.gz: '069fe2a97fbceeb475116cfab0b27666ce73613d1a13b5af46c8e2026eb13d35bbe593376bca4fdd34591e2fba58ffcc2b4d1104b00cd386bef85e7bda18fe9f'

data/.gitignore

@@ -1,3 +1,5 @@
+*.yml
+
 .yardoc/
 _yardoc/
 coverage/

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/.rubocop.yml

@@ -9,12 +9,14 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.5
   Exclude:
+    - doc/**/*
     - pkg/**/*
     - tmp/**/*
+    - vendor/**/*
 
 Layout/LineLength:
   Max: 120
-  IgnoredPatterns: ['^\s*#']
+  AllowedPatterns: ['^\s*#']
 
 Style/StringLiterals:
   Enabled: true

data/.rubocop_todo.yml

@@ -1,152 +1,47 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-03-02 12:13:30 UTC using RuboCop version 1.11.0.
+# on 2021-05-15 01:26:47 UTC using RuboCop version 1.14.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
+# Offense count: 5
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 23
+  Max: 24
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 144
+  Max: 87
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 149
+  Max: 121
 
-# Offense count: 5
+# Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 13
+  Max: 17
 
 # Offense count: 2
 RSpec/AnyInstance:
   Exclude:
-    - 'spec/pdfh_spec.rb'
-
-# Offense count: 13
-# Cop supports --auto-correct.
-RSpec/ContextMethod:
-  Exclude:
-    - 'spec/classes/document_spec.rb'
-    - 'spec/classes/month_spec.rb'
-    - 'spec/classes/pdf_handler_spec.rb'
-    - 'spec/classes/settings_spec.rb'
-    - 'spec/pdfh_spec.rb'
-
-# Offense count: 13
-# Configuration parameters: Prefixes.
-# Prefixes: when, with, without
-RSpec/ContextWording:
-  Exclude:
-    - 'spec/classes/document_spec.rb'
-    - 'spec/classes/month_spec.rb'
-    - 'spec/classes/pdf_handler_spec.rb'
-    - 'spec/classes/settings_spec.rb'
-    - 'spec/pdfh_spec.rb'
+    - 'spec/pdfh/document_processor_spec.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: SkipBlocks, EnforcedStyle.
-# SupportedStyles: described_class, explicit
-RSpec/DescribedClass:
-  Exclude:
-    - 'spec/classes/settings_spec.rb'
-
-# Offense count: 16
-# Cop supports --auto-correct.
-# Configuration parameters: AllowConsecutiveOneLiners.
-RSpec/EmptyLineAfterExample:
-  Exclude:
-    - 'spec/classes/document_spec.rb'
-    - 'spec/classes/dry_spec.rb'
-    - 'spec/classes/month_spec.rb'
-    - 'spec/classes/settings_spec.rb'
-    - 'spec/classes/verbose_spec.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-RSpec/EmptyLineAfterFinalLet:
-  Exclude:
-    - 'spec/classes/pdf_handler_spec.rb'
-    - 'spec/classes/settings_spec.rb'
-
-# Offense count: 1
-# Configuration parameters: Max.
+# Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Exclude:
-    - 'spec/pdfh_spec.rb'
+  Max: 7
 
-# Offense count: 1
-RSpec/ExpectInHook:
-  Exclude:
-    - 'spec/pdfh_spec.rb'
-
-# Offense count: 6
-# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
-# Include: **/*_spec*rb*, **/spec/**/*
-RSpec/FilePath:
-  Exclude:
-    - 'spec/classes/document_spec.rb'
-    - 'spec/classes/dry_spec.rb'
-    - 'spec/classes/month_spec.rb'
-    - 'spec/classes/pdf_handler_spec.rb'
-    - 'spec/classes/settings_spec.rb'
-    - 'spec/classes/verbose_spec.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-RSpec/LeadingSubject:
-  Exclude:
-    - 'spec/classes/document_spec.rb'
-    - 'spec/classes/pdf_handler_spec.rb'
-    - 'spec/classes/settings_spec.rb'
-
-# Offense count: 18
-# Configuration parameters: .
-# SupportedStyles: have_received, receive
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-# Offense count: 15
+# Offense count: 2
 RSpec/MultipleExpectations:
-  Max: 4
-
-# Offense count: 71
-# Configuration parameters: IgnoreSharedExamples.
-RSpec/NamedSubject:
-  Exclude:
-    - 'spec/classes/document_spec.rb'
-    - 'spec/classes/month_spec.rb'
-    - 'spec/classes/pdf_handler_spec.rb'
-    - 'spec/classes/settings_spec.rb'
-    - 'spec/pdfh_spec.rb'
-
-# Offense count: 16
-RSpec/StubbedMock:
-  Exclude:
-    - 'spec/classes/document_spec.rb'
-    - 'spec/classes/pdf_handler_spec.rb'
-    - 'spec/pdfh_spec.rb'
+  Max: 2
 
-# Offense count: 7
+# Offense count: 1
 RSpec/SubjectStub:
   Exclude:
-    - 'spec/classes/document_spec.rb'
-    - 'spec/classes/pdf_handler_spec.rb'
-    - 'spec/pdfh_spec.rb'
-
-# Offense count: 4
-# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
-RSpec/VerifiedDoubles:
-  Exclude:
-    - 'spec/classes/document_spec.rb'
-    - 'spec/pdfh_spec.rb'
+    - 'spec/pdfh/document_processor_spec.rb'

data/.ruby-version

@@ -1 +1 @@
-ruby-3.0.0
+3.1.2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.2

data/CHANGELOG.md

@@ -1,16 +1,31 @@
+## v3.0.0
+  * Migrate to `asdf` from `rvm`
+  * Upgrade old gems
+  * Bump to v3 (as this is project's the third iteration)
+
+## v0.2.0
+  * Major gem refactoring
+  * Change setting `base_path` to `destination_base_path`
+  * Add DocumentType listing option on executable file
+  * Add process individual documents providing type and files
+    ```bash
+    pdfh -t document_type_id path/to_files.pdf
+    ```
+  * Add `settings.yml` template in order to create a sample file
+
 ## v0.1.9
-* Add dependencies validation at run
+  * Add dependencies validation at run
 
 ## v0.1.5
-* Add print_cmd field in config file for information purposes
-* Settings now validates a no existing directory
-* Refactor for easier maintenance
+  * Add `print_cmd` field in config file for information purposes
+  * Settings now validates an unexisting directory
+  * Refactor for easier maintenance
 
 ## v0.1.4
-* Add titleize format when writing new file
+  * Add titleize format when writing new file
 
 ## v0.1.3
-* Fixed copy companion files, which was not copying the files.
+  * Fixed copy companion files, which was not copying the files.
 
 ## v0.1.2
-* Initial Release
+  * Initial Release

data/Gemfile

@@ -6,6 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "bundler", "~> 2.0"
+gem "code-scanning-rubocop", "~> 0.5"
 gem "pry", "~> 0.14"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.9"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pdfh (0.1.9)
+    pdfh (3.0.0)
       colorize (~> 0.8.0)
 
 GEM
@@ -10,55 +10,58 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     blockenspiel (0.5.0)
+    code-scanning-rubocop (0.6.1)
+      rubocop (~> 1.0)
     coderay (1.1.3)
     colorize (0.8.1)
-    diff-lcs (1.4.4)
-    docile (1.3.5)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.2)
     method_source (1.0.0)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rspec_junit_formatter (0.4.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.11.0)
+    rubocop (1.32.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.10.1)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -69,10 +72,10 @@ GEM
       simplecov
       terminal-table
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
-    terminal-table (3.0.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    unicode-display_width (1.7.0)
+    simplecov_json_formatter (0.1.4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.2.0)
     versionomy (0.5.0)
       blockenspiel (~> 0.5)
 
@@ -81,6 +84,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  code-scanning-rubocop (~> 0.5)
   pdfh!
   pry (~> 0.14)
   rake (~> 13.0)
@@ -95,4 +99,4 @@ DEPENDENCIES
   versionomy (~> 0.5)
 
 BUNDLED WITH
-   2.2.12
+   2.3.19

data/README.md

@@ -1,6 +1,9 @@
-# Pdfh
+# PDF Handler (pdfh)
 
-Examine all PDF files in scrape directories, remove password (if has one), rename and copy to a new directory using regular expresions.
+[![Rubocop](https://github.com/iax7/pdfh/actions/workflows/rubocop-analysis.yml/badge.svg)](https://github.com/iax7/pdfh/actions/workflows/rubocop-analysis.yml)
+[![Ruby][ruby-badge]][ruby-url]
+
+Examine all PDF files in Look up directories, remove password (if has one), rename and copy to a new directory using regular expresions.
 
 ## Installation
 
@@ -23,9 +26,9 @@ After installing this gem you need to create your configuration file on your hom
 `pdfh.yml`
 ```yaml
 ---
-scrape_dirs:       # Directories where all pdf's are going to be analyzed
+lookup_dirs:       # Directories where all pdf's are going to be analyzed
   - ~/Downloads
-base_path: ~/PDFs  # Directory where all matching documents will be copied
+destination_base_path: ~/PDFs  # Directory where all matching documents will be copied (MUST exist)
 document_types:
   - name: Document From Bank              # Description
     re_file: '.*MyBankReg\.pdf'           # Regular expression to match its filename
@@ -35,9 +38,22 @@ document_types:
     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 value to adjust month
+        month_offset: -1                     # [OPTIONAL] Integer (signed) value to adjust month
 ```
 
+Store Path supported placeholders:
+* `{YEAR}` 2022
+
+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
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -63,3 +79,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Pdfh project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iax7/pdfh/blob/master/CODE_OF_CONDUCT.md).
+
+<!-- Links -->
+[ruby-badge]: https://img.shields.io/badge/ruby-3.1-blue?style=flat&logo=ruby&logoColor=CC342D&labelColor=white
+[ruby-url]: https://www.ruby-lang.org/en/

data/Rakefile

@@ -12,6 +12,7 @@ task default: :spec
 desc "Bump gem version number (tiny|minor|major)"
 task :bump, :type do |_t, args|
   args.with_defaults(type: :tiny)
+
   version_file = File.join(__dir__, "lib", "pdfh", "version.rb")
   content = File.read(version_file)
 
@@ -22,4 +23,6 @@ task :bump, :type do |_t, args|
   File.write(version_file, content.gsub(version_pattern, "\\1#{next_version}\\3"))
 
   puts "Successfully bumped from #{current_version.to_s.red} to #{next_version.green}"
+  puts "\n> Building v#{next_version.green}..."
+  puts `rake build`
 end

data/bin/console

@@ -9,6 +9,9 @@ require "pdfh"
 
 # (If you use this, don't forget to add pry to your Gemfile!)
 require "pry"
+
+p Pdfh.parse_argv
+
 Pry.start
 
 # require "irb"

data/bin/run

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pdfh"
+require "pry"
+
+Pdfh::DocumentProcessor.new.start

data/exe/pdfh

@@ -1,43 +1,26 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "optparse"
+require "open3"
 require "pdfh"
-require "pdfh/version"
-require "pdfh/utils"
 
-options = {}
-opt = OptionParser.new do |opts|
-  # Process ARGV
-  opts.banner = "Usage: #{opts.program_name} [options]"
-  opts.on("-v", "--verbose", "Show more output, useful for debug") { |o| options[:verbose] = o }
-  opts.on("-d", "--dry", "Dry run, does not write new pdf") { |o| options[:dry] = o }
-  opts.on_tail("-V", "--version", "Show version") do
-    puts "#{opts.program_name} v#{Pdfh::VERSION}"
-    exit
+# @param apps [Array]
+# @return [Boolean]
+def validate_installed(*apps)
+  found_app = []
+  apps.each_with_object(found_app) do |app, result|
+    _stdout, _stderr, status = Open3.capture3("command -v #{app}")
+    puts "Missing #{app} command." unless status.success?
+    result << status.success?
   end
-  opts.on_tail("-h", "--help", "Show this message") do
-    puts opts
-    exit
-  end
-end
 
-begin
-  opt.parse!
-rescue OptionParser::InvalidOption => e
-  Pdfh.print_error e, exit_app: false
-  puts opt
-  exit 1
+  found_app.all?
 end
 
-def validate_installed(app)
-  require "open3"
-  _stdout, _stderr, status = Open3.capture3("command -v #{app}")
-  puts "Missing #{app} command." unless status.success?
+exit(1) unless validate_installed("qpdf", "pdftotext")
 
-  status.success?
+begin
+  Pdfh::DocumentProcessor.new.start
+rescue StandardError => e
+  Pdfh.error_print e.message
 end
-
-exit(1) unless validate_installed("qpdf") && validate_installed("pdftotext")
-
-Pdfh.main(options)

data/lib/ext/string.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-##
-# Extends String class when required
-module Extensions
-  ##
-  # Adds new functionality to string Class
-  refine String do
-    def titleize
-      split.map(&:capitalize).join(" ")
-    end
+# Adds :titleize to string Class
+class String
+  # @return [String]
+  def titleize
+    split.map(&:capitalize).join(" ")
   end
 end