This is a cool utility that uses YSlow! and PhantomJS to measure your site's speed across many pages. Should be good for identifying slow individual pages as well as practices that impact multiple pages.

This is how it works: You feed it with a start URL and how deep you want it to crawl. The pages are fetched and all links within the same domain from that page are analyzed, and a couple of HTML pages are created with the result. Sounds simple?

From: Performance Calendar » Do you sitespeed?

Adam Culp posted the 3rd article in his Clean Development Series this week, Dirty Code (how to spot/smell it). When you read it, you should keep in mind that he is pointing out practices which correlate with poorly written code not prescribing a list of things to avoid. It's a good list of things to look for and engendered quite a discussion in our internal Musketeers IRC.

Comments are valuable

Using good names for variables, functions, and methods does make your code self commenting, but often times that is not sufficient. Writing good comments is an art, too many comments get in the way, but a lack of comments is just as bad. Code can be dense to parse where a comment will help you out. They also let you quickly scan through a longer code block, just skimming the comments, to find EXACTLY the bit you need to change/desbug/fix/etc. Of course, the latter you can also get by breaking up large blocks of code into functions.

Comments should not explain what the code does, but should capture the "why" of how you are solving a problem. For example, if you're looping over something a bad comment is "// loop through results", a good comment is "// loop through results and extract any image tags"

Using Switch Statements

You definitely should not take this item in his list to mean that "Switch statements are evil." You could have equally bad code if you use a long block of if/then/elseif statements. If you're using them within a class, you're better off using polymorphism, as he suggests, or maybe look at coding to an Interface instead of coding around multiple implementations.

Other code smells

In reviewing the article, I thought of other smells that indicate bad code. Some are minor, but if frequent, you know you're dealing with someone who knows little more than to copy-and-paste code from the Interwebs. These include:

• Error suppression with @. There are very, very, very few cases where its ok to suppress an error instead of handling the error or preventing it in the first place.
• Using globals directly. Anything in \$_GET, \$_POST, \$_REQUEST, \$_COOKIE should be filtered and validated before you use it. 'Nuff said
• Deep class hierarchy. A deep class hierarchy likely means you should be using composition instead of inheritance to change class behaviors.
• Lack of Prepared DB Statements. Building SQL queries as strings instead of using PDO or the mysqli extensions' prepared statements can open up sql injection vulnerabilities.
• Antiquated PHP Practices. A catch all for things we all did nearly a decade ago, includes depending on register globals being on, using "or die()" to catch errors, using the mysql_* functions. PHP has evolved, there's no reason for you not to evolve with it.

That's generally what I look for when evaluating code quality. What are some things I missed?

This past weekend, my colleague and friend Sandy Smith participated in Election Hackathon 2012 (read his take of the hackathon). We built our first public Musketeers.me product, Candidata.me. This was my first hackathon, and it was exciting and exhausting to bring something to life in little more than 24 hours. Our idea combined a number of APIs to produce a profile for every candidate running for President or Congress in the United States. The seed of the idea was good enough that we were chosen among 10 projects to present it to the group at large on Sunday afternoon.

Under the Hood and Hooking Up with APIs

We used our own PHP framework, Treb, as our foundation. It provides routing by convention, controllers, db acccess, caching, and a view layer. Along the way, we discovered a small bug in our db helper function that failed because of the nuances of autoloading.

I quickly wrote up a base class for making HTTP Get requests to REST APIs. The client uses PHPs native stream functions for making the HTTP requests, which I've found easier to work with than the cURL extension. The latter is a cubmersome wrapper to the cURL fucntionality.  

To be good API clients, we cached the request responses in Memcached between an hour to a month, depending on how often we anticipated the API response to change.

Sandy also took on the tedious - but not thankless - task of creating a list of all the candidates that we imported into a simpl Mysql table. For each candidate, we could then pull in information such as

• Polling data from Huffington Post's Pollster API, which we then plotted using jqplot. Polls weren't available for every race, so we had to manually match available polls to candidates.
• Basic Biographical information from govtrack.us. 
• Campaign Finance and Fact Checked statements from Washington Post's APIs.
• Latest News courtesy of search queries to NPR's Story Api.
• A simple GeoIP lookup on the homepage to populate the Congressional candidates when a user loads the page

Bootstrap for UI goodness.

I used this opportunity to check out Twitter's Bootstrap framework. It let us get a clean design from the start, and we were able to use its classes and responsive grid to make the site look really nice on tablets and smartphones too. I found it a lot more feature filled than Skeleton, which is just a responsive CSS framework and lacks the advanced UI elements like navigation, drop downs, modals found in Bootstrap.

Improvements that we could make

We've already talked about a number of features we could add or rework to make the site better. Of course, given the shelf life this app will have after November 6th, we may not get to some of these.

• Re-work the state navigation on the homepage so that it plays nice with the browser's history. We did a simple ajax query on load, but a better way to do it would be to change the hash to contain the state "http://candidata.us/#VA", and then pull in the list of candidates. This would also only initiate the geoip lookup if the hash is missing.
• Add a simple way to navigate to opponents from a candidate's page.
• Allow users to navigate to other state races from a candidate's page.
• Get more candidate information, ideally something that can provide us Photos of each candidate. Other apps at the hackathon had this, but we didn't find the API in time. Sunlight provides photos for Members of Congress.
• Pull in statements made by a candidate via WaPo's Issue API, maybe running it through the Trove API to pull out categories, people, and places mentioned in the statement.
• Use the Trove API to organize or at least tag latest news stories and fact checks by Category.

Overall, I'm very happy with what we were able to build in 24 hours. The hackathon also exposed me to some cool ideas and approaches, particularly the visualizations done by some teams. I wish I'd had spent a little more time meeting other people, but my energy was really focused on coding most of the time.

Please check out CandiData.me and let me know what you think either via email or in the comments below.