Class: Yardstick::Rule Abstract

Inherits:

Object

• Object
• Yardstick::Rule

Extended by:

Forwardable

Defined in:

lib/yardstick/rule.rb

Overview

This class is abstract.

Base class of every rule

Direct Known Subclasses

Yardstick::Rules::ApiTag::Inclusion, Yardstick::Rules::ApiTag::Presence, Yardstick::Rules::ApiTag::PrivateMethod, Yardstick::Rules::ApiTag::ProtectedMethod, Yardstick::Rules::ExampleTag, Yardstick::Rules::ReturnTag, Yardstick::Rules::Summary::Delimiter, Yardstick::Rules::Summary::Length, Yardstick::Rules::Summary::Presence, Yardstick::Rules::Summary::SingleLine

Class Attribute Summary

• .description ⇒ String private

  Description of the rule.

Instance Attribute Summary

• #document ⇒ Document readonly private

  Return document that current rule is using.

Class Method Summary

• .coerce(document, config) ⇒ Yardstick::Rule private

  Makes a new instance of rule using given config.

Instance Method Summary

• #enabled? ⇒ Boolean private

  Checks if rule is enabled in current context.

• #initialize(document, config = RuleConfig.new) ⇒ Yardstick::Rule constructor private

  Initializes a rule.

• #validatable? ⇒ Boolean private

  Checks if the rule is validatable for given document.

Constructor Details

#initialize(document, config = RuleConfig.new) ⇒ Yardstick::Rule

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initializes a rule

Parameters:

• document (Yardstick::Document)
• config (Yardstick::RuleConfig) (defaults to: RuleConfig.new) —

  rule configuration

# File 'lib/yardstick/rule.rb', line 68

def initialize(document, config = RuleConfig.new)
  @document = document
  @config   = config
end

Class Attribute Details

.description ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Description of the rule

This is shown when a rule is invalid

Returns:

• (String)

# File 'lib/yardstick/rule.rb', line 20

def description
  @description
end

Instance Attribute Details

#document ⇒ Document (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return document that current rule is using

Returns:

• (Document)

# File 'lib/yardstick/rule.rb', line 57

def document
  @document
end

Class Method Details

.coerce(document, config) ⇒ Yardstick::Rule

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Makes a new instance of rule using given config

Parameters:

• document (Yardstick::Document) —

  document that will be measured

• config (Yardstick::Config) —

  a configuration

Returns:

• (Yardstick::Rule)

# File 'lib/yardstick/rule.rb', line 48

def self.coerce(document, config)
  new(document, config.for_rule(self))
end

Instance Method Details

#enabled? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Checks if rule is enabled in current context

Returns:

• (Boolean) —

  true if enabled

# File 'lib/yardstick/rule.rb', line 81

def enabled?
  @config.enabled_for_path?(@document.path)
end

#validatable? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Checks if the rule is validatable for given document

Returns:

• (Boolean)

# File 'lib/yardstick/rule.rb', line 90

def validatable?
  true
end