Class: Roebe::TwentyfourHoursNotation

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

Overview

Roebe::TwentyfourHoursNotation

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, #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, #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(optional_start_position = nil, optional_end_position = nil) ⇒ TwentyfourHoursNotation

#

initialize

#


26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 26

def initialize(
    optional_start_position = nil,
    optional_end_position   = nil
  )
  reset
  if optional_start_position
    set_start_position(optional_start_position)
  end
  if optional_end_position
    set_end_position(optional_end_position)
  end
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::TwentyfourHoursNotation[]

Usage example:

require 'roebe/classes/twentyfour_hours_notation.rb'; x = Roebe::TwentyfourHoursNotation[300] # => "00:05:00.000"
#


159
160
161
162
163
164
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 159

def self.[](i = ARGV)
  if i.is_a? Array
    i = i.first
  end
  new.convert_to_long_format(i)
end

Instance Method Details

#convert_to_long_format(i) ⇒ Object

#

convert_to_long_format

This returns the long string variant. We assume that the input is in seconds.

#


123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 123

def convert_to_long_format(i)
  i = i.to_s.dup
  i.tr!(',','.') if i.include? ','
  hours, minutes   = i.to_f.divmod(3600)
  minutes, seconds = minutes.divmod(60)
  # ======================================================================= #
  # As of Nov 2013, it seems as if Ffmpeg demands .000 rather than ,000
  # ======================================================================= #
  append_this = '.000'
  # ======================================================================= #
  # Unfortunately, something seems to have yet again changed, so.
  # ======================================================================= #
  append_this = ''
  result = (
    '%02d:%02d:' % [hours, minutes]
  )
  result << ('%0.3f' % seconds).to_s.rjust(6,'0')
  result << append_this
  return result
end

#end? ⇒ Boolean

#

end?

#

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 60

def end?
  return @end_position
end

#end_position? ⇒ Boolean Also known as: end_position

#

end_position?

#

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 90

def end_position?
  @end_position
end

#format_it_properly ⇒ Object Also known as: format

#

format_it_properly

#


97
98
99
100
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 97

def format_it_properly # run tag
  @result = '['+convert_to_long_format(start_position?)+'-'+
                convert_to_long_format(end_position?)+']'
end

#reset ⇒ Object

#

reset

#


42
43
44
45
46
47
48
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 42

def reset
  infer_the_namespace
  # ======================================================================= #
  # === @result
  # ======================================================================= #
  @result = ''.dup
end

#result? ⇒ Boolean

#

result?

#

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 105

def result?
  @result
end

#run ⇒ Object

#

run

#


147
148
149
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 147

def run
  format_it_properly
end

#set_end_position(i) ⇒ Object Also known as: set_end_position=, end_position=

#

set_end_position

#


75
76
77
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 75

def set_end_position(i) # Setter method.
  @end_position = i
end

#set_start_position(i) ⇒ Object Also known as: set_start_position=, start_position=

#

set_start_position

#


67
68
69
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 67

def set_start_position(i) # Setter method.
  @start_position = i
end

#simple_format(i) ⇒ Object

#

simple_format

#


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

def simple_format(i) # Simple alias. But we also kill 's.
  i.delete!('s') if i.to_s.include? 's'
  convert_to_long_format(i)
end

#start? ⇒ Boolean

#

start?

#

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 53

def start?
  return @start_position
end

#start_position? ⇒ Boolean Also known as: start_position

#

start_position?

#

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/roebe/classes/twentyfour_hours_notation.rb', line 83

def start_position?
  @start_position
end