pdfh 0.1.8 → 0.1.9

data/bin/console

@@ -1,15 +1,15 @@
 #!/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"
+Pry.start
 
-require 'irb'
-IRB.start(__FILE__)
+# require "irb"
+# IRB.start(__FILE__)

data/exe/pdfh

@@ -1,22 +1,22 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'optparse'
-require 'pdfh'
-require 'pdfh/version'
-require 'pdfh/utils'
+require "optparse"
+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
+  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
+  opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
   end
@@ -30,4 +30,14 @@ rescue OptionParser::InvalidOption => e
   exit 1
 end
 
+def validate_installed(app)
+  require "open3"
+  _stdout, _stderr, status = Open3.capture3("command -v #{app}")
+  puts "Missing #{app} command." unless status.success?
+
+  status.success?
+end
+
+exit(1) unless validate_installed("qpdf") && validate_installed("pdftotext")
+
 Pdfh.main(options)

data/lib/ext/string.rb

@@ -7,7 +7,7 @@ module Extensions
   # Adds new functionality to string Class
   refine String do
     def titleize
-      split.map(&:capitalize).join(' ')
+      split.map(&:capitalize).join(" ")
     end
   end
 end

data/lib/pdfh.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'pdfh/version'
-require 'pdfh/settings'
-require 'pdfh/document'
-require 'pdfh/utils'
+require "pdfh/version"
+require "pdfh/settings"
+require "pdfh/document"
+require "pdfh/utils"
 
 ##
 # Gem entry point
@@ -24,7 +24,7 @@ module Pdfh
   def self.search_config_file
     name = File.basename($PROGRAM_NAME)
     names_to_look = ["#{name}.yml", "#{name}.yaml"]
-    dir_order = [Dir.pwd, File.expand_path('~')]
+    dir_order = [Dir.pwd, File.expand_path("~")]
 
     dir_order.each do |dir|
       names_to_look.each do |file|
@@ -33,8 +33,8 @@ module Pdfh
       end
     end
 
-    raise StandardError, "no configuraton file (#{names_to_look.join(' or ')}) was found\n"\
-                         "       within paths: #{dir_order.join(', ')}"
+    raise StandardError, "no configuraton file (#{names_to_look.join(" or ")}) was found\n"\
+                         "       within paths: #{dir_order.join(", ")}"
   end
 
   ##
@@ -63,14 +63,14 @@ module Pdfh
   def self.process_document(file, type)
     puts "Working on #{basename_without_ext(file).colorize(:light_green)}"
     pad = 12
-    print_ident 'Type', type.name, :light_blue, width: pad
+    print_ident "Type", type.name, :light_blue, width: pad
     doc = Document.new(file, type)
-    print_ident 'Sub-Type', doc.sub_type, :light_blue, width: pad
-    print_ident 'Period', doc.period, :light_blue, width: pad
-    print_ident 'New Name', doc.new_name, :light_blue, width: pad
-    print_ident 'Store Path', doc.store_path, :light_blue, width: pad
-    print_ident 'Other files', doc.companion_files(join: true), :light_blue, width: pad
-    print_ident 'Print CMD', doc.print_cmd, :light_blue, width: pad
+    print_ident "Sub-Type", doc.sub_type, :light_blue, width: pad
+    print_ident "Period", doc.period, :light_blue, width: pad
+    print_ident "New Name", doc.new_name, :light_blue, width: pad
+    print_ident "Store Path", doc.store_path, :light_blue, width: pad
+    print_ident "Other files", doc.companion_files(join: true), :light_blue, width: pad
+    print_ident "Print CMD", doc.print_cmd, :light_blue, width: pad
     doc.write_pdf(@settings.base_path)
   rescue StandardError => e
     puts "       Doc Error: #{e.message}".colorize(:red)
@@ -79,16 +79,16 @@ module Pdfh
 
   def self.print_separator(title)
     _rows, cols = `stty size`.split.map(&:to_i)
-    sep = "\n#{'-' * 40} #{title} "
+    sep = "\n#{"-" * 40} #{title} "
     remaining_cols = cols - sep.size
-    sep += '-' * remaining_cols if remaining_cols.positive?
+    sep += "-" * remaining_cols if remaining_cols.positive?
     puts sep.colorize(:light_yellow)
   end
 
   def self.print_ident(field, value, color = :green, width: 3)
     field_str = field.to_s.rjust(width)
     value_str = value.colorize(color)
