Class: Roebe::SanitizeThisBookPath

Inherits:
Base show all
Defined in:
lib/roebe/classes/books/sanitize_this_book_path/sanitize_this_book_path.rb

Overview

Roebe::SanitizeThisBookPath

Constant Summary collapse

DIRECTORY_FOR_ALL_BOOKS =
#

DIRECTORY_FOR_ALL_BOOKS

Modify this path to adjust to your own path.

#
'/home/x/books/'

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #show_help, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

#initialize(commandline_arguments = ARGV, run_already = true) ⇒ SanitizeThisBookPath

#

initialize

#


31
32
33
34
35
36
37
38
39
40
 
# File 'lib/roebe/classes/books/sanitize_this_book_path/sanitize_this_book_path.rb', line 31

def initialize(
    commandline_arguments = ARGV,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  run if run_already
end

Instance Method Details

#autotitle_the_pdf_file(i = work_on_this_file? ) ⇒ Object

#

autotitle_the_pdf_file

#


74
75
76
77
78
 
# File 'lib/roebe/classes/books/sanitize_this_book_path/sanitize_this_book_path.rb', line 74

def autotitle_the_pdf_file(
    i = work_on_this_file?
  )
  ::PdfParadise.autotitle(i)
end

#reset ⇒ Object

#

reset (reset tag)

#


45
46
47
48
49
50
51
52
 
# File 'lib/roebe/classes/books/sanitize_this_book_path/sanitize_this_book_path.rb', line 45

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === :work_on_this_file
  # ======================================================================= #
  @internal_hash[:work_on_this_file] = nil
end

#run ⇒ Object

#

run (run tag)

#


83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/roebe/classes/books/sanitize_this_book_path/sanitize_this_book_path.rb', line 83

def run
  _ = first_argument?
  if _ and File.exist?(_)
    set_work_on_this_file(_)
    _ = work_on_which_file?
    autotitle_the_pdf_file # Always make sure the title is properly set.
    # ===================================================================== #
    # Next we must find out the new name of the directory.
    # ===================================================================== #
    target = DIRECTORY_FOR_ALL_BOOKS+
             File.basename(_).
             delete_suffix('.pdf')
    unless File.exist? target
      opne 'Creating the directory '+sfile(target)+' next:'
      mkdir(target)
    end
    # ===================================================================== #
    # Next we must move the file into that directory.
    # ===================================================================== #
    if File.directory?(target)
      new_target = target+'/'+File.basename(_)
      opne 'Now moving the file at '+sfile(_)
      opne 'towards '+sfile(new_target)
      move_file(_, new_target)
    end
  else
    opne tomato('Please provide a filename (a .pdf file) to this class.')
  end
end

#set_work_on_this_file(i) ⇒ Object

#

set_work_on_this_file

#


57
58
59
60
61
62
 
# File 'lib/roebe/classes/books/sanitize_this_book_path/sanitize_this_book_path.rb', line 57

def set_work_on_this_file(i)
  if i and File.exist?(i)
    i = File.absolute_path(i)
  end
  @internal_hash[:work_on_this_file] = i
end

#work_on_this_file? ⇒ Boolean Also known as: work_on_which_file?

#

work_on_this_file?

#

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/roebe/classes/books/sanitize_this_book_path/sanitize_this_book_path.rb', line 67

def work_on_this_file?
  @internal_hash[:work_on_this_file]
end