Class: Roebe::PrependThis

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

Overview

Roebe::PrependThis

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, #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(prepend_this = nil, use_these_files = :fetch_from_the_current_working_directory, run_already = true) ⇒ PrependThis

#

initialize

#

30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/roebe/classes/prepend_this.rb', line 30

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

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::PrependThis[]

#

243
244
245
# File 'lib/roebe/classes/prepend_this.rb', line 243

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

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

#

Roebe::PrependThis.to

#

250
251
252
253
254
255
256
257
258
# File 'lib/roebe/classes/prepend_this.rb', line 250

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

#batch_modify_the_files(these_files = files? ) ⇒ Object

#

batch_modify_the_files

#

176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/roebe/classes/prepend_this.rb', line 176

def batch_modify_the_files(
    these_files = files?
  )
  prepend_this = prepend_this?
  if prepend_this.empty?
    opne 'Can not prepend anything as the main prepend-string is empty.'
  else
    these_files.each {|this_file|
      new_name = "#{prepend_this}#{this_file}"
      opnn; e 'The new name is `'+sfile(new_name)+'`.'
      mv(this_file, new_name)
      # =================================================================== #
      # Keep track of the rename-operations next. The Hash format will
      # first show the ORIGINAL filename, and then the NEW filename.
      # =================================================================== #
      @hash_logging_actions_done_by_this_class[File.absolute_path(this_file)] =
        File.absolute_path(new_name)
    }
  end
end

#consider_logging_the_operations_that_were_done_by_this_classObject

#

consider_logging_the_operations_that_were_done_by_this_class (store tag)

#

229
230
231
232
233
234
235
236
237
238
# File 'lib/roebe/classes/prepend_this.rb', line 229

def consider_logging_the_operations_that_were_done_by_this_class
  unless @hash_logging_actions_done_by_this_class.empty?
    into = store_where?
    opnn; e "Logging the prepend-operations that were done "\
            "into the local file"
    opnn; e "  `(#{sfile(into)})`."
    what = YAML.dump(hash?)
    write_what_into(what, into)
  end
end

#hash_logging_actions_done_by_this_class?Boolean Also known as: hash?

#

hash_logging_actions_done_by_this_class?

#

Returns:

  • (Boolean)

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

def hash_logging_actions_done_by_this_class?
  @hash_logging_actions_done_by_this_class
end
#

menu (menu tag)

#

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/roebe/classes/prepend_this.rb', line 108

def menu(i)
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # === prepend --revert
    # ===================================================================== #
    when /^-?-?revert$/i,
         /^-?-?reverse$/i,
         /^-?-?undo$/i # === prepend --undo
      revert_the_last_operation
      exit
    # ===================================================================== #
    # === help
    # ===================================================================== #
    when /help/
      show_help
      exit
    end
  end
end

#modify_these_files?Boolean Also known as: files?

#

modify_these_files?

#

Returns:

  • (Boolean)

92
93
94
# File 'lib/roebe/classes/prepend_this.rb', line 92

def modify_these_files?
  @modify_these_files
end

#opne(i) ⇒ Object

#

opne

#

200
201
202
# File 'lib/roebe/classes/prepend_this.rb', line 200

def opne(i)
  opnn; e i
end

#prepend_this?Boolean

#

prepend_this?

#

Returns:

  • (Boolean)

134
135
136
# File 'lib/roebe/classes/prepend_this.rb', line 134

def prepend_this?
  @prepend_this
end

#resetObject

#

reset (reset tag)

#

48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/roebe/classes/prepend_this.rb', line 48

def reset
  super()
  # ======================================================================= #
  # === @namespace
  # ======================================================================= #
  @namespace = NAMESPACE
  # ======================================================================= #
  # === @hash_logging_actions_done_by_this_class
  #
  # The next Hash is useful because we can store what happened while this
  # class is working.
  # ======================================================================= #
  @hash_logging_actions_done_by_this_class = {}
  # ======================================================================= #
  # === @modify_these_files
  # ======================================================================= #
  @modify_these_files = []
end

#revert_the_last_operationObject

#

revert_the_last_operation

To invoke this method from the commandline, try:

prepend --revert
#

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/roebe/classes/prepend_this.rb', line 146

def revert_the_last_operation
  opnn; e 'Now attempting to revert the last prepend-operation.'
  _ = store_where?
  if File.exist?(_)
    opnn; e 'Using the information from the file '+sfile(_)+'.'
    hash_dataset = YAML.load_file(_)
    hash_dataset.each_pair {|old_file, existing_file|
      if File.exist? existing_file
        opnn; e 'Renaming/moving file from '+
                 sfile(existing_file)+' to '+sfile(old_file)
        move_file(existing_file, old_file)
      else
        opnn; no_file_at(existing_file)
      end
    }
  else
    opnn; no_file_exists_at(_)
  end
end

#runObject

#

run (run tag)

#

221
222
223
224
# File 'lib/roebe/classes/prepend_this.rb', line 221

def run
  batch_modify_the_files
  consider_logging_the_operations_that_were_done_by_this_class
end

#set_modify_these_files(i = return_files_from_pwd) ⇒ Object

#

set_modify_these_files

#

77
78
79
80
81
82
83
84
85
86
87
# File 'lib/roebe/classes/prepend_this.rb', line 77

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

#set_prepend_this(i = 'DONE_') ⇒ Object

#

set_prepend_this

#

99
100
101
102
103
# File 'lib/roebe/classes/prepend_this.rb', line 99

def set_prepend_this(i = 'DONE_')
  menu(i)
  i = [i].flatten.compact.first.to_s # We require a String here.
  @prepend_this = i
end

#show_helpObject

#

show_help

#

207
208
209
210
211
212
213
214
215
216
# File 'lib/roebe/classes/prepend_this.rb', line 207

def show_help
  e 'The class is currently very limited from the commandline.'
  e
  e 'Simply input the string that you wish to prepend, such as:'
  e
  e '  DONE_'
  e
  e '  --reverse # reverse the last prepend-operation (undo operation)'
  e
end

#store_where?Boolean

#

store_where?

#

Returns:

  • (Boolean)

169
170
171
# File 'lib/roebe/classes/prepend_this.rb', line 169

def store_where?
  "#{log_dir?}prepend_actions.yml"
end