The Cake is a Lie

The Cake Is A Lie Sebastian Bergmann June 11th 2010

Sebastian Bergmann  Co-Founder and Principal Consultant with thePHP.cc  Pioneer in the field of QA for PHP projects  Creator of PHPUnit  Contributor to PHP

Get the help you need from the experts you trust. Consulting | Code Review | Training

It all started at the IPC last fall … http://twitter.com/s_bergmann/status/5776174736

”Your promised reward is merely a fictitious motivator.” – Urban Dictionary

However: This is not about bashing projects. The goal is to highlight a couple of possible risks.

This is not the cake we're talking about.

This is my opinion. You are not required to share it.

Goals of Using a Framework

The Pareto Principle The first 80% of a project are easy, the last 20% are hard.

The Pareto Principle A framework wants to provide as much as possible of that 80%.

Framework Philosophy

Framework Philosophy Cake or Salad?  Cake  Full Stack Framework  Code Generation  Salad  Component Library  Coding / Project Standard

Standardization of Application Development

Standardization of Application Development Zend Framework: Project Structure sb@thinkpad /tmp % phploc --count-tests demo phploc 1.5.1 by Sebastian Bergmann. Directories: 4 Files: 7 Lines of Code (LOC): 127 Cyclomatic Complexity / Lines of Code: 0.18 Executable Lines of Code (ELOC): 65 Comment Lines of Code (CLOC): 29 Non-Comment Lines of Code (NCLOC): 98 Namespaces: 0 Interfaces: 0 Classes: 3 Abstract: 0 (0.00%) Concrete: 3 (100.00%) Average Class Length (NCLOC): 20 Methods: 4 Scope: Non-Static: 4 (100.00%) Static: 0 (0.00%) Visibility: Public: 4 (100.00%) Non-Public: 0 (0.00%) Average Method Length (NCLOC): 15 Cyclomatic Complexity / Number of Methods: 2.50 Anonymous Functions: 0 Functions: 0 Constants: 4 Global constants: 4 Class constants: 0 Tests: Classes: 0 Methods: 0

Scaffolding

Scaffolding CakePHP's scaffolding is pretty cool. It allows you to get a basic CRUD application up and going in minutes. So cool that you will want to use it in production apps. Now, we think it is cool, too, but please realize that scaffolding is … well ... just scaffolding. http://book.cakephp.org/view/105/Scaffolding

Scaffolding [Scaffolding is] a loose structure you throw up real quick during the beginning of a project in order to get started. It is not meant to be completely flexible, it is meant as a temporary way to get up and going. If you find yourself really wanting to customize your logic and your views, it is time to pull your scaffolding down in order to write some code. http://book.cakephp.org/view/105/Scaffolding

Described like this, scaffolding sounds like a spike solution (or throwaway code) to me.

iX 5/2009: ”Königswege” http://www.heise.de/kiosk/archiv/ix/2009/5/40_C-ASP.Net,-Java-EE,-PHP-Symfony,-Ruby-on-Rails

Scaffolding Symfony propel: Wine: _attributes: { defaultIdMethod: none } wineid: { type: integer, required: true, primaryKey: true, autoIncrement: true } name: varchar(32) age: integer price: decimal wineryid: { type: integer, required: true, foreignTable: Winery, foreignReference: wineryid } Winery: _attributes: { defaultIdMethod: none } wineryid: { type: integer, required: true, primaryKey: true, autoIncrement: true } name: varchar(32) adress: varchar(32) region: varchar(32) Cellar: _attributes: { defaultIdMethod: none } cellarid: { type: integer, required: true, primaryKey: true, autoIncrement: true } name: varchar(32) address: varchar(32) Stocked: _attributes: { defaultIdMethod: none } wineid: { type: integer, required: true, foreignTable: Wine, foreignReference: wineid, primaryKey: true } cellarid: { type: integer, required: true, foreignTable: Cellar, foreignReference: cellarid, primaryKey: true }

