Class: Roebe::ExtractDocumentation

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

Overview

Roebe::ExtractDocumentation

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(i = ARGV, run_already = true) ⇒ ExtractDocumentation

#

initialize

#


28
29
30
31
32
33
34
35
 
# File 'lib/roebe/classes/extract_documentation.rb', line 28

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

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::ExtractDocumentation[]

#


182
183
184
 
# File 'lib/roebe/classes/extract_documentation.rb', line 182

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

Instance Method Details

#data? ⇒ Boolean Also known as: dataset, dataset?

#

data?

#

Returns:

  • (Boolean) 


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

def data?
  @dataset
end

#find_this_method? ⇒ Boolean Also known as: name_of_the_method?

#

find_this_method?

#

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/roebe/classes/extract_documentation.rb', line 66

def find_this_method?
  @find_this_method
end

#in_which_file? ⇒ Boolean

#

in_which_file?

#

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/roebe/classes/extract_documentation.rb', line 90

def in_which_file?
  @read_in_this_file
end

#obtain_content_above_this_line(at_this_line, array) ⇒ Object

#

obtain_content_above_this_line

#


136
137
138
139
140
141
142
143
144
 
# File 'lib/roebe/classes/extract_documentation.rb', line 136

def obtain_content_above_this_line(at_this_line, array)
  loop {
    at_this_line -= 1
    line = array[at_this_line]+N
    @result << line
    break unless this_line_starts_with_a_comment? line
  }
  sanitize_result
end

#parse_the_commandline(i = commandline_arguments? ) ⇒ Object

#

parse_the_commandline

#


124
125
126
127
128
129
130
131
 
# File 'lib/roebe/classes/extract_documentation.rb', line 124

def parse_the_commandline(
    i = commandline_arguments?
  )
  if i.is_a? Array
    set_file(i.first)
    set_find_this_method(i.last)
  end
end

#report_result ⇒ Object Also known as: report

#

report_result

#


166
167
168
 
# File 'lib/roebe/classes/extract_documentation.rb', line 166

def report_result
  e @result
end

#reset ⇒ Object

#

reset (reset tag)

#


40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/roebe/classes/extract_documentation.rb', line 40

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @dataset
  # ======================================================================= #
  @dataset = nil # This will include the dataset.
  @read_in_this_file = nil # Which file to read in.
  @find_this_method = nil
  @result = ''.dup # The resulting String.
end

#run ⇒ Object

#

run (run tag)

#


173
174
175
176
177
 
# File 'lib/roebe/classes/extract_documentation.rb', line 173

def run
  parse_the_commandline
  try_to_read_in_the_dataset
  try_to_read_in_the_top_comment
end

#sanitize_result ⇒ Object

#

sanitize_result

#


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

def sanitize_result
  if @result.include? N+N
    @result.gsub!(/\n\n/, N)
  end
end

#set_find_this_method(i = nil) ⇒ Object

#

set_find_this_method

#


55
56
57
58
59
60
61
 
# File 'lib/roebe/classes/extract_documentation.rb', line 55

def set_find_this_method(i = nil)
  if i
    i = i.to_s.dup
    i[0,0] = 'def ' unless i.include? 'def'
  end
  @find_this_method = i
end

#set_read_in_this_file(i = nil) ⇒ Object Also known as: set_file

#

set_read_in_this_file

#


73
74
75
 
# File 'lib/roebe/classes/extract_documentation.rb', line 73

def set_read_in_this_file(i = nil)
  @read_in_this_file = i
end

#this_line_starts_with_a_comment?(line) ⇒ Boolean

#

this_line_starts_with_a_comment?

#

Returns:

  • (Boolean) 


112
113
114
115
116
117
118
119
 
# File 'lib/roebe/classes/extract_documentation.rb', line 112

def this_line_starts_with_a_comment?(line)
  line = line.to_s.strip
  if line.start_with?('#')
    true
  else
    false
  end
end

#try_to_read_in_the_dataset ⇒ Object

#

try_to_read_in_the_dataset

#


80
81
82
83
84
85
 
# File 'lib/roebe/classes/extract_documentation.rb', line 80

def try_to_read_in_the_dataset
  _ = in_which_file?
  if File.exist? _
    @dataset = File.read(_)
  end
end

#try_to_read_in_the_top_comment ⇒ Object

#

try_to_read_in_the_top_comment

#


97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/roebe/classes/extract_documentation.rb', line 97

def try_to_read_in_the_top_comment
  _ = find_this_method?
  if dataset?.include? _ # Ok, the file has this method, so we can continue.
    # First, we obtain the position where it is.
    data = dataset?.split(N)
    at_this_line = data.find_index {|entry| entry.include? name_of_the_method? }
    obtain_content_above_this_line(at_this_line, data)
  else
    opn; e 'We could not find the method '+sfancy(_)
  end
end