Class: Milktea::Model

Inherits:
Object
  • Object
show all
Defined in:
lib/milktea/model.rb

Overview

Base model class for creating TUI components following the Elm Architecture

Direct Known Subclasses

Container

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(state = {}) ⇒ Model

Returns a new instance of Model.



29
30
31
32
 
# File 'lib/milktea/model.rb', line 29

def initialize(state = {})
  @state = default_state.merge(state).freeze
  @children = build_children(@state)
end

Instance Attribute Details

#children ⇒ Object (readonly)

Returns the value of attribute children.



8
9
10
 
# File 'lib/milktea/model.rb', line 8

def children
  @children
end

#state ⇒ Object (readonly)

Returns the value of attribute state.



8
9
10
 
# File 'lib/milktea/model.rb', line 8

def state
  @state
end

Class Method Details

.child(klass, mapper = nil) ⇒ Object

Define a child model with optional state mapping

Parameters:

  • klass (Class, Symbol) —

    The child model class or method name

  • mapper (Proc) (defaults to: nil) —

    Lambda to map parent state to child state



14
15
16
17
18
19
20
 
# File 'lib/milktea/model.rb', line 14

def child(klass, mapper = nil)
  @children ||= []
  @children << {
    class: klass,
    mapper: mapper || ->(_state) { {} }
  }
end

.children ⇒ Array<Hash>

Get all child definitions for this model

Returns:

  • (Array<Hash>) —

    Array of child definitions



24
25
26
 
# File 'lib/milktea/model.rb', line 24

def children
  @children ||= []
end

Instance Method Details

#children_views ⇒ String

Combine all children views into a single string

Returns:

  • (String) —

    Combined views of all children



59
60
61
 
# File 'lib/milktea/model.rb', line 59

def children_views
  @children.map(&:view).join
end

#screen_height ⇒ Integer

Get the current screen height

Returns:

  • (Integer) —

    Screen height in characters



71
72
73
 
# File 'lib/milktea/model.rb', line 71

def screen_height
  TTY::Screen.height
end

#screen_size ⇒ Array<Integer>

Get the current screen size

Returns:

  • (Array<Integer>) —
    width, height

    in characters



77
78
79
 
# File 'lib/milktea/model.rb', line 77

def screen_size
  TTY::Screen.size
end

#screen_width ⇒ Integer

Get the current screen width

Returns:

  • (Integer) —

    Screen width in characters



65
66
67
 
# File 'lib/milktea/model.rb', line 65

def screen_width
  TTY::Screen.width
end

#update(message) ⇒ Array(Model, Message)

Update the model based on a message

Parameters:

  • message (Object) —

    The message to process

Returns:

  • (Array(Model, Message)) —

    New model and side effect message

Raises:

  • (NotImplementedError) 


43
44
45
 
# File 'lib/milktea/model.rb', line 43

def update(message)
  raise NotImplementedError, "#{self.class} must implement #update"
end

#view ⇒ String

Render the model to a string representation

Returns:

  • (String) —

    The rendered output

Raises:

  • (NotImplementedError) 


36
37
38
 
# File 'lib/milktea/model.rb', line 36

def view
  raise NotImplementedError, "#{self.class} must implement #view"
end

#with(new_state = {}) ⇒ Model

Create a new instance with updated state

Parameters:

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

    State updates to merge

Returns:

  • (Model) —

    New model instance with updated state



50
51
52
53
54
55
 
# File 'lib/milktea/model.rb', line 50

def with(new_state = {})
  merged_state = @state.merge(new_state)
  return Kernel.const_get(self.class.name).new(merged_state) if self.class.name

  self.class.new(merged_state)
end