Ryan Jackson ryanwebjackson

Intention Revealing Methods

Intention revealing method is simple and yet I see it frequently slip through programmers' code. Developers don't like lengthy methods, or find it inconvenient to read through chubby if-else branches, and if they are nice enough they'll leave comments like those.

If we change spaces by underscores in the comments, delete the comment characters, and define the resulting methods in the same file (as private helpers for example), we get code that explains itself, instead of through verbose long methods, or human code comments which get stale.

Intention revealing methods is the most basic, no brain-teaser, easiest rule that I know. Combine it with Sandi Metz's rule of a maximum of 5 lines per method and you'll get simple code that explains itself, that is a pleasure to read, improving communication and productivity of the team (even when it's only yourself).

Sample Code

Working Effectively with Legacy Code

Notes by Jeremy W. Sherman, October 2013, based on:

Feathers, Michael. Working Effectively with Legacy Code. Sixth printing, July 2007.

Foreword:

Software systems degrade into a mess.
Requirements ALWAYS change.
Your goal as a software developer: Create designs that tolerate change.

Essential JavaScript Links

I no longer mantain this list. There are lots of other very comprehensive JavaScript link lists out there. Please see those, instead (Google "awesome JavaScript" for a start).

Quiz time!

What does the dot mean in in StringIO.new, what does the hash mean in StringIO#puts?
How do you make a String literal?
How do you make a String without using a literal?

This is an HTTP request, it is a String that is sent across a Socket, which your program can read from as if it were a file or $stdin.

01 POST /users/5?omg=wtf&amp;bbq=lol HTTP/1.1\r\n

	type BankAccount() =
	member val Balance = Option<float>.None with get, set

	member this.openAccount() =
	this.Balance <- Some 0.0
	this.Balance.Value

	member this.closeAccount() =
	this.Balance <- None

	#Development Machine v1.0b

	cmd START http://boxstarter.org/package/nr/url?https://gist.githubusercontent.com/ThaddParker/543228b70fdafcee8183/raw/640f03295ce3274f870ee6f1754e9c13c070f0a6/webdev1

	#create the Temp directory
	$checkDir = Test-Path -PathType Container Temp
	if($checkDir -eq $false){
	New-Item 'Temp' -type Directory
	}
	# create the projects directory

	<!DOCTYPE NETSCAPE-Bookmark-file-1>
	<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
	<!-- This is an automatically generated file.
	It will be read and overwritten.
	Do Not Edit! -->
	<TITLE>Bookmarks</TITLE>
	<H1>Bookmarks</H1>
	<DL><p>
	<DT><A HREF="https://developer.apple.com/library/mac/releasenotes/InterapplicationCommunication/RN-JavaScriptForAutomation/index.html#//apple_ref/doc/-%20uid/TP40014508" ADD_DATE="1414706885" PRIVATE="0" TAGS="javascript,mac,osx,yosemite">JavaScript for Automation Release Notes</A>
	<DD>This article describes JavaScript for Automation, a new feature in OS X Yosemite.

	/** server */
	var
	port = 3000,
	server = require('http').createServer(function (req, res) {
	res.writeHead(200, {'Content-Type': 'text/html'});
	res.end('<!DOCTYPE html>'.concat(
	'<html>',
	'<head>',
	'<script>(', client, ').call(this);</script>',
	'</head>',

	git stash
	git stash list
	git stash apply
	git stash drop