davorg-cpan / symbol-approx-sub Goto Github PK

View Code? Open in Web Editor NEW

2.0 3.0 5.0 99 KB

Perl library to call subroutines using approximate names

Home Page: http://search.cpan.org/dist/Symbol-Approx-Sub

License: Other

Perl 100.00%

perl symbol-table cpan joke hacktoberfest

symbol-approx-sub's Introduction

Symbol::Approx::Sub

What is Symbol::Approx::Sub?

Symbol::Approx::Sub is a Perl module which allows you to call subroutines using approximate names.

Of course, why you might want to do that is a completely different question. You almost certainly don't want to do it in production code as it will make your program almost completely unmaintainable.

I only wrote this module to test my understanding of typeglobs and AUTOLOAD. I really don't expect it to have any sensible uses at all (but if you find one, I'd be interested in knowing what it is).

How Do I Install It?

Symbol::Approx::Sub uses the standard Perl module architecture and can therefore by installed using the standard Perl method which, in brief, goes something like this:

   gzip -cd Symbol-Approx-Sub-X.XX.tar.gz | tar xvf -
   cd Symbol-Approx-Sub-X.XX
   perl Makefile.PL
   make
   make test
   make install

Where X.XX is the version number of the module which you are installing.

If this doesn't work for you then creating a directory called Symbol/Approx somewhere in your Perl library path (@INC) and copying the Sub.pm file into this directory should also do the trick.

Prerequisites

As of version 1.03, Symbol::Approx::Sub uses Devel::Symdump to do all of the clever glob-walking stuff, so you'll need to get that from CPAN and install it before installing Symbol::Approx::Sub.

Where is the Documentation?

All of the documentation is currently in POD format in the Approx.pm file. If you install the module using the standard method you should be able to read it by typing

   perldoc Symbol::Approx::Sub

at a command prompt.

Latest Version

The latest version of this module will always be available from CPAN.

Copyright

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

Anything Else?

If you have any further questions, please contact the author.

Authors

Dave Cross

Email: [email protected]

symbol-approx-sub's People

Contributors

Stargazers

Watchers

Forkers

gaurav1911 harikv tvroom manwar

symbol-approx-sub's Issues

Better Tests

The tests are very much of the time they were written (or, perhaps, of my level of knowledge at the time they were written). There's a lot of stuff like ok(&sub eq 'string') which sohld be changed to is(sub(), 'string').

Also we should get rid of the explicit plans and use done_testing().

Improve test coverage

Missing tests:

Invalid matcher
Undef matcher
Coderef chooser
Invalid chooser
Default chooser

Replace README.xml with README.md (or README.pod)

README.xml was always a stupid idea. What's better - Markdown or Pod?

Bug in AUTOLOAD

The code in the generated AUTOLOAD has an obvious bug. Line 385 is currently

@match_ind = @subs[1 .. $#subs];

I think that should be.

@match_ind = 1 .. $#subs;

But I'd like to see a failing test before fixing it.

Get rid of ampersands on subroutine calls

I was young(er) and stupid. Lots of the subroutine calls in this module are of the form &sub where they should be sub(). This should be fixed.

Better module loading

Currently we have our own code for loading plugins. Let's look at Module::Load or something like that instead.

(Bonus points for considering something like Module::Pluggable as well.)

Better $@ checks

A few tests just check $@ for truth. They should probably be more explicit about what they are testing for - otherwise tests might pass because things fail for the wrong reason.

Die with real Exceptions

We croak() in a few places - passing a string to croak(). It might be nicer to croak with real exception objects (something based on Exception::Class perhaps).

Test::Excpetion

Would be nice to use Text::Exception in the tests that throw exceptions.

Missing tests

A couple more tests will get us to 100% coverage.

matcher => undef
chooser => sub { ... } (or, alternatively, chooser => \&some_chooser_sub)