pdfh 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e56c6dcb8915785a475e34a5120d44556fd6630d3738849161697b76ded58fa6
-  data.tar.gz: 335b684595f23f61607d3ff3e0c6ed106da1e52842090c4ddc89381252f5771a
+  metadata.gz: 800f047d683e60b4fafca9fc762c7df699194c916822221754de2383078e0da3
+  data.tar.gz: 6d10a59cdeb87d5127ff624ffad4c4fc644872ab91c8df50cd97db40f4fff0a2
 SHA512:
-  metadata.gz: 45bbfee057aeda92595c687b67a3e2f34c8ed4f36f28dbc5b3880fafb05f7a9e170b70e1ec61bc21709ba7ed3a1401667fca03cadf35593fb8843b93ee7fdfdb
-  data.tar.gz: 930644f381d3e338ec3161d8346179f3268c336bf3407ae64ed256eb9c30b0bd2b0d0bcf6c0ab31c2d0a57a25d56f05fd0f99bf89f7978be77a0d78f985da101
+  metadata.gz: b0caadec708ec57951c5e40192ccb84c735d652420d4bd1f0398fe3f4dc6758e3acf3ae1121459aa219275f7ef66084412cf8d7c8b07eb254f93c827513a4b9e
+  data.tar.gz: 125c1aebc9023315fa4355f880c25090c2f13aa34ebeadbcbcfc1481a49bb39d0112350fcd50b01844b278c45c9fa96842869ae969b8343fc600b6f4ee7740dd

data/.rubocop.yml

@@ -1,6 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 require:
+  - rubocop-factory_bot
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec

data/.rubocop_todo.yml

@@ -1,22 +1,16 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-07-13 05:43:39 UTC using RuboCop version 1.54.1.
+# on 2024-01-10 03:23:37 UTC using RuboCop version 1.59.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: 7
+# Offense count: 8
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 25
 
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 26
-
 # Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
@@ -30,23 +24,34 @@ RSpec/AnyInstance:
 # Offense count: 1
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Max: 7
-
-# Offense count: 2
-RSpec/MultipleExpectations:
-  Max: 2
+  Max: 6
 
-# Offense count: 1
-# Configuration parameters: AllowedPatterns.
-# AllowedPatterns: ^expect_, ^assert_
-RSpec/NoExpectationExample:
+# Offense count: 7
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
   Exclude:
-    - 'spec/pdfh/pdf_handler_spec.rb'
+    - 'spec/pdfh/models/document_period_spec.rb'
+    - 'spec/pdfh/models/document_spec.rb'
+    - 'spec/pdfh/utils/console_spec.rb'
+    - 'spec/pdfh/utils/month_spec.rb'
+    - 'spec/pdfh/utils/opt_parser_spec.rb'
+    - 'spec/pdfh/utils/pdf_file_handler_spec.rb'
+    - 'spec/pdfh/utils/settings_builder_spec.rb'
 
-# Offense count: 1
-RSpec/SubjectStub:
+# Offense count: 7
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
   Exclude:
-    - 'spec/pdfh/main_spec.rb'
+    - '**/spec/routing/**/*'
+    - 'spec/pdfh/models/document_period_spec.rb'
+    - 'spec/pdfh/models/document_spec.rb'
+    - 'spec/pdfh/utils/console_spec.rb'
+    - 'spec/pdfh/utils/month_spec.rb'
+    - 'spec/pdfh/utils/opt_parser_spec.rb'
+    - 'spec/pdfh/utils/pdf_file_handler_spec.rb'
+    - 'spec/pdfh/utils/settings_builder_spec.rb'
 
 # Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).

data/CHANGELOG.md

@@ -1,31 +1,40 @@
+## v3.0.2
+- Fix `undefined method` when an invalid option is provided
+- Fix and add tests to get above 90% coverage
+
+## v3.0.1
+- Refactor classes for better readability
+- Upgrade to Ruby v3.3.0 and require at least Ruby 3.0.0
+- Upgrade gem dependencies
+
 ## v3.0.0
