Class: Vedeu::Borders::Border

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Common, Presentation, Repositories::Model
Defined in:
lib/vedeu/borders/border.rb

Overview

Note:

Refer to UTF-8 U+2500 to U+257F for border characters. More details can be found at: en.wikipedia.org/wiki/Box-drawing_character

Provides the mechanism to decorate an interface with a border on all edges, or specific edges. The characters which are used for the border parts (e.g. the corners, verticals and horizontals) can be customised as can the colours and styles.

More information can be found at: Borders

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vedeu::Borders::Border

Returns a new instance of Vedeu::Borders::Border.

Parameters:

Options Hash (attributes):

  • bottom_left (String) —

    The bottom left border character.

  • bottom_right (String) —

    The bottom right border character.

  • colour (Hash)
  • enabled (Boolean) —

    Indicate whether the border is to be shown for this interface.

  • horizontal (String) —

    The horizontal border character.

  • name (String|Symbol) —

    The name of the interface to which this border relates.

  • style (Vedeu::Presentation::Style)
  • show_bottom (Boolean) —

    Indicate whether the bottom border is to be shown.

  • show_left (Boolean) —

    Indicate whether the left border is to be shown.

  • show_right (Boolean) —

    Indicate whether the right border is to be shown.

  • show_top (Boolean) —

    Indicate whether the top border is to be shown.

  • title (String) —

    An optional title for when the top border is to be shown.

  • caption (String) —

    An optional caption for when the bottom border is to be shown.

  • top_left (String) —

    The top left border character.

  • top_right (String) —

    The top right border character.

  • vertical (String) —

    The vertical border character.



146
147
148
149
150
 
# File 'lib/vedeu/borders/border.rb', line 146

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

Instance Attribute Details

#bottom_left ⇒ String

Returns The character to be used for the bottom left border if enabled.

Returns:

  • (String) —

    The character to be used for the bottom left border if enabled.



33
34
35
 
# File 'lib/vedeu/borders/border.rb', line 33

def bottom_left
  @bottom_left
end

#bottom_right ⇒ String

Returns The character to be used for the bottom right border if enabled.

Returns:

  • (String) —

    The character to be used for the bottom right border if enabled.



38
39
40
 
# File 'lib/vedeu/borders/border.rb', line 38

def bottom_right
  @bottom_right
end

#enabled ⇒ Boolean Also known as: enabled?

Returns Determines whether this border should be rendered.

Returns:

  • (Boolean) —

    Determines whether this border should be rendered.



107
108
109
 
# File 'lib/vedeu/borders/border.rb', line 107

def enabled
  @enabled
end

#horizontal ⇒ String

Returns The character to be used for the horizontal side border.

Returns:

  • (String) —

    The character to be used for the horizontal side border.



43
44
45
 
# File 'lib/vedeu/borders/border.rb', line 43

def horizontal
  @horizontal
end

#name ⇒ String (readonly)

Returns Associates the border with the same-named interface/view.

Returns:

  • (String) —

    Associates the border with the same-named interface/view.



97
98
99
 
# File 'lib/vedeu/borders/border.rb', line 97

def name
  @name
end

#parent ⇒ Vedeu::Interfaces::Interface|NilClass (readonly)

Returns The interface/ view associated with this border.

Returns:



102
103
104
 
# File 'lib/vedeu/borders/border.rb', line 102

def parent
  @parent
end

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

Returns:

#show_bottom ⇒ Boolean Also known as: bottom?

Returns Determines whether the bottom border should be shown.

Returns:

  • (Boolean) —

    Determines whether the bottom border should be shown.



48
49
50
 
# File 'lib/vedeu/borders/border.rb', line 48

def show_bottom
  @show_bottom
end

#show_left ⇒ Boolean Also known as: left?

Returns Determines whether the left border should be shown.

Returns:

  • (Boolean) —

    Determines whether the left border should be shown.



54
55
56
 
# File 'lib/vedeu/borders/border.rb', line 54

def show_left
  @show_left
end

#show_right ⇒ Boolean Also known as: right?

Returns Determines whether the right border should be shown.

Returns:

  • (Boolean) —

    Determines whether the right border should be shown.



60
61
62
 
# File 'lib/vedeu/borders/border.rb', line 60

def show_right
  @show_right
end

#show_top ⇒ Boolean Also known as: top?

Returns Determines whether the top border should be shown.

Returns:

  • (Boolean) —

    Determines whether the top border should be shown.



66
67
68
 
# File 'lib/vedeu/borders/border.rb', line 66

def show_top
  @show_top
end

#title ⇒ Vedeu::Borders::Title

Returns:




# File 'lib/vedeu/borders/border.rb', line 74

#top_left ⇒ String

Returns The character to be used for the top left border if enabled.

Returns:

  • (String) —

    The character to be used for the top left border if enabled.



82
83
84
 
# File 'lib/vedeu/borders/border.rb', line 82

def top_left
  @top_left
