pdfmd 2.1.6 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e2ba1b3dab8288ed43b930c7e27b1754fc436f5
-  data.tar.gz: b2a0cfb407738c31d9b465bc2711b7c2b04ff650
+  metadata.gz: 58d5e2cab3403b63a10160c42611014d6cac1ee3
+  data.tar.gz: ee23d47ddf7e0448f1bf67fba2f4e61847af16a7
 SHA512:
-  metadata.gz: d02be348bfe4301f09e3ca7e093c4d4585968f8229e56b759903ae2822b4a072f6030de75976f261a1c0ccccfe605988d01b71b22e49cb17bf645e20e0a60beb
-  data.tar.gz: 31051acfda07bd823eede7653917b74404e4d55948fd9b057156a4d082bda8697c56125777924034dfc5e4a84d7797d797c66711694fa42d4c83711866551954
+  metadata.gz: 117cac8d9bbdb9d1e38a4275fe2acaf596f8ef165008516f996506a5acfc9cc9268185512bcf89476bca474606fd7d3f31eea0120e82f644b4456896fa5c86a3
+  data.tar.gz: 8b9f96ebdcf351488006551a2d5727366ba46b86635b8d9b7b160919332d623b354727ff4dc784e2ba4393ea69d3beb9a128ca078d5795eace03d2df2fb98365

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# Version 2.2.0
+- Adding parameter 'typo' to command `sort`.
+
 # Version 2.1.6
 - Modified command `sort` to also support shell file extension.
 

data/bin/pdfmd

@@ -7,7 +7,7 @@ require "fileutils"
 require "i18n"
 require 'pathname'
 
-VERSION = '2.1.6'
+VERSION = '2.2.0'
 NAME    = 'pdfmd'
 
 #
@@ -207,6 +207,7 @@ method_option :copy, :aliases => '-c', :required => false, :type => :boolean, :d
 method_option :interactive, :aliases => '-i', :required => false, :type => :boolean, :desc => 'Enable/Disable interactive sorting'
 method_option :overwrite, :alises => '-o', :required => false, :type => :boolean, :desc => 'Enable/Disable file overwrite.', :lazy_default => true
 method_option :dryrun, :aliases => '-n', :required => false, :type => :boolean, :desc => 'Run without changing something'
+method_option :typo, :aliases => '-t', :required => false, :type => :boolean, :desc => 'Try to find typos before sorting into folders.', :lazy_default => true
 def sort(*input)
 
   input.each do |file|
@@ -218,6 +219,7 @@ def sort(*input)
       pdfdoc.destination  = pdfdoc.determineValidSetting(options[:destination], 'sort:destination')
       pdfdoc.overwrite    = pdfdoc.determineValidSetting(options[:overwrite], 'sort:overwrite')
       pdfdoc.dryrun       = pdfdoc.determineValidSetting(options[:dryrun], 'sort:dryrun')
+      pdfdoc.typo         = pdfdoc.determineValidSetting(options[:typo], 'sort:typo')
       pdfdoc.sort
 
     else

data/lib/pdfmd/explain.rb

@@ -12,6 +12,7 @@ when ''
   puts '- keywords'
   puts '- subject'
   puts '- title'
+  puts '- typo'
   puts ' '
   puts "Run `$ #{pdfmd} explain <subject>` to get more details."
 else

data/lib/pdfmd/explain.typo.md

@@ -0,0 +1,6 @@
+[typo]
+  Parameter for the command 'sort'.  
+  If parameter is set, a warning will appear during the sorting process when a target directory is already present, which is similar to the new one that shall be created.  
+  This usually indicates a typo in the author field, which then is reflected in the naming of the sub-directory in the sorting target.  
+  The user then can either decide to continue or abort the sorting process.
+

data/lib/pdfmd/long_desc.pdfmdsort.txt

@@ -54,6 +54,12 @@ If set to 'true' the command will overwrite any existing file at the target dest
 
 
 
+--typo, -t
+
+If set to 'true' (or set at all) similar sub-directories in the sorting target directory will be reported before a new folder is being created. Similar sub-directories can be caused by typos in the author field for the document. 
+
+
+
 === Replacement rules
 
 The subdirectories for the documents are generated from the values in the

data/lib/pdfmd/pdfmdsort.rb

@@ -3,16 +3,20 @@
 # TODO: Author values with a slave One/two should be sorted into one/two/yyyymmdd-one_to-xxx.pdf
 class Pdfmdsort < Pdfmd
 
