pdfh 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14832944087c61f4949fe3fd42cdb848ebfd8a8931826cbd3e4fc111f5813a31
-  data.tar.gz: 16c139cc38b766307fe4fe9a21b740161af8fffcc05b5c8397cfdde843b1b943
+  metadata.gz: 375df17076824594d8622b7dd9474ab53400297c5ff4598463b5dac3fea352d2
+  data.tar.gz: 5174dd71598e65630e78b394f3aa46d2562e9de7d682dcb30cd5695af7a75012
 SHA512:
-  metadata.gz: b0c320fcead6ae5e09a37ba17100837d392017b73fa0cd54b5d4126bebc52bd07f009457af741128df8197c67fb52d82eee2422a16b6240930f9e72ff795a950
-  data.tar.gz: 335af04d4f5753d39e4464be53a24986f89dff1cc1e9fa2866e8340680317337cf3b24eb043cdbcdef5051fa47d45dcfe67ab685b289173dc42e789d5014e3c6
+  metadata.gz: 68bed2cab1ef5346e7774d03d66538fcdbdd0ccbc72168359d4e3422a7d39c306de4483dd074483aec6f63d197d7275b072cce080178547b94c6adf2853e81e9
+  data.tar.gz: 35087b577052e468a97183af2305e3cef5d03fa42d9942d4528701280894dbe290759bc01b124ce54ba5835e7af53a67cbff5438c568cc1d7e0ce4f50bcdaccd

data/.gitignore

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

data/.rubocop.yml

@@ -9,8 +9,10 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.5
   Exclude:
+    - doc/**/*
     - pkg/**/*
     - tmp/**/*
+    - vendor/**/*
 
 Layout/LineLength:
   Max: 120

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
+ruby-3.0.1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.2.0
+* Major gem refactoring
+* Changed 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
 

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 (0.2.0)
       colorize (~> 0.8.0)
 
 GEM
@@ -10,21 +10,23 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     blockenspiel (0.5.0)
+    code-scanning-rubocop (0.5.0)
+      rubocop (~> 1.0)
     coderay (1.1.3)
     colorize (0.8.1)
     diff-lcs (1.4.4)
-    docile (1.3.5)
+    docile (1.4.0)
     method_source (1.0.0)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.1)
       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)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -40,23 +42,23 @@ GEM
     rspec-support (3.10.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.11.0)
+    rubocop (1.14.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.5.0, < 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.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (2.2.0)
+    rubocop-rspec (2.3.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
@@ -69,10 +71,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.3)
+    terminal-table (3.0.1)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.0.0)
     versionomy (0.5.0)
       blockenspiel (~> 0.5)
 
@@ -81,6 +83,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  code-scanning-rubocop (~> 0.5)
   pdfh!
   pry (~> 0.14)
   rake (~> 13.0)
@@ -95,4 +98,4 @@ DEPENDENCIES
   versionomy (~> 0.5)
 
 BUNDLED WITH
-   2.2.12
+   2.2.17

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,7 +38,7 @@ 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
 ```
 
 ## Development
@@ -63,3 +66,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.0.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)