pdfmd 1.8.0 → 1.9.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTY5MDkwYTcxZjliNTZiN2M2YjBhNWI0MTc2MDJmMjk3Zjc5YWFhZg==
-  data.tar.gz: !binary |-
-    MGEwMDkwYTFmZjAyNmRlNTMzZmY1OTNkMjU5ZjFlNzhiNzhkMGY2NQ==
+SHA1:
+  metadata.gz: df76f47dcfbeabf7402e1ae6b11198430bef7233
+  data.tar.gz: ba937131f2b83cb52cbc9c534012397dbc986634
 SHA512:
-  metadata.gz: !binary |-
-    ZGM4Njk2Y2E4ZjlkY2QzZGVmZTM0ODZhNWFjNGI1ZTNmNjI4NTE0MDkyMTAz
-    YjUwYTMwOTMzNjZhOTBkMjExYWJmNTVmOWYwNjczOTdiZWIzMTUzMDQ1NzI1
-    YzdmMzM3YTY5NWQ5ZGZmYTU3MjIxZThjNDAyMTdmZDkxNzM0MmE=
-  data.tar.gz: !binary |-
-    NGE5NzcyN2MzOGRlYWFkOTUzMzEyNDQ4YTllNzZmZDViOTNmZTBiZDIwZDRm
-    Nzg2MWRkNmE4ZTE0M2YxMTEzZTZkMTdjYTJhZGMyZGUyMDE4NDRkMWEzZmQ3
-    YWM4YzM5ZDg4ZjBlZDcxOWRmZTNmYjE5MzA1Y2RjYTdhNmY2M2M=
+  metadata.gz: aab4cd58aacee00a636527a34929ea501f46eabbdd122a2bcb88824c54f14818fecbc559ca5a3ed1390efaaf2d4ca887b3784eb864b37ee27be2df72e29efbdf
+  data.tar.gz: 922695d6b0a21d1c7ec539ef764fe0480f989c047c09712c31da57af9f982f44bf9d0a9378379e8e47242a9248cf4c11565550ae9f40f856df28d29619618b9b

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# Version 1.9.0
+- Added explain 'hiera-keys'
+- Added parameter to command 'config'
+- Added single file sort support for command 'sort'
+- Bugfix: Fixed to run commands without Hiera.
+- Bugfix: Logfile parameter was not correctly recognized when renaming.
+- Bugfix: Renaming dry-run ran into an error in developement mode.
+- Key-abbreviations are now configureable from Hiera.
+- Keywords matching the document type will now be listed first in the document name if the subject is meaningful.
+- Simplyfied the renaming command code.
+- Updated Documentation
+- Updated Tests
+
 # Version 1.8.0
 - Added Support for password protected pdf files in command 'show' and 'edit'
 - Cleaned up renaming key-string and added all string for NO,EN an DE language.

data/Rakefile

@@ -42,6 +42,30 @@ def initTmpDir
   FileUtils.cp(EXAMPLEPDF, TMPDIR + '/')
 end
 
+#
+# Build a new version
+#
+desc 'Build new gem file, optionally install it'
+task :build, :arg1 do |t, args|
+
+  args.with_defaults(:arg1 => '')
+
+  installoutput = `gem build pdfmd.gemspec`
+
+  if args[:arg1] == 'install'
+
+    installoutput.each_line do |line|
+
+      if line.match(/File\:\s/)
+        filename = line.split(': ')
+        puts `gem install #{filename[1]}`
+      end
+    end
+
+  end
+
+end
+
 #
 # Testing command 'sort'
 #

data/lib/pdfmd.rb

@@ -57,7 +57,7 @@ require "i18n"
 require 'pathname'
 require 'logger'
 
-VERSION = '1.8.0'
+VERSION = '1.9.0'
 
 # Include general usage methods
 require_relative('pdfmd/methods.rb')
@@ -166,11 +166,28 @@ class DOC < Thor
   desc 'config', 'Show config defaults'
   long_desc <<-LONGDESC
 
+  Shows the current default configuration as available in Hiera.
+
+  == Usage
+
+  Example: `pdfmd config [<command>]`
+
+
+  == Parameter
+
+  [<commandname>]
+
+  Shows only the default configuration from hiera for the specified command.
+  The command parameter is not case-sensitive.
+
+  Example: `pdfmd config edit`
+
   LONGDESC
   method_option :show, :type => :boolean, :aliases => '-s', :required => false
-  def config
+  def config(subcommand = '')
 
-    ENV['PDFMD_SHOW'] = options[:show].to_s
+    ENV['PDFMD_SHOW']     = options[:show].to_s
+    ENV['PDFMD_COMMAND']  = subcommand
     require_relative('./pdfmd/config.rb')
 
   end
@@ -362,7 +379,7 @@ class DOC < Thor
 
   When using this action a logfile with all actions will be generated in the
   current working directory with the same name as the script and the ending
-  '.log'. This can be disabled with the parameter 'log' if required.
+  '.log'. This can be disabled with the parameter 'log' if required or adjusted to write the logfile to a different location.
 
   If a document does not have an entry in the meta tag 'author', the file will
   not be processed. This can be seen in the output of the logfile as well.
@@ -393,8 +410,6 @@ class DOC < Thor
 
   Default: disabled.
 
-
-
   === Replacement rules
 
   The subdirectories for the documents are generated from the values in the
@@ -447,6 +462,9 @@ class DOC < Thor
    \x5 4. Disable the logging.
    \x5> CLI sort -d /tmp/test -c -l false ./documents
 
+   # Sort only a single file
+   \x5> CLI sort -d /tmp/test -c -l false ./documents/test.pdf
+
   LONGDESC
   method_option :destination, :aliases => '-d', :required => false, :type => :string, :desc => 'Defines the output directory'
   method_option :copy, :aliases => '-c', :required => false, :type => :boolean, :desc => 'Copy files instead of moving them'
@@ -534,6 +552,15 @@ class DOC < Thor
   # Simulate renaming example.pdf according to the metatags (dry-run)
   \x5> CLI rename -n example.pdf
 
+  == Hiera
+
+  There are Hiera settings available, that cannot be addressed by a commandline parameter.
+
+  defaultdoctype: Defines the appreviation for the default document type. This one isused when no other document type could be determined from the metadata-field 'title'. Default value is 'doc'.
+
+  For details on how to set the parameter, see 'pdfmd explain hiera'.
+
+
   == Rules
 
   There are some rules regarding how documents are being renamed
@@ -542,34 +569,40 @@ class DOC < Thor
 
   <yyyymmdd>-<author>-<type>-<additionalInformation>.<extension>
 
-  \x5 # <yyyymmdd>: Year, month and day identival to the meta information in the
-  document.
+  \x5 # <yyyymmdd>: Year, month and day identical to the meta information in the document.
   \x5 # <author>: Author of the document, identical to the meta information
   in the document. Special characters and whitespaces are replaced.
   \x5 # <type>: Document type, is being generated from the title field in the metadata of the document. Document type is a three character abbreviation following the following logic:
 
-  \x5 til => Tilbudt|Angebot
-  \x5 odb => Orderbekreftelse
-  \x5 fak => Faktura
-  \x5 ord => Order
-  \x5 avt => Kontrakt|Avtale|Vertrag|contract
-  \x5 kvi => Kvittering
+  \x5 con => Contract
+  \x5 inv => Invoice
+  \x5 inf => Information
   \x5 man => Manual
-  \x5 bil => Billett|Ticket
-  \x5 inf => Informasjon|Information
-  \x5 dok => unknown
+  \x5 off => Offer
+  \x5 ord => Order
+  \x5 rpt => Receipt
+  \x5 tic => Ticket
 
   If the dokument type can not be determined automatically, it defaults to 'dok'.
 
+  This default behavior got introduced with version 1.8.1 and can be overwritten by hiera.
+  See `pdfmd explain hiera-keys` for information on how to do this.
+
   # <additionalInformation>: Information generated from the metadata fields
   'title', 'subject' and 'keywords'. 
 
-  If 'Title' or 'Keywords' contains one of the following keywords, the will be replaced with the corresponding abbreviation followed by the specified value separated by a whitespace:
+  If 'Title' or 'Keywords' contains one of the following keywords, they will be replaced with the corresponding abbreviation followed by the specified value:
+
+  \x5 Contract    => con
+  \x5 Invoice     => inv
+  \x5 Information => inf
+  \x5 Manual      => man
+  \x5 Offer       => off 
+  \x5 Order       => ord
+  \x5 Receipt     => rpt
+  \x5 Ticket      => tic
 
