pdfmd 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 910525eeb9a1498f7b6345e987367eca6bc1a16e
-  data.tar.gz: 4fe25f14ef7c6366e2cd2188c68b5a5a7e56bba5
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGVjOGZmZTlhYjIzMGMzM2NjYzFhZDExM2RkMjNkNjJlYzk3ZGEyZg==
+  data.tar.gz: !binary |-
+    MGRmODdhOGJkZTI4YTQ0NThkZmRkMmEzZGU4OTUyZDZiZjc0ZjMyNA==
 SHA512:
-  metadata.gz: f2016aae25674bb4be3366ffda1954a1b799b0662f3f050eaf74c68e00a9f0195593b9113850dbfe1c8155fa9a7901a86d2899abea0e66f80284dca3c53e4a20
-  data.tar.gz: c5aa754e21ac36ad4166111099b721e972b3a4524e3fa33917c278d6bb268cbe40707bcc17f12070a7cb9c14fe4fe780610e742a5504410ba8de6152ffb1e296
+  metadata.gz: !binary |-
+    MTMzZmE2ZDE4MTZkNjA2ODM0ZmYzMDMwYjA5MGI3ZTg3YzZmMDc4ZTBhMjMx
+    ZTY4ZTU1YTIxMjQwOGNhMjA3MzQ5MDc1MTY1OGE1ZTcwMzczOTZkMDVhODAw
+    ODI0Yjc1OTViNDkzOWMxOTI0MTcyZTAzZTBmZjkzYTg0ZGMyZDY=
+  data.tar.gz: !binary |-
+    NGNkMmEyODYyMDRkNzBkNWI2NDNkYmJjMzJiNmQzMDIyNTE4Yzg3ZTg5MjVh
+    MjkzMjFiMTdmY2I0NjQzZjc4YmE5NjE0ZTEyNGI4NzkyZWY0NzRkYWMyNzBi
+    Nzc4YmZhNjE3YmQxZTFjMTc2NThkY2EwZTY3ZTRiNzE2MjQ3ODc=

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# Version 1.6.1
+- Bugfix with the sorting command and the logging
+- Added additional log messages for sorting.
+- Removed ampersand from target directory when sorting
+- Changed the parameter 'logfilepath' to 'logfile' for the command 'sort'. Now it should be identical in all commands.
+- Fixed command 'explain'. That was only working from inside the git repository, but not elsewhere.
+- Added installation instructions for Fedora/Ubuntu/CentOS to README.md
+
 # Version 1.6.0
 - Added command 'config'
 - Added dependency 'yaml'

data/README.md

@@ -30,6 +30,35 @@ $ gem install pathname
 $ gem install logger
 ```
 
+## Platforms
+### Fedora 21/CentOS 7
+* Install the depencies (required to install the rmagick gem)
+
+```
+$ sudo yum install -y rubygems rubygems-devel gcc ImageMagick ruby-devel ImageMagick-devel
+```
+
+* Install Gem
+
+``` 
+$ gem install pdfmd
+```
+
+### Ubuntu 14.04 LTS
+
+* Install the dependencies
+
+```
+$ sudo apt-get install -y rubygems-integration imagemagick libmagickwand-dev ruby-dev
+``` 
+
+* Install gem
+
+``` 
+$ sudo gem install pdfmd
+``` 
+
+
 ## Applications
 
 1. [exiftools](http://www.sno.phy.queensu.ca/~phil/exiftool/)

data/lib/pdfmd/explain.hiera.md

@@ -15,7 +15,7 @@ Configure default settings in hiera:
       destination : /data/output
       copy        : true
       log         : true
-      logfilepath : /var/log/pdfmd.log
+      logfile     : /var/log/pdfmd.log
       interactive : true
     rename:
       allkeywords : true

data/lib/pdfmd/explain.rb

@@ -13,5 +13,6 @@ when ''
   puts ' '
   puts "Run `$ #{pdfmd} explain <subject>` to get more details."
 else
-  puts File.read("lib/pdfmd/explain.#{term.downcase}.md")
+  # This reads the explain.x.md file relatively to the installed script file
+  puts File.read(File.join(File.dirname(__FILE__),"explain.#{term.downcase}.md"))
 end

data/lib/pdfmd/sort.rb

@@ -62,8 +62,8 @@ end
 if logenable
 
   if opt_logfilepath.blank? and 
-    ( hieraDefaults['sort']['logfilepath'].nil? or
-     hieraDefaults['sort']['logfilepath'].blank? or
+    ( hieraDefaults['sort']['logfile'].nil? or
+     hieraDefaults['sort']['logfile'].blank? or
      hieraDefaults['sort'].nil? )
 
     logfile = Dir.pwd.chomp('/') + '/' + File.basename(ENV['PDFMD'], '.*') + '.log'
@@ -78,9 +78,9 @@ if logenable
     logfile = opt_logfilepath
 
   elsif opt_logfilepath.blank? and
-    not hieraDefaults['sort']['logfilepath'].blank? 
+    not hieraDefaults['sort']['logfile'].blank? 
 
-    logfile = hieraDefaults['sort']['logfilepath']
+    logfile = hieraDefaults['sort']['logfile']
 
   else
 
@@ -95,9 +95,17 @@ end
 !File.exist?(inputDir) ? abort('Input directory does not exist. Abort.'): ''
 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)
