Module: NyanCat::Common

Included in:
RSpec1, RSpec2, RSpec3
Defined in:
lib/nyan_cat_formatter/common.rb

Constant Summary collapse

ESC = 
"\e["
NND = 
"#{ESC}0m"
PASS = 
'='
PASS_ARY = 
['-', '_']
FAIL = 
'*'
ERROR = 
'!'
PENDING = 
'+'
VT100_CODES = 
{
  :black   => 30,
  :red     => 31,
  :green   => 32,
  :yellow  => 33,
  :blue    => 34,
  :magenta => 35,
  :cyan    => 36,
  :white   => 37,
  :bold    => 1,
}
VT100_CODE_VALUES = 
VT100_CODES.invert

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



27
28
29
30
31
32
 
# File 'lib/nyan_cat_formatter/common.rb', line 27

def self.included(base)
  base.class_eval do
    attr_reader :current, :example_results, :color_index, :pending_count, :failure_count,
    :example_count
  end
end

Instance Method Details

#ascii_cat(o = '^') ⇒ Array

Ascii version of Nyan cat. Two cats in the array allow Nyan to animate running.

Parameters:

  • o (String) (defaults to: '^') —

    Nyan’s eye

Returns:

  • (Array) —

    Nyan cats



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/nyan_cat_formatter/common.rb', line 147

def ascii_cat(o = '^')
  [[ "_,------,   ",
      "_|  /\\_/\\ ",
      "~|_( #{o} .#{o})  ",
      " \"\"  \"\" "
    ],
    [ "_,------,   ",
      "_|   /\\_/\\",
      "^|__( #{o} .#{o}) ",
      " \" \"  \" \""
    ]]
end

#cat_length ⇒ Object

Returns the cat length



229
230
231
 
# File 'lib/nyan_cat_formatter/common.rb', line 229

def cat_length
  nyan_cat.split("\n").group_by(&:size).max.first
end

#colors ⇒ Array

Calculates the colors of the rainbow

Returns:

  • (Array) 


173
174
175
176
177
178
179
180
181
182
 
# File 'lib/nyan_cat_formatter/common.rb', line 173

def colors
  @colors ||= (0...(6 * 7)).map do |n|
    pi_3 = Math::PI / 3
    n *= 1.0 / 6
    r  = (3 * Math.sin(n           ) + 3).to_i
    g  = (3 * Math.sin(n + 2 * pi_3) + 3).to_i
    b  = (3 * Math.sin(n + 4 * pi_3) + 3).to_i
    36 * r + 6 * g + b + 16
  end
end

#console_code_for(code_or_symbol) ⇒ Object 



245
246
247
248
249
250
251
252
253
 
# File 'lib/nyan_cat_formatter/common.rb', line 245

def console_code_for(code_or_symbol)
  if VT100_CODE_VALUES.has_key?(code_or_symbol)
    code_or_symbol
  else
    VT100_CODES.fetch(code_or_symbol) do
      console_code_for(:white)
    end
  end
end

#current_width ⇒ Fixnum

Calculates the current flight length

Returns:

  • (Fixnum) 


89
90
91
92
 
# File 'lib/nyan_cat_formatter/common.rb', line 89

def current_width
  # padding_width + example_width + cat_length
  padding_width + (@current * example_width) + cat_length
end

#dump_progress ⇒ Object

Displays the current progress in all Nyan Cat glory

Returns:

  • nothing



63
64
65
 
# File 'lib/nyan_cat_formatter/common.rb', line 63

def dump_progress
  output.print(progress_lines.join("\n") + eol)
end

#eol ⇒ String

Determines how we end the trail line. If complete, return a newline etc.

Returns:

  • (String) 


80
81
82
83
84
 
# File 'lib/nyan_cat_formatter/common.rb', line 80

def eol
  return "\n" if @current == @example_count
  length = progress_lines.length - 1
  length > 0 ? format("\e[1A" * length + "\r") : "\r"
end

#example_width(item = 1) ⇒ Object

 Times a mark has to be repeated



139
140
141
 
# File 'lib/nyan_cat_formatter/common.rb', line 139

def example_width(item = 1)
  1
end

#failed_or_pending? ⇒ Boolean

Determines if the any specs failed or are in pending state

Returns:

  • (Boolean) 


222
223
224
 
# File 'lib/nyan_cat_formatter/common.rb', line 222

def failed_or_pending?
  (@failure_count.to_i > 0 || @pending_count.to_i > 0)
end

#failure_color(text) ⇒ Object 



241
242
243
 
# File 'lib/nyan_cat_formatter/common.rb', line 241

def failure_color(text)
  wrap(text, :failure)
end

#finished? ⇒ Boolean

Determines if the specs have completed

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/nyan_cat_formatter/common.rb', line 215

def finished?
  (@current == @example_count)
end

#format_duration(duration) ⇒ String

Converts a float of seconds into a minutes/seconds string

Returns:

  • (String) 


201
202
203
204
205
206
207
208
209
 
# File 'lib/nyan_cat_formatter/common.rb', line 201

def format_duration(duration)
  seconds = ((duration % 60) * 100.0).round / 100.0   # 1.8.7 safe .round(2)
  seconds = seconds.to_i if seconds.to_i == seconds   # drop that zero if it's not needed

  message = "#{seconds} second#{seconds == 1 ? "" : "s"}"
  message = "#{(duration / 60).to_i} minute#{(duration / 60).to_i == 1 ? "" : "s"} and " + message if duration >= 60

  message
