pdfh 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b58e13bf988d132601b4a22e7d58d2a9fedf0dbaefbe31263d49e441457361
-  data.tar.gz: c5c5faa977695d1e6cb0d42a692f1c951ce23d1fc07fe27e1dc714f16890a9e8
+  metadata.gz: 375df17076824594d8622b7dd9474ab53400297c5ff4598463b5dac3fea352d2
+  data.tar.gz: 5174dd71598e65630e78b394f3aa46d2562e9de7d682dcb30cd5695af7a75012
 SHA512:
-  metadata.gz: c76919c53cc31219265484721f441dc36b5194e859ca8bb0c71528374012e72dab1dde8e3edf47745494501c27d0a0ffcbfb12480a385cef63dfe9dd20e8bffe
-  data.tar.gz: 041110ee2ffa94ce826d020d3e44e7779768358a3e1b8abe89b2743751ee1f1f46319d3ca680d8de9fab04c1dd816e14fa90571d327ab88772d3f53927dabf40
+  metadata.gz: 68bed2cab1ef5346e7774d03d66538fcdbdd0ccbc72168359d4e3422a7d39c306de4483dd074483aec6f63d197d7275b072cce080178547b94c6adf2853e81e9
+  data.tar.gz: 35087b577052e468a97183af2305e3cef5d03fa42d9942d4528701280894dbe290759bc01b124ce54ba5835e7af53a67cbff5438c568cc1d7e0ce4f50bcdaccd

data/.gitignore

@@ -1,13 +1,42 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+*.yml
+
+.yardoc/
+_yardoc/
+coverage/
+pkg/
+spec/reports/
+spec/coverage/
+tmp/
 
 # rspec failure tracking
 .rspec_status
-coverage
-*.gem
+
+### macOS
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+

data/.rubocop.yml

@@ -1,18 +1,27 @@
----
-AllCops:
-  Exclude:
-    - '.git/**/*'
-    - 'spec/**/*'
+inherit_from: .rubocop_todo.yml
 
-Metrics/LineLength:
-  Enabled: false
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
 
-Metrics/BlockLength:
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
   Exclude:
-    - pdfh.gemspec
+    - doc/**/*
+    - pkg/**/*
+    - tmp/**/*
+    - vendor/**/*
+
+Layout/LineLength:
+  Max: 120
+  IgnoredPatterns: ['^\s*#']
 
-Metrics/MethodLength:
-  Max: 15
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
 
-Metrics/AbcSize:
-  Max: 15
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.2
+ruby-3.0.1

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 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
+
 ## v0.1.5
 * Add print_cmd field in config file for information purposes
 * Settings now validates a no existing directory

data/Gemfile

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in pdfh.gemspec
 gemspec
+
+gem "bundler", "~> 2.0"
+gem "code-scanning-rubocop", "~> 0.5"
+gem "pry", "~> 0.14"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.9"
+gem "rspec_junit_formatter", "~> 0.4"
+gem "rubocop", "~> 1.0"
+gem "rubocop-performance", "~> 1.9"
+gem "rubocop-rake", "~> 0.5"
+gem "rubocop-rspec", "~> 2.2"
+gem "simplecov", "~> 0.21"
+gem "simplecov-console", "~> 0.9"
+gem "versionomy", "~> 0.5"

data/Gemfile.lock

@@ -1,52 +1,101 @@
 PATH
   remote: .
   specs:
-    pdfh (0.1.5)
-      colorize (~> 0.8.1)
+    pdfh (0.2.0)
+      colorize (~> 0.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     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.3)
-    docile (1.3.1)
-    hirb (0.7.3)
-    json (2.2.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    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.5)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    simplecov (0.16.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.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.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.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.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-console (0.4.2)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
       ansi
-      hirb
       simplecov
-    simplecov-html (0.10.2)
+      terminal-table
+    simplecov-html (0.12.3)
+    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)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17.2)
+  bundler (~> 2.0)
+  code-scanning-rubocop (~> 0.5)
   pdfh!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  simplecov (~> 0.16.1)
-  simplecov-console (~> 0.4.2)
+  pry (~> 0.14)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rspec_junit_formatter (~> 0.4)
+  rubocop (~> 1.0)
+  rubocop-performance (~> 1.9)
+  rubocop-rake (~> 0.5)
+  rubocop-rspec (~> 2.2)
+  simplecov (~> 0.21)
+  simplecov-console (~> 0.9)
+  versionomy (~> 0.5)
 
 BUNDLED WITH
-   1.17.2
+   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
 
@@ -8,15 +11,24 @@ Examine all PDF files in scrape directories, remove password (if has one), renam
 gem install pdfh
 ```
 
+### Dependencies
+
+You need to install pdf handling dependencies in order to use this gem. (I have only tested it on macOS)
+
+```bash
+brew install qpdf
+brew install xpdf
+```
+
 ## Usage
 
 After installing this gem you need to create your configuration file on your home folder.
 `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
@@ -24,18 +36,21 @@ document_types:
     pwd: base64string                     # [OPTIONAL] Password if the document is protected
     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 
+    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
 
 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `rake install`. To release a new version, run `rake bump`, and then run `rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ```bash
+rake install
+
+# step by step
 build pdfh.gemspec
 gem install pdfh-*
 ```
@@ -51,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

@@ -1,8 +1,28 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "colorize"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "versionomy"
 
 RSpec::Core::RakeTask.new(:spec)
 
 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)
+
+  version_pattern = /(?<major>\d+)\.(?<minor>\d+)\.(?<tiny>\d+)/
+  current_version = content.match(version_pattern)
+  next_version    = Versionomy.parse(current_version.to_s).bump(args.type).to_s
+
+  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

@@ -1,15 +1,18 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'pdfh'
+require "bundler/setup"
+require "pdfh"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require 'pry'
-# Pry.start
+require "pry"
 
-require 'irb'
-IRB.start(__FILE__)
+p Pdfh.parse_argv
+
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

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,33 +1,26 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'optparse'
-require 'pdfh'
-require 'pdfh/version'
-require 'pdfh/utils'
+require "open3"
+require "pdfh"
 
-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
-  end
-  opts.on_tail('-h', '--help', 'Show this message') do
-    puts opts
-    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
+
+  found_app.all?
 end
 
+exit(1) unless validate_installed("qpdf", "pdftotext")
+
 begin
-  opt.parse!
-rescue OptionParser::InvalidOption => e
-  Pdfh.print_error e, exit_app: false
-  puts opt
-  exit 1
+  Pdfh::DocumentProcessor.new.start
+rescue StandardError => e
+  Pdfh.error_print e.message
 end
-
-Pdfh.main(options)