pdfmd 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 553f3eff11cc2292beaccc52470f9cc22f7a2a6c
-  data.tar.gz: fc0a114519fc15e859c3f5eaa1321fa198f0afdf
+  metadata.gz: 71b69c4e8462e3e8e9b8fe27df5fc9b6a472292b
+  data.tar.gz: 55cb0726b99937d3cbaad55bb803d8c652315f4c
 SHA512:
-  metadata.gz: 76d44d0d86b428268f2fb1c9f46d0423715fa31b8caa47aa1db2a26665f8b641aae468c06251efe05cdb5499643e2cef210b89157c95fac3d9ea8b5ab44eb12d
-  data.tar.gz: 344df1960429d50f417495fe51a7831056d2bdc11307e045bc988889ebe72d0cb200fae0ed0a7f86cad987f477d99ac4d908ac876e3fbaf33334877405c53e93
+  metadata.gz: 01a4b983e7eaaade73851e51d8193ad5e3c6911db00f87852b816c0848b2d0042c3acc651419e1d77226129582691d544fef85cce4395eb665fa51274eee7d64
+  data.tar.gz: 87b8640a0b5c3a1286a5fcd214afdc01c2c1f72a07a996da93a50603caa13a20699e6d907dcd18c03344266d686e7dc934114b93289e2e200da006b8506d5e4a

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# Version 1.5.0
+- Added option 'dryrun' to command 'sort'.
+- Added option 'logfilepath' to command 'sort'
+- Added more Hiera support to command 'sort'.
+- Added logfilepath to command 'sort'.
+- Added logentry for the answer of the interaction with the command 'sort' (parameter -i).
+- Bugfix: logic for parameters was not working correctly.
+- Change: Default value for logging is not 'false'.
+- Bugfix: Entry in Logfile shows now if the file is moved or copied.
+- Bugfix: Error message when logging and the logfile did not exist yet. File is now created correctly when necessary.
+- Added Hiera support to command 'rename'.
+- Command 'rename': Changed hiera parameter 'destination' to 'outputdir'.
+- Added Tests for 'sort','rename' and 'show'
+
 # Version 1.4.3
 - Bugfix: Commata in author field showed up in the filename after renaming.
 

data/README.md

@@ -60,24 +60,27 @@ So in order to get more information just run the required _help_ command:
 
 ```
 # Show general possibilities:
-$ pdfmd.rb 
+$ pdfmd 
 
 # Show more information about <action>
-$ pdfmd.rb help <action>
+$ pdfmd help <action>
 ```
 
 My usual workflow is like this:
 
 ``` 
-$ pdfmd.rb show test.pdf
-$ pdfmd.rb edit -t all test.pdf
+$ pdfmd show test.pdf
+$ pdfmd edit -t all test.pdf
   ...
-$ pdfmd.rb rename test.pdf
+$ pdfmd rename test.pdf
 $ mv 20150101-me-dok-testdocument.pdf /my/pdf/directory
+  ...
+$ pdfmd sort .
 ``` 
 
 There's an underlogic in the renaming and sorting of the files according to the metadata. Make sure you read at least the help-information before you use it.
 
+It's also usefull to define some default settings in Hiera to avoid unnecessary typing.
 
 __HINT__: Before you start using the script, make sure you have a backup of your files or you know what you're doing. If you loose information/files I will not be able to help you.
 
@@ -90,8 +93,15 @@ pdfmd::config:
   sort:
     destination : /data/tmp
     copy        : true
-    logfile     : /var/log/pdfmd.log
+    log         : true
+    logfilepath : /var/log/pdfmd.log # Needs create/write rights on this file
     interactive : false
