Class: Vedeu::Editor::Cropper Private

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Common
Defined in:
lib/vedeu/editor/cropper.rb

Overview

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

Crop the lines to the visible area of the document, as defined by the geometry provided.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Common

#absent?, #array?, #boolean, #boolean?, #empty_value?, #escape?, #falsy?, #hash?, #line_model?, #numeric?, #positionable?, #present?, #snake_case, #stream_model?, #string?, #symbol?, #truthy?, #view_model?

Constructor Details

#initialize(lines:, ox:, oy:, name:) ⇒ Vedeu::Editor::Cropper

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 new instance of Vedeu::Editor::Cropper.

Parameters:

  • lines (Vedeu::Editor::Lines)
  • name (NilClass|Symbol|String) —

    The name of the model or target model to act upon. May default to ‘Vedeu.focus`.

  • ox (Fixnum)
  • oy (Fixnum) 


32
33
34
35
36
37
 
# File 'lib/vedeu/editor/cropper.rb', line 32

def initialize(lines:, ox:, oy:, name:)
  @lines = lines
  @name  = present?(name) ? name : Vedeu.focus
  @ox    = ox
  @oy    = oy
end

Instance Attribute Details

#name ⇒ NilClass|Symbol|String (readonly, protected)

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 The name of the model, the target model or the name of the associated model.

Returns:

  • (NilClass|Symbol|String) —

    The name of the model, the target model or the name of the associated model.



68
69
70
 
# File 'lib/vedeu/editor/cropper.rb', line 68

def name
  @name
end

#ox ⇒ Fixnum (readonly, protected)

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:

  • (Fixnum) 


72
73
74
 
# File 'lib/vedeu/editor/cropper.rb', line 72

def ox
  @ox
end

#oy ⇒ Fixnum (readonly, protected)

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:

  • (Fixnum) 


76
77
78
 
# File 'lib/vedeu/editor/cropper.rb', line 76

def oy
  @oy
end

Instance Method Details

#geometry ⇒ Vedeu::Geometries::Geometry (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 the named geometry from the geometries repository.

Returns:



99
100
101
 
# File 'lib/vedeu/editor/cropper.rb', line 99

def geometry
  @_geometry ||= Vedeu.geometries.by_name(name)
end

#lines ⇒ Vedeu::Editor::Lines (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.

Return a range of visible lines.

Returns:



94
95
96
 
# File 'lib/vedeu/editor/cropper.rb', line 94

def lines
  @lines[oy...(oy + bordered_height)] || []
end

#to_a ⇒ Array<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.

Returns:

  • (Array<void>) 


60
61
62
 
# File 'lib/vedeu/editor/cropper.rb', line 60

def to_a
  visible
end

#viewport ⇒ Array<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.

Returns the visible lines as a sequence of Cells::Char objects.

Returns:

  • (Array<void>) 


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/vedeu/editor/cropper.rb', line 43

def viewport
  out = []

  visible.each_with_index do |line, iy|
    line.chars.each_with_index do |char, ix|
      out << Vedeu::Cells::Char.new(
        name:     name,
        position: Vedeu::Geometries::Position.new((by + iy), (bx + ix)),
        value:    char
      )
    end
  end

  out
end

#visible ⇒ Array<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.

Note:

If there are no lines of content, we return an empty

Returns the visible lines and their respective content, determined by the offsets ‘ox’ and ‘oy’.

array. If there are any empty lines, then they are discarded.

Returns:

  • (Array<void>) 


87
88
89
 
# File 'lib/vedeu/editor/cropper.rb', line 87

def visible
  lines.map { |line| line[ox...(ox + bordered_width)] || '' }
end