pdf_paradise 0.1.66

data/lib/pdf_paradise/toplevel_methods/convert_ppt_to_pdf.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/convert_ppt_to_pdf.rb'
+# =========================================================================== #
+require 'pdf_paradise/toplevel_methods/esystem.rb'
+
+module PdfParadise
+
+  # ========================================================================= #
+  # === PdfParadise.convert_this_ppt_file_to_a_pdf_file
+  #
+  # This method will make use of libreoffice to convert .pptx or
+  # ppt files into .pdf files.
+  # ========================================================================= #
+  def self.convert_this_ppt_file_to_a_pdf_file(
+      i, use_this_format = 'pptx'
+    )
+    if i.is_a? Array
+      i.each {|entry|
+        convert_this_ppt_file_to_a_pdf_file(entry, use_this_format)
+      }
+    else
+      cmd = 'libreoffice --headless --invisible --convert-to pdf *.'+use_this_format
+      esystem cmd
+    end
+  end; self.instance_eval { alias convert_ppt_to_pdf  convert_this_ppt_file_to_a_pdf_file } # === PdfParadise.convert_ppt_to_pdf
+       self.instance_eval { alias convert_pptx_to_pdf convert_this_ppt_file_to_a_pdf_file } # === PdfParadise.convert_pptx_to_pdf
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise.convert_this_ppt_file_to_a_pdf_file(ARGV)
+end

data/lib/pdf_paradise/toplevel_methods/e.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/e.rb'
+# =========================================================================== #
+module PdfParadise
+
+  # ========================================================================= #
+  # === PdfParadise.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/pdf_paradise/toplevel_methods/esystem.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/esystem.rb'
+# =========================================================================== #
+module PdfParadise
+
+  require 'pdf_paradise/toplevel_methods/e.rb'
+
+  # ========================================================================= #
+  # === PdfParadise.esystem
+  # ========================================================================= #
+  def self.esystem(i)
+    e i
+    system i
+  end
+
+end

data/lib/pdf_paradise/toplevel_methods/misc.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/misc.rb'
+# PdfParadise.do_require_the_utility_scripts
+# =========================================================================== #
+module PdfParadise
+
+  require 'pdf_paradise/toplevel_methods/esystem.rb'
+  require 'pdf_paradise/requires/colours.rb'
+
+  # ========================================================================= #
+  # === PdfParadise.log_dir?
+  # ========================================================================= #
+  def self.log_dir?
+    '/tmp/pdf_paradise/'
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.cd_to_the_log_directory
+  # ========================================================================= #
+  def self.cd_to_the_log_directory
+    Dir.chdir(PdfParadise.log_dir?)
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.do_require_the_utility_scripts
+  # ========================================================================= #
+  def self.do_require_the_utility_scripts
+    Dir[project_base_directory?+'utility_scripts/*.rb'].each {|entry|
+      require "pdf_paradise/utility_scripts/#{File.basename(entry)}"
+    }
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.report_which_pdf_viewer_is_in_use
+  #
+  # This method will simply report which pdf-viewer is in use.
+  # ========================================================================= #
+  def self.report_which_pdf_viewer_is_in_use
+    e "#{Colours.rev}The current pdf-viewer in use is "\
+      "#{Colours.sfancy(PdfParadise.pdf_viewer?)}."
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.convert_this_pdf_file_into_a_png_file
+  # ========================================================================= #
+  def self.convert_this_pdf_file_into_a_png_file(
+      this_pdf_file
+    )
+    _ = 'gs -dNOPAUSE -q -r300 -sPAPERSIZE=a4 -dTextAlphaBits=4 -dDownScaleFactor=3 '.dup
+    _ << '-dGraphicsAlphaBits=4 -dUseTrimBox -sDEVICE=png16m -dBATCH '
+    _ << '-sOutputFile="C:\ingrid\pdf\outputfile%d.png" '
+    _ << '-c \"30000000 setvmthreshold\" '
+    _ << '-f "'+this_pdf_file+'" '
+    esystem _
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.convert_postscript_to_pdf
+  #
+  # This method will convert a postscript-file into a .pdf file.
+  # ========================================================================= #
+  def self.convert_postscript_to_pdf(
+      i = 'filein.ps'
+    )
+    _ = 'gs -q -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=fileout.pdf '+i
+    esystem(_)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise.convert_postscript_to_pdf(ARGV)
+end

