pdfh 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 375df17076824594d8622b7dd9474ab53400297c5ff4598463b5dac3fea352d2
-  data.tar.gz: 5174dd71598e65630e78b394f3aa46d2562e9de7d682dcb30cd5695af7a75012
+  metadata.gz: a3761420b1befc7788493ed341094bffcf3b6f86bc2f6685f7b4de0a8201752b
+  data.tar.gz: 9da09a68dff012c3e22e67581c73b1bf874ed3abd0f9d58be8c760fa37ca6561
 SHA512:
-  metadata.gz: 68bed2cab1ef5346e7774d03d66538fcdbdd0ccbc72168359d4e3422a7d39c306de4483dd074483aec6f63d197d7275b072cce080178547b94c6adf2853e81e9
-  data.tar.gz: 35087b577052e468a97183af2305e3cef5d03fa42d9942d4528701280894dbe290759bc01b124ce54ba5835e7af53a67cbff5438c568cc1d7e0ce4f50bcdaccd
+  metadata.gz: 5a9ba91f43fcb3e96469bf1d4499ab9e857211553bebe4732e0d3d287e4fe7946fe635b7f6e345576d69da6b07573acce2794619098d62ae40309c7f3d170f2d
+  data.tar.gz: 80a52f67d7c47159918b5cff641f5744022d1400bf71ac9fe6247814a0369e0a2ec8e2915b791a5e85e1107a28d9c64777471aa1ec448aa1ad093ecf83805287

data/.ruby-version

@@ -1 +1 @@
-ruby-3.0.1
+ruby-3.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pdfh (0.2.0)
+    pdfh (0.2.1)
       colorize (~> 0.8.0)
 
 GEM
@@ -14,18 +14,18 @@ GEM
       rubocop (~> 1.0)
     coderay (1.1.3)
     colorize (0.8.1)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     docile (1.4.0)
     method_source (1.0.0)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.21.0)
+    parser (3.1.0.0)
       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)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -39,28 +39,27 @@ GEM
     rspec-mocks (3.10.2)
       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.10.3)
+    rspec_junit_formatter (0.5.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.14.0)
+    rubocop (1.24.1)
       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)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.5.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.11.3)
+    rubocop-performance (1.13.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.3.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.7.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -72,9 +71,9 @@ GEM
       terminal-table
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    terminal-table (3.0.1)
+    terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     versionomy (0.5.0)
       blockenspiel (~> 0.5)
 

data/README.md

@@ -41,6 +41,19 @@ document_types:
         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.
@@ -68,5 +81,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 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-badge]: https://img.shields.io/badge/ruby-3.1.0-blue?style=flat&logo=ruby&logoColor=CC342D&labelColor=white
 [ruby-url]: https://www.ruby-lang.org/en/

data/lib/pdfh/document.rb

@@ -3,7 +3,7 @@
 module Pdfh
   # Handles the PDF detected by the rules
   class Document
-    attr_reader :text, :type, :file, :extra, :pdf_doc
+    attr_reader :text, :type, :file, :extra, :pdf_doc, :period
 
     # @param file [String]
     # @param type [DocumentType]
@@ -13,7 +13,7 @@ module Pdfh
 
       @file = file
       @type = type
-      Pdfh.verbose_print "=== Type: #{type.name} =============================="
+      Pdfh.verbose_print "=== Document Type: #{type.name} =============================="
       @pdf_doc = PdfHandler.new(file, type.pwd)
       @text = @pdf_doc.extract_text
       Pdfh.verbose_print "~~~~~~~~~~~~~~~~~~ Finding a subtype"
@@ -51,17 +51,14 @@ module Pdfh
       @sub_type&.name&.titleize || "N/A"
     end
 
-    # @return [String]
-    def period
-      @period.to_s
-    end
-
     # @return [String]
     def new_name
       template = @type.name_template
       new_name = template
                  .sub("{original}", file_name_only)
-                 .sub("{period}", period)
+                 .sub("{period}", period.to_s)
+                 .sub("{year}", period.year.to_s)
+                 .sub("{month}", period.month.to_s)
                  .sub("{type}", type_name)
                  .sub("{subtype}", sub_type)
                  .sub("{extra}", extra || "")
@@ -70,7 +67,7 @@ module Pdfh
 
     # @return [String]
     def store_path
-      @type.store_path.gsub("{YEAR}", @period.year.to_s)
+      @type.store_path.gsub("{YEAR}", period.year.to_s)
     end
 
     # @return [String]
@@ -103,7 +100,7 @@ module Pdfh
     # unnamed matches needs to be in order month, year
     # @return [Array] - format [month, year, day]
     def match_data
