pdf_paradise 0.1.43

data/lib/pdf_paradise/commandline/help.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/commandline/help.rb'
+# =========================================================================== #
+module PdfParadise
+
+  # ========================================================================= #
+  # === PdfParadise.gold
+  # ========================================================================= #
+  def self.gold(i = '')
+    if Object.const_defined? :Colours
+      i = Colours.gold(i)
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.show_help
+  #
+  # Show the documented help options of the PdfParadise project.
+  #
+  # To invoke this method from the commandline, do:
+  #
+  #   pdf_paradise --help
+  #
+  # ========================================================================= #
+  def self.show_help
+    e 'The available options are:'
+    e
+    e gold('  pdf_paradise --use-this-pdf-file=foobar.pdf --set_title="Hello world!"')
+    e
+    e "    ^^^ this can be used to modify a .pdf's title"
+    e
+    e gold('  pdf_paradise --shrink-pdf-size-of=foobar.pdf')
+    e
+    e "    ^^^ this can be used to shrinke a .pdf file"
+    e
+    e gold('  pdf_paradise --store-open-pdf-files')
+    e
+    e '    ^^^ store all currently open .pdf files into a local file.'
+    e
+    e gold('  pdf_paradise --open-last-pdf-files')
+    e
+    e '    ^^^ open the last opened .pdf files via a local PDF reader.'
+    e
+    e gold('  pdf_paradise --show_last_opened_pdf_files')
+    e
+    e '    ^^^ show which .pdf files were last open.'
+    e
+    e gold('  pdf_paradise --gui')
+    e gold('  pdf_paradise --gtk')
+    e
+    e '    ^^^ to start the ruby-gtk2 bindings for the pdf_paradise.'
+    e
+    e gold('  pdf_paradise --autoconvert')
+    e
+    e '    ^^^ to autoconvert all .pdf files in the main directory '\
+      'into standalone .pdf files.'
+    e
+    e gold('  pdf_paradise --sinatra')
+    e
+    e '    ^^^ start the (minimal) sinatra-interface of the pdf_paradise '\
+      'project'
+    e
+  end
+
+end

data/lib/pdf_paradise/commandline/menu.rb

