File Coverage

blib/lib/Mango/BSON/Number.pm

Criterion	Covered	Total	%
statement	34	37	91.8
branch	11	12	91.6
condition	22	26	84.6
subroutine	9	12	75.0
pod	5	5	100.0
total	81	92	88.0

package Mango::BSON::Number;
use Mojo::Base -base;
use overload bool => sub { !!shift->value }, '""' => sub { shift->to_string },
             fallback => 1;

use B;
use Carp 'croak';

# 32bit integer range
use constant { INT32_MIN => -(1 << 31) + 1, INT32_MAX => (1 << 31) - 1 };

has [qw(value type)];

sub new {
  my ($class, $value, $type) = @_;

  $value //= 0;
  $type  //= Mango::BSON::DOUBLE();

  if ($type ne Mango::BSON::DOUBLE() &&
      $type ne Mango::BSON::INT32()  &&
      $type ne Mango::BSON::INT64())
  {
    croak "Invalid numerical type: '$type'";
  }

  return $class->SUPER::new(value => $value, type => $type);
}

sub TO_JSON { 0 + shift->value }

sub to_string { '' . shift->value }

sub isa_number {
  my $value = shift;

  my $flags = B::svref_2object(\$value)->FLAGS;

  if ($flags & (B::SVp_IOK | B::SVp_NOK)) {
    if ( ( 0 + $value eq $value && $value * 0 == 0)
      || ( 0 + 'nan' eq $value )
      || ( 0 + '+inf' eq $value )
      || ( 0 + '-inf' eq $value ) )
    {
      return $flags;
    }
  }

  return undef;
}

sub guess_type {
  my $value = shift;

  if (my $flags = isa_number($value)) {
    # Double
    return Mango::BSON::DOUBLE() if $flags & B::SVp_NOK;

    # Int32
    return Mango::BSON::INT32() if $value <= INT32_MAX && $value >= INT32_MIN;

    # Int64
    return Mango::BSON::INT64();
  }

  return undef;
}

1;

=encoding utf8

=head1 NAME

Mango::BSON::Number - Numerical types

=head1 SYNOPSIS

  use Mango::BSON;
  use Mango::BSON::Number;

  my $number = Mango::BSON::Number->new(666, Mango::BSON::INT64);
  say $number;

=head1 DESCRIPTION

L is a container for numerical values with a strict
type.

=head1 METHODS

L inherits all methods from L and implements
the following new ones.

=head2 new

  my $number = Mango::BSON::Number->new(3.14, Mango::BSON::DOUBLE);

Construct a new L object. Croak if the value is
incompatible with the given type. The 3 supported types are C,
C and C.

=head2 TO_JSON

  my $num = $obj->TO_JSON;

Return the numerical value.

=head2 to_string

  my $str = $num->to_string;

Return the value as a string.

=head2 isa_number

  my $flags = Mango::BSON::Number::isa_number(25);

Determine if the given variable is a number by looking at the internal
flags of the perl scalar object.

Return C if the value is not a number, or a non-null value otherwise.
This value contains flags which can be used for finer analysis of the scalar.

=head2 guess_type

  my $mongo_type = Mango::BSON::Number::guess_type(25);

Chose which BSON type to use to encode the given numeric value. Possible
types are: C, C or
C.

Return C if the given value is not a number.

=head1 OPERATORS

L overloads the following operators.

=head2 bool

  my $bool = !!$num;

=head2 stringify

  my $str = "$num";

Alias for L.

=head1 SEE ALSO

L, L, L.

=cut