Class: Roebe::Identical

Inherits:
Base show all
Includes:
Gem::Text
Defined in:
lib/roebe/classes/identical.rb

Overview

Roebe::Identical.new

Constant Summary collapse

STRING1 =
#

STRING1

#
'abc'
STRING2 =
#

STRING2

#
'abcdefg'
ROUND_TO_N_NUMBERS =
#

ROUND_TO_N_NUMBERS

#
3

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

#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, #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, #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(string1 = STRING1, string2 = STRING2, run_already = true) ⇒ Identical

#

initialize

#

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/roebe/classes/identical.rb', line 42

def initialize(
    string1 = STRING1,
    string2 = STRING2,
    run_already = true
  )
  reset
  set_string1(string1)
  set_string2(string2)
  # ======================================================================= #
  # === Handle blocks given to this class next
  # ======================================================================= #
  if block_given?
    yielded = yield
    case yielded
    when :be_quiet
      @be_verbose = false
    end
  end
  run if run_already
end

Class Method Details

.[](string1, string2) ⇒ Object

#

Identical[]

This class method will be a silent version - we just return the identity-number.

#

128
129
130
131
132
133
# File 'lib/roebe/classes/identical.rb', line 128

def self.[](string1, string2)
  _ = self.new(string1, string2, false) # false for do not run already.
  _.be_silent
  _.run
  return _.rounded_result? # Return the result here.
end

Instance Method Details

#report_resultObject

#

report_result

#

118
119
120
# File 'lib/roebe/classes/identical.rb', line 118

def report_result
  e result?
end

#resetObject

#

reset (reset tag)

#

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

def reset
  super()
  # ======================================================================= #
  # === @be_verbose
  # ======================================================================= #
  @be_verbose = true
end

#result?Boolean Also known as: result

#

result?

#

Returns:

  • (Boolean)

111
112
113
# File 'lib/roebe/classes/identical.rb', line 111

def result?
  @result
end

#rounded_result?Boolean

#

rounded_result?

#

Returns:

  • (Boolean)

138
139
140
# File 'lib/roebe/classes/identical.rb', line 138

def rounded_result?
  result?.to_f.round(ROUND_TO_N_NUMBERS)
end

#runObject

#

run (run tag)

#

145
146
147
148
149
150
151
152
153
154
155
# File 'lib/roebe/classes/identical.rb', line 145

def run
  n_different_positions = levenshtein_distance(
    string1?,
    string2?
  )
  # smaller_string = [string1?, string2?].min # This one is not needed.
  bigger_string  = [string1?, string2?].max
  match_percentage = 100 - ( (n_different_positions.to_i * 100 ) / bigger_string.size)
  @result = match_percentage
  report_result if be_verbose? # Finally, report the above too.
end

#set_string1(i = STRING1) ⇒ Object

#

set_string1

#

77
78
79
80
81
82
# File 'lib/roebe/classes/identical.rb', line 77

def set_string1(i = STRING1)
  i = i.first if i.is_a? Array
  i = STRING1 if i.nil?
  i = i.to_s.dup
  @string1 = i
end

#set_string2(i = STRING2) ⇒ Object

#

set_string2

#

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

def set_string2(i = STRING2)
  i = i.first if i.is_a? Array
  i = STRING2 if i.nil?
  i = i.to_s.dup
  @string2 = i
end

#string1?Boolean

#

string1?

#

Returns:

  • (Boolean)

97
98
99
# File 'lib/roebe/classes/identical.rb', line 97

def string1?
  @string1
end

#string2?Boolean

#

string2?

#

Returns:

  • (Boolean)

104
105
106
# File 'lib/roebe/classes/identical.rb', line 104

def string2?
  @string2
end