+  rename:
+    #allkeywords : true # Does not make sense in combination with _keywords_
+    keywords    : 2
+    outputdir   : /data/output/sorted
+    copy        : true
+
 ```
 
 Information about which hiera configuration settings are available can be either found in `pdfmd help <command>` or `pdfmd explain hiera`.

data/Rakefile

@@ -0,0 +1,141 @@
+require 'rake'
+require 'tmpdir'
+require 'fileutils'
+
+TMPDIR      = Dir.mktmpdir
+EXAMPLEPDF  = './test/test_default.pdf'
+TARGETPDF   = TMPDIR + '/' + File.basename(EXAMPLEPDF)
+PDFMD       = './lib/pdfmd.rb'
+$testResults = Hash.new
+
+desc 'test pdfmd'
+task :test do
+  sections = ARGV.last
+  #puts ARGV.last
+  #puts sections
+  task sections.to_sym do ; end
+
+  case sections
+  when 'rename'
+    rename
+  when 'show'
+    show
+  when 'sort'
+    sort
+  else
+    show
+    rename
+    sort
+  end
+
+end
+
+#
+# init Tmpdir
+# Reset the temporary directory into a known state
+# 1. Delete the tmp dir
+# 2. Create the tmp dir
+# 3. copy the default file back into it
+def initTmpDir
+  FileUtils.rm_rf TMPDIR
+  FileUtils.mkdir TMPDIR
+  FileUtils.cp(EXAMPLEPDF, TMPDIR + '/')
+end
+
+#
+# Testing command 'sort'
+#
+def sort
+
+  puts "Testing command 'sort'"
+  require_relative './test/test_sort.rb'
+  
+  # Cleanup after Tests
+  FileUtils.rm_rf TMPDIR
+  showTestResults
+
+end
+
+
+#
+# Testing command 'show'
+#
+def show
+
+  puts "Testing command 'show'"
+  require_relative './test/test_show.rb'
+  # Cleanup after Tests
+  FileUtils.rm_rf TMPDIR
+  showTestResults
+
+end
+
+# Testing command 'rename'
+#
+def rename
+
+  puts "Testing command 'rename'"
+  require_relative './test/test_rename.rb'
+
+  # Cleanup after Tests
+  FileUtils.rm_rf TMPDIR
+  showTestResults
+
+end # End of Task test rename
+
+################################################################################
+# Helper methods
+################################################################################
+
+#
+# Show the test results
+def showTestResults
+
+  $testResults.sort.each do |key,value|
+    if value[:result] == 'OK'
+      puts 'Test ' + key + ' : ' + value[:result].to_s
+    else
+      puts 'Test ' + key + ' : ' + value[:result].to_s
+      puts '  Command: ' + value[:command].to_s
+      exit 1
+    end
+  end
+end
+
+# 
+# Read the PDF files in the TMPDIR
+def readFilesInDir(targetdir)
+  filedata = Hash.new
+  files= Dir.glob(targetdir + "/*.pdf")
+  files.sort.each do |filename|
+    filedata[filename] = readExifData(filename)
+  end
+  return filedata
+end
+
+#
+# Read the Exifdata of a given file
+def readExifData(filepath)
+
+  exifdata = Hash.new
+
+  exifdatatext = `exiftool #{filepath}`
+  exifdatatext.each_line do |line|
+    case line
+    when /^author.*/i
+      exifdata['author'] = line.split(' : ').last.chomp
+    when /^title.*/i
+      exifdata['title'] = line.split(' : ').last.chomp
+    when /^subject.*/i
+      exifdata['subject'] = line.split(' : ').last.chomp
+    when /^keywords.*/i
+      exifdata['keywords'] = line.split(' : ').last.chomp
+    when /^Create\ Date.*/i
+      exifdata['createdate'] = line.split(' : ').last.chomp
+    end
+  end
+  return exifdata
+end
+
+
+

data/lib/pdfmd/explain.hiera.md

@@ -12,7 +12,14 @@ Configure default settings in hiera:
   ---
   pdfmd::config:
     sort:
-      destination : /tmp/output
+      destination : /data/output
+      copy        : true
+      log         : true
+      logfilepath : /var/log/pdfmd.log
+      interactive : true
+    rename:
+      allkeywords : true
+      keywords    : 4
+      outputdir   : /data/output/sorted
       copy        : true
-      logfile     : /var/log/pdfmd.log
 

data/lib/pdfmd/rename.rb

@@ -1,16 +1,18 @@
 #
 # Thor command 'rename'
 #
-# TODO: Define outputdir from Hiera
-# TODO: Add option for copy when renaming
 # TODO: Add option to create outputdir if not existing
 # TODO: Define option to create outputdir via Hiera
 #
-filename        = ENV.fetch('PDFMD_FILENAME')
-allkeywords     = ENV.fetch('PDFMD_ALLKEYWORDS')
-outputdir       = ENV.fetch('PDFMD_OUTPUTDIR') == 'false' ? false : ENV.fetch('PDFMD_OUTPUTDIR')
-dryrun          = ENV.fetch('PDFMD_DRYRUN') == 'false' ? false : true
-numberKeywords  = ENV.fetch('PDFMD_NUMBERKEYWORDS').to_i
+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')
+hieraDefaults       = queryHiera('pdfmd::config')
 
 metadata = readMetadata(filename).each do |key,value|
 
@@ -23,6 +25,63 @@ metadata = readMetadata(filename).each do |key,value|
 
 end
 
+
+# Determine the status of allkeywords
+# Default value is false
+if opt_allkeywords == 'true'
+  opt_allkeywords = true
+elsif opt_allkeywords.blank? and 
+  not 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
+  not hieraDefaults['rename'].nil? and
+  not 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
+  not hieraDefaults['rename'].nil? and
+  not hieraDefaults['rename']['copy'].nil?
+
+  opt_copy = hieraDefaults['rename']['copy']
+
+elsif opt_copy == 'true'
+
+  opt_copy = true
+
+else
+
+  opt_copy = false
+
+end
+
+
 date   = metadata['createdate'].gsub(/\ \d{2}\:\d{2}\:\d{2}.*$/,'').gsub(/\:/,'')
 author = metadata['author'].gsub(/\./,'_').gsub(/\-/,'').gsub(/\s/,'_').gsub(/\,/,'_').gsub(/\_\_/,'_')
 I18n.enforce_available_locales = false
@@ -98,8 +157,8 @@ if not metadata['keywords'].empty?
 
     # Exit condition limits the number of keywords used in the filename
     # unless all keywords shall be added
-    if not allkeywords.empty?
-      counter > numberKeywords-1 ? break : counter = counter + 1
+    if not opt_allkeywords
+      counter >= opt_numberKeywords-1 ? break : counter = counter + 1
     end
     if value.match(/(kvi|fak|ord|kdn)/i)
       keywords == '' ? keywords = '-' + value : keywords = value + '-' + keywords
@@ -107,6 +166,7 @@ if not metadata['keywords'].empty?
       keywords == '' ? keywords = '-' + value : keywords.concat('-' + value)
     end
   end
+
   # Normalise the keywords as well
   #
   I18n.enforce_available_locales = false
@@ -136,17 +196,25 @@ newFilename = date + '-' +
 
 # Output directory checks
 if outputdir 
+
   if not File.exist?(outputdir)
     puts "Error: output dir '#{outputdir}' not found. Abort."
     exit 1
   end
+
 else
-  # Output to Inputdir
-  outputdir = File.dirname(filename)
+
+  # Try to get the outputdir from hiera
+  outputdir = (not hieraDefaults['rename'].nil? and not hieraDefaults['rename']['outputdir'].nil?) ? hieraDefaults['rename']['outputdir'] : File.dirname(filename)
+
 end
 
 if not dryrun and filename != newFilename.downcase
