Class: Roebe::IsoToUsb

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

Overview

Roebe::IsoToUsb

Constant Summary collapse

USE_THIS_AS_THE_DEVICE_POINT =
#

USE_THIS_AS_THE_DEVICE_POINT

This is currently a static default.

#
'/dev/sdc'

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

Constructor Details

#initialize(use_this_iso_file = nil, run_already = true) ⇒ IsoToUsb

#

initialize

#


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

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

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::IsoToUsb[]

#


232
233
234
# File 'lib/roebe/classes/iso_to_usb.rb', line 232

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

Instance Method Details

#ask_the_user_whether_it_is_ok_to_run_this_cmd_before_proceeding(i) ⇒ Object

#

ask_the_user_whether_it_is_ok_to_run_this_cmd_before_proceeding

We require the user to specifically say whether it is fine to continue or whether it is not.

#


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/roebe/classes/iso_to_usb.rb', line 196

def ask_the_user_whether_it_is_ok_to_run_this_cmd_before_proceeding(i)
  opne 'User confirmation is necessary before we can continue,'
  opne 'in order to avoid any damage. Thus, please read the next'
  opne 'question carefully before hitting any key.'
  e
  opne tomato('Is it ok to proceed with the following command? [')+
       steelblue('y/n')+
       tomato(']')
  e
  e "  #{steelblue(i)}"
  e
  require 'io/console'
  user_input = STDIN.getch
  if user_input == 'y'
    opne 'Proceeding with the '+steelblue('dd')+
         ' command ... this may take a while.'
    system i
    opne 'Done!'
  else
    opne 'Operation was cancelled.'
  end
end

#do_perform_the_dd_step(bs = ' bs=4M') ⇒ Object

#

do_perform_the_dd_step (dd tag)

This method will perform the actual step through “dd”, such as in:

'dd if=/path/to/ubuntu.iso of=/dev/sdX bs=4M'

The value bs= defines the block size that is to be used. Using a very small block size means that you will get a lot of “CPU overhead”.

#


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'lib/roebe/classes/iso_to_usb.rb', line 174

def do_perform_the_dd_step(
    bs = ' bs=4M'
  )
  _ = 'dd if='+iso_file?+' of='+target_device?+bs # bs is added last here.
  _ = _.dup if _.frozen?
  # ======================================================================= #
  # This should write the output file data before finishing, which should
  # take care of the sync.
  # ======================================================================= #
  _ << ' conv=fdatasync'
  _ << ' status=progress'
  e
  ask_the_user_whether_it_is_ok_to_run_this_cmd_before_proceeding _
  e
end

#do_sync_stepObject

#

do_sync_step

The sync bit is important as “dd” can return before the write operation finishes.

#


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

def do_sync_step
  esystem 'sync'
end

#do_umount_stepObject

#

do_umount_step (umount tag)

#


95
96
97
98
99
# File 'lib/roebe/classes/iso_to_usb.rb', line 95

def do_umount_step
  _ = 'umount '+@target_device
  opne 'Performing an umount (un-mount) step next.'
  opnesystem _
end
#

menu (menu tag)

#


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/roebe/classes/iso_to_usb.rb', line 124

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry|
      menu(entry)
    }
  else
    case i
    # ===================================================================== #
    # === --help
    # ===================================================================== #
    when /^-?-?help$/
      show_help
      exit
    # ===================================================================== #
    # === --target-dev=/dev/sdb
    #
    # Invocation example:
    #
    #   iso_to_usb /Depot/ISOs/deepin-15.5-amd64.iso --target-dev=/dev/sdb
    #
    # ===================================================================== #
    when /^-?-?target(-|_)?dev=(.+)$/i # === $2
      set_target_dev($2.to_s.dup)
    end
  end
end

#resetObject

#

reset (reset tag)

#


53
54
55
56
57
58
59
60
# File 'lib/roebe/classes/iso_to_usb.rb', line 53

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @target_device
  # ======================================================================= #
  @target_device = USE_THIS_AS_THE_DEVICE_POINT
end

#runObject

#

run (run tag)

#


222
223
224
225
226
227
# File 'lib/roebe/classes/iso_to_usb.rb', line 222

def run
  menu
  do_umount_step
  do_perform_the_dd_step
  do_sync_step
end

#set_commandline_arguments(i) ⇒ Object

#

set_commandline_arguments

Note that the commandline arguments are only those that start with a ‘–’.

#


117
118
119
# File 'lib/roebe/classes/iso_to_usb.rb', line 117

def set_commandline_arguments(i)
  @commandline_arguments = i.select {|line| line.start_with? '--' }
end

#set_target_device(i) ⇒ Object Also known as: set_target_dev

#

set_target_device

#


65
66
67
# File 'lib/roebe/classes/iso_to_usb.rb', line 65

def set_target_device(i)
  @target_device = i
end

#set_use_this_iso_file(i = '') ⇒ Object

#

set_use_this_iso_file

#


79
80
81
82
83
# File 'lib/roebe/classes/iso_to_usb.rb', line 79

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

#show_helpObject

#

show_help (help tag)

#


156
157
158
159
160
161
162
# File 'lib/roebe/classes/iso_to_usb.rb', line 156

def show_help
  e
  e '  --target-dev= # designate the target device, such as /dev/sdb'
  e
  e 'The current hardcoded target device entry is '+slateblue(target_device?)
  e
end

#target_device?Boolean Also known as: device?

#

target_device?

#

Returns:

  • (Boolean)


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

def target_device?
  @target_device
end

#use_this_iso_file?Boolean Also known as: iso_file?

#

use_this_iso_file?

#

Returns:

  • (Boolean)


88
89
90
# File 'lib/roebe/classes/iso_to_usb.rb', line 88

def use_this_iso_file?
  @use_this_iso_file
end