-  \x5 fak => Faktura|Fakturanummer|Rechnung|Rechnungsnummer
-  \x5 kdn => Kunde|Kundenummer|Kunde|Kundennummer
-  \x5 ord => Ordre|Ordrenummer|Bestellung|Bestellungsnummer
-  \x5 kvi => Kvittering|Kvitteringsnummer|Quittung|Quittungsnummer
+  This setting will be overwritten as well by defining the 'keys' hash in Hiera.
 
   Rule 2: The number of keywords used in the filename is defined by the parameter '-k'. See the section of that parameter for more details and the default value.
 
@@ -625,7 +658,7 @@ class DOC < Thor
     ENV['PDFMD_LOG']            = options[:log].to_s
     ENV['PDFMD_LOGFILE']        = options[:logfile].to_s
     ENV['PDFMD']                = __FILE__
-    require_relative('./pdfmd/rename.rb')
+    require_relative('pdfmd/rename.rb')
 
   end
 

data/lib/pdfmd/config.rb

@@ -5,7 +5,8 @@
 #
 
 # Options
-opt_show = ENV.fetch('PDFMD_SHOW')
+opt_show    = ENV.fetch('PDFMD_SHOW')
+opt_command = ENV.fetch('PDFMD_COMMAND').downcase
 
 require_relative '../string_extend.rb'
 require 'yaml'
@@ -23,15 +24,36 @@ case opt_show
 when true
 
   # As long as only Hiera is supported as external storage
-  # for configuration (unless I need otherwise), read the
+  # for configuration (unless I need it otherwise), read the
   # hiera configuration
   puts 'Current default configuration:'
   puts ''
   hieraConfig = eval `hiera pdfmd::config`
-  hieraConfig.sort.each do |key,value|
-    puts 'Command: ' + key
-    puts value.to_yaml
+
+  # 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

@@ -19,18 +19,20 @@ if opt_rename == 'true'
   opt_rename = true
 elsif opt_rename == 'false'
   opt_rename = false
-elsif (not hieraDefaults['edit'].nil? and
-       not hieraDefaults['edit']['rename'].nil? and
-       hieraDefaults['edit']['rename'] == true)
+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['edit'].nil? or
-     hieraDefaults['edit']['log'].nil? or
-     not hieraDefaults['edit']['log'] == true ) and
+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

data/lib/pdfmd/explain.hiera-keys.md

@@ -0,0 +1,36 @@
+Keys in Hiera can be defined in order to overwrite the default renaming behaviour.
+
+The default support is since version 1.8.1 only for the english language and will replace words in the meta-tag field 'keywords' with abbreviations.
+
+The following default abbreviations will be used:
+
+* 'off': 'Offer', 'Offernumber'
+* 'inv': 'Invoice', 'Invoicenumber'
+* 'con': 'Contract'
+* 'ord': 'Order', 'Ordernumber'
+* 'rec': 'Receipt', 'Receiptnumber'
+* 'man': 'Manual'
+
+# Example
+
+Using the string 'Offernumber 1111' will result in the string 'off1111' in the filename, unless the number of keywords is higher than the maximum number of keywords to use.  
+The matching is case-insensitive. 'offernumber 1111' and 'Offernumber 1111' will result in the same replacement.
+
+In order to overwrite the default you need to configure hiera and define a hash 'keys' with the abbreviation as sub-key and the string to replace as value. The value can either be defined as string or as array.
+
+The following example mirrors the default replacement in the Hiera configuration:
+
+``` YAML
+pdfmd::config:
+  rename:
+    keys:
+      'off': ['Offer', 'Offernumber']
+      inv  : ['Invoice', 'Invoicenumber']
+      con  : Contract
+      ord  : ['Order', 'Ordernumber']
+      rec  : ['Receipt', 'Receiptnumber']
+      man  : Manual
+```
+
+Warning: Keys like 'off' need to be set in apostrophe, otherwise the key will be interpreted as 'false' instead.
+

data/lib/pdfmd/explain.hiera.md