-  logenable ? $logger.info("Destination '#{destination}' has been created.") : ''
+
+if not File.directory?(destination)
+
+  # Do nothing on a dry-run
+  if opt_dryrun
+    logenable ? $logger.info("Dryrun: Destination '#{destination}' has been created.") : ''
+  else
+    FileUtils.mkdir_p(destination)
+    logenable ? $logger.info("Destination '#{destination}' has been created.") : ''
+  end
+
 end
 
 # Iterate through all files
@@ -111,18 +119,28 @@ Dir[inputDir.chomp('/') +  '/*.pdf'].sort.each do |file|
   end
 
   metadata = readMetadata(file)
+
+  # The author information is used to create a subdirectory
+  # where all the files will end up in.
   if metadata['author'] and not metadata['author'].empty?
-    author                          = metadata['author'].gsub(' ','_').gsub('.','_')
+    author                          = metadata['author'].gsub(' ','_').gsub('.','_').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."): ''
+    if not File.directory?(folderdestination)
+
+      # Do nothing when it's a dry-run
+      if opt_dryrun
+        logenable ? $logger.info("Dryrun: Folder '#{folderdestination}' has been created."): ''
+      else
+        FileUtils.mkdir_p(folderdestination)
+        logenable ? $logger.info("Folder '#{folderdestination}' has been created."): ''
+      end
+
     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
@@ -130,15 +148,28 @@ Dir[inputDir.chomp('/') +  '/*.pdf'].sort.each do |file|
 
       # Move/Copy the file
       if copyAction 
-        opt_dryrun ? '' : FileUtils.cp(file, filedestination)
-        logenable ? $logger.info("File copied '#{file}' => '#{filedestination}'") : ''
+        if opt_dryrun
+          logenable ? $logger.info("Dryrun: File copied '#{file}' => '#{filedestination}'") : ''
+        else
+          FileUtils.cp(file, filedestination)
+          logenable ? $logger.info("File copied '#{file}' => '#{filedestination}'") : ''
+        end
+
       else
-        opt_dryrun ? '' : FileUtils.mv(file,filedestination)
-        logenable ? $logger.info("File moved '#{file}' => '#{filedestination}'") : ''
+
+        if opt_dryrun
+          logenable ? $logger.info("Dryrun: File moved '#{file}' => '#{filedestination}'") : ''
+        else
+          FileUtils.mv(file,filedestination)
+          logenable ? $logger.info("File moved '#{file}' => '#{filedestination}'") : ''
+        end
+
       end
 
     else
+
       logenable ? $logger.warn("File '#{filedestination}' already exists. Ignoring.") : ''
+
     end
   else
     logenable ? $logger.warn("Missing tag 'Author' for file '#{file}'. Skipping.") : (puts "Missing tag 'Author' for file '#{file}'. Skipping")

data/lib/pdfmd.rb

@@ -59,7 +59,7 @@ require "i18n"
 require 'pathname'
 require 'logger'
 
-VERSION = '1.6.0'
+VERSION = '1.6.1'
 
 # Include general usage methods
 require_relative('pdfmd/methods.rb')
@@ -346,10 +346,7 @@ class DOC < Thor
 
   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`.
-
-  [*logfilepath|p*]
+  [*logfile|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`.
 
@@ -395,13 +392,9 @@ class DOC < Thor
   [*log*]
   \x5 Enables (true) or disables (false) logging.
 
-  [*logfilepath*]
+  [*logfile*]
   \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.
 
-  [*logfilepath*]
-  \5x 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*]
@@ -420,7 +413,7 @@ class DOC < Thor
   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'
-  method_option :logfilepath, :aliases => '-p', :required => false, :type => :string, :desc => 'Change the default logfilepath'
+  method_option :logfile, :aliases => '-p', :required => false, :type => :string, :desc => 'Change the default logfile path'
   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)
@@ -429,7 +422,7 @@ class DOC < Thor
     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_LOGFILEPATH']  = options[:logfile].to_s
     ENV['PDFMD_INTERACTIVE']  = options[:interactive].to_s
     ENV['PDFMD_DRYRUN']       = options['dryrun'].to_s
     ENV['PDFMD']              = __FILE__

metadata

@@ -1,106 +1,106 @@
 --- !ruby/object:Gem::Specification
 name: pdfmd
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Daniel Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-04-12 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
-      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.
+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"
 email: pdfmd@micronarrativ.org
 executables:
 - pdfmd
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -137,18 +137,18 @@ 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.0.6
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: pdfmd - pdf-meta-data management