-  `mv -v '#{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
-  puts filename + "\n   => " + newFilename.downcase
+  puts filename + "\n   => " + outputdir + '/' + newFilename.downcase
 end

data/lib/pdfmd/sort.rb

@@ -1,25 +1,39 @@
+#
+# == File: sort.rb
+#
+# Actions for the sort command
+#
 inputDir = ENV.fetch('PDFMD_INPUTDIR')
 
 require_relative('./methods.rb')
+require_relative '../string_extend.rb'
 require 'fileutils'
 
 opt_destination = ENV.fetch('PDFMD_DESTINATION')
+opt_dryrun      = ENV.fetch('PDFMD_DRYRUN') == 'true' ? true : false
 opt_copy        = ENV.fetch('PDFMD_COPY')
 opt_log         = ENV.fetch('PDFMD_LOG')
+opt_logfilepath = ENV.fetch('PDFMD_LOGFILEPATH')
 opt_interactive = ENV.fetch('PDFMD_INTERACTIVE')
+hieraDefaults   = queryHiera('pdfmd::config')
 
-hieraDefaults = queryHiera('pdfmd::config')
-
-copyAction  = opt_copy.empty? ? false : true
-if opt_copy.nil? and hieraDefaults['sort']['copy'] == true
+# 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
   copyAction = true
-  puts 'Setting action to copy based on Hiera.'
+elsif copyAction.blank? or copyAction == 'false'
+  copyAction = false
 end
 
-interactiveAction = opt_interactive.empty? ? false : true
-if opt_interactive.empty? and hieraDefaults['sort']['interactive'] == true
+# Determine the setting for interaction
+if opt_interactive.blank? and hieraDefaults['sort']['interactive'] == true
+  puts 'Setting interactive from hiera'
+  interactiveAction = true
+elsif opt_interactive == 'true'
   interactiveAction = true
-  puts 'Setting interactive to true based on Hiera.'
+elsif opt_interactive.blank? or opt_interactive == 'false'
+  interactiveAction = false
 end
 
 # Fetch alternate destination from hiera if available
@@ -35,26 +49,55 @@ if destination.nil? or destination == ''
     puts 'Abort.'
     exit 1
   end
+end
 
+# Determine the state of the logging
+if (opt_log.blank? and hieraDefaults['sort']['log'] == true) or
+  opt_log == 'true'
+  logenable = true
+elsif opt_log.blank? or opt_log == 'false'
+  logenable = false
 end
 
-logenable = opt_log
-logfile   = !hieraDefaults['sort']['logfile'].nil? ? hieraDefaults['sort']['logfile'] : Dir.pwd.chomp('/') + '/' + Pathname.new(__FILE__).basename + '.log'
+if logenable
+
+  if opt_logfilepath.blank? and 
+    ( hieraDefaults['sort']['logfilepath'].nil? or
+     hieraDefaults['sort']['logfilepath'].blank? or
+     hieraDefaults['sort'].nil? )
+
+    logfile = Dir.pwd.chomp('/') + '/' + File.basename(ENV['PDFMD'], '.*') + '.log'
+
+  elsif not opt_logfilepath.blank?
+
+    if File.directory? opt_logfilepath
+      abort('Logfilepath is a directory. Abort.')
+      exit 1
+    end
+
+    logfile = opt_logfilepath
 
-# Check that logfilepath exists and is writeable
-if !File.writable?(logfile)
-  puts "Cannot write '#{logfile}. Abort."
-  exit 1
+  elsif opt_logfilepath.blank? and
+    not hieraDefaults['sort']['logfilepath'].blank? 
+
+    logfile = hieraDefaults['sort']['logfilepath']
+
+  else
+
+    logfile = Dir.pwd.chomp('/') + '/' + File.basename(ENV['PDFMD'], '.*') + '.log'
+
+  end
+
+  $logger = Logger.new(logfile)
 end
-logenable ? $logger = Logger.new(logfile) : ''
 
 # Input validation
 !File.exist?(inputDir) ? abort('Input directory does not exist. Abort.'): ''
-File.directory?(inputDir) ? '' : abort('Input is a single file')
+File.directory?(inputDir) ? '' : abort('Input is a single file. Not implemented yet. Abort.')
 File.file?(destination) ? abort("Output '#{destination}' is an existing file. Cannot create directory with the same name. Abort") : ''
 unless File.directory?(destination)
   FileUtils.mkdir_p(destination)
-  $logger.info("Destination '#{destination}' has been created.")
+  logenable ? $logger.info("Destination '#{destination}' has been created.") : ''
 end
 
 # Iterate through all files
@@ -63,6 +106,7 @@ Dir[inputDir.chomp('/') +  '/*.pdf'].sort.each do |file|
   if interactiveAction
     answer = readUserInput("Process '#{file}' ([y]/n): ")
     answer = answer.empty? ? 'y' : answer 
+    logenable ? $logger.info("Interactive answer for file '#{file}' : #{answer}") : ''
     answer.match(/y/) ? '' : next
   end
 
@@ -80,15 +124,17 @@ Dir[inputDir.chomp('/') +  '/*.pdf'].sort.each do |file|
 
     filedestination                 = destination.chomp('/') + '/' + author + '/' + Pathname.new(file).basename.to_s
 
+
     # Final check before touching the filesystem
     if not File.exist?(filedestination)
-      $logger.info("File '#{file}' => '#{filedestination}'")
 
       # Move/Copy the file
-      if copyAction
-        FileUtils.cp(file, filedestination)
+      if copyAction 
+        opt_dryrun ? '' : FileUtils.cp(file, filedestination)
+        logenable ? $logger.info("File copied '#{file}' => '#{filedestination}'") : ''
       else
-        FileUtils.mv(file,filedestination)
+        opt_dryrun ? '' : FileUtils.mv(file,filedestination)
+        logenable ? $logger.info("File moved '#{file}' => '#{filedestination}'") : ''
       end
 
     else
@@ -96,5 +142,6 @@ Dir[inputDir.chomp('/') +  '/*.pdf'].sort.each do |file|
     end
   else
     logenable ? $logger.warn("Missing tag 'Author' for file '#{file}'. Skipping.") : (puts "Missing tag 'Author' for file '#{file}'. Skipping")
+    next
   end
 end

data/lib/pdfmd.rb

@@ -41,9 +41,9 @@
 # TODO: Include password protected PDF documents as well
 # TODO: Fix broken PDF files automatically
 # TODO: Enable logging in more functions than only "sort"
+# TODO: command 'hiera' to show the current settings
 # TODO: Read this: http://lostechies.com/derickbailey/2011/04/29/writing-a-thor-application/
 # TODO: ... and this: http://blog.paracode.com/2012/05/17/building-your-tools-with-thor/
-# TODO: Create Gem: http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/
 # gs \
 #   -o repaired.pdf \
 #   -sDEVICE=pdfwrite \
@@ -62,7 +62,7 @@ require "i18n"
 require 'pathname'
 require 'logger'
 
-VERSION = '1.4.2'
+VERSION = '1.5.0'
 
 # Include general usage methods
 require_relative('pdfmd/methods.rb')
@@ -316,12 +316,18 @@ class DOC < Thor
 
   [*log|l*]
   \x5 Disable/Enable the logging.
-  \x5 Default: enabled.
+
+  Default: enabled.
+
+  [*logfilepath|p*]
+  \x5 Set an alternate path for the logfile. If not path is chosen, the logfile is being created in the current working directory as `pdfmd.log`.
 
   [*interactive|i*]
-  \x5 Disable/Enable interactive sorting. This will ask for confirmation for
-  \x5   each sorting action.
-  \x5 Default: disabled.
+  \x5 Disable/Enable interactive sorting. This will ask for confirmation for each sorting action.
+
+  Default: disabled.
+
+
 
   === Replacement rules
 
@@ -343,27 +349,28 @@ class DOC < Thor
   \x5sort:
   \x5  key: value
 
+  See the README file for an example how to define the values in Hiera.
+
   === Hiera defaults
 
-  The following values can be influenced by the hiera configuration in the
-    section 'sort'. Commandline parameter will overwrite the defaults coming
-    from hiera unless otherwise notet.
+  The following values can be influenced by the hiera configuration in the section 'sort'. Commandline parameter will overwrite the defaults coming from hiera unless otherwise notet.
 
   [*copy*]
   \x5  If set to true copies the files from the source directory instead of moving them.
 
   [*destination*]
-  \x5  Specifies the default output directory (root-directory). Either this or the
-    command line parameter for destinations must be set.
+  \x5  Specifies the default output directory (root-directory). Either this or the command line parameter for destinations must be set.
+
+  [*log*]
+  \x5 Enables (true) or disables (false) logging.
 
-  [*logfile*]
-  \x5  Specifies the default path for the logfile output. If this is not
-    specfied a logfile with the scriptname + '.log' will be created in the
-    current working directory.
+  [*logfilepath*]
+  \x5 Specifes the default path for the logfile. If no path is set and logging is enable, the logfile will be created in the current working directory.
+
+  Default is the current working directory with the filename `pdfmd.log`
 
   [*interactive*]
-  \x5  If set to true, each file must be acknowledged to be processed when
-    running the script.
+  \x5 If set to true, each file must be acknowledged to be processed when running the script.
 
   === Example
 
@@ -377,15 +384,20 @@ class DOC < Thor
   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'
-  method_option :log, :aliases => '-l', :required => false, :type => :boolean, :desc => 'Enable/Disable creation of log files', :default => true
-  method_option :interactive, :aliases => '-i', :required => false, :type => :boolean, :desc => 'Enable/Disable interactive sort'
+  method_option :log, :aliases => '-l', :required => false, :type => :boolean, :desc => 'Enable/Disable creation of log files'
+  method_option :logfilepath, :aliases => '-p', :required => false, :type => :string, :desc => 'Change the default logfilepath'
+  method_option :interactive, :aliases => '-i', :required => false, :type => :boolean, :desc => 'Enable/Disable interactive sorting'
+  method_option :dryrun, :aliases => '-n', :required => false, :type => :boolean, :desc => 'Run without changing something'
   def sort(inputDir)
 
     ENV['PDFMD_INPUTDIR']     = inputDir
     ENV['PDFMD_DESTINATION']  = options[:destination].to_s
     ENV['PDFMD_COPY']         = options[:copy].to_s
     ENV['PDFMD_LOG']          = options[:log].to_s
+    ENV['PDFMD_LOGFILEPATH']  = options[:logfilepath].to_s
     ENV['PDFMD_INTERACTIVE']  = options[:interactive].to_s
+    ENV['PDFMD_DRYRUN']       = options['dryrun'].to_s
+    ENV['PDFMD']              = __FILE__
     require_relative('./pdfmd/sort.rb')
 
   end
@@ -408,13 +420,31 @@ class DOC < Thor
   --all-keywords, -a
   \x5 Use all keywords from the meta information in the file name and ignore the limit.
 
+  Hiera parameter: allkeywords [true|false]
+
+  Default: false
+
   --keywwords, -k
   \x5 Set the number of keywords used in the filename to a new value.
-  \x5 Default: 3
+
+  Hiera parameter: keywords <integer>
+
+  Default: 3 
 
   --outputdir, -o
   \x5 Rename the file and move it to the directory defined in '--outputdir'.
 
+  Hiera parameter: outputdir </file/path/>
+
+  Default: current file directory
+
+  --copy, -c
+  \x5 Copy the file instead of moving it to the new name or destination.
+
+  Hiera parameter: copy [true|false]
+
+  Default: false
+
   The directory must exist at runtime.
 
   == Example
@@ -502,9 +532,10 @@ class DOC < Thor
 
   LONGDESC
   method_option :dryrun, :type => :boolean, :aliases => '-n', :desc => 'Run without making changes', :default => false, :required => false
-  method_option :allkeywords, :type => :boolean, :aliases => '-a', :desc => 'Add all keywords (no limit)', :default => false, :required => false
-  method_option :keywords, :type => :numeric, :aliases => '-k', :desc => 'Number of keywords to include (Default: 3)', :default => 3, :required => false
-  method_option :outputdir, :aliases => '-o', :type => :string, :desc => 'Speficy output directory', :default => :false, :required => :false
+  method_option :allkeywords, :type => :boolean, :aliases => '-a', :desc => 'Add all keywords (no limit)', :required => false
+  method_option :keywords, :type => :numeric, :aliases => '-k', :desc => 'Number of keywords to include (Default: 3)', :required => false
+  method_option :outputdir, :aliases => '-o', :type => :string, :desc => 'Speficy output directory', :default => false, :required => :false
+  method_option :copy, :aliases => '-c', :type => :boolean, :desc => 'Copy instead of moving the file when renaming'
   def rename(filename)
 
     ENV['PDFMD_FILENAME']       = filename
@@ -512,6 +543,7 @@ class DOC < Thor
     ENV['PDFMD_ALLKEYWORDS']    = options[:allkeywords].to_s
     ENV['PDFMD_OUTPUTDIR']      = options[:outputdir].to_s
     ENV['PDFMD_NUMBERKEYWORDS'] = options[:keywords].to_s
+    ENV['PDFMD_COPY']           = options[:copy].to_s
     require_relative('./pdfmd/rename.rb')
 
   end

data/lib/string_extend.rb

@@ -0,0 +1,25 @@
+#
+# Helper file with class extensions for string
+#
+class String
+
+  #
+  # Boolean function
+  #
+  #  'true|t|yes|y|1' == true
+  #  'false|f|no|n|0' == false
+  #  emtpy string is error
+  #
+  def to_bool
+    return true if self == true || self =~ (/\A(true|t|yes|y|1)\Z/i)
+    return false if self == false || self =~ (/\A(false|f|no|n|0)\Z/i)
+    raise ArgumentError.new("invalid value for Boolean: \"#{self}\"")
+  end
+
+  #
+  # method to check if a string is empty
+  #
+  def blank?
+    self.strip.empty?
+  end
+end 

data/pdfmd.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                  = 'pdfmd'
-  s.version               = '1.4.3'
+  s.version               = `grep -m 1 VERSION lib/pdfmd.rb | awk -F"'" '{ print $2 '}`
   s.date                  = Time.now.strftime("%Y-%m-%d").to_s
   s.summary               = "pdfmd - pdf-meta-data management"
   s.description           = <<-EOF
@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.executable            = 'pdfmd'
   s.homepage              = 'https://github.com/Micronarrativ/ruby-pmd'
   s.license               = 'MIT'
-  s.add_dependency "thor", '0.19.1'
-  s.add_dependency 'highline', '1.7.1'
-  s.add_dependency 'fileutils', '0.7'
-  s.add_dependency 'i18n', '0.6.11'
+  s.add_dependency "thor", '~>0.19', '>= 0.19.1'
+  s.add_dependency 'highline', '~>1.7', '>= 1.7.1'
+  s.add_dependency 'fileutils', '~>0.7','>= 0.7'
+  s.add_dependency 'i18n', '~>0.6', '>= 0.6.11'
 end

data/test/test_rename.rb

@@ -0,0 +1,72 @@
+# Standard renaming
+# Test 001
+initTmpDir
+commandparameter = " rename -o #{TMPDIR}"
+`#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+files = readFilesInDir(TMPDIR)
+if files.size == 1 and
+  File.basename(files.keys[0]) == '19700101-example_author-dok-some_keywords-kdn1111111-test_subject.pdf'
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults = { '001' => {:result => result, :command => commandparameter }}
+
+
+# Test 002
+# renaming with copy
+initTmpDir
+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-some_keywords-kdn1111111-test_subject.pdf' and
+  File.basename(files.keys[1]) == 'test_default.pdf'
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('002', {:result => result, :command => commandparameter })
+
+# Test 003
+# Testing Dryrun
+initTmpDir
+commandparameter = ' rename -n '
+`#{PDFMD} #{commandparameter} #{TARGETPDF} >>/dev/null`.chomp
+files = readFilesInDir(TMPDIR)
+if files.size == 1 and
+  File.basename(files.keys[0]) == 'test_default.pdf'
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('003', {:result => result, :command => commandparameter })
+
+# Test 004
+# Testing all keywords (-a)
+initTmpDir
+commandparameter = " rename -a -o #{TMPDIR}"
+`#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+files = readFilesInDir(TMPDIR)
+if files.size == 1 and
+  File.basename(files.keys[0]) == '19700101-example_author-dok-some_keywords-kdn1111111-test_subject-author-some_feature-customernumber_1111111.pdf'
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('004', {:result => result, :command => commandparameter })
+
+# Test 005
+# Testing number of keywords
+# this might be buggy
+initTmpDir
+commandparameter = " rename -k 1 -o #{TMPDIR}"
+`#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+files = readFilesInDir(TMPDIR)
+if files.size == 1 and
+  File.basename(files.keys[0]) == '19700101-example_author-dok-test_subject.pdf'
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('005', {:result => result, :command => commandparameter })

