forked from akitaonrails/utility-belt
-
Notifications
You must be signed in to change notification settings - Fork 1
/
usage.html
304 lines (180 loc) · 13.3 KB
/
usage.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<meta name="description" content="Baddest Ruby gem evar." />
<meta name="keywords" content="ruby, giles bowkett, batman, utility belt, gem, attack of the killer tomatoes" />
<meta name="author" content="Giles Bowkett / Original design: Andreas Viklund - http://andreasviklund.com/" />
<link rel="stylesheet" type="text/css" href="andreas00.css" media="screen,projection" />
<title>Utility Belt: Usage</title>
</head>
<body>
<div id="wrap">
<div id="header">
<h1><a href="http://utilitybelt.rubyforge.org">Utility Belt</a></h1>
<p><strong>IRB tools, tricks, and techniques</strong></p>
</div>
<div id="avmenu">
<h2 class="hide">Site menu:</h2>
<ul>
<li><a href="index.html">Overview</a></li>
<li><a href="usage.html">Usage</a></li>
<li><a href="authorship.html">Authorship</a></li>
<li><a href="http://rubyforge.org/projects/utilitybelt/">RubyForge Project</a></li>
</ul>
</div>
<div id="contentwide">
<h2>Synopsis And Usage</h2>
<h3>SYNOPSIS</h3>
<p>Utility Belt gives you a ton of new options and techniques in IRB. (You may find yourself putting its language patches in actual projects as well.) The way to use Utility Belt is to edit, or create, your .irbrc file. This is analogous to a Unix .bashrc, .tcshrc, .profile, or similar file.</p>
<p>Windows users have a couple options. The easiest is to define an environment variable called IRBRC and set it to the full path of your irbrc (e.g. "C:\Documents and Settings\<username>\_irbrc"). Presto, .irbrc for Windows. You could also set your HOME-Variable to any directory you want and put your ".irbrc" in there. (It needs to be called ".irbrc", "_irbrc" won't work). Since Windows Explorer won't let you create a file with a dot in the beginning, use any text editor (Notepad will do just fine) and "Save As" to save it as ".irbrc". (The quotation marks make the magic happen.) We don't recommend this if you're also using MSYS or Cygwin, as they use the same variable for their own purposes.</p>
<p>Adding Utility Belt to your .irbrc is easy:</p>
<pre>require 'rubygems'
require 'utility_belt'</pre>
<p>To use the Amazon shortcuts, you also need to set some environment variables. See the section on S3 under "Usage" for more. Also, if your terminal has a light background, you'll need to enable the light-background syntax coloring theme - see the section on themes under "Usage" for more.</p>
<h3>USAGE</h3>
<p>Using each of Utility Belt's tools is different:</p>
<h4>Interactively edit IRB code in your preferred text editor</h4>
<p>If your preferred text editor is vi(m), emacs, or TextMate, there are built-in commands: vi, emacs, and mate, respectively. To use another editor, use this command:</p>
<pre>edit_interactively(:the_name_of_my_editor)</pre>
<p>or</p>
<pre>edit_interactively("the name of my editor")</pre>
<p>or</p>
<pre>edit_interactively("/the/path/to/my/editor")</pre>
<p>If you're wondering why the method name is so ridiculously long, <a href="http://gilesbowkett.blogspot.com/2007/12/utility-belt-vs-rails.html" title="Giles Bowkett: Utility Belt vs. Rails">there's a story there</a>.</p>
<h4>Read from and write to OS X or Windows clipboard</h4>
<p>To read:</p>
<pre>Clipboard.read</pre>
<p>To write:</p>
<pre>Clipboard.write("something")</pre>
<h4>Post your code to Pastie with one command (OS X and Windows only)</h4>
<p>You must first equip the UtilityBelt with pastie in your .irbrc:</p>
<pre>UtilityBelt.equip(:pastie)</pre>
<p>This line will also automatically equip the Clipboard, which is required to use pastie.</p>
<p>First copy some code into your clipboard, or put it there with the Clipboard.write() class method. Then use the command:</p>
<pre>pastie</pre>
<p>or the shortcut version:</p>
<pre>pst</pre>
<p>Note that this method currently auto-formats all code as Ruby. Support for other languages is possible but not implemented yet. Also, this code is OS X and Windows only because it uses the Clipboard. (A platform-agnostic version without the clipboard aspect is certainly possible.)</p>
<h4>Unix-style history buffer</h4>
<p>Use "h" or "history" to view your command history, and "h! 123" to re-invoke command #123 in your buffer. "h!" with no args will run the last command.</p>
<h4>Write command history to file or vi</h4>
<p>To write your history to a file, use "history_write('/path/to/file')". To edit your history in vi, use "history_to_vi" or its shortcut alias "hvi".</p>
<h4>Grep classes and methods for strings</h4>
<p>Classes:</p>
<pre>>> grep_classes("ixnum")
#=> ["Fixnum"]
>> grep_classes("num")
#=> ["Bignum", "Fixnum", "Numeric", "REXML::SyncEnumerator"]</pre>
<p>Methods:</p>
<pre>>> "any arbitrary string".grep_methods("pretty")
#=> ["pretty_inspect", "pretty_print_instance_variables",
"pretty_print_inspect", "pretty_print", "pretty_print_cycle"]
>> 32.grep_methods("*")
#=> ["*", "**"]</pre>
<p>At some point it'll probably be a good idea to add regex support for these methods. (Of course if I do that, I'll probably have to change the name from grep to ack.)</p>
<h4>Verbosity controls for regular IRB and Rails console</h4>
<p>regular IRB: "verbose" or "v" / "quiet" or "q"</p>
<p>Rails: "log" method turns verbosity on, there isn't actually any method for turning it off. (Might add one at some point.)</p>
<h4>Finder shortcuts for Rails console</h4>
<pre>user(:all) / user(1)</pre>
<p>instead of</p>
<pre>User.find(:all) / User.find(1)</pre>
<p>Supports arbitrarily complex finds.</p>
<h4>Upload shortcut for Amazon S3</h4>
<p>First, define your secret keys in your environment variables:</p>
<pre>export AMAZON_ACCESS_KEY_ID='foofoofoofoofoo'
export AMAZON_SECRET_ACCESS_KEY='barbarbarbarbar'</pre>
<p>(Obviously, replace those with actual values.)</p>
<p>Then, you can use</p>
<pre>aws_upload("bucket_name","filename")</pre>
<p>To easily upload public-access files. This method will automatically connect to Amazon S3 for you, if your keys are defined in your environment variables. It also writes the resulting Amazon URL to your clipboard, if you're on OS X, so you can easily share the file with others. Note that you have to create the initial buckets manually - see <a href="http://amazon.rubyforge.org" title="AWS::S3 - Ruby Library for Amazon Simple Storage Service (S3)">amazon.rubyforge.org</a> for details on that.</p>
<p>A good way to use this is actually to have a default bucket, and create a further method in your .irbrc file:</p>
<pre>def my_bucket_name(filename)
aws_upload("my_default_bucket",filename)
end</pre>
<h4>Command-line Amazon S3 upload script</h4>
<p>Utility Belt also includes <code>amazon</code>, a simple command-line uploader for S3. It requires that you set your Amazon environment variables (see above). The usage is:</p>
<pre>amazon -b my_bucket_name filename other_filename</pre>
<p>(For any arbitrary number of filenames.)</p>
<p>Anytime you want to upload a file to your default bucket on S3, for example, the "images" bucket for your blog - or the "mp3" bucket if you're running a blog like Projectionist - all you have to do is</p>
<pre>amazon -b blog_files some_file.name</pre>
<p>Or</p>
<pre>amazon --bucket blog_files some_file.name</pre>
<p>And you're good to go. Of course, if that were too many characters to type, you could always take it one step further with a shell script. For instance, in bash:</p>
<pre>alias b1="amazon --bucket my_main_bucket $1"
alias b2="amazon --bucket my_other_bucket $1"</pre>
<p>And then you would only have to type:</p>
<pre>b1 file.name</pre>
<p>And of course tab completion will handle all the typing of the file name, assuming you choose your file names deliberately ahead of time to make tab completion effective, in which case all you have to type is "b1 f[tab]" and bam.</p>
<h4>Command-line Google shortcut (OS X only)</h4>
<p>To pop open a new window in your default browser with Google search results for a given search term, do:</p>
<pre>google "any given term"</pre>
<p>For one-word terms, you can omit the quotes:</p>
<pre>google term</pre>
<p>If you already have the search term in your clipboard, you can just type:</p>
<pre>google</pre>
<p>(The last approach is useful for unusual command-line error messages.)</p>
<h4>Auto-indentation</h4>
<p>Just type as normally. This just enables built-in but underused functionality in IRB. (The IRB default auto-indentation isn't perfect, but it clobbers the living hell out of no indentation at all.)</p>
<h4>_ special variable (like Unix shell var !!)</h4>
<p>More activation of built-in but underused functionality in IRB. _ functions like !! in Unix, with one subtle difference. Instead of re-issuing the previous command in your history, it gives you the last result of evaluating a command. This means when you start a new IRB session, _ won't go to your history, it'll just give you nil, and it means that some commands can't be repeated exactly. Nine out of ten times, however, it's pretty much the same thing.</p>
<p>Note that when combined with the h! in the command history code, you basically have two synonyms for !! here. Neither one is an exact replica, but between the two of them, you should have what you need.</p>
<h4>Extremely basic themes for Wirble syntax coloring</h4>
<p>Utility Belt incorporates <a href="http://pablotron.org/software/wirble/" title="Pablotron: Wirble">Wirble</a> as a dependency. Wirble provides syntax coloring. Utility Belt allows you to choose between two syntax coloring themes: Wirble's default, and an alternate color set for terminals with light backgrounds. The default theme is enabled by default (duh), but if you have a terminal with a light background, you can enable the light-background theme just by putting the following line of code in your .irbrc:</p>
<pre>UtilityBelt::Themes.background(:light)</pre>
<p>To revert back to the default, just use this:</p>
<pre>UtilityBelt::Themes.background(:dark)</pre>
<p>To specify an entirely new syntax color scheme, see the source code for this gem or for Wirble.</p>
<h4>Pascal/JavaScript-style "with" statement</h4>
<p>I use this with RSpec's spec_helper. Instead of:</p>
<pre>Spec::Runner.configure do |config|
config.use_transactional_fixtures = true
config.use_instantiated_fixtures = false
config.fixture_path = RAILS_ROOT + '/spec/fixtures'
config.mock_with :flexmock
end</pre>
<p>I do this:</p>
<pre>Spec::Runner.configure do |config|
with(config) do
use_transactional_fixtures = true
use_instantiated_fixtures = false
fixture_path = RAILS_ROOT + '/spec/fixtures'
mock_with :flexmock
end
end</pre>
<p>Note however that this blew up once and I have no idea why. Caveat emptor, et cetera.</p>
<h4>String#to_proc</h4>
<p>Syntactic sugar for functional programming. (<a href="http://weblog.raganwald.com/2007/10/stringtoproc.html" title="String#to_proc">More detail here</a>.) Rails' Symbol#to_proc is also included.</p>
<pre>(1..3).map(&'*2') => [2, 4, 6]
(1..3).map(&'[-1, _, 0]') => [[-1, 1, 0], [-1, 2, 0], [-1, 3, 0]]
(1..3).map(&'x -> y -> x * y').map(&'[2]') => [2, 4, 6]
(1..5).select(&'>2') => [3, 4, 5]
(1..3).map(&'x -> y -> x * y').map(&'.call(2)') => [2, 4, 6]
[5].map(&"(1.._).inject(&'*')") => [120]</pre>
<h4>Add and subtract Hashes with + and -</h4>
<pre>{:a => :b} + {:c => :d} = {:a => :b, :c => :d}
{:a => :b, :c => :d} - {:c => :d} = {:a => :b}
{:a => :b, :c => :d} - :c = {:a => :b}</pre>
<p>You could already do this with Arrays; now you can do it with Hashes as well. (I was kinda surprised the first time I tried to do this and realized I'd have to write it myself.)</p>
<h4>Grammatically-correct is_an? method - no more "is_a? Array" statements</h4>
<pre>>> [].is_an? Array
#=> true</pre>
<p>Most people don't care, but personally, "is_a? Array" drives me completely insane.</p>
<h4>Object#not</h4>
<p>Replace this:</p>
<pre>if !response.incomplete? && !response.invalid? && response.total > 0</pre>
<p>With this:</p>
<pre>if response.not.incomplete? && response.not.invalid? && response.total > 0</pre>
<p>Syntactic sugar for boolean conditions. (<a href="http://blog.jayfields.com/2007/08/ruby-adding-not-method-for-readability.html" title="Jay Fields Thoughts: Ruby: Adding a "not" method for readability">More detail here</a>.)</p>
<h4>One-character exit command</h4>
<pre>x</pre>
<p>Because life is too short to type whole words.</p>
</div>
<div id="footer">
<p>Copyright © 2007 Giles Bowkett | Design by <a href="http://andreasviklund.com">Andreas Viklund</a>.</p>
</div>
</div>
</body>
</html>