Class: MultimediaParadise::Video::VideoRenamer

Inherits:
Base
  • Object
show all
Defined in:
lib/multimedia_paradise/video/video_renamer.rb

Overview

MultimediaParadise::Video::VideoRenamer

Constant Summary

Constants inherited from Base

Base::ERROR, Base::ERROR_LINE, Base::NAMESPACE, Base::USE_THIS_NAMESPACE_FOR_THE_COLOURS, Base::USE_THIS_NAMESPACE_FOR_THE_CORE_COLOURS

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #cartoons_directory?, #clear_the_internal_hash, #cliner, #cliner_with_time_stamp, #colourized_comment, #copy_file, #crimson, #dataset_from_file_video_collection, #dd_mm_yyyy, #debug?, #default_readlines, #directory_to_realvids?, #do_not_use_opn, #dodgerblue, #does_the_video_player_support_this_commandline?, #e, #ecomment, #ecrimson, #efancy, #enable_debug, #ensure_main_encoding, #ensure_that_the_output_directory_exists, #eparse, #erev, #esystem, #ewarn, #file_video_collection?, #filter_for_audio_files, #filter_for_video_files, #forestgreen, #gold, #grey, #hh_mm_ss, #home_x_video?, #indianred, #infer_the_namespace, #internal_hash?, #is_audio_file?, #is_mkv?, #is_mp3?, #is_mp4?, #is_multimedia_file?, #is_on_roebe?, #is_video_file?, #konsole_colour_peru, #lightblue, #lightgreen, #load_yaml, #local_audio_directory?, #log_dir?, #map_symbol_to_locally_existing_file, #mediumorchid, #mediumpurple, #mediumslateblue, #mkdir, #move_file, #namespace?, #no_file_exists, #no_file_exists_at, #olive, #olivedrab, #opne, #opnecomment, #opnn, #orange, #palegoldenrod, #palegreen, #powderblue, #project_base_directory?, #rds, #register_sigint, #remove_file, #report_pwd, #reset_the_internal_hash, #return_all_video_files, #return_pwd, #return_random_video, #rev, #royalblue, #save_what_into, #sdir, #seagreen, #seconds_to_time_format, #select_only_video_files_from, #set_be_verbose, #set_use_colours, #sfancy, #sfile, #simp, #skyblue, #slateblue, #springgreen, #steelblue, #swarn, #teal, #time_right_now, #to_hh_mm_ss, #tomato, #true_rev, #try_to_rename_kde_konsole_tab, #ucliner, #use_colours?, #use_opn?, #use_which_video_player?, #verbose_truth, #video_collection?, #violet, #yaml_directory?, #yel

Methods included from CommandlineArgumentsModule

#all_input_starts_with_a_number?, #commandline_arguments?, #commandline_arguments_as_a_string, #first_argument?, #first_non_hyphened_commandline_argument?, #set_commandline_arguments

Constructor Details

#initialize(i = ARGV, run_already = true) ⇒ VideoRenamer

#

initialize

#


30
31
32
33
34
35
36
37
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 30

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

Class Method Details

.[](i = ARGV) ⇒ Object

#

MultimediaParadise::Video::VideoRenamer.new[]

#


153
154
155
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 153

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

Instance Method Details

#all_titles? ⇒ Boolean

#

all_titles?

#

Returns:

  • (Boolean) 


73
74
75
76
77
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 73

def all_titles?
  dataset?.map {|key, hash|
    hash['title']
  }
end

#dataset? ⇒ Boolean

#

dataset?

#

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 66

def dataset?
  MultimediaParadise.return_all_video_files
end

#first_word? ⇒ Boolean

#

first_word?

Obtain the first word of the input file.

#

Returns:

  • (Boolean) 


144
145
146
147
148
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 144

def first_word?
  _ = input?
  _ = _.split('_').first if _.include? '_'
  return _
end

#input? ⇒ Boolean

#

input?

#

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 59

def input?
  @input
end

#rename_this_video_file(i = input?) ) ⇒ Object

#

rename_this_video_file

Only call this method when you are sure that we have an input file.

It will then proceed to rename the video file.

#


120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 120

def rename_this_video_file(i = input?)
  matching_dataset = dataset?.select {|key, hash|
    downcased_word = first_word?.downcase
    hash['title'].downcase.include? downcased_word
  }
  if matching_dataset
    file_extension = File.extname(i).delete('.')
    the_key = matching_dataset.keys.first
    new_filename = the_key.to_s+'_'
    # ===================================================================== #
    # Next, append the real name.
    # ===================================================================== #
    new_filename << matching_dataset[the_key]['title'].delete(' ')+'.'+file_extension
    opne 'Now renaming the file `'+sfile(input?)+'` to `'+
         sfile(new_filename)+'`.'
    rename_file(i, new_filename)
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


42
43
44
45
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 42

def reset
  super()
  infer_the_namespace
end

#run ⇒ Object

#

run (run tag)

#


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
109
110
111
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 82

def run
  # ======================================================================= #
  # First, determine whether we have a match.
  # ======================================================================= #
  _ = first_word?
  # ======================================================================= #
  # If a '.' is there, we will assume a file extension such as '.mp4'
  # which is not necessary, thus it will be removed..
  # ======================================================================= #
  if _.include? '.'
    _.sub!(/#{File.extname(_)}$/,'')
  end
  video_is_registered = all_titles?.any? {|entry|
    entry.include? _
  }
  if video_is_registered
    rename_this_video_file
  else
    opnn; e 'It appears as if we do not have a video for this '\
            'input ('+simp(_)+').'
    # ===================================================================== #
    # === Check for numbers only
    # ===================================================================== #
    if _.to_s =~ /^\d+$/
      title = dataset?[_.to_i]['title']
      e 'Only numbers were given. We will thus check for the given file'
      e 'position at number '+simp(_)+' which is `'+simp(title)+'`.'
    end
  end
end

#set_input(i = '') ⇒ Object

#

set_input

#


50
51
52
53
54
 
# File 'lib/multimedia_paradise/video/video_renamer.rb', line 50

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