Class: Roebe::AppendThis

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

Overview

Roebe::AppendThis.new

Constant Summary collapse

NAMESPACE =
#

NAMESPACE

#
inspect

Constants inherited from Base

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #bold_blue, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkslateblue, #deeppink, #delete_symlink, #disable_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esystem, #esystem_colourized, #ewarn, #firebrick, #get_current_day, #get_current_month, #get_files_from, #get_german_name_for_this_weekday, #gold, #grey, #hh_mm_ss, #home_dir?, #home_directory_of_user_x?, #is_a_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lime, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumspringgreen, #mediumturquoise, #mkdir, #mv, #n_days_in_this_month, #no_file_exists_at, #olivedrab, #open_in_browser, #opne, #opnn, #orange, #orchid, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_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, #return_all_directories_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, #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, #silent_redirection?, #simp, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #swarn, #symlink, #teal, #to_camelcase, #tomato, #touch, #use_colours?, #verbose_truth, #weekday?, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#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?, #return_commandline_arguments_with_leading_hyphens, #set_commandline_arguments

Constructor Details

#initialize(append_this = nil, use_these_files = :fetch_from_the_current_working_directory, run_already = true) ⇒ AppendThis

#

initialize

#

28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/roebe/classes/append_this.rb', line 28

def initialize(
    append_this     = nil,
    use_these_files = :fetch_from_the_current_working_directory,
    run_already     = true
  )
  reset
  set_append_this(
    append_this
  )
  set_modify_these_files(
    use_these_files
  )
  run if run_already
end

Class Method Details

.to(this_string = ARGV.first, files: :in_the_current_directory) ⇒ Object

#

Roebe::AppendThis.to

#

147
148
149
150
151
152
153
154
155
 
# File 'lib/roebe/classes/append_this.rb', line 147

def self.to(
    this_string = ARGV.first,
    files: :in_the_current_directory
  )
  self.new(
    prepend_this    = this_string,
    use_these_files = files
  )
end

Instance Method Details

#append_this? ⇒ Boolean

#

append_this?

#

Returns:

  • (Boolean) 

97
98
99
 
# File 'lib/roebe/classes/append_this.rb', line 97

def append_this?
  @append_this
end

#batch_modify_the_files(these_files = files? ) ⇒ Object

#

batch_modify_the_files

#

112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/roebe/classes/append_this.rb', line 112

def batch_modify_the_files(
    these_files = files?
  )
  append_this = append_this?
  if append_this.empty?
    opnn; e 'Can not append anything as the main append-string is empty.'
  else
    these_files.each {|this_file|
      new_name = "#{this_file}#{append_this}"
      opnn; e 'The new name is `'+sfile(new_name)+'`.'
      mv(this_file, new_name)
    }
  end
end

#menu(i = @append_this) ⇒ Object

#

menu (menu tag)

#

55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/roebe/classes/append_this.rb', line 55

def menu(
    i = @append_this
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # === append --help
    # ===================================================================== #
    when /^-?-?help/
      show_help
      exit
    end
  end
end

#modify_these_files? ⇒ Boolean Also known as: files?

#

modify_these_files?

#

Returns:

  • (Boolean) 

90
91
92
 
# File 'lib/roebe/classes/append_this.rb', line 90

def modify_these_files?
  @modify_these_files
end

#reset ⇒ Object

#

reset (reset tag)

#

46
47
48
49
50
 
# File 'lib/roebe/classes/append_this.rb', line 46

def reset
  super()
  @modify_these_files = []
  @namespace = NAMESPACE
end

#run ⇒ Object

#

run (run tag)

#

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

def run
  menu
  batch_modify_the_files
end

#set_append_this(i = '') ⇒ Object

#

set_append_this

#

104
105
106
107
 
# File 'lib/roebe/classes/append_this.rb', line 104

def set_append_this(i = '')
  i = [i].flatten.compact.first.to_s # We require a String here.
  @append_this = i
end

#set_modify_these_files(i = return_files_from_pwd) ⇒ Object

#

set_modify_these_files

#

75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/roebe/classes/append_this.rb', line 75

def set_modify_these_files(
    i = return_files_from_pwd
  )
  case i
  when :default,
       :in_the_current_directory,
       :fetch_from_the_current_working_directory
    i = return_files_from_pwd
  end
  @modify_these_files = [i].flatten.compact
end

#show_help ⇒ Object

#

show_help (help tag)

#

130
131
132
133
134
 
# File 'lib/roebe/classes/append_this.rb', line 130

def show_help
  e
  e 'Currently no options are available for this class.'
  e
end