Class: Vedeu::Views::Composition

Inherits:
Object
  • Object
show all
Includes:
Presentation, Repositories::Model
Defined in:
lib/vedeu/models/views/composition.rb

Overview

A composition is a collection of interfaces.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vedeu::Views::Composition

Returns a new instance of Vedeu::Views::Composition.

Parameters:

  • attributes (Hash) (defaults to: {})

Options Hash (attributes):



27
28
29
30
31
 
# File 'lib/vedeu/models/views/composition.rb', line 27

def initialize(attributes = {})
  defaults.merge!(attributes).each do |key, value|
    instance_variable_set("@#{key}", value)
  end
end

Instance Attribute Details

#parent ⇒ NilClass (readonly)

Returns Composition objects do not have a parent.

Returns:

  • (NilClass) —

    Composition objects do not have a parent.



17
18
19
 
# File 'lib/vedeu/models/views/composition.rb', line 17

def parent
  @parent
end

#repository ⇒ Vedeu::Repositories::Repository Originally defined in module Repositories::Model

Returns:

Instance Method Details

#absent?(variable) ⇒ Boolean Originally defined in module Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether a variable is nil or empty.

Parameters:

  • variable (String|Symbol|Array|Fixnum) —

    The variable to check.

Returns:

  • (Boolean)

#add(child) ⇒ Vedeu::Views::ViewCollection Also known as: <<

Parameters:

Returns:



35
36
37
 
# File 'lib/vedeu/models/views/composition.rb', line 35

def add(child)
  @value = value.add(child)
end

#attributes ⇒ Hash

Returns:

  • (Hash) 


41
42
43
44
45
46
47
48
49
 
# File 'lib/vedeu/models/views/composition.rb', line 41

def attributes
  {
    client: @client,
    colour: @colour,
    parent: @parent,
    style:  @style,
    value:  value,
  }
end

#background ⇒ Vedeu::Colours::Background Originally defined in module Presentation::Colour

When the background colour for the model exists, return it, otherwise returns the parent background colour, or an empty Vedeu::Colours::Background.

Returns:

#background=(value) ⇒ Vedeu::Colours::Background Originally defined in module Presentation::Colour

Allows the setting of the background colour by coercing the given value into a Vedeu::Colours::Background colour.

Returns:

#colour ⇒ Vedeu::Colours::Colour Originally defined in module Presentation::Colour

Returns:

#colour=(value) ⇒ Vedeu::Colours::Colour Originally defined in module Presentation::Colour

Allows the setting of the model’s colour by coercing the given value into a Vedeu::Colours::Colour.

Returns:

#defaults ⇒ Hash (private)

The default values for a new instance of this class.

Returns:

  • (Hash) 


75
76
77
78
79
80
81
82
83
 
# File 'lib/vedeu/models/views/composition.rb', line 75

def defaults
  {
    client: nil,
    colour: nil,
    parent: nil,
    style:  nil,
    value:  [],
  }
end

#demodulize(klass) ⇒ String Originally defined in module Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Removes the module part from the expression in the string.

Examples:

demodulize('Vedeu::SomeModule::SomeClass') # => "SomeClass"

Parameters:

  • klass (Class|String)

Returns:

  • (String)

#deputy(client = nil) ⇒ Vedeu::DSL::Composition

Returns a DSL instance responsible for defining the DSL methods of this model.

Parameters:

  • client (Object|NilClass) (defaults to: nil) —

    The client binding represents the client application object that is currently invoking a DSL method. It is required so that we can send messages to the client application object should we need to.

Returns:



60
61
62
 
# File 'lib/vedeu/models/views/composition.rb', line 60

def deputy(client = nil)
  Vedeu::DSL::Composition.new(self, client)
end

#foreground ⇒ Vedeu::Colours::Foreground Originally defined in module Presentation::Colour

When the foreground colour for the model exists, return it, otherwise returns the parent foreground colour, or an empty Vedeu::Colours::Foreground.

Returns:

#foreground=(value) ⇒ Vedeu::Colours::Foreground Originally defined in module Presentation::Colour

Allows the setting of the foreground colour by coercing the given value into a Vedeu::Colours::Foreground colour.

Returns:

#position? ⇒ Boolean (private) Originally defined in module Presentation

Returns a boolean indicating the model has a position attribute.

Returns:

  • (Boolean)

#present?(variable) ⇒ Boolean Originally defined in module Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a boolean indicating whether a variable has a useful value.

Parameters:

  • variable (String|Symbol|Array|Fixnum) —

    The variable to check.

Returns:

  • (Boolean)

#render_colour ⇒ String (private) Originally defined in module Presentation

Renders the colour attributes of the receiver and yields (to then render the styles).

Returns:

  • (String)

#render_position ⇒ String (private) Originally defined in module Presentation

Returns:

  • (String)

#render_style ⇒ String (private) Originally defined in module Presentation

Renders the style attributes of the receiver and yields (to then render the next model, or finally, the content).

Returns:

  • (String)

#snake_case(name) ⇒ String Originally defined in module Common

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Converts a class name to a lowercase snake case string.

Examples:

snake_case(MyClassName) # => "my_class_name"
snake_case(NameSpaced::ClassName)
# => "name_spaced/class_name"

Parameters:

  • name (String)

Returns:

  • (String)

#store ⇒ void Originally defined in module Repositories::Model

TODO:

Perhaps some validation could be added here?

Note:

If a block is given, store the model, return the model after yielding.

This method returns an undefined value.

Returns The model instance stored in the repository.

#style ⇒ Vedeu::Presentation::Style Originally defined in module Presentation::Styles

When the style for the model exists, return it, otherwise returns the parent style, or an empty Vedeu::Presentation::Style.

Returns:

#style=(value) ⇒ Vedeu::Presentation::Style Originally defined in module Presentation::Styles

Allows the setting of the style by coercing the given value into a Vedeu::Presentation::Style.

Returns:

#to_s ⇒ String Also known as: to_str Originally defined in module Presentation

Converts the colours and styles to escape sequences, and when the parent model has previously set the colour and style, reverts back to that for consistent formatting.

Returns:

  • (String) —

    An escape sequence with value interpolated.

#value ⇒ Vedeu::Views::ViewCollection Also known as: views

Returns:



65
66
67
 
# File 'lib/vedeu/models/views/composition.rb', line 65

def value
  collection.coerce(@value, self)
end