Scaffolding Symfony sb@thinkpad wines % phploc --count-tests . phploc 1.5.1 by Sebastian Bergmann. Directories: 22 Files: 87 Lines of Code (LOC): 10145 Cyclomatic Complexity / Lines of Code: 0.17 Executable Lines of Code (ELOC): 4326 Comment Lines of Code (CLOC): 4106 Non-Comment Lines of Code (NCLOC): 6039 Namespaces: 0 Interfaces: 0 Classes: 36 Abstract: 9 (25.00%) Concrete: 27 (75.00%) Average Class Length (NCLOC): 165 Methods: 340 Scope: Non-Static: 223 (65.59%) Static: 117 (34.41%) Visibility: Public: 310 (91.18%) Non-Public: 30 (8.82%) Average Method Length (NCLOC): 17 Cyclomatic Complexity / Number of Methods: 3.03 Anonymous Functions: 0 Functions: 0 Constants: 42 Global constants: 0 Class constants: 42 Tests: Classes: 0 Methods: 0

Delicious? Maybe. Healthy? Not so sure.  We wrote 31 lines of YAML.  Symfony generated 10145 lines of PHP.  This is a lot of code that needs to be  executed  tested  maintained  debugged  …

Framework Overhead http://talks.php.net/show/froscon08/

Scaffolding Propel sb@thinkpad wines % phploc --count-tests lib/model phploc 1.5.1 by Sebastian Bergmann. Directories: 2 Files: 20 Lines of Code (LOC): 8489 Cyclomatic Complexity / Lines of Code: 0.20 Executable Lines of Code (ELOC): 3371 Comment Lines of Code (CLOC): 3910 Non-Comment Lines of Code (NCLOC): 4579 Namespaces: 0 Interfaces: 0 Classes: 20 Abstract: 8 (40.00%) Concrete: 12 (60.00%) Average Class Length (NCLOC): 270 Methods: 287 Scope: Non-Static: 170 (59.23%) Static: 117 (40.77%) Visibility: Public: 263 (91.64%) Non-Public: 24 (8.36%) Average Method Length (NCLOC): 18 Cyclomatic Complexity / Number of Methods: 3.33 Anonymous Functions: 0 Functions: 0 Constants: 42 Global constants: 0 Class constants: 42 Tests: Classes: 0 Methods: 0

Scaffolding Propel abstract class BaseWine extends BaseObject implements Persistent { // ... 1190 LOC ... } class Wine extends BaseWine { public function __toString() { return sprintf( '%s (%d years old) from %s: %f EUR', $this->getName(), $this->getAge(), $this->getWinery(), $this->getPrice() ); } }

Scaffolding … leads to a tight coupling between code and database.

ObjectRelational Mapping (ORM) ”The Vietnam of Computer Science”

ObjectRelational Mapping (ORM) Law of Diminishing Returns Early successes yield a commitment to use ORM in places where success becomes more elusive, and over time, isn't a success at all due to the overhead of time and energy required to support it through all possible use-cases. This slide contains material by Ted Neward

Mikado Architecture Tight coupling leads to situations where each change leads to unwanted side effects.

Automagic Functionality

Maintenance

Maintenance How do I {extend|maintain|test} generated code? abstract class BaseWine extends BaseObject implements Persistent { // ... 1190 LOC ... } class Wine extends BaseWine { public function __toString() { return sprintf( '%s (%d years old) from %s: %f EUR', $this->getName(), $this->getAge(), $this->getWinery(), $this->getPrice() ); } }

Technical Debt

Technical Debt  Ward Cunningham compares bad code with a financial loan that has an interest on it.  Such a loan can be a good idea.  If it helps to ship a product more quickly.  If the loan is not paid back, through refactoring for instance, the interest will pile up.  Eventually, every small change to the code will be so expensive that it will not be economically feasible anymore to maintain the code.

Technical Debt Relative cost of a bugfix [Boehm 2008]

Coding Standard

Sustainability

Sustainable Solutions  Don't go into Technical Debt because of your framework  Avoid code generation  Use Data Mapper instead of Active Record  Propel and Doctrine 1 use Active Record  Doctrine 2 uses Data Mapper (and looks promising)  Use loosely coupled components  Symfony Components (part of Symfony 2)  Zend Framework  Zeta Components (formerly known eZ Components)

PHP 4 is dead. Do not start a new project based on a framework that still supports PHP 4.

The End

The End  Web: http://thePHP.cc/ http://sebastian-bergmann.de/  Mail: sebastian@thePHP.cc  Twitter: @s_bergmann  Slides: http://talks.thePHP.cc/  Vote: http://joind.in/1537

The Cake is a Lie

by Sebastian Bergmann on Jun 11, 2010

Accessibility

Categories

Tags

Upload Details

Usage Rights

2 Embeds 59

Statistics

The Cake is a Lie — Presentation Transcript

http://www.slideshare.net	53
http://www.insidephp.com	6