pdf_paradise 0.1.43

data/lib/pdf_paradise/gui/shared_code/delete_the_first_or_the_last_page_of_this_pdf_file/delete_the_first_or_the_last_page_of_this_pdf_file_module.rb

@@ -0,0 +1,428 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::Gtk::DeleteTheFirstOrTheLastPageOfThisPdfFileModule
+# =========================================================================== #
+# require 'pdf_paradise/gui/shared_code/delete_the_first_or_the_last_page_of_this_pdf_file/delete_the_first_or_the_last_page_of_this_pdf_file_module.rb'
+# include ::PdfParadise::GUI::Gtk::DeleteTheFirstOrTheLastPageOfThisPdfFileModule
+# =========================================================================== #
+module PdfParadise
+
+module GUI
+
+module Gtk
+
+module DeleteTheFirstOrTheLastPageOfThisPdfFileModule
+
+  require 'pdf_paradise/utility_scripts/delete_first_page_of_this_pdf_file.rb'
+  require 'pdf_paradise/utility_scripts/delete_last_page_of_this_pdf_file.rb'
+  require 'pdf_paradise/utility_scripts/delete_this_page_of_this_pdf_file.rb'
+
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  require 'colours'
+  include Colours
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === ARRAY_ADD_THESE_SHORTCUT_FOLDERS
+  # ========================================================================= #
+  ARRAY_ADD_THESE_SHORTCUT_FOLDERS = [
+    "/",
+    '/Depot/PDF/'
+  ]
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Remove a specific page from a .pdf file.'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 1600
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 400
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = :dejavu_condensed_24
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  # ========================================================================= #
+  SMALLER_FONT  = :dejavu_condensed_22
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      optional_file = nil,
+      run_already   = true
+    )
+    super(:vertical)
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    reset_the_internal_variables
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, NAMESPACE]
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    @title  = TITLE
+    # ======================================================================= #
+    # === @width
+    # ======================================================================= #
+    @width  = WIDTH
+    # ======================================================================= #
+    # === @height
+    # ======================================================================= #
+    @height = HEIGHT
+    set_use_this_font(USE_THIS_FONT)
+    use_gtk_paradise_project_css_file
+    infer_the_size_automatically
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    0
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === add_the_remove_the_first_page_and_remove_the_last_page_of_the_pdf_file_buttons
+  # ========================================================================= #
+  def add_the_remove_the_first_page_and_remove_the_last_page_of_the_pdf_file_buttons
+    @hbox1.minimal(@button_remove_the_first_page_of_the_pdf_file, 2)
+    @hbox1.minimal(@button_remove_the_last_page_of_the_pdf_file, 2)
+  end
+
+  # ========================================================================= #
+  # === create_skeleton
+  # ========================================================================= #
+  def create_skeleton
+    @hbox1 = gtk_vbox
+    create_buttons
+    create_entries
+    create_labels
+    @gtk_text_above_the_main_entry = gtk_bold_label(
+      'Set the path to the .pdf file below this text here.'
+    ) {{
+      tooltip: 'You need to supply the path to the .pdf file '\
+      'into the input field on the right side.'
+    }}
+    @gtk_text_for_notification = gtk_label
+  end
+
+  # ========================================================================= #
+  # === create_buttons                                          (buttons tag)
+  #
+  # This method can be used to create all buttons in this small application.
+  # ========================================================================= #
+  def create_buttons
+    # ======================================================================= #
+    # === @button_remove_the_first_page_of_the_pdf_file
+    # ======================================================================= #
+    @button_remove_the_first_page_of_the_pdf_file = gtk_button('Remove the _first page')
+    @button_remove_the_first_page_of_the_pdf_file.skyblue
+    @button_remove_the_first_page_of_the_pdf_file.do_use_mnemonic
+    @button_remove_the_first_page_of_the_pdf_file.hint = 
+      "<b>Click</b> on this button to remove the first page of the pdf file.\n\n"\
+      "Do not forget to make sure that the .pdf file exists at that location.\n"\
+      "Note that the program called qpdf has to be installed as well."
+    @button_remove_the_first_page_of_the_pdf_file.on_clicked {
+      do_remove_the_first_page_of_the_pdf_file
+    }
+    # ======================================================================= #
+    # === @button_remove_the_last_page_of_the_pdf_file
+    # ======================================================================= #
+    @button_remove_the_last_page_of_the_pdf_file = gtk_button('Remove the _last page')
+    @button_remove_the_last_page_of_the_pdf_file.skyblue
+    @button_remove_the_last_page_of_the_pdf_file.do_use_mnemonic
+    @button_remove_the_last_page_of_the_pdf_file.hint = 
+      "  <b>Click</b> on this button to remove the last page of the pdf file.\n"\
+      "Do not forget to make sure that the .pdf file exists at that location."
+    @button_remove_the_last_page_of_the_pdf_file.on_clicked {
+      do_remove_the_last_page_of_the_pdf_file
+    }
+    # ======================================================================= #
+    # === @button_file_chooser
+    # ======================================================================= #
+    @button_file_chooser = gtk_button('🗄️ Choose a file')
+    @button_file_chooser.hint = 'Click this button to '\
+      'select a file.'
+    @button_file_chooser.skyblue
+    @button_file_chooser.on_clicked {
+      open_file_chooser_dialog
+    }
+  end
+
+  # ========================================================================= #
+  # === do_remove_the_last_page_of_the_pdf_file
+  # ========================================================================= #
+  def do_remove_the_last_page_of_the_pdf_file
+    e 'Now removing the last .pdf page.'
+    target_file = @entry_for_the_path_to_the_pdf_file.text.to_s
+    if File.exist?(target_file)
+      PdfParadise.remove_the_last_page_of_this_pdf_file(
+        target_file
+      )
+      # ===================================================================== #
+      # Notify the user that we finished here.
+      # ===================================================================== #
+      update_all_done_finished_at
+    else
+      no_file_was_found_at(target_file)
+    end
+  end
+
+  # ========================================================================= #
+  # === update_all_done_finished_at
+  # ========================================================================= #
+  def update_all_done_finished_at
+    @gtk_text_for_notification.set_text(
+      'All done! Finished at <b>'+Time.now.to_s+'</b>'
+    )
+    @gtk_text_for_notification.do_markify
+  end
+
+  # ========================================================================= #
+  # === do_remove_the_first_page_of_the_pdf_file
+  #
+  # This is the main action of this class.
+  # ========================================================================= #
+  def do_remove_the_first_page_of_the_pdf_file
+    e 'Now removing the first .pdf page.'
+    target_file = @entry_for_the_path_to_the_pdf_file.text.to_s
+    if File.exist?(target_file)
+      PdfParadise.remove_the_first_page_of_this_pdf_file(
+        target_file
+      )
+      # ===================================================================== #
+      # Notify the user that we finished here.
+      # ===================================================================== #
+      update_all_done_finished_at
+    else
+      no_file_was_found_at(target_file)
+    end
+  end
+
+  # ========================================================================= #
+  # === no_file_was_found_at
+  # ========================================================================= #
+  def no_file_was_found_at(i)
+    e "No file was found at #{sfile(i)}."
+  end
+
+  # ========================================================================= #
+  # === add_the_remove_this_page_entry
+  # ========================================================================= #
+  def add_the_remove_this_page_entry
+    hbox = gtk_hbox
+    hbox.minimal(
+      left_aligned_text(
+        'Denote which .pdf page (as a number) '\
+        'is to be removed '
+      )
+    )
+    hbox.minimal(@entry_remove_this_pdf_page)
+    @button_remove_the_specified_page = gtk_button('🗙')
+    @button_remove_the_specified_page.hint = 'Click '\
+      'this button in order to remove the specified page '\
+      'from the .pdf document at hand.'
+    @button_remove_the_specified_page.on_clicked {
+      do_remove_this_page(
+        @entry_remove_this_pdf_page.text.to_s
+      )
+    }
+    @button_remove_the_specified_page.set_size_request(160, 48)
+    @button_remove_the_specified_page.disallow_resizing
+    hbox.minimal(@button_remove_the_specified_page)
+    @hbox1.minimal(hbox)
+  end
+
+  # ========================================================================= #
+  # === create_labels
+  # ========================================================================= #
+  def create_labels
+    @label_on_top = gtk_left_aligned_label(
+      'Denote which .pdf file is to be manipulated, in the '\
+      'following entry.'
+    )
+    @label_on_top.use_this_font(SMALLER_FONT)
+  end
+
+  # ========================================================================= #
+  # === connect_skeleton
+  # ========================================================================= #
+  def connect_skeleton
+    abort_on_exception
+    @hbox1.maximal(@label_on_top, 2)
+    @hbox1.minimal(horizontal_spacer, 2)
+    @hbox1.minimal(@gtk_text_above_the_main_entry, 2)
+    @hbox1.maximal(@entry_for_the_path_to_the_pdf_file, 2)
+    # ======================================================================= #
+    # And add the file-chooser button:
+    # ======================================================================= #
+    @hbox1.minimal(@button_file_chooser)
+    # ======================================================================= #
+    # Next add the remove-this-page entry.
+    # ======================================================================= #
+    add_the_remove_this_page_entry
+    # ======================================================================= #
+    # Next add the two "remove first page" and "remove last page"
+    # buttons.
+    # ======================================================================= #
+    add_the_remove_the_first_page_and_remove_the_last_page_of_the_pdf_file_buttons
+    @hbox1.minimal(@gtk_text_for_notification)
+    minimal(@hbox1, 1)
+  end
+
+  require 'gtk_paradise/toplevel_methods/select_file.rb'
+  # ========================================================================= #
+  # === open_file_chooser_dialog                                   (open tag)
+  # ========================================================================= #
+  def open_file_chooser_dialog
+    current_folder = return_pwd
+    if is_on_roebe? and File.directory?('/Depot/j/')
+      current_folder = '/Depot/j/'
+    end
+    @extra_button = gtk_button('_Extra button') 
+    @extra_button.on_clicked { e ' > Extra button was clicked' }
+    
+    filename = ::Gtk.select_file(parent_widget?) {{
+      current_folder:             current_folder,
+      show_hidden:                true,
+      extra_widget:               @extra_button,
+      add_these_shortcut_folders: ARRAY_ADD_THESE_SHORTCUT_FOLDERS,
+      use_this_file_filter:       '*.pdf'
+    }}
+
+    @entry_for_the_path_to_the_pdf_file.set_text(filename)
+  end
+
+  # ========================================================================= #
+  # === parent_widget?
+  # ========================================================================= #
+  def parent_widget?
+    @parent_widget
+  end
+
+  # ========================================================================= #
+  # === set_parent_widget
+  # ========================================================================= #
+  def set_parent_widget(i)
+    @parent_widget = i
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    create_skeleton_then_connect_skeleton
+    show_all
+  end
+
+  # ========================================================================= #
+  # === create_entries                                      (entries tag)
+  # ========================================================================= #
+  def create_entries
+    @entry_for_the_path_to_the_pdf_file = gtk_entry('')
+    @entry_for_the_path_to_the_pdf_file.highlight_on_click_event
+    @entry_for_the_path_to_the_pdf_file.add_css_class(
+      'BG_floralwhite'
+    )
+    # ======================================================================= #
+    # === @entry_remove_this_pdf_page
+    # ======================================================================= #
+    @entry_remove_this_pdf_page = gtk_entry
+    @entry_remove_this_pdf_page.highlight_on_click_event
+    @entry_remove_this_pdf_page.bblack1
+    @entry_remove_this_pdf_page.add_css_class(
+      'BG_floralwhite'
+    )
+    @entry_remove_this_pdf_page.align_to_the_center
+    @entry_remove_this_pdf_page.set_size_request(160, 48)
+  end
+
+  # ========================================================================= #
+  # === do_remove_this_page
+  # ========================================================================= #
+  def do_remove_this_page(
+     i           = @entry_remove_this_pdf_page.text.to_s,
+     target_file = @entry_for_the_path_to_the_pdf_file.text.to_s
+    )
+    if File.exist?(target_file)
+      PdfParadise.remove_this_page_of_that_pdf_file(
+        i, target_file
+      )
+      update_all_done_finished_at
+    else
+      no_file_was_found_at(target_file)
+    end
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::Gtk::DeleteTheFirstOrTheLastPageOfThisPdfFileModule.run
+  # ========================================================================= #
+  def self.run
+    require 'gtk_paradise/run'
+    _ = ::PdfParadise::GUI::Gtk::DeleteTheFirstOrTheLastPageOfThisPdfFile.new
+    r = ::Gtk.run
+    r << _
+    r.set_size_request(
+      _.width?,
+      _.height?
+    )
+    r.top_left_then_run
+  end
+
+end; end; end
+
+# =========================================================================== #
+# === PdfParadise.return_widget_remove_first_page_of_pdf_file
+# =========================================================================== #
+def self.return_widget_remove_first_page_of_pdf_file
+  ::PdfParadise::GUI::Gtk::DeleteTheFirstOrTheLastPageOfThisPdfFile.new
+end
+
+# =========================================================================== #
+# === PdfParadise.start_gtk_gui_remove_first_page_of_pdf_file
+# =========================================================================== #
+def self.start_gtk_gui_remove_first_page_of_pdf_file
+  require 'gtk_paradise/run'
+  _ = PdfParadise::GUI::Gtk::DeleteTheFirstOrTheLastPageOfThisPdfFile.new
+  r = ::Gtk.run
+  _.set_parent_widget(r)
+  r.easy_exit
+  r << _
+  r.top_left_then_run
+end
+
+end

