Class: Roebe::RemoveComments

Inherits:
Base show all
Defined in:
lib/roebe/classes/remove_comments/remove_comments.rb,
lib/roebe/classes/remove_comments/constants.rb

Overview

Roebe::RemoveComments

Constant Summary collapse

BE_VERBOSE =
#

BE_VERBOSE

#
true
DEFAULT_SPLIT_CHARACTER =
#

DEFAULT_SPLIT_CHARACTER

#
'#'

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) ⇒ RemoveComments

#

initialize

#


33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 33

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  assign_this_dataset(i)
  case run_already
  when :be_silent
    @report_result = false
    run_already = false
  when :report_result
    @report_result = true # This instance variable is normally false.
  end
  run if run_already
end

Class Method Details

.[](i) ⇒ Object

#

RemoveComments[]

#


205
206
207
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 205

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

Instance Method Details

#assign_this_dataset(i = '') ⇒ Object

#

assign_this_dataset

Input can be this:

- A string such as "/Depot/j/TODO".
#


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

def assign_this_dataset(i = '')
  if File.exist? i
    i = File.readlines(i)
  end if i.is_a? String
  if i.is_a? Array and !i.empty? # If it is an Array and it is not empty
    if File.exist? i.first
      i = File.readlines(i.first)
    end
  end
  i = [i].flatten.compact
  @dataset = i
end

#compact_the_dataset ⇒ Object

#

compact_the_dataset

#


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

def compact_the_dataset
  @dataset.compact! # Get rid of all nil entries.
end

#dataset? ⇒ Boolean Also known as: result?

#

dataset?

#

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 94

def dataset?
  @dataset
end

#get_rid_of_empty_lines? ⇒ Boolean

#

get_rid_of_empty_lines?

#

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 173

def get_rid_of_empty_lines?
  @get_rid_of_empty_lines
end

#keep_newlines? ⇒ Boolean

#

keep_newlines?

#

Returns:

  • (Boolean) 


180
181
182
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 180

def keep_newlines?
  !get_rid_of_empty_lines?
end

#purge_empty_lines ⇒ Object

#

purge_empty_lines

#


102
103
104
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 102

def purge_empty_lines
  @dataset.reject! {|entry| entry.strip.empty? }
end

#report_result ⇒ Object

#

report_result

#


130
131
132
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 130

def report_result
  e to_s
end

#reset ⇒ Object

#

reset (reset tag)

#


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 52

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @get_rid_of_empty_lines
  # ======================================================================= #
  @get_rid_of_empty_lines = true # If true then we purge all empty lines.
  # ======================================================================= #
  # === @report_result
  # ======================================================================= #
  @report_result = false
  # ======================================================================= #
  # === @dataset
  # ======================================================================= #
  @dataset = nil
  self.split_character = DEFAULT_SPLIT_CHARACTER
end

#retain_newlines ⇒ Object

#

retain_newlines

#


137
138
139
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 137

def retain_newlines
  @get_rid_of_empty_lines = false
end

#run ⇒ Object Also known as: scan_data

#

run (run tag)

#


197
198
199
200
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 197

def run
  sanitize_dataset
  report_result if @report_result
end

#sanitize_dataset ⇒ Object

#

sanitize_dataset

We reject entries that start with a ‘#’ character.

#


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

def sanitize_dataset
  # ======================================================================= #
  # .compact on it to eliminate all possible nils 
  # ======================================================================= #
  dataset?.compact!
  dataset?.reject! {|entry|
    true if entry.start_with? split_character?
  }
  # ======================================================================= #
  # Ok, all entries starting with a '#' character were purged.
  #
  # Next we chop on every entry that includes a '#' character,
  # up to that character.
  # ======================================================================= #
  dataset?.map! {|entry|
    if entry.include? split_character?
      entry = entry[0, entry.index(split_character?)]+N
    end
    entry
  }
  compact_the_dataset
  purge_empty_lines if get_rid_of_empty_lines?
end

#split_character=(i = '#') ⇒ Object

#

split_character=

#


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

def split_character=(i = '#')
  @split_character = i
end

#split_character? ⇒ Boolean

#

split_character?

#

Returns:

  • (Boolean) 


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

def split_character?
  @split_character
end

#to_s ⇒ Object Also known as: result, string?, string, _

#

to_s

#


187
188
189
 
# File 'lib/roebe/classes/remove_comments/remove_comments.rb', line 187

def to_s
  dataset?.join
end