pdfmd 2.3.5 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 813b0ecd46d44e57d65eb8b28de7805876b1df54
-  data.tar.gz: a218ccc83880d0cf83469c8ed5fcc75dcdd0fda5
+  metadata.gz: 014584f51b2c90eed42cb65024504d2d9ebf1b81
+  data.tar.gz: 0618a7ea2c6e87cf750440979e306db7b99f07ae
 SHA512:
-  metadata.gz: e5e3701be0348417b1e9b4ea5a33e2bec55147209c233b724707cee6437e276162a733dcd65e8a570b49ea9ae9631db29ab095cc7a5cc6a64bfae4b15c24611c
-  data.tar.gz: 3c7538e7d397dd948f687c1933217552f4722c57a5b53d5e53dcada0a88e86ae2bb1a6914a7ba4c842794cae3dd430027ec9f6e26c3ff7c16d25d34460423d87
+  metadata.gz: 25308020f8ccaa6401d75ee8baae3c7c6acb0eb81ecd431d6ab917228db2993fc8cee1e070ae611c4796ab27484676ab0747458fc1934881537e4f8f7c396d96
+  data.tar.gz: 3a5168b63cea744d419e514f5d48296cbd2e7436fe2325ba7d888db572140a9d6ac98046ee8c27472971984f08fc117b19a14420dda92b3c8932e890c319ef78

data/README.md

@@ -1,5 +1,5 @@
 # pdfmd
-Pdf Meta data managing script.
+Pdf metadata managing script.
 
 I use the script `pdfmd.rb`/pdfmetadata (with a slightly different name) to manage my PDF documents and keep the naming in line.  
 Hidden deep in the directory structure of my disks I can quickly find the
@@ -128,6 +128,13 @@ __HINT__: Before you start using the script, make sure you have a backup of your
 _pdfmd_ recognises if a pdf file is password protected and will ask for the password.  
 A password string can be defined in hiera that will be used per default.
 
+# Bash completion
+
+Pdfmd comes with bash completion. To setup bash completion run the command
+
+$ pdfmd init bash_completion
+
+This will install a bash completion file. A restart of/new console might be necessary to enable it.
 
 # Hiera
  

data/bin/pdfmd

@@ -1,16 +1,16 @@
 #!/usr/bin/env ruby
 require 'pdfmd'
 require 'pdfmd/pdfmdstat'
+require 'pdfmd/pdfmdinit'
 require "thor"
 require "highline/import"
 require "fileutils"
 require "i18n"
 require 'pathname'
 
-VERSION = '2.3.5'
+VERSION = '2.4.0'
 NAME    = 'pdfmd'
 
-#
 # Read the content of the long description from an external file
 #
 def readLongDesc(filename)
@@ -99,6 +99,24 @@ class DOC < Thor
   end
 
 
+# Initialise something
+#
+#
+desc 'init [COMMAND]', 'Initialise additonal functions'
+long_desc readLongDesc 'pdfmd/long_desc.pdfmdinit.txt'
+method_option :remove, :type => :boolean, :aliases => '-r', :required => false, :lazydefault => 'true'
+def init(subcommand = '')
+
+  if subcommand == 'bash_completion'
+    init_bashcompletion(NAME,VERSION,options[:remove])
+  else
+    puts 'No command provided. Abort.'
+    puts 'Run `$ pdfmd help init` for details.'
+    exit 1
+  end
+
+end
+
 # Show current settings
 #
 desc 'config', 'Show config defaults'
@@ -298,30 +316,3 @@ end
 
 DOC.start
 
-#  #
-#  # Explain fields and Metatags
-#  # Show information about how they are used.
-#  #
-#  desc 'explain','Show more information about usuable Meta-Tags'
-#  long_desc <<-LONGDESC
-#  == General
-#
-#  Explain some terms used with the script.
-#
-#  == Example
-#
-#  # Show the available subjects
-#  \x5>CLI explain
-#
-#  # Show information about the subject 'author'
-#  \x5>CLI explain author
-#
-#  LONGDESC
-#  def explain(term='')
-#
-#    ENV['PDFMD_EXPLAIN']  = term
-#    ENV['PDFMD']          = File.basename(__FILE__)
-#    require_relative('./pdfmd/explain.rb')
-#
-#  end
-#

data/lib/pdfmd/long_desc.pdfmdinit.txt

@@ -0,0 +1,30 @@
+== General
+
+Command will setup the environment for pdfmd if executed.
+At this moment only the installation of bash completion file is integrated.
+
+
+
+== Command
+
+bash_completion
+
+Installs or removes the bash completion file for pdfmd. Existing files will be
+overwritten after a file with the extension '.backup' has been created in the
+same directory.
+
+== Parameter
+
+--remove, -r
+
+Removes the bash completion file. Does not remove any existing backup file.
+
+== General example
+
+# Install the bash completion file
+
+$ pdfmd init bash_completion
+
+# Remove the bash completion file
+
+$ pdfmd init -r bash_completion

