WWW::Ohloh::API::SizeFact - statistics about a Project source code


WWW-Ohloh-API documentation  | view source Contained in the WWW-Ohloh-API distribution.

Index


NAME

Top

WWW::Ohloh::API::SizeFact - statistics about a Project source code

SYNOPSIS

Top

    use WWW::Ohloh::API;

    my $ohloh = WWW::Ohloh::API->new( api_key => $my_api_key );
    my @size_facts = $ohloh->get_size_facts( $project_id );

    my $size_fact = shift @size_facts;

    print $size_fact->month;

DESCRIPTION

Top

W::O::A::SizeFact contains the statistics associated with an Ohloh project. To be properly populated, it must be created via the get_size_facts method of a WWW::Ohloh::API object.

METHODS

Top

API Data Accessors

month

Indicate the month covered by this SizeFact.

code

The total net lines of code, excluding comments and blanks, as of the end of this month.

comments

The total net lines of comments as of the end of this month.

blanks

The total net blank lines as of the end of this month.

comment_ratio

The fraction of net lines which are comments as of the end of this month.

man_months

The cumulative total months of effort expended by all contributors on this project, including this month.

stats

 ( $month, $commits, $code, $blanks, $comments, $comment_ratio, $man_month )
    = $size_fact->stats;

Return the facts as an array.

Other Methods

as_xml

Return the size fact as an XML string. Note that this is not the exact xml document as returned by the Ohloh server.

Overloading

Array reference

    @stats = @$size_fact;   # equivalent to 
                            # @stats = $size_fact->stats

Using the object as an array reference can be used as a shortcut for the method stats.

SEE ALSO

Top

*

WWW::Ohloh::API.

*

Ohloh API reference: http://www.ohloh.net/api/getting_started

*

Ohloh size_fact API reference: http://www.ohloh.net/api/reference/size_fact

VERSION

Top

This document describes WWW::Ohloh::API version 0.3.1

BUGS AND LIMITATIONS

Top

WWW::Ohloh::API is very extremely alpha quality. It'll improve, but till then: Caveat emptor.

The as_xml() method returns a re-encoding of the account data, which can differ of the original xml document sent by the Ohloh server.

Please report any bugs or feature requests to bug-www-ohloh-api@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Top

Yanick Champoux <yanick@cpan.org>

LICENCE AND COPYRIGHT

Top


WWW-Ohloh-API documentation  | view source Contained in the WWW-Ohloh-API distribution.