Class: Roebe::ServeLocalPage

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

Overview

Roebe::ServeLocalPage

Constant Summary collapse

SAVE_HERE =
#

SAVE_HERE

By default we will store into /Depot/Temp.

#
'/Depot/Temp/'
RUN_ALREADY =
#

RUN_ALREADY

#
true

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, #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, #olivedrab, #open_in_browser, #opne, #opnesystem, #orange, #orchid, #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, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #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 = RUN_ALREADY) ⇒ ServeLocalPage

#

initialize

First argument should be the input file.

#


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/roebe/classes/serve_local_page.rb', line 44

def initialize(
    i           = nil,
    run_already = RUN_ALREADY # Default mode.
  )
  reset
  set_these_files(i) # Set the input here.
  case run_already
  when :do_not_save, :no_save, :dont_save
    @do_save_the_dataset = false
    @be_quiet = true
    run_already = RUN_ALREADY
  when :dont_run_yet, :do_not_run_yet
    run_already = false
  end
  run if run_already
end

Instance Method Details

#base_dir?Boolean

#

base_dir?

#

Returns:

  • (Boolean)


77
78
79
# File 'lib/roebe/classes/serve_local_page.rb', line 77

def base_dir?
  SAVE_HERE
end

#check_whether_we_will_use_coloursObject

#

check_whether_we_will_use_colours

#


210
211
212
# File 'lib/roebe/classes/serve_local_page.rb', line 210

def check_whether_we_will_use_colours
  Colours.disable_colours unless use_colours?
end

#dataset?Boolean Also known as: result, string

#

dataset?

#

Returns:

  • (Boolean)


217
218
219
# File 'lib/roebe/classes/serve_local_page.rb', line 217

def dataset?
  @dataset # Note that @dataset is a String.
end

#file?Boolean

#

file?

#

Returns:

  • (Boolean)


116
117
118
119
120
# File 'lib/roebe/classes/serve_local_page.rb', line 116

def file?
  _ = @these_files
  _ = _.first if _
  _.to_s
end

#opnnObject

#

opnn

#


91
92
93
94
95
96
# File 'lib/roebe/classes/serve_local_page.rb', line 91

def opnn
  super({
    namespace:   NAMESPACE,
    use_colours: use_colours?
  })
end

#process_via_loopObject

#

process_via_loop

#


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

def process_via_loop
  reset if @these_files.size > 1
  @these_files.each {|from_this_file|
    _ = base_dir?+File.basename(from_this_file)+'.html'
    set_save_here(_)
    from_this_file = sanitize_file(from_this_file)
    read_dataset(from_this_file)
    save_dataset if @do_save_the_dataset
  }
end

#read_dataset(from_where = @these_files) ⇒ Object

#

read_dataset

#


163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/roebe/classes/serve_local_page.rb', line 163

def read_dataset(
    from_where = @these_files
  )
  begin
    unless @be_quiet
      opne 'Next serving from URI '+sfancy(from_where)
    end
    @dataset = OpenURI.open_uri(from_where).read
  rescue OpenURI::HTTPError
    unless @be_quiet
      opne 'Error trying to open '+sfancy(from_where)+': it does not exist.'
    end
  end
  sanitize_dataset
end

#resetObject

#

reset (reset tag)

#


64
65
66
67
68
69
70
71
72
# File 'lib/roebe/classes/serve_local_page.rb', line 64

def reset
  infer_the_namespace
  @these_files = []
  @do_save_the_dataset = true
  @use_colours = true
  @be_quiet = false
  @replace_with_absolute_path = true
  set_save_where
end

#return_regex_that_will_return_the_proper_pathObject

#

return_regex_that_will_return_the_proper_path

#


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

def return_regex_that_will_return_the_proper_path
  # _ = '../../../../../'
  regex = /<link rel="stylesheet" type="text\/css" href="(.+)CSS\/FONTS.css"/
  @dataset =~ regex # Here we assume that FONTS.css is hardcoded.
  _ = $1.to_s.dup
  Regexp.quote(_)
end

#runObject

#

run (run tag)

#


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

def run
  check_whether_we_will_use_colours
  process_via_loop
end

#sanitize_datasetObject

#

sanitize_dataset

#


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/roebe/classes/serve_local_page.rb', line 225

def sanitize_dataset
  # ======================================================================= #
  # First, we fix up the wrongful CSS entries by giving them the proper
  # location to the .css file in question. We must be careful here though
  # as the regex may otherwise also replace other entries.
  # ======================================================================= #
  if @dataset.include? '<link rel="stylesheet" type="text/css" href="../'
    path_to_css = "#{home_directory_of_user_x?}DATA/"
    # ===================================================================== #
    # The regex that we will next use needs to count the amount of
    # ../ required.
    # ===================================================================== #
    regex = /(#{return_regex_that_will_return_the_proper_path})/
    @dataset.gsub!(regex, path_to_css) 
  end if @replace_with_absolute_path
end

#sanitize_file(i) ⇒ Object

#

sanitize_file

#


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

def sanitize_file(i)
  if i.include? '#' # For now, we ignore everything after a '#' character here. (March 2014)
    i = i[0, i.index('#')].strip
  end if i
  return i
end

#save_datasetObject

#

save_dataset

#


182
183
184
185
186
187
# File 'lib/roebe/classes/serve_local_page.rb', line 182

def save_dataset
  unless @be_quiet
    opne 'Now saving into file `'+sfile(save_where?)+'`.'
  end
  write_what_into(dataset?, save_where?)
end

#save_where?Boolean Also known as: store_where?

#

save_where?

#

Returns:

  • (Boolean)


156
157
158
# File 'lib/roebe/classes/serve_local_page.rb', line 156

def save_where?
  @save_where
end

#set_save_where(i = SAVE_HERE+File.basename(file?)) ⇒ Object Also known as: store_here=, store_where=, store_where, set_save_here

#

set_save_where

Use this method to denote where to save.

#


194
195
196
197
198
199
200
201
202
# File 'lib/roebe/classes/serve_local_page.rb', line 194

def set_save_where(
    i = SAVE_HERE+File.basename(file?)
  )
  if i.frozen?
    i = i.dup
  end
  i.gsub!(/\.cgi/, '') # Get rid of the file extension here.
  @save_where = i
end

#set_these_files(i = nil) ⇒ Object

#

set_these_files

#


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

def set_these_files(
    i = nil
  )
  i = [i].flatten.map
  case i.first # case tag
  when 'HELP','--help'
    show_help
    exit
  end
  @these_files = i
end

#show_helpObject

#

show_help

#


84
85
86
# File 'lib/roebe/classes/serve_local_page.rb', line 84

def show_help
  opne 'These options are available:'
end

#which_files?Boolean

#

which_files?

#

Returns:

  • (Boolean)


149
150
151
# File 'lib/roebe/classes/serve_local_page.rb', line 149

def which_files?
  @these_files
end