Sha256: b39c12d4caae430bcc9fc89da3c5e1569edf6b5dc69c389cc2d2297372bea551

Contents?: true

Size: 1 KB

Versions: 7

Compression:

Stored size: 1 KB

Contents

## Introduction

`Too Many Instance Variables` is a special case of `LargeClass`. 

## Example

Given this configuration

```yaml
TooManyInstanceVariables:
  max_instance_variables: 3
```

and this code:

```Ruby
class TooManyInstanceVariables
  def initialize
    @arg_1 = :dummy
    @arg_2 = :dummy
    @arg_3 = :dummy
    @arg_4 = :dummy
  end
end
```

`reek` would emit the following warning:

```
test.rb -- 5 warnings:
  [1]:TooManyInstanceVariables has at least 4 instance variables (TooManyInstanceVariables)
```
## Current Support in `reek`

`reek` only counts the instance variables you use explicitly like in the example above. Class macros like `attr_accessor` are disregarded.

## Configuration

`reek`'s `Too Many Instance Variables` detector offers the [Basic Smell Options](Basic-Smell-Options.md), plus:

| Option         | Value       | Effect  |
| ---------------|-------------|---------|
| max_instance_variables     | integer | The maximum number of instance variables that are permitted. Defaults to 4 |

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
reek-3.5.0 docs/Too-Many-Instance-Variables.md
reek-3.4.1 docs/Too-Many-Instance-Variables.md
reek-3.4.0 docs/Too-Many-Instance-Variables.md
reek-3.3.1 docs/Too-Many-Instance-Variables.md
reek-3.3.0 docs/Too-Many-Instance-Variables.md
reek-3.2.1 docs/Too-Many-Instance-Variables.md
reek-3.2 docs/Too-Many-Instance-Variables.md