@@ -6,7 +6,8 @@ Installation:
 $ gem install hiera
 ```
 
-Configure default settings in hiera:
+Configure default settings for pdfmd in hiera:
+
 
   YAML
   ---
@@ -14,16 +15,18 @@ Configure default settings in hiera:
     default:
       password    : secretpassword
     sort:
-      destination : /data/output
       copy        : true
+      destination : /data/output
+      interactive : true
       log         : true
       logfile     : /var/log/pdfmd.log
-      interactive : true
     rename:
       allkeywords : true
+      copy        : true
+      defaultdoctype: doc
       keywords    : 4
       outputdir   : /data/output/sorted
-      copy        : true
     edit:
      rename       : true
 
+

data/lib/pdfmd/explain.rb

@@ -8,6 +8,7 @@ when ''
   puts '- csv'
   puts '- createdate'
   puts '- hiera'
+  puts '- hiera-keys'
   puts '- keywords'
   puts '- subject'
   puts '- title'

data/lib/pdfmd/methods.rb

@@ -15,11 +15,21 @@ def queryHiera(keyword,facts = 'UNSET')
 
   # If hiera isn't found, return false
   # otherwise return the hash
-  if !system('which hiera > /dev/null 2>&1')
+  if !system('which hiera > /dev/null 2>&1') 
     puts 'Cannot find "hiera" command in $path.'
-    return false
+    return eval('{}')
+  # elsif system('which hiera > /dev/null 2>&1') and
+  #   !File.exists?('/etc/hiera.yaml')
+  #   puts 'here too'
+  #   return eval('{}')
   else
-    return eval(`hiera #{keyword} #{facts}`)
+    commandreturn = ''
+    commandreturn = `hiera #{keyword} #{facts} 2>/dev/null`
+    if $?.exitstatus == 1
+      return eval('{}')
+    else
+      return eval(commandreturn)
+    end
   end
 
 end
@@ -34,7 +44,8 @@ end
 # replaced with underscores
 #
 def setKeywordsPreface(metadata, doktype)
-  if metadata['subject'].match(/^\d+[^+s]+.*/)
+  if metadata['subject'].match(/^\d+[^+s]+.*/) and
+    doktype != 'dok'
     return doktype + metadata['subject']
   else
     subject = metadata['subject']

data/lib/pdfmd/rename.rb

@@ -1,8 +1,6 @@
 #
 # Thor command 'rename'
 #
-# TODO: Make keywords abbreviations configurable from Hiera
-#
 require_relative '../string_extend'
 
 filename            = ENV.fetch('PDFMD_FILENAME')
@@ -15,24 +13,28 @@ opt_log             = ENV.fetch('PDFMD_LOG')
 opt_logfile         = ENV.fetch('PDFMD_LOGFILE')
 hieraDefaults       = queryHiera('pdfmd::config')
 
