pdf_paradise 0.3.20

data/lib/pdf_paradise/utility_scripts/to_pdf.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::ToPdf
+#
+# Usage example:
+#
+#   PdfParadise::ToPdf.new(ARGV)
+#
+# =========================================================================== #
+# require 'pdf_paradise/utility_scripts/to_pdf.rb'
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+class ToPdf < ::PdfParadise::Base # === PdfParadise::ToPdf
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    commandline_arguments?.each {|entry|
+      if entry.end_with?('.docx','.pptx')
+        convert_this_docx_file(entry)
+      elsif File.directory?(entry)
+        handle_this_directory(File.absolute_path(entry))
+      else
+        opnn; e "Unsure what to do with #{steelblue(entry)}."
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === convert_this_docx_file
+  # ========================================================================= #
+  def convert_this_docx_file(i)
+    _ = "soffice --headless --invisible --convert-to pdf #{i}"
+    e _
+    system _
+  end
+
+  # ========================================================================= #
+  # === handle_this_directory
+  # ========================================================================= #
+  def handle_this_directory(i)
+    require 'image_paradise/toplevel_methods/misc.rb'
+    require 'pdf_paradise/merge_pdf/merge_pdf.rb'
+    i = i.dup
+    i << '/' unless i.end_with?('/')
+    e "#{rev}First, we will obtain all image files "\
+      "of the directory #{sdir(i)}:"
+    all_image_files = Dir["#{i}*"].select {|entry|
+      is_an_image_file?(entry)
+    }
+    result = all_image_files.map {|this_image_file|
+      this_image_file = ::ImageParadise.img2pdf(this_image_file)
+      this_image_file
+    }
+    e 'Next merging these generated files into a new .pdf file:'
+    merge_pdf = PdfParadise::MergePdf.new(result)
+    _ = merge_pdf.where_it_is_stored? # Call it manually.
+    opnn; e 'If everything worked well then the resulting '\
+            '.pdf file can'
+    opnn; e 'be found at: '+sfile(_)
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::ToPdf[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === PdfParadise.to_pdf
+#
+# This method can, by using soffice, convert a file such as .docx into
+# the corresponding .pdf file - all on the commandline.
+# =========================================================================== #
+def self.to_pdf(
+    these_pdf_files = ARGV
+  )
+  [these_pdf_files].flatten.compact.map {|this_pdf_file|
+    if File.exist? this_pdf_file
+      # ===================================================================== #
+      # The soffice binary must exist in order for this functionality
+      # to work.
+      # ===================================================================== #
+      _ = "soffice --headless --invisible --convert-to pdf #{this_pdf_file}"
+      e _
+      system _
+      this_pdf_file # Return the path here, in case it has to be used.
+    else
+      e "No file exists at `#{this_pdf_file}.`"
+      nil
+    end
+  }
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::ToPdf.new(ARGV)
+end # topdf

data/lib/pdf_paradise/utility_scripts/to_qdf.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::ToQdf
+#
+# This class will convert a .pdf file into a .qdf file.
+#
+# Usage example:
+#
+#   PdfParadise::ToQdf.new(ARGV)
+#
+# =========================================================================== #
+# require 'pdf_paradise/utility_scripts/to_qdf.rb'
+# PdfParadise::ToQdf.new(ARGV)
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+class ToQdf < ::PdfParadise::Base # === PdfParadise::ToQdf
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    commandline_arguments?.each {|entry|
+      qdf_file = entry.sub(/\.?pdf$/,)
+      esystem "qpdf -qdf #{entry} #{qdf_file}.qdf"
+    }
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::ToQdf[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::ToQdf.new(ARGV)
+end # toqdf

data/lib/pdf_paradise/version/version.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'pdf_paradise/version/version.rb'
+# =========================================================================== #
+module PdfParadise
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.3.20'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '04.02.2024'
+
+end

data/lib/pdf_paradise/www/README.md

@@ -0,0 +1,2 @@
+In this directory we will put code that can be used on
+the www.

data/lib/pdf_paradise/www/sinatra/app.rb

@@ -0,0 +1,304 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::Sinatra
+# =========================================================================== #
+# require 'pdf_paradise/www/sinatra/app.rb'
+# PdfParadise.start_sinatra_interface
+# =========================================================================== #
+require 'sinatra/base.rb'
+
+module PdfParadise
+
+class Sinatra < ::Sinatra::Base
+
+  require 'pdf_paradise'
+
+  require 'beautiful_url'
+
+  # ========================================================================= #
+  # A lot of the code for this class is stored in the following module:
+  # ========================================================================= #
+  require 'pdf_paradise/sinatra/embeddable_interface.rb'
+  include PdfParadise::EmbeddableInterface
+
+  begin
+    require 'cyberweb'
+  rescue LoadError; end
+
+  include ::Colours
+
+  set :port, USE_THIS_PORT
+
+  # ========================================================================= #
+  # === PdfParadise::Sinatra.sub_routes?
+  # ========================================================================= #
+  def self.sub_routes?
+    PdfParadise::EmbeddableInterface.sub_routes?
+  end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    super()
+    reset
+    Dir.chdir('/home/Temp/') if File.directory? '/home/Temp'
+    if ::PdfParadise.is_on_roebe?
+      require 'open'
+      # ===================================================================== #
+      # Tell us which port will be used:
+      # ===================================================================== #
+      target = "http://localhost:#{USE_THIS_PORT}/"
+      e sfancy(target)
+      Thread.new {
+        Open.in_browser(target) {{ delay: '1.0 seconds' }}
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === report_file_listing
+  # ========================================================================= #
+  def report_file_listing
+    _ = '<p style="padding:1em; font-size: larger">'.dup
+    _ << '<b>File listing from the directory: '+Dir.pwd+'</b><br><br>'
+    Dir['*'].select {|entry| File.file?(entry) }.each {|entry|
+      _ << "→ <b style=\"margin-left:3em\">#{entry}</b><br>"
+    }
+    _ << '</p>'
+    _
+  end
+
+  # =========================================================================== #
+  # === View (view tag)
+  #
+  # http://localhost:5200/view
+  # http://localhost:5200/overview
+  # =========================================================================== #
+  %w( /view /overview ).each {|path|
+  get(path) {
+    result = ''.dup
+    result << p(
+      'The <b style="color: darkblue">content</b> of <b>'+
+      PdfParadise.main_directory?.to_s+'</b> is:'
+    ).dup
+    all_pdf_files = Dir[
+      PdfParadise.main_directory?.to_s+'*.pdf'
+    ]
+    if all_pdf_files.empty?
+      result << 'No .pdf files were found.<br>'
+    else
+      all_pdf_files.each {|this_file|
+        result << HtmlTags.p(
+          '<span style="color: darkblue">'+
+          RARROW+
+          '</span> '+this_file,
+          css_style: 'margin-left:1.5em; font-weight: bold; font-size: larger'
+        )
+      }
+    end
+    result << html_then_title+
+              p(
+                '(Do not forget to remove .pdf files that you do not '\
+                'wish to autoconvert, from that directory.)'
+              )+
+              return_link_to_root
+    result # Return the result here.
+  }
+  }
+
+  # ========================================================================= #
+  # === view
+  #
+  # http://localhost:5200/view
+  # ========================================================================= #
+  get('/view') { # view tag
+    return_view_string
+  }
+
+  # =========================================================================== #
+  # http://localhost:5200/title
+  #
+  # Show the title of the pdf file at hand.
+  # =========================================================================== #
+  get('/title/*'){ # n pdf pages
+    _ = web_params?
+    if _.is_a? Array
+      _ = _.first
+    end
+    if File.exist? _
+      title = PdfParadise.return_title_of_this_pdf_file(_).to_s
+      content = "This .pdf's file title is: <b>#{title}</b>."
+      if title.empty?
+        content = "This .pdf file has no title."
+      end 
+      result = p(
+        content
+      ).dup
+      result
+    else
+      html_start_then_title+
+      p("No file called #{_} exists.")
+    end
+  }
+
+  # =========================================================================== #
+  # http://localhost:5200/title
+  #
+  # Show how many pdf pages a pdf file has.
+  # =========================================================================== #
+  get('/title'){ # n pdf pages
+    route_to_this_action = '/title'
+    html_start_then_title
+    p('Provide the path to a <b>.pdf</b> file:')+
+    form(action: route_to_this_action, id: route_to_this_action.delete('/'), css_style: 'margin-left:2em; margin-top:2px') {
+      input_type_user_input+
+      br+
+      input_type_submit
+    }+
+    report_file_listing
+  }
+
+  # ========================================================================= #
+  # === /convert_single_pdf_file
+  #
+  # http://localhost:5200/convert_single_pdf_file/
+  # ========================================================================= #
+  get('/convert_single_pdf_file/*') {
+    user_input = web_params?
+    if params.has_key?('user_input')
+      user_input = params.fetch('user_input')
+    end
+    result = 
+    html_then_title+
+    p(
+      'Next attempting to work with the pdf file '\
+      'at `<b>'+user_input+'</b>`.<br>'
+    ).dup
+    if File.exist? user_input
+      path = PdfParadise.convert(user_input).to_s
+      result << br+
+                p(
+                  'The converted .pdf file(s) should now be '\
+                  'available at: <b>'+path+'</b>'
+                )
+    else
+      result << p(
+                  'Unfortunately no .pdf file exists at that path.'
+                )
+    end
+    result
+  }
+
+  # =========================================================================== #
+  # === /autoconvert
+  #
+  # http://localhost:5200/autoconvert
+  # =========================================================================== #
+  get('/autoconvert'){
+    # Start the autoconversion next, part of the PdfParadise project.
+    PdfParadise.autoconvert_pdf_files
+    result = p(
+      'Trying to autoconvert all .pdf files - look at <b>'+
+      PdfParadise.main_directory?.to_s+'</b> for results.'
+    ).dup
+    Dir[PdfParadise.main_directory?.to_s+'*.pdf'].each {|this_file|
+      result << p(this_file)
+    }
+    result << return_view_string
+    result
+  }
+
+  # =========================================================================== #
+  # http://localhost:5200/n_pdf_pages
+  #
+  # Show how many pdf pages a pdf file has.
+  # =========================================================================== #
+  get('/n_pdf_pages'){ # n pdf pages
+    return_n_pdf_pages
+  }
+
+  # =========================================================================== #
+  # === /n_pdf_pages
+  #
+  # http://localhost:5200/n_pdf_pages
+  #
+  # Show how many pdf pages a pdf file has.
+  # =========================================================================== #
+  get(sub_routes?[:n_pdf_pages]+'/*'){ # n pdf pages
+    _ = web_params_as_string?
+    _.prepend('/') unless _.start_with? '/'
+    if File.exist? _
+      result = html_start_then_title+
+      p(
+        'This .pdf file (at <b>'+_+'</b>) has <b>'+
+        PdfParadise.n_pages?(_).to_s+'</b> pages.'
+      ).dup
+      result
+    else
+      html_start_then_title+
+      p('No file called '+_+' exists.')
+    end
+  }
+
+  # ========================================================================= #
+  # === / Entry point                                              (root tag)
+  #
+  # This is the root of our web-application.
+  #
+  # http://localhost:5200
+  # ========================================================================= #
+  get('/'){
+    return_root_string
+  }
+
+  # =========================================================================== #
+  # http://localhost:5200/remove_the_first_page_of_this_pdf_file
+  #
+  # Invocation example:
+  #
+  #  http://localhost:5200/remove_the_first_page_of_this_pdf_file/Time_of_Our_Lives_The_Science_of_Human_Aging_by_Tom_Kirkwood_2001.pdf
+  #
+  # =========================================================================== #
+  get('/remove_the_first_page_of_this_pdf_file/*'){
+    _ = web_params?
+    _ = _.first if _.is_a? Array
+    unless File.exist? _
+      all_pdf_files = Dir['/home/x/books/**/*.pdf']
+      selection = all_pdf_files.select {|entry|
+        entry.end_with?(_)
+      }
+      if selection and !selection.empty?
+        _ = selection.first
+      end
+    end
+    PdfParadise.remove_the_first_page_of_this_pdf_file(_)
+    'Removed the first page of the .pdf file at '+_+'.'
+  }
+
+end
+
+# =========================================================================== #
+# === PdfParadise.start_sinatra_interface
+#
+# This method can be used to start the sinatra interface of the
+# PdfParadise project.
+# =========================================================================== #
+def self.start_sinatra_interface
+  e 'Starting the sinatra-interface of the PdfParadise project next.'
+  ::PdfParadise::Sinatra.run!
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise.start_sinatra_interface
+end

data/lib/pdf_paradise/yaml/working_on_these_pdf_files.yml

@@ -0,0 +1,4 @@
+---
+- "/home/x/books/NANO_TECHNOLOGY/DONE_Drexler_K.E._Engines_of_Creation_2.0_The_Coming_Era_of_Nanotechnology_2006.pdf"
+- "/home/x/books/GENETICS/DONE_Jochen_Graw_auth._Genetik-Springer_Spektrum_2015.pdf"
+- "/home/x/books/MICROBIOLOGY_IMMUNOLOGY_AND_VACCINATION/DONE_Immunulogie_für_Einsteiger_2015.pdf"

data/lib/pdf_paradise.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'pdf_paradise/requires/require_the_whole_project.rb'

data/pdf_paradise.gemspec

@@ -0,0 +1,61 @@
+# =========================================================================== #
+# Gemspec for Project PdfParadise.
+# =========================================================================== #
+require 'pdf_paradise/version/version.rb'
+require 'roebe/toplevel_methods/misc.rb'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'pdf_paradise'
+  s.version = PdfParadise::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+  
+  DESCRIPTION = <<-EOF
+
+This gem is called pdf_paradise.
+
+It attempts to be a swiss army knife, a wrapper, over pdf-related
+functionality in general, by tapping into external projects, 
+such as prawn, qpdf and so forth.
+
+For more information, please have a look at the documentation
+of the project on the homepage of this gem, at:
+
+https://www.rubydoc.info/gems/pdf_paradise/
+
+  EOF
+  
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  # ========================================================================= #
+  # Show this when a user installs this project.
+  # ========================================================================= #
+  s.post_install_message = <<-EOF
+
+  You can use this project to manipulate .pdf files.
+
+  You can find out the amount of pages in a .pdf file, you can use
+  it to merge pdf files and so on and so forth.
+
+  EOF
+
+  s.authors  = ['Robert A. Heiler']
+  s.email    = Roebe.email?
+  s.files    = Dir['**/*']
+  s.license  = 'MIT-0'
+  s.homepage = 'https://rubygems.org/gems/pdf_paradise'
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # External dependencies for the project:
+  # ========================================================================= #
+  s.add_dependency 'cliner'
+  s.add_dependency 'colours'
+  s.add_dependency 'opn'
+  s.add_dependency 'save_file'
+
+}

data/test/fpdf/001_minimal_example.rb

@@ -0,0 +1,12 @@
+require 'pdf_paradise/fpdf/fpdf.rb'
+require 'save_file'
+alias e puts
+
+pdf = FPDF.new
+pdf.new_page
+pdf.set_font('Arial','B',16)
+pdf.Cell(40,10,'Hello World!')
+dataset = pdf.Output
+
+e 'Storing into test.pdf next.'
+SaveFile.write_what_into(dataset, 'test.pdf')

data/test/fpdf/002_header_and_footer_example.rb

@@ -0,0 +1,64 @@
+require 'pdf_paradise/fpdf/fpdf.rb'
+require 'save_file'
+alias e puts
+
+class PDF < FPDF
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    super()
+  end
+
+  # ========================================================================= #
+  # === Header
+  #
+  # Page header
+  # ========================================================================= #
+  def Header
+    # Logo
+    Image('/home/x/data/images/NJOY/StringTime.jpg',10,6,30)
+    # ========================================================================= #
+    # Determine the font next:
+    #
+    #   Arial bold 15
+    #
+    # ========================================================================= #
+    SetFont('Arial','B',15)
+    # SetFont('Hack','B',30)
+    # SetFont('Liberation Sans Narrow','B',30)
+    # Move to the right
+    Cell(80)
+    # Title
+    Cell(120,10,'This showcases how to show a cell',1,0,'C')
+    # Line break
+    Ln(20)
+  end
+
+  # ========================================================================= #
+  # === Footer
+  #
+  # Page footer
+  # ========================================================================= #
+  def Footer
+    # Position at 1.5 cm from bottom
+    SetY(-15)
+    # Arial italic 8
+    set_font('Arial','I',8)
+    # Page number:
+    Cell(0,10,'Page '+PageNo().to_s+'/{nb}',0,0,'C')
+  end
+
+end
+
+pdf = PDF.new
+pdf.AliasNbPages
+pdf.AddPage
+pdf.SetFont('Times','',12)
+40.times {|n_run| n_run += 1
+  pdf.Cell(0,10,'Printing line number '+n_run.to_s,0,1)
+}
+dataset = pdf.Output
+e 'Storing into 002.pdf next.'
+SaveFile.write_what_into(dataset, '002.pdf')