Class: Onboardable::List::Builder

Inherits:
Object
  • Object
show all
Includes:
Utils::Warnings
Defined in:
lib/onboardable/list/builder.rb,
sig/onboardable/list/builder.rbs

Overview

The Builder class constructs and manages an onboarding step list, adding steps and building the final list.

Constant Summary collapse

STEP_KEY =

Key used to store steps in the options hash.

Returns:

  • (Symbol) 
:steps

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::Warnings

#warn_about_override

Constructor Details

#initialize(options = {}) ⇒ Builder

Initializes a new instance of ListBuilder.

Parameters:

  • options (Hash) (defaults to: {}) —

    Options to be set for the builder.

Options Hash (options):

  • :progress_calculation (Proc) —

    A custom calculation for progress percentage. Receives step_index and steps_size as arguments and returns a Float.



27
28
29
 
# File 'lib/onboardable/list/builder.rb', line 27

def initialize(options = {})
  self.options = options
end

Instance Attribute Details

#current_step ⇒ Step

Returns The current step in the building process, defaulting to the first added step.

Returns:

  • (Step) —

    The current step in the building process, defaulting to the first added step.



20
21
22
 
# File 'lib/onboardable/list/builder.rb', line 20

def current_step
  @current_step
end

#options ⇒ Hash

Returns The options hash for the builder.

Returns:

  • (Hash) —

    The options hash for the builder.



65
66
67
 
# File 'lib/onboardable/list/builder.rb', line 65

def options
  @options
end

Instance Method Details

#add_step(step) ⇒ Step

Adds a step to the builder.

Parameters:

  • step (Step) —

    The step to be added.

Returns:

  • (Step) —

    The added step.



80
81
82
83
84
85
86
87
 
# File 'lib/onboardable/list/builder.rb', line 80

def add_step(step)
  step.name.then do |name|
    warn_about_override(name) if steps.key?(name)
    steps[name] = step
  end

  step.tap { self.current_step ||= step }
end

#build(current_step_name = nil) ⇒ Base

Constructs a new List object from the steps added to the builder.

Parameters:

  • current_step_name (String, nil) (defaults to: nil) —

    The name of the current step.

Returns:

  • (Base) —

    A new List object initialized with the steps and the specified current step.



54
55
56
57
58
59
60
 
# File 'lib/onboardable/list/builder.rb', line 54

def build(current_step_name = nil)
  Base.new(
    convert_to_steps!,
    convert_to_step!(current_step_name || current_step.name),
    options.except(STEP_KEY)
  )
end

#convert_to_step!(name) ⇒ Step

Retrieves a Step object from the builder's steps based on the step name.

Parameters:

  • name (String) —

    The name of the step to be converted to a Step object.

Returns:

  • (Step) —

    The corresponding Step object.

Raises:

  • (StepError) —

    Raises if the specified step name is not present in steps hash.



102
103
104
 
# File 'lib/onboardable/list/builder.rb', line 102

def convert_to_step!(name)
  steps[name] || raise(StepError.new(name, steps.keys))
end

#convert_to_steps! ⇒ Array<Step>

Converts the internal hash of steps to an array of Step objects.

Returns:

  • (Array<Step>) —

    An array of steps.

Raises:



93
94
95
 
# File 'lib/onboardable/list/builder.rb', line 93

def convert_to_steps!
  steps.any? ? steps.values : raise(EmptyStepsError)
end

#create_step(name, data = {}) ⇒ Step Also known as: step

Creates a new Step object and adds it to the builder.

Parameters:

  • name (String) —

    The name of the step.

  • data (Hash) (defaults to: {}) —

    The data associated with the step.

Returns:

  • (Step) —

    The created step.



36
37
38
 
# File 'lib/onboardable/list/builder.rb', line 36

def create_step(name, data = {})
  Step.new(name, data).tap { |step| add_step(step) }
end

#create_step_from(klass) ⇒ Step Also known as: step_from

Converts a class to a Step object and adds it to the builder.

Parameters:

  • klass (Class) —

    The class to be converted to a step.

Returns:

  • (Step) —

    The converted step.



45
46
47
 
# File 'lib/onboardable/list/builder.rb', line 45

def create_step_from(klass)
  (Step.try_convert(klass) || undefined_method_error!(klass)).tap { |step| add_step(step) }
end

#steps ⇒ Hash

Stores the steps added to the builder.

Returns:

  • (Hash) —

    A hash of steps added to the builder.



15
16
17
 
# File 'lib/onboardable/list/builder.rb', line 15

def steps
  options[STEP_KEY] ||= {}
end

#undefined_method_error!(klass) ⇒ Object

Raises an UndefinedMethodError indicating that the conversion method is not defined for the class.

Parameters:

  • klass (Class) —

    The class that does not have the conversion method defined.

Returns:

  • (Object)

Raises:



110
111
112
 
# File 'lib/onboardable/list/builder.rb', line 110

def undefined_method_error!(klass)
  raise UndefinedMethodError.new(klass, Step::CONVERSION_METHOD)
end