pdf_paradise 0.3.20

data/doc/todo/todo.md

@@ -0,0 +1,13 @@
+- Add a converter-GUI.
+
+  From .docx to .pdf via libreoffice.
+    ^^^^ support this via that GUI.
+         ^^^ yeah
+
+  ^^ this works but has to be polished still.
+
+
+- add the above alias
+then integrate it into some libui gui or something
+then perhaps jruby or something hmmmmm
+^^^ we need to add more jruby

data/lib/pdf_paradise/base/base.rb

@@ -0,0 +1,344 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/base/base.rb'; < ::PdfParadise::Base
+# =========================================================================== #
+require 'pdf_paradise/requires/colours_and_esystem_and_save_file_and_fileutils_and_opn.rb'
+
+module PdfParadise
+
+class Base # === PdfParadise::Base
+
+  require 'yaml'
+  require 'fileutils'
+  require 'pdf_paradise/base/colours.rb'
+  require 'pdf_paradise/toplevel_methods/roebe.rb'
+  require 'pdf_paradise/toplevel_methods/misc.rb'
+  require 'pdf_paradise/constants/constants.rb'
+
+  begin
+    require 'cliner'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    reset
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @be_verbose
+    # ======================================================================= #
+    @be_verbose = true
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i)
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === set_be_quiet
+  # ========================================================================= #
+  def set_be_quiet
+    @be_verbose = false
+  end
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @be_verbose
+  end
+
+  # ========================================================================= #
+  # === no_file_at
+  #
+  # This method (or its alias) can be used to notify the user that the
+  # given file does not exist at that given location (denoted by the
+  # argument called i).
+  # ========================================================================= #
+  def no_file_at(i)
+    e "No file called `#{sfile(i)}` exists at that target."
+  end; alias no_file_exists_at no_file_at # === no_file_exists_at
+
+  # ========================================================================= #
+  # === is_on_roebe?
+  # ========================================================================= #
+  def is_on_roebe?
+    ::PdfParadise.is_on_roebe?
+  end
+
+  # ========================================================================= #
+  # === return_files_from_the_commandline_arguments
+  #
+  # This method will return all existing files from the commandline
+  # arguments.
+  # ========================================================================= #
+  def return_files_from_the_commandline_arguments
+    @commandline_arguments.select {|entry|
+      File.file?(entry.to_s)
+    }
+  end
+
+  # ========================================================================= #
+  # === return_pwd
+  # ========================================================================= #
+  def return_pwd
+    "#{Dir.pwd}/".squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end; alias input? commandline_arguments? # === input?
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end
+
+  # ========================================================================= #
+  # === input_without_leading_hyphens?
+  #
+  # This method will return the input that will not begin with --.
+  # ========================================================================= #
+  def input_without_leading_hyphens?
+    @commandline_arguments.reject {|entry| entry.start_with? '--' }
+  end
+
+  # ========================================================================= #
+  # === return_commandline_arguments_starting_with_hyphens
+  # ========================================================================= #
+  def return_commandline_arguments_starting_with_hyphens(
+      i = @commandline_arguments
+    )
+    [i].flatten.select {|entry| entry.start_with? '--' }
+  end; alias return_hyphen_arguments return_commandline_arguments_starting_with_hyphens # === return_hyphen_arguments
+
+  # ========================================================================= #
+  # === copy_file
+  # ========================================================================= #
+  def copy_file(
+      from, to = (Dir.pwd+'/').squeeze('/')
+    )
+    if File.exist? from
+      FileUtils.cp(from, to)
+    end
+  end
+
+  # ========================================================================= #
+  # === change_directory                                             (cd tag)
+  # ========================================================================= #
+  def change_directory(i)
+    Dir.chdir(i) if File.directory?(i)
+  end; alias cd change_directory # === cd
+
+  # ========================================================================= #
+  # === write_what_into
+  # ========================================================================= #
+  def write_what_into(
+      what, into
+    )
+    begin
+      require 'save_file/module' unless Object.const_defined?(:SaveFile)
+    rescue LoadError; end
+    if Object.const_defined?(:SaveFile)
+      SaveFile.write_what_into(what, into)
+    else
+      e 'Can not save into '+into+' as the save_file gem '\
+        'is not available/installed.'
+    end
+  end; alias save_what_into write_what_into # === save_what_into
+
+  # ========================================================================= #
+  # === n_pages?
+  #
+  # This method will return how many pages are in the given .pdf file at
+  # hand.
+  # ========================================================================= #
+  def n_pages?(i)
+    unless PdfParadise.const_defined? :PdfFileNTotalPages
+      require 'pdf_paradise/utility_scripts/pdf_file_n_total_pages.rb'
+    end
+    ::PdfParadise.n_pdf_pages?(i) 
+  end
+
+  # ========================================================================= #
+  # === esystem
+  #
+  # This method can be used to execute system-commands.
+  # ========================================================================= #
+  def esystem(i)
+    e steelblue(i)
+    system(i)
+  end
+
+  # ========================================================================= #
+  # === namespace?
+  # ========================================================================= #
+  def namespace?
+    @namespace
+  end
+
+  # ========================================================================= #
+  # === is_an_image_file?
+  # ========================================================================= #
+  def is_an_image_file?(i)
+    i.end_with?(
+      '.jpg','.png','.gif'
+    )
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn(
+      i = namespace?,
+      &block
+    )
+    if i.is_a? String
+      i = { namespace: i }
+    end
+    Opn.opn(i, &block)
+  end
+
+  # ========================================================================= #
+  # === infer_the_namespace
+  #
+  # This will assume the true namespace from the inspectable name.
+  # ========================================================================= #
+  def infer_the_namespace
+    _ = inspect
+    if _.include?(':0x')
+      _ = _.split(':0x').first.to_s.strip
+    end
+    _ = _.to_s.delete('<')
+    if _.include? ' '
+      _ = _.split(' ').first.delete('#')
+      if _.include? ':'
+        _ = _.split(':')[0 .. -2].reject {|entry| entry.empty? }.join('::')
+      end
+    end
+    @namespace = _.delete('#') # And assign it here.
+  end
+
+  # ========================================================================= #
+  # === opne
+  # ========================================================================= #
+  def opne(i = '')
+    opnn; e i
+  end
+
+  # ========================================================================= #
+  # === mv                                     (mv tag, move tag, rename tag)
+  # ========================================================================= #
+  def mv(
+      old,
+      new
+    )
+    # ======================================================================= #
+    # We must check that both files exist, before we delete the new file,
+    # as we may otherwise end up without any .pdf file. This has happened
+    # to me in August 2019 when qpdf failed to do a conversion.
+    # ======================================================================= #
+    if File.file?(new) and File.file?(old)
+      begin
+        File.delete(new)
+      rescue Exception => error
+        pp error
+        e 'Error trying to delete the file '+new+'.'
+      end
+    end
+    if File.exist? old
+      FileUtils.mv(old, new)
+    else
+      e 'No file exists at '+sfile(old)+'.'
+    end
+  end; alias move_file mv # === move_file
+
+  # ========================================================================= #
+  # === basename
+  # ========================================================================= #
+  def basename(i)
+    File.basename(i)
+  end
+
+  # ========================================================================= #
+  # === delete_file
+  #
+  # This method can be used to delete a local file.
+  # ========================================================================= #
+  def delete_file(i)
+    begin
+      File.delete(i) if File.file?(i)
+    rescue Errno::EACCES => error
+      e 'Could not delete the file at '+i+' - reason '\
+        'being insufficient permission.'
+      e 'The error was:'
+      e
+      pp error
+      e
+    end
+  end; alias delete_this_file delete_file # === delete_this_file
+
+  # ========================================================================= #
+  # === reset_the_internal_hash
+  # ========================================================================= #
+  def reset_the_internal_hash
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+  end
+
+  # ========================================================================= #
+  # === internal_hash?
+  # ========================================================================= #
+  def internal_hash?
+    @internal_hash
+  end; alias ihash? internal_hash? # === ihash?
+
+  # ========================================================================= #
+  # === log_dir?
+  # ========================================================================= #
+  def log_dir?
+    ::PdfParadise.log_dir?
+  end; alias log_directory? log_dir? # === log_directory?
+       alias temp_dir?      log_dir? # === temp_dir?
+
+  # ========================================================================= #
+  # === mkdir
+  # ========================================================================= #
+  def mkdir(i)
+    FileUtils.mkdir_p(i)
+  end
+
+  # ========================================================================= #
+  # === try_to_ensure_that_this_directory_exists
+  # ========================================================================= #
+  def try_to_ensure_that_this_directory_exists(i)
+    unless File.directory?(i)
+      mkdir(i)
+    end
+  end
+
+end; end

