Class: Roebe::FindAllFilesWithAQuestionMark

Inherits:
Base
  • Object
show all
Defined in:
lib/roebe/classes/find_all_files_with_a_question_mark.rb

Overview

FindAllFilesWithAQuestionMark.new

Constant Summary collapse

ALSO_BATCH_RENAME_THESE_FILES =
#

ALSO_BATCH_RENAME_THESE_FILES

If the following constant is set to true, then we will also batch rename these files to not include a ‘?’ token.

#
true

Constants inherited from Base

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

Class Method Summary collapse

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(i = nil, run_already = true) ⇒ FindAllFilesWithAQuestionMark

#

initialize

#


33
34
35
36
37
38
39
40
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 33

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_input(i)
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

[]

#


140
141
142
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 140

def self.[](i = '')
  self.new(i)
end

Instance Method Details

#consider_renaming_these_files ⇒ Object

#

consider_renaming_these_files

#


115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 115

def consider_renaming_these_files
  _ = @all_files
  if _.empty?
    opne 'No file with a "?" character in its file name was found.'
    opne 'The directory '+sdir(@work_on_this_directory)+' and '\
            'its subdirectories were searched.'
  else
    _.each {|this_file|
      rename(this_file) # This method will do the reporting for us.
    }
  end
end

#input? ⇒ Boolean

#

input?

#

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 62

def input?
  @input
end

#obtain_all_files ⇒ Object

#

obtain_all_files

#


77
78
79
80
81
82
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 77

def obtain_all_files
  @all_files = Dir[@work_on_this_directory+'**/**'].select {|entry|
    File.file?(entry)
  }
  sanitize_all_files
end

#rename(this_file) ⇒ Object

#

rename

#


99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 99

def rename(this_file)
  new_filename = this_file.dup
  extname = File.extname(new_filename) # This will be e. g. ".rb"
  if new_filename.end_with?('?'+extname)
    new_filename.gsub!(/\?#{extname}/,extname)
  end
  that_file = new_filename
  unless this_file == that_file
    e 'Now renaming from `'+sfile(this_file)+'` to `'+sfile(that_file)+'`.'
    FileUtils.mv(this_file, new_filename)
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


45
46
47
48
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 45

def reset
  super()
  infer_the_namespace
end

#run ⇒ Object

#

run (run tag)

#


131
132
133
134
135
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 131

def run
  set_work_on_this_directory(Dir.pwd)
  obtain_all_files
  consider_renaming_these_files
end

#sanitize_all_files ⇒ Object

#

sanitize_all_files

This is deliberately its own method. We want to select only file names that include a ‘?’ as part of their name.

#


90
91
92
93
94
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 90

def sanitize_all_files
  @all_files.select! {|entry|
    entry.include?('?')
  }
end

#set_input(i = '') ⇒ Object

#

set_input

#


53
54
55
56
57
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 53

def set_input(i = '')
  i = i.first if i.is_a? Array
  i = i.to_s.dup
  @input = i
end

#set_work_on_this_directory(i = Dir.pwd) ⇒ Object

#

set_work_on_this_directory

#


69
70
71
72
 
# File 'lib/roebe/classes/find_all_files_with_a_question_mark.rb', line 69

def set_work_on_this_directory(i = Dir.pwd)
  i << '/' unless i.end_with? '/'
  @work_on_this_directory = i
end