Class: Roebe::ReportHowManyClassesExistForThisDirectory

Inherits:
Base
  • Object
show all
Defined in:
lib/roebe/classes/report_how_many_classes_exist_for_this_directory.rb

Overview

Roebe::ReportHowManyClassesExistForThisDirectory

Constant Summary

Constants inherited from Base

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

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 = ARGV, run_already = true) ⇒ ReportHowManyClassesExistForThisDirectory

#

initialize

#


23
24
25
26
27
28
29
30
 
# File 'lib/roebe/classes/report_how_many_classes_exist_for_this_directory.rb', line 23

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

Instance Method Details

#obtain_all_ruby_files_from(i = @work_on_this_directory) ⇒ Object

#

obtain_all_ruby_files_from

#


43
44
45
46
47
 
# File 'lib/roebe/classes/report_how_many_classes_exist_for_this_directory.rb', line 43

def obtain_all_ruby_files_from(i = @work_on_this_directory)
  i = i.dup if i.frozen?
  i << '/' unless i.end_with?('/')
  @all_rb_files = Dir["#{i}**/**.rb"]
end

#reset ⇒ Object

#

reset (reset tag)

#


35
36
37
38
 
# File 'lib/roebe/classes/report_how_many_classes_exist_for_this_directory.rb', line 35

def reset
  super()
  infer_the_namespace
end

#run ⇒ Object

#

run

#


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/roebe/classes/report_how_many_classes_exist_for_this_directory.rb', line 59

def run
  target = first_argument?
  if target.nil? or target.empty?
    target = return_pwd
  end
  set_work_on_this_directory(target)
  @array_result = []
  # ======================================================================= #
  # Next we must obtain all .rb files under that directory.
  # ======================================================================= #
  obtain_all_ruby_files_from(@work_on_this_directory)
  # ======================================================================= #
  # Alright - now that we have all .rb files, we need to select
  # only those entries that do happen to contain a class
  # definition, such as "class Foobar". So we have to read the file
  # content and then decide based on that.
  # ======================================================================= #
  @all_rb_files.reject! {|this_rb_file|
    does_this_file_contain_a_ruby_class = false
    next if this_rb_file.include?('testing_') or
            this_rb_file.include?('test_') # Ignore test-files.
    if this_rb_file and File.exist?(this_rb_file)
      dataset = read_this_file(this_rb_file)
      # =================================================================== #
      # Use some unicode regex next.
      # =================================================================== #
      begin
      if dataset =~ /class [A-Z]{1}/u
        # ================================================================= #
        # Ok, it could include a class. Investigate further:
        # ================================================================= #
        lines = dataset.split("\n")
        lines.each {|a_single_line|
          if a_single_line and
             a_single_line.include?('#') and
            (a_single_line.size > 1)
            a_single_line = a_single_line.split('#').first.strip
          end
          if a_single_line =~ /class [A-Z]{1}/u
            does_this_file_contain_a_ruby_class = true
          end
        }
        if does_this_file_contain_a_ruby_class
          regex_to_use = /class ([A-Z]{1}[A-Za-z]*)/u
          dataset =~ regex_to_use
          name_of_the_class = $1.to_s.dup
          last_element = @array_result.last
          if last_element and last_element[2] == name_of_the_class
            # Do nothing in this case. 
          else
            @array_result << [dataset, tomato(this_rb_file), name_of_the_class] # The second entry we don't really need though.
          end
        end
      end
      rescue Exception => error
        pp error
        e 'The faulty file was: '+sfile(this_rb_file)
      end
    end
  }
  e "#{rev}A total of #{steelblue(@array_result.size)} "\
    "#{rev}classes were discovered in the directory "\
    "#{sdir(@work_on_this_directory)}"
end

#set_work_on_this_directory(i) ⇒ Object

#

set_work_on_this_directory

#


52
53
54
 
# File 'lib/roebe/classes/report_how_many_classes_exist_for_this_directory.rb', line 52

def set_work_on_this_directory(i)
  @work_on_this_directory = i
end