mofo 0.1 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG +4 -0
- data/lib/microformat.rb +11 -1
- data/lib/microformat/simple.rb +21 -17
- data/lib/mofo/hentry.rb +1 -1
- data/lib/mofo/hreview.rb +0 -2
- data/lib/mofo/rel_tag.rb +0 -1
- data/tests/fixtures/bob.html +69 -0
- data/tests/fixtures/chowhound.html +1052 -0
- data/tests/fixtures/corkd.html +403 -0
- data/tests/fixtures/events.html +39 -0
- data/tests/fixtures/fake.html +1 -0
- data/tests/fixtures/fauxtank.html +535 -0
- data/tests/fixtures/hatom.html +1101 -0
- data/tests/fixtures/simple.html +5 -0
- data/tests/fixtures/upcoming.html +335 -0
- data/tests/format_test.rb +230 -0
- data/tests/hatom_test.rb +39 -0
- data/tests/test_helper.rb +6 -0
- data/tests/xoxo_test.rb +49 -0
- data/vendor/testspec-0.2.0/ChangeLog +120 -0
- data/vendor/testspec-0.2.0/README +206 -0
- data/vendor/testspec-0.2.0/ROADMAP +3 -0
- data/vendor/testspec-0.2.0/Rakefile +86 -0
- data/vendor/testspec-0.2.0/SPECS +101 -0
- data/vendor/testspec-0.2.0/TODO +1 -0
- data/vendor/testspec-0.2.0/bin/specrb +103 -0
- data/vendor/testspec-0.2.0/examples/stack.rb +38 -0
- data/vendor/testspec-0.2.0/examples/stack_spec.rb +119 -0
- data/vendor/testspec-0.2.0/lib/test/spec.rb +366 -0
- data/vendor/testspec-0.2.0/lib/test/spec/dox.rb +114 -0
- data/vendor/testspec-0.2.0/lib/test/spec/rdox.rb +25 -0
- data/vendor/testspec-0.2.0/lib/test/spec/should-output.rb +48 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Kernel.html +105 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Object.html +154 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Test/Spec.html +132 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Test/Spec/DefinitionError.html +111 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Test/Spec/Should.html +863 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Test/Spec/ShouldNot.html +411 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Test/Spec/TestCase.html +220 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Test/Spec/TestCase/ClassMethods.html +290 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Test/Spec/TestCase/InstanceMethods.html +195 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Test/Unit/UI/RDox/TestRunner.html +222 -0
- data/vendor/testspec-0.2.0/rdoc/classes/Test/Unit/UI/SpecDox/TestRunner.html +468 -0
- data/vendor/testspec-0.2.0/rdoc/created.rid +1 -0
- data/vendor/testspec-0.2.0/rdoc/files/README.html +409 -0
- data/vendor/testspec-0.2.0/rdoc/files/ROADMAP.html +112 -0
- data/vendor/testspec-0.2.0/rdoc/files/SPECS.html +365 -0
- data/vendor/testspec-0.2.0/rdoc/files/lib/test/spec/dox_rb.html +108 -0
- data/vendor/testspec-0.2.0/rdoc/files/lib/test/spec/rdox_rb.html +108 -0
- data/vendor/testspec-0.2.0/rdoc/files/lib/test/spec/should-output_rb.html +114 -0
- data/vendor/testspec-0.2.0/rdoc/files/lib/test/spec_rb.html +123 -0
- data/vendor/testspec-0.2.0/rdoc/fr_class_index.html +37 -0
- data/vendor/testspec-0.2.0/rdoc/fr_file_index.html +33 -0
- data/vendor/testspec-0.2.0/rdoc/fr_method_index.html +95 -0
- data/vendor/testspec-0.2.0/rdoc/index.html +24 -0
- data/vendor/testspec-0.2.0/rdoc/rdoc-style.css +208 -0
- data/vendor/testspec-0.2.0/test/spec_dox.rb +39 -0
- data/vendor/testspec-0.2.0/test/spec_flexmock.rb +210 -0
- data/vendor/testspec-0.2.0/test/spec_mocha.rb +118 -0
- data/vendor/testspec-0.2.0/test/spec_nestedcontexts.rb +26 -0
- data/vendor/testspec-0.2.0/test/spec_should-output.rb +26 -0
- data/vendor/testspec-0.2.0/test/spec_testspec.rb +311 -0
- data/vendor/testspec-0.2.0/test/spec_testspec_order.rb +26 -0
- data/vendor/testspec-0.2.0/test/test_testunit.rb +21 -0
- metadata +81 -2
|
@@ -0,0 +1,1101 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
2
|
+
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
3
|
+
<head>
|
|
4
|
+
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
5
|
+
<title>err.the_blog</title>
|
|
6
|
+
<link href="/stylesheets/theme/milehigh.css?1162801438" media="screen" rel="Stylesheet" type="text/css" />
|
|
7
|
+
<link href="/stylesheets/theme/lightbox.css?1162801438" media="screen" rel="Stylesheet" type="text/css" />
|
|
8
|
+
<script src="/javascripts/prototype.js?1162801438" type="text/javascript"></script>
|
|
9
|
+
<script src="/javascripts/theme/application.js?1162801438" type="text/javascript"></script>
|
|
10
|
+
<script src="/javascripts/theme/lightbox.js?1162801438" type="text/javascript"></script>
|
|
11
|
+
<script src="/javascripts/effects.js?1162801438" type="text/javascript"></script>
|
|
12
|
+
<link href="http://feeds.feedburner.com/errtheblog" rel="alternate" title="Err the Blog Atom Feed" type="application/atom+xml" />
|
|
13
|
+
</head>
|
|
14
|
+
|
|
15
|
+
<body>
|
|
16
|
+
<div id="wrap">
|
|
17
|
+
|
|
18
|
+
<div id="header">
|
|
19
|
+
<div class="feed">
|
|
20
|
+
<a href="http://feeds.feedburner.com/errtheblog">
|
|
21
|
+
<img src="/images/theme/feed.png" alt="Err the Blog Atom Feed Icon" />
|
|
22
|
+
</a>
|
|
23
|
+
</div>
|
|
24
|
+
<div class="logo">
|
|
25
|
+
<a href="/" class="reverse">Err the Blog</a>
|
|
26
|
+
</div>
|
|
27
|
+
<div style="float:right">
|
|
28
|
+
<a href="http://feeds.feedburner.com/errtheblog"><img src="http://feeds.feedburner.com/~fc/errtheblog?bg=ED1166&fg=FFFFFF&anim=0" height="26" width="88" style="border:0" alt="" /></a>
|
|
29
|
+
|
|
30
|
+
</div>
|
|
31
|
+
<div class="sub">
|
|
32
|
+
Rubyisms and Railities
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<ul id="post-list">
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
<li class="post-li hentry">
|
|
42
|
+
<div class="sidebar">
|
|
43
|
+
|
|
44
|
+
<div class="title entry-title">“<a href="/post/13" class="reverse" rel="bookmark">A Rails Toolbox</a>”</div>
|
|
45
|
+
<div class="secondary byline">– <span class="author vcard fn">Chris</span> on <span class="published" title="Tue Oct 17 01:45:00 PDT 2006">October 17th, 2006</span></div>
|
|
46
|
+
|
|
47
|
+
<br/>
|
|
48
|
+
<div class="secondary tags">
|
|
49
|
+
This post is tagged with <a href="/tag/rails" class="tag-link" rel="tag">rails</a>.<br/>
|
|
50
|
+
This post is tagged with <a href="/tag/ruby" class="tag-link" rel="tag">ruby</a>.<br/>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
It has <a href="/post/13">one comment</a>
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div class="main entry-content">
|
|
61
|
+
|
|
62
|
+
<p>We’ve been finished with <a href='http://www.chow.com'>Chow</a> for about a month now, and that’s cool. (<a href='http://www.pjhyett.com/articles/2006/09/19/chow-com-has-launched'>PJ</a> wrote about the launch back in the day.) The site is stable and it’s our second from-scratch Rails site at <span class='caps'>CNET</span>, the first being <a href='http://www.chowhound.com/'>Chowhound</a>. Party time, right? <a href='http://flickr.com/photos/itsolivia/266719647/in/set-72157594322703108/'>Right</a>.</p>
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
<p>Since it seems like we did <em>something</em> correct, I’d like to share with you our toolbox. We have no <a href='http://en.wikipedia.org/wiki/Golden_hammer'>golden hammer</a>, but we sure use some kickass open source software. This is just a high level overview, but who knows? Maybe a hammer or tape measure you find within will be new and useful to you. I can only hope.</p>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
<div align='center'><img src='http://errtheblog.com/static/images/pink-toolbox.jpg' alt='tools!' /></div>
|
|
69
|
+
|
|
70
|
+
<h3>Servers</h3>
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<p>The muscle, scar tissue, and bone running our site are nothing unusual. Rails convention: a hardware load balancer to Apache 2.0 to Pen to a cluster of Mongrels. Coda Hale has an infamous <a href='http://blog.codahale.com/2006/06/19/time-for-a-grown-up-server-rails-mongrel-apache-capistrano-and-you/'>tutorial</a> on setting up a similar architecture and Zed maintains a <a href='http://mongrel.rubyforge.org/docs/index.html'>stellar documentation</a> page over at the Mongrel site. We have had very few problems with Mongrel and Pen is so quiet that I often forget it exists.</p>
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<p>Behind the backend we run an installation of <a href='http://incubator.apache.org/solr/'>Solr</a> as our search engine. It’s Java, but a nice <span class='caps'>XML</span>-RPC <span class='caps'>API</span> helps alleviate the pain. A dedicated <a href='http://wiki.apache.org/solr/SolRuby'>wiki page</a> is available with Ruby help (which you probably won’t need). A cron or two is needed to insert items into the index, mind you.</p>
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<p>We (of course) run <a href='http://www.danga.com/memcached/'>memcached</a> and use it to cache tons of data. This helps keep our site speedy and takes the load off our largeish database. In case you missed it, <a href='http://errtheblog.com/post/27'>a previous Err post</a> touches on memcached. It’s a lot easier to use than you might think.</p>
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
<p>Finally, we use MySQL for our database. Big surprise there.</p>
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
<h3>Deployment</h3>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<p>Like any red blooded America, we use Capistrano for deployment. There’s really no other option. The <a href='http://groups.google.com/group/capistrano'>mailing list</a> is invaluable, as are the <a href='http://del.icio.us/popular/capistrano'>various tidbits</a> scattered across the internet. There’s even a great <a href='http://cheat.errtheblog.com/s/capistrano/'>cheat sheet</a>.</p>
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
<p>We also use <a href='http://www.tildeslash.com/monit/'>monit</a> to handle our production environment. monit is a nice program which provides a web interface for monitoring your apps. It will restart troubled processes and e-mail you when trouble arises. On top of that, it can also watch to make sure daemons don’t take up too much <span class='caps'>CPU</span> or memory and kill them when they do. It uses a nice little <span class='caps'>DSL</span> for its config files and, as long as you have a pid file, is easy to get up and running with. There’s a nice starter <a href='http://pastie.caboo.se/13355'>monit config file here</a> and plenty of resources out there. monit can even replace <a href='http://p.caboo.se/17981'>mongrel cluster</a>. Highly recommended.</p>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<h3>Plugins</h3>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<p>Okay, we use a lot of plugins. I’m going to make this a bullet list. Just pretend it’s a PowerPoint presentation and it should seem more familiar. Er, on second though, don’t.</p>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<h4><a href='http://errtheblog.com/post/27'>acts_as_cached</a></h4>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
<p>Already mentioned further up, we use memcached to cache many database queries. This plugin supports model caching, session caching, and fragment caching out of the box. A simply <span class='code'>memcached.yml</span> is added to our <span class='code'>config/</span> directory and we can forget about it. The <span class='code'><span class='caps'>README</span></span> file provides a wealth of common idioms and a <a href='http://groups.google.com/group/acts_as_cached'>mailing list</a> keeps patches (and bug reports) flowing. Essential.</p>
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<h4><a href='http://blog.talbott.ws/articles/2006/05/17/querytrace-my-first-official-rails-plugin'>query_trace</a></h4>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<p>Completely essential. This plugin attaches a short backtrace to every <span class='caps'>SQL</span> query in your log files. The first time I heard this I thought, ‘so what?’ Well it’s a big deal. Suddenly you know <em>exactly</em> what is going on with your ActiveRecord code—you know the exact line number from which queries are being spawned. When you’re trying to cache everything using memcached, this goes a huge way in helping you lock down your database.</p>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<h4><a href='http://dev.rubyonrails.org/svn/rails/plugins/exception_notification/'>exception_notification</a></h4>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
<p>Again, essential. E-mails us whenever an exception is raised on the site. Some days I just gather up the exceptions in my Inbox and bang away on those bugs for an hour or two. No more e-mails. It’s very gratifying. Best part is, you can control whether certain exceptions show a 500 or a 404, and you can even set the prefix of the e-mails you receive. For instance, I can set the e-mail prefixes then setup mailbox filters to have all the e-mails prefixed with <span class='code'>[CHOW]</span> go to my Inbox and all the e-mails prefixed with <span class='code'>[CHOWHOUND]</span> go into my trash can. Very slick.</p>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<h4><a href='http://errtheblog.com/post/14'>acts_as_textiled</a></h4>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<p>The first ‘official’ plugin extracted from our work, acts_as_textiled lets us forget about rendering <a href='http://www.textism.com/tools/textile/'>Textile</a>. Instead of having to ask ‘should I render Textile?’, the question becomes ‘should I not render Textile?’ If a story description uses Textile, we always want it rendered—except in special circumstances. It’s nice to not have to use the <span class='code'>textile</span> helper all over our app and instead focus on things that matter. Like pastels.</p>
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
<h4><a href='http://acts-as-solr.rubyforge.org/'>acts_as_solr</a></h4>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
<p>This is a bit of a white lie. We’re currently using a plugin PJ rolled called ‘acts_as_indexed,’ but he is in the process of transferring our stuffs over to acts_as_solr. It’s a fine piece of work and written by people who know Lucence (and solr) inside and out. One of those dudes even wrote a book, I hear.</p>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
<h4><a href='http://www.realityforge.org/articles/2006/03/20/rails-plugin-to-help-debug-views'>debug_view_helpers</a></h4>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<p>This is a real life saver. If you’ve ever used <a href='http://smarty.php.net'>Smarty</a>, you know how great that ‘debug’ window is that pops up. There’s no ambiguity for your <span class='caps'>CSS</span> people: all the available variables are shown right there in a pop-up window. We installed this plugin and set the ‘debug’ link to appear a) in development mode b) if you’re on the <span class='caps'>VPN</span>. That means, even in production mode, authorized elite personnel can always see the variables available to the view. So awesome for debugging. (Plus it means I don’t have to talk to our <span class='caps'>CSS</span> guy, Todd, so much. He is weird.)</p>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<h4><a href='http://blog.evanweaver.com/articles/2006/06/02/has_many_polymorphs'>has_many_polymorphs</a></h4>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<p><a href='http://1vy.org'>Evan Weaver’s</a> crazy plugin lets us forget about all the black magic we learned from <a href='http://blog.hasmanythrough.com'>Josh Susser</a>. Little o’ this:</p>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<pre class='ruby'>
|
|
143
|
+
<span class='keyword'>class </span><span class='class'>Tag</span> <span class='punct'><</span> <span class='constant'>ActiveRecord</span><span class='punct'>::</span><span class='constant'>Base</span>
|
|
144
|
+
<span class='ident'>has_many_polymorphs</span> <span class='symbol'>:tagged_things</span><span class='punct'>,</span> <span class='symbol'>:from</span> <span class='punct'>=></span> <span class='punct'>[</span><span class='symbol'>:posts</span><span class='punct'>,</span> <span class='symbol'>:files</span><span class='punct'>,</span> <span class='symbol'>:tags</span><span class='punct'>]</span>
|
|
145
|
+
<span class='keyword'>end</span>
|
|
146
|
+
</pre>
|
|
147
|
+
|
|
148
|
+
<p>Yup. Very nice. Also lets you do <span class='code'>Tag.find(:all, :include => :tagged_things)</span> and fetches the result in <strong>one</strong> query. That is, if you’re using MySQL or Postgres.</p>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
<h4><a href='http://svn.vivabit.net/external/rubylibs/request_routing/'>request_routing</a></h4>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<p>Hey, check out this code:</p>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<pre class='ruby'>
|
|
158
|
+
<span class='ident'>map</span><span class='punct'>.</span><span class='ident'>connect</span> <span class='punct'>'</span><span class='string'></span><span class='punct'>',</span> <span class='symbol'>:controller</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>mobile</span><span class='punct'>',</span> <span class='symbol'>:conditions</span> <span class='punct'>=></span> <span class='punct'>{</span> <span class='symbol'>:subdomain</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>m</span><span class='punct'>'</span> <span class='punct'>}</span>
|
|
159
|
+
</pre>
|
|
160
|
+
|
|
161
|
+
<p>Can you believe that’s not in core? It’s so great, and thanks to the request_routing plugin we’re able to use it for <a href='http://m.chow.com'>Chow’s mobile site</a>. Plus, <a href='http://www.danwebb.net/'>Dan Webb’s blog is hot</a>. There. I said it.</p>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
<h4><a href='http://blog.craigambrose.com/articles/2006/08/16/redbox-a-rails-compatible-lightbox'>redbox</a></h4>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<p>You just have to see it for yourself. Real nice code which lets you pull off that whole ‘lightbox dialog’ thing. We’re using it for the ‘E-mail to a Friend’ links. Nice.</p>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<h4><a href='http://julik.textdriven.com/svn/tools/rails_plugins/unicode_hacks/'>unicode_hacks</a></h4>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<p>Right now, Unicode seems to fall down when you need to pattern match against it or do any sort of manipulation. Lucky for us we just do input and output. Until the new Rails hits the streets, we rely on the unicode_hacks plugin to get those crazy characters in and out of our database correctly.</p>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<h4><a href='http://dev.rubyonrails.org/svn/rails/plugins/browser_filters/'>browser_filters</a></h4>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
<p>Safari crashing randomly? We (correctly) suspected Unicode. This Super Official Rails Plugin solved our problems and may solve yours. Also provides a few more fixes and tweaks.</p>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<h4><a href='http://errtheblog.com/post/16'>composite_migrations</a></h4>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
<p>Yes, we’re crazy enough to use composite primary keys. That’s just the way some of us were raised. This home rolled plugin allows us to create the dastardly fellows in a migration so that we may use the <a href='http://compositekeys.rubyforge.org'>composite primary key gem</a> freely and openly in our code. Hey, we’ve got <a href='http://www.pjhyett.com/articles/2006/08/26/composite-primary-keys-are-good'>opinions</a>, too.</p>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<h3>Libraries</h3>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<p>First and foremost, <a href='http://code.whytheluckystiff.net/hpricot/'>hpricot</a> is an amazing invention and a huge help. Scraping and parsing <span class='caps'>HTML</span>/XML isn’t something we think twice about anymore. We use hpricot on more than <span class='caps'>XML</span> import feed because it’s just so damn easy. If you’ve never given it a shot, I recommend <a href='http://errtheblog.com/post/32'>trying it</a> soon.</p>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<p>Both <a href='http://magicmodels.rubyforge.org/'>Dr Nic’s Magic Models</a> and <a href='http://code.whytheluckystiff.net/camping/'>Camping</a> are used by us to prototype all sorts of ideas and internal tools. Some of our top secret monitoring tools run using a combination of the two. Being fluent in Camping, and knowing some <a href='http://errtheblog.com/post/19'>tricks to get it working with Magic Models</a>, is a must.</p>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<p><a href='http://rfuzz.rubyforge.org/'>RFuzz</a>, available as a standard Ruby gem, is a library which makes it trivial to test web sites. We run periodic RFuzz tests against our live sites to make sure they’re alive, bullet proof, and speedy. The tests run just like unit tests and help us feel that much better about our babies. During the big <a href='http://weblog.rubyonrails.org/2006/8/10/rails-1-1-6-backports-and-full-disclosure'>security fiasco</a> RFuzz was instrumental, and since I’ve fallen in love.</p>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<p>When it comes to testing, nothing gives me more pleasure than <a href='http://glu.ttono.us/articles/2006/08/22/colorize-your-tests'>color</a>. Thanks to <a href='http://on-ruby.blogspot.com/'>Pat Eyler</a>, the <a href='http://errtheblog.com/post/15'>redgreen</a> gem makes all those little repetitive dots that much more bearable.</p>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<p>Use <a href='http://nubyonrails.com/articles/2006/04/19/autotest-rails'>autotest</a>. It takes your mind off the testing and lets you focus on the tests.</p>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<p><a href='http://fastercsv.rubyforge.org/'>FasterCSV</a> is a gem you can get from the standard repository. One of our data feeds is delivered as Excel, which is basically completely useless. So we export it to <span class='caps'>CSV</span> then import it with FasterCSV, which can nail about 5000 records in 2 seconds. Awesome.</p>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<p><a href='http://mocha.rubyforge.org/'>Mocha</a> is a library for stubbing and mocking tests. Because of it, I’ve slowly been moving over to a fixture-less state of mind. There’s all sorts of <a href='http://glu.ttono.us/articles/2006/09/01/the-flexibility-of-mocha'>information out there</a> on using Mocha, so dive right in.</p>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<p>First made known to me by <a href='http://weblog.techno-weenie.net/'>technoweenie</a>, <a href='http://piston.rubyforge.org/'>Piston</a> is an incredible tool for managing Rails plugins. We had troubles when deploying with svn:externals set: our server would try to make too many connections to the external <span class='caps'>SVN</span> server too quickly. As a result, the connections would die and the deploy would fail. Piston solved this issue: we can keep plugins in our local repository and sync them up with their remote repository whenever we want. So far it’s been working out wonderfully, and so easy! If you haven’t started yet, get on the Piston bandwagon immediately.</p>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<h3>Editing</h3>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<p>Sorry, I admit it: I’m not a TextMate guy. Sure, I’m writing this post in TextMate, but I still prefer vim for coding. I know there’s at least one duder out there who can side with me. For that one guy (you know who you are), here’s a few classy vim links: the <a href='http://wiki.rubygarden.org/Ruby/page/show/VimRubySupport'>wiki page</a>, <a href='http://vim-ruby.rubyforge.org/'>the gem</a>, <a href='http://www.vim.org/scripts/script.php?script_id=1567'>the Rails plugin</a>, and <a href='http://www.vim.org/scripts/script.php?script_id=164'>the html-macros plugin</a>. All essential.</p>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<h3>Outliers</h3>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<p>Like everyone else, we use Subversion and Trac to manage our source code and tickets. We also use <a href='http://habtm.com/articles/2006/04/14/meet-marshmallow-the-campfire-bot'>Marshmallow</a> and a polling Ruby process to notify us of changes to Subversion. It’s helpful to see the commits in Campfire because they’re always there, whether you are or not.</p>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<p>We recently started using <a href='http://crazyegg.com/'>Crazy Egg</a> to check out clicks on our site and wow wow wow. <a href='http://weblog.rubyonrails.org/2006/9/8/crazy-egg-is-crazy-cool-and-on-rails'>Everyone</a> has <a href='http://photomatt.net/2006/09/15/crazy-egg/'>already</a> talked about it, but I suggest trying it out. So easy, and it gives you an entirely new perspective on your site.</p>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<h3>Hammers and Tape</h3>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<p>So that’s my toolbox. Maybe I missed a few screws or rulers, sure, but you get the general idea. Have any really great levels you want to share? Hit me in the comments.</p>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<div id="first"></div>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</div>
|
|
240
|
+
</li>
|
|
241
|
+
<li class="post-li hentry">
|
|
242
|
+
<div class="sidebar">
|
|
243
|
+
|
|
244
|
+
<div class="title entry-title">“<a href="/post/12" class="reverse" rel="bookmark">Cheat Again!</a>”</div>
|
|
245
|
+
<div class="secondary byline">– <span class="entry-author">admin</span> on <span class="published" title="Sun Oct 15 21:14:00 PDT 2006">October 15th, 2006</span></div>
|
|
246
|
+
|
|
247
|
+
<br/>
|
|
248
|
+
<div class="secondary tags">
|
|
249
|
+
This post is tagged with <a href="/tag/ruby" class="tag-link" rel="tag">ruby</a>.<br/>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
It has <a href="/post/12">zero comments</a>
|
|
253
|
+
|
|
254
|
+
</div>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
</div>
|
|
258
|
+
|
|
259
|
+
<div class="main entry-content">
|
|
260
|
+
|
|
261
|
+
<p>It wasn’t <a href='http://errtheblog.com/post/23'>so long ago</a> that <a href='http://cheat.errtheblog.com'>Cheat!</a> was loosed upon the world. We started with five (5) sheets. That’s one hand. Hold up one hand. We now have forty-two (42). That’s eight hands and two fingers. Hold up eight hands and then another hand, but only put up two fingers on the ninth hand. Ha! You can’t! That’s not nearly possible.</p>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<div align='center' style='padding-bottom:10px;'><img src='http://errtheblog.com/static/images/42.png' alt='forty two' /></div>
|
|
265
|
+
|
|
266
|
+
<p>Today marks the proud release of Cheat 1.1.0. A few things have changed, but don’t let that get in your way. Upgrade immediately:</p>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
<p><span class='code'>$ sudo gem update cheat</span></p>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<p>or</p>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<p><span class='code'>$ sudo gem install cheat</span></p>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
<h3>Command Line Editing</h3>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<p>This is the real big change. It separates the men from the boys, the 1.1.0s from the 1.0.3s, etc. You can now edit and create cheat sheets straight from the command line.</p>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<p>Edit the <span class='code'>rjs</span> cheat sheet:</p>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
<p><span class='code'>$ cheat rjs --edit</span></p>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<p>Create the <span class='code'>nonsense</span> cheat sheet:</p>
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
<p><span class='code'>$ cheat nonsense --add</span></p>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<p>By default, Cheat will try to use your <span class='code'><span class='caps'>VISUAL</span></span> or <span class='code'><span class='caps'>EDITOR</span></span> environment variable to determine which editor to launch. If it can’t find either variable, it tries to launch <span class='code'>vim</span>.</p>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<p>To edit using TextMate:</p>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<p><span class='code'>$ export <span class='caps'>VISUAL</span>=’mate -w’</span></p>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<p>Go ahead and stick that in <span class='code'>.bashrc</span> or whatever init script your shell uses to ensure <span class='code'>$ cheat --edit</span> and <span class='code'>$ cheat --add</span> always use TextMate.</p>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
<p>Windows users: this new functionality could use some testing, bugfixing, and patching. All I knows is it works on <span class='caps'>POSIX</span>.</p>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
<p>One million thanks to the mysterious commenter known only as <em>nornagon</em> who submitted the patch. Who is this phantom coder?</p>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
<h3>Tabbin’ Around</h3>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
<p>King of bash <a href='http://kevinmarsh.com/'>Kevin Marsh</a>, perhaps inspired by a bit of past <a href='http://errtheblog.com/post/33'>rakery</a>, conjured some tab completion magic for Cheat.</p>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<pre class='ruby'>
|
|
321
|
+
<span class='comment'># Cache, and complete, Cheats</span>
|
|
322
|
+
<span class='keyword'>if</span> <span class='punct'>[</span> <span class='punct'>!</span> <span class='punct'>-</span><span class='ident'>r</span> ~<span class='punct'>/.</span><span class='ident'>cheats</span> <span class='punct'>]</span> <span class='punct'>|</span> <span class='punct'>[[</span> <span class='punct'>!</span> <span class='punct'>"</span><span class='string'></span><span class='punct'>"</span> <span class='punct'>==</span> `<span class='ident'>find</span> ~ <span class='punct'>'</span><span class='string'>.cheats</span><span class='punct'>'</span> <span class='punct'>-</span><span class='ident'>ctime</span> <span class='number'>1</span> <span class='punct'>-</span><span class='ident'>maxdepth</span> <span class='number'>0`</span> <span class='punct'>]];</span> <span class='keyword'>then</span>
|
|
323
|
+
<span class='ident'>echo</span> <span class='punct'>"</span><span class='string'>Rebuilding Cheat cache... </span><span class='punct'>"</span>
|
|
324
|
+
<span class='ident'>cheat</span> <span class='ident'>sheets</span> <span class='punct'>|</span> <span class='ident'>egrep</span> <span class='punct'>'</span><span class='string'>^ </span><span class='punct'>'</span> <span class='punct'>|</span> <span class='ident'>awk</span> <span class='punct'>{'</span><span class='string'>print $1</span><span class='punct'>'}</span> <span class='punct'>></span> ~<span class='punct'>/</span><span class='regex'>.cheats
|
|
325
|
+
fi
|
|
326
|
+
complete -W "$(cat ~</span><span class='punct'>/.</span><span class='ident'>cheats</span><span class='punct'>)"</span><span class='string'> cheat<span class='normal'>
|
|
327
|
+
</span></span></pre>
|
|
328
|
+
|
|
329
|
+
<p>POSIXers can stick that in your <span class='code'>.bashrc</span> (or wherever) and enjoy sweet, sweet tab completion. Go ahead and try it: restart you shell then do <span class='code'>$ cheat m<TAB></span>. You should see a glorious list of sheets.</p>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<p>Thanks to <a href='http://blog.evanweaver.com/'>Evan</a>, the tab completion list will refresh itself every day.</p>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
<h3>Printing</h3>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<p>Once again in the news, up-and-coming all star <a href='http://kevinmarsh.com/'>Kevin Marsh</a> fandangled a print style sheet for our lovely cheat sheets. There’s nothing to it: surf to a cheat sheet and hit ‘print.’ Like normal.</p>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
<div align='center' style='padding-bottom:10px;'><a href='http://static.flickr.com/115/270713374_bc55eae133_b.jpg'><img src='http://static.flickr.com/115/270713374_bc55eae133_m.jpg' alt='print' /></a></div>
|
|
342
|
+
|
|
343
|
+
<p>That totally defeats the purpose, but I don’t care. Print away!</p>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<h3>Captcha</h3>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<p>Using Andreas Schwarz’s <a href='http://captchator.ruby-forum.com/'>Captchator</a> web service, the <a href='http://captchator.ruby-forum.com/'>Cheat wiki</a> now has a <a href='http://en.wikipedia.org/wiki/Captcha'>captcha</a>. The damn spammers kept reverting and messing with sheets so, for now, this seems the best solution (next to the other solution I’ll talk about in a second).</p>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
<div align='center' style='padding-bottom:10px;'><img src='http://errtheblog.com/static/images/cheat-captcha.jpg' alt='captcha' /></div>
|
|
353
|
+
|
|
354
|
+
<p>It shouldn’t really get in your way all that much. Let me know if it does. Hats off to Andreas for the simple service.</p>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<h3>Remember!</h3>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
<p>We still have TextMate and jEdit integration, among other tricks, at the original <a href='http://errtheblog.com/post/23'>Cheat post</a>. And then there’s the <a href='http://feeds.feedburner.com/cheatsheets'><span class='caps'>RSS</span> feed</a>, too.</p>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
<div align='center' style='padding-bottom:10px;'><a href='http://feeds.feedburner.com/cheatsheets'><img src='http://errtheblog.com/static/images/cheat-rss.jpg' alt='rss' /></a></div>
|
|
364
|
+
|
|
365
|
+
<p>As always, it’s never too late to <a href='http://drnicwilliams.com/2006/09/03/100s-cheatsheets-for-ruby-and-rails/'>write about</a> or <a href='http://www.bloggingmyassoff.com/articles/2006/10/14/its-cheating-everyone'>contribute to</a> <a href='http://cheat.errtheblog.com'>Cheat</a>. You might think this is an ego thing, but it’s not: the more cheat sheets everyone makes, the easier all our lives become. What would you rather be doing, drinking tequila on a secluded Mexican beach or slaving away in your cubicle? That’s what I thought. Get to work.</p>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
</div>
|
|
370
|
+
</li>
|
|
371
|
+
<li class="post-li hentry">
|
|
372
|
+
<div class="sidebar">
|
|
373
|
+
|
|
374
|
+
<div class="title entry-title">“<a href="/post/11" class="reverse" rel="bookmark">Rake Around MySQL</a>”</div>
|
|
375
|
+
<div class="secondary byline">– <span class="entry-author">admin</span> on <span class="published" title="Sat Oct 14 18:39:00 PDT 2006">October 14th, 2006</span></div>
|
|
376
|
+
|
|
377
|
+
<br/>
|
|
378
|
+
<div class="secondary tags">
|
|
379
|
+
This post is tagged with <a href="/tag/rails" class="tag-link" rel="tag">rails</a>.<br/>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
It has <a href="/post/11">zero comments</a>
|
|
383
|
+
|
|
384
|
+
</div>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
</div>
|
|
388
|
+
|
|
389
|
+
<div class="main entry-content">
|
|
390
|
+
|
|
391
|
+
<p>In the <a href='http://en.wikipedia.org/wiki/Greek_Dark_Ages'>dark ages</a> of web programming, we’d write various Perl, <span class='caps'>PHP</span>, and shell scripts to maintain our application. Something to clean up the sessions, something to send out our newsletter every night, something to rename files en masse. We’d scatter them throughout our directory tree, like ninja stars thrown blindly at that old hickory down by the river. Then, one day, the brash new kid up and duplicates all of them on his own because he has no idea they exist. How could he?! We have no one to blame but ourselves.</p>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<p>Fortunately, this is the <a href='http://en.wikipedia.org/wiki/Renaissance_in_the_Netherlands'>renaissance</a>. We have <a href='http://rake.rubyforge.org/'>Rake</a>. Aside from <a href='http://svn.techno-weenie.net/projects/plugins/gems/README'>freezing gems</a>, <a href='http://blog.unquiet.net/archives/2005/11/06/helpful-rake-tasks-for-using-rails-with-subversion/'>managing Subversion</a>, and <a href='http://errtheblog.com/post/3'>rake remigrating</a>, we can also use Rake to help make our shellin’ lives easier.</p>
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
<p>While you probably use a gooey to manhandle your database (I fancy <a href='http://yoursql.ludit.it/'>YourSQL</a>), sometimes you just need to hit the <span class='code'>mysql</span> shell and hit it hard. For those occasions I really want to not worry about the host, port, or showing my credentials. I just want to shell in and get on with my business. Something like <span class='code'>$ rake production mysql</span> would be nice.</p>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<p>Two steps, here they are.</p>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
<h3>environments.rake</h3>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<p>So, you can chain rake tasks. Run <span class='code'>$ rake task1 task2</span> and the tasks will be executed in that order. As a result, I want to create some environment tasks which set the <span class='code'><span class='caps'>RAILS</span>_ENV</span> for me. That way I can <span class='code'>$ rake production migrate</span> instead of having to <span class='code'>$ rake migrate <span class='caps'>RAILS</span>_ENV=production</span>. I switch environments so much that this little nicety is worth it. And it has another advantage, which I’ll tell you about later.</p>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<p>Anyway, define a task for each of your environments and slip them into something like, say, <span class='code'><span class='caps'>RAILS</span>_ROOT/lib/tasks/environments.rake</span>.</p>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<p>Here’s my <span class='code'>environments.rake</span>:</p>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
<pre class='ruby'>
|
|
416
|
+
<span class='ident'>desc</span> <span class='punct'>"</span><span class='string'>Runs the following task in the development environment</span><span class='punct'>"</span>
|
|
417
|
+
<span class='ident'>task</span> <span class='symbol'>:development</span> <span class='keyword'>do</span>
|
|
418
|
+
<span class='constant'>RAILS_ENV</span> <span class='punct'>=</span> <span class='constant'>ENV</span><span class='punct'>['</span><span class='string'>RAILS_ENV</span><span class='punct'>']</span> <span class='punct'>=</span> <span class='punct'>'</span><span class='string'>development</span><span class='punct'>'</span>
|
|
419
|
+
<span class='keyword'>end</span>
|
|
420
|
+
|
|
421
|
+
<span class='ident'>desc</span> <span class='punct'>"</span><span class='string'>Runs the following task in the production environment</span><span class='punct'>"</span>
|
|
422
|
+
<span class='ident'>task</span> <span class='symbol'>:production</span> <span class='keyword'>do</span>
|
|
423
|
+
<span class='constant'>RAILS_ENV</span> <span class='punct'>=</span> <span class='constant'>ENV</span><span class='punct'>['</span><span class='string'>RAILS_ENV</span><span class='punct'>']</span> <span class='punct'>=</span> <span class='punct'>'</span><span class='string'>production</span><span class='punct'>'</span>
|
|
424
|
+
<span class='keyword'>end</span>
|
|
425
|
+
|
|
426
|
+
<span class='ident'>desc</span> <span class='punct'>"</span><span class='string'>Runs the following task in the staging environment</span><span class='punct'>"</span>
|
|
427
|
+
<span class='ident'>task</span> <span class='symbol'>:staging</span> <span class='keyword'>do</span>
|
|
428
|
+
<span class='constant'>RAILS_ENV</span> <span class='punct'>=</span> <span class='constant'>ENV</span><span class='punct'>['</span><span class='string'>RAILS_ENV</span><span class='punct'>']</span> <span class='punct'>=</span> <span class='punct'>'</span><span class='string'>staging</span><span class='punct'>'</span>
|
|
429
|
+
<span class='keyword'>end</span>
|
|
430
|
+
|
|
431
|
+
<span class='ident'>desc</span> <span class='punct'>"</span><span class='string'>Runs the following task in the test environment</span><span class='punct'>"</span>
|
|
432
|
+
<span class='ident'>task</span> <span class='symbol'>:test</span> <span class='keyword'>do</span>
|
|
433
|
+
<span class='constant'>RAILS_ENV</span> <span class='punct'>=</span> <span class='constant'>ENV</span><span class='punct'>['</span><span class='string'>RAILS_ENV</span><span class='punct'>']</span> <span class='punct'>=</span> <span class='punct'>'</span><span class='string'>test</span><span class='punct'>'</span>
|
|
434
|
+
<span class='keyword'>end</span>
|
|
435
|
+
|
|
436
|
+
<span class='ident'>task</span> <span class='symbol'>:dev</span> <span class='keyword'>do</span>
|
|
437
|
+
<span class='constant'>Rake</span><span class='punct'>::</span><span class='constant'>Task</span><span class='punct'>["</span><span class='string'>development</span><span class='punct'>"].</span><span class='ident'>invoke</span>
|
|
438
|
+
<span class='keyword'>end</span>
|
|
439
|
+
|
|
440
|
+
<span class='ident'>task</span> <span class='symbol'>:prod</span> <span class='keyword'>do</span>
|
|
441
|
+
<span class='constant'>Rake</span><span class='punct'>::</span><span class='constant'>Task</span><span class='punct'>["</span><span class='string'>production</span><span class='punct'>"].</span><span class='ident'>invoke</span>
|
|
442
|
+
<span class='keyword'>end</span>
|
|
443
|
+
</pre>
|
|
444
|
+
|
|
445
|
+
<p>Not super-DRY, but there’s a reason for that. I promise.</p>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<p>Now we can prefix any task with an environment instead of having to fumble with <span class='code'><span class='caps'>RAILS</span>_ENV</span> ourselves. Joy.</p>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
<h2>mysql.rake</h2>
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
<p>The second part of our <span class='code'>$ rake production mysql</span> task (which we want to launch us into a shell connected to our production MySQL server) is the actual <span class='code'>mysql</span> task.</p>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<p>Here’s <span class='code'><span class='caps'>RAILS</span>_ROOT/lib/tasks/mysql.rake</span>, which we use to build and execute a <span class='code'>mysql</span> shell command using the configuration options set in <span class='code'>database.yml</span>. Using the config file ensures our <span class='code'>mysql</span> rake task is always synced up with our Rails application’s db settings.</p>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<pre class='ruby'>
|
|
461
|
+
<span class='keyword'>def </span><span class='method'>sh_mysql</span><span class='punct'>(</span><span class='ident'>config</span><span class='punct'>)</span>
|
|
462
|
+
<span class='ident'>returning</span> <span class='punct'>'</span><span class='string'></span><span class='punct'>'</span> <span class='keyword'>do</span> <span class='punct'>|</span><span class='ident'>mysql</span><span class='punct'>|</span>
|
|
463
|
+
<span class='ident'>mysql</span> <span class='punct'><<</span> <span class='ident'>mysql_command</span> <span class='punct'><<</span> <span class='punct'>'</span><span class='string'> </span><span class='punct'>'</span>
|
|
464
|
+
<span class='ident'>mysql</span> <span class='punct'><<</span> <span class='punct'>"</span><span class='string'>-u<span class='expr'>#{config['username']}</span> </span><span class='punct'>"</span> <span class='keyword'>if</span> <span class='ident'>config</span><span class='punct'>['</span><span class='string'>username</span><span class='punct'>']</span>
|
|
465
|
+
<span class='ident'>mysql</span> <span class='punct'><<</span> <span class='punct'>"</span><span class='string'>-p<span class='expr'>#{config['password']}</span> </span><span class='punct'>"</span> <span class='keyword'>if</span> <span class='ident'>config</span><span class='punct'>['</span><span class='string'>password</span><span class='punct'>']</span>
|
|
466
|
+
<span class='ident'>mysql</span> <span class='punct'><<</span> <span class='punct'>"</span><span class='string'>-h<span class='expr'>#{config['host']}</span> </span><span class='punct'>"</span> <span class='keyword'>if</span> <span class='ident'>config</span><span class='punct'>['</span><span class='string'>host</span><span class='punct'>']</span>
|
|
467
|
+
<span class='ident'>mysql</span> <span class='punct'><<</span> <span class='punct'>"</span><span class='string'>-P<span class='expr'>#{config['port']}</span> </span><span class='punct'>"</span> <span class='keyword'>if</span> <span class='ident'>config</span><span class='punct'>['</span><span class='string'>port</span><span class='punct'>']</span>
|
|
468
|
+
<span class='ident'>mysql</span> <span class='punct'><<</span> <span class='ident'>config</span><span class='punct'>['</span><span class='string'>database</span><span class='punct'>']</span> <span class='keyword'>if</span> <span class='ident'>config</span><span class='punct'>['</span><span class='string'>database</span><span class='punct'>']</span>
|
|
469
|
+
<span class='keyword'>end</span>
|
|
470
|
+
<span class='keyword'>end</span>
|
|
471
|
+
|
|
472
|
+
<span class='keyword'>def </span><span class='method'>mysql_command</span>
|
|
473
|
+
<span class='punct'>'</span><span class='string'>mysql</span><span class='punct'>'</span>
|
|
474
|
+
<span class='keyword'>end</span>
|
|
475
|
+
|
|
476
|
+
<span class='ident'>desc</span> <span class='punct'>"</span><span class='string'>Launch mysql shell. Use with an environment task (e.g. rake production mysql)</span><span class='punct'>"</span>
|
|
477
|
+
<span class='ident'>task</span> <span class='symbol'>:mysql</span> <span class='keyword'>do</span>
|
|
478
|
+
<span class='ident'>system</span> <span class='ident'>sh_mysql</span><span class='punct'>(</span><span class='constant'>YAML</span><span class='punct'>.</span><span class='ident'>load</span><span class='punct'>(</span><span class='ident'>open</span><span class='punct'>(</span><span class='constant'>File</span><span class='punct'>.</span><span class='ident'>join</span><span class='punct'>('</span><span class='string'>config</span><span class='punct'>',</span> <span class='punct'>'</span><span class='string'>database.yml</span><span class='punct'>')))[</span><span class='constant'>RAILS_ENV</span><span class='punct'>])</span>
|
|
479
|
+
<span class='keyword'>end</span>
|
|
480
|
+
</pre>
|
|
481
|
+
|
|
482
|
+
<p>If you need to use something other than `<span class='code'>mysql</span>’ (maybe you need to include the full path?), just replace the return value of the <span class='code'>mysql_command</span> method. Lucky for us this is easy, fast, and fairly safe: a the <span class='code'>mysql</span> shell command is nice enough to hide the password from <span class='code'>ps aux</span>. That part of the command will show as ‘-pXXXXX’. Fort Knox style.</p>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
<p>That’s it. Now you can <span class='code'>$ rake prod mysql</span> or <span class='code'>$ rake mysql</span> or whatever, all day long. You barely need to code anymore.</p>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<h3>Tab-leeting It</h3>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<p>Since <a href='http://www.rubyinside.com/how-to-enable-tab-completion-in-irb-260.html'>tab</a> <a href='http://drnicwilliams.com/2006/10/12/my-irbrc-for-consoleirb/'>completion</a> is all the rage these days, I thought it’d be nice to dig through the Internet and find out how to get it rolling on rake.</p>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
<p>What I came across was a chain letter ending at <a href='http://onrails.org/articles/2006/08/30/namespaces-and-rake-command-completion'>this onrails.org post</a>. It rules! But unfortunately, it’s slow. Real slow. Is my laptop really that old already? Damn.</p>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
<p>The problem is that <span class='code'>rake</span> is being run each time we hit tab. Here’s my sped up version:</p>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
<pre class='ruby'>
|
|
501
|
+
<span class='comment'>#!/usr/bin/env ruby</span>
|
|
502
|
+
|
|
503
|
+
<span class='comment'># Save this somewhere, chmod 755 it, then add</span>
|
|
504
|
+
<span class='comment'># complete -C path/to/this/script -o default rake</span>
|
|
505
|
+
<span class='comment'># to your ~/.bashrc</span>
|
|
506
|
+
<span class='comment'>#</span>
|
|
507
|
+
<span class='comment'># If you update your tasks, just $ rm ~/.raketabs*</span>
|
|
508
|
+
<span class='comment'>#</span>
|
|
509
|
+
<span class='comment'># Adapted from </span>
|
|
510
|
+
<span class='comment'># http://onrails.org/articles/2006/08/30/namespaces-and-rake-command-completion</span>
|
|
511
|
+
|
|
512
|
+
<span class='ident'>exit</span> <span class='number'>0</span> <span class='keyword'>unless</span> <span class='constant'>File</span><span class='punct'>.</span><span class='ident'>file?</span><span class='punct'>(</span><span class='constant'>File</span><span class='punct'>.</span><span class='ident'>join</span><span class='punct'>(</span><span class='constant'>Dir</span><span class='punct'>.</span><span class='ident'>pwd</span><span class='punct'>,</span> <span class='punct'>'</span><span class='string'>Rakefile</span><span class='punct'>'))</span>
|
|
513
|
+
<span class='ident'>exit</span> <span class='number'>0</span> <span class='keyword'>unless</span> <span class='punct'>/</span><span class='regex'>^rake<span class='escape'>\b</span></span><span class='punct'>/</span> <span class='punct'>=~</span> <span class='constant'>ENV</span><span class='punct'>["</span><span class='string'>COMP_LINE</span><span class='punct'>"]</span>
|
|
514
|
+
|
|
515
|
+
<span class='keyword'>def </span><span class='method'>rake_silent_tasks</span>
|
|
516
|
+
<span class='keyword'>if</span> <span class='constant'>File</span><span class='punct'>.</span><span class='ident'>exists?</span><span class='punct'>(</span><span class='ident'>dotcache</span> <span class='punct'>=</span> <span class='constant'>File</span><span class='punct'>.</span><span class='ident'>join</span><span class='punct'>(</span><span class='constant'>File</span><span class='punct'>.</span><span class='ident'>expand_path</span><span class='punct'>('</span><span class='string'>~</span><span class='punct'>'),</span> <span class='punct'>"</span><span class='string'>.raketabs-<span class='expr'>#{Dir.pwd.hash}</span></span><span class='punct'>"))</span>
|
|
517
|
+
<span class='constant'>File</span><span class='punct'>.</span><span class='ident'>read</span><span class='punct'>(</span><span class='ident'>dotcache</span><span class='punct'>)</span>
|
|
518
|
+
<span class='keyword'>else</span>
|
|
519
|
+
<span class='ident'>tasks</span> <span class='punct'>=</span> `<span class='ident'>rake</span> <span class='punct'>--</span><span class='ident'>silent</span> <span class='punct'>--</span><span class='ident'>tasks`</span>
|
|
520
|
+
<span class='constant'>File</span><span class='punct'>.</span><span class='ident'>open</span><span class='punct'>(</span><span class='ident'>dotcache</span><span class='punct'>,</span> <span class='punct'>'</span><span class='string'>w</span><span class='punct'>')</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>f</span><span class='punct'>|</span> <span class='ident'>f</span><span class='punct'>.</span><span class='ident'>puts</span> <span class='ident'>tasks</span> <span class='punct'>}</span>
|
|
521
|
+
<span class='ident'>tasks</span>
|
|
522
|
+
<span class='keyword'>end</span>
|
|
523
|
+
<span class='keyword'>end</span>
|
|
524
|
+
|
|
525
|
+
<span class='ident'>after_match</span> <span class='punct'>=</span> <span class='global'>$'</span>
|
|
526
|
+
<span class='ident'>task_match</span> <span class='punct'>=</span> <span class='punct'>(</span><span class='ident'>after_match</span><span class='punct'>.</span><span class='ident'>empty?</span> <span class='punct'>||</span> <span class='ident'>after_match</span> <span class='punct'>=~</span> <span class='punct'>/</span><span class='regex'><span class='escape'>\s</span>$</span><span class='punct'>/)</span> <span class='punct'>?</span> <span class='constant'>nil</span> <span class='punct'>:</span> <span class='ident'>after_match</span><span class='punct'>.</span><span class='ident'>split</span><span class='punct'>.</span><span class='ident'>last</span>
|
|
527
|
+
<span class='ident'>tasks</span> <span class='punct'>=</span> <span class='ident'>rake_silent_tasks</span><span class='punct'>.</span><span class='ident'>split</span><span class='punct'>("</span><span class='string'><span class='escape'>\n</span></span><span class='punct'>")[</span><span class='number'>1</span><span class='punct'>..-</span><span class='number'>1</span><span class='punct'>].</span><span class='ident'>map</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>line</span><span class='punct'>|</span> <span class='ident'>line</span><span class='punct'>.</span><span class='ident'>split</span><span class='punct'>[</span><span class='number'>1</span><span class='punct'>]</span> <span class='punct'>}</span>
|
|
528
|
+
<span class='ident'>tasks</span> <span class='punct'>=</span> <span class='ident'>tasks</span><span class='punct'>.</span><span class='ident'>select</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>t</span><span class='punct'>|</span> <span class='punct'>/</span><span class='regex'>^<span class='expr'>#{Regexp.escape task_match}</span></span><span class='punct'>/</span> <span class='punct'>=~</span> <span class='ident'>t</span> <span class='punct'>}</span> <span class='keyword'>if</span> <span class='ident'>task_match</span>
|
|
529
|
+
|
|
530
|
+
<span class='comment'># handle namespaces</span>
|
|
531
|
+
<span class='keyword'>if</span> <span class='ident'>task_match</span> <span class='punct'>=~</span> <span class='punct'>/</span><span class='regex'>^([-<span class='escape'>\w</span>:]+:)</span><span class='punct'>/</span>
|
|
532
|
+
<span class='ident'>upto_last_colon</span> <span class='punct'>=</span> <span class='global'>$1</span>
|
|
533
|
+
<span class='ident'>after_match</span> <span class='punct'>=</span> <span class='global'>$'</span>
|
|
534
|
+
<span class='ident'>tasks</span> <span class='punct'>=</span> <span class='ident'>tasks</span><span class='punct'>.</span><span class='ident'>map</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>t</span><span class='punct'>|</span> <span class='punct'>(</span><span class='ident'>t</span> <span class='punct'>=~</span> <span class='punct'>/</span><span class='regex'>^<span class='expr'>#{Regexp.escape upto_last_colon}</span>([-<span class='escape'>\w</span>:]+)$</span><span class='punct'>/)</span> <span class='punct'>?</span> <span class='punct'>"</span><span class='string'><span class='expr'>#{$1}</span></span><span class='punct'>"</span> <span class='punct'>:</span> <span class='ident'>t</span> <span class='punct'>}</span>
|
|
535
|
+
<span class='keyword'>end</span>
|
|
536
|
+
|
|
537
|
+
<span class='ident'>puts</span> <span class='ident'>tasks</span>
|
|
538
|
+
<span class='ident'>exit</span> <span class='number'>0</span>
|
|
539
|
+
</pre>
|
|
540
|
+
|
|
541
|
+
<p>You can grab it with <span class='code'>wget http://pastie.caboo.se/17743/text</span>.</p>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
<p>Next stick this into <span class='code'>.bashrc</span> or whatever init script your shell hits:</p>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<p><span class='code'>complete -C path/to/script/you/downloaded -o default rake</span></p>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
<p>Now restart your shell, then <span class='code'>cd</span> to a Rails project. Next type <span class='code'>rake db:<tab></span>. Wait a second. Did all the tasks show up? Awesome. Hit tab again. Only the first time should be slow.</p>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<p>Improvements? Bug fixes? Let’s hear ‘em.</p>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<h3>Love It</h3>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<p>Rake is real cool. Beyond having <a href='http://rake.rubyforge.org/files/lib/rake_rb.html#M000007'>namespaces</a> and <a href='http://nubyonrails.com/articles/2006/07/28/foscon-and-living-dangerously-with-rake'>method_missing</a>, it’s got built in support for <a href='http://rake.rubyforge.org/classes/Rake/GemPackageTask.html'>building gems</a>. And hey, if you look in <span class='code'>rake/lib/rake/contrib</span> you can even find files such as <span class='code'>rubyforgepublisher.rb</span> for, you guessed it, publishing to Rubyforge automatically. What <em>can’t</em> this kid do?</p>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
</div>
|
|
564
|
+
</li>
|
|
565
|
+
<li class="post-li hentry">
|
|
566
|
+
<div class="sidebar">
|
|
567
|
+
|
|
568
|
+
<div class="title entry-title">“<a href="/post/10" class="reverse" rel="bookmark">Strut Your Structs</a>”</div>
|
|
569
|
+
<div class="secondary byline">– <span class="entry-author">admin</span> on <span class="published" title="Tue Sep 26 15:33:00 PDT 2006">September 26th, 2006</span></div>
|
|
570
|
+
|
|
571
|
+
<br/>
|
|
572
|
+
<div class="secondary tags">
|
|
573
|
+
This post is tagged with <a href="/tag/ruby" class="tag-link" rel="tag">ruby</a>.<br/>
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
It has <a href="/post/10">zero comments</a>
|
|
577
|
+
|
|
578
|
+
</div>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
</div>
|
|
582
|
+
|
|
583
|
+
<div class="main entry-content">
|
|
584
|
+
|
|
585
|
+
<p>I am sitting in the airport right now, waiting for my twice delayed flight to board. The security man took my Scope. He does not want my teeth to be clean or my breath to be fresh. So be it.</p>
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
<p>Here’re two classes you may or may not have seen before. Unlike, say, a small bottle of refreshing mouth wash, you can definitely take these guys on an airplane.</p>
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
<h3>Struct</h3>
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
<p><span class='code'>Struct</span> is like Ruby on Rails for classes. Scaffolding. It lets you quickly cobble together a new class with some gettable-settable attributes. You can then instantiate your struct’d class and go nuts. You don’t even need to <span class='code'>require</span> anything—<span class='code'>Struct</span> is right there, ready and willing, all the time.</p>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
<p>When I was little we had a black lab named Tucker. He was a dog with four legs and two eyeballs.</p>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
<pre class='ruby'>
|
|
601
|
+
<span class='punct'>>></span> <span class='constant'>Animal</span> <span class='punct'>=</span> <span class='constant'>Struct</span><span class='punct'>.</span><span class='ident'>new</span><span class='punct'>(</span><span class='symbol'>:name</span><span class='punct'>,</span> <span class='symbol'>:legs</span><span class='punct'>,</span> <span class='symbol'>:eyeballs</span><span class='punct'>)</span>
|
|
602
|
+
<span class='punct'>=></span> <span class='constant'>Animal</span>
|
|
603
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span> <span class='punct'>=</span> <span class='constant'>Animal</span><span class='punct'>.</span><span class='ident'>new</span><span class='punct'>('</span><span class='string'>dog</span><span class='punct'>',</span> <span class='number'>4</span><span class='punct'>,</span> <span class='number'>2</span><span class='punct'>)</span>
|
|
604
|
+
<span class='punct'>=></span> <span class='comment'>#<struct Animal name="dog", legs=4, eyeballs=2></span>
|
|
605
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>legs</span>
|
|
606
|
+
<span class='punct'>=></span> <span class='number'>4</span>
|
|
607
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>legs</span> <span class='punct'>=</span> <span class='number'>3</span>
|
|
608
|
+
<span class='punct'>=></span> <span class='number'>3</span>
|
|
609
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>legs</span>
|
|
610
|
+
<span class='punct'>=></span> <span class='number'>3</span>
|
|
611
|
+
</pre>
|
|
612
|
+
|
|
613
|
+
<p>Wow, that’s quick. We didn’t have to set up a class definition or fumble with <span class='code'>attr_accessor</span>. But there’s more.</p>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
<pre class='ruby'>
|
|
617
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>[</span><span class='number'>0</span><span class='punct'>]</span>
|
|
618
|
+
<span class='punct'>=></span> <span class='punct'>"</span><span class='string'>dog</span><span class='punct'>"</span>
|
|
619
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>['</span><span class='string'>name</span><span class='punct'>']</span>
|
|
620
|
+
<span class='punct'>=></span> <span class='punct'>"</span><span class='string'>dog</span><span class='punct'>"</span>
|
|
621
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>[</span><span class='symbol'>:name</span><span class='punct'>]</span>
|
|
622
|
+
<span class='punct'>=></span> <span class='punct'>"</span><span class='string'>dog</span><span class='punct'>"</span>
|
|
623
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>[</span><span class='symbol'>:name</span><span class='punct'>]</span> <span class='punct'>=</span> <span class='punct'>'</span><span class='string'>doggy</span><span class='punct'>'</span>
|
|
624
|
+
<span class='punct'>=></span> <span class='punct'>"</span><span class='string'>doggy</span><span class='punct'>"</span>
|
|
625
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>name</span>
|
|
626
|
+
<span class='punct'>=></span> <span class='punct'>"</span><span class='string'>doggy</span><span class='punct'>"</span>
|
|
627
|
+
</pre>
|
|
628
|
+
|
|
629
|
+
<p>It’s like <span class='code'>Array</span> and <span class='code'>Hash</span> got married and had a little classling. Okay, that’s not true, but it sure looks that way from the outside. I wonder if that means <span class='code'>Struct</span> objects are enumerable?</p>
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
<pre class='ruby'>
|
|
633
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>is_a?</span> <span class='constant'>Enumerable</span>
|
|
634
|
+
<span class='punct'>=></span> <span class='constant'>true</span>
|
|
635
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>methods</span><span class='punct'>.</span><span class='ident'>grep</span> <span class='punct'>/</span><span class='ident'>each</span><span class='punct'>/</span>
|
|
636
|
+
<span class='punct'>=></span> <span class='punct'>["</span><span class='string'>each_with_index</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>each</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>each_pair</span><span class='punct'>"]</span>
|
|
637
|
+
</pre>
|
|
638
|
+
|
|
639
|
+
<p>How unexpected. And it’s ordered, too—the order you passed your keys when creating your struct’d class is maintained. In this case the order is <span class='code'>name</span>, <span class='code'>legs</span>, then <span class='code'>eyeballs</span>. Always.</p>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
<pre class='ruby'>
|
|
643
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>each_pair</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>k</span><span class='punct'>,</span><span class='ident'>v</span><span class='punct'>|</span> <span class='ident'>puts</span> <span class='punct'>"</span><span class='string'>key: <span class='expr'>#{k}</span>, value: <span class='expr'>#{v}</span></span><span class='punct'>"</span> <span class='punct'>}</span>
|
|
644
|
+
<span class='ident'>key</span><span class='punct'>:</span> <span class='ident'>name</span><span class='punct'>,</span> <span class='ident'>value</span><span class='punct'>:</span> <span class='ident'>dog</span>
|
|
645
|
+
<span class='ident'>key</span><span class='punct'>:</span> <span class='ident'>legs</span><span class='punct'>,</span> <span class='ident'>value</span><span class='punct'>:</span> <span class='number'>4</span>
|
|
646
|
+
<span class='ident'>key</span><span class='punct'>:</span> <span class='ident'>eyeballs</span><span class='punct'>,</span> <span class='ident'>value</span><span class='punct'>:</span> <span class='number'>2</span>
|
|
647
|
+
<span class='punct'>=></span> <span class='comment'>#<struct Animal name="dog", legs=4, eyeballs=2></span>
|
|
648
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>each</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>v</span><span class='punct'>|</span> <span class='ident'>puts</span> <span class='ident'>v</span> <span class='punct'>}</span>
|
|
649
|
+
<span class='ident'>dog</span>
|
|
650
|
+
<span class='number'>4</span>
|
|
651
|
+
<span class='number'>2</span>
|
|
652
|
+
<span class='punct'>=></span> <span class='comment'>#<struct Animal name="dog", legs=4, eyeballs=2></span>
|
|
653
|
+
</pre>
|
|
654
|
+
|
|
655
|
+
<p>For reference:</p>
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
<pre class='ruby'>
|
|
659
|
+
<span class='punct'>>></span> <span class='punct'>(</span><span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>methods</span> <span class='punct'>&</span> <span class='constant'>Enumerable</span><span class='punct'>.</span><span class='ident'>instance_methods</span><span class='punct'>).</span><span class='ident'>sort</span>
|
|
660
|
+
<span class='punct'>=></span> <span class='punct'>["</span><span class='string'>all?</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>any?</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>collect</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>detect</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>each_with_index</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>entries</span><span class='punct'>",</span>
|
|
661
|
+
<span class='punct'>"</span><span class='string'>find</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>find_all</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>grep</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>include?</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>inject</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>map</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>max</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>member?</span><span class='punct'>",</span>
|
|
662
|
+
<span class='punct'>"</span><span class='string'>min</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>partition</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>reject</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>select</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>sort</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>sort_by</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>to_a</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>zip</span><span class='punct'>"]</span>
|
|
663
|
+
</pre>
|
|
664
|
+
|
|
665
|
+
<p>Since a struct’d class is not actually a <span class='code'>Hash</span> or an <span class='code'>Array</span>, there are differences. A <span class='code'>Struct</span> instantiated object has no keys—it has <span class='code'>members</span>.</p>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
<pre class='ruby'>
|
|
669
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>members</span>
|
|
670
|
+
<span class='punct'>=></span> <span class='punct'>["</span><span class='string'>name</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>legs</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>eyeballs</span><span class='punct'>"]</span>
|
|
671
|
+
<span class='punct'>>></span> <span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>values</span>
|
|
672
|
+
<span class='punct'>=></span> <span class='punct'>["</span><span class='string'>doggy</span><span class='punct'>",</span> <span class='number'>4</span><span class='punct'>,</span> <span class='number'>2</span><span class='punct'>]</span>
|
|
673
|
+
</pre>
|
|
674
|
+
|
|
675
|
+
<p>Also: you can not add new <span class='code'>members</span> arbitrarily as you can with an <span class='code'>Array</span> or a <span class='code'>Hash</span>. However many <span class='code'>members</span> you instantiate your struct’d class with is however many you’re stuck with. As a result: no <span class='code'>merge</span>, <span class='code'>update</span>, or <span class='code'>concat</span> (+). This is a class, after all. Not a fancy faux-primitive.</p>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
<p>If you need to turn a <span class='code'>Struct</span> object into a <span class='code'>Hash</span>, here’s an easy way:</p>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
<pre class='ruby'>
|
|
682
|
+
<span class='punct'>>></span> <span class='ident'>hash</span> <span class='punct'>=</span> <span class='constant'>Hash</span><span class='punct'>[*</span><span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>members</span><span class='punct'>.</span><span class='ident'>zip</span><span class='punct'>(</span><span class='ident'>tucker</span><span class='punct'>.</span><span class='ident'>values</span><span class='punct'>).</span><span class='ident'>flatten</span><span class='punct'>]</span>
|
|
683
|
+
<span class='punct'>=></span> <span class='punct'>{"</span><span class='string'>name</span><span class='punct'>"=>"</span><span class='string'>doggy</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>eyeballs</span><span class='punct'>"=></span><span class='number'>2</span><span class='punct'>,</span> <span class='punct'>"</span><span class='string'>legs</span><span class='punct'>"=></span><span class='number'>4</span><span class='punct'>}</span>
|
|
684
|
+
</pre>
|
|
685
|
+
|
|
686
|
+
<p>Maybe wrap that in a <span class='code'>to_hash</span> if you’d like. For <span class='code'>to_a</span>, just use <span class='code'>values</span>.</p>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
<p>It’s worth noting that since everything in Ruby is an object, we can inherit straight from a call to <span class='code'>Struct.new</span>. Maybe we want to add some questions?</p>
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
<pre class='ruby'>
|
|
693
|
+
<span class='keyword'>class </span><span class='class'>Primate</span> <span class='punct'><</span> <span class='constant'>Struct</span><span class='punct'>.</span><span class='ident'>new</span><span class='punct'>(</span><span class='symbol'>:name</span><span class='punct'>,</span> <span class='symbol'>:legs</span><span class='punct'>,</span> <span class='symbol'>:eyeballs</span><span class='punct'>)</span>
|
|
694
|
+
<span class='keyword'>def </span><span class='method'>legs?</span>
|
|
695
|
+
<span class='punct'>(</span><span class='ident'>legs</span> <span class='punct'>&&</span> <span class='ident'>legs</span><span class='punct'>.</span><span class='ident'>to_i</span> <span class='punct'>></span> <span class='number'>0</span><span class='punct'>)</span> <span class='punct'>?</span> <span class='constant'>true</span> <span class='punct'>:</span> <span class='constant'>false</span>
|
|
696
|
+
<span class='keyword'>end</span>
|
|
697
|
+
<span class='keyword'>end</span>
|
|
698
|
+
</pre>
|
|
699
|
+
|
|
700
|
+
<p>Imagine the possibilities. Fake-out <span class='code'>ActiveRecord</span> objects in your tests! Mock hashes that are super indifferent! Create resources which can only be described as active! Amaze your friends!</p>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
<h3>OpenStruct</h3>
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
<p><span class='code'>OpenStruct</span> is a bit more liberal than <span class='code'>Struct</span>, with less structure. Like that hippie cousin everyone has. (in my family it’s me)</p>
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
<p>Usage: pass a hash to <span class='code'>OpenStruct.new</span>, receive an object with full-on getters and setters. Because this behavior is a bit suspect we must explicitly require <span class='code'>OpenStruct</span> (<span class='code'>ostruct</span>) from the standard library. Like <span class='code'><span class='caps'>YAML</span></span>.</p>
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
<pre class='ruby'>
|
|
713
|
+
<span class='punct'>>></span> <span class='ident'>require</span> <span class='punct'>'</span><span class='string'>ostruct</span><span class='punct'>'</span>
|
|
714
|
+
<span class='punct'>=></span> <span class='constant'>true</span>
|
|
715
|
+
<span class='punct'>>></span> <span class='ident'>scope</span> <span class='punct'>=</span> <span class='constant'>OpenStruct</span><span class='punct'>.</span><span class='ident'>new</span><span class='punct'>(</span><span class='symbol'>:brand</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>Scope</span><span class='punct'>',</span> <span class='symbol'>:owner</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>P&G</span><span class='punct'>',</span> <span class='symbol'>:flavor</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>Cinnamon Ice</span><span class='punct'>')</span>
|
|
716
|
+
<span class='punct'>=></span> <span class='comment'>#<OpenStruct brand="Scope", owner="P&G", flavor="Cinnamon Ice"></span>
|
|
717
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>brand</span>
|
|
718
|
+
<span class='punct'>=></span> <span class='punct'>"</span><span class='string'>Scope</span><span class='punct'>"</span>
|
|
719
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>brand</span> <span class='punct'>=</span> <span class='punct'>'</span><span class='string'>Scoped</span><span class='punct'>'</span>
|
|
720
|
+
<span class='punct'>=></span> <span class='punct'>"</span><span class='string'>Scoped</span><span class='punct'>"</span>
|
|
721
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>brand</span>
|
|
722
|
+
<span class='punct'>=></span> <span class='punct'>"</span><span class='string'>Scoped</span><span class='punct'>"</span>
|
|
723
|
+
</pre>
|
|
724
|
+
|
|
725
|
+
<p>Unlike <span class='code'>Struct</span>, we <strong>can</strong> add new members to an <span class='code'>OpenStruct</span> object whenever we’d like.</p>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
<pre class='ruby'>
|
|
729
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>tasty</span>
|
|
730
|
+
<span class='punct'>=></span> <span class='constant'>nil</span>
|
|
731
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>tasty</span> <span class='punct'>=</span> <span class='constant'>true</span>
|
|
732
|
+
<span class='punct'>=></span> <span class='constant'>true</span>
|
|
733
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>tasty</span>
|
|
734
|
+
<span class='punct'>=></span> <span class='constant'>true</span>
|
|
735
|
+
</pre>
|
|
736
|
+
|
|
737
|
+
<p>This is accomplished through some <span class='code'>method_missing</span>-like magic. Unfortunately, this means all your <span class='code'>NoMethodError</span> exceptions go away.</p>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
<pre class='ruby'>
|
|
741
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>something_fake</span>
|
|
742
|
+
<span class='punct'>=></span> <span class='constant'>nil</span>
|
|
743
|
+
</pre>
|
|
744
|
+
|
|
745
|
+
<p>Not the biggest deal. That’s how hashes work when you try to access a non-existent key, after all. And there’s always good ol’ <span class='code'>respond_to</span>:</p>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
<pre class='ruby'>
|
|
749
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>respond_to?</span> <span class='symbol'>:something_fake</span>
|
|
750
|
+
<span class='punct'>=></span> <span class='constant'>false</span>
|
|
751
|
+
</pre>
|
|
752
|
+
|
|
753
|
+
<p>So that’s all pretty cool. I’ve been playing with this class in my code lately. Mainly in tests to fake out <span class='code'>ActiveRecord</span> stuffs, as I suggested with <span class='code'>Struct</span>. There is one major disadvantage to <span class='code'>OpenStruct</span>: it’s not enumerable. Less structure, see. You can not <span class='code'>each</span>, you can not <span class='code'>members</span>, you can’t even <span class='code'>values</span>. Well. I mean. Out of the box you can’t.</p>
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
<h3>Enum-o-Struct</h3>
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
<p>What we’re going to do is make <span class='code'>OpenStruct</span> enumerable by adding the <span class='code'>each</span> method, the <span class='code'>members</span> method, and including the <span class='code'>Enumerable</span> module.</p>
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
<pre class='ruby'>
|
|
763
|
+
<span class='ident'>require</span> <span class='punct'>'</span><span class='string'>ostruct</span><span class='punct'>'</span>
|
|
764
|
+
|
|
765
|
+
<span class='keyword'>class </span><span class='class'>EnumoStruct</span> <span class='punct'><</span> <span class='constant'>OpenStruct</span>
|
|
766
|
+
<span class='ident'>include</span> <span class='constant'>Enumerable</span>
|
|
767
|
+
|
|
768
|
+
<span class='keyword'>def </span><span class='method'>members</span>
|
|
769
|
+
<span class='ident'>methods</span><span class='punct'>(</span><span class='constant'>false</span><span class='punct'>).</span><span class='ident'>grep</span><span class='punct'>(/</span><span class='regex'>=</span><span class='punct'>/).</span><span class='ident'>map</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>m</span><span class='punct'>|</span> <span class='ident'>m</span><span class='punct'>[</span><span class='number'>0</span><span class='punct'>...-</span><span class='number'>1</span><span class='punct'>]</span> <span class='punct'>}</span>
|
|
770
|
+
<span class='keyword'>end</span>
|
|
771
|
+
|
|
772
|
+
<span class='keyword'>def </span><span class='method'>each</span>
|
|
773
|
+
<span class='ident'>members</span><span class='punct'>.</span><span class='ident'>each</span> <span class='keyword'>do</span> <span class='punct'>|</span><span class='ident'>method</span><span class='punct'>|</span>
|
|
774
|
+
<span class='keyword'>yield</span> <span class='ident'>send</span><span class='punct'>(</span><span class='ident'>method</span><span class='punct'>)</span>
|
|
775
|
+
<span class='keyword'>end</span>
|
|
776
|
+
<span class='constant'>self</span>
|
|
777
|
+
<span class='keyword'>end</span>
|
|
778
|
+
<span class='keyword'>end</span>
|
|
779
|
+
</pre>
|
|
780
|
+
|
|
781
|
+
<p>Cryptic? Hardly.</p>
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
<p>We want an <span class='code'>each</span> method. How are we going to enumerate over an <span class='code'>OpenStruct</span>? Well, we could always just pass the return value of each getter-method to whatever block is passed to our <span class='code'>each</span> method. If that’s our approach, it looks like we need a way to find all the members. All the getters.</p>
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
<p>While an <span class='code'>OpenStruct</span> object may have a ton of arbitrary methods, it has setters which end in an equal sign and almost always correspond to a getter. The <span class='code'>members</span> method here finds all methods ending in <span class='code'>=</span> on an object by grabbing an array of methods <em>excluding</em> those defined on parent/ancestor classes (<span class='code'>methods(false)</span>) and creating an array of methods which match a regular expression, using <span class='code'>grep</span>. It then strips the last character from each found method, the <span class='code'>=</span>, returning our array of members.</p>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
<p>The members from our <span class='code'>scope</span> example: <span class='code'>[“flavor”, “owner”, “brand”]</span></p>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
<p>The <span class='code'>Enumerable</span> module depends on your class implementing <span class='code'>each</span> to work its magic. The concept is simple: go through each of the <span class='code'>member</span> methods and call the method, passing its value into the block passed to <span class='code'>each</span> using <span class='code'>yield</span>. In this case, <span class='code'>send(method)</span> is the same as, for example, <span class='code'>self.flavor</span> or <span class='code'>self.brand</span>.</p>
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
<p>Notice we return <span class='code'>self</span> in our <span class='code'>each</span> method: it’s polite for <span class='code'>each</span> to return <span class='code'>self</span> so that calls to it may be chained.</p>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
<p>In action:</p>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
<pre class='ruby'>
|
|
803
|
+
<span class='punct'>>></span> <span class='ident'>require</span> <span class='punct'>'</span><span class='string'>enumostruct</span><span class='punct'>'</span>
|
|
804
|
+
<span class='punct'>=></span> <span class='constant'>true</span>
|
|
805
|
+
<span class='punct'>>></span> <span class='ident'>scope</span> <span class='punct'>=</span> <span class='constant'>EnumoStruct</span><span class='punct'>.</span><span class='ident'>new</span><span class='punct'>(</span><span class='symbol'>:brand</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>Scope</span><span class='punct'>',</span> <span class='symbol'>:owner</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>P&G</span><span class='punct'>',</span> <span class='symbol'>:flavor</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>Cinnamon Ice</span><span class='punct'>')</span>
|
|
806
|
+
<span class='punct'>=></span> <span class='comment'>#<EnumoStruct brand="Scope", owner="P&G", flavor="Cinnamon Ice"></span>
|
|
807
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>each</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>v</span><span class='punct'>|</span> <span class='ident'>puts</span> <span class='punct'>"</span><span class='string'>value: <span class='expr'>#{v}</span></span><span class='punct'>"</span> <span class='punct'>}</span>
|
|
808
|
+
<span class='ident'>value</span><span class='punct'>:</span> <span class='constant'>Cinnamon</span> <span class='constant'>Ice</span>
|
|
809
|
+
<span class='ident'>value</span><span class='punct'>:</span> <span class='constant'>P</span><span class='punct'>&</span><span class='constant'>G</span>
|
|
810
|
+
<span class='ident'>value</span><span class='punct'>:</span> <span class='constant'>Scope</span>
|
|
811
|
+
<span class='punct'>=></span> <span class='comment'>#<EnumoStruct brand="Scope", owner="P&G", flavor="Cinnamon Ice"></span>
|
|
812
|
+
</pre>
|
|
813
|
+
|
|
814
|
+
<p>Oh that’s delicious. Remember, now we have all the <span class='code'>Enumerable</span> methods.</p>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
<pre class='ruby'>
|
|
818
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>map</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>v</span><span class='punct'>|</span> <span class='ident'>v</span> <span class='punct'>}</span>
|
|
819
|
+
<span class='punct'>=></span> <span class='punct'>["</span><span class='string'>Cinnamon Ice</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>P&G</span><span class='punct'>",</span> <span class='punct'>"</span><span class='string'>Scope</span><span class='punct'>"]</span>
|
|
820
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>detect</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>v</span><span class='punct'>|</span> <span class='ident'>v</span> <span class='punct'>=~</span> <span class='punct'>/</span><span class='regex'>&</span><span class='punct'>/</span> <span class='punct'>}</span>
|
|
821
|
+
<span class='punct'>=></span> <span class='punct'>"</span><span class='string'>P&G</span><span class='punct'>"</span>
|
|
822
|
+
</pre>
|
|
823
|
+
|
|
824
|
+
<p>Hey, I liked that <span class='code'>each_pair</span> method that <span class='code'>Struct</span> gives you. Let’s add it before we go.</p>
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
<pre class='ruby'>
|
|
828
|
+
<span class='keyword'>class </span><span class='class'>EnumoStruct</span> <span class='punct'><</span> <span class='constant'>OpenStruct</span>
|
|
829
|
+
<span class='keyword'>def </span><span class='method'>each_pair</span>
|
|
830
|
+
<span class='ident'>members</span><span class='punct'>.</span><span class='ident'>each</span> <span class='keyword'>do</span> <span class='punct'>|</span><span class='ident'>method</span><span class='punct'>|</span>
|
|
831
|
+
<span class='keyword'>yield</span> <span class='ident'>method</span><span class='punct'>,</span> <span class='ident'>send</span><span class='punct'>(</span><span class='ident'>method</span><span class='punct'>)</span>
|
|
832
|
+
<span class='keyword'>end</span>
|
|
833
|
+
<span class='constant'>self</span>
|
|
834
|
+
<span class='keyword'>end</span>
|
|
835
|
+
<span class='keyword'>end</span>
|
|
836
|
+
|
|
837
|
+
<span class='punct'>>></span> <span class='ident'>scope</span><span class='punct'>.</span><span class='ident'>each_pair</span> <span class='punct'>{</span> <span class='punct'>|</span><span class='ident'>k</span><span class='punct'>,</span><span class='ident'>v</span><span class='punct'>|</span> <span class='ident'>puts</span> <span class='punct'>"</span><span class='string'>key: <span class='expr'>#{k}</span>, value: <span class='expr'>#{v}</span></span><span class='punct'>"</span> <span class='punct'>}</span>
|
|
838
|
+
<span class='ident'>key</span><span class='punct'>:</span> <span class='ident'>flavor</span><span class='punct'>,</span> <span class='ident'>value</span><span class='punct'>:</span> <span class='constant'>Cinnamon</span> <span class='constant'>Ice</span>
|
|
839
|
+
<span class='ident'>key</span><span class='punct'>:</span> <span class='ident'>owner</span><span class='punct'>,</span> <span class='ident'>value</span><span class='punct'>:</span> <span class='constant'>P</span><span class='punct'>&</span><span class='constant'>G</span>
|
|
840
|
+
<span class='ident'>key</span><span class='punct'>:</span> <span class='ident'>brand</span><span class='punct'>,</span> <span class='ident'>value</span><span class='punct'>:</span> <span class='constant'>Scope</span>
|
|
841
|
+
<span class='punct'>=></span> <span class='comment'>#<EnumoStruct brand="Scope", owner="P&G", flavor="Cinnamon Ice"></span>
|
|
842
|
+
</pre>
|
|
843
|
+
|
|
844
|
+
<p>Same as <span class='code'>each</span>, really. The only difference is we pass the name of the current member into the block as the first argument. Cake.</p>
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
<h3>Bye!</h3>
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
<p>Ah, we’ve accomplished so much. My only hope is you can truly find a use for one of these humble classes. They are not flammable and pose no threat to your fellow passengers.</p>
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
</div>
|
|
855
|
+
</li>
|
|
856
|
+
<li class="post-li hentry">
|
|
857
|
+
<div class="sidebar">
|
|
858
|
+
|
|
859
|
+
<div class="title entry-title">“<a href="/post/9" class="reverse" rel="bookmark">Content For Whom?</a>”</div>
|
|
860
|
+
<div class="secondary byline">– <span class="entry-author">admin</span> on <span class="published" title="Sat Sep 16 15:46:00 PDT 2006">September 16th, 2006</span></div>
|
|
861
|
+
|
|
862
|
+
<br/>
|
|
863
|
+
<div class="secondary tags">
|
|
864
|
+
This post is tagged with <a href="/tag/rails" class="tag-link" rel="tag">rails</a>.<br/>
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
It has <a href="/post/9">zero comments</a>
|
|
868
|
+
|
|
869
|
+
</div>
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
</div>
|
|
873
|
+
|
|
874
|
+
<div class="main entry-content">
|
|
875
|
+
|
|
876
|
+
<p>Larry is building a personal home page. He’s using Ruby on Rails and fla-fla-flying. Why, at the rate he’s going, link groups and banner exchanges will be <em>begging</em> him to join in no time flat.</p>
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
<div align='center'><img src='http://errtheblog.com/static/images/meet_larry.jpg' alt='Meet Larry.' /></div>
|
|
880
|
+
|
|
881
|
+
<p>Just recently he was Googling and came across a post on Err the Blog titled <em><a href='http://errtheblog.com/post/28'>Content for Whom?</a></em> While the writer of said blog is a bit of a flake, Larry was able to make his site more dynamic and <span class='caps'>DRY</span> using <span class='code'>content_for</span> after reading the post. Here’s how.</p>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
<h3>The Sidebar</h3>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
<p>We all know Rails compiles views before it compiles the layout. That is, if you set <span class='code'>@page_title</span> in your view, you may reference it in your layout. Something like <span class='code'><title>My Site :: <%= @page_title %></title></span>. <span class='code'>content_for</span> is no different: it allows you to ‘assign’ a chunk of <span class='caps'>HTML</span> or Ruby to a symbol which may be referenced in your layout.</p>
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
Here’s Larry’s layout:
|
|
891
|
+
<pre class='ruby'>
|
|
892
|
+
<span class='punct'><</span><span class='ident'>html</span><span class='punct'>></span>
|
|
893
|
+
<span class='punct'><</span><span class='ident'>head</span><span class='punct'>><</span><span class='ident'>title</span><span class='punct'>></span><span class='constant'>Larry</span><span class='punct'>'</span><span class='string'>s Personal Home Page</title></head>
|
|
894
|
+
<body>
|
|
895
|
+
<table width="100%">
|
|
896
|
+
<tr><td>
|
|
897
|
+
<%= yield %>
|
|
898
|
+
</td><td>
|
|
899
|
+
<%= yield :sidebar %>
|
|
900
|
+
</td></tr>
|
|
901
|
+
<tr><td colspan="2" align="center">
|
|
902
|
+
Copyright (c) 2006 Larry
|
|
903
|
+
</td></tr>
|
|
904
|
+
</table>
|
|
905
|
+
</body>
|
|
906
|
+
</html><span class='normal'>
|
|
907
|
+
</span></span></pre>
|
|
908
|
+
|
|
909
|
+
<p>The first <span class='code'>yield</span>, clearly, will be replaced with Larry’s view when rendered. The second <span class='code'>yield</span> is a bit different: he’s passing it a symbol, saying he wants to yield <span class='code'>:sidebar</span> at that point in time—whatever <span class='code'>:sidebar</span> may be.</p>
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
Let’s look at Larry’s view:
|
|
913
|
+
<pre class='ruby'>
|
|
914
|
+
<span class='punct'><</span><span class='ident'>font</span> <span class='ident'>color</span><span class='punct'>="</span><span class='string'>red</span><span class='punct'>"></span><span class='constant'>Welcome</span> <span class='ident'>to</span> <span class='ident'>my</span> <span class='ident'>website</span><span class='punct'>.</</span><span class='regex'>font><br>
|
|
915
|
+
<img src="under_construction.gif"><br>
|
|
916
|
+
<font color="blue">It was coded by hand in notepad.<</span><span class='punct'>/</span><span class='ident'>font</span><span class='punct'>><</span><span class='ident'>br</span><span class='punct'>></span>
|
|
917
|
+
<span class='punct'><</span><span class='ident'>font</span> <span class='ident'>color</span><span class='punct'>="</span><span class='string'>green</span><span class='punct'>"></span><span class='constant'>Tell</span> <span class='ident'>me</span> <span class='ident'>what</span> <span class='ident'>you</span> <span class='punct'><</span><span class='ident'>blink</span><span class='punct'>></span><span class='ident'>think!</span><span class='punct'>!</</span><span class='regex'>blink><</span><span class='punct'>/</span><span class='ident'>font</span><span class='punct'>><</span><span class='ident'>br</span><span class='punct'>></span>
|
|
918
|
+
|
|
919
|
+
<span class='punct'><%</span> <span class='ident'>content_for</span> <span class='symbol'>:sidebar</span> <span class='keyword'>do</span> <span class='punct'>%></span><span class='string'>
|
|
920
|
+
Hot Links<br</span><span class='punct'>></span>
|
|
921
|
+
<span class='punct'><</span><span class='ident'>a</span> <span class='ident'>href</span><span class='punct'>="</span><span class='string'>http://www.netscape.com</span><span class='punct'>"></span><span class='constant'>Netscape</span><span class='punct'></</span><span class='regex'>a><br>
|
|
922
|
+
<a href="http:</span><span class='punct'>//</span><span class='ident'>www</span><span class='punct'>.</span><span class='ident'>lycos</span><span class='punct'>.</span><span class='ident'>com</span><span class='punct'>"</span><span class='string'>>Lycos</a><br>
|
|
923
|
+
<a href=</span><span class='punct'>"</span><span class='ident'>http</span><span class='punct'>:/</span><span class='regex'></span><span class='punct'>/</span><span class='ident'>www</span><span class='punct'>.</span><span class='ident'>walmart</span><span class='punct'>.</span><span class='ident'>com</span><span class='punct'>"</span><span class='string'>>Wal Mart</a><br>
|
|
924
|
+
<% end %><span class='normal'>
|
|
925
|
+
</span></span></pre>
|
|
926
|
+
|
|
927
|
+
<p>You got it, right? <span class='code'>yield :sidebar</span> is going to be replaced by whatever block is passed to <span class='code'>content_for :sidebar</span>. In this case, Larry’s sidebar.</p>
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
<p>Ah, solidarity:</p>
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
<div class="lightbox"><a href="http://errtheblog.com/static/images/larrys_php.jpg" rel="lightbox"><img src="http://errtheblog.com/static/images/larrys_php-small.jpg" alt='submit_to_popup form'></a></div>
|
|
934
|
+
|
|
935
|
+
<p>That’s fairly useful, but it means Larry has to set <span class='code'>:sidebar</span> in every view if he wants one to always show up. A nice thing to do is provide a default.</p>
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
<h3>The Conditional</h3>
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
Larry just needs to replace, in his layout,
|
|
942
|
+
<pre class='ruby'>
|
|
943
|
+
<span class='punct'><%=</span><span class='string'> yield :sidebar %><span class='normal'>
|
|
944
|
+
</span></span></pre>
|
|
945
|
+
|
|
946
|
+
<p>with</p>
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
<pre class='ruby'>
|
|
950
|
+
<span class='punct'><%=</span><span class='string'> (sidebar </span><span class='punct'>=</span> <span class='keyword'>yield</span> <span class='symbol'>:sidebar</span><span class='punct'>)</span> <span class='punct'>?</span> <span class='ident'>sidebar</span> <span class='punct'>:</span> <span class='ident'>render</span><span class='punct'>(</span><span class='symbol'>:partial</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>shared/sidebar</span><span class='punct'>')</span> <span class='punct'>%></span><span class='string'><span class='normal'>
|
|
951
|
+
</span></span></pre>
|
|
952
|
+
|
|
953
|
+
<p>Now <span class='code'>shared/sidebar</span> will always be rendered unless a view defines <span class='code'>:sidebar</span> with <span class='code'>content_for</span>. So, you can override a default element of the layout. Nice.</p>
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
<p>As an aside, you can access <span class='code'>@content_for_sidebar</span> directly but that’s not legit. Deprecated.</p>
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
<h3>The Faux Nested Layout</h3>
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
<p>Imagine Larry has a whole bunch of controllers. He is happy with the default sidebar trick but there’s still an issue: he wants all the <span class='code'>HomeController</span> views to have a standard sidebar and all the <span class='code'>UsersController</span> to have a different standard sidebar.</p>
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
<p>One idea is to remove the <span class='code'>shared/</span> from the conditional in his layout:</p>
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
<pre class='ruby'>
|
|
969
|
+
<span class='punct'><%=</span><span class='string'> (sidebar </span><span class='punct'>=</span> <span class='keyword'>yield</span> <span class='symbol'>:sidebar</span><span class='punct'>)</span> <span class='punct'>?</span> <span class='ident'>sidebar</span> <span class='punct'>:</span> <span class='ident'>render</span><span class='punct'>(</span><span class='symbol'>:partial</span> <span class='punct'>=></span> <span class='punct'>'</span><span class='string'>sidebar</span><span class='punct'>')</span> <span class='punct'>%></span><span class='string'><span class='normal'>
|
|
970
|
+
</span></span></pre>
|
|
971
|
+
|
|
972
|
+
<p>Now either <span class='code'>home/_sidebar.rhtml</span> or <span class='code'>users/_sidebar.rhtml</span> will be rendered depending on which controller you’re in. The problem is Larry loses his ‘catch-all’ default sidebar and is forced to create a <span class='code'>_sidebar.rhtml</span> file for every controller. Not cool.</p>
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
<p>I tell Larry, “Throw away that code and change it back to the conditional which uses <span class='code'>shared/sidebar</span>. Now, think about layouts. If you have a <span class='code'>HomeController</span> and <span class='code'>home.rhtml</span> exists in your <span class='code'>views/layouts/</span> directory, Rails will render that. Perfect place to define a <span class='code'>home</span>-wide sidebar, yeah?”</p>
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
<span class='code'>views/layouts/home.rhtml</span>:
|
|
979
|
+
<pre class='ruby'>
|
|
980
|
+
<span class='punct'><%</span> <span class='ident'>content_for</span> <span class='symbol'>:sidebar</span> <span class='keyword'>do</span> <span class='punct'>%></span><span class='string'>
|
|
981
|
+
Cool Pages on My Site:<br</span><span class='punct'>></span>
|
|
982
|
+
<span class='punct'><</span><span class='ident'>a</span> <span class='ident'>href</span><span class='punct'>="</span><span class='string'>/home/lonely</span><span class='punct'>"></span><span class='constant'>LonelyGrrl</span> <span class='constant'>Videos</span><span class='punct'></</span><span class='regex'>a><br>
|
|
983
|
+
<a href="</span><span class='punct'>/</span><span class='ident'>home</span><span class='punct'>/</span><span class='ident'>pagerank</span><span class='punct'>"</span><span class='string'>>My Google Pagerank</a><br>
|
|
984
|
+
<a href=</span><span class='punct'>"/</span><span class='ident'>home</span><span class='punct'>/</span><span class='ident'>web2</span><span class='punct'>"</span><span class='string'>>Web 2.0 Logo Generator (lol)</a>
|
|
985
|
+
<% end %>
|
|
986
|
+
<%= render :file => 'layouts/application' %><span class='normal'>
|
|
987
|
+
</span></span></pre>
|
|
988
|
+
|
|
989
|
+
<p>This ‘layout’ file is setting <span class='code'>:sidebar</span> then rendering the <span class='code'>application</span> layout. Larry just needs to do the same thing for <span class='code'>views/layouts/users.rhtml</span> and he’s all set.</p>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
<p>Let’s recap. Larry can now define <span class='code'>content_for :sidebar</span> in a view, define it for a whole set of controller views, and also have a site-wide default. All at the same time. Talk about power!</p>
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
<p>One caveat here is that <span class='code'>content_for</span> <strong>appends</strong> content. It don’t replace it. If you’re defining <span class='code'>:sidebar</span> in a view under <span class='code'>views/home/</span>, using the above example, you’re going to end up with what looks like two sidebars: the one in the <span class='code'>home.rhtml</span> layout file and the one in your specific view.</p>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
<p>And hey, if you want real nested layouts there’s a <a href='http://rubyforge.org/projects/nested-layouts/'>plugin</a> for Ruby on Rails available. So get that.</p>
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
<h3>The Stylesheet</h3>
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
<p>Years pass. Larry learns a bit of <span class='caps'>CSS</span> and begins working for a big, corporate website. Special promotions are demanded by advertisers: they want to advertise on pages which have their own unique style with which “the kids” can identify. Something street. Like those <span class='caps'>PSP</span> graffiti ads.</p>
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
<p>Larry, now a seasoned Rails pro, knows this is not a problem. <span class='code'>content_for</span>, after all. He comes up with this:</p>
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
<pre class='ruby'>
|
|
1011
|
+
<span class='punct'><</span><span class='ident'>html</span><span class='punct'>></span>
|
|
1012
|
+
<span class='punct'><</span><span class='ident'>head</span><span class='punct'>></span>
|
|
1013
|
+
<span class='punct'><</span><span class='ident'>title</span><span class='punct'>></span><span class='constant'>Big</span> <span class='constant'>Corporate</span> <span class='constant'>Website</span> <span class='number'>4.0</span> <span class='constant'>Beta</span><span class='punct'></</span><span class='regex'>title>
|
|
1014
|
+
|
|
1015
|
+
<%= stylesheet_link_tag 'main' %>
|
|
1016
|
+
<%= yield :stylesheet %>
|
|
1017
|
+
<</span><span class='punct'>/</span><span class='ident'>head</span><span class='punct'>></span>
|
|
1018
|
+
<span class='punct'><</span><span class='ident'>body</span><span class='punct'>></span>
|
|
1019
|
+
<span class='punct'><%=</span><span class='string'> yield %>
|
|
1020
|
+
</body>
|
|
1021
|
+
</html><span class='normal'>
|
|
1022
|
+
</span></span></pre>
|
|
1023
|
+
|
|
1024
|
+
<p>See it? If there’s no <span class='code'>content_for :stylesheet</span>, everything works. However, Larry can also bust out a <span class='code'>content_for :stylesheet</span> in any view to add a bit more spice to that particular page. Like:</p>
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
<pre class='ruby'>
|
|
1028
|
+
<span class='punct'><%</span> <span class='ident'>content_for</span> <span class='symbol'>:stylesheet</span> <span class='keyword'>do</span> <span class='punct'>%></span><span class='string'>
|
|
1029
|
+
<%= stylesheet_link_tag 'railsconf' -%</span><span class='punct'>></span>
|
|
1030
|
+
<span class='punct'><%</span> <span class='keyword'>end</span> <span class='punct'>%></span><span class='string'>
|
|
1031
|
+
|
|
1032
|
+
<h1</span><span class='punct'>></span><span class='constant'>Welcome</span> <span class='ident'>to</span> <span class='ident'>our</span> <span class='constant'>RailsConf</span> <span class='ident'>information</span> <span class='ident'>page!</span><span class='punct'></</span><span class='regex'>h1><span class='normal'>
|
|
1033
|
+
</span></span></pre>
|
|
1034
|
+
|
|
1035
|
+
<p>Now his <span class='code'>h1</span>’s can be as nutty as all hell and won’t affect the other <span class='code'>h1</span>’s in his meticulously crafted website. He can even change the background color. Something pastel, I’d imagine.</p>
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
<h3>The Fin</h3>
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
<p>All of this <span class='code'>content_for</span> magic lovingly wraps ActionView’s <span class='code'>capture</span> method. The <a href='http://api.rubyonrails.org/classes/ActionView/Helpers/CaptureHelper.html'>Rails <span class='caps'>API</span></a> has the scoop. Just try to remember <span class='code'>:layout</span> is off limits when dealing with <span class='code'>content_for</span>. If you use it, you’ll just be messing with what gets displayed in your layout’s vanilla <span class='code'><%= yield %></span> call.</p>
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
<p>The web’s really all about <span class='caps'>HTML</span>, amirite? I dig the stuff <a href='http://codefluency.com/'>Bruce</a> is doing and hey, <a href='http://www.matthewman.net/articles/2006/09/04/new-rails-feature-simply_helpful'>SimplyHelpful</a> looks like a step in the right direction. My memories of <a href='http://smarty.php.net/'>Smarty</a> are cherised, but ActionView has stolen my heart.</p>
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
</div>
|
|
1049
|
+
</li>
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
<li class="post-li">
|
|
1057
|
+
<div id="time-travel">
|
|
1058
|
+
<a href="/page/2"><img alt="Older" src="/images/theme/older.gif" /></a>
|
|
1059
|
+
</div>
|
|
1060
|
+
|
|
1061
|
+
</li>
|
|
1062
|
+
|
|
1063
|
+
</ul>
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
<div id="footer">
|
|
1067
|
+
|
|
1068
|
+
<div class="projects">
|
|
1069
|
+
<h3 class="title">Projects</h3>
|
|
1070
|
+
<ul>
|
|
1071
|
+
<li><a href="http://cheat.errtheblog.com/">Cheat! Sheets</a> <li><a href="http://require.errtheblog.com/">require 'errtheblog'</a></li>
|
|
1072
|
+
<li><a href="http://errtheblog.com/post/27">acts_as_cached</a></li>
|
|
1073
|
+
<li><a href="http://errtheblog.com/post/15">acts_as_textiled</a></li>
|
|
1074
|
+
<li><a href="http://errtheblog.com/post/37">tagurit [micrOformats]</a></li>
|
|
1075
|
+
</ul>
|
|
1076
|
+
</div>
|
|
1077
|
+
|
|
1078
|
+
<div>
|
|
1079
|
+
<h3 class="title">Past Wanderings</h3>
|
|
1080
|
+
<ul>
|
|
1081
|
+
<li><a href="/post/1">first post!</a></li>
|
|
1082
|
+
<li><a href="/post/2">Block to Partial</a></li>
|
|
1083
|
+
<li><a href="/post/3">acts_as_textiled</a></li>
|
|
1084
|
+
<li><a href="/post/4">Colored Tests</a></li>
|
|
1085
|
+
<li><a href="/post/5">Accessor Missing</a></li>
|
|
1086
|
+
</ul>
|
|
1087
|
+
</div>
|
|
1088
|
+
|
|
1089
|
+
<div class="meta">
|
|
1090
|
+
This is Err,
|
|
1091
|
+
the weblog of <span class="vcard"><a href="http://www.pjhyett.com" class="url fn">PJ Hyett</a></span>
|
|
1092
|
+
and <span class="vcard"><a href="http://ozmm.org" class="url fn">Chris Wanstrath</a></span>.
|
|
1093
|
+
<br/>All original content copyright ©2006 the aforementioned.
|
|
1094
|
+
</div>
|
|
1095
|
+
|
|
1096
|
+
</div>
|
|
1097
|
+
|
|
1098
|
+
</div>
|
|
1099
|
+
|
|
1100
|
+
</body>
|
|
1101
|
+
</html>
|