Clean code

Inhoudsopgave

1. Clean code: definities
2. Clean code: principes
3. Unit testing: definities
4. Unit testing: voorbeelden

Clean code is code that is easy to understand and easy to change.

			function process($obj, $continue = FALSE) {
				// echo "starting the process";
				if($obj->generate() == NULL) {
					return -1;
				}
				$result = $obj->generate();
				if($continue) {
					return $result->generate();
				}
				return $result;
			}
						

	function getBookByISBN($isbn) {
		$book = array_search($isbn, $this->books);
		if($book == FALSE) {
			throw new BookNotFoundException("book was not found!");
		}
		return $book;
	}
						

1. Naamgeving: comments

1. Naamgeving: comments

	/**
	 *
	 * Prolong the book
	 *
	 * @param    Book  		$i The book to prolong
	 * @param    DateTime  		$j The date to prolong to
	 * @param    Person		$k The person to prolong the book to
	 * @return   nothing if OK
	 *
	 */
	function prolong($i, $j, $k) {
		//Check if this book has been checked out by the same person
		if($i->person != $k)
			//BUSTED!
			return "This is not a book you checked out."
		else
			//Everything OK, prolong the book
			$book->checkOutDate = $date;
	}
						

1. Naamgeving: comments

	function prolong($book, $date, $person) {
		if(!$book->isCheckedOutBy($person))
			return "This is not a book you checked out."
		else
			$book->checkOutDate = $date;
	}
						

2. Functies: Side effects

	class Book {
			function prolong($date, $person) {
				//prolong implementatie
				if($this->isOverDue()){
					$person->credit -= 10;
				}
		}
	}
						

	class Book {
		function prolong($date, $person) {
			//prolong implementatie
		}
	}

	if($book.isOverdue($date)){
		$person->applyFine();
	}
	$book->prolong($date, $person);
						

oefeningen deel 1

Oefeningen deel 1: story 1

• Gegeven: Empire, Sith, Jedi classes vol funcs.
• Uw taak: verduidelijken! Wat doet wat? Naamgeving!
• Unit testen groen houden! (cmd: > phpunit tests)

PHPUNIT - recap

Oefeningen deel 1: story 2

• maak een function op Empire, 'convert($jedi)'
     Wat zou dit volgens u moeten doen?
• maak een function op Jedi, 'equip($saber)'.
     Wat zou dit volgens u moeten doen?
• Vergeet niet de testen uit te breiden!

Oefeningen deel 1 - discussie

• Zijn alle testen nog groen? Heb je er bijgeschreven?
• Naamgeving - ook doorgevoerd in testen?
• Onthou principes voor volgende oefeningen!

3. Scoping - poging 1

	public class BookRepository {
		public $db;
		public $bookCache = [];
	}

	$bookRepositoryInstance->db->query('where isOverdue = TRUE');
						

3. Scoping - poging 2

public class BookRepository {
	private $db;
	public function getOverdueBooks() {
		return $db->query('where isOverdue = TRUE');
	}
}

$bookRepositoryInstance->getOverdueBooks();
						

4. OO design - poging 1

	$bookid = $_POST['bookid'];
	function prolong($book, $date, $person) {
			$book->checkOutDate = $date;
			$person->bookList->push($book);
		}
	}
	prolong($db->getby($bookid), $_POST['date'], $person);

	echo "thank you it has been prolonged"

						

4. OO design - poging 2

	class Book {
		function prolong($date, $person) {
			$person->addToBookList($this);
		}
	}
	$book = new Book();
	$book->prolong($_POST['date'], $person);
	$view->renderThankYouPage();
						

	class BookTest extends TestCase {
		public void testProlongAddsToPersonBookList() {
			// ...
		}
	}
						

4. OO design: polymorphism - poging 1

	function getAisle($book) {
		switch($book->type) {
			case 'nonficition': return 400;
			case 'fiction': return 234;
		}
	}

	getAisle({ type: 'nonfiction' });
						

4. OO design: polymorphism - poging 2

	abstract class Book {
		abstract public function getAisle();
	}
	class FictionBook extends Book {
		function getAisle() {
			return 234;
		}
	}
	class NonFictionBook extends Book {
		function getAisle() {
			return 400;
		}	
	}

	new NonFictionBook()->getAisle();
						

