pdfmd 1.9.1 → 2.0.0

data/pdfmd.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                  = 'pdfmd'
-  s.version               = `grep -m 1 VERSION lib/pdfmd.rb | awk -F"'" '{ print $2 '}`
+  s.version               = `grep -m 1 VERSION bin/pdfmd | awk -F"'" '{ print $2 '}`
   s.date                  = Time.now.strftime("%Y-%m-%d").to_s
   s.summary               = "pdfmd - pdf-meta-data management"
   s.description           = <<-EOF
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
     Sets common tags like 'author', 'createdate', 'title', 'subject' and 'keywords'
     and re-uses them for renaming the file with to a human-readable identifier.
   EOF
-  s.post_install_message  = 'Run `pdfmd` to see the command help.'
+  s.post_install_message  = '. Run `pdfmd` to see the command help.'
   s.authors               = ['Daniel Roos']
   s.email                 = 'pdfmd@micronarrativ.org'
   s.require_paths         = ['lib']
@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.files                 = `git ls-files`.split("\n")
   s.executable            = 'pdfmd'
   s.homepage              = 'https://github.com/Micronarrativ/ruby-pmd'
+  s.metadata              = { 'created' => Time.now.strftime("%Y-%m-%d %H:%M:%S"), 'revision' => Time.now.strftime("%Y%m%d%H%M%S") }
   s.license               = 'MIT'
   s.add_dependency "thor", '~>0.19', '>= 0.19.1'
   s.add_dependency 'highline', '~>1.7', '>= 1.7.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfmd
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -105,11 +105,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- TODO.mkd
 - bin/pdfmd
 - lib/pdfmd.rb
-- lib/pdfmd/check.rb
-- lib/pdfmd/config.rb
-- lib/pdfmd/edit.rb
 - lib/pdfmd/explain.author.md
 - lib/pdfmd/explain.createdate.md
 - lib/pdfmd/explain.csv.md
@@ -120,11 +118,23 @@ files:
 - lib/pdfmd/explain.rb
 - lib/pdfmd/explain.subject.md
 - lib/pdfmd/explain.title.md
+- lib/pdfmd/long_desc.pdfmdconfig.txt
+- lib/pdfmd/long_desc.pdfmdedit.txt
+- lib/pdfmd/long_desc.pdfmdexplain.txt
+- lib/pdfmd/long_desc.pdfmdrename.txt
+- lib/pdfmd/long_desc.pdfmdshow.txt
+- lib/pdfmd/long_desc.pdfmdsort.txt
+- lib/pdfmd/long_desc.pdfmdstat.txt
 - lib/pdfmd/methods.rb
-- lib/pdfmd/rename.rb
-- lib/pdfmd/show.rb
-- lib/pdfmd/sort.rb
-- lib/string_extend.rb
+- lib/pdfmd/pdfmdconfig.rb
+- lib/pdfmd/pdfmdedit.rb
+- lib/pdfmd/pdfmdmethods.rb
+- lib/pdfmd/pdfmdrename.rb
+- lib/pdfmd/pdfmdshow.rb
+- lib/pdfmd/pdfmdsort.rb
+- lib/pdfmd/pdfmdstat.rb
+- lib/pdfmd/string_extend.rb
+- lib/run.rb
 - pdfmd.gemspec
 - test/test_default.pdf
 - test/test_rename.rb
@@ -133,8 +143,10 @@ files:
 homepage: https://github.com/Micronarrativ/ruby-pmd
 licenses:
 - MIT
-metadata: {}
-post_install_message: Run `pdfmd` to see the command help.
+metadata:
+  created: '2015-07-07 08:08:08'
+  revision: '20150707080808'
+post_install_message: ". Run `pdfmd` to see the command help."
 rdoc_options: []
 require_paths:
 - lib

data/lib/pdfmd/check.rb

@@ -1,10 +0,0 @@
-filename = ENV.fetch('PDFMD_FILENAME')
-
-returnvalue = 0
-readMetadata(filename).each do|key,value|
-  if key.match(/author|subject|createdate|title/) and value.empty?
-    puts 'Missing value: ' + key 
-    returnvalue == 0 ? returnvalue = 1 : ''
-  end
-end
-exit returnvalue

