Raku Land

Ecosystem::Archive

zef:lizmat

Actions Status

NAME

Ecosystem::Archive - Interface to the Raku Ecosystem Archive

SYNOPSIS

use Ecosystem::Archive;

my $ea = Ecosystem::Archive.new(
  shelves     => 'archive',
  jsons       => 'meta',
  http-client => default-http-client
);

say "Archive has $ea.meta.elems() identities:";
.say for $ea.meta.keys.sort;

DESCRIPTION

Ecosystem::Archive provides the basic logic to the Raku Programming Language Ecosystem Archive, a place where (almost) every distribution ever available in the Raku Ecosystem, can be obtained even after it has been removed (specifically in the case of the old ecosystem master list and the distributions kept on CPAN).

ARGUMENTS

The name (or an IO object) of a directory in which to place distributions. This is usually a symlink to the "archive" directory of the actual Raku Ecosystem Archive repository. The default is 'archive', aka the 'archive' subdirectory from the current directory.

The name (or an IO object) of a directory in which to store META6.json files as downloaded. This is usually a symlink to the "meta" directory of the actual Raku Ecosystem Archive repository. The default is 'meta', aka the 'meta' subdirectory from the current directory.

The Cro::HTTP::Client object to do downloads with. Defaults to a Cro::HTTP::Client object that advertises this module as its User-Agent.

The number of CPU cores that may be used for parallel processing. Defaults to the half number of Kernel.cpu-cores.

The number of objects to be processed in parallel per batch. Defaults to 64.

METHODS

batch

say "Processing with batches of $ea.batch() objects in parallel";

The number of objects per batch that will be used in parallel processing.

clear-notes

my @cleared = $ea.clear-notes;
say "All notes have been cleared";

Returns the notes of the object as a List, and removes them from the object.

degree

say "Using $ea.degree() CPUs";

The number of CPU cores that will be used in parallel processing.

distro-io

my $identity = $ea.find-identities('eigenstates').head;
say $ea.distro-io($identity);

Returns an IO object for the given identity, or Nil if it can not be found.

distros

say "Archive has $ea.distros.elems() different distributions, they are:";
.say for $ea.distros.keys.sort;

Returns a Map keyed by distribution name, with a list of identities that are available of this distribution, as value.

find-identities

my @identities = $ea.find-identities('eigenstates', :ver<0.0.3*>);
say "@identities[0] is the most recent";

Find the identities that supply the given module name (as a positional parameter) and possible refinement with named parameters for :ver, :auth and :api. Note that the :ver specification can contain + or * to indicate a range rather than a single version.

The identities will be returned sorted by highest version first. So if you're interested in only the most recent version, then just select the first element returned.

http-client

say "Information fetched as '$ea.http-client.user-agent()'";

The Cro::HTTP::Client object that is used for downloading information from the Internet.

investigate-repo

my @found = $ea.investigate-repo($url, "lizmat");

Performs a git clone on the given URL, scans the repo for changes in the META6.json file that would change the version, and downloads and saves a tar-file of the repository (and the associated META information in git-meta) at that state of the repository.

The second positional parameter indicates the default auth value to be applied to any JSON information, if no auth value is found or it is invalid.

Only Github and Gitlab URLs are currently supported.

Returns a list of Pairs of the distributions that were added, with the identity as the key, and the META information hash as the value.

Updates the .meta and .modules meta-information in a thread-safe manner.

jsons

indir $ea.jsons, {
    my $jsons = (shell 'ls */*', :out).out.lines.elems;
    say "$jsons different distributions";
}

The IO object of the directory in which the JSON meta files are being stored. For instance the IRC::Client distribution:

meta
  |- ...
  |- I
     |- ...
     |- IRC::Client
         |- IRC::Client:ver<1.001001>:auth<github:zoffixznet>.json
         |- IRC::Client:ver<1.002001>:auth<github:zoffixznet>.json
         |- ...
         |- IRC::Client:ver<3.007010>:auth<github:zoffixznet>.json
         |- IRC::Client:ver<3.007011>:auth<cpan:ELIZABETH>.json
         |- IRC::Client:ver<3.009990>:auth<cpan:ELIZABETH>.json
     |- ...
  |- ...

meta

say "Archive has $ea.meta.elems() identities, they are:";
.say for $ea.meta.keys.sort;

Returns a hash of all of the META information of all distributions, keyed by identity (for example "Module::Name:ver<0.1>:authfoo:bar:api<1>"). The value is a hash obtained from the distribution's meta data.

meta-as-json

say $ea.meta-as-json;  # at least 3MB of text

Returns the JSON of all the currently known meta-information. The JSON is ordered by identity in the top level array.

modules

say "Archive has $ea.modules.elems() different modules, they are:";
.say for $ea.modules.keys.sort;

Returns a Map keyed by module name, with a list of identities that provide that module name, as value.

note

$ea.note("something's wrong");

Add a note to the notes of the object.

notes

say "Found $ea.notes.elems() notes:";
.say for $ea.notes;

Returns the notes of the object as a List.

shelves

indir $ea.shelves, {
    my $distros = (shell 'ls */*', :out).out.lines.elems;
    say "$distros different distributions in archive";
}

The IO object of the directory where distributions are being stored in a subdirectory by the name of the module in the distribution. For instance the silently distribution:

archive
 |- ...
 |- S
    |- ...
    |- silently
        |- silently:ver<0.0.1>:auth<cpan:ELIZABETH>.tar.gz
        |- silently:ver<0.0.2>:auth<cpan:ELIZABETH>.tar.gz
        |- silently:ver<0.0.3>:auth<cpan:ELIZABETH>.tar.gz
        |- silently:ver<0.0.4>:auth<zef:lizmat>.tar.gz
    |- ...
 |- ...

Note that a subdirectory will contain all distributions of the name, regardless of version, authority or API value.

update

my %updated = $ea.update;

Updates all the meta-information and downloads any new distributions. Returns a hash with the identities and the meta info of any distributions that were not seen before. Also updates the .meta and .modules information in a thread-safe manner.

EXPORTED SUBROUTINES

identity2module

say identity2module("zef:ver<0.1.1>:auth<zef:ugexe>");  # zef

Returns the module of a given identity.

AUTHOR

Elizabeth Mattijsen liz@raku.rocks

Source can be located at: https://github.com/lizmat/Ecosystem-Archive. Comments and Pull Requests are welcome.

COPYRIGHT AND LICENSE

Copyright 2021 Elizabeth Mattijsen

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.