4. OO design; Error handling - poging 1

	function getBookById($id) {
		if($id == NULL) return -1;

		return $db->getById($id);
	}
						

4. OO design; Error handling - poging 2

function getBookById($id) {
	if($id == NULL) throw new InvalidIdException("id cannot be null!");

	return $db->getById($id);
}
						

Oefeningen deel 2

Dierentuin - story 1

• maak een Dierentuin class
• kan verschillende Dieren (class) ontvangen (function)
• elk dier heeft een grootte en naam:
  Neushoorn (40), Giraf(25), Poema (10)
• elke dierentuin heeft x beschikbareRuimte afhankelijk van grootte van het dier
  wat doe je bij het ontvangen van een te groot dier?

class Dierentuin {
	public function bezoek() {
		// return [] of dieren
	}
	public function ontvangDier($dier) {
		// ??
	}
}
						

Dierentuin - story 2

• voeder functie op dierentuin
  return TRUE of FALSE indien genoeg voedsel voor elk ontvangen dier in de tuin
• voedsel heeft een voedingswaarde
  Elk dier eet even veel waarde als zijn grootte
• Verzin voedsel implementaties om alle edge cases te kunnen testen!

class Dierentuin {
	public function voeder($voedsel) {
		return TRUE;	// ??
	}
}
						

Dierentuin - story 3

• Dieren zijn carnivoren, herbivoren of omnivoren!
• voedsel is ofwel vlees- of plant-gebaseerd
• Wat doe je als je een carnivoor sla geeft, of een herbivoor een stukje kip?
• Focus op de testen! Alle gevallen onder test brengen.

	public function voeder($voedsel) {
		// wat nu??
	}
						

Dierentuin - story 4

• Dieren zijn allergisch aan bepaald voedsel!
• Wat doe je als een dier voedsel eet wat het niet verdraagt?
  Hoe ga je om in de Dierentuin klasse met een dier minder?
• Wat doe je in de voeder implementatie?

class Dier {
	public function isAllergischAan($voedsel) {
		return TRUE;	// ??
	}
}
						

Dierentuin - discussie

• Polymorfisme niet vergeten?
• Genoeg testen geschreven voor elk geval?
• Exceptions gebruikt ipv return code?

Waarom unit testen?

Waarom unit testen?

• feedback!
• Denk in code vanuit API standpunt
• Makkelijk voor pair om te volgen
• Alle mogelijke paden gedekt

Soorten testen

unit testing

• Onafhankelijk van externen (db, webservice, ...)
• Snel!
• Véél testen
• Test normaal pad & limieten
• "actieve vijand van de code"

integration testing

• Test geïntegreerd met externen (db, webservice, ...)
• Test integratie twee verschillende lagen
• Trager dan unit tests
• Minder test cases

end to end testing

• Test hele applicatie!
• niet alle limieten
• traag, moelijker onderhoudbaar
• Test integratie alle lagen

OEFENING:
SPREADSHEET

Story 1: simple spreadsheet

• Onbeperkt aantal rijen/kolommen
• Rij = nummer 1 -> 9999...
• Kolom = Cijfer A -> Z, AA -> ZZ, ...
• Cellen zijn standaard leeg ("")
• Cellen kunnen tekst opslaan
• Mogelijk om inhoud van cel uit te lezen

Story 2: numerics and literal values

• Numerische cellen worden automatisch herkend:
  Tekst " 124 " (met spaties) wordt het getal 124 (zonder spaties)
• Mogelijk om literaire inhoud van cel uit te lezen
  Cel met tekst " 124 " heeft literaire waarde " 124 " en waarde 124

Story 3: Formulas

• "=234" is een formule, " =234" (spatie) is tekst
• Waarde van formule "=234" is het getal 234. Literaire waarde = de formule
• Soorten:
  1. Constanten =124
  2. Met haakjes =((124))
  3. Simpele berekeningen =3+5, =5-3, =4*2
  4. Complexe berekeningen =7*(2+3)*((((2+1))))

Story 3: Formulas - berekeningen

	public function testFormula_evaluatesSimpleCalculation() {
		$formula = "3+5";

		$this->assertEquals(8, eval('return ' . $formula . ';'));
	}

						

Story 4: Formula errors

Story 5: dependencies

• Waarde = waarde van cel waar je naar verwijst.
• Indien waarde A2 verandert, verandert deze cel ook.
• Referenties naar referenties = mogelijk! A1 -> A2 -> A3
• Circulaire referneties vermijden.
  Geef "#CIRCULAR" fout als waarde.

Story 6: Functions

• Sum(range)
  Bijvoorbeeld =SUM(A1:A6)
• Average(range)
  Bijvoorbeeld =AVG(A1:D1)

Spreadsheet - discussie

• Genoeg testen geschreven voor elk geval?
• Exceptions gebruikt ?
• Is je code leesbaar voor je buurman?
• Was dit makkelijker met focus op schrijven van testen of niet?

3. Scoping - poging 1

	var obj = {
		isRendered: false,

		render: function() {
			if(!this.isRendered) {
				refresh();
			}
			this.isRendered = true;
		}
	};
						

3. Scoping - poging 1

1. delete obj.isRendered en *POOF*
2. obj.isRendered = true en *POOF*

3. Scoping - poging 2

	obj = (function() {
		var isRendered = false;
		var render = function() {
			// ...
		}

		return {
			render: render
		};
	})();
						

3. Scoping - poging 2

	(function() {
		// niemand kan aan mij! FUNCTION LEVEL SCOPE
	})();
						

	myAPI = (function() {
		return {
			// enkel DIT is aanspreekbaar
		};
	})();
						

3. Scoping

	function main() {
	    if (TRUE) {
	        $i = 3;
	    }
	    echo $i;
	}
	main();			// wat doet dit?
						

3. Scoping

	var main = function () {
	    if (true) {
	        var i = 3;
	    }
	    console.log(i);
	}
	main();			// wat doet dit?
    				

	var main = function () {
		var i = undefined;
	    if (true) {
	        i = 3;
	    }
	    console.log(i);
	}
    				

3. Scoping

	void main() {
	    if (true) {
	        int i = 3;
	    }
	    printf("%d", i);	// wat doet dit?
	}
						

4. OO design - poging 1

	var bookid = document.querySelector('#bookid').innerHTML;
	var prolong = function(book, date, person) {
			book.checkOutDate = date;
			person.bookList.push(book);
		}
	};
	doAjaxCall('getBookById.json', bookid, function(book) {
		prolong(book, someDate, person);
	});
	document.querySelector('#messages').innerHTML = "thank you";

						

4. OO design - poging 2

	// ------ domain/book.js ------ 
	var Book = {
		prolong: function(date, person) {
			person.addToBookList(this);
		}
	};
	// ------ controller/bookid.js ------
	var bookid = view.getBookId();
	doAjaxCall('getBookById.json', bookid, function(book) {
		book.prolong(someDate, person);
	});
	view.renderThankYouPage();
						

4. OO design - poging 3

	doAjaxCall('getBookById.json', bookid, function(book) {
		book.prolong(someDate, person);
		view.renderThankYouPage();
	});
						

4. OO design - Testen!

	describe("Book tests", function() {
	  it("should add book to person list", function() {
	  	var book = Object.create(Book);
	  	book.prolong(someDate, person);

	    expect(person.getBookList()).toContain(book);
	  });
	});						
						

4. OO design

Héél belangrijk in goed onderhoudbare JS code:

1. Scheiding domein/callbacks - async stuff
2. Scheiding domein/front - DOM manipulatie
3. Scheiding domein/frameworks - niet (makkelijk) testbaar!

Moeilijk testbare code => beter eerst testen geschreven??

Unit testing in JS

		describe("A suite", function() {
		  it("contains spec with an expectation", function() {
		    expect(true).toBe(true);
		  });
		});
						

Test Driven Development (TDD)
remember?

TDD: "bugfix" edge case

Oefening - Dierentuin HERWERKEN IN JS

Dierentuin - story 1 - remember?

• maak een Dierentuin class (ES6!)
• kan verschillende Dieren ontvangen
• elk dier heeft een grootte en naam:
  Neushoorn (40), Giraf(25), Poema (10)
• elke dierentuin heeft x beschikbareRuimte afhankelijk van grootte van het dier
  wat doe je bij het ontvangen van een te groot dier?

class Dierentuin {
	constructor() {}

	bezoek() {
		// return [] of dieren
	}
	ontvangDier(dier) {
		// ??
	}
}
						

Dierentuin - story 2

