Class: Roebe::ConvertEncodingOfThisFile

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

Overview

Roebe::ConvertEncodingOfThisFile

Constant Summary collapse

DEFAULT_SEARCH_FOR_THIS_LINE =
#

DEFAULT_SEARCH_FOR_THIS_LINE

#
'# Encoding: ISO-8859-1'
DEFAULT_REPLACE_WITH_THIS_LINE =
#

DEFAULT_REPLACE_WITH_THIS_LINE

#
'# Encoding: UTF-8'

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, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #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, #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(commandline_arguments = ARGV, input_files = nil, run_already = true) ⇒ ConvertEncodingOfThisFile

#

initialize

#


47
48
49
50
51
52
53
54
55
56
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 47

def initialize(
    commandline_arguments = ARGV,
    input_files           = nil,
    run_already           = true
  )
  reset
  set_commandline_arguments(commandline_arguments)
  set_input_files(input_files)
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::ConvertEncodingOfThisFile[]

#


207
208
209
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 207

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

Instance Method Details

#dataset_has_fitting_line?Boolean

#

dataset_has_fitting_line?

#

Returns:

  • (Boolean)


197
198
199
200
201
202
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 197

def dataset_has_fitting_line?
  seek_this_entry = seek_which_entry?
  @dataset.any? {|line|
    line.include? seek_this_entry
  }
end

#input_files?Boolean

#

input_files?

#

Returns:

  • (Boolean)


124
125
126
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 124

def input_files?
  @input_files
end
#

menu (menu tag)

#


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 131

def menu(
    i = @commandline_arguments
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i
    # ===================================================================== #
    # === convert_encoding --all
    # ===================================================================== #
    when /^--all$/
      set_files(:all)
    end
  end
end

#replace_with_this_line?Boolean Also known as: replace_with?, seek_this_replacement?

#

replace_with_this_line?

#

Returns:

  • (Boolean)


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

def replace_with_this_line?
  @replace_with_this_line
end

#resetObject

#

reset (reset tag)

#


61
62
63
64
65
66
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 61

def reset
  super()
  infer_the_namespace
  set_search_for_this_line
  set_replace_with_this_line
end

#runObject

#

run (run tag)

#


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 150

def run
  menu
  if @input_files.empty?
    opne "#{rev}Please provide at the least one input-file."
  else
    seek_this_entry       = seek_which_entry?
    seek_this_replacement = seek_this_replacement?
    @input_files.each {|work_on_this_file|
      if File.exist? work_on_this_file
        @dataset = read_lines_via_iso_encoding(work_on_this_file).map(&:chomp)
        if dataset_has_fitting_line?
          # =============================================================== #
          # Ok this dataset has the fitting line. We can thus replace
          # the line, and then save the dataset.
          # =============================================================== #
          _ = ''.dup
          @dataset.each {|this_line|
            if this_line.include? seek_this_entry
              this_line = seek_this_replacement.dup
            end
            _ << "#{this_line}#{N}"
          }
          store_this_dataset(_.chomp, work_on_this_file)
        else
          opne 'No entry called '+sfile(seek_which_entry?)+
                rev+' was found for file '+
                sfile(work_on_this_file)+
                rev+'.'
        end
      else
        opne "No file exists at #{sfile(work_on_this_file)}"
      end
    }
  end
end

#search_for_this_line?Boolean Also known as: search_for_which_line?, seek_which_entry?

#

search_for_this_line?

#

Returns:

  • (Boolean)


84
85
86
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 84

def search_for_this_line?
  @search_for_this_line
end

#set_input_files(i = nil) ⇒ Object Also known as: set_files

#

set_input_files

#


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

def set_input_files(i = nil)
  case i
  when :all, nil
    i = Dir['**/**']
  end
  i = [i] unless i.is_a? Array
  i.reject! {|entry|
    File.directory?(entry) # Reject directories.
  }
  @input_files = i
end

#set_replace_with_this_line(i = DEFAULT_REPLACE_WITH_THIS_LINE) ⇒ Object

#

set_replace_with_this_line

#


92
93
94
95
96
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 92

def set_replace_with_this_line(
    i = DEFAULT_REPLACE_WITH_THIS_LINE
  )
  @replace_with_this_line = i
end

#set_search_for_this_line(i = DEFAULT_SEARCH_FOR_THIS_LINE) ⇒ Object

#

set_search_for_this_line

This method will specify for which line we will search.

By default, it will be invoked from within the method reset().

#


75
76
77
78
79
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 75

def set_search_for_this_line(
    i = DEFAULT_SEARCH_FOR_THIS_LINE
  )
  @search_for_this_line = i
end

#store_this_dataset(what, into) ⇒ Object

#

store_this_dataset

#


189
190
191
192
# File 'lib/roebe/classes/convert_encoding_of_this_file.rb', line 189

def store_this_dataset(what, into)
  opne 'Now saving a new dataset into '+sfile(into)+'.'
  save_what_into(what, into)
end