Re: Modules you build yourself = Your Child

OK, so let's get technical and look at your modules.

SF::SF_form_secure

SF::? Is that supposed to mean anything? Or is it just the first two letters of your nick? I mean I do name my modules using my name, but only as long as they are internal only. Modules that are to be uploaded to CPAN should have meaningful names! At least the first part of the name should definitely be meaningful and aligned with others in the category.
The docs are crap. Not only do they contain a lot of typos and missing letters, they are confusing at best. "Minutes code will expire in 1 to 99"?
The API is crap. You require "SF::SF_form_secure" and then call SF_form_secure::x_secure()? Where did the SF:: go? And why the heck do you only have one function with the "action" you want to do specified by an integer passed as the first (heavily underdocumented) parameter? Actions 4 and 5 mentioned in "DESCRIPTION" and Changes are not documented at all.
README is NOT supposed to be a plain text copy of the docs.
Tests only test the undocumented actions 4 and 5 and the tests are very very shallow. Almost nonexistent. And the code ... even though there is just some 20 or so lines is not even indented consistently.
The module deletes some %ENV variables. Without this being documented anywhere. The variables are none of its fscking business! The fact that you read somewhere that these are dangerous is nice, but irrelevant.
There are typos even in the short list of error messages. 'Referer is to long.'? "Referers do not Match."? 'Code Has expired.'? And you keep them in a hash with keys a,b,c,d,e,f,...? if (this or that) { return $x_error{f}}? Beg your pardon?
$act eq 1? You have heard about the difference between eg and ==, right?
if (!$link) { You do know 0 and "0" is false, right?
Code indentation is totally absolutely inconsistent.
Function and variable names are crap. Let's see, what does x_regex() do?
```
sub x_regex {
my $regex = shift;
$regex =~ s/^(.*?)\?(.*?)$/$2/;
return $regex;
}
[download]
```
Waitasec? It finds the first question mark and removes everything before plus that question mark? The variable is called $regex and you pass the function the HTTP_REFERER? What?!?

So all in all, thank you for making me waste my time on your crap. I would not touch that module no matter what. The AUBBC looks slightly better at the first look, I ain't gonna waste any more time.

Jenda
Enoch was right!
Enjoy the last years of Rome.

Comment on Re: Modules you build yourself = Your Child Select or Download Code

Replies are listed 'Best First'.
Re^2: Modules you build yourself = Your Child by CountZero (Bishop) on Sep 19, 2010 at 07:39 UTC
And let's not forget such beauties as found in the "Notes": To Provide a uniqe link others can not use Format the provided key something like this $key = $key . $Member_Name; and/or use the IP encoding the new key format and/or ip encoding will need to be used for all actions I had to read that three times to start understanding what it was all about. Making it easy on your users is of course oh so uncool. CountZero A program should be light and agile, its subroutines connected like a string of pearls. The spirit and intent of the program should be retained throughout. There should be neither too little or too much, neither needless loops nor useless variables, neither lack of structure nor overwhelming rigidity." - The Tao of Programming, 4.1 - Geoffrey James	[reply]
Re^2: Modules you build yourself = Your Child by tinita (Parson) on Sep 19, 2010 at 10:50 UTC
The AUBBC looks slightly better at the first look, I ain't gonna waste any more time. I have now tested it to include it in my Parse::BBCode compare.html. It is fast (almost as fast as HTML::BBReverse), but unfortunately like the latter it creates invalid HTML with unbalanced tags: `perl -Ilib -wle' use AUBBC; my $p = AUBBC->new; my $bbcode = "[i] italic [b]bold[/b] end"; my $html = $p->do_all_ubbc($bbcode); print $html; ' <i> italic <b>bold</b> end` [download] So it's basically unusable in a web forum because it can break the output HTML. I didn't find something about unbalanced tags in the docs. It allows block elements like div inside of elements like i or b. These are the reasons why it is so fast because it replaces start and end tags independently. The module does not have any tests. Source code is IMHO not very readable. No, too small or inconsistent indenting, very long lines. But of course, source code is just a matter of taste...	[reply] [d/l]
A reply falls below the community's threshold of quality. You may see it by logging in.
A reply falls below the community's threshold of quality. You may see it by logging in.