• voeder functie op dierentuin
  return true of false indien genoeg voedsel voor elk ontvangen dier in de tuin
• voedsel heeft een voedingswaarde
  Elk dier eet even veel waarde als zijn grootte
• Verzin voedsel implementaties om alle edge cases te kunnen testen!

class Dierentuin {
	voeder(voedsel) {
		return true;	// ??
	}
}
						

Dierentuin - story 3

• Dieren zijn carnivoren, herbivoren of omnivoren!
• voedsel is ofwel vlees- of plant-gebaseerd
• Wat doe je als je een carnivoor sla geeft, of een herbivoor een stukje kip?
• Focus op de testen! Alle gevallen onder test brengen.

	public function voeder($voedsel) {
		// wat nu??
	}
						

Dierentuin - story 4

• Dieren zijn allergisch aan bepaald voedsel!
• Wat doe je als een dier voedsel eet wat het niet verdraagt?
  Hoe ga je om in de Dierentuin klasse met een dier minder?
• Wat doe je in de voeder implementatie?

class Dier {
	public function isAllergischAan($voedsel) {
		return TRUE;	// ??
	}
}
						

Dierentuin - ES6 crash course

Van PHP naar JS met ES6

class Dier {
	constructor(arg) { }		// __construct()
	eet(voedsel) {			// public function eet($voedsel)
		this.boer();		// $this->boer();
	}
	boer() {			// public function boer()
		console.log('burp'); 	// echo "burp";
	}
}
new Dier().eet();			// new Dier()->eet();
						

Dierentuin - discussie

• Genoeg testen geschreven voor elk geval?
• Was dit makkelijk van PHP naar JS over te zetten?
• Gedacht aan classes en inheritance?

Soorten testen - remember?

integration testing - remember?

• Test geïntegreerd met externen (db, webservice, ...)
• Test integratie twee verschillende lagen
• Trager dan unit tests
• Minder test cases

unit testing - hoe één stukje testen?

	var Book = {
		prolong: function(person) {
			var date = Date.now();
			this.dbHandle.prolong(date, person.id);
		}
	};
						

unit testing - hoe één stukje testen?

Injecteer een andere dbHandle: een "mock".

 	var book = Object.create(Book);
 	book.dbHandle = {
 		prolong: function(date, personId) {
 			// Captured arguments! Assert stuff here
 		}
 	};
						

unit testing - met Jasmine

Laat Jasmine "spies" aanmaken
https://jasmine.github.io/api/2.6/global.html#spyOn

it("should call prolong from repository", () => {
	let personId;
	const dbHandle = spyOn('dbHandle', 'prolong').and.callFake((theDate, thePersonId) => {
		personId = thePersonId;
	});
	book.dbHandle = dbHandle;
	book.prolong(person);

	expect(personId).toBe(person.id);
});
						

unit testing - met PHPUnit

https://phpunit.de/manual/current/en/test-doubles.html

    public function testStub()
    {
        $mock = $this->createMock(DbHandle::class);
        $mock->method('prolong')
        		->with($this->anything())
        		->with($this->person.id);
    	$book = new Book($mock);

        $this->assertEquals('foo', $book->prolong());
    }
						

unit testing - in Symfony

Welke stukken kan ik op die manier testen...
in een Symfony project?

unit testing - in Symfony

• De entityManager ObjectManager klasse
• Stukjes domein logica uit controllers halen die elders getest zijn
• ...

      $bookRepositoryMock = $this->getMockBuilder(EntityRepository::class)
            ->disableOriginalConstructor()
            ->getMock();
      $bookRepositoryMock->expects($this->once())
            ->method('find')
            ->will($this->returnValue($book));

     $bookController = new BookController($bookRepositoryMock);
						

Oefening - CODE REVIEWS

Code reviews

• switch computers!
• Zoek actief naar stukken die goed en minder zijn.
  Denk aan clean code & unit testen!
• Nog geen code wijzigen!
• Neem de tijd om alles onder de loep te nemen, incl testen.
• Noteer in een open NOTEPAD scherm: + WAAROM?

Code reviews - discussie

• Wie heeft de unit testen bekeken?
  Ontbreken er een aantal?
• Wie heeft de applicatie daadwerkelijk gebruikt als eindgebruiker?
• Wie heeft ook gelet op functionele vereisten die ontbreken?