Class: Roebe::CreateMyDirectories

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

Overview

Roebe::CreateMyDirectories

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, #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, #opnn, #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(commandline_arguments = ARGV, run_already = true) ⇒ CreateMyDirectories

#

initialize

#


41
42
43
44
45
46
47
48
49
50
# File 'lib/roebe/classes/create_my_directories.rb', line 41

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

Instance Method Details

#consider_notifying_the_user_how_many_directories_have_been_createdObject

#

consider_notifying_the_user_how_many_directories_have_been_created

#


167
168
169
170
171
172
# File 'lib/roebe/classes/create_my_directories.rb', line 167

def consider_notifying_the_user_how_many_directories_have_been_created
  if @created_n_directories == 0
    e "#{rev}No directory has been created, which usually means that all"
    e 'directories already exist. '+slateblue(cheerful_guy)
  end
end

#create_these_directories(these_directories) ⇒ Object

#

create_these_directories

Pass to this method the directories that you wish to create.

The input should be an Array.

#


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/roebe/classes/create_my_directories.rb', line 72

def create_these_directories(
    these_directories
  )
  if these_directories
    these_directories.each { |directory|
      # =================================================================== #
      # Only create directories if they do not yet exist.
      # =================================================================== #
      this_dir = ("#{@base_prefix}#{directory}").squeeze('/')
      unless File.exist?(this_dir)
        if File.directory?(this_dir)
          # =============================================================== #
          # Be quiet in this case, as the directory already exists.
          # =============================================================== #
        elsif File.file?(this_dir)
          opne "#{rev}Can not create a directory a #{sfile(this_dir)}"
          opne "#{rev}as a file already exists at that location."
        else
          begin
            opne "#{rev}Creating a directory at `#{sdir(this_dir)}#{rev}`."
            create_directory(this_dir)
            @created_n_directories += 1
          rescue Exception => error
            pp error
          end
        end
      end
    }
  else
    opne 'No valid directories could be found.' # ← This should actually never happen. :)
  end
end
#

menu (menu tag)

#


138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/roebe/classes/create_my_directories.rb', line 138

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ========================================================================= #
    # === idirs --help
    # ========================================================================= #
    when /^-?-?help$/
      show_help
      exit
    # ========================================================================= #
    # === idirs --create-directory-layout-at-this-target=/Depot/Chroot/
    # ========================================================================= #
    when /^-?-?create-?directory-?layout-?at-?this-?target=(.+)$/
      set_base_prefix($1.to_s.dup)
    else
      if i and File.directory?(i)
        set_base_prefix(i)
      end
    end
  end
end

#resetObject

#

reset (reset tag)

#


55
56
57
58
59
60
61
62
63
# File 'lib/roebe/classes/create_my_directories.rb', line 55

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @created_n_directories
  # ======================================================================= #
  @created_n_directories = 0
  set_base_prefix # Where we will create our subdirectory at.
end

#runObject

#

run (run tag)

#


177
178
179
180
181
182
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/create_my_directories.rb', line 177

def run
  set_use_this_file(DIRECTORY_STRUCTURE) # Set a default here.
  menu
  my_directories = nil # Safeguard.    
  file_directory_structure = @use_this_file
  e "#{rev}Creating my directories next by loading the dataset from"
  e
  e "  #{sdir(file_directory_structure)}"
  e
  # ======================================================================= #
  # Next, we will load up the directories. If YAML is available and
  # works fine, then we can make use of it. If YAML does not work
  # fine, but the main file exists nonetheless, then we will load
  # it up on our own.
  # ======================================================================= #
  begin
    my_directories = YAML.load_file(file_directory_structure)
  rescue Exception => error
    pp error # We display the error nonetheless.
    if File.exist? file_directory_structure
      my_directories = YAML.readlines(file_directory_structure).select {|line|
        line.start_with? '- '
      }
    end
  end
  create_these_directories(my_directories)
  consider_notifying_the_user_how_many_directories_have_been_created
end

#set_base_prefix(i = '/') ⇒ Object

#

set_base_prefix

#


122
123
124
125
# File 'lib/roebe/classes/create_my_directories.rb', line 122

def set_base_prefix(i = '/')
  i << '/' unless i.end_with? '/'
  @base_prefix = i
end

#set_use_this_file(i = DIRECTORY_STRUCTURE) ⇒ Object

#

set_use_this_file

#


130
131
132
133
# File 'lib/roebe/classes/create_my_directories.rb', line 130

def set_use_this_file(i = DIRECTORY_STRUCTURE)
  i = i.first if i.is_a? Array
  @use_this_file = i
end

#show_helpObject

#

show_help (help tag)

#


108
109
110
111
112
113
114
115
116
117
# File 'lib/roebe/classes/create_my_directories.rb', line 108

def show_help
  e
  e 'You can also specify the location where to create '\
    'the directory layout.'
  e
  e 'Example:'
  e
  e '  idirs --create-directory-layout-at-this-target=/Depot/Chroot/'
  e
end