data/lib/pdfmd/config.rb

@@ -1,59 +0,0 @@
-#
-# == File: config.rb
-#
-# Show the current default configuration settings
-#
-
-# Options
-opt_show    = ENV.fetch('PDFMD_SHOW')
-opt_command = ENV.fetch('PDFMD_COMMAND').downcase
-
-require_relative '../string_extend.rb'
-require 'yaml'
-require 'pp'
-
-#
-# If now options are set,
-# show the current settings
-if opt_show.blank? or opt_show == 'true'
-  opt_show = true
-end
-
-# Show the current settings
-case opt_show
-when true
-
-  # As long as only Hiera is supported as external storage
-  # for configuration (unless I need it otherwise), read the
-  # hiera configuration
-  puts 'Current default configuration:'
-  puts ''
-  hieraConfig = eval `hiera pdfmd::config`
-
-  # Show the configuration only for one key
-  if not opt_command.empty? and
-
-    hieraConfig.has_key?(opt_command)
-
-    puts 'Command: ' + opt_command
-    puts hieraConfig[opt_command].to_yaml
-    puts ''
-
-  # Strange key provided. Typo? Anyway: error
-  elsif not opt_command.empty? and
-    not hieraConfig.has_key?(opt_command)
-
-    puts "Command '#{opt_command}' not found in default configuration."
-
-  # Show all configuration from Hiera
-  else
-
-    hieraConfig.sort.each do |key,value|
-      puts 'Command: ' + key
-      puts value.to_yaml
-      puts ''
-    end
-
-  end
-
-end

data/lib/pdfmd/edit.rb

@@ -1,144 +0,0 @@
-#
-# Thor command 'edit' for changing the common
-# ExifTags within the PDF file
-# TODO: backup file/path into hiera and options
-#
-
-require_relative '../string_extend'
-
-filename    = ENV.fetch('PDFMD_FILENAME')
-optTag      = ENV['PDFMD_TAG'] || nil
-opt_rename  = ENV['PDFMD_RENAME']
-pdfmd       = ENV['PDFMD']
-opt_log     = ENV['PDFMD_LOG']
-opt_logfile = ENV['PDFMD_LOGFILE']
-hieraDefaults = queryHiera('pdfmd::config')
-
-# Rename or not
-if opt_rename == 'true'
-  opt_rename = true
-elsif opt_rename == 'false'
-  opt_rename = false
-elsif (!hieraDefaults.nil? and
-  !hieraDefaults['edit'].nil? and
-  ! hieraDefaults['edit']['rename'].nil? and
-  hieraDefaults['edit']['rename'] == true)
-  opt_rename = true
-else
-  opt_rename = false
-end
-
-# Define logging state
-if (hieraDefaults.nil? or
-  hieraDefaults['edit'].nil? or
-  hieraDefaults['edit']['log'].nil? or
-  !hieraDefaults['edit']['log'] == true ) and
-  (opt_log == 'false' or opt_log.blank?)
-
-  logenable = false
-  
-else
-
-  logenable = true
-
-end
-
-# If logging is enabled, set parameters and create the obkject
-if logenable
-
-  if opt_logfile.nil?  and
-    ( hieraDefaults['edit'].nil? or
-    hieraDefaults['edit']['logfile'].nil? or
-    hieraDefaults['edit']['logfile'].blank? ) 
-
-    logfile = Dir.pwd.chomp('/') + '/' + File.basename(ENV['PDFMD'], '.*') + '.log'
-
-  elsif not opt_logfile.nil? and not opt_logfile.blank?
-
-    if File.directory? opt_logfile
-      abort('Logfile path is a directory. Abort.')
-      exit 1
-    end
-
-    logfile = opt_logfile
-
-  elsif (opt_logfile.nil? or opt_logfile.blank?) and
-    not hieraDefaults['edit']['logfile'].blank?
-
-    logfile = hieraDefaults['edit']['logfile']
-
-  else
-
-    logfile = Dir.pwd.chomp('/') + '/' + File.basename(ENV['PDFMD'], '.*') + '.log'
-
-  end
-
-  $logger = Logger.new(logfile)
-
-end
-
-metadata = readMetadata(filename)
-
-# Set the password for the exiftool if available
-if metadata['password'].size > 0
-  logenable ? $logger.info("#{filename}: Using PDF password to edit metadata.") : ''
-  exifPdfPassword = "-password '#{metadata['password']}'"
-else
-  exifPdfPassword = ''
-end
-
-if optTag == 'all'
-  tags = ['author','title','subject','createdate','keywords']
-else
-  tags = optTag.split(',')
-end
-
-tags.each do |currentTag|
-
-  # If the tags contain an '=', set the value for the tag
-  # automatically. Otherwise enter interactive mode.
-  if currentTag.match(/\=/)
-
-    tag, value = currentTag.split('=')
-
-    # Include Date identifier
-    if tag.downcase == 'createdate'
-      value = identifyDate(value)
-    end
-
-    logenable ? $logger.info("#{filename}: Setting value for tag '#{tag.downcase}': '#{value}'") : ''
-
-    # Running the exiftool with optional PDF password parameter on the original file
-    `exiftool #{exifPdfPassword} -#{tag.downcase}='#{value}' -overwrite_original '#{filename}'`
-
-  else
-
-    # Change the tag to something we can use here
-    puts "Current value: '#{metadata[currentTag.downcase]}'"
-    answer     = readUserInput("Enter new value for #{currentTag} :")
-    answerCopy = answer
-    if currentTag.downcase == 'createdate'
-      while not answer = identifyDate(answer)
-        logenable ? $logger.warn("${filename}: Invalid date provided: '#{answerCopy}'.") : ''
-        logenable ? $logger.info("${filename}: Asking for new user provided date.") : ''
-        puts 'Invalid date format.'
-        answer = readUserInput("Enter new value for #{currentTag} :")
-      end
-    end
-    puts "Changing value for #{currentTag}: '#{metadata[currentTag]}' => #{answer}"
-    logenable ? $logger.info("#{filename}: Setting value for tag '#{currentTag.downcase}': '#{answer}'") : ''
-
-    # Running the exiftool with optional PDF password parameter on the original file
-    `exiftool #{exifPdfPassword} -#{currentTag.downcase}='#{answer}' -overwrite_original '#{filename}'`
-  
-  end # If interactive/batch mode
-end
-
-#
-# If required, run the renaming task afterwards
-# This is not pretty, but seems to be the only way to do this in THOR
-#
-if opt_rename
-  logenable ? $logger.info("#{filename}: Trigger file renaming.") : ''
-  `#{pdfmd} rename '#{filename}'`
-end

