Module: Onboardable

Defined in:

lib/onboardable.rb,
lib/onboardable/step.rb,
lib/onboardable/errors.rb,
lib/onboardable/version.rb,
lib/onboardable/list/base.rb,
lib/onboardable/list/builder.rb,
lib/onboardable/utils/warnings.rb,
lib/onboardable/list/navigation.rb,
sig/onboardable.rbs,
sig/onboardable/step.rbs,
sig/onboardable/errors.rbs,
sig/onboardable/list/base.rbs,
sig/onboardable/list/builder.rbs,
sig/onboardable/utils/warnings.rbs,
sig/onboardable/list/navigation.rbs

Overview

The Onboardable module provides a DSL for defining and navigating onboarding steps.

Defined Under Namespace

Modules: ClassMethods, InstanceMethods, List, Utils Classes: ComparisonResultError, EmptyStepsError, Error, FirstStepError, LastStepError, Step, StepConversionError, StepError, StepStatusError, UndefinedMethodError

Constant Summary

VERSION =

The version of the Onboardable gem.

Returns:

• (String)

'1.7.0'

Class Method Summary

• .included(klass) ⇒ void

  Initializes the Onboardable module when included in a class, extending it with class and instance methods.

Class Method Details

.included(klass) ⇒ void

This method returns an undefined value.

Initializes the Onboardable module when included in a class, extending it with class and instance methods.

Parameters:

• klass (Module) —

  The class including the Onboardable module

# File 'lib/onboardable.rb', line 17

def self.included(klass)
  klass.extend ClassMethods
  klass.include InstanceMethods
end