-    puts "#{' ' * 4}#{field_str}: #{value_str}"
+    puts "#{" " * 4}#{field_str}: #{value_str}"
   end
 
   def self.basename_without_ext(file)

data/lib/pdfh/document.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'fileutils'
-require 'pdfh/month'
-require 'pdfh/pdf_handler'
-require 'ext/string'
+require "fileutils"
+require "pdfh/month"
+require "pdfh/pdf_handler"
+require "ext/string"
 
 ##
 # main module
@@ -13,7 +13,7 @@ module Pdfh
   ##
   # Regular Date Error, when there is not match
   class ReDateError < StandardError
-    def initialize(message = 'No data matched your date regular expression')
+    def initialize(message = "No data matched your date regular expression")
       super(message)
     end
   end
@@ -57,7 +57,7 @@ module Pdfh
     end
 
     def period
-      formated_month = month.to_s.rjust(2, '0')
+      formated_month = month.to_s.rjust(2, "0")
       "#{year}-#{formated_month}"
     end
 
@@ -93,21 +93,21 @@ module Pdfh
     end
 
     def type_name
-      @type ? @type.name.titleize : 'N/A'
+      @type ? @type.name.titleize : "N/A"
     end
 
     def sub_type
-      @sub_type ? @sub_type.name.titleize : 'N/A'
+      @sub_type ? @sub_type.name.titleize : "N/A"
     end
 
     def new_name
-      template = @type.to_h.key?(:name_template) ? @type.name_template : '{original}'
+      template = @type.to_h.key?(:name_template) ? @type.name_template : "{original}"
       new_name = template
-                 .sub('{original}', file_name_only)
-                 .sub('{period}', period)
-                 .sub('{type}', type_name)
-                 .sub('{subtype}', sub_type)
-                 .sub('{extra}', extra || '')
+                 .sub("{original}", file_name_only)
+                 .sub("{period}", period)
+                 .sub("{type}", type_name)
+                 .sub("{subtype}", sub_type)
+                 .sub("{extra}", extra || "")
       "#{new_name}.pdf"
     end
 
@@ -116,7 +116,7 @@ module Pdfh
     end
 
     def print_cmd
-      return 'N/A' if type.print_cmd.nil? || type.print_cmd.empty?
+      return "N/A" if type.print_cmd.nil? || type.print_cmd.empty?
 
       relative_path = File.join(store_path, new_name)
       "#{type.print_cmd} #{relative_path}"
@@ -140,19 +140,19 @@ module Pdfh
     def companion_files(join: false)
       @companion unless join
 
-      @companion.empty? ? 'N/A' : @companion.join(', ')
+      @companion.empty? ? "N/A" : @companion.join(", ")
     end
 
     private
 
     ##
-    # @param [Array] subtypes
+    # @param sub_types [Array]
     # @return [OpenStruct]
     def extract_subtype(sub_types)
       return nil if sub_types.nil? || sub_types.empty?
 
       sub_types.each do |st|
-        is_matched = Regexp.new(st['name']).match?(@text)
+        is_matched = Regexp.new(st["name"]).match?(@text)
         next unless is_matched
 
         sub = OpenStruct.new(st)
@@ -171,7 +171,7 @@ module Pdfh
     # unamed matches needs to be in order month, year
     # @return [Array] - format [month, year, day]
     def match_data
-      Verbose.print '~~~~~~~~~~~~~~~~~~ RegEx'
+      Verbose.print "~~~~~~~~~~~~~~~~~~ RegEx"
       Verbose.print "  Using regex: #{@type.re_date}"
       Verbose.print "        named:   #{@type.re_date.named_captures}"
       matched = @type.re_date.match(@text)
@@ -194,24 +194,24 @@ module Pdfh
     end
 
     def find_companion_files
-      Verbose.print '~~~~~~~~~~~~~~~~~~ Searching Companion files'
+      Verbose.print "~~~~~~~~~~~~~~~~~~ Searching Companion files"
       Verbose.print "   Working on dir: #{home_dir}"
       Dir.chdir(home_dir) do
         all_files = Dir["#{file_name_only}.*"]
-        companion = all_files.reject { |file| file.include? 'pdf' }
-        Verbose.print "     - #{companion.join(', ')}"
+        companion = all_files.reject { |file| file.include? "pdf" }
+        Verbose.print "     - #{companion.join(", ")}"
 
         @companion = companion || []
       end
     end
 
     def copy_companion_files(destination)
