Free subclass software for linux

Class::Spiffy is a Spiffy Framework with No Source Filtering.

SYNOPSIS

package Keen;
use strict;
use warnings;
use Class::Spiffy -base;
field mirth;
const mood => :-);

sub happy {
my $self = shift;
if ($self->mood eq :-() {
$self->mirth(-1);
print "Cheer up!";
}
super;
}

1;

"Class::Spiffy" is a framework and methodology for doing object oriented (OO) programming in Perl. Class::Spiffy combines the best parts of Exporter.pm, base.pm, mixin.pm and SUPER.pm into one magic foundation class. It attempts to fix all the nits and warts of traditional Perl OO, in a clean, straightforward and (perhaps someday) standard way.

Class::Spiffy borrows ideas from other OO languages like Python, Ruby, Java and Perl 6. It also adds a few tricks of its own.

If you take a look on CPAN, there are a ton of OO related modules. When starting a new project, you need to pick the set of modules that makes most sense, and then you need to use those modules in each of your classes. Class::Spiffy, on the other hand, has everything youll probably need in one module, and you only need to use it once in one of your classes. If you make Class::Spiffy the base class of the basest class in your project, Class::Spiffy will automatically pass all of its magic to all of your subclasses. You may eventually forget that youre even using it!

The most striking difference between Class::Spiffy and other Perl object oriented base classes, is that it has the ability to export things. If you create a subclass of Class::Spiffy, all the things that Class::Spiffy exports will automatically be exported by your subclass, in addition to any more things that you want to export. And if someone creates a subclass of your subclass, all of those things will be exported automatically, and so on. Think of it as "Inherited Exportation", and it uses the familiar Exporter.pm specification syntax.
To use Class::Spiffy or any subclass of Class::Spiffy as a base class of your class, you specify the -base argument to the use command.

use MySpiffyBaseModule -base;

You can also use the traditional use base MySpiffyBaseModule; syntax and everything will work exactly the same. The only caveat is that Class::Spiffy must already be loaded. Thats because Class::Spiffy rewires base.pm on the fly to do all the Spiffy magics.

Class::Spiffy has support for Ruby-like mixins with Perl6-like roles. Just like base you can use either of the following invocations:

use mixin MySpiffyBaseModule;
use MySpiffyBaseModule -mixin;

The second version will only work if the class being mixed in is a subclass of Class::Spiffy. The first version will work in all cases, as long as Class::Spiffy has already been loaded.

To limit the methods that get mixed in, use roles. (Hint: they work just like an Exporter list):

use MySpiffyBaseModule -mixin => qw(:basics x y !foo);

A useful feature of Class::Spiffy is that it exports two functions: field and const that can be used to declare the attributes of your class, and automatically generate accessor methods for them. The only difference between the two functions is that const attributes can not be modified; thus the accessor is much faster.

One interesting aspect of OO programming is when a method calls the same method from a parent class. This is generally known as calling a super method. Perls facility for doing this is butt ugly:

sub cleanup {
my $self = shift;
$self->scrub;
$self->SUPER::cleanup(@_);
}

Class::Spiffy makes it, er, super easy to call super methods. You just use the super function. You dont need to pass it any arguments because it automatically passes them on for you. Heres the same function with Class::Spiffy:

sub cleanup {
my $self = shift;
$self->scrub;
super;
}

Class::Spiffy has a special method for parsing arguments called parse_arguments, that it also uses for parsing its own arguments. You declare which arguments are boolean (singletons) and which ones are paired, with two special methods called boolean_arguments and paired_arguments. Parse arguments pulls out the booleans and pairs and returns them in an anonymous hash, followed by a list of the unmatched arguments.

Finally, Class::Spiffy can export a few debugging functions WWW, XXX, YYY and ZZZ. Each of them produces a YAML dump of its arguments. WWW warns the output, XXX dies with the output, YYY prints the output, and ZZZ confesses the output. If YAML doesnt suit your needs, you can switch all the dumps to Data::Dumper format with the - dumper option.

Basset::Object is a Perl module used to create objects.

This is my ultimate object creation toolset to date. It has roots in Mail::Bulkmail, Text::Flowchart, and the unreleased abstract object constructors that Ive tooled around with in the past.

If you want an object to be compatible with anything else Ive written, then subclass it off of here.

Of course, you dont have to use this to create subclasses, but youll run the risk of making something with an inconsistent interface vs. the rest of the system. Thatll confuse people and make them unhappy. So I recommend subclassing off of here to be consistent. Of course, you may not like these objects, but they do work well and are consistent. Consistency is very important in interface design, IMHO.

HTML::Seamstress is a HTML::Tree subclass for HTML templating via tree rewriting.

SYNOPSIS

HTML::Seamstress provides "fourth generation" dynamic HTML generation (templating).
In the beginning we had...

First generation dynamic HTML production

First generation dynamic HTML production used server-side includes:

< p >Todays date is < !--#echo var="DATE_LOCAL" -- > < /p >

Second generation dynamic HTML production

The next phase of HTML generation saw embedded HTML snippets in Perl code. For example:

sub header {
my $title = shift;
print $title< /title >
< /head >
EOHEADER
}

Basset::DB::Table is used to define database tables, ways to load that data into memory and build queries based upon the table information.

SYNOPSIS

For example,

my $table = Basset::DB::Table->new(
name => user,
primary_column => id,
autogenerated => 1,
definition => {
id => SQL_INTEGER,
username => SQL_VARCHAR,
password => SQL_VARCHAR,
name => SQL_VARCHAR
}
);
print $table->insert_query, "n"; print $table->update_query, "n"; print $table->delete_query, "n";

Basset::DB::Table provides an abstract and consistent location for defining database tables, building queries based upon them, and so on. It is rarely (if ever) used directly in code, but is used extensively in packages which subclass from Basset::Object::Persistent.

Any queries returned by the query methods are simply strings that must be prepared by DBI in order bo be used.

Class::DBI::Template::Stash is a Perl module with Template::Stash subclass for Class::DBI::Template.

SYNOPSIS

package Music::DBI;
use base Class::DBI;
use Class::DBI::Template;

There is nothing you need to do for this module, it is setup for you when you use Class::DBI::Template. It provides a subclass of Template::Stash that overrides its get() method. The new method knows how to find the Class::DBI object that we are rendering, and how to get information out of it for use by the Template module for rendering your template.

Netscape::Bookmarks is a Perl module to parse, manipulate, or create Netscape Bookmarks files.

SYNOPSIS

use Netscape::Bookmarks;

# parse an existing file
my $bookmarks = Netscape::Bookmarks->new( $bookmarks_file );

# -- OR --
# start a new Bookmarks structure
my $bookmarks = Netscape::Bookmarks->new;

# print a Netscape compatible file
print $bookmarks->as_string;

[ Note: I wrote this a long time ago. Although this should still work with "Netscape" browsers, Mozilla browsers do the same thing. When the docs say "Netscape", I mean either branch of browsers. ]

The Netscape bookmarks file has several basic components:

title
folders (henceforth called categories)
links
aliases
separators

On disk, Netscape browsers store this information in HTML. In the browser, it is displayed under the "Bookmarks" menu. The data can be manipulated through the browser interface.

This module allows one to manipulate the bookmarks file programmatically. One can parse an existing bookmarks file, manipulate the information, and write it as a bookmarks file again. Furthermore, one can skip the parsing step to create a new bookmarks file and write it in the proper format to be used by a Netscape browser.

The Bookmarks module simply parses the bookmarks file passed to it as the only argument to the constructor:

my $bookmarks = Netscape::Bookmarks->new( $bookmarks_file );

The returned object is a Netscape::Bookmarks::Category object, since the bookmark file is simply a collection of categories that contain any of the components listed above. The top level (i.e. root) category is treated specially and defines the title of the bookmarks file.

HTML::Parser is used behind the scenes to build the data structure (a simple list of lists (of lists ...)). Netscape::Bookmarks::Category, Netscape::Bookmarks::Link, Netscape::Bookmarks::Alias, or Netscape::Bookmarks::Separator objects can be stored in a Netscape::Bookmarks::Category object. Netscape::Bookmarks::Alias objects are treated as references to Netscape::Bookmarks::Link objects, so changes to one affect the other.

Methods for manipulating this object are in the Netscape::Bookmarks::Category module. Methods for dealing with the objects contained in a Netscape::Bookmarks::Category object are in their appropriate modules.

new( [filename] )

The constructor takes a filename as its single (optional) argument. If you do not give new an argument, an empty Netscape::Bookmarks::Category object is returned so that you can start to build up your new Bookmarks file. If the file that you name does not exist, undef is returned in scalar context and an empty list is returned in list context. If the file does exist it is parsed with HTML::Parser with the internal parser subclass defined in the same package as new. If the parsing finishes without error a Netscape::Bookmarks::Category object is returned.

parse_string

Method for HTML::Parser subclass method

start

Method for HTML::Parser subclass method

text

Method for HTML::Parser subclass method

end

Method for HTML::Parser subclass method

my_init

Method for HTML::Parser subclass method

Class::MakeMethods::Template package contains extensible code templates.

SYNOPSIS

package MyObject;
use Class::MakeMethods::Template::Hash (
new => new,
string => foo,
number => bar,
);

my $obj = MyObject->new( foo => "Foozle", bar => 23 );
print $obj->foo();
$obj->bar(42);

MOTIVATION

If you compare the source code of some of the closure-generating methods provided by other subclasses of Class::MakeMethods, such as the hash accessors provided by the various Standard::* subclasses, you will notice a fair amount of duplication. This module provides a way of assembling common pieces of code to facilitate support the maintenance of much larger libraries of generated methods.

This module extends the Class::MakeMethods framework by providing an abstract superclass for extensible code-templating method generators.
Common types of methods are generalized into template definitions. For example, Template::Generics new provides a template for methods that create object instances, while Template::Generics scalar is a template for methods that allow you to get and set individual scalar values.

Thse definitions are then re-used and modified by various template subclasses. For example, the Template::Hash subclass supports blessed-hash objects, while the Template::Global subclass supports shared data; each of them includes an appropriate version of the scalar accessor template for those object types.

Each template defines one or more behaviors, individual methods which can be installed in a calling package, and interfaces, which select from those behaviours and indicate the names to install the methods under.

Each individual meta-method defined by a calling package requires a method name, and may optionally include other key-value parameters, which can control the operation of some meta-methods.