Class: Roebe::CompareTheseTwoFiles

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

Overview

Roebe::CompareTheseTwoFiles

Constant Summary collapse

NAMESPACE =
#

NAMESPACE

#
inspect

Constants inherited from Base

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

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, #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, #show_help, #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(first_file = ARGV[0], second_file = ARGV[1], run_already = true) ⇒ CompareTheseTwoFiles

#

initialize

#

31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/roebe/classes/compare_these_two_files.rb', line 31

def initialize(
    first_file  = ARGV[0],
    second_file = ARGV[1],
    run_already = true
  )
  reset
  if first_file == :default
    # ======================================================================= #
    # In this case overrule everything with hardcoded paths. These
    # locations may change in the future.
    # ======================================================================= #
    first_file  = '/public/indium4/scratch/bioinf4/Mouse2/ncrna/TEST/ncrna.13.fa'
    second_file = '/public/indium4/scratch/bioinf4/Mouse2/ncrna/ncrna.13.fa'
  end
  set_first_file(
    first_file
  )
  set_second_file(
    second_file
  )
  run if run_already
end

Instance Method Details

#do_compare_the_two_filesObject

#

do_compare_the_two_files

#

114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/roebe/classes/compare_these_two_files.rb', line 114

def do_compare_the_two_files
  dataset1 = File.readlines(file1?)
  dataset2 = File.readlines(file2?)
  dataset1.each_with_index {|line1, index|
    line2 = dataset2[index]
    if (line1 == line2)
      # =================================================================== #
      # In this case all is fine. Nothing to report.
      # =================================================================== #
    else
      # =================================================================== #
      # And in that case, there must be an error.
      # =================================================================== #
      opnn; e "The two lines at file line "\
              "#{slateblue((index+1).to_s)} are different."
      e
      e royalblue(line1)
      e royalblue(line2)
      e
      show_the_path_to_the_two_files
      e
      opnn; e 'Exiting now.'
      exit
    end
  }
  opnn; e 'These two files seem to be identical, judging '\
          'from their content. '+gold(cheering_person)
end

#exit_unless_this_is_not_a_file(i) ⇒ Object

#

exit_unless_this_is_not_a_file

#

82
83
84
85
86
87
88
# File 'lib/roebe/classes/compare_these_two_files.rb', line 82

def exit_unless_this_is_not_a_file(i)
  unless File.exist? i
    opnn; e "No file exists at `#{sfile(i)}. Please provide an existing"
    opnn; e 'file in order for the comparison to work.'
    exit
  end
end

#file1?Boolean

#

file1?

#

Returns:

  • (Boolean)

107
108
109
# File 'lib/roebe/classes/compare_these_two_files.rb', line 107

def file1?
  @first_file
end

#file2?Boolean

#

file2?

#

Returns:

  • (Boolean)

100
101
102
# File 'lib/roebe/classes/compare_these_two_files.rb', line 100

def file2?
  @second_file
end

#opnnObject

#

opnn

#

93
94
95
# File 'lib/roebe/classes/compare_these_two_files.rb', line 93

def opnn
  super(NAMESPACE)
end

#resetObject

#

reset

#

57
58
59
# File 'lib/roebe/classes/compare_these_two_files.rb', line 57

def reset
  super()
end

#runObject

#

run

#

164
165
166
167
# File 'lib/roebe/classes/compare_these_two_files.rb', line 164

def run
  show_to_the_user_what_we_are_about_to_do_next
  do_compare_the_two_files
end

#set_first_file(i) ⇒ Object

#

set_first_file

#

64
65
66
67
68
# File 'lib/roebe/classes/compare_these_two_files.rb', line 64

def set_first_file(i)
  i = i.first if i.is_a? Array
  exit_unless_this_is_not_a_file(i)
  @first_file = i
end

#set_second_file(i) ⇒ Object

#

set_second_file

#

73
74
75
76
77
# File 'lib/roebe/classes/compare_these_two_files.rb', line 73

def set_second_file(i)
  i = i.first if i.is_a? Array
  exit_unless_this_is_not_a_file(i)
  @second_file = i
end

#show_the_path_to_the_two_filesObject

#

show_the_path_to_the_two_files

#

156
157
158
159
# File 'lib/roebe/classes/compare_these_two_files.rb', line 156

def show_the_path_to_the_two_files
  e sfancy(file1?)
  e sfancy(file2?)
end

#show_to_the_user_what_we_are_about_to_do_nextObject

#

show_to_the_user_what_we_are_about_to_do_next

#

146
147
148
149
150
151
# File 'lib/roebe/classes/compare_these_two_files.rb', line 146

def show_to_the_user_what_we_are_about_to_do_next
  opnn; e 'Now comparing the two following input files:'
  e
  show_the_path_to_the_two_files
  e
end