pdf_paradise 0.3.20

data/lib/pdf_paradise/main_pdf/main_pdf.rb

@@ -0,0 +1,474 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::MainPdf
+#
+# Use this file to open one or several .pdf files.
+#
+# The convention is that you can pass both commandlines and also
+# filenames on the commandlines.
+#
+# Usage example:
+#
+#   PdfParadise::MainPdf.new
+#
+# =========================================================================== #
+# require 'pdf_paradise/main_pdf/main_pdf.rb'
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+class MainPdf < Base # === PdfParadise::MainPdf
+
+  begin
+    require 'directory_paradise'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === MAIN_PDF_YAML_FILE
+  # ========================================================================= #
+  MAIN_PDF_YAML_FILE = ::PdfParadise.file_main_pdf_yaml_file?
+
+  # ========================================================================= #
+  # === HOME_DIR
+  # ========================================================================= #
+  HOME_DIR = ENV['HOME'].to_s+'/'
+
+  # ========================================================================= #
+  # === LAST_DOWNLOADED_FILE
+  # ========================================================================= #
+  LAST_DOWNLOADED_FILE =
+    "#{HOME_DIR}LAST_DOWNLOADED_FILE.md"
+
+  # ========================================================================= #
+  # === LAST_PDF_FILE_OPENED
+  # ========================================================================= #
+  LAST_PDF_FILE_OPENED =
+    "#{HOME_DIR}LAST_PDF_FILE_OPENED.md"
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument can be an Array or a String, of pdf-files that
+  # we attempt to open.
+  # ========================================================================= #
+  def initialize(
+      these_pdf_files = nil,
+      run_already     = true,
+      &block
+    )
+    reset
+    check_commandline_options(
+      these_pdf_files
+    )
+    case run_already
+    when :do_not_run_yet
+      run_already = false
+    end
+    if block_given?
+      yielded = yield
+      if yielded.is_a? Hash
+        # =================================================================== #
+        # === :open_via_fullscreen
+        # =================================================================== #
+        if yielded.has_key? :open_via_fullscreen
+          @open_via_fullscreen = yielded[:open_via_fullscreen]
+        end
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @pdf_viewer
+    # ======================================================================= #
+    if File.exist? MAIN_PDF_YAML_FILE
+      @pdf_viewer = YAML.load_file(MAIN_PDF_YAML_FILE)
+    else
+      ewarn "The file at `#{MAIN_PDF_YAML_FILE}` was not found."
+    end
+    @pdf_viewer = @pdf_viewer.first if @pdf_viewer.is_a? Array # Use only the first entry for now if we read in an Array.
+    # ======================================================================= #
+    # === @open_these_pdf_files
+    # ======================================================================= #
+    @open_these_pdf_files = []
+    # ======================================================================= #
+    # === @commandline_options
+    # ======================================================================= #
+    @commandline_options  = [] # This array may contain our commandline options.
+    # ======================================================================= #
+    # === @open_via_fullscreen
+    # ======================================================================= #
+    @open_via_fullscreen = false
+  end
+
+  # ========================================================================= #
+  # === save_new_pdf_handler
+  #
+  # The first (and only) argument to this method is which new pdf handler
+  # we will use. Afterwards we will exit.
+  #
+  # To invoke this method, do:
+  #
+  #   mpdf SAVE xournal
+  #   mpdf SAVE okular
+  #
+  # ========================================================================= #
+  def save_new_pdf_handler(
+      i = @commandline_options[1]
+    )
+    i = i.to_s
+    e 'Saving `'+sfancy(i)+'` into `'+sfile(MAIN_PDF_YAML_FILE)+'`.'
+    write_what_where(i, MAIN_PDF_YAML_FILE)
+    exit
+  end
+
+  # ========================================================================= #
+  # === show_yaml_file
+  # ========================================================================= #
+  def show_yaml_file
+    e "The main yaml file is at `#{sfile(main_yaml_file?)}`."
+  end
+
+  # ========================================================================= #
+  # === MAIN_PDF_YAML_FILE
+  # ========================================================================= #
+  def main_yaml_file?
+    MAIN_PDF_YAML_FILE
+  end
+
+  # ========================================================================= #
+  # === feedback_pdf_handler_in_use
+  # ========================================================================= #
+  def feedback_pdf_handler_in_use
+    e 'You currently use this as .pdf handler: '+
+      sfancy(@pdf_viewer)
+  end
+
+  # ========================================================================= #
+  # === check_whether_we_have_found_any_pdf_file
+  #
+  # This method checks whether we have found any .pdf file or not. If not,
+  # we try to check whether the current directory has any .pdf file at all.
+  # ========================================================================= #
+  def check_whether_we_have_found_any_pdf_file
+    if @open_these_pdf_files.empty?
+      any_pdf_file = get_all_pdf_files
+      if ! any_pdf_file.empty?
+        _ = any_pdf_file.first
+        e 'It seems as if no .pdf file was supplied.'
+        e 'We did however find at least one .pdf file. We will now '
+        e 'use this .pdf file at '+sfile(_)+'.'
+        add _
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === edit_this_file_here
+  # ========================================================================= #
+  def edit_this_file_here
+    _ = 'bluefish '+__FILE__
+    esystem _
+  end
+
+  # ========================================================================= #
+  # === do_log_this_pdf_file_was_opened_last
+  # ========================================================================= #
+  def do_log_this_pdf_file_was_opened_last(
+      i = @full_file_location
+    )
+    save_what_into(i, LAST_PDF_FILE_OPENED)
+  end
+
+  # ========================================================================= #
+  # === set_full_file_location
+  # ========================================================================= #
+  def set_full_file_location(i)
+    unless i.include? '/'
+      i = Dir.pwd+'/'+i
+    end
+    @full_file_location = i
+  end
+
+  # ========================================================================= #
+  # === MainPdf[]
+  # ========================================================================= #
+  def self.[](
+      i, optional_commandline_arguments = nil
+    )
+    _ = new(i, :do_not_run_yet)
+    if optional_commandline_arguments
+      _.commandline_arguments = optional_commandline_arguments
+    end
+    _.run
+  end
+
+  # ========================================================================= #
+  # === check_commandline_options
+  #
+  # The convention is simply - if it is a valid file, we 
+  # add it to the list of pdf files to open.
+  # ========================================================================= #
+  def check_commandline_options(i)
+    if i.is_a? Array
+      i.each {|entry| check_commandline_options(entry) }
+    else # We either add it to the list of pdf files to open, or to the commandline options
+      if File.exist? i
+        # =================================================================== #
+        # Open the .pdf file here, if it exists.
+        # =================================================================== #
+        add_to_open_these_pdf_files(i)
+      else
+        @commandline_options << i
+      end
+    end
+  end; alias commandline_arguments= check_commandline_options # === commandline_arguments=
+
+  # ========================================================================= #
+  # === process_commandline_options
+  #
+  # Use this method to process the commandline options given.
+  # ========================================================================= #
+  def process_commandline_options
+    _ = @commandline_options.first
+    case _ # case tag
+    # ======================================================================= #
+    # === mpdf --use-atril
+    # ======================================================================= #
+    when /^-?-?use(-|_)?atril$/i,
+         /^-?-?atril$/i
+      save_new_pdf_handler :atril
+    # ======================================================================= #
+    # === mpdf --use-evince
+    # ======================================================================= #
+    when /^-?-?use(-|_)?evince$/i,
+         /^-?-?EVINCE$/i
+      save_new_pdf_handler :evince
+    # ======================================================================= #
+    # === --open-main-pdf
+    # ======================================================================= #
+    when /^-?-?open(-|_)?main(-|_)?pdf$/i
+      add_to_open_these_pdf_files(:the_main_pdf)
+    # ======================================================================= #
+    # === mpdf --open-last
+    # ======================================================================= #
+    when /^-?-?open(-|_)?last$/i,
+         'OPENLATEST',
+         'LATEST',
+         'LAST','last'
+      open_last_found_pdf
+    # ======================================================================= #
+    # === mpdf --query?
+    # ======================================================================= #
+    when /-?-?query\??/,
+         'QUERY','QUERY?','?','PDF?',/-?-?current\??/
+      feedback_pdf_handler_in_use
+      exit
+    # ======================================================================= #
+    # === mpdf --file?
+    # ======================================================================= #
+    when /-?-?file\??/
+      show_yaml_file
+      exit
+    # ======================================================================= #
+    # === mpdf SAVE okular
+    # ======================================================================= #
+    when 'SAVE',
+         'SET',
+         'save','set','--save','--set'
+      save_new_pdf_handler
+    # ======================================================================= #
+    # === mpdf --help
+    # ======================================================================= #
+    when /-?-?help/,'HELP'
+      feedback_available_commandline_options
+    # ======================================================================= #
+    # === mpdf --restore
+    # ======================================================================= #
+    when /-?-?restore/,'RESTORE'
+      add( File.readlines(LAST_PDF_FILE_OPENED)[0].to_s.strip )
+    # ======================================================================= #
+    # === mpdf --edit
+    # ======================================================================= #
+    when 'EDIT','OPEN','OPEN_SELF','OPENSELF',/edit/
+      edit_this_file_here; exit
+    # ======================================================================= #
+    # === mpdf --okular
+    # ======================================================================= #
+    when 'USE_OKULAR','OKULAR',/^-?-?okular/
+      save_new_pdf_handler :okular
+    # ======================================================================= #
+    # === mpdf --fullscreen
+    # ======================================================================= #
+    when /^-?-?fullscreen$/i
+      @pdf_viewer << ' --fullscreen'
+    # ======================================================================= #
+    # === mpdf LAST_DOWNLOAD
+    # ======================================================================= #
+    when 'LAST_DOWNLOAD','LASTDOWNLOAD'
+      last_downloaded_file = LAST_DOWNLOADED_FILE
+      if File.exist? last_downloaded_file
+        add(File.readlines(last_downloaded_file).first)
+      end
+    else # else step
+      unless File.exist? _
+        opn; e 'Unsure what to do with input `'+simp(_)+'`.'
+      end if _
+    end
+  end
+
+  # ========================================================================= #
+  # === feedback_available_commandline_options                     (help tag)
+  #
+  # Show the available help options next.
+  # ========================================================================= #
+  def feedback_available_commandline_options(
+      shall_we_exit = true
+    )
+    cliner {
+      ecomment '  RESTORE       - open the last opened .pdf file in general'
+      ecomment '  OPEN_LAST     - open the "youngest" .pdf file in the current working directory'
+      ecomment '  EDIT          - open this file here'
+      ecomment '  QUERY         - query which is our current default pdf reader'
+      ecomment '  --current?    - alias to the above'
+      ecomment '  --file?       - show the location of the .yml file'
+      ecomment '  SAVE / SET    - save a new mpdf handler to use (i.e. '\
+               '"okular", via "mpdf SAVE okular")'
+      ecomment '  LAST_DOWNLOAD - open the last downloaded file stored in '+
+                LAST_DOWNLOADED_FILE
+    }
+    exit if shall_we_exit
+  end
+
+  # ========================================================================= #
+  # === get_all_pdf_files
+  # ========================================================================= #
+  def get_all_pdf_files
+    _ = DirectoryParadise::Report.new('', :do_not_run_yetfalse)
+    _.menu(:latest)
+    _.gather_content
+    only_pdf_files = _.content.select {|entry|
+      entry.include? '.pdf'
+    }
+    return only_pdf_files
+  end
+
+  # ========================================================================= #
+  # === open_last_found_pdf
+  #
+  # This will open the last .pdf file in the current directory. Which
+  # one is that? We will act on the file information here.
+  # ========================================================================= #
+  def open_last_found_pdf
+    add :latest_pdf
+  end
+
+  # ========================================================================= #
+  # === add_to_open_these_pdf_files                                 (add tag)
+  # ========================================================================= #
+  def add_to_open_these_pdf_files(i)
+    case i
+    # ======================================================================= #
+    # === :main_pdf
+    # ======================================================================= #
+    when :main_pdf,
+         :the_main_pdf
+      i = ENV['MAIN_BOOK'].to_s
+    # ======================================================================= #
+    # === :latest_pdf
+    # ======================================================================= #
+    when :latest_pdf
+      i = get_all_pdf_files.sort.first.to_s # Get the latest .pdf file. [0] Should be the properly sorted one.
+    end
+    @open_these_pdf_files << i
+  end; alias add add_to_open_these_pdf_files # === add
+
+  # ========================================================================= #
+  # === open_all_pdf_files
+  # ========================================================================= #
+  def open_all_pdf_files(
+      i = @open_these_pdf_files
+    )
+    i.each {|entry|
+      consider_opening_this_pdf_file(entry)
+    }
+  end
+
+  # ========================================================================= #
+  # === run_sys_command
+  # ========================================================================= #
+  def run_sys_command
+    process_commandline_options
+    check_whether_we_have_found_any_pdf_file
+    open_all_pdf_files
+  end
+
+  # ========================================================================= #
+  # === consider_opening_this_pdf_file
+  #
+  # This method will do the actual opening-part, by using system().
+  # ========================================================================= #
+  def consider_opening_this_pdf_file(
+      i                   = @open_these_pdf_files,
+      open_via_fullscreen = @open_via_fullscreen
+    )
+    if File.exist? i
+      set_full_file_location(i)
+      i = '"'+i+'"' if i.include? ' '
+      i = '"'+i+'"' if i.include? '('
+      i = '"'+i+'"' if i.include? "'"
+      extra_options = ' '.dup
+      if open_via_fullscreen
+        extra_options << '--fullscreen '
+      end
+      i = @pdf_viewer+extra_options+i+
+          ' &'
+      do_log_this_pdf_file_was_opened_last
+      esystem i
+    else # Ok, at this point the file does not exist. Try a regex first.
+      results = Dir['*'+i+'*']
+      if results.empty? 
+        opn; e 'No valid .pdf file was found at `'+sfile(i)+'`.'
+        opn; e 'Thus we can not open anything.'
+      else
+        consider_opening_this_pdf_file(results.first)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_sys_command
+  end
+
+end
+
+# =========================================================================== #
+# === PdfParadise.main_pdf
+# =========================================================================== #
+def self.main_pdf(i = ARGV, &block)
+  ::PdfParadise::MainPdf.new(i, &block)
+end
+
+# =========================================================================== #
+# === PdfParadise.use_which_pdf_viewer?
+# =========================================================================== #
+def self.use_which_pdf_viewer?
+  return YAML.load_file(MAIN_PDF_YAML_FILE)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise.main_pdf(ARGV)
+end # mpdf AUPC_Einheit_I_Einfuehrung_2013.pdf  AUPC_Einheit_II_2013.pdf