end

#top_right ⇒ String

Returns The character to be used for the top right border if enabled.

Returns:

  • (String) —

    The character to be used for the top right border if enabled.



87
88
89
 
# File 'lib/vedeu/borders/border.rb', line 87

def top_right
  @top_right
end

#vertical ⇒ String

Returns The character to be used for the vertical side border.

Returns:

  • (String) —

    The character to be used for the vertical side border.



92
93
94
 
# File 'lib/vedeu/borders/border.rb', line 92

def vertical
  @vertical
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)

#attributes ⇒ Hash<Symbol => Boolean|Hash|NilClass|String|Symbol| Vedeu::Borders::Repository|Vedeu::Presentation::Style>

Returns:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/vedeu/borders/border.rb', line 154

def attributes
  {
    bottom_left:  @bottom_left,
    bottom_right: @bottom_right,
    caption:      @caption,
    client:       @client,
    colour:       @colour,
    enabled:      @enabled,
    horizontal:   @horizontal,
    name:         @name,
    parent:       @parent,
    repository:   @repository,
    show_bottom:  @show_bottom,
    show_left:    @show_left,
    show_right:   @show_right,
    show_top:     @show_top,
    style:        @style,
    title:        @title,
    top_left:     @top_left,
    top_right:    @top_right,
    vertical:     @vertical,
  }
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:

#bx ⇒ Fixnum

Return the column position for 1 character right of the left

border.

Returns:

  • (Fixnum) 


182
183
184
 
# File 'lib/vedeu/borders/border.rb', line 182

def bx
  (enabled? && left?) ? x + 1 : x
end

#bxn ⇒ Fixnum

Return the column position for 1 character left of the right

border.

Returns:

  • (Fixnum) 


190
191
192
 
# File 'lib/vedeu/borders/border.rb', line 190

def bxn
  (enabled? && right?) ? xn - 1 : xn
end

#by ⇒ Fixnum

Return the row position for 1 character under of the top

border.

Returns:

  • (Fixnum) 


198
199
200
 
# File 'lib/vedeu/borders/border.rb', line 198

def by
  (enabled? && top?) ? y + 1 : y
end

#byn ⇒ Fixnum

Return the column position for 1 character above of the bottom

border.

Returns:

  • (Fixnum) 


206
207
208
 
# File 'lib/vedeu/borders/border.rb', line 206

def byn
  (enabled? && bottom?) ? yn - 1 : yn
end

#caption ⇒ Vedeu::Borders::Caption

Returns:



211
212
213
 
# File 'lib/vedeu/borders/border.rb', line 211

def caption
  Vedeu::Borders::Caption.coerce(@caption, width)
end

#caption=(value) ⇒ Vedeu::Borders::Caption

Parameters:

  • value (String)

Returns:



217
218
219
 
# File 'lib/vedeu/borders/border.rb', line 217

def caption=(value)
  @caption = Vedeu::Borders::Caption.coerce(value, width)
end

#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<Symbol => Boolean|Hash|NilClass|String|Symbol| Vedeu::Borders::Repository|Vedeu::Presentation::Style> (private)

The default values for a new instance of this class.

Returns:

See Also:



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/vedeu/borders/border.rb', line 274

def defaults
  {
    bottom_left:  Vedeu::EscapeSequences::Borders.bottom_left,
    bottom_right: Vedeu::EscapeSequences::Borders.bottom_right,
    caption:      '',
    client:       nil,
    colour:       nil,
    enabled:      false,
    horizontal:   Vedeu::EscapeSequences::Borders.horizontal,
    name:         '',
    parent:       nil,
    repository:   Vedeu.borders,
    show_bottom:  true,
    show_left:    true,
    show_right:   true,
    show_top:     true,
    style:        nil,
    title:        '',
    top_left:     Vedeu::EscapeSequences::Borders.top_left,
    top_right:    Vedeu::EscapeSequences::Borders.top_right,
    vertical:     Vedeu::EscapeSequences::Borders.vertical,
  }
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::Borders::DSL

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:



240
241
242
 
# File 'lib/vedeu/borders/border.rb', line 240

def deputy(client = nil)
  Vedeu::Borders::DSL.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:

#geometry ⇒ Object (private)

Returns the geometry for the interface.



265
266
267
 
# File 'lib/vedeu/borders/border.rb', line 265

def geometry
  Vedeu.geometries.by_name(name)
end

#height ⇒ Fixnum

Returns the height of the interface determined by whether a top, bottom, both or neither borders are shown.

Returns:

  • (Fixnum) 


256
257
258
 
# File 'lib/vedeu/borders/border.rb', line 256

def height
  (by..byn).size
end

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

#width ⇒ Fixnum

Returns the width of the interface determined by whether a left, right, both or neither borders are shown.

Returns:

  • (Fixnum) 


248
249
250
 
# File 'lib/vedeu/borders/border.rb', line 248

def width
  (bx..bxn).size
end