data/lib/pdf_paradise/toplevel_methods/number_pages.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/number_pages.rb'
+# =========================================================================== #
+module PdfParadise
+
+  require 'pdf_paradise/toplevel_methods/e.rb'
+
+  # ========================================================================= #
+  # === PdfParadise.number_pages
+  # ========================================================================= #
+  def self.number_pages(*these_pdf_files)
+    begin
+      require 'combine_pdf'
+    rescue LoadError; end
+    use_this_font_size = 30
+    these_pdf_files.flatten.each {|this_pdf_file|
+      pdf = CombinePDF.load(this_pdf_file)
+      pdf.number_pages(
+        location: :bottom_right,
+        font_size: use_this_font_size,
+        number_format: ' %s ',
+        margin_from_height:  5, # The default here is 45 normally.
+        margin_from_side:   10  # The default here is 15 normally. 
+      )
+      store_into = this_pdf_file.sub(/\.pdf$/,'')+'_numbered.pdf'
+      e "Storing into #{store_into}"
+      pdf.save store_into
+    }
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise.number_pages(ARGV)
+end # numberpages

data/lib/pdf_paradise/toplevel_methods/opened_pdf_files.rb

@@ -0,0 +1,221 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Code in this file can:
+#
+#   (a) return all opened .pdf files
+#   (b) store all opened .pdf files in a local file.
+#
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/opened_pdf_files.rb'
+# =========================================================================== #
+module PdfParadise
+
+  require 'pdf_paradise/requires/colours.rb'
+  require 'pdf_paradise/constants/constants.rb'
+  require 'pdf_paradise/toplevel_methods/e.rb'
+  require 'pdf_paradise/toplevel_methods/esystem.rb'
+  require 'pdf_paradise/toplevel_methods/roebe.rb'
+
+  # ========================================================================= #
+  # === PdfParadise.return_array_of_all_currently_opened_pdf_files
+  #
+  # To view this array on the commandline, do:
+  #
+  #   pdf_paradise --array-all-currently-opened-pdf-files
+  #
+  # The second argument is a bit buggy and slow, so I disabled it as
+  # of 27.12.2018. It may be re-enabled at a later time (or removed
+  # altogether).
+  #
+  # Usage example from ruby code:
+  #
+  #   array = PdfParadise.return_array_of_all_currently_opened_pdf_files(:extensive)
+  #
+  # ========================================================================= #
+  def self.return_array_of_all_currently_opened_pdf_files(
+      also_run_locate = false
+    )
+    case also_run_locate
+    # ======================================================================= #
+    # === :make_use_of_locate
+    # ======================================================================= #
+    when :make_use_of_locate,
+         :extensive
+      also_run_locate = true
+    # ======================================================================= #
+    # === :do_not_run_locate
+    # ======================================================================= #
+    when :do_not_run_locate
+      also_run_locate = false
+    end
+    ps_ax_result = `ps ax`.split("\n").map(&:strip)
+    array = ps_ax_result.select {|line|
+      line.include? '.pdf'
+    }.map {|inner_liner|
+      # ===================================================================== #
+      # A line here may look like this:
+      #   10970 pts/25   Sl     0:38 evince DONE_MolBiol_?bungen_SS2017_Transfection_english_060220.pdf
+      # For now we split on ' ' and just use the last part.
+      # ===================================================================== #
+      inner_line = inner_liner.split(' ').last.strip
+      # ===================================================================== #
+      # We will also try to locate the file, via "locate". This functionality
+      # depends on findutils' "locate" binary and a prior run of "updatedb".
+      # ===================================================================== #
+      if also_run_locate
+        run_this_command = "locate #{inner_line} 2>&1"
+        # =================================================================== #
+        # The command above ^^^ may look like this:
+        #
+        #   locate DONE_foobar_abc_2006.pdf 2>&1
+        #
+        # =================================================================== #
+        result = `#{run_this_command}`.strip
+        inner_line = result if result and result.include? inner_line
+        if inner_line.include?('?') and !File.exist?(inner_line)
+          inner_line.tr!('?','ä')
+        end
+      end
+      inner_line
+    }
+    return array
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.open_last_opened_pdf_files                     (open tag)
+  #
+  # This method will try to open all the last opened .pdf files. This
+  # functionality depends on having stored these .pdf files in a local
+  # file, which presently has to be done manually (e. g. via the
+  # commandline) rather than automatically.
+  #
+  # Invocation example from the commandline:
+  #
+  #   pdfparadise --open-last-pdf-files
+  #
+  # ========================================================================= #
+  def self.open_last_opened_pdf_files(
+      pdf_viewer_to_use = PdfParadise.pdf_viewer?
+    )
+    _ = FILE_ALL_CURRENTLY_OPENED_PDF_FILES
+    if File.exist? _
+      dataset = YAML.load_file(_)
+      dataset.each {|this_pdf_file|
+        if File.exist? this_pdf_file
+          esystem pdf_viewer_to_use+' "'+this_pdf_file+'" &'
+        else
+          e "No file exists at `#{::Colours.sfile(this_pdf_file)}`."
+        end
+      }
+    else
+      e 'No file exists at `'+sfile(_)+'`.'
+    end
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.show_last_opened_pdf_files
+  # ========================================================================= #
+  def self.show_last_opened_pdf_files
+    _ = FILE_ALL_CURRENTLY_OPENED_PDF_FILES
+    if File.exist? _
+      dataset = YAML.load_file(_)
+      if dataset.empty?
+        e 'No .pdf files have been registered as having been opened.'
+      else
+        e 'The following .pdf files have been opened:'
+        e
+        dataset.each {|this_pdf_file| e "  #{Colours.sfile(this_pdf_file)}" }
+        e
+      end
+    else
+      e 'No file exists at `'+_+'`.'
+    end
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.file_all_currently_opened_pdf_files?
+  # ========================================================================= #
+  def self.file_all_currently_opened_pdf_files?
+    FILE_ALL_CURRENTLY_OPENED_PDF_FILES
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.store_all_currently_opened_pdf_files
+  #
+  # To invoke this method from the commandline, do:
+  #
+  #   pdfparadise --store-open-pdf-files
+  #
+  # ========================================================================= #
+  def self.store_all_currently_opened_pdf_files
+    begin
+      require 'save_file'
+    rescue LoadError; end
+    array = return_array_of_all_currently_opened_pdf_files(:extensive)
+    if array.empty?
+      e 'No .pdf file is currently empty.'
+    else
+      # ===================================================================== #
+      # Designate where to store the open .pdf files.
+      # ===================================================================== #
+      into = FILE_ALL_CURRENTLY_OPENED_PDF_FILES
+      e 'All currently opened .pdf files will be stored into the file'
+      e
+      e "  `#{Colours.sfile(into)}`."
+      e
+      e 'These are the .pdf files that will be stored:'
+      e
+      array.each {|this_file|
+        e "  #{Colours.sfile(this_file)}"
+      }
+      e
+      what = YAML.dump(array)
+      SaveFile.write_what_into(what, into)
+      if is_on_roebe?
+        update_main_pdf_entries(array)
+        into = '/home/x/programming/ruby/src/pdf_paradise/lib/pdf_paradise/yaml/working_on_these_pdf_files.yml'
+        e 'As we are on roebe, we will also store into the pdf-paradise'
+        e "project's designated yaml file at:"
+        e
+        e "  #{Colours.sfile(into)}"
+        e
+        SaveFile.write_what_into(what, into)
+      end
+    end
+  end; self.instance_eval { alias store_all_currently_open_pdf_files store_all_currently_opened_pdf_files } # === PdfParadise.store_all_currently_open_pdf_files
+       self.instance_eval { alias save_open_pdf_files                store_all_currently_opened_pdf_files } # === PdfParadise.save_open_pdf_files
+
+  # ========================================================================= #
+  # === PdfParadise.update_main_pdf_entries
+  #
+  # This method will update entries for e. g. openpdf1, openpdf2 and
+  # so forth.
+  # ========================================================================= #
+  def self.update_main_pdf_entries(
+      use_this_array = :try_to_use_the_main_file
+    )
+    begin
+      require 'roebe/classes/open_pdf.rb'
+    rescue LoadError; end
+    unless use_this_array.is_a? Array
+      case use_this_array
+      when :try_to_use_the_main_file
+        _ = file_all_currently_opened_pdf_files?
+        if File.exist? _
+          use_this_array = File.readlines(_).map(&:strip)
+        end
+      end
+    end
+    use_this_array.each_with_index {|pdf_location, pdf_number_to_use| pdf_number_to_use += 1
+      Roebe.set_pdf_for_this_number(pdf_number_to_use, pdf_location)
+    }
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp PdfParadise.return_array_of_all_currently_opened_pdf_files
+  PdfParadise.store_all_currently_opened_pdf_files  
+end # openedpdffiles