end

#highlight(mark = PASS) ⇒ String

Determines how to color the example. If pass, it is rainbowified, otherwise we assign red if failed or yellow if an error occurred.

Returns:

  • (String) 


188
189
190
191
192
193
194
195
196
 
# File 'lib/nyan_cat_formatter/common.rb', line 188

def highlight(mark = PASS)
  case mark
  when PASS; rainbowify PASS_ARY[@color_index%2]
  when FAIL; "\e[31m#{mark}\e[0m"
  when ERROR; "\e[33m#{mark}\e[0m"
  when PENDING; "\e[33m#{mark}\e[0m"
  else mark
  end
end

#nyan_cat ⇒ String

Determine which Ascii Nyan Cat to display. If tests are complete, Nyan Cat goes to sleep. If there are failing or pending examples, Nyan Cat is concerned.

Returns:

  • (String) —

    Nyan Cat



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/nyan_cat_formatter/common.rb', line 48

def nyan_cat
  if self.failed_or_pending? && self.finished?
    ascii_cat('x')[@color_index%2].join("\n") #'~|_(x.x)'
  elsif self.failed_or_pending?
    ascii_cat('o')[@color_index%2].join("\n") #'~|_(o.o)'
  elsif self.finished?
    ascii_cat('-')[@color_index%2].join("\n") # '~|_(-.-)'
  else
    ascii_cat('^')[@color_index%2].join("\n") # '~|_(^.^)'
  end
end

#nyan_trail ⇒ String

Creates a rainbow trail

Returns:

  • (String) —

    the sprintf format of the Nyan cat



130
131
132
133
134
135
136
 
# File 'lib/nyan_cat_formatter/common.rb', line 130

def nyan_trail
  marks = @example_results.each_with_index.map{ |mark, i| highlight(mark) * example_width(i) }
  marks.shift(current_width - terminal_width) if current_width >= terminal_width
  nyan_cat_lines = nyan_cat.split("\n").each_with_index.map do |line, index|
    format("%s#{line}", marks.join)
  end.join("\n")
end

#padding_width ⇒ Fixnum

Gets the padding for the current example count

Returns:

  • (Fixnum) 


97
98
99
 
# File 'lib/nyan_cat_formatter/common.rb', line 97

def padding_width
  @example_count.to_s.length * 2 + 6
end

#pending_color(text) ⇒ Object 



237
238
239
 
# File 'lib/nyan_cat_formatter/common.rb', line 237

def pending_color(text)
  wrap(text, :pending)
end

#progress_lines ⇒ Object 



67
68
69
70
71
72
73
74
75
 
# File 'lib/nyan_cat_formatter/common.rb', line 67

def progress_lines
  padding = @example_count.to_s.length * 2 + 2
  [
    nyan_trail.split("\n").each_with_index.inject([]) do |result, (trail, index)|
      value = "#{scoreboard[index]}/#{@example_count}:"
      result << format("%s %s", value, trail)
    end
  ].flatten
end

#rainbowify(string) ⇒ String

Colorizes the string with raindow colors of the rainbow

Returns:

  • (String) 


164
165
166
167
168
 
# File 'lib/nyan_cat_formatter/common.rb', line 164

def rainbowify(string)
  c = colors[@color_index % colors.size]
  @color_index += 1
  "#{ESC}38;5;#{c}m#{string}#{NND}"
end

#scoreboard ⇒ Array

Creates a data store of pass, failed, and pending example results We have to pad the results here because sprintf can’t properly pad color

Returns:

  • (Array) 


117
118
119
120
121
122
123
124
125
 
# File 'lib/nyan_cat_formatter/common.rb', line 117

def scoreboard
  @pending_examples ||= []
  @failed_examples ||= []
  padding = @example_count.to_s.length
  [ @current.to_s.rjust(padding),
    success_color((@current - @pending_examples.size - @failed_examples.size).to_s.rjust(padding)),
    pending_color(@pending_examples.size.to_s.rjust(padding)),
    failure_color(@failed_examples.size.to_s.rjust(padding)) ]
end

#success_color(text) ⇒ Object 



233
234
235
 
# File 'lib/nyan_cat_formatter/common.rb', line 233

def success_color(text)
  wrap(text, :success)
end

#terminal_width ⇒ Fixnum

A Unix trick using stty to get the console columns

Returns:

  • (Fixnum) 


104
105
106
107
108
109
110
111
 
# File 'lib/nyan_cat_formatter/common.rb', line 104

def terminal_width
  if defined? JRUBY_VERSION
    default_width = 80
  else
    default_width = `stty size`.split.map { |x| x.to_i }.reverse.first - 1
  end
  @terminal_width ||= default_width
end

#tick(mark = PASS) ⇒ Object

Increments the example count and displays the current progress



37
38
39
40
41
 
# File 'lib/nyan_cat_formatter/common.rb', line 37

def tick(mark = PASS)
  @example_results << mark
  @current = (@current > @example_count) ? @example_count : @current + 1
  dump_progress
end

#wrap(text, code_or_symbol) ⇒ Object 



255
256
257
258
259
260
261
 
# File 'lib/nyan_cat_formatter/common.rb', line 255

def wrap(text, code_or_symbol)
  if RSpec.configuration.color_enabled?
    "\e[#{console_code_for(code_or_symbol)}m#{text}\e[0m"
  else
    text
  end
end