Class: Roebe::PermissionAsciiFormat

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

Overview

Roebe::PermissionAsciiFormat

Constant Summary collapse

HASH_REVERSED =
#

HASH_REVERSED

This hash has the information to rebuild the original file permissions.

#
{}

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?, #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(i = nil, run_already = true) ⇒ PermissionAsciiFormat

#

initialize

#


51
52
53
54
55
56
57
58
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 51

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_input(i)
  run if run_already
end

Class Method Details

.[](i, optional_mode = nil) ⇒ Object

#

Roebe::PermissionAsciiFormat[]

To use the reverse example, do this:

Roebe::PermissionAsciiFormat['-rwxr-xr-x', :reverse]
#


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 207

def self.[](i, optional_mode = nil)
  case optional_mode
  when :reverse, :convert_into_decimal_format # We wish to reverse it.
    i = i.dup if i.frozen?
    _ = ''.dup
    i[0,1] = '' if i.size == 10 # Chop off the leading one first.
    splitted = i.split(/(.{3})/).reject(&:empty?)
    splitted.each {|entry|
      _ << HASH_REVERSED[entry].to_s
    }
    return _
  else
    PermissionAsciiFormat.new(i).result
  end
end

Instance Method Details

#add(i) ⇒ Object

#

add

#


146
147
148
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 146

def add(i)
  @result << i
end

#build_result_string ⇒ Object

#

build_result_string

#


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 117

def build_result_string
  reset_result
  if File.exist? input?
    # ===================================================================== #
    # The following is semi-hardcoded - should obviously be changed
    # eventually.
    # ===================================================================== #
    if File.directory? input?
      add 'd'
    elsif File.symlink? input?
      add 'l' # l for link, I assume.
    else
      add '-'
    end
    @chmod_value.each_char {|char|
      add(convert_number_to_ascii_format(char))
    }
  elsif only_numbers?
    @chmod_value.each_char {|char|
      add(convert_number_to_ascii_format(char))
    }
  else
    add 'XXX' # This is the key code for a file that does not exist.
  end
end

#chmod_value?(i) ⇒ Boolean

#

chmod_value?

#

Returns:

  • (Boolean) 


87
88
89
90
91
92
93
94
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 87

def chmod_value?(i)
  if File.exist? i
    _ = File.stat(i).mode.to_s(8)[-3,3]
  else
    _ = i
  end
  return _
end

#convert_number_to_ascii_format(i) ⇒ Object

#

convert_number_to_ascii_format

_ will become the return value.

#


162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 162

def convert_number_to_ascii_format(i)
  i = i.to_i
  _ = case i
  when 0 then '---'
  when 1 then '--x'
  when 2 then '-w-'
  when 3 then '-wx'
  when 4 then 'r--'
  when 5 then 'r-x'
  when 6 then 'rw-'
  when 7 then 'rwx'
  end
  return _
end

#determine_chmod_value ⇒ Object

#

determine_chmod_value

#


180
181
182
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 180

def determine_chmod_value
  @chmod_value = chmod_value?(input?)
end

#input? ⇒ Boolean

#

input?

#

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 80

def input?
  @input
end

#only_numbers? ⇒ Boolean

#

only_numbers?

#

Returns:

  • (Boolean) 


109
110
111
112
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 109

def only_numbers?
  return true if input? =~ /\d+/
  false
end

#report_result ⇒ Object Also known as: report

#

report_result

#


153
154
155
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 153

def report_result
  e @result
end

#reset ⇒ Object

#

reset (reset tag)

#


63
64
65
66
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 63

def reset
  infer_the_namespace
  reset_result
end

#reset_result ⇒ Object

#

reset_result

#


99
100
101
102
103
104
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 99

def reset_result
  # ======================================================================= #
  # === @result
  # ======================================================================= #
  @result = ''.dup # Keept it non-frozen.
end

#result? ⇒ Boolean Also known as: result

#

result?

#

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 187

def result?
  @result
end

#run ⇒ Object

#

run (run tag)

#


194
195
196
197
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 194

def run
  determine_chmod_value
  build_result_string
end

#set_input(i = '') ⇒ Object

#

set_input

#


71
72
73
74
75
 
# File 'lib/roebe/classes/permission_ascii_format.rb', line 71

def set_input(i = '')
  i = i.first if i.is_a? Array
  i = i.to_s.dup if i
  @input = i
end