Class: Roebe::SyntaxChecker

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

Overview

Roebe::SyntaxChecker

Constant Summary

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(commandline_arguments = nil, run_already = true) ⇒ SyntaxChecker

#

initialize

#


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

def initialize(
    commandline_arguments = nil,
    run_already           = true
  )
  reset
  if commandline_arguments and commandline_arguments.is_a?(Symbol)
    case commandline_arguments
    # ===================================================================== #
    # === :do_not_run_yet
    # ===================================================================== #
    when :do_not_run_yet
      run_already = false
      commandline_arguments = []
    end
  end
  set_commandline_arguments(
    commandline_arguments
  )
  if first_argument?
    set_work_on_this_file(first_argument?)
  end
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::SyntaxChecker[]

#


185
186
187
 
# File 'lib/roebe/classes/syntax_checker.rb', line 185

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

.is_this_java_file_ok?(i) ⇒ Boolean

#

Roebe::SyntaxChecker.is_this_java_file_ok?

This checks whether the syntax for a given .java file is ok.

#

Returns:

  • (Boolean) 


147
148
149
150
151
152
153
 
# File 'lib/roebe/classes/syntax_checker.rb', line 147

def self.is_this_java_file_ok?(i)
  _ = Roebe::SyntaxChecker.new(:do_not_run_yet)
  _.set_work_on_this_file(i)
  _.be_quiet
  _.run
  return _.all_is_ok?
end

Instance Method Details

#all_is_ok? ⇒ Boolean

#

all_is_ok?

#

Returns:

  • (Boolean) 


158
159
160
 
# File 'lib/roebe/classes/syntax_checker.rb', line 158

def all_is_ok?
  !was_an_error_encountered?
end

#be_quiet ⇒ Object

#

be_quiet

#


75
76
77
 
# File 'lib/roebe/classes/syntax_checker.rb', line 75

def be_quiet
  @be_verbose = false
end

#do_check_the_syntax_of_this_java_file(i) ⇒ Object

#

do_check_the_syntax_of_this_java_file

#


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/roebe/classes/syntax_checker.rb', line 165

def do_check_the_syntax_of_this_java_file(i)
  cmd_to_use = 'javac'.dup
  if File.exist?(i)
    dataset = File.read(i)
    if dataset.include?('classpath:')
      dataset =~ /^classpath: "(.+)"/
      cmd_to_use << " -cp \"#{$1}\""
    end
  end
  cmd_to_use << " #{i} 2>&1"
  result = `#{cmd_to_use}`
  if result.include? " error\n"
    found_an_error
  end
  feedback_the_error_if_an_error_was_encountered(result)
end

#feedback_the_error_if_an_error_was_encountered(result) ⇒ Object

#

feedback_the_error_if_an_error_was_encountered

#


102
103
104
105
106
107
108
109
110
 
# File 'lib/roebe/classes/syntax_checker.rb', line 102

def feedback_the_error_if_an_error_was_encountered(result)
  if @be_verbose
    cliner(use_this_token: '▁')
    e
    e tomato(result) if was_an_error_encountered?
    cliner(use_this_token: '▁')
    e
  end
end

#found_an_error ⇒ Object

#

found_an_error

#


95
96
97
 
# File 'lib/roebe/classes/syntax_checker.rb', line 95

def found_an_error
  @success_or_failure = :failure
end

#reset ⇒ Object

#

reset (reset tag)

#


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/roebe/classes/syntax_checker.rb', line 55

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @success_or_failure
  # ======================================================================= #
  @success_or_failure = :success
  # ======================================================================= #
  # === @work_on_this_file
  # ======================================================================= #
  @work_on_this_file = nil
  # ======================================================================= #
  # === @be_verbose
  # ======================================================================= #
  @be_verbose = true
end

#run ⇒ Object

#

run (run tag)

#


123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/roebe/classes/syntax_checker.rb', line 123

def run
  print rev
  _ = @work_on_this_file
  case _
  # ======================================================================= #
  # === Handle .java files next
  # ======================================================================= #
  when /\.java$/
    do_check_the_syntax_of_this_java_file(_)
  end
end

#set_work_on_this_file(i) ⇒ Object

#

set_work_on_this_file

#


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

def set_work_on_this_file(i)
  if i.is_a? Array
    i = i.first
  end
  if i and !i.include?('/')
    i = File.absolute_path(i) # Trying this since as of August 2022.
  end
  @work_on_this_file = i
end

#was_an_error_encountered? ⇒ Boolean Also known as: any_error?, failure?

#

was_an_error_encountered?

#

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/roebe/classes/syntax_checker.rb', line 115

def was_an_error_encountered?
  @success_or_failure == :failure
end

#work_on_which_file? ⇒ Boolean

#

work_on_which_file?

#

Returns:

  • (Boolean) 


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

def work_on_which_file?
  @work_on_this_file
end