-if (opt_log.blank? and not hieraDefaults['rename'].nil? and not hieraDefaults['rename']['log'].nil? and hieraDefaults['rename']['log'] == true) or
-  opt_log == 'false' or
-  opt_log.blank? 
-
+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['rename']['logfilepath'].nil? or
-     hieraDefaults['rename']['logfilepath'].blank? or
-     hieraDefaults['rename'].nil? )
+    (
+     !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'
 
@@ -46,9 +48,12 @@ if logenable
     logfile = opt_logfile
 
   elsif opt_logfile.blank? and
-    not hieraDefaults['rename']['logfilepath'].blank?
+    !hieraDefaults.nil? and
+    !hieraDefaults['rename'].nil? and
+    !hieraDefaults['rename']['logfile'].nil? and
+    not hieraDefaults['rename']['logfile'].blank?
 
-    logfile = hieraDefaults['rename']['logfilepath']
+    logfile = hieraDefaults['rename']['logfile']
 
   else
 
@@ -77,7 +82,8 @@ end
 if opt_allkeywords == 'true'
   opt_allkeywords = true
 elsif opt_allkeywords.blank? and 
-  not hieraDefaults['rename'].nil? and
+  !hieraDefaults.nil? and
+  !hieraDefaults['rename'].nil? and
   not hieraDefaults['rename']['allkeywords'].nil?
 
   opt_allkeywords = hieraDefaults['rename']['allkeywords']
@@ -93,8 +99,9 @@ end
 # Determine the number of keywords
 # Default value is 3
 if opt_numberKeywords.blank? and
-  not hieraDefaults['rename'].nil? and
-  not hieraDefaults['rename']['keywords'].nil?
+  !hieraDefaults.nil? and
+  !hieraDefaults['rename'].nil? and
+  !hieraDefaults['rename']['keywords'].nil?
 
   opt_numberKeywords = hieraDefaults['rename']['keywords']
 
@@ -112,8 +119,9 @@ end
 #
 # Determine the status of the copy parameter
 if opt_copy.blank? and
-  not hieraDefaults['rename'].nil? and
-  not hieraDefaults['rename']['copy'].nil?
+  !hieraDefaults.nil? and
+  !hieraDefaults['rename'].nil? and
+  !hieraDefaults['rename']['copy'].nil?
 
   opt_copy = hieraDefaults['rename']['copy']
 
@@ -127,6 +135,29 @@ else
 
 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(/\_\_/,'_')
@@ -135,129 +166,99 @@ author = I18n.transliterate(author) # Normalising
 
 keywords_preface = ''
 # Determine the document type from the title.
-# Languages: DE|NO|EN
-case metadata['title']
-when /Tilbudt/i
-  doktype = 'til'
-when /Offer/i
-  doktype = 'off'
-when /Angebot/i
-  doktype = 'ang'
-when /Orderbekreftelse/i
-  doktype = 'odb'
-when /faktura/i
-  doktype = 'fak'
-when /invoice/i
-  doktype = 'inv'
-when /rechnung/i
-  doktype = 'rec'
-when /order/i
-  doktype = 'ord'
-when /bestilling/i
-  doktype = 'bes'
-when /(kontrakt|avtale)/i
-  doktype = 'avt'
-when /vertrag/i
-  doktype = 'ver'
-when /contract/i
-  doktype = 'con'
-when /kvittering/i
-  doktype = 'kvi'
-when /manual/i
-  doktype = 'man'
-when /billett/i
-  doktype = 'bil'
-when /ticket/i
-  doktype = 'tik'
-when /(informasjon|information)/i
-  doktype = 'inf'
+
+# 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 = 'dok'
+  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_preface == '' ? keywords = '' : keywords = keywords_preface
+  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
-  # I need to make this one better and make it configurable from
-  #   Hiera. But not right now.
-  #
+  #   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
-    
-    # Invoices
-    value = value.gsub(/Faktura(nummer)? /i,'fak')
-    value = value.gsub(/Rechnung(snummer)? /i, 'rec')
-    value = value.gsub(/Invoice(number)? /i, 'inv')
-
-    # Customernumbers
-    value = value.gsub(/Kunde(n)?(nummer)? /i,'kdn')
-    value = value.gsub(/Customer(number)? /i, 'cno')
-
-    # Ordernumbers
-    value = value.gsub(/Bestellung(s?nummer)? /i,'bes')
-    value = value.gsub(/(Ordre)(nummer)? /i,'ord')
-    value = value.gsub(/Bestilling(snummer)? /i,'bst')
-
-    # Receiptnumbers
-    value = value.gsub(/(Kvittering)(snummer)? /i,'kvi')
-    value = value.gsub(/Quittung(snummer)? /i,'qui')
-    value = value.gsub(/Receipt(number)? /i, 'rpt')
 
+   # 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 value.match(/^(fak|rec|inv|cno|kdn|bes|ord|bst|kvi|qui|rpt)/)
+
+    # 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
 
-  counter = 0
-  keywordssorted.each_with_index do |value,index|
+  # Insert the document preface in the beginning when it's available
+  if not keywords_preface.empty?
+    keywordssorted.insert(0, keywords_preface) 
+  end
 
-    # Exit condition limits the number of keywords used in the filename
-    # unless all keywords shall be added
-    if not opt_allkeywords
-      counter >= opt_numberKeywords-1 ? break : counter = counter + 1
-    end
-    if value.match(/^(fak|rec|inv|cno|kdn|bes|ord|bst|kvi|qui|rpt)/)
-      keywords == '' ? keywords = '-' + value : keywords = value + '-' + keywords
-    else
-      keywords == '' ? keywords = '-' + value : keywords.concat('-' + value)
-    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)
 
-  # There are no keywords
-  # Rare, but it happens
 else
 
   # There are no keywords.
   # we are using the title and the subject
-  if keywords_preface != '' 
-    keywords = keywords_preface
-  end
+  keywords_preface != '' ? keywords = keywords_preface : ''
 
 end
