File Coverage

blib/lib/CryptoCurrency/Catalog.pm

Criterion	Covered	Total	%
statement	42	42	100.0
branch	7	8	87.5
condition			n/a
subroutine	11	11	100.0
pod	8	8	100.0
total	68	69	98.5

package CryptoCurrency::Catalog;

our $DATE = '2018-04-03'; # DATE
our $VERSION = '20180403'; # VERSION

use 5.010001;
use strict;
use warnings;

my %by_code;
my %by_name_lc;
my %by_safename;
my @all_data;

sub new {
    my $class = shift;

    unless (keys %by_code) {
        while (defined(my $line = )) {
            chomp $line;
            my @ff = split /\t/, $line;
            my ($code, $name, $safename) = @ff;
            $by_code{$code}         = \@ff;
            $by_name_lc{lc $name}   = \@ff;
            $by_safename{$safename} = \@ff;
            push @all_data, \@ff;
        }
    }

    bless {}, $class;
}

sub by_code {
    my ($self, $code) = @_;
    $code = uc($code);
    die "Can't find cryptocurrency with code '$code'"
        unless $by_code{$code};
    return {
        code=>$code,
        name=>$by_code{$code}[1],
        safename=>$by_code{$code}[2],
    };
}

sub by_ticker { by_code(@_) }

sub by_name {
    my ($self, $name) = @_;
    die "Can't find cryptocurrency with name '$name'"
        unless my $rec = $by_name_lc{lc $name};
    return {
        name=>$rec->[1],
        code=>$rec->[0],
        safename=>$rec->[2],
    };
}

sub by_safename {
    my ($self, $safename) = @_;
    $safename = lc($safename);
    die "Can't find cryptocurrency with safename '$safename'"
        unless $by_safename{$safename};
    return {
        safename=>$safename,
        code=>$by_safename{$safename}[0],
        name=>$by_safename{$safename}[1],
    };
}

sub by_slug { by_safename(@_) }

sub all_codes {
    my $self = shift;
    my @res;
    for (@all_data) {
        push @res, $_->[0];
    }
    @res;
}

sub all_data {
    my $self = shift;
    my @res;
    for (@all_data) {
        push @res, {code=>$_->[0], name=>$_->[1], safename=>$_->[2]};
    }
    @res;
}

1;
# ABSTRACT: Catalog of cryptocurrencies

=pod

=encoding UTF-8

=head1 NAME

CryptoCurrency::Catalog - Catalog of cryptocurrencies

=head1 VERSION

This document describes version 20180403 of CryptoCurrency::Catalog (from Perl distribution CryptoCurrency-Catalog), released on 2018-04-03.

=head1 SYNOPSIS

 use CryptoCurrency::Catalog;

 my $cat = CryptoCurrency::Catalog->new;

 my $record = $cat->by_code("ETH");          # => { code=>"ETH", name=>"Ethereum", safename=>"ethereum" }
 my $record = $cat->by_ticker("eth");        # alias for by_code(), lowercase also works
 my $record = $cat->by_name("Ethereum");     # note: case-sensitive
 my $record = $cat->by_safename("ethereum");
 my $record = $cat->by_slug("Ethereum");     # alias for by_safename(), mixed case also works

 my @codes = $cat->all_codes(); # => ("BTC", "ETH", ...)

 my @data = $cat->all_data; # => ({code=>"BTC", name=>"Bitcoin", safename=>"bitcoin"}, {...}, ...)

=head1 DESCRIPTION

This class attempts to provide a list/catalog of cryptocurrencies. The main
source for this catalog is the Cryptocurrency Market Capitalizations website
(L, or CMC for short).

CMC does not provide unique codes nor unique names, only unique "safenames"
(slugs). Whenever there is a clash, this catalog modifies the clashing code
and/or unique name to make code and name to be unique again (usually the
coin/token with the smaller market cap "loses" the name).

There is no guarantee that the code/name/safename of old/unlisted coins or
tokens will not be reused.

=head1 METHODS

=head2 new

=head2 by_code

=head2 by_ticker

Alias for L.

=head2 by_name

=head2 by_safename

=head2 by_slug

Alias for L.

=head2 all_codes

=head2 all_data

=head1 HOMEPAGE

Please visit the project's homepage at L.

=head1 SOURCE

Source repository is at L.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L

When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.

=head1 SEE ALSO

L

=head1 AUTHOR

perlancar

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by [e-mail].

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut

__DATA__