Class: Roebe::Story

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

Overview

Roebe::Story

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

#

initialize

#


25
26
27
28
29
30
31
32
 
# File 'lib/roebe/classes/story.rb', line 25

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

Instance Method Details

#[](i = 0) ⇒ Object

#

[]

#


169
170
171
 
# File 'lib/roebe/classes/story.rb', line 169

def [](i = 0)
  @dataset[i]
end

#do_show_the_content_on_the_commandline ⇒ Object

#

do_show_the_content_on_the_commandline

This method will output the content on the commandline.

#


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/roebe/classes/story.rb', line 148

def do_show_the_content_on_the_commandline
  require 'cyberweb/requires/remove_html.rb'
  show_the_title
  e
  range?.each_with_index {|entry, index|
    results = header_contains_this_subsection?(index)
    unless results.empty? # In this case the header must be displayed.
      # =================================================================== #
      # Show the header in this case - always before the main content.
      # =================================================================== #
      first_entry = results.first
      e
      e orange(first_entry[1].to_s)+rev
    end
    e rev+Cyberweb.remove_html(@dataset[entry].to_s).rstrip
  }
end

#header_contains_this_subsection?(i) ⇒ Boolean

#

header_contains_this_subsection?

#

Returns:

  • (Boolean) 


135
136
137
138
139
140
141
 
# File 'lib/roebe/classes/story.rb', line 135

def header_contains_this_subsection?(i)
  _ = headers?.select {|array|
    first = array.first - 1
    (first == i)
  }
  return _
end

#headers? ⇒ Boolean

#

headers?

#

Returns:

  • (Boolean) 


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

def headers?
  @headers
end

#image? ⇒ Boolean Also known as: remote_image?

#

image?

#

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/roebe/classes/story.rb', line 49

def image?
  @image
end

#n_subsections? ⇒ Boolean Also known as: n_paragraphs?

#

n_subsections?

#

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/roebe/classes/story.rb', line 88

def n_subsections?
  @original_dataset.scan(/---/).size
end

#range? ⇒ Boolean

#

range?

#

Returns:

  • (Boolean) 


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

def range?
  (0 .. n_subsections?).each
end

#reset ⇒ Object

#

reset (reset tag)

#


37
38
39
40
41
42
43
44
 
# File 'lib/roebe/classes/story.rb', line 37

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @headers
  # ======================================================================= #
  @headers = []
end

#return_the_sanitized_dataset_from_the_original_dataset ⇒ Object

#

return_the_sanitized_dataset_from_the_original_dataset

This combines two actions:

(1) remove '#' comments from the .md file
(2) split on '---' in the .md file
#


115
116
117
118
119
120
121
122
123
 
# File 'lib/roebe/classes/story.rb', line 115

def return_the_sanitized_dataset_from_the_original_dataset
  return @original_dataset.split("\n").map {|entry|
           if entry.start_with? '#'
             entry = nil
           end
           entry
         }.compact.join("\n").
           split('---')
end

#run ⇒ Object

#

run (run tag)

#


82
83
 
# File 'lib/roebe/classes/story.rb', line 82

def run
end

#set_headers(i) ⇒ Object

#

set_headers

The method .set_headers() can be used to designate additional headers. If we display in HTML then this will become h3() typically.

This method expects an Array as input.

#


68
69
70
 
# File 'lib/roebe/classes/story.rb', line 68

def set_headers(i)
  @headers = i
end

#show_the_title ⇒ Object

#

show_the_title

#


128
129
130
 
# File 'lib/roebe/classes/story.rb', line 128

def show_the_title
  e lightgreen(title?)+rev
end

#string? ⇒ Boolean

#

string?

#

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/roebe/classes/story.rb', line 102

def string?
  @dataset.join("\n")
end

#title? ⇒ Boolean

#

title?

#

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/roebe/classes/story.rb', line 56

def title?
  @title
end