+
 extension   = 'pdf'
 if keywords != nil and keywords[0] != '-'
   keywords = '-' + keywords
 end
-keywords == nil ? keywords = '' : ''
 newFilename = date + '-' +
   author + '-' +
   doktype +
@@ -275,7 +276,7 @@ if outputdir
 else
 
   # Try to get the outputdir from hiera
-  outputdir = (not hieraDefaults['rename'].nil? and not hieraDefaults['rename']['outputdir'].nil?) ? hieraDefaults['rename']['outputdir'] : File.dirname(filename)
+  outputdir = (!hieraDefaults.nil? and !hieraDefaults['rename'].nil? and !hieraDefaults['rename']['outputdir'].nil?) ? hieraDefaults['rename']['outputdir'] : File.dirname(filename)
 
 end
 

data/lib/pdfmd/show.rb

@@ -29,6 +29,7 @@ end
 
 # Determine format from Hiera if possible
 if opt_format.nil? and
+  !hieraDefaults.nil? and
   not hieraDefaults['show'].nil? and
   not hieraDefaults['show']['format'].nil? and
   hieraDefaults['show']['format'] != ''
@@ -40,8 +41,9 @@ end
 
 # Determine tags from Hiera if possible
 if optTag.nil? and
-  not hieraDefaults['show'].nil? and
-  not hieraDefaults['show']['tag'].nil? and
+  !hieraDefaults.nil? and
+  !hieraDefaults['show'].nil? and
+  !hieraDefaults['show']['tag'].nil? and
   hieraDefaults['show']['tag'] != ''
 
   optTag = hieraDefaults['show']['tag']

data/lib/pdfmd/sort.rb

@@ -3,6 +3,8 @@
 #
 # Actions for the sort command
 #
+# TODO: Put in file overwrite parameter
+#
 inputDir = ENV.fetch('PDFMD_INPUTDIR')
 
 require_relative('./methods.rb')
@@ -20,14 +22,22 @@ hieraDefaults   = queryHiera('pdfmd::config')
 # Determin the setting for the copy/move action when sorting
 # Use HieraDefaults if nothing has been set.
 copyAction  = opt_copy
-if copyAction.blank? and hieraDefaults['sort']['copy'] == true
+if copyAction.blank? and 
+  !hieraDefaults.nil? and
+  !hieraDefaults['sort'].nil? and
+  !hieraDefaults['sort']['copy'].nil? and
+  hieraDefaults['sort']['copy'] == true
   copyAction = true
 elsif copyAction.blank? or copyAction == 'false'
   copyAction = false
 end
 
 # Determine the setting for interaction
-if opt_interactive.blank? and hieraDefaults['sort']['interactive'] == true
+if opt_interactive.blank? and 
+  !hieraDefaults.nil? and
+  !hieraDefaults['sort'].nil? and
+  !hieraDefaults['sort']['interactive'].nil? and
+  hieraDefaults['sort']['interactive'] == true
   puts 'Setting interactive from hiera'
   interactiveAction = true
 elsif opt_interactive == 'true'
@@ -41,7 +51,9 @@ destination = opt_destination
 if destination.nil? or destination == ''
 
   hieraHash = queryHiera('pdfmd::config')
-  if !hieraHash['sort']['destination'].nil?
+  if !hieraHash.nil? and
+    !hieraHash['sort'].nil? and
+    !hieraHash['sort']['destination'].nil?
     destination = hieraHash['sort']['destination']
   else
     puts 'No information about destination found.'
@@ -52,7 +64,11 @@ if destination.nil? or destination == ''
 end
 
 # Determine the state of the logging
-if (opt_log.blank? and hieraDefaults['sort']['log'] == true) or
+if (opt_log.blank? and
+    !hieraDefaults.nil? and
+    !hieraDefaults['sort'].nil? and
+    !hieraDefaults['sort']['log'].nil? and
+    hieraDefaults['sort']['log'] == true) or
   opt_log == 'true'
   logenable = true
 elsif opt_log.blank? or opt_log == 'false'
@@ -91,9 +107,12 @@ if logenable
   $logger = Logger.new(logfile)
 end
 
+# Create array of Files to iterate through
+pdfDocuments = File.directory?(inputDir) ? Dir[inputDir.chomp('/') + '/*.pdf'].sort : inputDir.split
+
+
 # Input validation
