Class: Cyberweb::FotoGallery

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

Overview

Cyberweb::FotoGallery

Constant Summary

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) ⇒ FotoGallery

#

initialize

#


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/cyberweb/foto_gallery/foto_gallery.rb', line 25

def initialize(
    commandline_arguments = nil,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  case run_already
  # ======================================================================= #
  # === :do_not_run_yet
  # ======================================================================= #
  when :do_not_run_yet
    run_already = false
  end
  # ======================================================================= #
  # === Handle blocks given to this class next
  # ======================================================================= #
  if block_given?
    yielded = yield
    case yielded
    # ===================================================================== #
    # === :do_not_run_yet
    # ===================================================================== #
    when :do_not_run_yet
      run_already = false
    end
  end
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Cyberweb::FotoGallery[]

#


145
146
147
 
# File 'lib/cyberweb/foto_gallery/foto_gallery.rb', line 145

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

Instance Method Details

#all_image_files? ⇒ Boolean Also known as: images?

#

all_image_files?

#

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/cyberweb/foto_gallery/foto_gallery.rb', line 131

def all_image_files?
  @all_image_files
end

#obtain_all_image_files ⇒ Object

#

obtain_all_image_files

#


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/cyberweb/foto_gallery/foto_gallery.rb', line 94

def obtain_all_image_files
  if @fetch_images_from_subdirectories_as_well
    all_files = Dir[@use_this_directory+'**/**']
  else
    all_files = Dir[@use_this_directory+'**']
  end
  @all_image_files = all_files.select {|file|
    is_an_image_file?(file)
  }
  if @sort_how
    case @sort_how
    # ===================================================================== #
    # === :sort_based_on_time
    # ===================================================================== #
    when :sort_based_on_time
      @all_image_files = Cyberweb.sort_based_on_time(@all_image_files)
    end
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cyberweb/foto_gallery/foto_gallery.rb', line 59

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @use_this_directory
  # ======================================================================= #
  @use_this_directory = return_pwd
  # ======================================================================= #
  # === @fetch_images_from_subdirectories_as_well
  #
  # If this variable is true then we will fetch images from
  # subdirectories as well.
  # ======================================================================= #
  @fetch_images_from_subdirectories_as_well = true
  # ======================================================================= #
  # === @sort_how
  #
  # If the following variable is set to nil then no sorting will occur.
  # If, however had, the variable is set to :sort_based_on_time then
  # the images that are shown will be time-sorted.
  # ======================================================================= #
  @sort_how = :sort_based_on_time
end

#run ⇒ Object

#

run (run tag)

#


138
139
140
 
# File 'lib/cyberweb/foto_gallery/foto_gallery.rb', line 138

def run
  obtain_all_image_files
end

#set_use_this_directory(i) ⇒ Object

#

set_use_this_directory

#


117
118
119
 
# File 'lib/cyberweb/foto_gallery/foto_gallery.rb', line 117

def set_use_this_directory(i)
  @use_this_directory = i
end

#use_base64_images? ⇒ Boolean

#

use_base64_images?

#

Returns:

  • (Boolean) 


86
87
88
89
 
# File 'lib/cyberweb/foto_gallery/foto_gallery.rb', line 86

def use_base64_images?
  _ = use_which_directory?
  !_.include?(::Cyberweb.serve_directory?) # The latter will return a String such as "/home/x/".
end

#use_this_directory? ⇒ Boolean Also known as: use_which_directory?

#

use_this_directory?

#

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/cyberweb/foto_gallery/foto_gallery.rb', line 124

def use_this_directory?
  @use_this_directory
end