data/lib/pdf_paradise/base/colours.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/base/colours.rb'
+# =========================================================================== #
+require 'pdf_paradise/requires/colours_and_esystem_and_save_file_and_fileutils_and_opn.rb'
+
+module PdfParadise
+
+class Base # === PdfParadise::Base
+
+  require 'pdf_paradise/colours/colours.rb'
+
+  if Object.const_defined?(:Colours) and Colours.const_defined?(:HtmlColoursMethods)
+    include ::Colours
+    include ::Colours::HtmlColoursMethods
+    def e(i = '')
+      puts i
+    end
+  else
+    include ::Colours
+  end
+
+  # ========================================================================= #
+  # === orange
+  # ========================================================================= #
+  def orange(i)
+    ::Colours.orange(i)
+  end
+
+  # ========================================================================= #
+  # === steelblue
+  # ========================================================================= #
+  def steelblue(i)
+    ::Colours::HtmlColoursMethods.steelblue(i)
+  end
+
+  # ========================================================================= #
+  # === gold
+  # ========================================================================= #
+  def gold(i)
+    ::Colours::HtmlColoursMethods.gold(i)
+  end
+
+  # ========================================================================= #
+  # === lightsteelblue
+  # ========================================================================= #
+  def lightsteelblue(i)
+    ::Colours::HtmlColoursMethods.lightsteelblue(i)
+  end
+
+  # ========================================================================= #
+  # === ecomment
+  # ========================================================================= #
+  def ecomment(i)
+    ::Colours.ecomment(i)
+  end
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    ::Colours.rev
+  end
+
+end; end

