File Coverage

blib/lib/Time/ProseClock.pm

Criterion	Covered	Total	%
statement	48	50	96.0
branch	6	12	50.0
condition	3	9	33.3
subroutine	9	9	100.0
pod	0	2	0.0
total	66	82	80.4

require 5.004;
package Time::ProseClock;

use strict;
use vars qw($VERSION);
$VERSION = 1.02;

use Carp();

sub new
{
  my $self = shift;

  $self = bless {}, ref($self) || $self;

  $self->_set_phrases();

  return $self;
}

sub display
{
  my $self = shift;
  my $time_arg = shift || time;

  Carp::croak(qq[invalid time format [$time_arg]])
      if $time_arg !~ /^\d+$/;

  $self->_get_time($time_arg);
  $self->_set_minute();
  $self->_set_hour();

  my $txt = qq[$self->{'min_phrase'} $self->{'mul_phrase'} $self->{'hour_phrase'}];
  $txt =~ s| {2,}| |; # there may not be a mul_phrase
  return $txt;
}


#------------------------------------------------------------------------------#
# private methods                                                              #
#------------------------------------------------------------------------------#
sub _set_hour
{
  my $self = shift;

  my $hours = $self->{'time'}->{'hours'};

  if ($self->{'mul'} >= 35)
  {
    ($hours == 23) ? $hours = 0 : $hours++;
  }

  $self->{'hour_phrase'} = $self->{'HourPhrases'}->[$hours];

  if (($hours == 0) && ($self->{'time'}->{'minutes'} < 3))
  {
    $self->{'mul_phrase'} = '';
  }

  return;
}

sub _set_minute
{
  my $self = shift;

  my $minutes = $self->{'time'}->{'minutes'};

  my $remainder = $minutes % 5;

  $self->{'mul'} = $minutes - $remainder;

  # switch frame of reference
  $self->{'mul'} += 5 if $remainder >= 3;

  $self->{'min_phrase'} = $self->{'MinutePhrases'}->[$remainder];

  if (exists($self->{'Multiples'}->{$self->{'mul'}}))
  {
    $self->{'mul_phrase'} = $self->{'Multiples'}->{$self->{'mul'}};
  }
  else
  {
    $self->{'mul_phrase'} = '';
  }

  return;
}

# We only need hours and minutes; finer granularity would be unprosaic.
sub _get_time
{
  my $self = shift;
  my $time_arg = shift;
  @{$self->{'time'}}{qw(minutes hours)} = (localtime($time_arg))[1, 2];
  return;
}

sub _set_phrases
{
  my $self = shift;

  $self->{'MinutePhrases'} =
    [
     'exactly',
     'just after',
     'a little after',
     'coming up to',
     'almost',
    ];

  $self->{'Multiples'} =
    {
      0 => '',
      5 => 'five past',
     10 => 'ten past',
     15 => 'quarter past',
     20 => 'twenty past',
     25 => 'twenty-five past',
     30 => 'half past',
     35 => 'twenty-five to',
     40 => 'twenty to',
     45 => 'quarter to',
     50 => 'ten to',
     55 => 'five to',
    };

  $self->{'HourPhrases'} =
    [
     'midnight',
     'one in the morning',
     'two in the morning',
     'three in the morning',
     'four in the morning',
     'five in the morning',
     'six in the morning',
     'seven in the morning',
     'eight in the morning',
     'nine in the morning',
     'ten in the morning',
     'eleven in the morning',
     'noon',
     'one in the afternoon',
     'two in the afternoon',
     'three in the afternoon',
     'four in the afternoon',
     'five in the afternoon',
     'six at night',
     'seven at night',
     'eight at night',
     'nine at night',
     'ten at night',
     'eleven at night',
    ];

  return;
}

1;

__END__