pdf_paradise 0.3.20

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

@@ -0,0 +1,287 @@
+#!/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
+    # ======================================================================= #
+    set_width(WIDTH)
+    # ======================================================================= #
+    # === @height
+    # ======================================================================= #
+    set_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
+    begin
+      require 'gtk_paradise/toplevel_methods/toplevel_methods.rb'
+    rescue LoadError; end
+    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

data/lib/pdf_paradise/gui/shared_code/remove_the_first_page_of_this_pdf_file_module/remove_the_first_page_of_this_pdf_file_module.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::RemoveTheFirstPageOfThisPdfFileModule
+# =========================================================================== #
+# require 'pdf_paradise/gui/shared_code/remove_the_first_page_of_this_pdf_file_module/remove_the_first_page_of_this_pdf_file_module.rb'
+# include PdfParadise::GUI::RemoveTheFirstPageOfThisPdfFileModule
+# =========================================================================== #
+module PdfParadise
+
+module GUI
+
+module RemoveTheFirstPageOfThisPdfFileModule # === PdfParadise::GUI::RemoveTheFirstPageOfThisPdfFileModule
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::RemoveTheFirstPageOfThisPdfFileModule::TITLE
+  # ========================================================================= #
+  TITLE = 'Remove the first page of this .pdf file'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH  = 1400
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 800
+
+end; end; end

data/lib/pdf_paradise/gui/shared_code/split_pdf_file/split_pdf_file_module.rb

