Class: Roebe::WebfancyController

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

Overview

Roebe::WebfancyController

Constant Summary collapse

FILE_WEBFANCY_CONTROLLER =
#

FILE_WEBFANCY_CONTROLLER

#
'/home/x/data/images/fotos/webfancy_controller.yml'
HASH_ACTIONS =
#

HASH_ACTIONS

Designate which parameters we have to pass towards Cyberweb::ImagesToHtml here.

To access to cweb11, do:

HASH_ACTIONS[:cweb11]
#
{
  cweb11:    '--use-HTML-table --table=2 --display_top_header; oibhtml',
  cweb111:   '--do-not-traverse --add-hyperlinks-to-subdirectories --use-HTML-table --table=2 --display_top_header'
}

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, #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) ⇒ WebfancyController

#

initialize

#


53
54
55
56
57
58
59
60
 
# File 'lib/roebe/classes/webfancy_controller.rb', line 53

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

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::WebfancyController[]

#


222
223
224
 
# File 'lib/roebe/classes/webfancy_controller.rb', line 222

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

Instance Method Details

#file_webfancy_controller? ⇒ Boolean

#

file_webfancy_controller?

#

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/roebe/classes/webfancy_controller.rb', line 93

def file_webfancy_controller?
  FILE_WEBFANCY_CONTROLLER
end

#images_to_html(i) ⇒ Object

#

images_to_html

This method will delegate towards Cyberweb::ImagesToHtml.

#


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

def images_to_html(i)
  return Cyberweb::ImagesToHtml.new(i, :do_not_run_yet) { :use_jquery }
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


100
101
102
103
104
105
106
107
108
109
110
111
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
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/roebe/classes/webfancy_controller.rb', line 100

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    if i.empty? and return_pwd.include?('/home/x/data/images/fotos/')
      i = [return_pwd]
    end
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # === --pwd
    # ===================================================================== #
    when /^-?-?pwd$/i
      i = return_pwd
    # ===================================================================== #
    # === --help
    # ===================================================================== #
    when /-?-?help/i
      show_help
      exit
    else
      # =================================================================== #
      # === Handle the case when the input is an existing directory
      # =================================================================== #
      if i and File.directory?(i)
        opne "Operating on the directory #{sdir(i)} #{rev}next."
        dataset = return_dataset_from_the_primary_yaml_file
        if dataset.has_key? i
          work_on_this_hash(
            {
              i => dataset[i]
            }
          )
        else # else we must fetch all images files
          these_files = Dir["#{i}**/**"].select {|entry| is_an_image_file?(entry) }
          _ = images_to_html(these_files)
          arguments = HASH_ACTIONS[:cweb11]
          if arguments.include? ';'
            arguments = arguments.split(';').first
          end
          if arguments.include?(' ')
            arguments = arguments.split(' ')
          end
          _.append_to_the_commandline_arguments(arguments)
          _.run
        end
        exit
      end
    end
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


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

def reset
  super()
  infer_the_namespace
end

#return_dataset_from_the_primary_yaml_file(_ = FILE_WEBFANCY_CONTROLLER) ⇒ Object

#

return_dataset_from_the_primary_yaml_file

#


84
85
86
87
88
 
# File 'lib/roebe/classes/webfancy_controller.rb', line 84

def return_dataset_from_the_primary_yaml_file(
    _ = FILE_WEBFANCY_CONTROLLER
  )
  return YAML.load_file(_)
end

#run ⇒ Object

#

run (run tag)

#


209
210
211
212
213
214
215
216
217
 
# File 'lib/roebe/classes/webfancy_controller.rb', line 209

def run
  _ = file_webfancy_controller?
  menu
  if File.exist? _
    run_in_batch_mode
  else
    opnn; no_file_exists_at(_)
  end
end

#run_in_batch_mode(i = FILE_WEBFANCY_CONTROLLER) ⇒ Object

#

run_in_batch_mode

#


165
166
167
168
169
170
171
 
# File 'lib/roebe/classes/webfancy_controller.rb', line 165

def run_in_batch_mode(
    i = FILE_WEBFANCY_CONTROLLER
  )
  dataset = return_dataset_from_the_primary_yaml_file
  opne "We will visit only entries covered in the file `#{sfile(i)}` next."
  work_on_this_hash(dataset)
end

#show_help ⇒ Object

#

show_help (help tag)

#


73
74
75
76
77
78
79
 
# File 'lib/roebe/classes/webfancy_controller.rb', line 73

def show_help
  e
  e 'If you pass arguments to this class that correspond to an'
  e 'existing directory then this directory will be used as main target'
  e 'for this class.'
  e
end

#work_on_this_hash(hash) ⇒ Object

#

work_on_this_hash

This method expects a Hash as input.

This Hash may look like this:

{"/home/x/data/images/fotos/family/wunibald_kunz/"=>"cweb11"}
#


183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/roebe/classes/webfancy_controller.rb', line 183

def work_on_this_hash(hash)
  hash.each_pair {|key, value|
    opne "Working on the directory `#{sdir(key)}#{rev}` next:"
    cd(key) # cd into the first entry, which should be a directory.
    if value.start_with? '--'
      arguments = value
    else
      arguments = HASH_ACTIONS[value.to_sym] # Obtain the true value from the main Hash.
    end
    if arguments.include? ';'
      arguments = arguments.split(';').first
    end
    opne 'The commandline arguments used will be: '+
         steelblue(arguments)
    _ = images_to_html(ARGV)
    _.append_to_the_commandline_arguments(
      arguments.split(' ')
    ) # This is the default. The arguments will typically be an Array such
      # as: ["--use-HTML-table", "--table=2", "--display_top_header"]
    _.run
  }
end