Php|tek '12 It's More Than Just Style

It’s More Than Just Stylephp|Tek ’12May 23, 2012

LB Denker@elblinkin an Etsy Admin

First Things That Come To Mind

What Difference Does Whitespace Make?

With Modern Monitors,Line Length Does Not Matter.

It’s Just Style!

The Argument for Style

Requires Less Human Cognitive Effort to Work with Code

Sniffs That Save You

DuplicateClass NameYou can not have two classes or interfaceswith the same name

DuplicateFunctionArgumentYou can not have two arguments in afunction with the same name

Static $thisUsage$this requires an instance

Non-ExecutableCodeCode after a return or exit will not beexecuted

ValidDefault ValueAll required arguments should precedeall optional arguments

Closing TagAvoid sending headers early

Minimal ruleset.xmlRun The Sniffs That Save You

PHPCSruleset.xmlGeneratorhttp://edorian.github.com/php-coding-standard-generator/#phpcs

LeadingWhitespaceCustom Sniff to Avoid sending headersearly

Full ReportRunning phpcs

Summary ReportRunning phpcs

Source ReportRunning phpcs

XML ReportRunning phpcs

CSV ReportRunning phpcs

Emacs ReportRunning phpcs

Blame Report(git|svn)Running phpcs

Checkstyle ReportRunning phpcs

Checkstyle Plugin — JenkinsRunning phpcs in Jenkins

PHP Templatefor Jenkinshttp://jenkins-php.org/

Step Back for a Minute

Don’t Forget Lint php -l

Steps To Clean Code✤ Start with Syntax✤ Move to Style✤ Then Design... maybe

Standards to Drive Conventions

Etsy Custom Sniffs✤ Goto ✤ Integration Test ✤ Disallow goto ✤ Ensure that All Tests in a @group are Marked @medium✤ SvnTag or Higher ✤ Disallow SVN Tags ie. $Date$ or $Revision$ ✤ Test Group ✤ Ensure that All Tests are✤ UnnecessaryComment Marked in a @group that ✤ Disallow phpDoc Tags that Exists Repeat Info in Source Control ie. @author

Standards to Move You Forward

Sniff OutBackwardsIncompatibilityCoding Standards to Help You Upgrade

Upgrade to PHP 5.3✤ Deprecated Functions✤ Deprecated ini Directives✤ Deprecated new Reference Return✤ Forbidden Names, Reserved Keywords✤ Non-Static Magic Methods, Ensure✤ Removed Extensions https://github.com/wimg/PHP53Compat_CodeSniffer

Compatibility Through PHP 5.4✤ Default Timezone Required✤ Deprecated Functions✤ Deprecated ini Directives✤ Deprecated new Reference Return✤ Forbidden continue and break Variable Arguments✤ Forbidden Names, Reserved Keywords✤ Non-Static Magic Methods, Ensure✤ Removed Extensions✤ Removed Hash Algorithms https://github.com/wimg/PHPCompatibility

Standards to Save You Time

PHPUnit Coding Standard✤ Ensures Tests are Executable✤ Reduces Superﬂuous Code✤ Increases Readability✤ Decreases Debug Time

Minimal phpunit-ruleset.xmlRun The Sniffs That Save You

Code Sniffer Limitations

How Code Sniffer Basically Works✤ Gets array of Tokens from token_get_all()✤ Creates Abstract Syntax Tree (AST)✤ Analyzes Each File Individually, Sequentially✤ Collects All Parsed, Analyzed Files in an array for Multi-File Sniffs

CSRunnerOnly analyze recent changeshttps://github.com/elblinkin/CSRunner

HpHp as a Static Analyzer✤ Pros ✤ Cons ✤ Very Fast Static Analysis ✤ Not Easy to Install ✤ Call Graph Analysis ✤ Takes a Decent Amount of Conﬁguration ✤ HpHp Analyzer Creates Checkstyle Reports

Beyond Code Sniffer

Enforcing a Standard✤ Draft a Coding Standard✤ Experiment with Various Sniffs, Tweak Sniffs✤ Discover Actual Coding Tendencies✤ Decide on Changes to Coding Standard Based on Previous Steps✤ Strategize on How to Get to GREEN

PHP Community Standard✤ Checkout PSR-1✤ Checkout PSR-2✤ Just-in: PHP Coding Standards Fixer ✤ http://cs.sensiolabs.org/

Moving Towards Enforcement✤ Assign Violations via blame✤ Create a Staging Set that Can Be Ignored in an Emergency✤ Fix-It Competition or Party

PHPMess Detectorhttp://phpmd.org/

✤ http://phpadvent.org/2011/more-than-just-style-by- laura-beth-denker✤ http://codeascraft.com✤ http://www.slideshare.net/Etsy✤ http://elblinkin.info✤ http://www.lornajane.net/posts/2009/php-codesniffer-tutorial-on-techportal

Php|tek '12 It's More Than Just Style

by LB Denker on May 23, 2012

Accessibility

Categories

Upload Details

Usage Rights

2 Embeds 15

Statistics

Php|tek ’12 It’s More Than Just Style Presentation Transcript

http://lanyrd.com	10
http://us-w1.rockmelt.com	5