-!File.exist?(inputDir) ? abort('Input directory does not exist. Abort.'): ''
-File.directory?(inputDir) ? '' : abort('Input is a single file. Not implemented yet. Abort.')
+!File.exist?(inputDir) ? abort('Input does not exist. Abort.'): ''
 File.file?(destination) ? abort("Output '#{destination}' is an existing file. Cannot create directory with the same name. Abort") : ''
 
 if not File.directory?(destination)
@@ -109,7 +128,7 @@ if not File.directory?(destination)
 end
 
 # Iterate through all files
-Dir[inputDir.chomp('/') +  '/*.pdf'].sort.each do |file|
+pdfDocuments.each do |file|
 
   if interactiveAction
     answer = readUserInput("Process '#{file}' ([y]/n): ")
@@ -142,6 +161,8 @@ Dir[inputDir.chomp('/') +  '/*.pdf'].sort.each do |file|
 
     filedestination = destination.chomp('/') + '/' + author + '/' + Pathname.new(file).basename.to_s
 
+    puts filedestination
+
 
     # Final check before touching the filesystem
     if not File.exist?(filedestination)

data/test/test_rename.rb

@@ -5,9 +5,10 @@ commandparameter = " rename -o #{TMPDIR} -c false "
 `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
 files = readFilesInDir(TMPDIR)
 if files.size == 1 and
-  File.basename(files.keys[0]) == '19700101-example_author-dok-cno1111111-kdn1111111-test_subject.pdf'
+  File.basename(files.keys[0]) == '19700101-example_author-doc-test_subject-cno1111111-some_keywords.pdf'
   result = 'OK'
 else
+  puts File.basename(files.keys[0])
   result = 'failed'
 end
 $testResults = { '001' => {:result => result, :command => commandparameter }}
@@ -20,10 +21,11 @@ commandparameter = " rename -c -o #{TMPDIR}"
 `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
 files = readFilesInDir(TMPDIR)
 if files.size == 2 and
-  File.basename(files.keys[0]) == '19700101-example_author-dok-cno1111111-kdn1111111-test_subject.pdf' and
+  File.basename(files.keys[0]) == '19700101-example_author-doc-test_subject-cno1111111-some_keywords.pdf'
   File.basename(files.keys[1]) == 'test_default.pdf'
   result = 'OK'
 else
+  puts File.basename(files.keys[0])
   result = 'failed'
 end
 $testResults.store('002', {:result => result, :command => commandparameter })
@@ -49,9 +51,10 @@ commandparameter = " rename -a -o #{TMPDIR} -c false"
 `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
 files = readFilesInDir(TMPDIR)
 if files.size == 1 and
-  File.basename(files.keys[0]) == '19700101-example_author-dok-cno1111111-kdn1111111-test_subject-some_keywords-author-some_feature.pdf'
+  File.basename(files.keys[0]) == '19700101-example_author-doc-test_subject-cno1111111-some_keywords-author-some_feature-kundenummer_1111111.pdf'
   result = 'OK'
 else
+  puts File.basename(files.keys[0])
   result = 'failed'
 end
 $testResults.store('004', {:result => result, :command => commandparameter })
@@ -64,9 +67,10 @@ commandparameter = " rename -k 1 -o #{TMPDIR} -c false"
 `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
 files = readFilesInDir(TMPDIR)
 if files.size == 1 and
-  File.basename(files.keys[0]) == '19700101-example_author-dok-test_subject.pdf'
+  File.basename(files.keys[0]) == '19700101-example_author-doc-test_subject.pdf'
   result = 'OK'
 else
+  puts File.basename(files.keys[0])
   result = 'failed'
 end
 $testResults.store('005', {:result => result, :command => commandparameter })
@@ -78,10 +82,11 @@ commandparameter = " rename -l -p #{TMPDIR}/pdfmd.log -c false"
 `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
 files = readFilesInDir(TMPDIR)
 if files.size == 1 and
-  File.basename(files.keys[0]) == '19700101-example_author-dok-cno1111111-kdn1111111-test_subject.pdf' and
+  File.basename(files.keys[0]) == '19700101-example_author-doc-test_subject-cno1111111-some_keywords.pdf' and
   `tail -n 1 #{TMPDIR}/pdfmd.log | wc -l`.to_i == 1
   result = 'OK'
 else