-      Verbose.print '~~~~~~~~~~~~~~~~~~ Writing Companion files'
+      Verbose.print "~~~~~~~~~~~~~~~~~~ Writing Companion files"
       @companion.each do |file|
         Verbose.print "  Working on #{file}..."
         src_name = File.join(home_dir, file)
         src_ext = File.extname(file)
-        dest_name = File.basename(new_name, '.pdf')
+        dest_name = File.basename(new_name, ".pdf")
         dest_full = File.join(destination, "#{dest_name}#{src_ext}")
         Verbose.print "    cp #{src_name} --> #{dest_full}"
         FileUtils.cp(src_name, dest_full)

data/lib/pdfh/pdf_handler.rb

@@ -38,7 +38,7 @@ module Pdfh
     end
 
     def write_pdf(dir_path, full_path)
-      Verbose.print '~~~~~~~~~~~~~~~~~~ Writing PDFs'
+      Verbose.print "~~~~~~~~~~~~~~~~~~ Writing PDFs"
       raise IOError, "Path #{dir_path} not found." unless Dir.exist?(dir_path)
 
       password_opt = "--password='#{@password}'" if @password

data/lib/pdfh/settings.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'yaml'
-require 'ostruct'
-require 'base64'
+require "yaml"
+require "ostruct"
+require "base64"
 
 module Pdfh
   ##
@@ -14,11 +14,11 @@ module Pdfh
       file_hash = YAML.load_file(file)
       Verbose.print "Loaded configuration file: #{file}"
 
-      @scrape_dirs = process_scrape_dirs(file_hash['scrape_dirs'])
-      @base_path = File.expand_path(file_hash['base_path'])
-      @document_types = process_doc_types(file_hash['document_types'])
+      @scrape_dirs = process_scrape_dirs(file_hash["scrape_dirs"])
+      @base_path = File.expand_path(file_hash["base_path"])
+      @document_types = process_doc_types(file_hash["document_types"])
 
-      Verbose.print 'Processing directories:'
+      Verbose.print "Processing directories:"
       scrape_dirs.each { |dir| Verbose.print "  - #{dir}" }
       Verbose.print
     end

data/lib/pdfh/utils.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'colorize'
+require "colorize"
 
 # Contains all generic short functionality
 module Pdfh
@@ -15,7 +15,7 @@ module Pdfh
         @active
       end
 
-      def print(msg = '')
+      def print(msg = "")
         puts msg.colorize(:cyan) if active?
       end
     end

data/lib/pdfh/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pdfh
-  VERSION = '0.1.8'
+  VERSION = "0.1.9"
 end

data/pdfh.gemspec

@@ -1,52 +1,43 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pdfh/version'
+# lib = File.expand_path("lib", __dir__)
+# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/pdfh/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'pdfh'
+  spec.name          = "pdfh"
   spec.version       = Pdfh::VERSION
-  spec.authors       = ['Isaias Piña']
-  spec.email         = ['iax7@users.noreply.github.com']
+  spec.authors       = ["Isaias Piña"]
+  spec.email         = ["iax7@users.noreply.github.com"]
 
-  spec.summary       = 'Organize PDF files'
-  spec.description   = 'Examine all PDF files in scrape directories, remove password (if has one), '\
-                       'rename and copy to a new directory using regular expresions.'
-  spec.homepage      = 'https://github.com/iax7/pdfh'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.summary       = "Organize PDF files"
+  spec.description   = "Examine all PDF files in scrape directories, remove password (if has one), "\
+                       "rename and copy to a new directory using regular expresions."
+  spec.homepage      = "https://github.com/iax7/pdfh"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = spec.homepage
-    spec.metadata['changelog_uri'] = 'https://raw.githubusercontent.com/iax7/pdfh/master/CHANGELOG.md'
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "https://raw.githubusercontent.com/iax7/pdfh/master/CHANGELOG.md"
   else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:\.\w+|docs|test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'colorize', '~> 0.8.0'
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'simplecov-console'
-  spec.add_development_dependency 'versionomy'
+  spec.add_dependency "colorize", "~> 0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfh
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Isaias Piña
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,118 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov-console
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: versionomy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Examine all PDF files in scrape directories, remove password (if has
   one), rename and copy to a new directory using regular expresions.
 email:
@@ -150,7 +38,6 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -160,7 +47,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docs/legacy.md
 - exe/pdfh
 - lib/ext/string.rb
 - lib/pdfh.rb
@@ -194,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.4
 signing_key:
 specification_version: 4
 summary: Organize PDF files