pdfmd 1.3.2 → 1.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWRlMmI4ZGUwNjFkODQ1ZjcwODRlOTlkNDkwNGRhNWU4ZGNlNWU4Mw==
-  data.tar.gz: !binary |-
-    ODE4Nzk2YTQ3NWE0MTQzNWRkMTYxNmI4YmRlNTUwOTk5YTAyNmQxMg==
+SHA1:
+  metadata.gz: de090beed3dac1f418ba19c76a6d2854bbd4812b
+  data.tar.gz: 60cdc9d02a4da98e8c86098a6db26b93a15c00e0
 SHA512:
-  metadata.gz: !binary |-
-    YjA1Y2MwMWEyYWYxN2ZmMTc3YWEwYWVmMjU1NDk5MjlmNTgzNjQzMTE3MzU2
-    NzEzN2FkYTVhZDE5ZDU3MDgyY2M3MzcxNjkwNjE5NjczZWQwY2E1ODA3ZDNi
-    MjhkODhlMWIyNDRhNGJkYzJlMzI0YTExYjBkZWUwZjhjYjA3ZWQ=
-  data.tar.gz: !binary |-
-    M2U4OGNhZGEzOTIwMWY2MzM5NDNjMTEwODhkOGZhYWU1MmQ5YzU4YjhiNjRk
-    ZDQ2YzJhMDA0YzcxNTdmMjczNWE2MTQ4MDIxN2YzODcyNWY0ZDYyYTJiZWI3
-    ZDQ5Mjc2Y2MxMmNmNDc5NTMzMTBhYTIzNDcxM2I0YTg0MDM3YjU=
+  metadata.gz: 420de8f357b24fa83bfca65a8d973c108f38f2652c0bb1925c3098f8b72bc07066facc2f3a24bc95c392e8051c58286d917df02002d86c0a7c638389187cd7b0
+  data.tar.gz: 49b3cdf928a3a5728cf1fd660c10d807195990f182bc6398662295f038d5936bfeba9678890e820725fff506be4db56ed1cb91127d5b62234058f5c42ba7e3c1

data/bin/pdfmd

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # == Version 1.3
 #
-# == File: pdfmetadata.rb
+# == File: pdfmd.rb
 #
 # Show and edit Metadata of PDF files and rename the files accordingly.
 #
@@ -21,9 +21,9 @@
 #
 # === Usage
 #
-#   $ ./pdfmetadata <action> <parameter> file
+#   $ ./pdfmd <action> <parameter> file
 #
-#   $ ./pdfmetadata help <action>
+#   $ ./pdfmd help <action>
 #
 # An overview about the actions can be seen when running the script without
 # any parameters
@@ -62,7 +62,8 @@ require "i18n"
 require 'pathname'
 require 'logger'
 
-VERSION = '1.3.2'
+VERSION = '1.4.0'
+
 #
 # Function to read the metadata from a given file
 # hash readMetadata(string)
@@ -98,6 +99,30 @@ def readMetadata(pathFile = false)
   return metadata
 end
 
+
+#
+# Query Hiera installation
+# I don't give a sh** about cross platform at this point.
+#
+# Return the hash of the hiera values or false (if no hiera is found)
+#
+def queryHiera(keyword,facts = 'UNSET')
+
+  # Set default facts
+  facts == 'UNSET' ? facts = "fqdn=#{`hostname`}" : ''
+
+  # If hiera isn't found, return false
+  # otherwise return the hash
+  if !system('which hiera > /dev/null 2>&1')
+    puts 'Cannot find "hiera" command in $path.'
+    return false
+  else
+    return eval(`hiera #{keyword} #{facts}`)
+  end
+
+end
+
+
 #
 # Set Keywords Preface based on title and subject
 # If subject matches a number/character combination and contains no spaces,
@@ -418,6 +443,7 @@ class DOC < Thor
       puts 'Available subjects:'
       puts '- author'
       puts '- createdate'
+      puts '- hiera'
       puts '- keywords'
       puts '- subject'
       puts '- title'
@@ -449,6 +475,23 @@ class DOC < Thor
       puts '  '
       puts '  When writing Invoices with their numbers, these will be automatically be '
       puts '  picked up and can be integrated in the filename, e.g. "Invoicenumber 12334'
+    when 'hiera'
+      puts 'Information about hiera: https://docs.puppetlabs.com/hiera/1/index.html'
+      puts ''
+      puts 'Installation:'
+      puts '  $ gem install hiera'
+      puts ''
+      puts ''
+      puts 'Configure default settings in hiera:'
+      puts ''
+      puts '  YAML'
+      puts '  ---'
+      puts '  pdfmd::config:'
+      puts '    sort:'
+      puts '      destination : /tmp/output'
+      puts '      action      : copy'
+      puts '      logfile     : /var/log/pdfmd.log'
+      puts ''
     end
 
   end
@@ -475,7 +518,9 @@ class DOC < Thor
   [*destination|d*]
   \x5 Speficy the root output directory to where the folderstructure is being created.
 