+  puts File.basename(files.keys[0])
   result = 'failed'
 end
 $testResults.store('006', {:result => result, :command => commandparameter })

data/test/test_show.rb

@@ -1,3 +1,9 @@
+def show_content(actualContent,expectedContent)
+  puts "Expteced: \n #{expectedContent}"
+  puts '---'
+  puts "Got     : \n #{showContent}"
+end
+
 # Standard Show
 # Test 001
 initTmpDir
@@ -13,6 +19,7 @@ if showContent == expectedContent
   result = 'OK'
 else
   result = 'failed'
+  show_content(showContent,expectedContent)
 end
 $testResults = { '001' => {:result => result, :command => commandparameter }}
 
@@ -26,6 +33,7 @@ if showContent == expectedContent
   result = 'OK'
 else
   result = 'failed'
+  show_content(showContent,expectedContent)
 end
 $testResults.store('002', {:result => result, :command => commandparameter })
 
@@ -40,6 +48,7 @@ if showContent == expectedContent
   result = 'OK'
 else
   result = 'failed'
+  show_content(showContent,expectedContent)
 end
 $testResults.store('003', {:result => result, :command => commandparameter })
 
@@ -55,6 +64,7 @@ if showContent == expectedContent
   result = 'OK'
 else
   result = 'failed'
+  show_content(showContent,expectedContent)
 end
 $testResults.store('004', {:result => result, :command => commandparameter })
 
@@ -68,6 +78,7 @@ if showContent == expectedContent
   result = 'OK'
 else
   result = 'failed'
+  show_content(showContent,expectedContent)
 end
 $testResults.store('005', {:result => result, :command => commandparameter })
 
@@ -81,6 +92,7 @@ if showContent == expectedContent
   result = 'OK'
 else
   result = 'failed'
+  show_content(showContent,expectedContent)
 end
 $testResults.store('006', {:result => result, :command => commandparameter })
 
@@ -94,6 +106,7 @@ if showContent == expectedContent
   result = 'OK'
 else
   result = 'failed'
+  show_content(showContent,expectedContent)
 end
 $testResults.store('007', {:result => result, :command => commandparameter })
 

data/test/test_sort.rb

@@ -2,16 +2,7 @@
 #
 # Test 001
 # Testing Abort when running on a single file
-initTmpDir
-commandparameter = " sort -d #{TMPDIR}/target "
-`#{PDFMD} #{commandparameter} #{TARGETPDF} 2>/dev/null`
-if $?.to_s.match(/.*exit 1/)
-  result = 'OK'
-else
-  result = 'failed'
-end
-$testResults = { '001' => {:result => result, :command => commandparameter }}
-
+# Disabled since single file support in version 1.9.0
 
 # Test 002
 # Testing Sorting on a dir

metadata

@@ -1,106 +1,106 @@
 --- !ruby/object:Gem::Specification
 name: pdfmd
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Daniel Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: fileutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.11
-description: ! "    Managing the common pdf metadata values and renaming the pdf file
-  accordingly.\n    Sets common tags like 'author', 'createdate', 'title', 'subject'
-  and 'keywords'\n    and re-uses them for renaming the file with to a human-readable
-  identifier.\n"
+description: |2
+      Managing the common pdf metadata values and renaming the pdf file accordingly.
+      Sets common tags like 'author', 'createdate', 'title', 'subject' and 'keywords'
+      and re-uses them for renaming the file with to a human-readable identifier.
 email: pdfmd@micronarrativ.org
 executables:
 - pdfmd
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -113,6 +113,7 @@ files:
 - lib/pdfmd/explain.author.md
 - lib/pdfmd/explain.createdate.md
 - lib/pdfmd/explain.csv.md
+- lib/pdfmd/explain.hiera-keys.md
 - lib/pdfmd/explain.hiera.md
 - lib/pdfmd/explain.keywords.md
 - lib/pdfmd/explain.password.md
@@ -139,16 +140,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- ! '[exiftools](http://www.sno.phy.queensu.ca/~phil/exiftool/)'
+- "[exiftools](http://www.sno.phy.queensu.ca/~phil/exiftool/)"
 rubyforge_project: 
 rubygems_version: 2.4.6
 signing_key: