pdfmd 1.6.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a468c38125c3c8666a363e93f670707f27aa7d56
-  data.tar.gz: d73bc27bf63fedeb9f8c8ae9b4f335c8243e6283
+  metadata.gz: 903c39b8e2c5945304816a802bc46238d6ca26af
+  data.tar.gz: 2e8c939877d8208e89ea22a209b678e3424eca72
 SHA512:
-  metadata.gz: b1250781f28ee514c561386f98e79447798d9b46ee24a57a31874c24ecce53b2da6c920455ff3bf7ebbc6166624fd0c8f82933f83ca8cf255b8cb3c663c67cdb
-  data.tar.gz: 4eb10eec863147e23945b9fc585d94dd557e3fa522ef4c8ed50948369529e8e189860fa0a6be51670d9fe3a672bac0f2024367129986991bfc724d649ff4a849
+  metadata.gz: b72e6437d000b61c92fc30ce92ab4f7f6dc43b3cd0cf3601a0472db67771102811a404bb81e6b8ceb276aae251df6002bdad14848035f56caaaba2b1ce3c5623
+  data.tar.gz: 9a525d5c2551199d19556958c87a3ffaf46769f11658a8c93a7db409e6ff715facb11932addb9e6d362c821a3d93ccb7b361306b253c273231a865bee4b13916

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# Version 1.7.0
+- Rename option in command 'edit' on the Shell now overwrites the hiera setting.
+- The command 'show' supports multiple output formats.
+- Added hiera support for parameter 'format' and 'tag' for the command 'show'.
+- Added parameter 'includepdf' with Hiera for command 'show'.
+
 # Version 1.6.3
 - Added hiera option 'rename' for command 'edit'
 

data/lib/pdfmd.rb

@@ -59,7 +59,7 @@ require "i18n"
 require 'pathname'
 require 'logger'
 
-VERSION = '1.6.3'
+VERSION = '1.7.0'
 
 # Include general usage methods
 require_relative('pdfmd/methods.rb')
@@ -69,14 +69,13 @@ class DOC < Thor
   #
   # Show the current metadata tags
   #
-  # TODO: format output as JSON and YAML
   # TODO: Enable additional options
-  # TODO: Add command to show current settings (from hiera)
   #
   desc 'show', 'Show metadata of a file'
   method_option :all, :type => :boolean, :aliases => '-a', :desc => 'Show all metatags', :default => false, :required => false
   method_option :tag, :type => :string, :aliases => '-t', :desc => 'Show specific tag(s), comma separated', :required => false
-  #method_option :format, :type => :string, :aliases => '-f', :desc => 'Define output format', :required => false
+  method_option :format, :type => :string, :aliases => '-f', :desc => 'Define output format', :required => false
+  method_option :includepdf, :type => :boolean, :aliases => '-i', :desc => 'Include the filename in output', :required => false
   long_desc <<-LONGDESC
   == General
 
@@ -97,11 +96,36 @@ class DOC < Thor
 
   Relevant tags are Author,Creator, CreateDate, Title, Subject, Keywords.
 
+  This is the default action.
+
   --tag, -t
   \x5 Specify the metatag to show. The selected metatag must be one of the relevant tags. Other tags are ignored and nothing is returned.
 
   The value for the parameter is case insensitive: 'Author' == 'author'
 
+  Multiple Tags can be specificed, separated by a comma. 
+
+  If multiple tags are specified in a different order than the default order, the specified order will be used. This has an impact on the order of the fields when e.g. the output is exported in CSV format.
+
+  Hiera parameter: tag
+
+  --format, -f
+
+  Specify a different output format.
+
+  Available formats are json,yaml,csv,hash
+
+  The default output format is a human readable format.
+
+  Hiera parameter: format
+
+  --includepdf, -i
+
+  Include the filename of the PDF document in the output if this option is set to true.
+  Per default the filename is not included.
+
+  Hiera parameter: includepdf (boolean)
+
   == Example
 
   # Show default metatags for a pdf document
