Class: Roebe::SimpleMarkdownParser

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

Overview

Roebe::SimpleMarkdownParser

Constant Summary collapse

REGEX_TO_USE_FOR_ITALIC =
#

REGEX_TO_USE_FOR_ITALIC

#
/\*\s?([^\n]+)\*/
REGEX_TO_USE_FOR_BOLD1 =
#

REGEX_TO_USE_FOR_BOLD1

#
/\*\*\s?([^\n]+)\*\*/
REGEX_TO_USE_FOR_BOLD2 =
#

REGEX_TO_USE_FOR_BOLD2

#
/__([^_]+)__/
REGEX_TO_USE_FOR_PARAGRAPHS =
#

REGEX_TO_USE_FOR_PARAGRAPHS

#
/([\s\S]*)/

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 = nil, run_already = true, &block) ⇒ SimpleMarkdownParser

#

initialize

#


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 70

def initialize(
    i           = nil,
    run_already = true,
    &block
  )
  reset
  set_commandline_arguments(i)
  if block_given?
    yielded = yield
    case yielded
    # ===================================================================== #
    # === :do_not_use_colours
    # ===================================================================== #
    when :do_not_use_colours
      do_not_use_colours
    end
  end
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::SimpleMarkdownParser[]

#


257
258
259
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 257

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

Instance Method Details

#assign_to_the_result(i) ⇒ Object

#

assign_to_the_result

#


207
208
209
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 207

def assign_to_the_result(i)
  @result = i
end

#parse_for_bold_italic_and_other_rules(i) ⇒ Object

#

parse_for_bold_italic_and_other_rules

#


112
113
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
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 112

def parse_for_bold_italic_and_other_rules(i)
  i = i.dup if i.frozen?
  if i.include?('**')
    i.gsub!(REGEX_TO_USE_FOR_BOLD1, '<b>\1</b>')
  elsif i.include?('__')
    i.gsub!(REGEX_TO_USE_FOR_BOLD2, '<b>\1</b>')
  end
  if i.include?('*')
    i.gsub!(REGEX_TO_USE_FOR_ITALIC, '<i>\1</i>')
  end
  if i.include?('http')
    i.gsub!(
      /(https?:\/\/.+)/,
      HtmlTags.a('\1',
      css_class: 'BOLD')
    )
  end
  if i.start_with?('    ')
    unless i.include?('<a href')
      i = '<pre class="css_for_code">'+i+"</pre>"
    end
  else
    i.gsub!(REGEX_TO_USE_FOR_PARAGRAPHS) {|entry|
      return_non_empty_paragraph(entry)
      # return_non_empty_span(entry)
    }
  end
  return i
end

#perform_postprocessing_on_this_string(i) ⇒ Object

#

perform_postprocessing_on_this_string

#


190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 190

def perform_postprocessing_on_this_string(i)
  if i.include?("<p>
</p>")
    i.gsub!(/<p>\s+<\/p>/,'') # Chop off wrong p-tags.
  end
  if i.include?('<p></p>')
    i.gsub!(/<p><\/p>/,'')
  end
  if i.include?('</p><p>')
    i.gsub!(/<\/p><p>/,'')
  end
  return i
end

#process_this_content(content) ⇒ Object

#

process_this_content

#


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 153

def process_this_content(content)
  _ = ''.dup
  if content.is_a?(String) and !content.respond_to?(:each)
    begin
      content = content.split("\n")
    rescue ArgumentError => error
      puts 'Problem in this content:'
      puts content
      pp error
      exit
    end
  end
  content.each {|this_line|
    if this_line.start_with?('#') and this_line.include?(' ')
      splitted = this_line.split(' ')
      n_comment_tokens = splitted.first.count('#').to_s
      # =================================================================== #
      # Determine the header-level to use here, based on how many
      # '#' we can count:
      # =================================================================== #
      this_line = HtmlTags.send(
                    'h'+n_comment_tokens,
                    this_line.sub(/^#+/,''),
                    'h'+n_comment_tokens+'_css_class' # CSS class
                  )
    else # This clause is for all but the h-tags.
      this_line = parse_for_bold_italic_and_other_rules(this_line)
    end
    _ << this_line
  }
  _ = perform_postprocessing_on_this_string(_)
  assign_to_the_result(_)
end

#process_this_file(i) ⇒ Object

#

process_this_file

#


145
146
147
148
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 145

def process_this_file(i)
  content = default_readlines(i)
  process_this_content(content)
end

#report ⇒ Object

#

report

#


214
215
216
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 214

def report
  e @result
end

#reset ⇒ Object

#

reset (reset tag)

#


93
94
95
96
97
98
99
100
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 93

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @result
  # ======================================================================= #
  @result = nil
end

#result? ⇒ Boolean

#

result?

#

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 105

def result?
  @result
end

#return_non_empty_paragraph(i) ⇒ Object

#

return_non_empty_paragraph

#


246
247
248
249
250
251
252
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 246

def return_non_empty_paragraph(i)
  if i and !i.strip.empty?
    return "<p>#{i}</p>"
  else
    return ''
  end
end

#return_non_empty_span(i) ⇒ Object

#

return_non_empty_span

#


235
236
237
238
239
240
241
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 235

def return_non_empty_span(i)
  if i and !i.strip.empty?
    return "<span>#{i}</span>"
  else
    return ''
  end
end

#run ⇒ Object

#

run (run tag)

#


221
222
223
224
225
226
227
228
229
230
 
# File 'lib/roebe/classes/simple_markdown_parser.rb', line 221

def run
  _ = first_argument?
  if _ and File.exist?(_)
    process_this_file(_)
  elsif !_.empty?
    process_this_content(_)
  else
    opnn; no_file_exists_at(_)
  end
end