File Coverage

blib/lib/Geo/Leaflet/Icon.pm

Criterion	Covered	Total	%
statement	12	28	42.8
branch	0	10	0.0
condition	0	3	0.0
subroutine	4	9	44.4
pod	4	4	100.0
total	20	54	37.0

package Geo::Leaflet::Icon;
use strict;
use warnings;
use base qw{Package::New};
use JSON::XS;

our $VERSION = '0.04';
our $PACKAGE = __PACKAGE__;

=head1 NAME

Geo::Leaflet::Icon - Leaflet icon object

=head1 SYNOPSIS

  use Geo::Leaflet;
  my $map = Geo::Leaflet->new;

=head1 DESCRIPTION

This package constructs a Leaflet icon object for use in a L object.

=head1 CONSTRUCTORS

=head2 new

=head1 PROPERTIES

=head2 name

The JavaScript name for the icon object.

Default: iconNNN

=cut

our $NAME_PREFIX = 'icon';
our $NAME_INDEX  = 1;

sub name {
  my $self          = shift;
  $self->{'name'}   = shift if @_;
  $self->{'name'} ||= sprintf(sprintf('%s%d', $NAME_PREFIX, $NAME_INDEX++));
  die("Error: $PACKAGE name invaild variable name") unless $self->{'name'} =~ m/\A[a-z_][a-z0-9_]*\Z/i;
  return $self->{'name'};
}

=head2 options

=cut

sub options {
  my $self              = shift;
  $self->{'options'} = shift if @_;
  $self->{'options'} = {} unless $self->{'options'};
  die("Error: $PACKAGE options must be a hash") unless ref($self->{'options'}) eq 'HASH';
  return $self->{'options'};
}

=head1 METHODS

=head2 stringify

=cut

sub _method_name {'icon'};

sub stringify {
  my $self    = shift;
  # var icon_name = L.icon({
  #          iconUrl: 'my-icon.png',
  #          iconSize: [38, 95],
  #          iconAnchor: [22, 94],
  #          popupAnchor: [-3, -76],
  #          shadowUrl: 'my-icon-shadow.png',
  #          shadowSize: [68, 95],
  #          shadowAnchor: [22, 94]
  #        });
  return sprintf(q{L.%s(%s);}, $self->_method_name, $self->JSON->encode($self->options));
}

=head2 JSON

=cut

sub JSON {
  my $self        = shift;
  $self->{'JSON'} = JSON::XS->new->allow_nonref;
  return $self->{'JSON'};
}

=head1 SEE ALSO

=head1 AUTHOR

Michael R. Davis

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2024 by Michael R. Davis

MIT LICENSE

=cut

1;