data/lib/pdf_paradise/merge_pdf/menu.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/merge_pdf/menu.rb'
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+class MergePdf < Base # === PdfParadise::MergePdf
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  #
+  # This is check_against_menu(). We respond to some given input.
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # (case tag)
+      # ===================================================================== #
+      # === --use-hexapdf
+      # ===================================================================== #
+      when /^-?-?use(-|_| )?hexapdf$/i,
+           /^-?-?hexapdf$/i
+        @use_this_program_for_merging_the_pdf_files = :hexapdf
+      # ===================================================================== #
+      # === --use-ghostscript
+      # ===================================================================== #
+      when /^-?-?use(-|_| )?ghostscript$/i,
+           /^-?-?ghostscript$/i
+        @use_this_program_for_merging_the_pdf_files = :ghostscript
+      # ===================================================================== #
+      # === --remove
+      # ===================================================================== #
+      when '1',
+           /^-?-?last$/i,
+           /^-?-?kill$/i,
+           /^-?-?remove$/i
+        remove_merged_files
+        exit
+      # ===================================================================== #
+      # === --openself
+      # ===================================================================== #
+      when '2',
+           /^-?-?openself$/i
+        open_this_file_here
+        exit
+      # ===================================================================== #
+      # === mergepdf --help
+      # ===================================================================== #
+      when /help/
+        show_help
+        exit
+      end
+    end
+  end; alias check_against_menu menu # === check_against_menu
+
+end; end