Class: Roebe::RemoveLine

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

Overview

Roebe::RemoveLine

Constant Summary collapse

DEFAULT_FILE =
#

DEFAULT_FILE

#
'Makefile'
DEFAULT_LINE_NUMBER_THAT_IS_TO_BE_REMOVED =
#

DEFAULT_LINE_NUMBER_THAT_IS_TO_BE_REMOVED

#
10

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, #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, #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(which_line_number = DEFAULT_LINE_NUMBER_THAT_IS_TO_BE_REMOVED, this_file = DEFAULT_FILE, run_already = true) ⇒ RemoveLine

#

initialize

#


45
46
47
48
49
50
51
52
53
54
# File 'lib/roebe/classes/remove_line.rb', line 45

def initialize(
    which_line_number = DEFAULT_LINE_NUMBER_THAT_IS_TO_BE_REMOVED,
    this_file         = DEFAULT_FILE,
    run_already       = true
  )
  reset
  set_line_number(which_line_number)
  set_file(this_file)
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::RemoveLine[]

#


152
153
154
# File 'lib/roebe/classes/remove_line.rb', line 152

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

Instance Method Details

#do_remove_the_lineObject

#

do_remove_the_line

#


67
68
69
70
71
72
73
# File 'lib/roebe/classes/remove_line.rb', line 67

def do_remove_the_line # we work on the array here.
  opne rev+'Removing line number '+
       steelblue(@line_number)+rev+' next,'
  opne 'from the file '+sfile(file?)+'.'
  @array[@line_number - 1] = nil
  @array.compact! # Not a 100% perfect solution but it's ok for now.
end

#exit_program(exit_code = 1) ⇒ Object

#

exit_program

#


78
79
80
# File 'lib/roebe/classes/remove_line.rb', line 78

def exit_program(exit_code = 1)
  exit(exit_code)
end

#file?Boolean

#

file?

#

Returns:

  • (Boolean)


136
137
138
# File 'lib/roebe/classes/remove_line.rb', line 136

def file?
  @file
end

#read_file(this_file = @file) ⇒ Object

#

read_file

#


124
125
126
127
128
129
130
131
# File 'lib/roebe/classes/remove_line.rb', line 124

def read_file(this_file = @file)
  if File.exist? this_file
    @array = File.readlines(this_file)
  else
    e 'Can not read file '+sfile(this_file)+' as it does not exist.'
    exit_program
  end
end

#resetObject

#

reset (reset tag)

#


59
60
61
62
# File 'lib/roebe/classes/remove_line.rb', line 59

def reset
  super()
  infer_the_namespace
end

#runObject

#

run (run tag)

#


143
144
145
146
147
# File 'lib/roebe/classes/remove_line.rb', line 143

def run
  read_file
  do_remove_the_line
  write_what_into(@array.join, @file)
end

#set_file(i = DEFAULT_FILE) ⇒ Object

#

set_file

#


108
109
110
111
# File 'lib/roebe/classes/remove_line.rb', line 108

def set_file(i = DEFAULT_FILE)
  i = DEFAULT_FILE if i.nil?
  @file = i # The input file.
end

#set_line_number(i) ⇒ Object

#

set_line_number

#


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

def set_line_number(i)
  case i
  when '?','help','hel','he','h'
    show_help_then_exit
  end
  @line_number = i.to_i
end

#show_helpObject

#

show_help

This method will show some help to the user in how to use it.

#


87
88
89
90
91
92
# File 'lib/roebe/classes/remove_line.rb', line 87

def show_help
  e rev+'This script accepts two arguments:'
  e '  - The first argument denotes the '+gold('LINE')+rev+'.'
  e '  - The second argument denotes the '+gold('FILE')+
    ' (defaulting to '+sfile(DEFAULT_FILE)+rev+').'
end

#show_help_then_exitObject

#

show_help_then_exit

#


116
117
118
119
# File 'lib/roebe/classes/remove_line.rb', line 116

def show_help_then_exit
  show_help
  exit_program
end