class Termodoro

A new instance of this class takes user-input as command line arguments and prepares a string to be execute as a Bash system command. The user specifies an amount of time and an optional message to display. After the amount of time elapses a terminal-notifier message appears with the message - if the message was omitted, the word “Termodoro” appears instead.

Constants

SECS_IN_HOUR: Used in multiplication to arrive at the number of seconds in an hour.
SECS_IN_MIN: Used in multiplication to arrive at the number of seconds in a minute.

Attributes

arguments[R]

message[RW]

number_of_units[RW]

time_unit[RW]

Public Class Methods

new(arguments) click to toggle source

@param arguments [String] The arguments passed in by the user at the command

line. this includes the time after which the reminder will appear and an 
optional message to appear in the body of the reminder.

# File lib/termodoro/termodoro.rb, line 26
def initialize(arguments)
  @arguments = arguments
end

Public Instance Methods

calculate_time() click to toggle source

Depending on what unit of time is being used, determines the number of seconds using multiplication by {Termodoro::SECS_IN_MIN SECS_IN_MIN} and {Termodoro::SECS_IN_HOUR SECS_IN_HOUR} constants. The check to seconds? is not necessary, but feels nice. @see parse_number_of_units @see seconds? @see minutes? @see hours? @return [Integer] total number of seconds for which to wait until the reminder

is displayed.

# File lib/termodoro/termodoro.rb, line 65
def calculate_time
  if minutes?
    seconds = parse_number_of_units * SECS_IN_MIN
  elsif hours?
    seconds = parse_number_of_units * SECS_IN_HOUR
  elsif seconds?
    seconds = parse_number_of_units
  end

  seconds
end

command() click to toggle source

Workhorse method: Runs calculate_time and parse_message, taking the results of those methods and creating the string to execute. @see calculate_time @see parse_message @return [String] the fully-formed command string ready to be run by bash as

a system command.

# File lib/termodoro/termodoro.rb, line 115
def command
  time_unit = calculate_time
  msg_part = parse_message
  "sleep #{time_unit} && terminal-notifier -message '#{msg_part}' -title 'Termodoro' & disown"
end

hours?() click to toggle source

Truthy if user has input a number of hours. @see parse_time_unit @return [Boolean]

# File lib/termodoro/termodoro.rb, line 97
def hours?
  hours = %w[h hr hrs hour hours]
  true if hours.include?(parse_time_unit)
end

minutes?() click to toggle source

Truthy if user has input a number of minutes. @return [Boolean] @see parse_time_unit

# File lib/termodoro/termodoro.rb, line 89
def minutes?
  minutes = %w[m min mins minute minutes]
  true if minutes.include?(parse_time_unit)
end

parse_message() click to toggle source

Looks into the user-supplied arguments and returns the message, if one is present. If not, sets the message to “Termodoro”. @return [String] the optional message given by the user.

# File lib/termodoro/termodoro.rb, line 49
def parse_message
  # .split(/[\d]+.[\w]+/).last
  parsed_message = @arguments.split(/^\s*[\d]+\s*[\w]+/).last || 'Termodoro'
  self.message = parsed_message.strip
end

parse_number_of_units() click to toggle source

Looks into the user-supplied arguments and parses out the number of units of time. @return [Integer] the number of units of time given by the user.

# File lib/termodoro/termodoro.rb, line 41
def parse_number_of_units
  number = @arguments.scan(/[\d]+/).first.strip.to_i
  self.number_of_units = number
end

parse_time_unit() click to toggle source

Looks into the user-supplied arguments and retreives the unit of time. @return [String] a version of hours, minutes or seconds, depending on how the user inputs it (“s”, “Sec”, “seconds”, etc.)

# File lib/termodoro/termodoro.rb, line 33
def parse_time_unit
  segment = @arguments.match(/\D+/)[0].split(' ').first
  self.time_unit = segment
end

seconds?() click to toggle source

Truthy if user has input a number of seconds. @return [Boolean] @see parse_time_unit

# File lib/termodoro/termodoro.rb, line 81
def seconds?
  seconds = %w[s sec secs second seconds]
  true if seconds.include?(parse_time_unit)
end