data/lib/pdfmd/rename.rb

@@ -1,295 +0,0 @@
-#
-# Thor command 'rename'
-#
-require_relative '../string_extend'
-
-filename            = ENV.fetch('PDFMD_FILENAME')
-opt_allkeywords     = ENV.fetch('PDFMD_ALLKEYWORDS')
-outputdir           = ENV.fetch('PDFMD_OUTPUTDIR') == 'false' ? false : ENV.fetch('PDFMD_OUTPUTDIR')
-dryrun              = ENV.fetch('PDFMD_DRYRUN') == 'false' ? false : true
-opt_numberKeywords  = ENV.fetch('PDFMD_NUMBERKEYWORDS')
-opt_copy            = ENV.fetch('PDFMD_COPY')
-opt_log             = ENV.fetch('PDFMD_LOG')
-opt_logfile         = ENV.fetch('PDFMD_LOGFILE')
-hieraDefaults       = queryHiera('pdfmd::config')
-
-if opt_log == 'false'
-  logenable = false
-elsif opt_log == 'true'
-  logenable = true
-elsif opt_log.blank? and
-  !hieraDefaults.nil? and
-  !hieraDefaults['rename'].nil? and
-  !hieraDefaults['rename']['log'].nil? and
-   hieraDefaults['rename']['log'] == true
-  logenable = true
-else
-  logenable = true
-end
-
-if logenable
-
-  if opt_logfile.blank? and
-    (
-     !hieraDefaults.nil? and
-     hieraDefaults['rename'].nil? and 
-     (hieraDefaults['rename']['logfile'].nil? or
-     hieraDefaults['rename']['logfile'].blank?))
-
-    logfile = Dir.pwd.chomp('/') + '/' + File.basename(ENV['PDFMD'], '.*') + '.log'
-
-  elsif not opt_logfile.blank?
-
-    if File.directory? opt_logfile
-      abort('Logfilepath is a directory. Abort.')
-      exit 1
-    end
-
-    logfile = opt_logfile
-
-  elsif opt_logfile.blank? and
-    !hieraDefaults.nil? and
-    !hieraDefaults['rename'].nil? and
-    !hieraDefaults['rename']['logfile'].nil? and
-    not hieraDefaults['rename']['logfile'].blank?
-
-    logfile = hieraDefaults['rename']['logfile']
-
-  else
-
-    logfile = Dir.pwd.chomp('/') + '/' + File.basename(ENV['PDFMD'], '.*') + '.log'
-
-  end
-
-  $logger = Logger.new(logfile)
-
-end
-
-metadata = readMetadata(filename).each do |key,value|
-
-  # Check if the metadata is complete
-  if key.match(/author|subject|createdate|title/) and value.empty?
-    puts 'Missing value for ' + key
-    puts 'Abort'
-    exit 1
-  end
-
-end
-
-
-# Determine the status of allkeywords
-# Default value is false
-if opt_allkeywords == 'true'
-  opt_allkeywords = true
-elsif opt_allkeywords.blank? and 
-  !hieraDefaults.nil? and
-  !hieraDefaults['rename'].nil? and
-  not hieraDefaults['rename']['allkeywords'].nil?
-
-  opt_allkeywords = hieraDefaults['rename']['allkeywords']
-
-elsif opt_allkeywords == 'false' or
-  opt_allkeywords.blank?
-
-  opt_allkeywords = false
-
-end
-
-#
-# Determine the number of keywords
-# Default value is 3
-if opt_numberKeywords.blank? and
-  !hieraDefaults.nil? and
-  !hieraDefaults['rename'].nil? and
-  !hieraDefaults['rename']['keywords'].nil?
-
-  opt_numberKeywords = hieraDefaults['rename']['keywords']
-
-elsif opt_numberKeywords.to_i.is_a? Integer and
-  opt_numberKeywords.to_i > 0
-
-  opt_numberKeywords = opt_numberKeywords.to_i
-
-else
-
-  opt_numberKeywords = 3
-
-end
-
-#
-# Determine the status of the copy parameter
-if opt_copy.blank? and
-  !hieraDefaults.nil? and
-  !hieraDefaults['rename'].nil? and
-  !hieraDefaults['rename']['copy'].nil?
-
-  opt_copy = hieraDefaults['rename']['copy']
-
-elsif opt_copy == 'true'
-
-  opt_copy = true
-
-else
-
-  opt_copy = false
-
-end
-
-# Use a default set for the keywords or (if provided) the keywords from hiera
-# The default set is only in english
-if !hieraDefaults.nil? and
-  !hieraDefaults['rename'].nil? and 
-  !hieraDefaults['rename']['keys'].nil? and
-  hieraDefaults['rename']['keys'] != ''
-
-  keymappings = hieraDefaults['rename']['keys']
-
-else
-  keymappings = {
-    'cno' => ['Customer','Customernumber'],
-    'con' => ['Contract'],
-    'inf' => ['Information'],
-    'inv' => ['Invoice', 'Invoicenumber'],
-    'man' => ['Manual'],
-    'off' => ['Offer', 'Offernumber'],
-    'ord' => ['Order', 'Ordernumber'],
-    'rec' => ['Receipt', 'Receiptnumber'],
-    'tic' => ['Ticket'],
-    }
-end
-
-
-date   = metadata['createdate'].gsub(/\ \d{2}\:\d{2}\:\d{2}.*$/,'').gsub(/\:/,'')
-author = metadata['author'].gsub(/\./,'_').gsub(/\&/,'').gsub(/\-/,'').gsub(/\s/,'_').gsub(/\,/,'_').gsub(/\_\_/,'_')
-I18n.enforce_available_locales = false
-author = I18n.transliterate(author) # Normalising
-
-keywords_preface = ''
-# Determine the document type from the title.
-
-# Default docment type
-if !hieraDefaults.nil? and
-  !hieraDefaults['rename'].nil? and
-  !hieraDefaults['rename']['defaultdoctype'].nil? and
-  hieraDefaults['rename']['defaultdoctype'].empty?
-
-  doktype = hieraDefaults['rename']['defaultdoctype']
-else
-  doktype = 'doc'
-end
-
-
-## Iterate through the keymappings and try to find a matching doktype
-keymappings.each do |key,value|
-  value.kind_of?(String) ? value = value.split : ''
-  value.each do |keyword|
-    metadata['title'].match(/#{keyword}/i) ? doktype = key : ''
-  end
-end
-
-# Set the preface from the doktype
-# This must be added to the beginning of the hash when generating
-# the filename so it will come first after the doktype
-keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
-
-if not metadata['keywords'].empty? 
-  keywords = ''
-  #keywords_preface == '' ? keywords = '' : keywords = keywords_preface
-  keywordsarray    = metadata['keywords'].split(',')
-
-  #
-  # Sort array
-  # and replace key-strings with the abbreviations
-  #   in combination with the titel information for the filename
-  # BTW: When the value is identical with the title, then it should be 
-  # the first keyword IMHO. TODO
-  keywordssorted = Array.new
-  keywordsarray.each_with_index do |value,index|
-    value = value.lstrip.chomp
-
-   # Replace strings for the filename with abbreviations 
-   keymappings.each do |abbreviation,keyvaluesarray|
-     keyvaluesarray.kind_of?(String) ? keyvaluesarray = keyvaluesarray.split : ''
-     keyvaluesarray.each do |keystring|
-       value = value.gsub(/#{keystring.lstrip.chomp} /i, abbreviation.to_s)
-     end
-   end 
-    
-    # Remove special characters from string
-    value = value.gsub(/\s|\/|\-|\./,'_')
-
-    keywordsarray[index] = value
-
-    # If the current values matches some of the replacement-abbreviations,
-    # put the keyword on the top of the array to be listed first later on 
-    # in the filename
-    if value.match(/^#{keymappings.keys.join('|')} /i)
-      keywordssorted.insert(0, value)
-    else
-      keywordssorted.push(value)
-    end
-
-  end
-
-  # Insert the document preface in the beginning when it's available
-  if not keywords_preface.empty?
-    keywordssorted.insert(0, keywords_preface) 
-  end
-
-  # all keywords as a string 
-  if not opt_allkeywords
-    keywords = keywordssorted.values_at(*(0..opt_numberKeywords-1)).join('-')
-  else
-    keywords = keywordssorted.join('-')
-  end
-
-  # Normalise the keywords as well
-  I18n.enforce_available_locales = false
-  keywords = I18n.transliterate(keywords)
-
-else
-
-  # There are no keywords.
-  # we are using the title and the subject
-  keywords_preface != '' ? keywords = keywords_preface : ''
-
-end
-
-extension   = 'pdf'
-if keywords != nil and keywords[0] != '-'
-  keywords = '-' + keywords
-end
-newFilename = date + '-' +
-  author + '-' +
-  doktype +
-  keywords + '.' + 
-  extension
-
-# Output directory checks
-if outputdir 
-
-  if not File.exist?(outputdir)
-    puts "Error: output dir '#{outputdir}' not found. Abort."
-    exit 1
-  end
-
-else
-
-  # Try to get the outputdir from hiera
-  outputdir = (!hieraDefaults.nil? and !hieraDefaults['rename'].nil? and !hieraDefaults['rename']['outputdir'].nil?) ? hieraDefaults['rename']['outputdir'] : File.dirname(filename)
-
-end
-
-if not dryrun and filename != newFilename.downcase
-
-  logenable ? $logger.info(filename + ' => ' + outputdir + '/' + newFilename.downcase): ''
-
-  # Copy of me the file to the new name
-  command = opt_copy ? 'cp' : 'mv'
-  `#{command} -v '#{filename}' '#{outputdir}/#{newFilename.downcase}'`
-
-else
-
-  logenable ? $logger.info('Dryrun: ' + filename + ' => ' + outputdir + '/' + newFilename.downcase): ''
-
-end