data/lib/pdf_paradise/colours/colours.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/colours/colours.rb'
+# =========================================================================== #
+module PdfParadise
+
+  begin
+    require 'colours/html_colours'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === PdfParadise.darkolivegreen
+  # ========================================================================= #
+  def self.darkolivegreen(i = '')
+    ::Colours.darkolivegreen(i)
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.rev
+  # ========================================================================= #
+  def self.rev
+    ::Colours.rev
+  end
+
+end

data/lib/pdf_paradise/commandline/commandline.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/commandline/commandline.rb'
+# =========================================================================== #
+module PdfParadise
+
+  # ========================================================================= #
+  # === @commandline_arguments
+  # ========================================================================= #
+  @commandline_arguments = []
+
+  # ========================================================================= #
+  # === PdfParadise.mega_check_every_pdf_file_in_the_current_directory
+  # ========================================================================= #
+  def self.mega_check_every_pdf_file_in_the_current_directory
+    require 'pdf_paradise/utility_scripts/check_syntax_of_pdf_files.rb'
+    PdfParadise::CheckSyntaxOfPdfFiles.new(:work_on_every_pdf_file_in_the_current_working_directory)
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.set_commandline_arguments
+  # ========================================================================= #
+  def self.set_commandline_arguments(i)
+    i = [i].flatten.compact
+    # ======================================================================= #
+    # We will also check if a file with that name exists. If so we
+    # will replace it via File.absolute_path().
+    # ======================================================================= #
+    i.map! {|entry|
+      if File.exist?(entry)
+        entry = File.absolute_path(entry)
+      end
+      entry
+    }
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.commandline_arguments?
+  # ========================================================================= #
+  def self.commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === @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(
+      target = "#{AUTOCONVERT_PDF_FILES_RESIDING_IN_THIS_DIRECTORY}*.pdf"
+    )
+    require 'pdf_paradise/utility_scripts/split_pdf.rb'
+    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.open_the_default_pdf_files
+  #
+  # To invoke this method, do:
+  #
+  #   pdfpa --open-pdf-files
+  #
+  # ========================================================================= #
+  def self.open_the_default_pdf_files(
+      use_this_file = ::PdfParadise.file_working_on_these_pdf_files
+    )
+    if File.exist? use_this_file
+      dataset = YAML.load_file(use_this_file)
+      dataset.each {|file|
+        esystem "atril #{file} &"
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === PdfParadise.start_the_most_important_libui_wrapper
+  # ========================================================================= #
+  def self.start_the_most_important_libui_wrapper(
+      optional_commandline_arguments = nil
+    )
+    require 'pdf_paradise/gui/libui/extract_all_images_from_this_pdf_file/extract_all_images_from_this_pdf_file.rb'
+    PdfParadise::GUI::LibUI::ExtractAllImagesFromThisPdfFile.new(optional_commandline_arguments)
+  end
+
+end

data/lib/pdf_paradise/commandline/help.rb

@@ -0,0 +1,77 @@
+#!/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
+    return 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 --mega-checker') # === pdf_paradise --mega-checker
+    e
+    e '    ^^^ check every .pdf file in the current working directory for errors.'
+    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
+    e gold('  pdf_paradise --libui')
+    e
+    e '    ^^^ start the libui GUI'
+    e
+  end
+
+end