jashmenn-git-style-binaries 0.1.7 → 0.1.9
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +6 -0
- data/Rakefile +1 -1
- data/VERSION.yml +1 -1
- data/lib/git-style-binary.rb +12 -1
- data/test/running_binaries_test.rb +2 -2
- data/vendor/gems/trollop/FAQ.txt +35 -0
- data/vendor/gems/trollop/History.txt +97 -0
- data/vendor/gems/trollop/Manifest.txt +7 -0
- data/vendor/gems/trollop/README.txt +40 -0
- data/vendor/gems/trollop/Rakefile +36 -0
- data/vendor/gems/trollop/lib/trollop.rb +735 -0
- data/vendor/gems/trollop/release-script.txt +13 -0
- data/vendor/gems/trollop/test/test_trollop.rb +1042 -0
- data/vendor/gems/trollop/www/index.html +167 -0
- metadata +11 -2
@@ -0,0 +1,167 @@
|
|
1
|
+
<html>
|
2
|
+
<head>
|
3
|
+
<title>Trollop</title>
|
4
|
+
<style type="text/css">
|
5
|
+
.ruby { background: #111122; padding: 10px; color: #228822; width: 70em; }
|
6
|
+
.ruby .normal { color: #fff; }
|
7
|
+
.ruby .comment { color: #99f }
|
8
|
+
.ruby .keyword { color: #A44; font-weight: bold; }
|
9
|
+
.ruby .method { color: #44f; }
|
10
|
+
.ruby .class { color: #0c4; }
|
11
|
+
.ruby .module { color: #050; }
|
12
|
+
.ruby .punct { color: #FF0; font-weight: bold; }
|
13
|
+
.ruby .symbol { color: #ff0; }
|
14
|
+
.ruby .string { color: #4f4 }
|
15
|
+
.ruby .char { color: #F07; }
|
16
|
+
.ruby .ident { color: #fff; }
|
17
|
+
.ruby .constant { color: #0c4; }
|
18
|
+
.ruby .regex { color: #B66; background: #444; }
|
19
|
+
.ruby .number { color: #F99; }
|
20
|
+
.ruby .attribute { color: #fc4; }
|
21
|
+
.ruby .global { color: #7FB; }
|
22
|
+
.ruby .expr { color: #227; }
|
23
|
+
.ruby .escape { color: #277; }
|
24
|
+
</style>
|
25
|
+
</head>
|
26
|
+
|
27
|
+
<body>
|
28
|
+
|
29
|
+
<h1>Trollop</h1>
|
30
|
+
|
31
|
+
<p style="border: solid 1px black; background: #ccc; padding: 0.5em;">
|
32
|
+
Current project news: see the <a href="http://all-thing.net/search/label/trollop">blog</a>.
|
33
|
+
</p>
|
34
|
+
|
35
|
+
<p>Trollop is a commandline option parser for Ruby that <i>gets out of your
|
36
|
+
way</i>. One line of code per option is all you need to write. For that, you get
|
37
|
+
a nice automatically-generated help page (fit to your screen size!), robust
|
38
|
+
option parsing, command subcompletion, and sensible defaults for everything you
|
39
|
+
don't specify.</p>
|
40
|
+
|
41
|
+
<p> Reasons to use Trollop:
|
42
|
+
<ol>
|
43
|
+
<li> It requires <i>fewer lines of code</i> than any other option out there. </li>
|
44
|
+
<li> It doesn't require you to subclass some shit just to use a damn option parser.</li>
|
45
|
+
</li>
|
46
|
+
<li> It's a single file. You don't even need to make it a dependency. Just throw it in <code>lib/</code>.</li>
|
47
|
+
<li> This gradient-free webpage. Fight the candy! </li>
|
48
|
+
</ol>
|
49
|
+
</p>
|
50
|
+
|
51
|
+
<p> To install, get the "raw blob data" for <a href="http://gitorious.org/projects/trollop/repos/mainline/blobs/master/lib%2Ftrollop.rb">lib/trollop.rb</a>, or download the tarball from the <a href="http://rubyforge.org/projects/trollop/">Trollop Rubyforge page</a>, or command your computer to <code>gem install trollop</code>.</p>
|
52
|
+
|
53
|
+
|
54
|
+
<p> To hack, see the <a href="http://gitorious.org/projects/trollop">Trollop Gitorious page</a>. </p>
|
55
|
+
|
56
|
+
<p>To understand, read the examples below, the <a href="FAQ.txt">FAQ</a>, and the <a href="trollop/">API docs</a>.
|
57
|
+
|
58
|
+
<h2>Examples</h2>
|
59
|
+
<h3>Simple</h3>
|
60
|
+
<pre class="ruby"><span class="ident">require</span> <span class="punct">'</span><span class="string">trollop</span><span class="punct">'</span>
|
61
|
+
<span class="ident">opts</span> <span class="punct">=</span> <span class="constant">Trollop</span><span class="punct">::</span><span class="ident">options</span> <span class="keyword">do</span>
|
62
|
+
<span class="ident">opt</span> <span class="symbol">:monkey</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Use monkey mode</span><span class="punct">"</span> <span class="comment"># a flag --monkey, defaulting to false</span>
|
63
|
+
<span class="ident">opt</span> <span class="symbol">:goat</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Use goat mode</span><span class="punct">",</span> <span class="symbol">:default</span> <span class="punct">=></span> <span class="constant">true</span> <span class="comment"># a flag --goat, defaulting to true</span>
|
64
|
+
<span class="ident">opt</span> <span class="symbol">:num_limbs</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Number of limbs</span><span class="punct">",</span> <span class="symbol">:default</span> <span class="punct">=></span> <span class="number">4</span> <span class="comment"># an integer --num-limbs <i>, defaulting to 4</span>
|
65
|
+
<span class="ident">opt</span> <span class="symbol">:num_thumbs</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Number of thumbs</span><span class="punct">",</span> <span class="symbol">:type</span> <span class="punct">=></span> <span class="symbol">:int</span> <span class="comment"># an integer --num-thumbs <i>, defaulting to nil</span>
|
66
|
+
<span class="keyword">end</span>
|
67
|
+
|
68
|
+
<span class="ident">p</span> <span class="ident">opts</span> <span class="comment"># returns a hash: { :monkey => false, :goat => true, :num_limbs => 4, :num_thumbs => nil }</span>
|
69
|
+
</pre>
|
70
|
+
|
71
|
+
<p>
|
72
|
+
<ul>
|
73
|
+
<li><tt>Trollop::options</tt> returns a hash of values. That's all the output you get.</li>
|
74
|
+
<li>Underscores are converted to dashes. <tt>opt :hello_there</tt> corresponds to an option <tt>--hello-there</tt>.
|
75
|
+
<li>All options are taken to be boolean flags, defaulting to false, unless you specify a default or a type. The type will be inferred from the default if given, so no need to specify both.</li>
|
76
|
+
<li>Short (one-character) option names are created automatically. You can set them manually with <tt>:short</tt>.
|
77
|
+
</ul>
|
78
|
+
</p>
|
79
|
+
|
80
|
+
<h3>Medium</h3>
|
81
|
+
<pre class="ruby">
|
82
|
+
<span class="ident">require</span> <span class="punct">'</span><span class="string">trollop</span><span class="punct">'</span>
|
83
|
+
<span class="ident">opts</span> <span class="punct">=</span> <span class="constant">Trollop</span><span class="punct">::</span><span class="ident">options</span> <span class="keyword">do</span>
|
84
|
+
<span class="ident">version</span> <span class="punct">"</span><span class="string">test 1.2.3 (c) 2008 William Morgan</span><span class="punct">"</span>
|
85
|
+
<span class="ident">banner</span> <span class="punct"><<-</span><span class="constant">EOS</span><span class="string">
|
86
|
+
Test is an awesome program that does something very, very important.
|
87
|
+
|
88
|
+
Usage:
|
89
|
+
test [options] <filenames>+
|
90
|
+
where [options] are:
|
91
|
+
</span><span class="constant">EOS</span>
|
92
|
+
|
93
|
+
<span class="ident">opt</span> <span class="symbol">:ignore</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Ignore incorrect values</span><span class="punct">"</span>
|
94
|
+
<span class="ident">opt</span> <span class="symbol">:file</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Extra data filename to read in, with a very long option description like this one</span><span class="punct">",</span> <span class="symbol">:type</span> <span class="punct">=></span> <span class="constant">String</span>
|
95
|
+
<span class="ident">opt</span> <span class="symbol">:volume</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Volume level</span><span class="punct">",</span> <span class="symbol">:default</span> <span class="punct">=></span> <span class="number">3.0</span>
|
96
|
+
<span class="ident">opt</span> <span class="symbol">:iters</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Number of iterations</span><span class="punct">",</span> <span class="symbol">:default</span> <span class="punct">=></span> <span class="number">5</span>
|
97
|
+
<span class="keyword">end</span>
|
98
|
+
<span class="constant">Trollop</span><span class="punct">::</span><span class="ident">die</span> <span class="symbol">:volume</span><span class="punct">,</span> <span class="punct">"</span><span class="string">must be non-negative</span><span class="punct">"</span> <span class="keyword">if</span> <span class="ident">opts</span><span class="punct">[</span><span class="symbol">:volume</span><span class="punct">]</span> <span class="punct"><</span> <span class="number">0</span>
|
99
|
+
<span class="constant">Trollop</span><span class="punct">::</span><span class="ident">die</span> <span class="symbol">:file</span><span class="punct">,</span> <span class="punct">"</span><span class="string">must exist</span><span class="punct">"</span> <span class="keyword">unless</span> <span class="constant">File</span><span class="punct">.</span><span class="ident">exist?</span><span class="punct">(</span><span class="ident">opts</span><span class="punct">[</span><span class="symbol">:file</span><span class="punct">])</span> <span class="keyword">if</span> <span class="ident">opts</span><span class="punct">[</span><span class="symbol">:file</span><span class="punct">]</span>
|
100
|
+
</pre>
|
101
|
+
|
102
|
+
<p>
|
103
|
+
<ul>
|
104
|
+
<li>You can specify a version and some banner text for the help message. <tt>--help</tt> and <tt>--version</tt> are defined for you.</li>
|
105
|
+
<li>Any special error-checking is done by you, on the option hash. You can call <tt>Trollop::die</tt> to die with a nice message.</li>
|
106
|
+
</ul>
|
107
|
+
</p>
|
108
|
+
|
109
|
+
<h3>Sub-commands, a la SVN and Git</h3>
|
110
|
+
<pre class="ruby"><span class="ident">require</span> <span class="punct">'</span><span class="string">trollop</span><span class="punct">'</span>
|
111
|
+
|
112
|
+
<span class="comment">## Here's a program called "magic". We want this behavior:</span>
|
113
|
+
<span class="comment">##</span>
|
114
|
+
<span class="comment">## magic delete <fn> => deletes a file</span>
|
115
|
+
<span class="comment">## magic copy <fn> => copies a file</span>
|
116
|
+
<span class="comment">##</span>
|
117
|
+
<span class="comment">## So 'delete' and 'copy' are subcommands.</span>
|
118
|
+
<span class="comment">##</span>
|
119
|
+
<span class="comment">## There are some global options, which appear to the left of the subcommand.</span>
|
120
|
+
<span class="comment">## There are some subcommand options, which appear to the right.</span>
|
121
|
+
<span class="comment">##</span>
|
122
|
+
<span class="comment">## Subcommand options can be specific to the subcommand. 'delete' might take</span>
|
123
|
+
<span class="comment">## different options from 'copy'.</span>
|
124
|
+
<span class="comment">##</span>
|
125
|
+
<span class="comment">## We do this by calling Trollop twice; one for the global options and once for</span>
|
126
|
+
<span class="comment">## the subcommand options. We need to tell Trollop what the subcommands are, so</span>
|
127
|
+
<span class="comment">## that it stops on them.</span>
|
128
|
+
|
129
|
+
<span class="constant">SUB_COMMANDS</span> <span class="punct">=</span> <span class="punct">%w(</span><span class="string">delete copy</span><span class="punct">)</span>
|
130
|
+
<span class="ident">global_opts</span> <span class="punct">=</span> <span class="constant">Trollop</span><span class="punct">::</span><span class="ident">options</span> <span class="keyword">do</span>
|
131
|
+
<span class="ident">banner</span> <span class="punct">"</span><span class="string">magic file deleting and copying utility</span><span class="punct">"</span>
|
132
|
+
<span class="ident">opt</span> <span class="symbol">:dry_run</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Don't actually do anything</span><span class="punct">",</span> <span class="symbol">:short</span> <span class="punct">=></span> <span class="punct">"</span><span class="string">-n</span><span class="punct">"</span>
|
133
|
+
<span class="ident">stop_on</span> <span class="constant">SUB_COMMANDS</span>
|
134
|
+
<span class="keyword">end</span>
|
135
|
+
|
136
|
+
<span class="ident">cmd</span> <span class="punct">=</span> <span class="constant">ARGV</span><span class="punct">.</span><span class="ident">shift</span> <span class="comment"># get the subcommand</span>
|
137
|
+
<span class="ident">cmd_opts</span> <span class="punct">=</span> <span class="keyword">case</span> <span class="ident">cmd</span>
|
138
|
+
<span class="keyword">when</span> <span class="punct">"</span><span class="string">delete</span><span class="punct">"</span> <span class="comment"># parse delete options</span>
|
139
|
+
<span class="constant">Trollop</span><span class="punct">::</span><span class="ident">options</span> <span class="keyword">do</span>
|
140
|
+
<span class="ident">opt</span> <span class="symbol">:force</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Force deletion</span><span class="punct">"</span>
|
141
|
+
<span class="keyword">end</span>
|
142
|
+
<span class="keyword">when</span> <span class="punct">"</span><span class="string">copy</span><span class="punct">"</span> <span class="comment"># parse copy options</span>
|
143
|
+
<span class="constant">Trollop</span><span class="punct">::</span><span class="ident">options</span> <span class="keyword">do</span>
|
144
|
+
<span class="ident">opt</span> <span class="symbol">:double</span><span class="punct">,</span> <span class="punct">"</span><span class="string">Copy twice for safety's sake</span><span class="punct">"</span>
|
145
|
+
<span class="keyword">end</span>
|
146
|
+
<span class="keyword">else</span>
|
147
|
+
<span class="constant">Trollop</span><span class="punct">::</span><span class="ident">die</span> <span class="punct">"</span><span class="string">unknown subcommand <span class="expr">#{cmd.inspect}</span></span><span class="punct">"</span>
|
148
|
+
<span class="keyword">end</span>
|
149
|
+
|
150
|
+
<span class="ident">puts</span> <span class="punct">"</span><span class="string">Global options: <span class="expr">#{global_opts.inspect}</span></span><span class="punct">"</span>
|
151
|
+
<span class="ident">puts</span> <span class="punct">"</span><span class="string">Subcommand: <span class="expr">#{cmd.inspect}</span></span><span class="punct">"</span>
|
152
|
+
<span class="ident">puts</span> <span class="punct">"</span><span class="string">Subcommand options: <span class="expr">#{cmd_opts.inspect}</span></span><span class="punct">"</span>
|
153
|
+
<span class="ident">puts</span> <span class="punct">"</span><span class="string">Remaining arguments: <span class="expr">#{ARGV.inspect}</span></span><span class="punct">"</span>
|
154
|
+
|
155
|
+
</pre>
|
156
|
+
|
157
|
+
<h2> Contributors </h2>
|
158
|
+
|
159
|
+
<p>Trollop is brought to you by <a href="http://cs.stanford.edu/~ruby/">William Morgan</a> and by:
|
160
|
+
<ul>
|
161
|
+
<li>Tuomas Kareinen <tkareine at the gmail dot coms></li>
|
162
|
+
<li>Ohad Lutzky <ohad at the lutzky dot nets></li>
|
163
|
+
</ul>
|
164
|
+
</p>
|
165
|
+
|
166
|
+
</body>
|
167
|
+
</html>
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jashmenn-git-style-binaries
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.9
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Nate Murray
|
@@ -9,7 +9,7 @@ autorequire:
|
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
11
|
|
12
|
-
date: 2009-
|
12
|
+
date: 2009-06-11 00:00:00 -07:00
|
13
13
|
default_executable:
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
@@ -64,6 +64,15 @@ files:
|
|
64
64
|
- test/running_binaries_test.rb
|
65
65
|
- test/shoulda_macros/matching_stdio.rb
|
66
66
|
- test/test_helper.rb
|
67
|
+
- vendor/gems/trollop/FAQ.txt
|
68
|
+
- vendor/gems/trollop/History.txt
|
69
|
+
- vendor/gems/trollop/Manifest.txt
|
70
|
+
- vendor/gems/trollop/README.txt
|
71
|
+
- vendor/gems/trollop/Rakefile
|
72
|
+
- vendor/gems/trollop/lib/trollop.rb
|
73
|
+
- vendor/gems/trollop/release-script.txt
|
74
|
+
- vendor/gems/trollop/test/test_trollop.rb
|
75
|
+
- vendor/gems/trollop/www/index.html
|
67
76
|
has_rdoc: true
|
68
77
|
homepage: http://github.com/jashmenn/git-style-binaries
|
69
78
|
post_install_message:
|