Class: ParseArgs::Parser

Inherits:
Object show all
Includes:
Util
Defined in:
lib/parseargs.rb,
lib/parseargs-0.2.0.rb

Defined Under Namespace

Classes: Argument, Keyword

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

append_features

Constructor Details

#initialize(opts = {}, &b) ⇒ Parser

Returns a new instance of Parser.



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/parseargs.rb', line 166

def initialize(opts = {}, &b)
#--{{{
  @required_arguments = []
  @optional_arguments = []
  @required_keywords = []
  @optional_keywords = []
  opts.each{|k,v| send k, v}
  instance_eval &b
#--}}}
end

Instance Attribute Details

#receiver ⇒ Object

class Keyword



165
166
167
 
# File 'lib/parseargs.rb', line 165

def receiver
  @receiver
end

Instance Method Details

#define_arguments(list, required, *descs) ⇒ Object

–}}}



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/parseargs.rb', line 176

def define_arguments(list, required, *descs)
#--{{{
  unless descs.empty?
    metadata = descs.size >= 2 && Hash === descs.last ? descs.pop : {}
    descs.flatten!
    mdefault ||= get_kw('default', metadata)
    descs.each do |desc|
      names, default = Hash === desc ? desc.to_a.first : [desc, mdefault]
      req = default ? false : required
      names = [ names ] unless names.respond_to? :each
      names.each do |name|
        list << Argument::new(name, metadata.merge('required'=>req,'default'=>default)) 
      end
    end
  end
  list
#--}}}
end

#define_keywords(list, required, *descs) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/parseargs.rb', line 234

def define_keywords(list, required, *descs)
#--{{{
  unless descs.empty?
    metadata = descs.size >= 2 && Hash === descs.last ? descs.pop : {}
    descs.flatten!
    mdefault ||= get_kw('default', metadata)
    descs.each do |desc|
      names, default = Hash === desc ? desc.to_a.first : [desc, mdefault]
      req = default ? false : required
      names = [ names ] unless names.respond_to? :each
      names.each do |name|
        list << Keyword::new(name, metadata.merge('required'=>req,'default'=>default)) 
      end
    end
  end
  list
#--}}}
end

#extract_kw(kw, kws) ⇒ Object

–}}}



357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/parseargs.rb', line 357

def extract_kw kw, kws 
#--{{{
  k = kw.name
  return [k, kws[k]] if kws.has_key? k
  k = "#{ k }" 
  return [k, kws[k]] if kws.has_key? k
  k = k.intern 
  return [k, kws[k]] if kws.has_key? k
  return [nil, nil]
#--}}}
end

#optional_arguments(*descs) ⇒ Object Also known as: optional_argument, opt_arguments, opt_argument, opt_args, opt_arg, o_args, o_arg, oas, oa 



216
217
218
219
220
221
222
223
224
 
# File 'lib/parseargs.rb', line 216

def optional_arguments(*descs)
#--{{{
  if descs.empty?
    @optional_arguments
  else
    define_arguments(@optional_arguments, false, *descs)
  end
#--}}}
end

#optional_keywords(*descs) ⇒ Object Also known as: optional_keyword, opt_keywords, opt_keyword, opt_kws, opt_kw, o_kws, o_kw, okws, okw 



272
273
274
275
276
277
278
279
280
 
# File 'lib/parseargs.rb', line 272

def optional_keywords(*descs)
#--{{{
  if descs.empty?
    @required_keywords
  else
    define_keywords(@optional_keywords, false, *descs)
  end
#--}}}
end

#parse(arg) ⇒ Object

TODO - thinks about *args signature??



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/parseargs.rb', line 293

def parse arg 
#--{{{
  enumerable, receiver =
    if Hash === arg
      a = arg.to_a
      pair = a.shift
      unless a.empty?
        raise ArgumentError, "wrong number of arguments(#{ a.size + 1 } for 1"
      end
      pair
    else
      [arg, Receiver::new]
    end

  p_args = enumerable.to_enum.map

  n = p_args.size

  @required_arguments.each do |arg|
    if p_args.empty? 
      raise ArgumentNotGiven, "<#{ arg.name }>"
    end
    p_arg = p_args.shift
    arg.value = p_arg
    receiver_set receiver, arg.name, arg.value
  end

  @optional_arguments.each do |arg|
    p_arg = p_args.empty? ? arg.default : p_args.shift
    arg.value = p_arg
    receiver_set receiver, arg.name, arg.value
  end

  if receiver.respond_to? "arguments="
    receiver.arguments = @required_arguments + @optional_arguments
  end

  p_kws = Hash === p_args.first ? p_args.shift : {}

  @required_keywords.each do |kw|
    p_kw, p_arg = extract_kw kw, p_kws
    raise KeywordNotGiven, "<#{ kw.name }>" if p_kw.nil?
    kw.value = p_arg
    receiver_set receiver, kw.name, kw.value
  end

  @optional_keywords.each do |kw|
    p_kw, p_arg = extract_kw kw, p_kws
    p_arg = p_kw ? p_arg : kw.default
    kw.value = p_arg
    receiver_set receiver, kw.name, kw.value
  end

  if receiver.respond_to? "keywords="
    receiver.keywords = @required_keywords + @optional_keywords
  end

  unless p_args.empty?
    raise ArgumentError, "wrong number of arguments(#{ n } for #{ n - p_args.size })"
  end

  receiver
#--}}}
end

#receiver_set(receiver, name, value) ⇒ Object

–}}}



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/parseargs.rb', line 368

def receiver_set receiver, name, value
#--{{{
  begin
    receiver.send "[]=", name, value
  rescue NameError
    begin
      receiver.send "#{ name }=", value
    rescue NameError
      receiver.send "#{ name }", value
    end
  end
#--}}}
end

#required_arguments(*descs) ⇒ Object Also known as: required_argument, req_arguments, req_argument, req_args, req_arg, r_args, r_arg, args, arg, arguments, argument, ras, ra

–}}}



194
195
196
197
198
199
200
201
202
 
# File 'lib/parseargs.rb', line 194

def required_arguments(*descs)
#--{{{
  if descs.empty?
    @required_arguments
  else
    define_arguments(@required_arguments, true, *descs)
  end
#--}}}
end

#required_keywords(*descs) ⇒ Object Also known as: required_keyword, req_keywords, req_keyword, req_kws, req_kw, r_kws, r_kw, kws, kw, keywords, keyword

–}}}



252
253
254
255
256
257
258
259
260
 
# File 'lib/parseargs.rb', line 252

def required_keywords(*descs)
#--{{{
  if descs.empty?
    @required_keywords
  else
    define_keywords(@required_keywords, true, *descs)
  end
#--}}}
end