-    This parameter is required.
+    This parameter is required if hiera is not configured.
+
+    This parameter overwrites the hiera defaults
 
   [*copy|c*]
   \x5 Copy the files instead of moving them.
@@ -484,6 +529,11 @@ class DOC < Thor
   \x5 Disable/Enable the logging.
   \x5 Default: enabled.
 
+  [*interactive|i*]
+  \x5 Disable/Enable interactive sorting. This will ask for confirmation for
+  \x5   each sorting action.
+  \x5 Default: disabled.
+
   === Replacement rules
 
   The subdirectories for the documents are generated from the values in the
@@ -496,6 +546,36 @@ class DOC < Thor
   \x5 3. All letters are converted to their lowercase version.
   \x5 4. Special characters are serialized
 
+  === Hiera configuration
+
+  Set the default values mentioned below as sub-hash of the main configuration:
+
+  YAML
+  \x5sort:
+  \x5  key: value
+
+  === 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.
+
+  [*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.
+
+  [*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.
+
+  [*interactive*]
+  \x5  If set to true, each file must be acknowledged to be processed when
+    running the script.
+
   === Example
 
     This command does the following:
@@ -506,15 +586,51 @@ class DOC < Thor
    \x5> CLI sort -d /tmp/test -c -l false ./documents
 
   LONGDESC
-  method_option :destination, :aliases => '-d', :required => true, :type => :string, :desc => 'Defines the output directory'
+  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', :require => false, :type => :boolean, :desc => 'Enable/Disable creation of log files', :default => true
+  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'
   def sort(inputDir = '.')
 
+    hieraDefaults = queryHiera('pdfmd::config')
+
+    copyAction  = options[:copy].nil? ? false : true
+    if options[:copy].nil? and hieraDefaults['sort']['copy'] == true
+      copyAction = true
+      puts 'Setting action to copy based on Hiera.'
+    end
+
+    interactiveAction = options[:interactive].nil? ? false : true
+    if options[:interactive].nil? and hieraDefaults['sort']['interactive'] == true
+      interactiveAction = true
+      puts 'Setting interactive to true based on Hiera.'
+    end
+
+    # Fetch alternate destination from hiera if available
     destination = options[:destination]
-    logenable   = options[:log]
-    scriptname = Pathname.new(__FILE__).basename
-    logenable ? $logger = Logger.new(Dir.pwd.chomp('/') + "/#{scriptname}.log") : ''
+    if destination.nil?
+
+      hieraHash = queryHiera('pdfmd::config')
+      if !hieraHash['sort']['destination'].nil?
+        destination = hieraHash['sort']['destination']
+      else
+        puts 'No information about destination found.'
+        puts 'Set parameter -d or configure hiera.'
+        puts 'Abort.'
+        exit 1
+      end
+
+    end
+
+    logenable = options[:log]
+    logfile   = !hieraHash['sort']['logfile'].nil? ? hieraHash['sort']['logfile'] : Dir.pwd.chomp('/') + '/' + Pathname.new(__FILE__).basename + '.log'
+
+    # Check that logfilepath exists and is writeable
+    if !File.writable?(logfile)
+      puts "Cannot write '#{logfile}. Abort."
+      exit 1
+    end
+    logenable ? $logger = Logger.new(logfile) : ''
 
     # Input validation
     !File.exist?(inputDir) ? abort('Input directory does not exist. Abort.'): ''
@@ -528,24 +644,31 @@ class DOC < Thor
     # Iterate through all files
     Dir[inputDir.chomp('/') +  '/*.pdf'].sort.each do |file|
 
+      if interactiveAction
+        answer = readUserInput("Process '#{file}' ([y]/n): ")
+        answer.empty? ? 'y' : next
+      end
+
       metadata = readMetadata(file)
       if metadata['author'] and not metadata['author'].empty?
-        author = metadata['author'].gsub(' ','_').gsub('.','_')
-        I18n.enforce_available_locales = false # Serialize special characters
-        author = I18n.transliterate(author).downcase
-        folderdestination = destination.chomp('/') + '/' + author
+        author                          = metadata['author'].gsub(' ','_').gsub('.','_')
+        I18n.enforce_available_locales  = false # Serialize special characters
+        author                          = I18n.transliterate(author).downcase
+        folderdestination               = destination.chomp('/') + '/' + author
+
         unless File.directory?(folderdestination)
           FileUtils.mkdir_p(folderdestination)
           logenable ? $logger.info("Folder '#{folderdestination}' has been created."): ''
         end
-        filedestination = destination.chomp('/') + '/' + author + '/' + Pathname.new(file).basename.to_s
+
+        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 options[:copy]
+          if copyAction
             FileUtils.cp(file, filedestination)
           else
             FileUtils.mv(file,filedestination)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfmd
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Daniel Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies: []
 description: Managing the common pdf metadata values and renaming the pdf file accordingly.
 email: pdfmd@micronarrativ.org
@@ -28,17 +28,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: pdfmd - pdf-meta-data management