Class: Kitchen::Counter

Inherits:

Object

• Object
• Kitchen::Counter

Defined in:

lib/kitchen/counter.rb

Overview

A simple counting object

hehe

Instance Method Summary

• #get ⇒ Integer

  Returns the value of the counter.

• #increment(by: 1) ⇒ Object (also: #inc)

  Increase the value of the counter.

• #initialize ⇒ Counter constructor

  Creates a new Counter instance.

• #reset(to: 0) ⇒ Object

  Reset the value of the counter.

Constructor Details

#initialize ⇒ Counter

Creates a new Counter instance

# File 'lib/kitchen/counter.rb', line 10

def initialize
  reset
end

Instance Method Details

#get ⇒ Integer

Returns the value of the counter

Returns:

• (Integer)

# File 'lib/kitchen/counter.rb', line 29

def get
  @value
end

#increment(by: 1) ⇒ Object Also known as: inc

Increase the value of the counter

Parameters:

• by (Integer) (defaults to: 1) —

  the amount to increase by

# File 'lib/kitchen/counter.rb', line 18

def increment(by: 1)
  @value += by
end

#reset(to: 0) ⇒ Object

Reset the value of the counter

Parameters:

• to (Integer) (defaults to: 0) —

  the value to reset to

# File 'lib/kitchen/counter.rb', line 36

def reset(to: 0)
  @value = to
end