Class: Cyberweb::SimpleIndex

Inherits:
Base
  • Object
show all
Defined in:
lib/cyberweb/utility_scripts/simple_index/simple_index.rb

Overview

Cyberweb::SimpleIndex

Constant Summary collapse

FILE_INDEX =
#

FILE_INDEX

#
'index.html'

Constants inherited from Base

Base::HOME_DIRECTORY_OF_THE_USER_X, Base::NAMESPACE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#be_verbose, #be_verbose?, #cascading_style_sheets_directory?, #cd, #commandline_mode?, #copyright?, #css_comment, #delete_directory, #do_toggle, #e, #echo_raw, #filename?, #full_path_to_image_directory?, #html_colours?, #html_image, #htmlentities, #img_dir?, #infer_the_namespace, #initialize_the_configuration, #is_a_file?, #is_a_video_file?, #is_an_image_file?, #is_on_roebe?, #last_tag_used?, #last_tag_used_first_element?, #last_tag_used_id?, #mkdir, #mode?, #namespace?, #open_in_browser, #opne, #opnn, #remove_comments_from_this_string_but_preserve_CSS_rules, #remove_html, #return_all_directories, #return_date, #return_program_name, #return_pwd, #ruby_header?, #server_base_directory?, #set_commandline_mode, #set_last_tag_used, #update_the_image_directory, #use_this_relative_directory_for_custom_images?, #www_mode?

Methods included from BaseModule::FileRelatedFunctionality

#copy_this_file, #cpr, #delete_file, #filename_without_extension?, #read_file_via_utf8_encoding

Methods included from BaseModule

#attach_these_constants, #base_dir?, #beautiful_url, #cd, #create_the_internal_hash, #doctype?, #ee, #ensure_main_encoding, #esystem, #html_templates, #initialize_the_config_if_the_config_hash_is_empty, #internal_hash?, #log_dir?, #no_http, #random_alphabet_characters, #rarrow?, #rds, #remove_comments_from_this_string, #remove_numbers, #require_the_html_templates, #require_these, #return_file_size_in_kb_of, #return_html_comment, #ruby_sitelib_dir?, #sanitize_this_id, #server_base_directory?, #string_remote_image, #today?, #try_to_require_rack, #try_to_require_the_open_gem, #write_what_into

Methods included from BaseModule::ContentType

#content_type_is_html, #content_type_is_jpeg, #content_type_is_json, #content_type_is_plain_text

Methods included from BaseModule::CommandlineArguments

#append_to_the_commandline_arguments, #commandline_arguments?, #first_argument?, #parse_these_commandline_arguments, #second_argument?, #set_commandline_arguments

Methods included from BaseModule::Colours

#all_html_colours, #lightgreen, #rev, #sdir, #sfancy, #sfile, #simp, #steelblue, #tomato

Constructor Details

#initialize(commandline_arguments = nil, run_already = true) ⇒ SimpleIndex

#

initialize

#


31
32
33
34
35
36
37
38
39
40
 
# File 'lib/cyberweb/utility_scripts/simple_index/simple_index.rb', line 31

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

Class Method Details

.[](i = '') ⇒ Object

#

Cyberweb::SimpleIndex[]

#


133
134
135
 
# File 'lib/cyberweb/utility_scripts/simple_index/simple_index.rb', line 133

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

Instance Method Details

#

menu

#


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
 
# File 'lib/cyberweb/utility_scripts/simple_index/simple_index.rb', line 65

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i
    # ===================================================================== #
    # === sindex --help
    # ===================================================================== #
    when /^-?-?help/
      show_help
      exit
    # ===================================================================== #
    # === sindex --pdf --traverse
    # ===================================================================== #
    when /^-?-?pdf/
      @scan_for_this_filetype = 'pdf'
    # ===================================================================== #
    # === sindex --traverse
    # ===================================================================== #
    when /^-?-?traverse/
      @check_subdirectories_as_well = true
    end
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/cyberweb/utility_scripts/simple_index/simple_index.rb', line 45

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @check_subdirectories_as_well
  # ======================================================================= #
  @check_subdirectories_as_well = false
  # ======================================================================= #
  # === @scan_for_this_filetype
  #
  # Here we keep track of the filetype we will look for. By default
  # this will be for .html files, but it could also be for .pdf
  # files, for instance.
  # ======================================================================= #
  @scan_for_this_filetype = 'html'
end

#run ⇒ Object

#

run (run tag)

#


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/cyberweb/utility_scripts/simple_index/simple_index.rb', line 107

def run
  menu
  if @check_subdirectories_as_well
    work_on_these_files = Dir['**/**.'+@scan_for_this_filetype]
  else
    work_on_these_files = Dir['*.'+@scan_for_this_filetype]
  end
  all_html_files_in_the_current_directory = work_on_these_files.reject {|entry|
    File.basename(entry) == FILE_INDEX # Exclude self-mentions here. 
  }
  _ = "<html><head><title>Index</title></head>"\
      "<body style=\"font-size: 1.25em; padding:8px\">\n".dup
  all_html_files_in_the_current_directory.each {|this_HTML_file|
    _ << '<a href="'+this_HTML_file+'">'+
         this_HTML_file.delete_suffix('.html').tr('_',' ')+
         '</a>'+"<br>\n"
  }
  _ << '</body></html>'
  into = FILE_INDEX
  re rev+"Storing into `#{sfile(into)}`."
  write_what_into(_, into)
end

#show_help ⇒ Object

#

show_help (help tag)

#


95
96
97
98
99
100
101
102
 
# File 'lib/cyberweb/utility_scripts/simple_index/simple_index.rb', line 95

def show_help
  re
  re '  --traverse # this will include subdirectores too, and '\
     'check for more .html files there'
  re '  --pdf      # work on .pdf files rather than .html files '\
     'in the given subdirectory'
  re
end