root/trunk/antimatter/tim/Modules/SFLC/TimeTracker/Question/YesNoCat.pm

# Copyright (C) 2005, 2006   Software Freedom Law Center, Inc.
#  Author: Bradley M. Kuhn <bkuhn@softwarefreedom.org>
#
#  This software gives you freedom; it is licensed to you under version
#  3 of the GNU Affero General Public License.
#
#  This software is distributed WITHOUT ANY WARRANTY, without even the
#  implied warranties of MERCHANTABILITY and FITNESS FOR A PARTICULAR
#  PURPOSE.  See the GNU Affero General Public License for further
#  details.
#
# You should have received a copy of the GNU Affero General Public
# License, version 3 along with this software.  If not, see
# <http://www.gnu.org/licenses/>.
package SFLC::TimeTracker::Question::YesNoCat;

use strict;
use warnings;


require Exporter;
#use AutoLoader qw(AUTOLOAD);

use base qw(SFLC::TimeTracker::Question Exporter);


our @EXPORT_OK = ();

our @EXPORT = qw( );

our $VERSION = '0.01';

use Carp;

our $YES_RE = '(?:y+e*s*|t+r?u?e?)';
our $NO_RE = '(?:n+o*|f+a?l?s?e?)';
our $ABORT_RE = '(?:x|ab?o?r?t?|q)';

sub new {
  my $class = shift;
  my %args = @_;

  $args{numberRegex} = 'NOT_IN_USE';
  $args{answers} = [ 'y', 'n', 'a'];
  my $self = SFLC::TimeTracker::Question::new($class, %args);
  croak "category value required for YesNoCat question"
    unless defined $args{category};
  $self->{categoryValue} = $args{category};
  $self->{resolutionData} = {};
  $self->{resolutionData}{answerType} = 'loopback';
  return $self;
}
###############################################################################
sub setResolutionData {
  my $self = shift;

  $self->{resolutionData} = shift;
}
###############################################################################
sub getResolutionData {
  my $self = shift;
  return %{$self->{resolutionData}};
}
###############################################################################
sub validateAnswer ($$) {
  my($self, $answer) = @_;

  my $n = $self->{numberRegex};
  return undef if not defined $self->{answers};
  if ($answer =~ /^\s*$YES_RE/) {
    return "yes";
  } elsif  ($answer =~ /^\s*$NO_RE/) {
    return "no";
  } elsif ($answer =~ /^\s*$ABORT_RE/) {
    return "abort";
  } else {
    return undef;
  }
}
###############################################################################
sub formatQuestion ($) {
  my($self) = @_;
  my $string = "";

  return "$self->{question} (y|n|a)?";
}
###############################################################################
sub resolve ($$) {
  my($self, $answer) = @_;

  my $retVal = undef;

  $answer = $self->validateAnswer($answer);
  return "INVALID" unless defined $answer;
  my $categoryID;
  my $rejected = 0;
  if ($answer eq "yes") {
    $self->setResolutionData({ answerType => 'yes',
                               category => $self->{categoryValue} });
#                               ( (defined $self->{resolutionData}{category})
#                                 ? $self->{resolutionData}{category} : "/")
#                               . $self->{categoryValue} });
    return 'RESOLVED';
  } elsif ($answer eq "no") {
    $self->setResolutionData({ answerType => 'no', category => undef});
#,
#                               category => 
#                               ( (defined $self->{resolutionData}{category})
#                                 ? $self->{resolutionData}{category} : "") });
    return 'RESOLVED';
  } elsif ($answer eq "abort") {
    $self->setResolutionData({ answerType => 'abort', category => undef});
    return "REJECTED";
  } else {
    $self->setResolutionData({ answerType => 'loopback',
                               category =>
                               ( (defined $self->{resolutionData}{category})
                                 ? $self->{resolutionData}{category} : "") });
    return "INVALID";
  }
}
###############################################################################

sub formatResolveString ($$) {
  my($self, $string) = @_;
  return "Aborted." if $string eq "REJECTED";
  return "Your response was invalid." if $string =~ /^INVALID/;
  return "Ok." if $string =~ /^RESOLVED/;
}

1;
__END__

#
# Local variables:
# compile-command: "perl -I ../../../../Modules -c YesNoCat.pm"
# End: