Ein Skript zum CPAN-Modul-Erstellen (Fragen zu Perl-Modulen)

[thread]20267[/thread]

Ein Skript zum CPAN-Modul-Erstellen

Tags: perl5 Ähnliche Threads

Leser: 9

Articles: hide open all | hide show old branches

+5 replies

hlubenow

2017-04-15 02:18

User since
2009-02-22
875 Artikel
BenutzerIn
[default_avatar]

Hallo,

jedesmal, wenn ich nach Monaten oder Jahren mein CPAN-Modul (bisher eins) updaten will, muß ich mir nochmal klarmachen, wie man aus seiner .pm-Datei (und dem README und den Beispieldateien) ein CPAN-taugliches .tar.gz macht.

Dieses Mal konnte ich mein Shell-Skript dazu endlich soweit anpassen, daß der Prozess weitgehend automatisch ging. Ich poste es mal. Mein Modulname ist dreiteilig, daher dort "Your::Module::Name". Die "rm"-Kommandos für das Saubermachen (Option "clean" und auch sonst) hab' ich erstmal entschärft.
Man muß sich das Skript (es verwendet "module-starter") also schon noch angucken und es anpassen. Dennoch HTH:

Code (sh): (dl )

#!/bin/bash

# makemodule.sh, GNU GPL 3.
# We need
#      Name.pm (The Perl-Module, full name is "Your::Module::Name")
#      README
#      examples (dir)
# in this directory. After the process, there should
# be a .tar.gz in this directory.
# Use "makemodule.sh clean" to clean up.

VERSION="1.00" # Version of Module

modulename="Your::Module::Name"
authorname="Max Mustermann"
authoremail="Max Mustermann@...de"

checkForFile ()
{
    if [ ! -e "$1" ]; then
        echo
        echo "File or directory '$1' not found in this directory. Aborting."
        echo
        exit
    fi
}

basedir=$(pwd)
tarname="Your-Module-Name-$VERSION.tar.gz"
versiondirname="Your-Module-Name-$VERSION"
exampledir="$basedir/Your-Module-Name"
libdir="$exampledir/lib/Your/Module"
versiondir="$basedir/$versiondirname"
tarfile="$basedir/$tarname"

cleanUp ()
{
    if [ -d "$exampledir" ]; then
        # rm -r "$exampledir"
    fi
    if [ -d "$versiondir" ]; then
        # rm -r "$versiondir"
    fi
    if [ -e "$tarfile" ]; then
        # rm "$tarfile"
    fi
}

if [ "$1" = "clean" ]; then
    cleanUp
    exit
fi

checkForFile "Name.pm"
checkForFile "README"
checkForFile "examples"

cleanUp

module-starter --module="$modulename" --author="$authorname" --email="$authoremail"

cp -v Name.pm "$libdir"
cp -rv examples "$exampledir"
cp -v README "$exampledir"

mv "$exampledir" "$versiondir"

tar -czvf "$tarname" "$versiondirname"

hlubenow

2017-04-15 17:05

User since
2009-02-22
875 Artikel
BenutzerIn
[default_avatar]

Und nochmal eine - etwas abstraktere - Version in Perl.
Es sollte reichen, oben im Skript die Daten einzutragen.

@required legt auch die Kopierziele für die Dateien fest.
"module-starter" legt ja ein Verzeichnis mit vielen Unterverzeichnissen an. Insbesondere "lib" mit den Modulunterverzeichnissen. Mein $libdir zielt auf das Unterverzeichnis, in dem die Moduldatei liegen soll.
(In @required sind $libdir und $exampledir als einfache Strings (also ohne das Sigil) angegeben, weil die Variablen zu dem frühen Zeitpunkt noch nicht bekannt sind. Durch die Funktion "getDestination()" werden die Strings dann später durch den Inhalt der Variablen ersetzt.)
Kopiervorgänge sind der Einfachheit halber über system-Calls gemacht (nicht über "File::Copy", usw.). Denn für "module-starter" und "tar -czvf" braucht man danach sowieso system-Calls.
Die "rm"-Kommandos sind erstmal wieder vorsichtshalber entschärft. Ggf. also selbst scharf machen.

Code (perl): (dl )

#!/usr/bin/perl

use warnings;
use strict;

####################################################
# makemodule.pl, (C) 2017. GNU GPL 3.
#
# After the process, there should
# be a .tar.gz in this directory.
#
# Use "makemodule.pl clean" to clean up.
####################################################

use Cwd;

my $version="1.00";

my $modulename = "Your::Module::Name";
my $authorname = "Max Mustermann";
my $authoremail = "Max Mustermann@...de";

my %required = ("Name.pm" => "libdir",
                "README"       => "exampledir",
                "examples"     => "exampledir");

sub getDestination {
    my $deststr = shift;
    my $libdir = shift;
    my $exampledir = shift;
    if ($deststr eq "libdir") {
        return $libdir;
    }
    if ($deststr eq "exampledir") {
        return $exampledir;
    }
}

sub cleanUp {
    my $exampledir = shift;
    my $versiondir = shift;
    my $tarfile = shift;
    if (-d $exampledir ) {
        # system("rm -r $exampledir");
    }
    if (-d $versiondir ) {
        # system("rm -r $versiondir");
    }
    if (-e $tarfile) {
        # system("rm $tarfile");
    }
}

sub checkForExistence {
    my $fname = shift;
    if (! -e $fname) {
        print "\nFile or directory '$fname' not found in this directory. Aborting.\n\n";
        exit;
    }
}

my $basedir = getcwd();
my $i;
my @modulenameparts = split(/\:\:/, $modulename);
my $temp = join("-", @modulenameparts);
my $exampledir = "$basedir/$temp";
my $tarname .= "$temp-$version.tar.gz";
my $versiondirname="$temp-$version";
my $libdir="$exampledir/lib/";
for $i (0 .. $#modulenameparts - 1) {
    $libdir .= $modulenameparts[$i];
    $libdir .= "/";
}
my $versiondir="$basedir/$versiondirname";
my $tarfile="$basedir/$tarname";
my $execstr;

for $i (keys(%required)) {
    $required{$i} = getDestination($required{$i}, $libdir, $exampledir);
}

if ($#ARGV >= 0 && $ARGV[0] eq "clean") {
    cleanUp($exampledir, $versiondir, $tarfile);
    exit;
}

for $i (keys(%required)) {
    checkForExistence($i);
}

cleanUp($exampledir, $versiondir, $tarfile);

$execstr = "module-starter --module=\"";
$execstr .= "$modulename\" --author=\"$authorname\" --email=\"$authoremail\"";
system($execstr);

for $i (keys(%required)) {
    $execstr = "cp -rv ";
    $execstr .= "$basedir/$i ";
    $execstr .= "\"$required{$i}\"";
    system($execstr);
}

system("mv \"$exampledir\" \"$versiondir\"");
system("tar -czvf \"$tarname\" \"$versiondirname\"");

+3 replies
rosti

2017-04-15 18:47

User since
2011-03-19
3472 Artikel
BenutzerIn

Quote
jedesmal, wenn ich nach Monaten oder Jahren mein CPAN-Modul (bisher eins) updaten will, muß ich mir nochmal klarmachen, wie man aus seiner .pm-Datei (und dem README und den Beispieldateien) ein CPAN-taugliches .tar.gz macht.

Machs doch einfach mit h2xs, das nimmt Dir die ganze Arbeit ab.

MfG
- +2 replies
- hlubenow
  
  2017-04-15 22:17
  
  User since
  2009-02-22
  875 Artikel
  BenutzerIn
  
  2017-04-15T16:47:57 rosti
  Machs doch einfach mit h2xs, das nimmt Dir die ganze Arbeit ab.
  
  Ist das nicht für Perl-Module in C?
  - rosti
    
    2017-04-16 05:22
    
    User since
    2011-03-19
    3472 Artikel
    BenutzerIn
    
    2017-04-15T20:17:58 hlubenow
    2017-04-15T16:47:57 rosti
    Machs doch einfach mit h2xs, das nimmt Dir die ganze Arbeit ab.
    
    Ist das nicht für Perl-Module in C?
    
    Nicht nur, h2xs erstellt Dir alle Dateien und Verzeichnisse für jedes Modul was Du erstellen willst. Im Wesentlichen musst Du nur die Haupt.pm-Datei im lib-Verzeichnis beackern, einschließlich pod.
    
    Schließlich führst Du nur noch ein make dist aus und fertig ist das .tar.gz was Du an CPAN schickst. Da steht dann auch die Versionsnummer im Dateinamen.
    
    MfG
    Last edited: 2017-04-16 05:24:15 +0200 (CEST)

View all threads created 2017-04-15 02:18.