Class: MultimediaParadise::Audio::ReportMissingId

Inherits:
MultimediaParadise::AudioBase show all
Defined in:
lib/multimedia_paradise/audio/report_missing_id.rb

Overview

MultimediaParadise::Audio::ReportMissingId

Constant Summary collapse

ARRAY_CHECK_ON_THESE_ENTRIES =
#

ARRAY_CHECK_ON_THESE_ENTRIES

Here you can specify which mp3 tags are to be checked.

#
%i(
  year
  Artist
)

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 MultimediaParadise::AudioBase

#directory_to_the_local_songs?, #return_random_audio_file

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) ⇒ ReportMissingId

#

initialize

#


41
42
43
44
45
46
47
48
49
50
 
# File 'lib/multimedia_paradise/audio/report_missing_id.rb', line 41

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

Class Method Details

.[](i = ARGV) ⇒ Object

#

MultimediaParadise::ReportMissingId[]

#


124
125
126
 
# File 'lib/multimedia_paradise/audio/report_missing_id.rb', line 124

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

Instance Method Details

#reset ⇒ Object

#

reset (reset tag)

#


55
56
57
58
 
# File 'lib/multimedia_paradise/audio/report_missing_id.rb', line 55

def reset
  super()
  infer_the_namespace
end

#run ⇒ Object

#

run (run tag)

#


109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/multimedia_paradise/audio/report_missing_id.rb', line 109

def run
  first = first?
  first = return_pwd if first.nil?
  _ = [first].map {|entry|
    if File.directory?(entry)
      entry = Dir[entry+'**']
    end
    entry
  }.flatten.select {|entry| is_an_audio_file?(entry) }
  work_on_these_files(_)
end

#work_on_these_files(i) ⇒ Object

#

work_on_these_files

This method will work on the given audio files, and identify which entry is missing.

#


66
67
68
69
70
71
72
73
74
75
76
77
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
 
# File 'lib/multimedia_paradise/audio/report_missing_id.rb', line 66

def work_on_these_files(i)
  problem_encountered = 0
  i.each {|this_audio_file|
    audio_tag_reader = MultimediaParadise::Audio::AudioTagReader.new(this_audio_file) { :do_not_report_anything }
    # ===================================================================== #
    # Next, we will check against the main Array.
    # ===================================================================== #
    ARRAY_CHECK_ON_THESE_ENTRIES.each {|this_entry|
      result = audio_tag_reader.send(
        (this_entry.to_s.downcase+'?').to_sym
      )
      case this_entry
      # =================================================================== #
      # === :Artist
      # =================================================================== #
      when :Artist, :artist
        if result.to_s.empty?
          problem_encountered += 1
          e steelblue(problem_encountered.to_s)+
            rev+') No artist entry for: '+sfile(this_audio_file)
        end
      # =================================================================== #
      # === :Year
      # =================================================================== #
      when :Year, :year
        if result.to_s == '0'
          problem_encountered += 1
          e steelblue(problem_encountered.to_s)+
            rev+') '\
            'Faulty year entry for '+sfile(this_audio_file)+rev+'; '\
            'the value was 0.'
          e tomato(
              '  This means that no year has been registered for this audio file.'
            )
        end
      end
    }
  }
end