data/lib/pdf_paradise/toplevel_methods/query_pdf_title.rb

@@ -0,0 +1,191 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::QueryPdfTitle
+#
+# This class will simply report the title of a .pdf file (or more accurately,
+# all .pdf files that were passed to this class).
+#
+# Presently this depends on exiftool, but there are other ways how to
+# query the title of a .pdf file, such as via prawn.
+#
+# However had, for the time being, we will depend on exiftool.
+#
+# The shell-invocation command for this would be:
+#
+#   exiftool *.pdf | grep Title
+#
+# Usage example:
+#
+#   PdfParadise::QueryPdfTitle.new(ARGV)
+#
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/query_pdf_title.rb'
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+class QueryPdfTitle < Base # === PdfParadise::QueryPdfTitle
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    if block_given?
+      yielded = yield
+      case yielded
+      when :be_verbose
+        @be_verbose = true
+      when :be_quiet
+        @be_verbose = false
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @be_verbose
+    # ======================================================================= #
+    @be_verbose = true
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = [i] unless i.is_a? Array
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end; alias pdf_files? input? # === pdf_files?
+
+  # ========================================================================= #
+  # === iterate_over_the_input_files
+  # ========================================================================= #
+  def iterate_over_the_input_files
+    use_this_regex = /^Title\s*: (.+)$/
+    pdf_files?.each {|this_pdf_file|
+      if File.exist? this_pdf_file
+        sys_cmd = `exiftool #{this_pdf_file}`
+        begin
+          @title = sys_cmd.scan(use_this_regex).flatten.first
+        rescue ArgumentError => error
+          e 'An error happened for '+sfile(this_pdf_file)+'.'
+          pp error
+          pp error.class
+          exit
+        end
+        if @be_verbose
+          e "The title for `#{sfile(this_pdf_file)}` is:"
+          e
+          e "  #{sfancy(@title)}"
+          e
+        end
+      else
+        opnn(namespace: @namespace); e "No file exists at `#{sfile(this_pdf_file)}`."
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === title?
+  # ========================================================================= #
+  def title?
+    @title
+  end
+
+  # ========================================================================= #
+  # === string?
+  #
+  # This variant will always return a String - an empty String if the .pdf
+  # file has no title set.
+  # ========================================================================= #
+  def string?
+    title?.to_s
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    iterate_over_the_input_files
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::QueryPdfTitle[]
+  # ========================================================================= #
+  def self.[](i = '')
+    self.new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === PdfParadise.does_this_pdf_file_have_a_title?
+#
+# This method can be used to query whether a given .pdf file has a title
+# or whether it does not.
+#
+# Usage example:
+#
+#   PdfParadise.does_this_pdf_file_have_a_title? "foobar.pdf" # => true
+#
+# =========================================================================== #
+def self.does_this_pdf_file_have_a_title?(i)
+  !query_pdf_title(i).empty?
+end
+
+# =========================================================================== #
+# === PdfParadise.pdf_has_no_title?
+# =========================================================================== #
+def self.pdf_has_no_title?(i)
+  !does_this_pdf_file_have_a_title?(i)
+end
+
+# =========================================================================== #
+# === PdfParadise.query_pdf_title
+#
+# The input to this method should be an existing .pdf file.
+#
+# Usage example:
+#
+#   title = PdfParadise.query_pdf_title('/foobar.pdf') # => "Lecture 2 - Scaling"
+#
+# =========================================================================== #
+def self.query_pdf_title(i)
+  PdfParadise::QueryPdfTitle.new(i) { :be_quiet }.string?
+end; self.instance_eval { alias return_pdf_title_of           query_pdf_title } # === PdfParadise.return_pdf_title
+     self.instance_eval { alias return_title_of_this_pdf_file query_pdf_title } # === PdfParadise.return_title_of_this_pdf_file
+     self.instance_eval { alias title?                        query_pdf_title } # === PdfParadise.title?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::QueryPdfTitle.new(ARGV)
+end # querypdftitle

data/lib/pdf_paradise/toplevel_methods/reduce_size_of_this_pdf_file.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/reduce_size_of_this_pdf_file.rb'
+# =========================================================================== #
+module PdfParadise
+
+  require 'pdf_paradise/toplevel_methods/e.rb'
+
+  begin
+    require 'esystem'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === PdfParadise.reduce_size_of_this_pdf_file
+  #
+  # This method can be used to reduce the size of the passed .pdf file.
+  #
+  # This functionality depends on ghostscript (on the "gs" binary,
+  # specifically).
+  # ========================================================================= #
+  def self.reduce_size_of_this_pdf_file(this_pdf_file)
+    if this_pdf_file.is_a? Array
+      this_pdf_file.each {|entry|
+        reduce_size_of_this_pdf_file(entry)
+      }
+    else
+      guessed_name = File.basename(this_pdf_file).sub(/#{File.extname(this_pdf_file)}$/,'').dup
+      name_of_the_output_file = "output_#{guessed_name}".dup
+      name_of_the_output_file << '.pdf' unless name_of_the_output_file.end_with?('.pdf')
+      e
+      e 'Trying to reduce the size of the file '+this_pdf_file+' next:'
+      e
+      _ = 'gs -sDEVICE=pdfwrite -dCompatibilityLevel=1.4 '\
+          '-dPDFSETTINGS=/screen -dNOPAUSE -dQUIET -dBATCH '\
+          '-sOutputFile='+name_of_the_output_file+' '+this_pdf_file
+      Esystem.esystem(_)
+    end
+  end; self.instance_eval { alias reduce_size reduce_size_of_this_pdf_file } # === PdfParadise.reduce_size
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise.reduce_size_of_this_pdf_file(ARGV)
+end # reduce_size_of_this_pdf_file

data/lib/pdf_paradise/toplevel_methods/roebe.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/roebe.rb'
+# PdfParadise.is_on_roebe?
+# =========================================================================== #
+module PdfParadise
+
+  # ========================================================================= #
+  # === PdfParadise.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+end