Class: Roebe::SymlinkEverythingFromThatDirectoryToThisDirectory

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

Overview

Roebe::SymlinkEverythingFromThatDirectoryToThisDirectory

Constant Summary collapse

DEFAULT_TARGET =
#

DEFAULT_TARGET

#
'/usr/local/include/'

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, #show_help, #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_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?

Constructor Details

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

#

initialize

#


33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 33

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

Class Method Details

.[](i = '') ⇒ Object

#

[]

#


188
189
190
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 188

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

Instance Method Details

#commandline_arguments? ⇒ Boolean

#

commandline_arguments?

#

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 115

def commandline_arguments?
  @commandline_arguments
end

#default_symlink_to_pwd ⇒ Object

#
#


72
73
74
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 72

def default_symlink_to_pwd
  set_symlink_to_this_directory(:pwd)
end

#determine_target_directory_from_the_commandline_arguments ⇒ Object

#

determine_target_directory_from_the_commandline_arguments

#


170
171
172
173
174
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 170

def determine_target_directory_from_the_commandline_arguments
  set_from_that_directory(
    @commandline_arguments.first
  )
end

#do_symlink(from, to) ⇒ Object

#
#


142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 142

def do_symlink(
    from, to
  )
  unless File.exist? to
    opn; e "Next symlinking `#{sfancy(from)}` to `#{sfancy(to)}`."
    File.symlink(from, to)
  else
    opn; e 'We tried to symlink into '+sfancy(to)+' but this '+
           'target already exists, so we will not symlink.'
  end
end

#entries_that_must_be_symlinked? ⇒ Boolean

#

entries_that_must_be_symlinked?

#

Returns:

  • (Boolean) 


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

def entries_that_must_be_symlinked?
  @entries_that_must_be_symlinked
end

#notify_the_user_what_will_be_done_next ⇒ Object

#

notify_the_user_what_will_be_done_next

#


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

def notify_the_user_what_will_be_done_next
  opn; e 'Now symlinking all from `'+sdir(target_dir?)+
         '` into `'+sdir(symlink_into_this_dir?)+'`.'
end

#obtain_all_entries_from_target_directory ⇒ Object

#

obtain_all_entries_from_target_directory

#


86
87
88
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 86

def obtain_all_entries_from_target_directory
  @entries_that_must_be_symlinked = Dir["#{target_dir?}*"]
end

#reset ⇒ Object

#

reset (reset tag)

#


48
49
50
51
52
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 48

def reset
  super()
  infer_the_namespace
  default_symlink_to_pwd
end

#run ⇒ Object

#

run (run tag)

#


179
180
181
182
183
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 179

def run
  notify_the_user_what_will_be_done_next
  obtain_all_entries_from_target_directory
  symlink_all_entries
end

#set_commandline_arguments(i = '') ⇒ Object

#

set_input

#


107
108
109
110
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 107

def set_commandline_arguments(i = '')
  i = [i].flatten.compact
  @commandline_arguments = i
end

#set_from_that_directory(i = DEFAULT_TARGET) ⇒ Object

#

set_from_that_directory

#


157
158
159
160
161
162
163
164
165
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 157

def set_from_that_directory(
    i = DEFAULT_TARGET
  )
  i = i.first if i.is_a? Array
  i = DEFAULT_TARGET if i.nil?
  i = i.to_s.dup if i
  i << '/' unless i.end_with? '/'
  @from_that_directory = i
end

#set_symlink_to_this_directory(i = return_pwd) ⇒ Object Also known as: set_symlink_into_this_directory

#
#


57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 57

def set_symlink_to_this_directory(
    i = return_pwd
  )
  case i
  when :pwd
    i = return_pwd
  end
  i = i.dup if i.frozen?
  i << '/' unless i.end_with? '/'
  @symlink_to_this_directory = i
end

#symlink_all_entries ⇒ Object

#
#


130
131
132
133
134
135
136
137
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 130

def symlink_all_entries
  symlink_into_this_dir = symlink_into_this_dir?
  entries_that_must_be_symlinked?.each {|entry|
    do_symlink(entry,
      symlink_into_this_dir+File.basename(entry)
    ) 
  }
end

#symlink_to_this_directory? ⇒ Boolean Also known as: symlink_into_this_dir?

#
#

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 79

def symlink_to_this_directory?
  @symlink_to_this_directory
end

#target_dir? ⇒ Boolean

#

target_dir?

#

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/roebe/classes/symlink_everything_from_that_directory_to_this_directory.rb', line 100

def target_dir?
  @from_that_directory
end