@@ -116,12 +140,24 @@ class DOC < Thor
   # Show value for metatags 'Author','Title' for the file example.pdf
   \x5>CLI show -t author,title example.pdf
 
+  == Hiera
+
+  Here is an example configuration for hiera:
+
+  pdfmd::config
+    show:
+      format    : yaml
+      tag       : author,subject
+      includepdf: true
+
   LONGDESC
   def show(filename)
 
-    ENV['PDFMD_FILENAME'] = filename
-    ENV['PDFMD_TAGS']     = options[:tag]
-    ENV['PDFMD_ALL']      = options[:all].to_s
+    ENV['PDFMD_FILENAME']   = filename
+    ENV['PDFMD_TAGS']       = options[:tag]
+    ENV['PDFMD_ALL']        = options[:all].to_s
+    ENV['PDFMD_FORMAT']     = options[:format]
+    ENV['PDFMD_INCLUDEPDF'] = options[:includepdf].to_s
     require_relative('./pdfmd/show.rb')
 
   end
@@ -242,7 +278,7 @@ class DOC < Thor
 
   LONGDESC
   method_option :tag, :type => :string, :aliases => '-t', :desc => 'Name of the Tag(s) to Edit', :default => false, :required => true
-  method_option :rename, :type => :boolean, :aliases => '-r', :desc => 'Rename file after changing meta-tags', :default => false, :required => false
+  method_option :rename, :type => :boolean, :aliases => '-r', :desc => 'Rename file after changing meta-tags', :required => false
   method_option :log, :aliases => '-l', :type => :boolean, :desc => 'Enable logging'
   method_option :logfile, :aliases => '-p', :type => :string, :desc => 'Define path to logfile'
   def edit(filename)

data/lib/pdfmd/edit.rb

@@ -17,6 +17,8 @@ hieraDefaults = queryHiera('pdfmd::config')
 # Rename or not
 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)

data/lib/pdfmd/explain.csv.md

@@ -0,0 +1,23 @@
+The CSV output formatted follows the guidelines mentioned under https://en.wikipedia.org/wiki/Comma-separated_values.
+
+# Field Names
+
+There is no header line defining the fields for the CSV output.
+
+The fields are in the following order:
+
+1. Author
+2. Creator
+3. CreateDate
+4. Title
+5. Subject
+6. Keywords
+
+# Quotes
+Double quotes in fields like 'keywords' are replaced by double double quotes:
+
+'"Keyword1, Keyword2"' => '""Keyword1, Keyword2""'
+
+# Field seperator
+The comma is used as a field seperator.
+

data/lib/pdfmd/explain.rb

@@ -5,6 +5,7 @@ case term
 when ''
   puts 'Available subjects:'
   puts '- author'
+  puts '- csv'
   puts '- createdate'
   puts '- hiera'
   puts '- keywords'

data/lib/pdfmd/show.rb

@@ -1,24 +1,162 @@
-filename  = ENV.fetch('PDFMD_FILENAME')
-optTag    = ENV['PDFMD_TAGS'] || nil 
-optAll    = ENV['PDFMD_ALL'] == 'true' ? true : nil
+#
+# Show function of pdfmd
+#
+filename        = ENV.fetch('PDFMD_FILENAME')
+optTag          = ENV['PDFMD_TAGS'] || nil 
+optAll          = ENV['PDFMD_ALL'] == 'true' ? true : nil
+opt_format      = ENV['PDFMD_FORMAT']
+opt_includepdf  = ENV['PDFMD_INCLUDEPDF']
+hieraDefaults   = queryHiera('pdfmd::config')
+
+# Determine includepdf from Hiera if possible
+if not opt_includepdf.nil? and
+  opt_includepdf == 'true'
+
+  opt_includepdf = true
+
+elsif opt_includepdf.nil? and
+  not hieraDefaults['show'].nil? and
+  not hieraDefaults['show']['includepdf'].nil? and
+  hieraDefaults['show']['includepdf'] == true
+
+  opt_includepdf = true
+  
+else
+
+  opt_includepdf = false
+
+end
+
+# Determine format from Hiera if possible
+if opt_format.nil? and
+  not hieraDefaults['show'].nil? and
+  not hieraDefaults['show']['format'].nil? and
+  hieraDefaults['show']['format'] != ''
+
+  opt_format = hieraDefaults['show']['format']
+
+end
+
+
+# Determine tags from Hiera if possible
+if optTag.nil? and
+  not hieraDefaults['show'].nil? and
+  not hieraDefaults['show']['tag'].nil? and
+  hieraDefaults['show']['tag'] != ''
+
+  optTag = hieraDefaults['show']['tag']
+
+end
 
 metadata  = readMetadata(filename)
 
