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 collapse

NAMESPACE =
#

NAMESPACE

#
inspect

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #bold_blue, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkslateblue, #deeppink, #delete_symlink, #disable_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esystem, #esystem_colourized, #ewarn, #firebrick, #get_current_day, #get_current_month, #get_files_from, #get_german_name_for_this_weekday, #gold, #grey, #hh_mm_ss, #home_dir?, #home_directory_of_user_x?, #is_a_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lime, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumspringgreen, #mediumturquoise, #mkdir, #mv, #n_days_in_this_month, #no_file_exists_at, #olivedrab, #open_in_browser, #opne, #opnn, #orange, #orchid, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_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, #return_all_directories_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, #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, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #swarn, #symlink, #teal, #to_camelcase, #tomato, #touch, #use_colours?, #verbose_truth, #weekday?, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#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?, #return_commandline_arguments_with_leading_hyphens, #set_commandline_arguments

Constructor Details

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

#

initialize

#

43
44
45
46
47
48
49
50
51
52
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 43

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

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::SymlinkFilesFromThatDirectoryToTheCurrentDirectory[]

#

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 246

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

Instance Method Details

#

menu (menu tag)

#

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 148

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) 

77
78
79
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 77

def overwrite_existing_files?
  @internal_hash[:overwrite_existing_files]
end

#reset ⇒ Object

#

reset (reset tag)

#

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 57

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

#run ⇒ Object

#

run (run tag)

#

173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 173

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

#

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

def set_target(
    i = first_argument?
  )
  # ======================================================================= #
  # === Handle pseudo-input starting with ':' such as in ':gtk'
  # ======================================================================= #
  if i.start_with?(':') and !File.exist?(i)
    # ===================================================================== #
    # In this case we will assume a special input is used by the user.
    #
    # Usage example:
    #
    #   sfiles :gtk
    #
    # ===================================================================== #
    case i.delete(':')
    when 'gtk'
      i = 'gtk+'
    when ':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 = '/home/Temp/rbt/last_symlinked_program.yml'
        if File.exist? this_file
          i = ':'+File.read(this_file).strip
        end
      rescue LoadError; end
    end
    i = "#{programs_dir?}#{i.delete(':').capitalize}/Current/lib/"
  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)

#

136
137
138
139
140
141
142
143
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 136

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

#
#

203
204
205
206
207
208
209
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
 
# File 'lib/roebe/classes/symlink_files_from_that_directory_to_the_current_directory/symlink_files_from_that_directory_to_the_current_directory.rb', line 203

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 "Symlinking the file `#{sfile(this_file)}`"
    e 'next, into `'+steelblue(inner_target)+'`.'
    symlink(this_file, inner_target) { :be_verbose }
    e
  }
end

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

#

target?

#

Returns:

  • (Boolean) 

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 128

def target?
  @internal_hash[:target]
end