@@ -0,0 +1,160 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/commandline/menu.rb'
+# =========================================================================== #
+require 'pdf_paradise/set_pdf_title.rb'
+require 'pdf_paradise/toplevel_methods/e.rb'
+require 'pdf_paradise/toplevel_methods/reduce_size_of_this_pdf_file.rb'
+require 'pdf_paradise/toplevel_methods/opened_pdf_files.rb'
+require 'pdf_paradise/commandline/help.rb'
+
+module PdfParadise
+
+  # ========================================================================= #
+  # === @use_this_pdf_file
+  # ========================================================================= #
+  @use_this_pdf_file = nil
+
+  # ========================================================================= #
+  # === PdfParadise.set_use_this_pdf_file
+  # ========================================================================= #
+  def self.set_use_this_pdf_file(i)
+    @use_this_pdf_file = i.to_s.dup
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.autoconvert_pdf_files_in_the_main_directory
+  # ========================================================================= #
+  def self.autoconvert_pdf_files_in_the_main_directory
+    require 'pdf_paradise/utility_scripts/split_pdf.rb'
+    target = "#{AUTOCONVERT_PDF_FILES_RESIDING_IN_THIS_DIRECTORY}*.pdf"
+    all_pdf_files = Dir[target]
+    if all_pdf_files.empty?
+      e "No files found at #{target}."
+    else
+      all_pdf_files.each {|this_pdf_file|
+        PdfParadise.split_this_pdf_file(
+          this_pdf_file,
+          1,
+          AUTOCONVERT_PDF_FILES_RESIDING_IN_THIS_DIRECTORY
+        )
+      }
+    end
+  end; self.instance_eval { alias autoconvert_pdf_files autoconvert_pdf_files_in_the_main_directory } # === PdfParadise.autoconvert_pdf_files
+
+  # ========================================================================= #
+  # === PdfParadise.menu
+  # ========================================================================= #
+  def self.menu(i)
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === pdfparadise --controller
+      # ===================================================================== #
+      when /^-?-?controller$/
+        require 'pdf_paradise/gui/gtk3/controller/controller.rb'
+        PdfParadise::GUI::Gtk::Controller.run
+      # ===================================================================== #
+      # === --use-this-pdf-file=DONE_Life_History_Evolution_WS_17_4.pdf
+      # ===================================================================== #
+      when /^-?-?use(-|_)?this(-|_)?pdf(-|_)?file=(.+)$/, # === $4
+           /^-?-?set(-|_)?pdf(-|_)?title=(.+)$/,          # === $3
+           /^-?-?use(-|_)?this(-|_)?title=(.+)$/          # === $4
+        i = $3 # <- This is for the second line ^^^.
+        i = $4 if $4 # <- And this is for the first line.
+        set_use_this_pdf_file(i)
+      # ===================================================================== #
+      # === pdf_paradise --sinatra
+      # ===================================================================== #
+      when /^-?-?sinatra$/i,
+           /^-?-?www$/i # === pdf_paradise --www
+        require 'pdf_paradise/www/sinatra/app.rb'
+        PdfParadise.start_sinatra_interface
+      # ===================================================================== #
+      # === pdf_paradise --autoconvert
+      # ===================================================================== #
+      when /^-?-?autoconvert$/i
+        autoconvert_pdf_files_in_the_main_directory
+      # ===================================================================== #
+      # === pdf_paradise --gui
+      # === pdf_paradise --gtk
+      # ===================================================================== #
+      when /^-?-?gui$/,
+           /^-?-?gtk$/
+        require 'pdf_paradise/gui/gtk2/split_pdf_file/split_pdf_file.rb'
+        PdfParadise.start_gtk_gui
+      # ===================================================================== #
+      # === pdf_paradise --show_last_opened_pdf_files
+      # ===================================================================== #
+      when /^-?-?show(-|_)?last(-|_)?opened(-|_)?pdf(-|_)?files$/i,
+           /^-?-?pdf(-|_)?file(-|_)?content$/i, # pdfparadise --pdf-file-content
+           /^-?-?last(-|_)?open(-|_)?pdf\??$/i,
+           /^-?-?last-pdf$/i,
+           /^-?-?last\??$/i,
+           /^-?-?pdf\??$/i # pdfparadise --pdf?
+        PdfParadise.show_last_opened_pdf_files
+      # ===================================================================== #
+      # === pdfparadise --store-open-pdf-files
+      # ===================================================================== #
+      when /^-?-?store(-|_| )?open(-|_| )?pdf(-|_| )?files$/,
+           /^-?-?store(-|_| )?open(-|_| )?pdfs?$/,
+           /^-?-?store(-|_| )?pdf(-|_| )?files$/,
+           /^-?-?store(-|_| )?pdfs$/
+        PdfParadise.store_all_currently_open_pdf_files
+      # ===================================================================== #
+      # === pdf_paradise --array-all-currently-opened-pdf-files
+      # ===================================================================== #
+      when /^-?-?array(-|_| )?all(-|_| )?currently(-|_| )?opened(-|_| )?pdf(-|_| )?files$/i,
+           /^-?-?show(-|_| )?currently(-|_| )?open(-|_| )?pdf(-|_| )?files$/i
+        PdfParadise.return_array_of_all_currently_opened_pdf_files(:do_not_run_locate).each {|entry|
+          e entry
+        }
+      # ===================================================================== #
+      # === pdfparadise --open-last-pdf-files
+      # ===================================================================== #
+      when /^-?-?open(-|_| )?last(-|_| )?pdf(-|_| )?files$/,
+           /^-?-?open(-|_| )?last(-|_| )?opened(-|_| )?pdf(-|_| )?files$/,
+           /^-?-?open(-|_| )?last(-|_| )?pdfs$/,
+           /^-?-?main$/, # <- This is the main task (main tag)
+           /^-?-?restore$/
+        PdfParadise.open_last_opened_pdf_files
+      # ===================================================================== #
+      # === pdf_paradise --shrink-pdf-size-of=foobar.pdf
+      # ===================================================================== #
+      when /^-?-?shrink(-|_)?pdf(-|_)?size(-|_)?of=(.+)/i,
+           /^-?-?shrink=(.+)/i
+        this_file = $1.to_s.dup
+        this_file = $4.to_s.dup if $4
+        reduce_size_of_this_pdf_file(this_file)
+      # ===================================================================== #
+      # === pdf_paradise --help
+      # ===================================================================== #
+      when /^-?-?help/
+        show_help
+      # ===================================================================== #
+      # === --set_title="Hello world!"
+      # ===================================================================== #
+      when /^--set(-|_)?title=(.+)$/,
+           /^--title=(.+)$/
+        # =================================================================== #
+        # @use_this_pdf_file has to have been set properly before calling
+        # this method.
+        # =================================================================== #
+        i = $1
+        i = $2 if $2
+        PdfParadise.set_title_of_this_pdf_file(@use_this_pdf_file, i)
+      else
+        e "Unknown command: #{i}" unless File.exist? i
+      end
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise.menu(ARGV)
+end