-  * Migrate to `asdf` from `rvm`
-  * Upgrade old gems
-  * Bump to v3 (as this is project's third iteration)
+- Migrate to `asdf` from `rvm`
+- Upgrade old gems
+- Bump to v3 (as this is project's 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
+- 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
+- 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 an unexisting 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.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    pdfh (3.0.1)
-      colorize (~> 0.8.0)
+    pdfh (3.0.2)
+      colorize (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -25,7 +25,7 @@ GEM
     code-scanning-rubocop (0.6.1)
       rubocop (~> 1.0)
     coderay (1.1.3)
-    colorize (0.8.1)
+    colorize (1.1.0)
     concurrent-ruby (1.2.2)
     connection_pool (2.4.1)
     diff-lcs (1.5.0)

data/README.md

@@ -76,6 +76,12 @@ build pdfh.gemspec
 gem install pdfh-*
 ```
 
+### Conventional Commits
+```bash
+npm install -g @commitlint/cli @commitlint/config-conventional
+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.

data/commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+}

data/lib/pdfh/models/document_sub_type.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+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)
+end

data/lib/pdfh/models/document_type.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 module Pdfh
-  DocumentSubType = Struct.new(:name, :month_offset, keyword_init: true)
-
+  # 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
     # @return [self]

data/lib/pdfh/utils/opt_parser.rb

@@ -13,25 +13,9 @@ module Pdfh
       opts.separator "Specific options:"
 
       opts.on("-tID", "--type=ID", "Document type id (requires a trailing file list)")
-      opts.on_tail("-T", "--list-types", "List document types in configuration") do
-        settings = SettingsBuilder.build
-        ident = 4
-        max_width = settings.document_types.map { |t| t.gid.size }.max
-        puts "#{" " * ident}#{"ID".ljust(max_width)}  Type Name"
-        puts "#{" " * ident}#{"—" * max_width}  #{"—" * 23}"
-        settings.document_types.each do |type|
-          puts "#{" " * ident}#{type.gid.ljust(max_width).yellow}  #{type.name.inspect}"
-        end
-        exit
-      end
-      opts.on_tail("-V", "--version", "Show version") do
-        puts "#{opts.program_name} v#{Pdfh::VERSION}"
-        exit
-      end
-      opts.on_tail("-h", "--help", "help (this dialog)") do
-        puts opts
-        exit
-      end
+      opts.on_tail("-T", "--list-types", "List document types in configuration") { list_types || exit }
+      opts.on_tail("-V", "--version", "Show version") { version || exit }
+      opts.on_tail("-h", "--help", "help (this dialog)") { help || exit }
 
       opts.on("-v", "--verbose", "Show more output. Useful for debug")
       opts.on("-d", "--dry", "Dry run, does not write new pdf")
@@ -47,10 +31,33 @@ module Pdfh
         options[:files] = ARGV if ARGV.any?
         options.transform_keys { |key| key.to_s.tr("-", "_").to_sym }
       rescue OptionParser::InvalidOption => e
-        error_print e.message, exit_app: false
+        Pdfh.error_print(e.message, exit_app: false)
         puts OPT_PARSER.help
         exit 1
       end
+
+      # @return [nil]
+      def version
+        puts "#{OPT_PARSER.program_name} v#{Pdfh::VERSION}"
+      end
+
+      # @return [nil]
+      def help
+        puts OPT_PARSER
+      end
+
+      # @return [nil]
+      def list_types
+        settings = SettingsBuilder.build
+        ident = 4
+        max_width = settings.document_types.map { |t| t.gid.size }.max
+        puts "#{" " * ident}#{"ID".ljust(max_width)}  Type Name"
+        puts "#{" " * ident}#{"—" * max_width}  #{"—" * 23}"
+        settings.document_types.each do |type|
+          puts "#{" " * ident}#{type.gid.ljust(max_width).yellow}  #{type.name.inspect}"
+        end
+        nil
+      end
     end
   end
 end

data/lib/pdfh/utils/options.rb

@@ -11,7 +11,7 @@ module Pdfh
       @verbose = arg_options[:verbose]
       @dry = arg_options[:dry]
       @type = arg_options[:type]
-      @files = arg_options[:files]
+      @files = arg_options[:files] || []
       @mode = type ? :file : :directory
     end
 

data/lib/pdfh/version.rb

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

data/lib/pdfh.rb

@@ -12,6 +12,7 @@ require_relative "ext/string"
 # Models
 require_relative "pdfh/models/document"
 require_relative "pdfh/models/document_period"
+require_relative "pdfh/models/document_sub_type"
 require_relative "pdfh/models/document_type"
 require_relative "pdfh/models/settings"
 

data/pdfh.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "colorize", "~> 0.8.0"
+  spec.add_dependency "colorize", "~> 1.1.0"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfh
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Isaias Piña
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.1.0
 description: Examine all PDF files in Look up directories, remove password (if has
   one), rename and copy to a new directory using regular expressions.
 email:
@@ -48,12 +48,14 @@ files:
 - bin/console
 - bin/run
 - bin/setup
+- commitlint.config.js
 - exe/pdfh
 - lib/ext/string.rb
 - lib/pdfh.rb
 - lib/pdfh/main.rb
 - lib/pdfh/models/document.rb
 - lib/pdfh/models/document_period.rb
+- lib/pdfh/models/document_sub_type.rb
 - lib/pdfh/models/document_type.rb
 - lib/pdfh/models/settings.rb
 - lib/pdfh/settings_template.rb