Class: Roebe::Merge

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

Overview

Roebe::Merge

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, #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 = ARGV, run_already = true) ⇒ Merge

#

initialize

#


33
34
35
36
37
38
39
40
 
# File 'lib/roebe/classes/merge.rb', line 33

def initialize(
    i           = ARGV,
    run_already = true
  )
  reset
  set_commandline_arguments(i)
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

Roebe::Merge[]

#


113
114
115
 
# File 'lib/roebe/classes/merge.rb', line 113

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

Instance Method Details

#merge_these_files(i) ⇒ Object

#

merge_these_files

#


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

def merge_these_files(i)
  # ======================================================================= #
  # Use a default value for the file extension of the new file that is
  # to be created:
  # ======================================================================= #
  file_extension_to_use_for_the_new_file = '.md'
  if i.is_a? Array
    file_extension_to_use_for_the_new_file = File.extname(i.first)
    dataset = ''.dup
    i.each {|this_file|
      if File.exist?(this_file)
        dataset << file_read(this_file)
        # dataset << "\n" # Adding a newline appears to be incorrect.
      end
    }
    new_filename = i.map {|entry|
      entry.delete_suffix(File.extname(entry))
    }.join('_')
    i = i.join(' ').strip
  else
    raise 'Needs an Array as input.'
  end
  new_filename = new_filename.dup if new_filename.frozen?
  unless new_filename.end_with? file_extension_to_use_for_the_new_file
    new_filename << file_extension_to_use_for_the_new_file
  end
  opne 'Merging the following files together: '
       sfile(i)
  opne 'The file that will be created is: '+sfile(new_filename)
  write_what_into(dataset, new_filename)
end

#reset ⇒ Object

#

reset (reset tag)

#


45
46
47
48
 
# File 'lib/roebe/classes/merge.rb', line 45

def reset
  super()
  infer_the_namespace
end

#run ⇒ Object

#

run (run tag)

#


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/roebe/classes/merge.rb', line 53

def run
  # ======================================================================= #
  # We presently only work on files. Perhaps in the future this may be
  # changed, but for now this is the way to go.
  # ======================================================================= #
  files_only = arguments?.select {|entry| is_a_file?(entry) }
  opne 'Merging '+(files_only.size).to_s+' files ...'
  # ======================================================================= #
  # Next, we distinguish between two use cases: regular text files or
  # other files; versus multimedia files. For the latter we will
  # pass towards class MergeMultimedia. For the former use cases, we
  # will implement a solution as-is in this class.
  # ======================================================================= #
  if files_only.any? {|entry|
      is_a_multimedia_file?(entry)
    }
    MultimediaParadise::MergeMultimedia.new(files_only)
  else
    merge_these_files(files_only)
  end
end