Your code sucks,   let’s !x it!   Object Calisthenics and Code readability            Rafael Dohms
Rafael Dohms                                                    photo credit: Eli WhitePHP Evangelist, Speaker andcontribu...
What’s the talk about?• Why does my code suck?• How can we fix it?
Is it Maintainable?   Is it Readable?          Why does my          code suck?  Is it Reusable?     Is it Testable?
<?php                                                 Does it look like this?$list=mysql_connect("******","*******","*****...
How do we fix it?
cal·is·then·ics - noun - /ˌkaləsˈTHeniks/     Calisthenics are a form of dynamic      exercise consisting of a variety of ...
“So here’s an exercise that can help you to internalize      principles of good object-oriented design and actually       ...
“You need to write code that minimizes the time it wouldObject Calisthenics           take someone else to understand it—e...
Disclaimer:“These are guidelines, not rules”
OC #1“Only one indentation  level per method”
function validateProducts($products) {        // Check to make sure that our valid fields are in there        $requiredFie...
function validateProducts($products) {      // Check to make sure that our valid fields are in there      $requiredFields ...
function validateProducts($storeData) {    $requiredFields = array(price,name,description,type); cheating!                ...
List is more readable the pluralfunction validateProductList($products) iteration                                   faster...
Key Benefits• Cohesiveness• Methods does only one thing• Increases re-use
OC #2“Do not use the ‘else’      keyword”
public function createPost($request){    $entity = new Post();    $form = new MyForm($entity);    $form->bind($request);  ...
public function createPost($request){    $entity = new Post();    $form = new MyForm($entity);    $form->bind($request);  ...
public function createPost($request){    $entity = new Post();    $form = new MyForm($entity);    $form->bind($request);  ...
Separate code                                                              into blocks.public function createPost($request...
Key Benefits• Helps avoid code duplication• Makes code clearer (single path)
Ad                     ap       OC #3                      te                          d “Wrap all primitivetypes and stri...
class UIComponent{//...    public function repaint($animate = true){            //...    }}//...$component->repaint(false)...
class UIComponent{    //...    public function repaint( Animate $animate ){            //...    }}class Animate           ...
Key Benefits• Type Hinting• Encapsulation of operations
Ad                      ap                       te                          d        OC #4“Only one -> per line, if not g...
Source: CodeIgniter                         properties are harder to mock$this->base_url = $this->CI->config->site_url()./...
Source: Zend Framework App    fluent interface$filterChain->addFilter(new Zend_Filter_Alpha())            ->addFilter(new Z...
Key Benefits• Readability• Easier Mocking• Easier to Debug• Demeter’s Law
OC #5“Do not Abbreviate”
?if($sx >= $sy) {                      ?    if ($sx > $strSysMatImgW) {        $ny = $strSysMatImgW * $sy / $sx;        $n...
Why?Its repeated many times,       and i’m lazy.                  Underlying Problem!  You need to transfer those operatio...
Why?                          more then one                          responsibility?function processResponseHeadersAndDefi...
get from where?                                  Use clearer names:function getPage($data) { ... }   fetchPage()          ...
Key Benefits• Clearer communication• Indicates underlying problems
Ad                 ap                     te                     d      OC #6“Keep your classes     small”
Increased to include     docblocks          15-20 lines per method  100 lines per class15 classes per package             ...
Key Benefits• Single Responsibility• Objective methods• Slimmer namespaces• Less clunky folders
Ad                    ap         OC #7                      te                          d “Limit the number ofinstance var...
class MyRegistrationService                     {                         protected   $userService;                       ...
Key Benefits• Shorter dependency list• Easier Mocking for unit test
OC #8“Use first class  collections”
Doctrine:      ArrayCollection$collection->getIterator();$collection->filter(...);$collection->append(...);$collection->ma...
Key Benefits• Implements collection operations• Uses SPL interfaces
Dr                   op                    pe                        d        OC #9“Do not use accessors   (getter/setter)”
/**  * THIS CLASS WAS GENERATED BY THE DOCTRINE ORM. DO NOT EDIT THIS FILE.  */class DoctrineTestsModelsCMSCmsUserProxy   ...
Key Benefits• Injector operations• Encapsulation of transformations
Cr                  ea                   te                      d!   OC #10 (bonus!)“Document your code!”
really?//check to see if the section above set the $overall_pref variable to voidif ($overall_pref == void)// implode the ...
$priority = isset($event[priority]) ? $event[priority] : 0;                            Add a simple comment:if   (!isset($...
Do a mind dump,                                                       then clean it up.      A note on cost of       runni...
Key Benefits• Automatic API documentation• Transmission of “line of thought”• Avoids confusion
Recap•   #1 - Only one indentation level per method.•   #2 - Do not use the ‘else’ keyword.•   #3 - Wrap primitive types a...
@rdohms                  http://doh.msrafael @doh.ms          http://slides.doh.ms             Questions?         https://...
Recommended Links:                                       https://joind.in/6125                    The ThoughtWorks Antholo...
Upcoming SlideShare
Loading in...5
×

You code sucks, let's fix it

155,519

Published on

How do you measure the quality of your code? Performance and testing are just one aspect of code, in order to meet deadlines and make maintenance quicker you also need your code to be readable, decoupled and generally easier to comprehend and work with. This talk will go over tips and exercises to help you identify trouble areas, refactor them and train you to write better code in future projects. Come make your code look and function better.

Published in: Technology
8 Comments
134 Likes
Statistics
Notes
No Downloads
Views
Total Views
155,519
On Slideshare
0
From Embeds
0
Number of Embeds
46
Actions
Shares
0
Downloads
1,025
Comments
8
Likes
134
Embeds 0
No embeds

No notes for slide

You code sucks, let's fix it

  1. 1. Your code sucks, let’s !x it! Object Calisthenics and Code readability Rafael Dohms
  2. 2. Rafael Dohms photo credit: Eli WhitePHP Evangelist, Speaker andcontributor. He is a very active member of thePHP Community, having helped create andmanage two PHP User Groups in Brazil. Heshared the lead of PHPSP for 3 wonderfulyears making a positive mark on the local market.Developer, gamer and lover of code he also hostsBrazil’s first PHP Podcast: PHPSPCast, as wellas contributing to well known projects. He moved to the Netherlands in search ofnew challenges and is now part of the team atWEBclusive.
  3. 3. What’s the talk about?• Why does my code suck?• How can we fix it?
  4. 4. Is it Maintainable? Is it Readable? Why does my code suck? Is it Reusable? Is it Testable?
  5. 5. <?php Does it look like this?$list=mysql_connect("******","*******","*****");if(!$list)echo Cannot login.;else{ mysql_select_db("******", $list); $best=array("0","0","0","0","0","0"); $id=mysql_num_rows(mysql_query("SELECT * FROM allnews")); $count=0; for($i=0;$i<6;$i++){ while(mysql_query("SELECT language FROM allnews WHERE id=$id-$count")!="he")$count++; $best[$i]=mysql_query("SELECT id FROM allnews WHERE id=$id-$count");} $id=$id-$count; $maxdate=mktime(0,0,0,date(m),date(d)-7,date(Y)); while(mysql_query("SELECT date FROM allnews WHERE id=$id-$count")>=$maxdate){ if(mysql_query("SELECT language FROM allnews WHERE id=$id-$count")=="he"){ $small=$best[0]; while($i=0;$i<6;$i++){ if(mysql_query("SELECT score FROM allnews WHERE id=$small)"<mysql_query("SELECT score FROM allnews WHERE id=$best[i+1]")) $small=$best[i+1];} if(mysql_query("SELECT score FROM allnews WHERE id=$small")<mysql_query("SELECT score FROM Rebecca WHERE id=$id-$count")){ If allnews Black was a developer while($i=0;$i<6;$i++){ if($small==$best[i])$best[i]=mysql_query("SELECT id FROMallnews WHERE id=$id-$count");}}}} while($i=0;$i<6;$i++) echo <a href="news-page.php?id=.$best[i]."><div class="box .mysql_query("SELECTtype FROM allnews WHERE id=$best[i]").">.mysql_query("SELECT title FROM allnews WHERE id=$best[i]").<div class="img" style="background-image:url(images/.mysql_query("SELECTimage1 FROM allnews WHERE id=$best[i]").);"></div></div></a>; mysql_close($list);}?>
  6. 6. How do we fix it?
  7. 7. cal·is·then·ics - noun - /ˌkaləsˈTHeniks/ Calisthenics are a form of dynamic exercise consisting of a variety of simple, often rhythmical, movements, generally using minimal equipment or apparatus.Object Calisthenics A variety of simple, often rhythmical, exercises to achieve better OO and code quality
  8. 8. “So here’s an exercise that can help you to internalize principles of good object-oriented design and actually use them in real life.” -- Jeff BayObject Calisthenics Important: PHP != JAVA Adaptations will be done
  9. 9. “You need to write code that minimizes the time it wouldObject Calisthenics take someone else to understand it—even if that someone else is you.” + -- Dustin Boswell and Trevor Foucher Readability Tips I’m a tip
  10. 10. Disclaimer:“These are guidelines, not rules”
  11. 11. OC #1“Only one indentation level per method”
  12. 12. function validateProducts($products) { // Check to make sure that our valid fields are in there $requiredFields = array( price, name, description, type, ); $valid = true; 0 foreach ($products as $rawProduct) { 1 $fields = array_keys($rawProduct); foreach ($requiredFields as $requiredField) { 2 if (!in_array($requiredField, $fields)) { 3 $valid = false; } } } return $valid;}
  13. 13. function validateProducts($products) { // Check to make sure that our valid fields are in there $requiredFields = array( price, name, description, type, ); $valid = true; 0 foreach ($products as whitespace $validationResult $rawProduct) { = validateSingleProduct($rawProduct, $requiredFields); 1 if ( ! $validationResult){ } 2 $valid = false; } return $valid;}function validateSingleProduct($product, $requiredFields){ $valid = true; duplicated logic $fields = array_keys($rawProduct); 0 foreach(!in_array($requiredField, $fields)) ($requiredFields as $requiredField) { 1 if { } 2 $valid = false; } return $valid;}
  14. 14. function validateProducts($storeData) { $requiredFields = array(price,name,description,type); cheating! I see foreach ($storeData[products] as $rawProduct) { if ( ! validateSingleProduct($rawProduct, $requiredFields)) return false; } return true; Single line IF, simple operations return early}function validateSingleProduct($product, $requiredFields){ $fields = array_keys($rawProduct); $missingFields = array_diff($requiredFields, $fields); return (count($missingFields) == 0);} C (native) functions are faster then PHP
  15. 15. List is more readable the pluralfunction validateProductList($products) iteration faster{ $invalidProducts = array_filter($products, isInvalidProduct); return (count($invalidProducts) === 0);} readable return: zero invalid products reusable methodfunction isInvalidProduct($rawProduct){ $requiredFields = array(price, name, description, type); $fields = array_keys($rawProduct); $missingFields = array_diff($requiredFields, $fields); return (count($missingFields) > 0);} method name matches “true” result
  16. 16. Key Benefits• Cohesiveness• Methods does only one thing• Increases re-use
  17. 17. OC #2“Do not use the ‘else’ keyword”
  18. 18. public function createPost($request){ $entity = new Post(); $form = new MyForm($entity); $form->bind($request); if ($form->isValid()){ $repository = $this->getRepository(MyBundle:Post); if (!$repository->exists($entity) ) { $repository->save($entity); return $this->redirect(create_ok); } else { $error = "Post Title already exists"; return array(form => $form, error => $error); } } else { $error = "Invalid fields"; return array(form => $form, error => $error); }}
  19. 19. public function createPost($request){ $entity = new Post(); $form = new MyForm($entity); $form->bind($request); if ($form->isValid()){ $repository = $this->getRepository(MyBundle:Post); if (!$repository->exists($entity) ) { $repository->save($entity); return $this->redirect(create_ok); } else { $error = "Post Title already exists"; return array(form => $form, error => $error); } } else { $error = "Invalid fields"; return array(form => $form, error => $error); }}
  20. 20. public function createPost($request){ $entity = new Post(); $form = new MyForm($entity); $form->bind($request); if ($form->isValid()){ $repository = $this->getRepository(MyBundle:Post); if (!$repository->exists($entity) ) { $repository->save($entity); intermediate variable return $this->redirect(create_ok); } else { $error = "Post Title already exists"; return array(form => $form, error => $error); } intermediate variable } else { $error = "Invalid fields"; return array(form => $form, error => $error); }}
  21. 21. Separate code into blocks.public function createPost($request){ Its like using $entity = new Post(); $repository = $this->getRepository(MyBundle:Post); Paragraphs. $form = new MyForm($entity); $form->bind($request); removed intermediates if ( ! $form->isValid()){ return array(form => $form, error => Invalid fields); } early return if ($repository->exists($entity)){ return array(form => $form, error => Duplicate post title); } $repository->save($entity); return $this->redirect(create_ok);}
  22. 22. Key Benefits• Helps avoid code duplication• Makes code clearer (single path)
  23. 23. Ad ap OC #3 te d “Wrap all primitivetypes and string, if it has behaviour”
  24. 24. class UIComponent{//... public function repaint($animate = true){ //... }}//...$component->repaint(false); unclear operation
  25. 25. class UIComponent{ //... public function repaint( Animate $animate ){ //... }}class Animate This can now encapsulate all{ animation related operations public $animate; public function __construct( $animate = true ) { $this->animate = $animate;}}//...$component->repaint( new Animate(false) );
  26. 26. Key Benefits• Type Hinting• Encapsulation of operations
  27. 27. Ad ap te d OC #4“Only one -> per line, if not getter or fluent”
  28. 28. Source: CodeIgniter properties are harder to mock$this->base_url = $this->CI->config->site_url()./.$this->CI->uri->segment(1).$this->CI->uri->slash_segment(2, both); no whitespace$this->base_uri = $this->CI->uri->segment(1).$this->CI->uri->slash_segment(2, leading); move everything to uri object $this->getCI()->getUriBuilder()->getBaseUri(‘leading’); - Underlying encapsulation problem - Hard to debug and test - Hard to read and understand
  29. 29. Source: Zend Framework App fluent interface$filterChain->addFilter(new Zend_Filter_Alpha()) ->addFilter(new Zend_Filter_StringToLower()); operator alignment only getters (no operations) $user = $this->get(security.context)->getToken()->getUser(); where did my return null? autocomplete go? Source: Symfony 2 Docs.
  30. 30. Key Benefits• Readability• Easier Mocking• Easier to Debug• Demeter’s Law
  31. 31. OC #5“Do not Abbreviate”
  32. 32. ?if($sx >= $sy) { ? if ($sx > $strSysMatImgW) { $ny = $strSysMatImgW * $sy / $sx; $nx = $strSysMatImgW; } ? if ($ny > $strSysMatImgH) { $nx = $strSysMatImgH * $sx / $sy; $ny = $strSysMatImgH; }} else { ? if ($sy > $strSysMatImgH) { $nx = $strSysMatImgH * $sx / $sy; $ny = $strSysMatImgH; } ? if($nx > $strSysMatImgW) { $ny = $strSysMatImgW * $sy / $sx; $nx = $strSysMatImgW; }}
  33. 33. Why?Its repeated many times, and i’m lazy. Underlying Problem! You need to transfer those operations into a separate class.
  34. 34. Why? more then one responsibility?function processResponseHeadersAndDefineOutput($response) { ... } This method name is too long to type, and i’m lazy.
  35. 35. get from where? Use clearer names:function getPage($data) { ... } fetchPage() downloadPage() Use a thesaurus:function startProcess() { ... } fork, create, begin, open Table row? Easy understanding, complete scope:$tr->process(“site.login”); $translatorService
  36. 36. Key Benefits• Clearer communication• Indicates underlying problems
  37. 37. Ad ap te d OC #6“Keep your classes small”
  38. 38. Increased to include docblocks 15-20 lines per method 100 lines per class15 classes per package read this as namespace or folder
  39. 39. Key Benefits• Single Responsibility• Objective methods• Slimmer namespaces• Less clunky folders
  40. 40. Ad ap OC #7 te d “Limit the number ofinstance variables in a class (max: 2 5)”
  41. 41. class MyRegistrationService { protected $userService; protected $passwordService; protected $logger;All DB interaction protected $translator; should be in protected $entityManager; userService protected $imageCropper; Use and event based system and move this // ... to listener } Limit: 5
  42. 42. Key Benefits• Shorter dependency list• Easier Mocking for unit test
  43. 43. OC #8“Use first class collections”
  44. 44. Doctrine: ArrayCollection$collection->getIterator();$collection->filter(...);$collection->append(...);$collection->map(...);
  45. 45. Key Benefits• Implements collection operations• Uses SPL interfaces
  46. 46. Dr op pe d OC #9“Do not use accessors (getter/setter)”
  47. 47. /** * THIS CLASS WAS GENERATED BY THE DOCTRINE ORM. DO NOT EDIT THIS FILE. */class DoctrineTestsModelsCMSCmsUserProxy extends DoctrineTestsModelsCMSCmsUser implements DoctrineORMProxyProxy{ public function getId() { $this->__load(); Example: Doctrine uses getters to return parent::getId(); inject lazy loading operations } public function getStatus() { $this->__load(); return parent::getStatus(); }
  48. 48. Key Benefits• Injector operations• Encapsulation of transformations
  49. 49. Cr ea te d! OC #10 (bonus!)“Document your code!”
  50. 50. really?//check to see if the section above set the $overall_pref variable to voidif ($overall_pref == void)// implode the revised array of selections in group three into a string// variable so that it can be transferred to the database at the end of the// page$groupthree = implode($groupthree_array, "nr"); Documenting because i’m doing it wrong in an anusual way
  51. 51. $priority = isset($event[priority]) ? $event[priority] : 0; Add a simple comment:if (!isset($event[event])) { throw new //Strips special chars and camel cases to onXxx InvalidArgumentException(...));}if (!isset($event[method])) { $event[method] = on.preg_replace(array( Don’t explain bad /(?<=b)[a-z]/ie, code, fix it! /[^a-z0-9]/i ), array(strtoupper("0"), ), $event[event]);}$definition->addMethodCall( addListenerService, array($event[event], array($listenerId, What does this do? $event[method]), $priority)); Source: Symfony2
  52. 52. Do a mind dump, then clean it up. A note on cost of running function/*** Checks whether an element is contained in the collection.* This is an O(n) operation, where n is the size of the collection.** @todo implement caching for better performance* @param mixed $element The element to search for.* @return boolean TRUE if the collection contains the element, or FALSE.*/function contains($element); Generate API docs ex: docBlox mark todo items so the changes don’t get lost
  53. 53. Key Benefits• Automatic API documentation• Transmission of “line of thought”• Avoids confusion
  54. 54. Recap• #1 - Only one indentation level per method.• #2 - Do not use the ‘else’ keyword.• #3 - Wrap primitive types and string, if it has behavior.• #4 - Only one -> per line, if not getter or fluent.• #5 - Do not Abbreviate.• #6 - Keep your classes small• #7 - Limit the number of instance variables in a class (max: 5)• #8 - Use first class collections• #9 - Use accessors (getter/setter)• #10 - Document your code!
  55. 55. @rdohms http://doh.msrafael @doh.ms http://slides.doh.ms Questions? https://joind.in/6125
  56. 56. Recommended Links: https://joind.in/6125 The ThoughtWorks Anthology http://goo.gl/OcSNx The Art of Readable Code http://goo.gl/unrijDISCLAIMER: This talk re-uses some of the examples used by Guilherme Blanco in hisoriginal Object Calisthenic talk. These principles were studied and applied by us while weworked together in previous jobs. The result taught us all a lesson we really want to spreadto other developers.
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×