data/lib/pdf_paradise/compress_this_pdf_file.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: false
+# =========================================================================== #
+# === PdfParadise::CompressThisPdfFile
+#
+# This class can be used to compress a .pdf file.
+#
+# Usage example:
+#
+#   PdfParadise::CompressThisPdfFile.new(ARGV)
+#
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+class CompressThisPdfFile < ::PdfParadise::Base # === PdfParadise::CompressThisPdfFile
+
+  include SaveFile
+  include FileUtils::Verbose
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  #
+  # Note that using /ebook rather than /prepress would reduce the file
+  # size even further.
+  # ========================================================================= #
+  def run
+    commandline_arguments?.each {|this_file|
+      store_into_this_file = 'compressed_PDF_file.pdf'
+      cmd = "gs -sDEVICE=pdfwrite -dCompatibilityLevel=1.4 "\
+            "-dPDFSETTINGS=/prepress "\
+            "-dNOPAUSE -dQUIET -dBATCH -sOutputFile=#{store_into_this_file} #{this_file}"
+      e
+      e Colours.rev+
+        'The compressed .pdf file will be stored here: '+
+        sfile(store_into_this_file)
+      e
+      esystem cmd
+      e
+    }
+  end
+
+end
+
+# =========================================================================== #
+# === PdfParadise.compress_this_pdf_file
+# =========================================================================== #
+def self.compress_this_pdf_file(i = ARGV)
+  PdfParadise::CompressThisPdfFile.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::CompressThisPdfFile.new(ARGV)
+end # compressthispdffile

data/lib/pdf_paradise/constants/constants.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/constants/constants.rb'
+# =========================================================================== #
+module PdfParadise
+
+  # ========================================================================= #
+  # === HOME_DIRECTORY_OF_USER_X
+  # ========================================================================= #
+  if ENV['USERS']
+    HOME_DIRECTORY_OF_USER_X = ENV['USERS'].to_s+'/x/'
+  else
+    HOME_DIRECTORY_OF_USER_X = '/home/x/'
+  end
+
+  # ========================================================================= #
+  # === MAIN_PDF_YAML_FILE
+  # ========================================================================= #
+  MAIN_PDF_YAML_FILE =
+    "#{HOME_DIRECTORY_OF_USER_X}programming/ruby/src/roebe/lib/roebe/yaml/"\
+    "main_pdf.yml"
+
+  # ========================================================================= #
+  # === FILE_ALL_CURRENTLY_OPENED_PDF_FILES
+  # ========================================================================= #
+  FILE_ALL_CURRENTLY_OPENED_PDF_FILES = 
+    '/home/Temp/all_currently_opened_pdf_files.md'
+
+  # ========================================================================= #
+  # === AUTOCONVERT_PDF_FILES_RESIDING_IN_THIS_DIRECTORY
+  # ========================================================================= #
+  AUTOCONVERT_PDF_FILES_RESIDING_IN_THIS_DIRECTORY = '/ingrid/pdf/'
+
+  # ========================================================================= #
+  # === PdfParadise.main_directory?
+  # ========================================================================= #
+  def self.main_directory?
+    AUTOCONVERT_PDF_FILES_RESIDING_IN_THIS_DIRECTORY
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.file_main_pdf_yaml_file?
+  # ========================================================================= #
+  def self.file_main_pdf_yaml_file?
+    MAIN_PDF_YAML_FILE
+  end; self.instance_eval { alias file_pdf_viewer? file_main_pdf_yaml_file? } # === PdfParadise.file_pdf_viewer?
+
+  # ========================================================================= #
+  # === PdfParadise.pdf_viewer?
+  #
+  # Use the default and registered .pdf viewer.
+  # ========================================================================= #
+  def self.pdf_viewer?(i = file_main_pdf_yaml_file?)
+    YAML.load_file(i)
+  end
+
+end

data/lib/pdf_paradise/convert_text_to_pdf.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::ConvertTextToPdf
+#
+# Use this class to convert a text file to a .pdf file.
+#
+# Usage examples:
+#   PdfParadise::ConvertTextToPdf.new
+# ============================================================================ #
+require 'pdf_paradise/requires/colours.rb'
+
+module PdfParadise
+
+class ConvertTextToPdf # require 'convert_text_to_pdf'; ConvertTextToPdf.new
+
+  include Colours
+
+  # ========================================================================= #
+  # === FONT_FAMILY
+  # ========================================================================= #
+  FONT_FAMILY = 'Courier'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i = nil,
+      run_already = true
+    )
+    set_input(i)
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset # reset tag
+    @font_family = FONT_FAMILY
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === convert_this_text_file
+  #
+  # Use enscript to created a .ps file, and then ps2pdf
+  # (or ps2pdfwr) to convert to .pdf
+  #
+  # The following script creates a .pdf file with 10 pt
+  # left and right margins, and uses a courier font that
+  # is 7.3 pts wide and 10 pts high, so a 132 col printout
+  # fits on an 8 1/2 X 11 page. Use enscript to setup your
+  # page, fonts, etc.
+  # ========================================================================= #
+  def convert_this_text_file(i = @input)
+    if File.exist? i
+      _ 'enscript -B --margins=10:10: -o outputfile.ps -f '+
+        @font_family+'@7.3/10 '+i 
+      _ 'ps2pdfwr outputfile.ps x.pdf'
+    else
+      e 'Sorry, there is no file at '+i+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === _
+  # ========================================================================= #
+  def _(i)
+    e i
+    system i
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run # (run tag)
+    convert_this_text_file
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::ConvertTextToPdf.new(ARGV)
+end # text_to_pdf