Class: YARD::Handlers::Ruby::ClassConditionHandler
- Defined in:
- lib/yard/handlers/ruby/class_condition_handler.rb
Overview
Matches if/unless conditions inside classes and attempts to process only one branch (by evaluating the condition if possible).
Constant Summary
Constants included from CodeObjects
CodeObjects::BUILTIN_ALL, CodeObjects::BUILTIN_CLASSES, CodeObjects::BUILTIN_EXCEPTIONS, CodeObjects::BUILTIN_EXCEPTIONS_HASH, CodeObjects::BUILTIN_MODULES, CodeObjects::CONSTANTMATCH, CodeObjects::CSEP, CodeObjects::CSEPQ, CodeObjects::ISEP, CodeObjects::ISEPQ, CodeObjects::METHODMATCH, CodeObjects::METHODNAMEMATCH, CodeObjects::NAMESPACEMATCH, CodeObjects::NSEP, CodeObjects::NSEPQ
Instance Attribute Summary
Attributes inherited from Base
#namespace, #owner, #parser, #scope, #statement, #visibility
Instance Method Summary collapse
-
#parse_condition ⇒ true, ...
protected
Parses the condition part of the if/unless statement.
- #parse_else_block ⇒ Object protected
- #parse_then_block ⇒ Object protected
Methods inherited from Base
handles?, meta_type, method_call, #parse_block
Methods included from Parser::Ruby
Methods inherited from Base
clear_subclasses, #ensure_loaded!, handlers, handles, handles?, in_file, #initialize, matches_file?, namespace_only, namespace_only?, #parse_block, process, #process, #push_state, #register, subclasses
Constructor Details
This class inherits a constructor from YARD::Handlers::Base
Instance Method Details
#parse_condition ⇒ true, ... (protected)
Parses the condition part of the if/unless statement
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 |
# File 'lib/yard/handlers/ruby/class_condition_handler.rb', line 35 def parse_condition condition = nil # Right now we can handle very simple unary conditions like: # if true # if false # if 0 # if 100 (not 0) # if defined? SOME_CONSTANT # # The last case will do a lookup in the registry and then one # in the Ruby world (using eval). case statement.condition.type when :int condition = statement.condition[0] != "0" when :defined # defined? keyword used, let's see if we can look up the name # in the registry, then we'll try using Ruby's powers. eval() is not # *too* dangerous here since code is not actually executed. name = statement.condition[0].source obj = YARD::Registry.resolve(namespace, name, true) begin condition = true if obj || Object.instance_eval("defined? #{name}") rescue SyntaxError, NameError condition = false end when :var_ref var = statement.condition[0] if var == s(:kw, "true") condition = true elsif var == s(:kw, "false") condition = false end end # Invert an unless condition if statement.type == :unless || statement.type == :unless_mod condition = !condition if condition != nil end condition end |
#parse_else_block ⇒ Object (protected)
81 82 83 |
# File 'lib/yard/handlers/ruby/class_condition_handler.rb', line 81 def parse_else_block parse_block(statement.else_block) if statement.else_block end |
#parse_then_block ⇒ Object (protected)
77 78 79 |
# File 'lib/yard/handlers/ruby/class_condition_handler.rb', line 77 def parse_then_block parse_block(statement.then_block) end |