Module: Vedeu::Repositories::Defaults Private

Includes:

Common

Included in:

Buffers::Empty, Buffers::View, Cells::Empty, Colours::Colour, Editor::Document, Geometries::Move, Views::DefaultAttributes

Defined in:

lib/vedeu/repositories/defaults.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.

Some classes expect a certain set of attributes when initialized, this module uses the #defaults method of the class to provide missing attribute keys (and values).

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.

• #defaults ⇒ Hash<void> private 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.

• #initialize(attributes = {}) ⇒ void private

  Returns a new instance of the class including this module.

• #line_model? ⇒ Boolean included from Common private

  Returns a boolean indicating the model is a Views::Line.

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

  Returns a boolean indicating whether the value is a Fixnum.

• #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 Views::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.

• #validate(attributes) ⇒ Hash private private
• #view_model? ⇒ Boolean included from Common private

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

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)

#defaults ⇒ Hash<void> (private)

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:

• (Hash<void>)

# File 'lib/vedeu/repositories/defaults.rb', line 36

def defaults
  {}
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)

#initialize(attributes = {}) ⇒ 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.

Note:

If a particular key is missing from the attributes parameter, then it is added with the respective value from #defaults.

Returns a new instance of the class including this module.

Parameters:

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

# File 'lib/vedeu/repositories/defaults.rb', line 27

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

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

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

#validate(attributes) ⇒ Hash (private)

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.

Parameters:

• attributes (Hash)

Returns:

• (Hash)

Raises:

• (Vedeu::Error::InvalidSyntax) —

  When the value given for an argument or parameter cannot be used because it is not valid for the use case, unsupported or the method expects a different type.

# File 'lib/vedeu/repositories/defaults.rb', line 43

def validate(attributes)
  fail Vedeu::Error::InvalidSyntax,
       'Argument :attributes is not a Hash.' unless hash?(attributes)

  attributes.keep_if { |key, _| defaults.key?(key) }
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)