-# Output all metatags
 if optAll or optTag.nil?
 
-  puts "Author      : " + metadata['author'].to_s
-  puts "Creator     : " + metadata['creator'].to_s
-  puts "CreateDate  : " + metadata['createdate'].to_s
-  puts "Subject     : " + metadata['subject'].to_s
-  puts "Title       : " + metadata['title'].to_s
-  puts "Keywords    : " + metadata['keywords'].to_s
-
-elsif not optTag.nil? # Output specific tag(s)
+  # Sort the keys in the hash in a specific order, so it becomes predictable
+  sortedHash = Hash.new
+  sortedHash['author']      = metadata['author']
+  sortedHash['creator']     = metadata['creator']
+  sortedHash['createdate']  = metadata['createdate']
+  sortedHash['title']       = metadata['title']
+  sortedHash['subject']     = metadata['subject']
+  sortedHash['keywords']    = metadata['keywords']
+  metadata = sortedHash
 
+  tags = metadata.keys.join(',').split(',')
+else
   tags = optTag.split(',')
-  tags.each do |tag|
-    puts metadata[tag.downcase]
+end
+
+# Format the output according to the spefications.
+# Default output is for Human readable
+#
+case opt_format
+when /yaml/i
+
+  # Format the output as YAML
+
+  require 'yaml'
+  yamlData = Hash.new
+  tags.each do |tagname|
+    yamlData[tagname] = metadata[tagname.downcase]
+  end
+
+  # Include the filename if required
+  if opt_includepdf
+    fullHash            = Hash.new
+    fullHash[filename]  = yamlData
+    puts fullHash.to_yaml
+  else
+    puts yamlData.to_yaml
+  end
+
+when /hash/i
+
+  # Format the output as Ruby Hash
+
+  hashData = Hash.new
+  tags.each do |tagname|
+    hashData[tagname] = metadata[tagname.downcase]
+  end
+
+  # Include filename if required
+  if opt_includepdf
+    fullHash = Hash.new
+    fullHash[filename] = hashData
+    puts fullHash
+  else
+    puts hashData
+  end
+
+when /csv/i
+
+  # Format the output as CSV data (or what could be interpreted as something
+  # similar
+
+  # Format the fields as CSV
+  csvData = Hash.new
+  tags.each do |tagname|
+    csvData[tagname] = '"' + metadata[tagname.downcase].to_s.gsub(/"/,'""') + '"'
+  end
+
+  # Include the filename if required
+  if opt_includepdf
+    # Hash to array and joined to CSV compatible string
+    puts "\"#{filename}\"," + csvData.values.join(',')
+  else
+    # Hash to array and joined to CSV compatible string
+    puts csvData.values.join(',')
+  end
+
+
+when /json/i
+
+  # Format the output as JSON
+
+  require 'json'
+  jsonData = Hash.new
+  tags.each do |tagname|
+    jsonData[tagname] = metadata[tagname.downcase]
+  end
+
+  # Include the filename if required
+  if opt_includepdf
+    fullHash = Hash.new
+    fullHash[filename] = jsonData
+    puts fullHash.to_json
+  else
+    puts jsonData.to_json
+  end
+
+else
+
+  # Default output for humans to read
+  if opt_includepdf
+    puts 'File: ' + filename
+  end
+  tags.each do |key,tag|
+    puts key.capitalize + ': ' + metadata[key.downcase]
   end
 
 end
+

data/test/test_show.rb

@@ -1,14 +1,14 @@
 # Standard Show
 # Test 001
 initTmpDir
-commandparameter = ' show '
+commandparameter = ' show -i false --format standard --all'
 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'
+expectedContent = 'Author: Example Author
+Creator: Writer
+Createdate: 1970:01:01 00:00:00
+Title: Test Dokument
+Subject: Test Subject
+Keywords: Some Keywords, Author, some feature, Customernumber 1111111, Kundenummer 1111111'
 if showContent == expectedContent
   result = 'OK'
 else
@@ -19,9 +19,9 @@ $testResults = { '001' => {:result => result, :command => commandparameter }}
 # Show single tags
 # Test 002
 initTmpDir
-commandparameter = ' show -t author'
+commandparameter = ' show -t author --format standard'
 showContent = `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
-expectedContent = 'Example Author'
+expectedContent = 'Author: Example Author'
 if showContent == expectedContent
   result = 'OK'
 else
@@ -32,10 +32,10 @@ $testResults.store('002', {:result => result, :command => commandparameter })
 # Test 003
 # Show multiple tags
 initTmpDir
-commandparameter = ' show -t author,subject'
+commandparameter = ' show -t author,subject --format standard'
 showContent = `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
-expectedContent = 'Example Author
-Test Subject'
+expectedContent = 'Author: Example Author
+Subject: Test Subject'
 if showContent == expectedContent
   result = 'OK'
 else
@@ -43,3 +43,57 @@ else
 end
 $testResults.store('003', {:result => result, :command => commandparameter })
 
+# Test 004
+# Show output as YAML format
+initTmpDir
+commandparameter = ' show -t author,subject -f yaml'
+showContent = `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+expectedContent = '---
+author: Example Author
+subject: Test Subject'
+if showContent == expectedContent
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('004', {:result => result, :command => commandparameter })
+
+# Test 005
+# Show output as JSON format
+initTmpDir
+commandparameter = ' show -f json -a'
+showContent = `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+expectedContent = '{"author":"Example Author","creator":"Writer","createdate":"1970:01:01 00:00:00","title":"Test Dokument","subject":"Test Subject","keywords":"Some Keywords, Author, some feature, Customernumber 1111111, Kundenummer 1111111"}'
+if showContent == expectedContent
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('005', {:result => result, :command => commandparameter })
+
+# Test 006
+# Show output as CSV format
+initTmpDir
+commandparameter = ' show -t author,subject -f csv -a'
+showContent = `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+expectedContent = '"Example Author","Writer","1970:01:01 00:00:00","Test Dokument","Test Subject","Some Keywords, Author, some feature, Customernumber 1111111, Kundenummer 1111111"'
+if showContent == expectedContent
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('006', {:result => result, :command => commandparameter })
+
+# Test 007
+# Show output as Hash format
+initTmpDir
+commandparameter = ' show -t author,subject -f hash -a'
+showContent = `#{PDFMD} #{commandparameter} #{TARGETPDF}`.chomp
+expectedContent = '{"author"=>"Example Author", "creator"=>"Writer", "createdate"=>"1970:01:01 00:00:00", "title"=>"Test Dokument", "subject"=>"Test Subject", "keywords"=>"Some Keywords, Author, some feature, Customernumber 1111111, Kundenummer 1111111"}'
+if showContent == expectedContent
+  result = 'OK'
+else
+  result = 'failed'
+end
+$testResults.store('007', {:result => result, :command => commandparameter })
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfmd
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.7.0
 platform: ruby
 authors:
 - Daniel Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -112,6 +112,7 @@ files:
 - lib/pdfmd/edit.rb
 - lib/pdfmd/explain.author.md
 - lib/pdfmd/explain.createdate.md
+- lib/pdfmd/explain.csv.md
 - lib/pdfmd/explain.hiera.md
 - lib/pdfmd/explain.keywords.md
 - lib/pdfmd/explain.rb