Jay McGavren's Journal

How a Head First author spends his days off

View on GitHub
2009-04-21

Just submitted a talk proposal for the next Desert Code Camp at DeVry on June 13:

Though many would argue it's far more elegant, Ruby was inspired in its early days in part by Perl. That heritage means it's an awesome environment for text parsing, file manipulation, and many other tedious daily chores faced by every developer on earth (and their Aunt Tillie, too). This session will cover some of the powerful features of the standard Ruby library - utilities that may already be installed on your Linux or OS X machine (and can easily be added to Windows). Learn to slice and dice files and directories, HTML, XML, shell commands, and more!

Read more...
2009-04-20

Bort with Rails 2.3, Authlogic, and Cucumber

We have a series of small new projects coming at work, and I hate project setup. We’d used Bort previously, but it uses Restful Authentication, and my boss was recommending Authlogic. I also didn’t want to have to set up Cucumber on five new code bases.

So, Git/GitHub being the wonderful platform it is, I forked the Bort repo and set to work:

Bort with Rails 2.3, Authlogic, and Cucumber

…I might have done better starting from scratch. Bits of Restful Auth kept disrupting my Authlogic setup, likewise Rails 2.2 code with 2.3.

But in the end I prevailed (I think). There may still be odd errors lurking in there. Those should be teased out by the many projects I hope to use it on, though.

Read more...
2009-04-18

QuickSilver Google search with 100 results per page...

Man, was this a pain to find. I’m assuming some proficiency with XML and Quicksilver here; leave a comment if you need more specific directions.

Install the Web Search module from the Quicksilver plugins pane if you haven’t already. Quit Quicksilver. Then edit this file:

~/Library/Caches/Quicksilver/Indexes/QSPresetDocWebSearches.qsindex

Search for:

<string>qss-http://www.google.com/search?hl=en&q=***</string>

And change it to:

<string>qss-http://www.google.com/search?hl=en&q=***&num=100</string>

Be sure you’ve got the “Google Search” entry; there are many similar ones. I originally edited the file while Quicksilver was running and had to quit and reload the catalog several times before I got it to stick. Your mileage may vary.

To test, bring up QS, type “Google Search”, tab twice, type your query, and press Return. Your default browser should load a Google Search with 100 results per page. You can of course make any other tweaks to this or any other search URL that your heart desires.

Read more...
2009-04-16

SVG...

I’m having way too much fun with the out-of-the-box SVG support in Firefox 3…

picture-18.png

Read more...
2009-04-15

“Filter Through Command” in your editor...

It’s SO nice to finally have an editor (TextMate) with a proper “filter selection through command…” command. I’ll never go back to an IDE without one.

For those not familiar, commands like this take the current selection and pipe it through a Unix command (shell scripts, Perl, Ruby, Python, etc. included), then replace the selection with the command’s output. So if you have this text in the open document:

foo
bar
baz

You can select it, choose Filter Through Command (Cmd-Option-R in Textmate), type “sort” (the Unix command) in the dialog that appears, and wind up with this:

bar
baz
foo

Read more...
2009-04-04

I shit you not...

Was sitting at a red light when I remembered that I needed to look into GitX (thanks for the tip, Byron and Andrew). So I commit a minor no-no and flip out my cell to send myself a voice-to-text note via jott.com. As I’m doing so, the cross-street’s light changes, and I step on the gas. That’s when I realize my light hasn’t changed.

Fortunately it was late at night, so there was no traffic to have an accident with. But I did find this message in my e-mail:

Jott Networks to Jay: Reminder. Computer research Getex(?). Wooh! Jesus!

Read more...
2009-03-29

Notes from Kernighan and Pike: The Practice of Programming...

Borrowed The Practice of Programming from the Gangplank library on Jade Meskill’s recommendation… It’s pretty C++ and Java-centric, but a lot of it is applicable to Ruby, and these notes were taken through Ruby-colored glasses.

Style:

Why 'waste time' on good coding style?  Once it becomes automatic, even code
you produce under pressure will be better.
Using long names regardless of context is a mistake: clarity is often achieved
through brevity.
"queue.queue_capacity" is redundant, "queue.capacity" is better.
The ?: operator is fine for short expressions where it can replace four lines
of if-else with one, but if full conditional statements make the code clearer,
use those.
If you work on a program you didn't write, preserve the style you find there.
The program's consistency is more important than your personal preference.
Learn your language's idioms.  Those with experience can read and write them
easily without mistakes.  And if there's a mistake in using the idiom, it's
usually easy to spot.
Sprawling code goes onto multiple pages/screens; scrolling reduces readability.
If there's no good logic to put as the default in case statements and if-elses,
throw an exception; it catches conditions that "can't happen".
On comments:
        Harmful comments:
                Don't restate what the code already clearly says.  (Carefully
                chosen names are better than comments.)
                Don't write comments unless you're sure they will be updated as
                the code changes.
        Good comments:
                Aid understanding of a program by briefly pointing out
                important details.
        A comment that introduces each function will speed comprehension when
        reading code.
        If the code uses an unfamiliar algorithm, consider referencing a
        document/URL/book the maintainer can read.
        Comment anything unusual or potentially confusing, but only after
        considering refactoring.


Design and Implementation:

"Show me your tables, and I won't usually need your flowcharts; they'll be
obvious." --Frederick P. Brooks, Jr., The Mythical Man-Month
Program design can be colored by the language used, but is usually not
dominated by it.
Issues to be worked out in a design:
        Interfaces: provide services that are uniform and convenient, without
        so much functionality as to be unwieldy.
        Information hiding: provide straightforward access to your components.
        Hide details of your implementation so they can be changed without
        affecting users.
        Resource management: is the user responsible for managing storage,
        memory, and other limited resources, or is the framework?
        Error handling: who detects errors, who reports them, and how?  What
        recovery is attempted?
Build a prototype for new systems.  It's not until you've built and used a
version of a program that you understand the issues well enough to get the
design right.

Read more...
2009-03-22

Diana got tickets for us and Mom to the Chihuly blown glass exhibition at the botanical garden… The artist is one of the few I know of that allows cameras into the exhibition, and shutterbugs came out of the woodwork for it. All 3 of us were armed with our own point-and-shoots (one on loan from Diana’s mom), and we fired off hundreds of shots between us until batteries started running out.

This one’s off my camera phone; the proper pictures will be posted later. Some will be going into a photo contest they’re running, and judging from the unimaginative entries in the gallery, we might actually have a chance.

chihuly-flames.jpg

Read more...
2009-03-16

MountainWest RubyConf - a travelogue...


Integrum at MountainWest RubyConf 2009 from Jay McGavren on Vimeo.

Read more...
2009-03-14

Notes from Jim Weirich - Building Blocks of Modularity...

Update 2009-05-05: Saw this talk again today at RailsConf and had a chance to fill in some missing pieces…

Is there a grand unified theory of software development?
Principles:
	SOLID
	Law of Demeter
		Method chains not good - only talk to objects in local environment.
	DRY
	Small Methods
	Design by Contract
Myer on Coupling: old, imperfect model that doesn't extend well to dynamic languages.  From best to worst:
	No coupling
	Data coupling
		Data local to two modules: simple data
	Stamp coupling
		Data local to two modules: structured data
	Control coupling
		Method usually has a "flag" parameter that controls which algorithm it uses
			ex: Array.instance_methods(true) #What does true mean?!
			ActiveRecord#find (:first, :all, etc.)
	External coupling
		Global data: simple data
	Common coupling
		Global data: structured data
	Content coupling
Connascence
	Things that are born together, and change together.  A change in one requires a corresponding change in the other.
	Originally applied to software by Meilir Page-Jones in early 90's.
Connascence of Name:
	class Customer
		def email; blah; end
	end
	def send_mail(customer)
		customer.email #Change Customer#email's name, you must update this call.
	end
Rule of Locality:
	Connascence of name between method parameter and a reference in the same method doesn't matter at all.
	Connascence of name between two separate libraries matters a lot.  It's why APIs must be frozen.
Connascence of Position:
	:orders => {"3" => "1", "5" => "2"}
	[ [ Order.find(3), true], [ Order.find(5), false ] ]
	Order of parameters decides behavior.
	Really bad:
		def process(order, expedite, confirmation_number, ...); blah; end
		[order, true, 2374]
		Easy to forget order of parameters, especially if you're passing 3, '
	Better:
		class OrderDisposition
			attr_reader :order
			attr_reader :expedite
			attr_reader :confirmation_number
		end
	Methods that take hash parameters are better than positional arguments, because each argument is labelled and can be re-ordered or omitted.
Degree matters:
	Some types of connascence are worse than others.
	Connascence of Name better than Connascence of Position.
Rule of Degree:
	Convert higher degrees of connascence into weaker forms.
		Example: refactor from positional method params to an options hash with named keys (CoP -> CoN).
Connascence of Meaning
	Consider "magic numbers" (these are bad):
		<input type="checkbox" value="2">
		if params[:med][id] == "2" #Have to do case-like statement in totally different module.
			@medication.given = false
		end
Contranascence
	Things conflicting with each other.  (Always in name?)
		#my_xml_lib
		module Kernel; def node; end; end
		#my_graph_lib
		module Kernel; def node; end; end #Conflict!
	Example is classes that must be namespaced to avoid conflict (XML::Node, YAML::Node)
Connascence of Algorithm:
	Logic repeated in multiple places - not DRY.
	Bad:
		def add_check_digit(digits); digits + ((10 - digits.foobar{|d| d + 5} % 10).to_s; end
		def check?(digits) check_sum(digits.foobar{|d| d + 5}) == 10; end
		Change digits.foobar{|d| d + 5} in one place, you must change it in both places.  Better not forget!
	Better:
		def add_check_digit(digits); digits + ((10 - foobar(digits) % 10).to_s; end
		def check?(digits) foobar(digits) == 10; end
		def foobar(digits); blah; end #Shared routine
		Change the shared routine, and you change the logic everywhere you need to.
Connascence of Timing
	Race conditions.
	Bad if called from multiple threads:
		def increment
			@amount += 1
		end
	Use Java-like synchronized declarations on methods to ensure they are thread-safe.
Connascence of Type
	See What Every Programmer Should Know About Object Oriented Design, Meilir Page-Jones
Connascence of Execution
	See What Every Programmer Should Know About Object Oriented Design, Meilir Page-Jones
Connascence of Value
	See What Every Programmer Should Know About Object Oriented Design, Meilir Page-Jones
Connascence of Identity
	See What Every Programmer Should Know About Object Oriented Design, Meilir Page-Jones

Read more...
Copyright © Jay McGavren.