-  attr_accessor :filename, :dryrun, :copy, :interactive, :destination, :overwrite
+  require 'fuzzystringmatch'
+
+  attr_accessor :filename, :dryrun, :copy, :interactive, :destination, :overwrite, :typo
 
   # Initialize
   def initialize(input)
       super input
-      @destination  = '.'
-      @interactive  = false
-      @copy         = false
-      @dryrun       = false
-      @overwrite    = false
+      @stringSimBorder = 0.8  # Defines the value of the typo check
+      @destination     = '.'
+      @interactive     = false
+      @copy            = false
+      @dryrun          = false
+      @overwrite       = false
+      @typo            = false
   end
 
 
@@ -44,6 +48,30 @@ class Pdfmdsort < Pdfmd
     I18n.transliterate(author).downcase # Normalising
   end
 
+  # Method compares string from 'targetdir' with all subfolders in the targetdir
+  #   in order to find similarities in writing.
+  def findSimilarTargetdir( targetdir )
+
+    self.log('debug', "Running method 'findSimilarTarget' with parameter '#{targetdir}'.")
+
+    fuzzy       = FuzzyStringMatch::JaroWinkler.create( :native )
+    returnValue = false
+
+    # Get all subfolders 
+    subDirectories = Dir[@destination + '/*']
+    subDirectories.each do |fullPathFolder|
+       stringSimilarity = fuzzy.getDistance( 
+         fullPathFolder.gsub(@destination + '/', ''),
+         targetdir.gsub(@destination + '/', '')
+         )
+       if stringSimilarity > @stringSimBorder
+         self.log('debug', "findSimilarTargetdir: Found String value #{stringSimilarity.to_s} for target '#{fullPathFolder}'.")
+         returnValue = fullPathFolder
+       end
+    end
+    returnValue
+  end
+
 
   #
   # Sort the file away
@@ -69,13 +97,34 @@ class Pdfmdsort < Pdfmd
       targetdir   = @destination.chomp + '/' + author
       targetfile  = targetdir + '/' + Pathname.new(@filename).basename.to_s
 
-      # Create the target dir if not existing.
+      # Create the target directory, if it does not exist yet.
       if !File.exists? targetdir
+
+        # Check for similiar directory names which might indicate a typo in the
+        #   current directory name.
+        if @typo and foundDir = self.findSimilarTargetdir(targetdir)
+
+          self.log('info', "Similar target found ('" + foundDir + "'). Request user input.")
+          puts 'Similar target directory detected:'
+          puts 'Found : ' + foundDir
+          puts 'Target: ' + targetdir
+          while answer = readUserInput('Abort? ([y]/n): ')
+            if answer.match(/(y|yes|j|ja|^$)/i)
+              self.log('info','User chose to abort sorting.')
+              puts 'Abort.'
+              exit 0
+            elsif answer.match(/(n|no)/i)
+              self.log('info', 'User chose to continue sorting.')
+              break
+            end
+          end
+        end
+
         if @dryrun
           self.log('info', "Dryrun: Created Directory '#{targetdir}'.")
         else
           self.log('info', "Created directory '#{targetdir}'.")
-          puts targetdir
+          puts 'Created: ' + targetdir
           FileUtils.mkdir_p(targetdir)
         end
       end

data/pdfmd.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   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'
+  s.add_dependency 'fuzzy-string-match', '~>0.9', '>=0.9.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfmd
 version: !ruby/object:Gem::Version
-  version: 2.1.6
+  version: 2.2.0
 platform: ruby
 authors:
 - Daniel Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -90,6 +90,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.11
+- !ruby/object:Gem::Dependency
+  name: fuzzy-string-match
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.7
 description: |2
       Managing the common pdf metadata values and renaming the pdf file accordingly.
       Sets common tags like 'author', 'createdate', 'title', 'subject' and 'keywords'
@@ -122,6 +142,7 @@ files:
 - lib/pdfmd/explain.rb
 - lib/pdfmd/explain.subject.md
 - lib/pdfmd/explain.title.md
+- lib/pdfmd/explain.typo.md
 - lib/pdfmd/long_desc.pdfmdclean.txt
 - lib/pdfmd/long_desc.pdfmdconfig.txt
 - lib/pdfmd/long_desc.pdfmdedit.txt
@@ -150,8 +171,8 @@ homepage: https://github.com/Micronarrativ/ruby-pmd
 licenses:
 - MIT
 metadata:
-  created: '2015-09-21 21:06:09'
-  revision: '20150921210609'
+  created: '2015-10-14 21:56:45'
+  revision: '20151014215645'
 post_install_message: ". Run `pdfmd` to see the command help."
 rdoc_options: []
 require_paths: