Class: Vedeu::Output::Compressors::Character Private

Inherits:
Object
  • Object
show all
Defined in:
lib/vedeu/output/compressors/character.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.

A simple character based compressor which compressed based on the previous character’s attributes.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content) ⇒ Vedeu::Output::Compressors::Character

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:

  • content (Array<void>) 


24
25
26
27
28
 
# File 'lib/vedeu/output/compressors/character.rb', line 24

def initialize(content)
  @content = content
  @colour  = ''
  @style   = ''
end

Instance Attribute Details

#content ⇒ void (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.

This method returns an undefined value.



52
53
54
 
# File 'lib/vedeu/output/compressors/character.rb', line 52

def content
  @content
end

Class Method Details

.with(content) ⇒ String

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:

  • content (Array<void>)

Returns:

  • (String) 


18
19
20
 
# File 'lib/vedeu/output/compressors/character.rb', line 18

def self.with(content)
  new(content).with
end

Instance Method Details

#character_for(char) ⇒ String (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:

Returns:

  • (String) 


58
59
60
61
62
63
 
# File 'lib/vedeu/output/compressors/character.rb', line 58

def character_for(char)
  position_for(char) +
    colour_for(char) +
    style_for(char) +
    value_for(char)
end

#colour_for(char) ⇒ String (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.

Compress by not repeatedly sending the same colours for each character which has the same colours as the last character output.

Parameters:

Returns:

  • (String) 


71
72
73
74
75
76
 
# File 'lib/vedeu/output/compressors/character.rb', line 71

def colour_for(char)
  return '' if char.colour == @colour

  @colour = char.colour
  @colour.to_s
end

#message ⇒ String (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:

  • (String) 


79
80
81
 
# File 'lib/vedeu/output/compressors/character.rb', line 79

def message
  "Compression for #{original_size} objects"
end

#original_size ⇒ Fixnum (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:

  • (Fixnum) 


84
85
86
 
# File 'lib/vedeu/output/compressors/character.rb', line 84

def original_size
  content.size
end

#position_for(char) ⇒ String (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:

Returns:

  • (String) 


90
91
92
93
94
 
# File 'lib/vedeu/output/compressors/character.rb', line 90

def position_for(char)
  return '' unless char.position?

  char.position.to_s
end

#style_for(char) ⇒ String (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.

Compress by not repeatedly sending the same style(s) for each character which has the same style(s) as the last character output.

Parameters:

Returns:

  • (String) 


102
103
104
105
106
107
 
# File 'lib/vedeu/output/compressors/character.rb', line 102

def style_for(char)
  return '' if char.style == @style

  @style = char.style
  @style.to_s
end

#value_for(char) ⇒ String (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:

Returns:

  • (String) 


111
112
113
114
115
 
# File 'lib/vedeu/output/compressors/character.rb', line 111

def value_for(char)
  return '' unless char.value?

  char.value
end

#with ⇒ String

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.

Process the content as a stream; for each sequence with the same position take the first sequence and ignore the rest.

Returns:

  • (String) 


34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/vedeu/output/compressors/character.rb', line 34

def with
  @same = ''
  @compress ||= Vedeu.timer(message) do
    content.map do |cell|
      character = character_for(cell)

      character == @same ? next : @same = character
    end.join.tap do |out|
      Vedeu.log(type:    :compress,
                message: "#{message} -> #{out.size} characters")
    end
  end
end