pdf_paradise 0.1.43

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

@@ -0,0 +1,294 @@
+#!/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
+    # ======================================================================= #
+    @width  = WIDTH
+    # ======================================================================= #
+    # === @height
+    # ======================================================================= #
+    @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 = gtk_vbox
+    create_buttons
+    create_gtk_entries
+  end
+
+  # ========================================================================= #
+  # === create_gtk_entries                                      (entries tag)
+  # ========================================================================= #
+  def create_gtk_entries
+    @entry_for_the_path_to_the_pdf_file = gtk_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 = gtk_button('Choose a file')
+    @button_file_chooser.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 = gtk_button('Split the pdf file')
+    @button_split_the_pdf_file.lightgreen
+    @button_split_the_pdf_file.fancy_tooltip =
+      '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
+  #
+  # 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.to_s
+    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 = gtk_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 = gtk_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 = gtk_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

data/lib/pdf_paradise/gui/shared_code/statistics_widget/statistics_widget_module.rb

@@ -0,0 +1,333 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::Gtk::StatisticsWidgetModule
+# =========================================================================== #
+# require 'pdf_paradise/gui/shared_code/statistics_widget/statistics_widget_module.rb'
+# include ::PdfParadise::GUI::Gtk::StatisticsWidgetModule
+# =========================================================================== #
+module PdfParadise
+
+module GUI
+
+module Gtk
+
+module StatisticsWidgetModule
+
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  require 'pdf_paradise/pdf_file_n_total_pages.rb'
+  require 'pdf_paradise/toplevel_methods/automatic_pdf_title.rb'
+  require 'pdf_paradise/toplevel_methods/query_pdf_title.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Show statistics about the .pdf file at hand'
+
+  # ========================================================================= #
+  # === FONT_SIZE
+  # ========================================================================= #
+  FONT_SIZE = 18
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = "Liberation serif #{FONT_SIZE}"
+
+  # ========================================================================= #
+  # === USE_THIS_FONT_FOR_THE_DISPLAY_AREA
+  # ========================================================================= #
+  USE_THIS_FONT_FOR_THE_DISPLAY_AREA = 'DejaVu Sans Mono 18' # :hack_18
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 1820
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 840
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument is assumed to be the parent-widget.
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    super(:vertical) # Vertical box in style.
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    abort_on_exception
+    reset_the_internal_variables
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, NAMESPACE]
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    @title  = TITLE
+    # ======================================================================= #
+    # === @width
+    # ======================================================================= #
+    @width  = WIDTH
+    @height = HEIGHT
+    set_use_this_font(USE_THIS_FONT)
+    use_gtk_paradise_project_css_file
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    0
+  end
+
+  # ========================================================================= #
+  # === parent_widget?
+  # ========================================================================= #
+  def parent_widget?
+    @commandline_arguments.first
+  end
+
+  # ========================================================================= #
+  # === main_entry?
+  # ========================================================================= #
+  def main_entry?
+    @gtk_entry
+  end
+
+  # ========================================================================= #
+  # === create_the_entries
+  # ========================================================================= #
+  def create_the_entries
+    @gtk_entry = gtk_entry
+    @gtk_entry.yellow_background
+    @gtk_entry.bblack1
+    @gtk_entry.css_class('pad4px')
+  end
+
+  # ========================================================================= #
+  # === create_the_buttons                          (buttons tag, button tag)
+  # ========================================================================= #
+  def create_the_buttons
+    # ======================================================================= #
+    # === @button_choose_file
+    # ======================================================================= #
+    @button_choose_file = gtk_file_chooser_button
+    @button_choose_file.hint = 'Click on this button to open a '\
+      'local <b>.pdf</b> file.'
+    @button_choose_file.lightgreen
+    @button_choose_file.on_clicked {
+      do_create_a_new_file_chooser_dialog_and_then_set_the_main_entry_to(main_file?)
+    }
+    # ======================================================================= #
+    # === @button_analyse
+    # ======================================================================= #
+    @button_analyse = gtk_button('_Analyse the .pdf file')
+    @button_analyse.lightgreen
+    @button_analyse.hint =
+      'Click this button to obtain some information about '\
+      'the .pdf file at hand.'
+    @button_analyse.on_clicked {
+      do_analyse_the_pdf_file
+    }
+    # ======================================================================= #
+    # === @button_auto_title
+    # ======================================================================= #
+    @button_auto_title = gtk_button('Automatic Title')
+    @button_auto_title.hint = 'Click on this button to automatically '\
+      'determine the title for this .pdf file, based on the filename.'
+    @button_auto_title.on_clicked {
+      do_automatically_determine_the_title_for_the_pdf_file_at_hand
+    }
+    @button_open_via_a_pdf_reader = gtk_button('Open via a pdf-reader')
+    @button_open_via_a_pdf_reader.hint = 'This will open the .pdf '\
+      'file in a pdf-reader.'
+    @button_open_via_a_pdf_reader.on_clicked {
+      do_open_the_local_pdf_file_in_the_pdf_reader
+    }
+    return_all_buttons.each {|this_button|
+      this_button.bblack1
+    }
+    @button_auto_title.bblack3
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                                          (create tag)
+  # ========================================================================= #
+  def create_skeleton
+    create_the_entries
+    create_the_buttons
+    @label = gtk_left_aligned_label
+    @label.set_font(USE_THIS_FONT_FOR_THE_DISPLAY_AREA)
+
+    @label.make_selectable
+    @hbox_containing_the_entry = gtk_hbox
+
+    @arrow_right = emoji(:arrow_right)
+    @event_box_arrow_right = gtk_eventbox(@arrow_right)
+    @event_box_arrow_right.on_clicked {
+      do_create_a_new_file_chooser_dialog_and_then_set_the_main_entry_to(main_file?)
+    }
+    @hbox_containing_the_entry.minimal(
+      @event_box_arrow_right
+    )
+    @hbox_containing_the_entry.maximal(@gtk_entry)
+  end
+
+  # ========================================================================= #
+  # === connect_skeleton                      (connect skeleton, connect tag)
+  # ========================================================================= #
+  def connect_skeleton
+    _ = top_bar
+    _.add(@button_auto_title)
+    _.add(@button_open_via_a_pdf_reader)
+    minimal(_)
+    minimal(
+      gtk_left_aligned_label(
+        'This small widget will show some information about the .pdf file at hand.'
+      ), 4
+    )
+    minimal(@hbox_containing_the_entry, 4)
+    button_box = gtk_button_box(
+      @button_choose_file,
+      @button_analyse
+    ) {{ layout:  :horizontal,
+         padding: 2 }}
+    button_box.spacing = 2
+    button_box.layout = :expand
+    minimal(button_box,                 4)
+    minimal(@label,                     4)
+  end
+
+  # ========================================================================= #
+  # === do_create_a_new_file_chooser_dialog_and_then_set_the_main_entry_to
+  # ========================================================================= #
+  def do_create_a_new_file_chooser_dialog_and_then_set_the_main_entry_to(
+      i = main_file?.to_s
+    )
+    create_a_new_file_chooser_dialog(parent_widget?) {{
+      filter:             '.pdf',
+      additional_folders: '/Depot/j/',
+      start_directory:    '/Depot/'
+    }}
+    _ = assigned_main_file?.to_s
+    if _ and !_.empty?
+      main_entry?.set_text(_)
+      do_analyse_the_pdf_file
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    create_skeleton_then_connect_skeleton
+    show_all
+    Thread.new {
+      sleep 0.001
+      main_entry?.do_focus
+    }
+  end
+
+  # ========================================================================= #
+  # === do_analyse_the_pdf_file
+  #
+  # This is the method that will analyse the .pdf file at hand.
+  # ========================================================================= #
+  def do_analyse_the_pdf_file
+    this_pdf_file = main_entry?.text.to_s
+    _ = ''.dup
+    _ << "This .pdf file has the following characteristics:\n\n"
+    _ << '    <b>n pages</b>: '+::PdfParadise.n_pages?(this_pdf_file).to_s
+    _ << "\n"
+    use_this_title = ::PdfParadise.title?(this_pdf_file).to_s
+    if use_this_title.empty?
+      use_this_title = '(This .pdf file has no title)'
+    end
+    _ << "    <b>title</b>: #{use_this_title}"
+    _ << "\n"
+    @label.set_text(_)
+    @label.do_markify
+  end
+
+  # ========================================================================= #
+  # === do_automatically_determine_the_title_for_the_pdf_file_at_hand
+  # ========================================================================= #
+  def do_automatically_determine_the_title_for_the_pdf_file_at_hand
+    this_pdf_file = main_entry?.text.to_s
+    if this_pdf_file and !this_pdf_file.empty?
+      ::PdfParadise.automatic_pdf_title(this_pdf_file)
+      do_analyse_the_pdf_file
+    else
+      popup_over_this_widget(
+        main_entry?,
+        'Please first assign a .pdf file, before '\
+        'this functionality can be used.'
+      )
+    end
+  end
+
+  # ========================================================================= #
+  # === do_open_the_local_pdf_file_in_the_pdf_reader
+  # ========================================================================= #
+  def do_open_the_local_pdf_file_in_the_pdf_reader
+    this_pdf_file = main_entry?.text.to_s
+    if this_pdf_file and !this_pdf_file.empty?
+      Thread.new {
+        esystem("evince #{this_pdf_file}")
+      }
+    else
+      popup_over_this_widget(
+        main_entry?,
+        'Please first assign a .pdf file, before '\
+        'this functionality can be used.'
+      )
+    end
+  end
+
+end; end; end
+
+# =========================================================================== #
+# === PdfParadise.start_gtk_gui_statistics_widget
+# =========================================================================== #
+def self.start_gtk_gui_statistics_widget
+  require 'gtk_paradise/run'
+  r = ::Gtk.run
+  _ = PdfParadise::GUI::Gtk::StatisticsWidget.new(r)
+  r << _
+  r.automatic_size
+  r.automatic_title
+  r.top_left_then_run
+end
+
+# =========================================================================== #
+# === PdfParadise.return_widget_about_this_pdf_file
+# =========================================================================== #
+def self.return_widget_about_this_pdf_file
+  ::PdfParadise::GUI::Gtk::StatisticsWidget.new
+end
+
+end