Class: Inch::CodeObject::Proxy::MethodParameterObject

Inherits:

Object

• Object
• Inch::CodeObject::Proxy::MethodParameterObject

Defined in:

lib/inch/code_object/proxy/method_parameter_object.rb

Overview

Proxy class for method parameters

Constant Summary

BAD_NAME_EXCEPTIONS =

%w(id)

BAD_NAME_THRESHOLD =

3

Instance Method Summary

• #[](key) ⇒ Object
• #bad_name? ⇒ Boolean

  true if the name of the parameter is uncommunicative.

• #block? ⇒ Boolean

  true if the parameter is a block.

• #described? ⇒ Boolean

  true if an additional description given?.

• #initialize(attributes) ⇒ MethodParameterObject constructor

  A new instance of MethodParameterObject.

• #mentioned? ⇒ Boolean

  true if the parameter is mentioned in the docs.

• #name ⇒ Object (also: #fullname)
• #splat? ⇒ Boolean

  true if the parameter is a splat argument.

• #typed? ⇒ Boolean

  true if the type of the parameter is defined.

• #wrongly_mentioned? ⇒ Boolean

  true if the parameter is mentioned in the docs, but not present in the method’s signature.

Constructor Details

#initialize(attributes) ⇒ MethodParameterObject

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 6

def initialize(attributes)
  @attributes = attributes
end

Instance Method Details

#[](key) ⇒ Object

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 10

def [](key)
  @attributes[key]
end

#bad_name? ⇒ Boolean

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 18

def bad_name?
  return false if BAD_NAME_EXCEPTIONS.include?(name)
  name.size < BAD_NAME_THRESHOLD || name =~ /[0-9]$/
end

#block? ⇒ Boolean

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 24

def block?
  self[:block?]
end

#described? ⇒ Boolean

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 29

def described?
  self[:described?]
end

#mentioned? ⇒ Boolean

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 34

def mentioned?
  self[:mentioned?]
end

#name ⇒ Object Also known as: fullname

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 38

def name
  self[:name]
end

#splat? ⇒ Boolean

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 44

def splat?
  self[:splat?]
end

#typed? ⇒ Boolean

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 49

def typed?
  self[:typed?]
end

#wrongly_mentioned? ⇒ Boolean

# File 'lib/inch/code_object/proxy/method_parameter_object.rb', line 54

def wrongly_mentioned?
  self[:wrongly_mentioned?]
end