@@ -0,0 +1,295 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::Gtk::SplitPdfFileModule
+#
+# This is a simple gtk-GUI wrapper over the split-pdf functionality
+# of the PdfParadise project. The main box is a VBox (vertical box).
+# =========================================================================== #
+# require 'pdf_paradise/gui/shared_code/split_pdf_file/split_pdf_file_module.rb'
+# include ::PdfParadise::GUI::Gtk::SplitPdfFileModule
+# =========================================================================== #
+module PdfParadise
+
+module GUI
+
+module Gtk
+
+module SplitPdfFileModule
+
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  require 'pdf_paradise/utility_scripts/split_pdf.rb'
+
+  begin
+    require 'colours'
+    include Colours
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Split .pdf files'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 1400
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 700
+
+  # ========================================================================= #
+  # === ARRAY_ADD_THESE_SHORTCUT_FOLDERS
+  # ========================================================================= #
+  ARRAY_ADD_THESE_SHORTCUT_FOLDERS = [
+  #  "C:\\",
+  #  "C:\\ingrid",
+  #  '/ingrid'
+  ]
+
+  # ========================================================================= #
+  # === 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]
+    set_use_this_font(:dejavu_condensed_24)
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    @title  = TITLE
+    # ======================================================================= #
+    # === @width
+    # ======================================================================= #
+    set_width(WIDTH)
+    # ======================================================================= #
+    # === @height
+    # ======================================================================= #
+    set_height(HEIGHT)
+    use_project_css_file
+  end
+
+  # ========================================================================= #
+  # === add_the_split_pdf_file_button
+  # ========================================================================= #
+  def add_the_split_pdf_file_button
+    minimal(
+      @button_split_the_pdf_file, 2
+    )
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    2
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === create_skeleton
+  # ========================================================================= #
+  def create_skeleton
+    @hbox1 = create_vbox
+    create_buttons
+    create_the_entries
+  end
+
+  # ========================================================================= #
+  # === create_the_entries                                      (entries tag)
+  # ========================================================================= #
+  def create_the_entries
+    @entry_for_the_path_to_the_pdf_file = create_entry('')
+    @entry_for_the_path_to_the_pdf_file.on_click_event {
+      :highlight_text
+    }
+    # ======================================================================= #
+    # Determine where the individual .pdf files are to be kept:
+    # ======================================================================= #
+    _ = return_pwd
+    _ = '/Depot/j/'.dup if File.directory? '/Depot/j/'
+    @entry_for_the_directory_where_we_will_generate_the_individual_pdf_files_into = gtk_entry(
+      _
+    )
+  end
+
+  # ========================================================================= #
+  # === create_buttons                                          (buttons tag)
+  #
+  # This method can be used to create all buttons in this small application.
+  # ========================================================================= #
+  def create_buttons
+    @button_file_chooser = create_button('Choose a file')
+    @button_file_chooser.on_hover(:lightgreen)
+    @button_file_chooser.on_clicked {
+      open_file_chooser_dialog
+    }
+    @button_file_chooser.fancy_tooltip = 'Select this to <b>choose</b> '\
+      ' a local .pdf file.'
+    @button_split_the_pdf_file = create_button('_Split the pdf file')
+    @button_split_the_pdf_file.clear_background
+    @button_split_the_pdf_file.on_hover(:lightgreen)
+    @button_split_the_pdf_file.hint =
+      'Click on this button to actually <b>split the .pdf file</b> at hand.'
+    @button_split_the_pdf_file.on_clicked {
+      do_split_the_pdf_file
+    }
+  end
+
+  # ========================================================================= #
+  # === do_split_the_pdf_file                                     (split tag)
+  #
+  # This is the main action of this class.
+  # ========================================================================= #
+  def do_split_the_pdf_file
+    target_file = @entry_for_the_path_to_the_pdf_file.text?
+    if File.exist?(target_file)
+      e 'Now splitting the .pdf file'
+      PdfParadise.split_this_pdf_file(
+        target_file, :default, store_in_which_directory?
+      )
+    else
+      e 'No file was found at the location '+target_file+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === store_in_which_directory?
+  #
+  # This method must return a String, hence why the method .text is used.
+  # ========================================================================= #
+  def store_in_which_directory?
+    @entry_for_the_directory_where_we_will_generate_the_individual_pdf_files_into.text
+  end
+
+  # ========================================================================= #
+  # === open_file_chooser_dialog
+  # ========================================================================= #
+  def open_file_chooser_dialog
+    @file_chooser_dialog = create_file_chooser_dialog('Open File',
+      self,
+      ::Gtk::FileChooser::ACTION_OPEN, nil,
+     [::Gtk::Stock::CANCEL, ::Gtk::Dialog::RESPONSE_CANCEL],
+     [::Gtk::Stock::OPEN,   ::Gtk::Dialog::RESPONSE_ACCEPT]
+    )
+    if File.directory? '/Depot/j/'
+      @file_chooser_dialog.current_folder = '/Depot/j/'
+    else
+      @file_chooser_dialog.current_folder = return_pwd
+    end
+    # @file_chooser_dialog.add_shortcut_folder(return_pwd)
+    # ^^^ already exists as shortcut.
+    begin
+      ARRAY_ADD_THESE_SHORTCUT_FOLDERS.each {|this_directory|
+        @file_chooser_dialog.add_shortcut_folder(this_directory)
+      }
+    rescue; end
+    if File.directory? '/home/Temp/'
+      @file_chooser_dialog.add_directory('/home/Temp/')
+    end
+    @file_chooser_dialog.show_hidden = true # Do show hidden files.
+    @extra_button = create_button('_Extra button')
+    @extra_button.signal_connect(:clicked) { e ' > Extra button was clicked' }
+    @file_chooser_dialog.extra_widget = @extra_button
+    case @file_chooser_dialog.run
+    when ::Gtk::Dialog::RESPONSE_ACCEPT 
+      filename = @file_chooser_dialog.filename.to_s
+      @entry_for_the_path_to_the_pdf_file.set_text(filename)
+    end
+    @file_chooser_dialog.destroy
+  end
+
+  # ========================================================================= #
+  # === connect_skeleton
+  # ========================================================================= #
+  def connect_skeleton
+    abort_on_exception
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    create_skeleton
+    connect_skeleton
+    gtk_text_for_the_gtk_entry_denoting_into_which_directory_we_will_generate_the_pdf_files = gtk_label(
+      'Set the path to the directory where these .pdf files will be kept below:'
+    )
+    gtk_text = create_label(
+      'Set the path to the .pdf file below this text.'
+    ) {{
+      tooltip: 'You need to supply the path to the .pdf file '\
+               'into the input field on the right side.'
+    }}
+    @hbox1.minimal(gtk_text)
+    @hbox1.maximal(@entry_for_the_path_to_the_pdf_file)
+    # ======================================================================= #
+    # And add the file-chooser button:
+    # ======================================================================= #
+    @hbox1.minimal(@button_file_chooser)
+    maximal(@hbox1, 1)
+
+    @vbox_denoting_where_the_individual_pdf_files_are_kept = gtk_vbox
+    @vbox_denoting_where_the_individual_pdf_files_are_kept.minimal(
+      gtk_text_for_the_gtk_entry_denoting_into_which_directory_we_will_generate_the_pdf_files,
+      1
+    )
+    @vbox_denoting_where_the_individual_pdf_files_are_kept.minimal(
+      @entry_for_the_directory_where_we_will_generate_the_individual_pdf_files_into,
+      1
+    )
+    minimal(
+      @vbox_denoting_where_the_individual_pdf_files_are_kept, 0
+    )
+    add_the_split_pdf_file_button
+    show_all
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::Gtk::SplitPdfFileModule.run
+  # ========================================================================= #
+  def self.run
+    require 'gtk_paradise/run'
+    _ = ::PdfParadise::GUI::Gtk::SplitPdfFile.new
+    r = ::Gtk.run
+    r << _
+    r.set_size_request(
+      _.width?,
+      _.height?
+    )
+    r.enable_quick_exit
+    r.top_left_then_run
+  end
+
+end; end; end; end