-      Pdfh.verbose_print "~~~~~~~~~~~~~~~~~~ RegEx"
+      Pdfh.verbose_print "~~~~~~~~~~~~~~~~~~ Match Data RegEx"
       Pdfh.verbose_print "  Using regex: #{@type.re_date}"
       Pdfh.verbose_print "        named:   #{@type.re_date.named_captures}"
       matched = @type.re_date.match(@text)

data/lib/pdfh/document_period.rb

@@ -24,9 +24,14 @@ module Pdfh
       @year = (year.size == 2 ? "20#{year}" : year).to_i + year_offset
     end
 
-    # @return [String]
+    # @return [String (frozen)]
     def to_s
       "#{year}-#{month.to_s.rjust(2, "0")}"
     end
+
+    # @return [String (frozen)]
+    def inspect
+      "<#{self.class} year=#{year} month=#{month}>"
+    end
   end
 end

data/lib/pdfh/document_processor.rb

@@ -11,7 +11,7 @@ module Pdfh
       Pdfh.verbose = options[:verbose]
       Pdfh.dry = options[:dry]
       Pdfh.verbose_print(options)
-      @mode = options.key?(:type) ? :file : :directory
+      Pdfh.mode = options.key?(:type) ? :file : :directory
     end
 
     # @return [void]
@@ -19,7 +19,7 @@ module Pdfh
       @settings = Settings.new(Pdfh.search_config_file)
       puts "Destination path: #{@settings.base_path.colorize(:light_blue)}" if Pdfh.verbose?
 
-      @mode == :file ? process_files : process_lookup_dirs
+      Pdfh.file_mode? ? process_files : process_lookup_dirs
     rescue SettingsIOError => e
       Pdfh.error_print(e.message, exit_app: false)
       Pdfh.create_settings_file
@@ -53,6 +53,7 @@ module Pdfh
       raise ArgumentError, "No files provided to process #{type_id.inspect} type." unless options[:files]
 
       type = doc_type_by_id(type_id)
+      Pdfh.error_print "Type #{type_id.inspect} was not found." if type.nil?
       puts
       options[:files].each do |file|
         unless File.exist?(file)
@@ -109,7 +110,7 @@ module Pdfh
       Pdfh.ident_print "Type", type.name, color: :light_blue, width: pad
       doc = Document.new(file, type)
       Pdfh.ident_print "Sub-Type", doc.sub_type, color: :light_blue, width: pad
-      Pdfh.ident_print "Period", doc.period, color: :light_blue, width: pad
+      Pdfh.ident_print "Period", doc.period.to_s, color: :light_blue, width: pad
       Pdfh.ident_print "New Name", doc.new_name, color: :light_blue, width: pad
       Pdfh.ident_print "Store Path", doc.store_path, color: :light_blue, width: pad
       Pdfh.ident_print "Other files", doc.companion_files(join: true), color: :light_blue, width: pad

data/lib/pdfh/version.rb

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

data/lib/pdfh.rb

@@ -21,13 +21,13 @@ module Pdfh
 
   # Regular Date Error, when there is not match
   class ReDateError < StandardError
-    def initialize(msg = "No data matched your date regular expression")
+    def initialize(msg = "Date regular expression did not find a match in document.")
       super
     end
   end
 
   class << self
-    attr_writer :verbose, :dry
+    attr_writer :verbose, :dry, :mode
 
     # @return [Boolean]
     def verbose?
@@ -39,6 +39,11 @@ module Pdfh
       @dry
     end
 
+    # @return [Boolean]
+    def file_mode?
+      @mode == :file
+    end
+
     # Returns rows, cols
     # TODO: review https://gist.github.com/nixpulvis/6025433
     # @return [Array<Integer, Integer>]
@@ -108,9 +113,7 @@ module Pdfh
       full_path = File.join(File.expand_path("~"), "#{config_file_name}.yml")
       return if File.exist?(full_path) # double check
 
-      File.open(full_path, "w") do |f|
-        f.write Pdfh::SETTINGS_TEMPLATE.to_yaml
-      end
+      File.write(full_path, Pdfh::SETTINGS_TEMPLATE.to_yaml)
       puts "Settings #{full_path.inspect.colorize(:green)} was created."
     end
 
@@ -128,7 +131,7 @@ module Pdfh
       end
 
       raise SettingsIOError, "no configuration file (#{names_to_look.join(" or ")}) was found\n"\
-                               "       within paths: #{dir_order.join(", ")}"
+                             "       within paths: #{dir_order.join(", ")}"
     end
   end
 end

data/pdfh.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfh
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Isaias Piña
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-15 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -70,6 +70,7 @@ metadata:
   homepage_uri: https://github.com/iax7/pdfh
   source_code_uri: https://github.com/iax7/pdfh
   changelog_uri: https://github.com/iax7/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -85,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Organize PDF files