data/lib/pdfmd/pdfmd.bash

@@ -0,0 +1,194 @@
+# Bash completion file for pdfmd
+# copy to /etc/bash_completion.d to use it
+_pdfmd()
+{
+  local cur prev opts tags chapter
+  COMPREPLY=()
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+  chapter="${COMP_WORDS[1]}"
+  tags='all author keywords title subject createdate'
+
+  # The basic options
+  opts="edit clean config init rename show sort stat --version --revision"
+
+  #
+  # complete the arguments to some of the basic commands
+  #
+  case "${chapter}" in
+    init)
+      case "${prev}" in
+        -r|--remove) # Remove 
+          local parameter='bash_completion'
+          COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+          return 0
+          ;;
+        *)
+          local parameter='--remove bash_completion'
+          COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+          return 0
+          ;;
+      esac
+      ;;
+    edit)
+      case "${prev}" in
+        -t|--tags) # Define the tags
+          local tags='all author keywords title subject createdate'
+          COMPREPLY=( $(compgen -W "${tags}" -- ${cur}) )
+          return 0
+          ;;
+        -r|--rename) # Rename files
+          local files=$(ls *.pdf)
+          COMPREPLY=( $(compgen -W "${files}" -- ${cur}) )
+          return 0
+          ;;
+        -o|--opendoc) # Open the document
+          local files=$(ls *.pdf)
+          COMPREPLY=( $(compgen -W "${files}" -- ${cur}) )
+          return 0
+          ;;
+        'all') # all tags
+          local files="$(find . -maxdepth 1 -type f -iname '*.pdf')"
+          COMPREPLY=( $(compgen -W "${files}" -- ${cur}) )
+          return 0
+          ;;
+        *)
+          local tags="--tags --rename --opendoc $(find . -maxdepth 1 -type f -iname '*.pdf')"
+          COMPREPLY=( $(compgen -W "${tags}" -- ${cur}) )
+          return 0
+          ;;
+      esac
+
+      ;;
+    clean) # Clean some stuff
+      case "${prev}" in
+        -t|--tags)
+          local tags='all author keywords title subject createdate'
+          COMPREPLY=( $(compgen -W "${tags}" -- ${cur}) )
+          return 0
+          ;;
+        all|author|keywords|title|subject|createdate)
+          local parameter="$(ls *.pdf)"
+          COMPREPLY=( $(compgen -W "${parameter}") )
+          return 0
+          ;;
+        
+        *)
+          local parameter="--tags $(find . -maxdepth 1 -type f -iname '*.pdf')"
+          COMPREPLY=( $(compgen -W "${parameter}") )
+          return 0
+          ;;
+      esac
+      ;;
+    config) # Config pdfmd
+      case "${prev}" in
+        edit|clean|rename|sort|stat)
+          local parameter=''
+          COMPREPLY=( $(compgen -W "${parameter}") )
+          return 0
+          ;;
+        *)
+          local parameter="clean edit rename sort stat"
+          COMPREPLY=( $(compgen -W "${parameter}") )
+          return 0
+          ;;
+      esac
+      ;;
+    rename) # Rename files
+      case "${prev}" in
+        -k|--nrkeywords)
+          local parameter="3"
+          COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+          return 0
+          ;;
+        -o|--outputdir)
+          return 0
+          ;;
+        *)
+          local parameter="--dryrun --allkeywords --nrkeywords --outputdir --copy $(ls *.pdf)"
+          COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+          return 0
+          ;;
+      esac
+      ;;
+    show) # Show status of files
+
+      case "${prev}" in
+        -t|--tags)
+          COMPREPLY=( $(compgen -W "${tags}" -- ${cur}) )
+          return 0
+          ;;
+        -i|--includepdf)
+          local files=$(find . -maxdepth 1 -type f -iname '*.pdf')
+          COMPREPLY=( $(compgen -W "${files}" -- ${cur}) )
+          return 0
+          ;;
+        -f|--format)
+          local format='hash json yaml csv'
+          COMPREPLY=( $(compgen -W "${format}" -- ${cur}) )
+          return 0
+          ;;
+        all|author|keywords|title|subject|createdate)
+          local files=$(ls *.pdf)
+          COMPREPLY=( $(compgen -W "${files}" -- ${cur}) )
+          return 0
+          ;;
+        *)
+          local parameter="--tags --format $(find . -maxdepth 1 -type f -iname '*.pdf')"
+          COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+          return 0
+          ;;
+      esac
+      ;;
+    sort) # Sorting files
+      case "$prev" in
+        -d|--destination)
+          local directories="$(find . -maxdepth 1 -type d)"
+          COMPREPLY=( $(compgen -W "${directories}" -- ${cur} ) )
+          return 0
+          ;;
+        *)
+          local parameter="--destination --copy --overwrite --dryrun --interactive --typo $(find . -maxdepth 1 -type f -iname '*.pdf')" 
+          COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+          return 0
+          ;;
+      esac
+      
+      # Default output
+      local parameter="--destination --copy --overwrite --dryrun --typo $(find . -maxdepth 1 -type f -iname '*.pdf')"
+      COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+      return 0
+
+      ;;
+    stat)
+
+      case "${prev}" in
+        -r|--recursive)
+          local parameter="$(find . -maxdepth 1 -type d)"
+          COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+          return 0
+          ;;
+        -t|--tags)
+          local tags='all author keywords title subject createdate'
+          COMPREPLY=( $(compgen -W "${tags}" -- ${cur}) )
+          return 0
+          ;;
+        *)
+          local parameter="--recursive --tags $(find . -maxdepth 1 -type d)"
+          COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+          return 0
+          ;;
+      esac
+
+      # Default output
+      local parameter="-t -ri $(find . -maxdepth 1 -type d)"
+      COMPREPLY=( $(compgen -W "${parameter}" -- ${cur}) )
+      return 0
+      ;;
+    *)
+      ;;
+  esac
+
+  COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+}
+complete -o default -F _pdfmd pdfmd