data/test/test_show.rb

@@ -0,0 +1,45 @@
+# Standard Show
+# Test 001
+initTmpDir
+commandparameter = ' show '
+showContent = `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+expectedContent = 'Author      : Example Author
+Creator     : Writer
+CreateDate  : 1970:01:01 00:00:00
+Subject     : Test Subject
+Title       : Test Dokument
+Keywords    : Some Keywords, Author, some feature, Customernumber 1111111, Kundenummer 1111111'
+if showContent == expectedContent
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults = { '001' => {:result => result, :command => commandparameter }}
+
+# Show single tags
+# Test 002
+initTmpDir
+commandparameter = ' show -t author'
+showContent = `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+expectedContent = 'Example Author'
+if showContent == expectedContent
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('002', {:result => result, :command => commandparameter })
+
+# Test 003
+# Show multiple tags
+initTmpDir
+commandparameter = ' show -t author,subject'
+showContent = `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+expectedContent = 'Example Author
+Test Subject'
+if showContent == expectedContent
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('003', {:result => result, :command => commandparameter })
+

data/test/test_sort.rb

@@ -0,0 +1,97 @@
+# Testing the results of the command 'sort'
+#
+# 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 }}
+
+
+# Test 002
+# Testing Sorting on a dir
+initTmpDir
+commandparameter = " sort -d #{TMPDIR}/target "
+`#{PDFMD} #{commandparameter} #{TMPDIR}`
+files = readFilesInDir(TMPDIR + '/target/example_author')
+if files.size == 1 and
+  File.basename(files.keys[0]) == 'test_default.pdf'
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('002',{:result => result, :command => commandparameter })
+
+# Test 003
+# Testing sorting on a dir with copy instead of moving
+initTmpDir
+commandparameter = " sort -d #{TMPDIR}/target -c "
+`#{PDFMD} #{commandparameter} #{TMPDIR}`
+filesTarget = readFilesInDir(TMPDIR + '/target/example_author')
+filesSource = readFilesInDir(TMPDIR)
+if filesTarget.size == 1 and
+  filesSource.size == 1 and
+  File.basename(filesTarget.keys[0]) == 'test_default.pdf' and
+  File.basename(filesSource.keys[0]) == 'test_default.pdf'
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('003',{:result => result, :command => commandparameter })
+
+# Test 004
+# Testing sorting on a dir with dryrun option
+initTmpDir
+commandparameter = " sort -d #{TMPDIR}/target -n "
+`#{PDFMD} #{commandparameter} #{TMPDIR}`
+filesTarget = readFilesInDir(TMPDIR + '/target/example_author')
+filesSource = readFilesInDir(TMPDIR)
+if filesTarget.size == 0 and
+  filesSource.size == 1 and
+  File.basename(filesSource.keys[0]) == 'test_default.pdf'
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('004',{:result => result, :command => commandparameter })
+
+# Test 005
+# Testing sorting on a dir with log creation
+# and default log location (changed in this case)
+initTmpDir
+commandparameter = " sort -d #{TMPDIR}/target -l -p #{TMPDIR}/pdfmd.log"
+`#{PDFMD} #{commandparameter} #{TMPDIR}`
+filesTarget = readFilesInDir(TMPDIR + '/target/example_author')
+filesSource = readFilesInDir(TMPDIR)
+if filesTarget.size == 1 and
+  filesSource.size == 0 and
+  File.basename(filesTarget.keys[0]) == 'test_default.pdf' and
+  File.exist?(TMPDIR + '/pdfmd.log')
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('005',{:result => result, :command => commandparameter })
+
+# Test 006
+# Testing sorting on a dir without log creation
+initTmpDir
+commandparameter = " sort -d #{TMPDIR}/target -l false -p #{TMPDIR}/pdfmd.log"
+`#{PDFMD} #{commandparameter} #{TMPDIR}`
+filesTarget = readFilesInDir(TMPDIR + '/target/example_author')
+filesSource = readFilesInDir(TMPDIR)
+if filesTarget.size == 1 and
+  filesSource.size == 0 and
+  File.basename(filesTarget.keys[0]) == 'test_default.pdf' and
+  not File.exist?(TMPDIR + '/pdfmd.log')
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('006',{:result => result, :command => commandparameter })
+

metadata

@@ -1,69 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: pdfmd
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-03-31 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: |2
@@ -80,6 +104,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- Rakefile
 - bin/pdfmd
 - lib/pdfmd.rb
 - lib/pdfmd/check.rb
@@ -95,7 +120,12 @@ files:
 - lib/pdfmd/rename.rb
 - lib/pdfmd/show.rb
 - lib/pdfmd/sort.rb
+- lib/string_extend.rb
 - pdfmd.gemspec
+- test/test_default.pdf
+- test/test_rename.rb
+- test/test_show.rb
+- test/test_sort.rb
 homepage: https://github.com/Micronarrativ/ruby-pmd
 licenses:
 - MIT