pdf_paradise 0.3.20

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,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/esystem.rb'
+# =========================================================================== #
+module PdfParadise
+
+  require 'pdf_paradise/colours/colours.rb'
+  require 'pdf_paradise/toplevel_methods/e.rb'
+
+  # ========================================================================= #
+  # === PdfParadise.esystem
+  # ========================================================================= #
+  def self.esystem(i)
+    e "#{rev}#{i}"
+    system i
+  end
+
+end

data/lib/pdf_paradise/toplevel_methods/misc.rb

@@ -0,0 +1,228 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/toplevel_methods/misc.rb'
+# PdfParadise.use_which_file?
+# PdfParadise.djvu_to_pdf
+# PdfParadise.do_require_the_utility_scripts
+# =========================================================================== #
+module PdfParadise
+
+  require 'pdf_paradise/toplevel_methods/esystem.rb'
+  require 'pdf_paradise/requires/colours.rb'
+
+  # ========================================================================= #
+  # === @use_this_file
+  #
+  # This variable can be used to keep track of the current .pdf file
+  # the PdfParadise gem operates on - for instance, from which the
+  # first page has been deleted from.
+  # ========================================================================= #
+  @use_this_file = nil
+
+  # ========================================================================= #
+  # === PdfParadise.use_which_file?
+  # ========================================================================= #
+  def self.use_which_file?
+    @use_this_file
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.set_use_this_file
+  # ========================================================================= #
+  def self.set_use_this_file(i)
+    @use_this_file = i
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.set_author
+  #
+  # This method can be used to set the author of a given .pdf file.
+  #
+  # The external tool called "exiftool" is required for this.
+  # ========================================================================= #
+  def self.set_author(
+      of_this_pdf_file,
+      this_author = 'foobar'
+    )
+    _ = 'exiftool -Author="'+this_author+'" '+of_this_pdf_file
+    esystem(_)
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.n_pdf_files_in_this_directory
+  # ========================================================================= #
+  def self.n_pdf_files_in_this_directory(
+      i
+    )
+    Dir[i+'**/**.pdf'].size
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.djvu_to_pdf
+  #
+  # This method can be used to convert a .djvu file to a .pdf file.
+  # ========================================================================= #
+  def self.djvu_to_pdf(i)
+    if i.is_a? Array
+      i = i.join(' ').strip
+    end
+    output_file = 'output_file.pdf'
+    esystem "djvups #{i} | ps2pdf - #{output_file}"
+    return output_file
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.number_this_pdf_file
+  #
+  # This method can be used to number a given .pdf file - that is to add
+  # numbers to this file, typically on the bottom right area (by default).
+  #
+  # Specific usage example:
+  #
+  #   PdfParadise.number_this_pdf_file('foobar.pdf')
+  #
+  # ========================================================================= #
+  def self.number_this_pdf_file(
+      this_pdf_file,
+      font_size_to_use = 30
+    )
+    [this_pdf_file].flatten.each {|pdf_file|
+      x = pdf_file
+      require 'combine_pdf'
+      pdf = CombinePDF.load(x)
+      pdf.number_pages(
+        location:      [:bottom_right],
+        number_format: ' %s ',
+        border_width:  1,
+        font_size:     font_size_to_use
+      )
+      pdf.save "numbered_pages.pdf"
+    }
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.remove_html
+  #
+  # Usage example:
+  #
+  #   PdfParadise.remove_html('<one>two</three>')
+  #
+  # ========================================================================= #
+  def self.remove_html(i)
+    i.gsub(
+      %r{<[^>]+>},
+      ''
+    )
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.ensure_that_the_log_directory_exists
+  # ========================================================================= #
+  def self.ensure_that_the_log_directory_exists
+    require 'fileutils'
+    log_dir = PdfParadise.log_dir?
+    unless File.directory? log_dir
+      begin
+        FileUtils.mkdir_p(log_dir)
+        return log_dir # And return it here, just in case.
+      rescue LoadError; end
+    end
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.cd_to_the_log_directory
+  # ========================================================================= #
+  def self.cd_to_the_log_directory
+    Dir.chdir(PdfParadise.log_dir?)
+  end; self.instance_eval { alias cd_to_the_log_dir cd_to_the_log_directory } # === PdfParadise.cd_to_the_log_dir
+
+  # ========================================================================= #
+  # === 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)}"
+    }
+    # ======================================================================= #
+    # And some ad-hoc requires:
+    # ======================================================================= #
+    require 'pdf_paradise/utility_scripts/delete_the_first_page_of_this_pdf_file/delete_the_first_page_of_this_pdf_file.rb'
+  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
+
+  # ========================================================================= #
+  # === PdfParadise.is_on_windows?
+  # ========================================================================= #
+  def self.is_on_windows?
+    case RUBY_PLATFORM
+    when /win/,
+         /mingw/
+      true
+    else
+      false
+    end
+  end; self.instance_eval { alias on_windows? is_on_windows? } # === PdfParadise.on_windows?
+
+  require 'tmpdir'
+  # ========================================================================= #
+  # === PdfParadise.log_dir?
+  #
+  # This method must return a proper temp-dir (temporary directory),
+  # both on a Linux system, as well as on a windows system.
+  #
+  # Why is this necessary?
+  #
+  # Some operations of the pdf_paradise gem require access to such a
+  # a temp-directory.
+  # ========================================================================= #
+  def self.log_dir?
+    _ = '/tmp/pdf_paradise/' # This is the default. It should work on Linux.
+    _ = Dir.tmpdir
+    _ = ENV['TEMP_DIR'].dup if ENV['TEMP_DIR']
+    _ = _.dup
+    _ << '/pdf_paradise/' unless _.end_with? 
+    return _.squeeze('/')
+  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