Module: Vedeu::Views::Value::InstanceMethods Private

Includes:

Common

Defined in:

lib/vedeu/views/value.rb

Overview

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

Provides view model instance methods for Vedeu::Views.

Instance Attribute Summary

• #client ⇒ void

  The client binding represents the client application object that is currently invoking a DSL method.

• #parent ⇒ void

Instance Method Summary

• #absent?(variable) ⇒ Boolean included from Common private

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

• #become(klass, attributes) ⇒ Class included from Common private

  Converts one class into another.

• #boolean(value) ⇒ Boolean included from Common private

  Returns a boolean indicating the value was a boolean.

• #boolean?(value) ⇒ Boolean included from Common private

  Returns a boolean indicating whether the value is a Boolean.

• #client? ⇒ Boolean private
• #collection ⇒ void private
• #deputy ⇒ void private

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

• #entity ⇒ void private
• #escape?(value) ⇒ Boolean included from Common private

  Returns a boolean indicating whether the value is an escape sequence object (e.g. Cells::Escape.).

• #falsy?(value) ⇒ Boolean included from Common private

  Returns a boolean indicating whether the value should be considered false.

• #hash?(value) ⇒ Boolean included from Common private

  Returns a boolean indicating whether the value is a Hash.

• #line_model? ⇒ Boolean included from Common private

  Returns a boolean indicating the model is a Line.

• #numeric?(value) ⇒ Boolean included from Common private

  Returns a boolean indicating whether the value is a Fixnum.

• #parent? ⇒ Boolean private
• #present?(variable) ⇒ Boolean included from Common private

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

• #snake_case(klass) ⇒ String included from Common private

  Converts a class name to a lowercase snake case string.

• #stream_model? ⇒ Boolean included from Common private

  Returns a boolean indicating the model is a Stream.

• #string?(value) ⇒ Boolean included from Common private

  Returns a boolean indicating whether the value is a Fixnum.

• #truthy?(value) ⇒ Boolean included from Common private

  Returns a boolean indicating whether the value should be considered true.

• #value ⇒ void private
• #value=(value) ⇒ void private
• #value? ⇒ Boolean private

  Returns a boolean indicating whether this model has a non-empty value.

• #view_model? ⇒ Boolean included from Common private

  Returns a boolean indicating the model is a Vedeu::Views::View.

Instance Attribute Details

#client ⇒ void

This method returns an undefined value.

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.

# File 'lib/vedeu/views/value.rb', line 76

def client
  @client
end

#parent ⇒ void

This method returns an undefined value.

# File 'lib/vedeu/views/value.rb', line 80

def parent
  @parent
end

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)

#become(klass, attributes) ⇒ Class 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 one class into another.

Parameters:

• klass (Class) —

  The class to become an instance of.

• attributes (Hash) —

  The attributes of klass.

Returns:

• (Class) —

  Returns a new instance of klass.

#boolean(value) ⇒ 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 the value was a boolean.

Parameters:

• value (void)

Returns:

• (Boolean)

#boolean?(value) ⇒ 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 the value is a Boolean.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

#client? ⇒ Boolean

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:

• (Boolean)

# File 'lib/vedeu/views/value.rb', line 83

def client?
  present?(client)
end

#collection ⇒ void

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.

This method returns an undefined value.

# File 'lib/vedeu/views/value.rb', line 88

def collection
  self.class.collection_klass
end

#deputy ⇒ void

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.

This method returns an undefined value.

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

# File 'lib/vedeu/views/value.rb', line 96

def deputy
  self.class.deputy_klass.new(self, client)
end

#entity ⇒ void

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.

This method returns an undefined value.

# File 'lib/vedeu/views/value.rb', line 101

def entity
  self.class.entity_klass
end

#escape?(value) ⇒ 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 the value is an escape sequence object (e.g. Vedeu::Cells::Escape.)

Returns:

• (Boolean)

#falsy?(value) ⇒ 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 the value should be considered false.

Parameters:

• value (void)

Returns:

• (Boolean)

#hash?(value) ⇒ 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 the value is a Hash.

Parameters:

• value (Hash|void)

Returns:

• (Boolean)

#line_model? ⇒ 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 the model is a Views::Line.

Returns:

• (Boolean)

#numeric?(value) ⇒ 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 the value is a Fixnum.

Parameters:

• value (Fixnum|void)

Returns:

• (Boolean)

#parent? ⇒ Boolean

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:

• (Boolean)

# File 'lib/vedeu/views/value.rb', line 106

def parent?
  present?(parent)
end

#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)

#snake_case(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.

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"

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

Parameters:

• klass (Module|Class|String)

Returns:

• (String)

#stream_model? ⇒ 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 the model is a Views::Stream.

Returns:

• (Boolean)

#string?(value) ⇒ 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 the value is a Fixnum.

Parameters:

• value (String|void)

Returns:

• (Boolean)

#truthy?(value) ⇒ 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 the value should be considered true.

Parameters:

• value (void)

Returns:

• (Boolean)

#value ⇒ void

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.

This method returns an undefined value.

# File 'lib/vedeu/views/value.rb', line 111

def value
  collection.coerce(@value || [], self)
end

#value=(value) ⇒ void

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.

This method returns an undefined value.

Parameters:

• value (void)

# File 'lib/vedeu/views/value.rb', line 117

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

#value? ⇒ Boolean

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 this model has a non-empty value.

Returns:

• (Boolean)

# File 'lib/vedeu/views/value.rb', line 125

def value?
  value.any?
end

#view_model? ⇒ 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 the model is a Views::View.

Returns:

• (Boolean)