data/lib/pdfmd/pdfmdinit.rb

@@ -0,0 +1,8 @@
+# file: pdfmdinit.rb
+# Logik to setup environment
+require_relative './pdfmdmethods.rb'
+
+#class Pdfmdinit
+#  puts Dir.pwd()
+#end
+

data/lib/pdfmd/pdfmdmethods.rb

@@ -127,3 +127,48 @@ module Pdfmdmethods
   end # End of queryHiera
 
 end
+
+#
+# Initializing or removing the bash_completion file
+def init_bashcompletion(name, version, remove = false)
+
+  # Find the current local path where the original bash completion file might be hiding.
+  paths = [
+    "#{File.dirname(File.expand_path($0))}../lib",
+    "#{Gem.dir}/gems/#{name}-#{version}/lib",
+  ]
+  bash_completion_destination = '/etc/bash_completion.d/pdfmd.bash'
+  bash_completion_destination_backup = bash_completion_destination + '.backup'
+
+  paths.each do |value|
+    bash_completion_source = value + '/' + name + '/pdfmd.bash'
+    if File.exists?(bash_completion_source)
+
+      if !remove
+
+        # Create a backup file when a file is found
+        if File.exists?(bash_completion_destination)
+          puts 'Existing file found.Taking backup.'
+          `sudo cp #{bash_completion_destination} #{bash_completion_destination_backup}`
+        end
+        puts 'Installing ' + bash_completion_destination
+        `sudo cp #{bash_completion_source} #{bash_completion_destination}`
+      else
+
+        if File.exists?(bash_completion_destination)
+          puts 'Removing ' + bash_completion_destination
+          `sudo rm #{bash_completion_destination}`
+          if $?.exitstatus == 0
+            puts 'File successfully removed.'
+          end
+        else
+          puts bash_completion_destination + ' not found.'
+        end
+
+      end
+
+    end
+  end
+
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfmd
 version: !ruby/object:Gem::Version
-  version: 2.3.5
+  version: 2.4.0
 platform: ruby
 authors:
 - Daniel Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -147,14 +147,17 @@ files:
 - lib/pdfmd/long_desc.pdfmdconfig.txt
 - lib/pdfmd/long_desc.pdfmdedit.txt
 - lib/pdfmd/long_desc.pdfmdexplain.txt
+- lib/pdfmd/long_desc.pdfmdinit.txt
 - lib/pdfmd/long_desc.pdfmdrename.txt
 - lib/pdfmd/long_desc.pdfmdshow.txt
 - lib/pdfmd/long_desc.pdfmdsort.txt
 - lib/pdfmd/long_desc.pdfmdstat.txt
 - lib/pdfmd/methods.rb
+- lib/pdfmd/pdfmd.bash
 - lib/pdfmd/pdfmdclean.rb
 - lib/pdfmd/pdfmdconfig.rb
 - lib/pdfmd/pdfmdedit.rb
+- lib/pdfmd/pdfmdinit.rb
 - lib/pdfmd/pdfmdmethods.rb
 - lib/pdfmd/pdfmdrename.rb
 - lib/pdfmd/pdfmdshow.rb
@@ -171,8 +174,8 @@ homepage: https://github.com/Micronarrativ/ruby-pmd
 licenses:
 - MIT
 metadata:
-  created: '2016-06-07 20:15:26'
-  revision: '20160607201526'
+  created: '2016-08-20 18:26:13'
+  revision: '20160820182613'
 post_install_message: ". Run `pdfmd` to see the command help."
 rdoc_options: []
 require_paths:
@@ -190,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - "[exiftools](http://www.sno.phy.queensu.ca/~phil/exiftool/)"
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: pdfmd - pdf-meta-data management