Class: ParseArgs::Parser
- Includes:
- Util
- Defined in:
- lib/parseargs.rb,
lib/parseargs-0.3.0.rb
Defined Under Namespace
Instance Attribute Summary collapse
-
#receiver ⇒ Object
class Keyword.
Instance Method Summary collapse
-
#define(what, list, required, *descs) ⇒ Object
–}}}.
-
#define_arguments(list, required, *descs) ⇒ Object
–}}}.
- #define_keywords(list, required, *descs) ⇒ Object
-
#extract_kw(kw, kws) ⇒ Object
–}}}.
-
#initialize(opts = {}, &b) ⇒ Parser
constructor
A new instance of Parser.
- #optional_arguments(*descs) ⇒ Object (also: #optional_argument, #opt_arguments, #opt_argument, #opt_args, #opt_arg, #o_args, #o_arg, #oas, #oa)
- #optional_keywords(*descs) ⇒ Object (also: #optional_keyword, #opt_keywords, #opt_keyword, #opt_kws, #opt_kw, #o_kws, #o_kw, #okws, #okw)
-
#parse(arg) ⇒ Object
TODO - thinks about *args signature??.
-
#receiver_set(receiver, name, value) ⇒ Object
–}}}.
-
#required_arguments(*descs) ⇒ Object
(also: #required_argument, #req_arguments, #req_argument, #req_args, #req_arg, #r_args, #r_arg, #args, #arg, #arguments, #argument, #ras, #ra)
–}}}.
-
#required_keywords(*descs) ⇒ Object
(also: #required_keyword, #req_keywords, #req_keyword, #req_kws, #req_kw, #r_kws, #r_kw, #kws, #kw, #keywords, #keyword)
–}}}.
Methods included from Util
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(what, 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(what, list, required, *descs) #--{{{ unless descs.empty? = descs.size >= 2 && Hash === descs.last ? descs.pop : {} descs.flatten! mdefault = get_kw('default', ) 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 << what::new(name, .merge('required' => req,'default' => default)) end end end list #--}}} end |
#define_arguments(list, required, *descs) ⇒ Object
–}}}
194 195 196 197 198 |
# File 'lib/parseargs.rb', line 194 def define_arguments(list, required, *descs) #--{{{ define Argument, list, required, *descs #--}}} end |
#define_keywords(list, required, *descs) ⇒ Object
239 240 241 242 243 |
# File 'lib/parseargs.rb', line 239 def define_keywords(list, required, *descs) #--{{{ define Keyword, list, required, *descs #--}}} end |
#extract_kw(kw, kws) ⇒ Object
–}}}
349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/parseargs.rb', line 349 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
221 222 223 224 225 226 227 228 229 |
# File 'lib/parseargs.rb', line 221 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
264 265 266 267 268 269 270 271 272 |
# File 'lib/parseargs.rb', line 264 def optional_keywords(*descs) #--{{{ if descs.empty? @optional_keywords else define_keywords(@optional_keywords, false, *descs) end #--}}} end |
#parse(arg) ⇒ Object
TODO - thinks about *args signature??
285 286 287 288 289 290 291 292 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 |
# File 'lib/parseargs.rb', line 285 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
–}}}
360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/parseargs.rb', line 360 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
–}}}
199 200 201 202 203 204 205 206 207 |
# File 'lib/parseargs.rb', line 199 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
–}}}
244 245 246 247 248 249 250 251 252 |
# File 'lib/parseargs.rb', line 244 def required_keywords(*descs) #--{{{ if descs.empty? @required_keywords else define_keywords(@required_keywords, true, *descs) end #--}}} end |