data/lib/pdf_paradise/gui/shared_code/pdf_viewer/pdf_viewer.css

@@ -0,0 +1,5 @@
+#button1 {
+  border: 3px solid darkblue;
+  color: teal;
+  background: oldlace;
+}

data/lib/pdf_paradise/gui/shared_code/pdf_viewer/pdf_viewer_module.rb

@@ -0,0 +1,284 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::Gtk::PdfViewerModule
+#
+# This widget can be used to "view" a .pdf file. Right now we will
+# convert it to a .pdf file, then simply display the text.
+# =========================================================================== #
+# require 'pdf_paradise/gui/shared_code/pdf_viewer/pdf_viewer_module.rb'
+# include ::PdfParadise::GUI::Gtk::PdfViewerModule
+# =========================================================================== #
+module PdfParadise
+
+module GUI
+
+module Gtk
+
+module PdfViewerModule
+
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'View .pdf files'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 1600
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 600
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    super(:vertical)
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    reset_the_internal_variables
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, NAMESPACE]
+    # ======================================================================= #
+    # === @parent_widget
+    # ======================================================================= #
+    @parent_widget = nil
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    @title  = TITLE
+    # ======================================================================= #
+    # === @width
+    # ======================================================================= #
+    @width  = WIDTH
+    # ======================================================================= #
+    # === @height
+    # ======================================================================= #
+    @height = HEIGHT
+    set_use_this_font(:dejavu_condensed_23)
+    use_project_css_file
+    infer_the_size_automatically
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    2
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === create_skeleton
+  # ========================================================================= #
+  def create_skeleton
+    @text_buffer = gtk_text_buffer
+    create_the_text_view
+    create_the_buttons
+    create_the_scrolled_window
+  end
+
+  # ========================================================================= #
+  # === create_the_scrolled_window
+  # ========================================================================= #
+  def create_the_scrolled_window
+    @scrolled_window = gtk_scrolled_window(@text_view) { :always_show_the_scrollbars }
+    @scrolled_window.css_class('bblack1')
+  end
+
+  # ========================================================================= #
+  # === create_the_text_view
+  # ========================================================================= #
+  def create_the_text_view
+    @text_view = gtk_text_view(@text_buffer)
+  end
+
+  # ========================================================================= #
+  # === do_the_conversion
+  #
+  # This method will do the actual file-conversion.
+  # ========================================================================= #
+  def do_the_conversion(
+      i = @entry_this_is_the_pdf_file.text.to_s
+    )
+    if File.exist? i
+      location_of_the_newly_generated_file = '/Depot/j/converted_pdf_file.md'
+      # ===================================================================== #
+      # Next, do the conversion.
+      # ===================================================================== #
+      `pdftotext #{i} #{location_of_the_newly_generated_file}`
+      if File.exist? location_of_the_newly_generated_file
+        dataset = File.read(location_of_the_newly_generated_file).to_s
+        set_text_in_the_main_buffer(dataset)
+      else
+        e 'No file exists at '+location_of_the_newly_generated_file+'.'
+      end
+    else
+      e 'No file exists at '+::Colours.sfile(i)+'.'
+    end
+  end; alias trigger_the_conversion do_the_conversion # === trigger_the_conversion
+
+  # ========================================================================= #
+  # === create_the_buttons
+  # ========================================================================= #
+  def create_the_buttons
+    @button_view_this_pdf_file = gtk_button('View this .pdf file')
+    @button_view_this_pdf_file.set_name('button1')
+    @button_view_this_pdf_file.hint = 'Click on '\
+      'this button to view the content of the .pdf file.'
+    @button_view_this_pdf_file.on_clicked {
+      do_the_conversion(@entry_this_is_the_pdf_file.text.to_s)
+    }
+    @button_clear = gtk_button('Clear')
+    @button_clear.hint = 'Click this button '\
+      'to clear the buffer shown below.'
+    @button_clear.on_clicked {
+      @text_buffer.clear
+    }
+    @button_file_picker = gtk_button('_Pick a file')
+    @button_file_picker.hint = 'Pick a local .pdf file.'
+    @button_file_picker.on_clicked {
+      do_pick_a_file
+    }
+  end
+
+  # ========================================================================= #
+  # === connect_skeleton                                        (connect tag)
+  # ========================================================================= #
+  def connect_skeleton
+    abort_on_exception
+    # ======================================================================= #
+    # === @entry_this_is_the_pdf_file
+    # ======================================================================= #
+    @entry_this_is_the_pdf_file = gtk_entry(
+      '/Depot/j/test.pdf'
+    )
+    @entry_this_is_the_pdf_file.yellow_background
+    top_hbox = gtk_hbox
+    top_hbox.maximal(@entry_this_is_the_pdf_file, 3)
+    top_hbox.maximal(@button_view_this_pdf_file,  3)
+    top_hbox.minimal(@button_file_picker,         3)
+    top_hbox.minimal(@button_clear,               3)
+    minimal(top_hbox)
+    maximal(@scrolled_window)
+  end
+
+  # ========================================================================= #
+  # === set_parent_widget
+  # ========================================================================= #
+  def set_parent_widget(i)
+    @parent_widget = i
+  end
+
+  # ========================================================================= #
+  # === set_text_in_the_main_buffer
+  # ========================================================================= #
+  def set_text_in_the_main_buffer(i)
+    i = i.to_s.dup.strip
+    i.delete!('®') # Do a bit ad-hoc deletion.
+    @text_buffer.set_text(i.to_s.dup)
+    GC.start
+  end
+
+  # ========================================================================= #
+  # === set_this_as_the_active_pdf_file
+  # ========================================================================= #
+  def set_this_as_the_active_pdf_file(i)
+    i = i.to_s.dup
+    @entry_this_is_the_pdf_file.set_text(i)
+  end
+
+  # ========================================================================= #
+  # === do_pick_a_file
+  # ========================================================================= #
+  def do_pick_a_file
+    filename = ::Gtk.select_file(@parent_widget) {{
+      current_folder:             '/Depot/j/',
+      show_hidden:                true,
+      add_these_shortcut_folders: ['/Depot/j/'],
+      use_this_file_filter:       '*.pdf'
+    }}
+    if File.exist? filename
+      set_this_as_the_active_pdf_file_then_trigger_the_conversion(filename)
+    end
+  end
+
+  # ========================================================================= #
+  # === set_this_as_the_active_pdf_file_then_trigger_the_conversion
+  # ========================================================================= #
+  def set_this_as_the_active_pdf_file_then_trigger_the_conversion(
+      filename
+    )
+    set_this_as_the_active_pdf_file(filename)
+    trigger_the_conversion
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    create_skeleton_then_connect_skeleton
+    menu
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      if File.exist? i
+        set_this_as_the_active_pdf_file_then_trigger_the_conversion(i)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::Gtk::PdfViewerModule.run
+  # ========================================================================= #
+  def self.run
+    require 'gtk_paradise/run'
+    _ = ::PdfParadise::GUI::Gtk::PdfViewer.new
+    r = ::Gtk.run
+    _.set_parent_widget(r)
+    r << _
+    r.automatic_title_and_size
+    r.top_left_then_run
+  end
+
+end; end; end; end