Class: Roebe::SymlinkFilesFromThatDirectoryToTheCurrentDirectory

Inherits:
Base
  • Object
show all
Defined in:
lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb

Overview

Roebe::SymlinkFilesFromThatDirectoryToTheCurrentDirectory

Constant Summary

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(commandline_arguments = nil, run_already = true) ⇒ SymlinkFilesFromThatDirectoryToTheCurrentDirectory

#

initialize

#


38
39
40
41
42
43
44
45
46
47
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 38

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

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::SymlinkFilesFromThatDirectoryToTheCurrentDirectory[]

#


253
254
255
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 253

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

Instance Method Details

#

menu (menu tag)

#


155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 155

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i
    # ===================================================================== #
    # === symlink_from --help
    # ===================================================================== #
    when /^-?-?help$/
      show_help
      exit
    # ===================================================================== #
    # === symlink_from /Programs/Python/Current/include/python/ --do-not-overwrite
    # ===================================================================== #
    when /-?-?do(-|_)?not(-|_)?overwrite$/i
      @internal_hash[:overwrite_existing_files] = true
    end
  end
end

#overwrite_existing_files? ⇒ Boolean

#

overwrite_existing_files?

#

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 69

def overwrite_existing_files?
  @internal_hash[:overwrite_existing_files]
end

#reset ⇒ Object

#

reset (reset tag)

#


52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 52

def reset
  super()
  infer_the_namespace
  set_be_verbose
  # ======================================================================= #
  # === @internal_hash
  # ======================================================================= #
  # @internal_hash = {}
  # ======================================================================= #
  # === :overwrite_existing_files
  # ======================================================================= #
  @internal_hash[:overwrite_existing_files] = true
end

#run ⇒ Object

#

run (run tag)

#


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
205
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 180

def run
  # ======================================================================= #
  # First put the commandline arguments into the menu() interface.
  # ======================================================================= #
  menu
  set_target(first_argument?)
  # ======================================================================= #
  # Obtain our target directory next.
  # ======================================================================= #
  target = target?
  if target and File.directory?(target.delete('*'))
    work_on_these_files = Dir[target].select {|entry|
      File.file? entry # Only work on files.
    }
    if work_on_these_files.empty?
      opne "The directory exists but no files "\
           "were found at #{sdir(target)}."
    else
      symlink_these_files(work_on_these_files)
    end
  else
    opne "No target exists at `#{sdir(target)}`."
    opne "An existing directory is normally the main target here."
    exit 1
  end
end

#set_target(i = first_argument? ) ⇒ Object

#

set_target

#


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
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
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 76

def set_target(
    i = first_argument?
  )
  # ======================================================================= #
  # === Handle pseudo-input starting with ':' such as in ':gtk' or
  #     ":glib". Since as of September 2022 this may also be
  #     ":binaries_neon", which refers to the AppDir bin/ of
  #     neon - aka a target such as /home/Programs/Neon/Current/bin/
  # ======================================================================= #
  if i and
     i.start_with?(':') and
    !File.exist?(i)
    # ===================================================================== #
    # In this case we will assume a special input is used by the user.
    #
    # Usage examples:
    #
    #   sfiles :gtk
    #   sfiles :binaries_neon
    #
    # ===================================================================== #
    case i.delete(':') # Get rid of leading ':' here - we don't need these anymore.
    # when 'gtk' # Disabled in December 2022, because "gtk" is now a real package name.
    #   i = 'gtk+'
    when ':last','last'
      begin
        cd '/usr/lib/' # Require this.
        # ================================================================= #
        # We need to find out the proper file - we will use a hardcoded
        # approach, as that is much faster.
        # ================================================================= #
        this_file = temp_dir?+'rbt/last_symlinked_program.yml'
        if File.exist? this_file
          i = ':'+File.read(this_file).strip
        end
      rescue LoadError; end
    end
    # ===================================================================== #
    # Use the following for libraries, residing under lib/:
    # ===================================================================== #
    i = i.dup if i.frozen?
    i.delete!(':')
    if i.include? 'binaries_'
      i = "#{programs_dir?}#{i.sub(/binaries_/, '').capitalize}/Current/bin/"
    else
      i = "#{programs_dir?}#{i.capitalize}/Current/lib/"
    end
  end
  if File.directory? i
    i = i.dup
    i << '/' unless i.end_with?('/','*') # Ensure a trailing '/'.
    i << '*' unless i.end_with?('*')
  end
  @internal_hash[:target] = i
end

#show_help ⇒ Object

#

show_help (help tag)

#


143
144
145
146
147
148
149
150
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 143

def show_help
  e
  e 'These help-options are documented so far:'
  e
  e '  :gtk               # to use as a shortcut for /Programs/Gtk+/Current/lib/'
  e '  --do-not-overwrite # keep existing files rather than overwrite them'
  e
end

#symlink_these_files(work_on_these_files, overwrite_existing_files = overwrite_existing_files? ) ⇒ Object

#
#


210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 210

def symlink_these_files(
    work_on_these_files,
    overwrite_existing_files = overwrite_existing_files?
  )
  pwd = return_pwd
  opnn
  e; e
  work_on_these_files.each {|this_file|
    if this_file.start_with?('..') and
        File.directory?(File.absolute_path(this_file))
      this_file = File.absolute_path(this_file)
    end
    inner_target = pwd+
                   File.basename(this_file)
    if File.exist?(inner_target) and File.file?(inner_target) 
      # =================================================================== #
      # The old code had this:
      #
      #   and !File.symlink?(inner_target)
      #
      # But I thinks this is not really necessary. We will delete
      # symlinks as well as regular files as-is.
      # =================================================================== #
      if overwrite_existing_files
        remove_this_file(inner_target)
      else
        if be_verbose?
          e crimson('Will not overwrite existing file at `')+
            sfile(inner_target)+
            crimson('`.')
        end
      end
    end
    e "#{rev}Symlinking the file `#{sfile(this_file)}#{rev}`"
    e "#{rev}next, into `#{steelblue(inner_target)}#{rev}`."
    symlink(this_file, inner_target) { :be_verbose }
    e
  }
end

#target? ⇒ Boolean Also known as: symlink_files_from_that_directory?, target_dir?

#

target?

#

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 135

def target?
  @internal_hash[:target]
end