Class: Roebe::Upcaser

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

Constant Summary

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(from_where = return_pwd, run_already = true) ⇒ Upcaser

#

initialize

#


22
23
24
25
26
27
28
29
30
31
# File 'lib/roebe/classes/upcaser.rb', line 22

def initialize(
    from_where  = return_pwd,
    run_already = true
  )
  reset
  set_from_where(
    from_where
  )
  run if run_already
end

Instance Method Details

#execute_sys_cmdObject

#

execute_sys_cmd

#


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/roebe/classes/upcaser.rb', line 80

def execute_sys_cmd
  @files.each { |file|
    new_filename = rds(
      "#{File.dirname(file)}/#{File.basename(file).upcase}"
    )
    # ===================================================================== #
    # Rename the files here.
    # ===================================================================== #
    unless file == new_filename
      # =================================================================== #
      # Also store what we have done into the following Hash.
      # =================================================================== #
      @hash_these_files_were_renamed[file] = new_filename
      FileUtils.mv(file, new_filename)
    end
  }
end

#filesBoolean

#

files?

#

files

Returns:

  • (Boolean)


68
69
70
# File 'lib/roebe/classes/upcaser.rb', line 68

def files?
  @files
end

#files?Boolean

#

files?

#

Returns:

  • (Boolean)


66
67
68
# File 'lib/roebe/classes/upcaser.rb', line 66

def files?
  @files
end

#hash_these_files_were_renamed?Boolean Also known as: main_hash?

#

hash_these_files_were_renamed?

#

Returns:

  • (Boolean)


101
102
103
# File 'lib/roebe/classes/upcaser.rb', line 101

def hash_these_files_were_renamed?
  @hash_these_files_were_renamed
end

#resetObject

#

reset

#


36
37
38
39
40
41
42
43
44
# File 'lib/roebe/classes/upcaser.rb', line 36

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @hash_these_files_were_renamed
  # ======================================================================= #
  @hash_these_files_were_renamed = {}
  select_all_files_from_the_main_directory
end

#runObject

#

run

#


122
123
124
125
# File 'lib/roebe/classes/upcaser.rb', line 122

def run
  execute_sys_cmd
  save_the_main_hash
end

#save_the_main_hashObject

#

save_the_main_hash

#


108
109
110
111
112
113
114
115
116
117
# File 'lib/roebe/classes/upcaser.rb', line 108

def save_the_main_hash
  target_directory = '/Depot/Temp/roebe/'
  if is_on_roebe? or File.directory?(target_directory)
    what = YAML.dump(main_hash?)
    mkdir(target_directory)
    into = "#{target_directory}these_files_were_upcased.yml"
    opne "Also storing which files were upcased into `#{sfile(into)}`."
    write_what_into(what, into)
  end
end

#select_all_files_from_the_main_directoryObject

#

select_all_files_from_the_main_directory

#


49
50
51
52
# File 'lib/roebe/classes/upcaser.rb', line 49

def select_all_files_from_the_main_directory
  @files = Dir["#{@from_where}*"]
  @files.reject! {|entry| ! File.file? entry }
end

#set_from_where(i) ⇒ Object

#

set_from_where

#


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

def set_from_where(i)
  i = i.to_s.dup
  i << '/' unless i.end_with? '/' 
  @from_where = i
end