rainbow_formatter 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f1db74fd8a49272248b3dd804d84e7a0ae70afc7ddf8c7853a5522c226d8a77
+  data.tar.gz: ee87a058bd4d4e1911152e688b9c1081789946d680c607a3121ab62e166494d0
+SHA512:
+  metadata.gz: d37022065d796e659ba7caa66fe932e607eef908acc31c9f53a4075a7802fef6133044bf97279c55bca151758d88b32e898115b3cdf62a6b832bfb7447cff42d
+  data.tar.gz: 7343072a5e504bc565e00ac00cf268e158492d9b48918a24291e1bab1f00013d959cbfffd7cb868eb95ba207ae4a81e0354298a2489736cffc006951ae11e2c2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format RainbowFormatter

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - './spec/*.rb'
+Metrics/AbcSize:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.5

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rainbow_formatter.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Farina Federico
+Copyright (c) 2011 Matt Sears
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+Fully customizable Rainbow trail RSpec formatter.
+![](data/tina_bike.gif)
+![](data/tina_dream.gif)
+![](data/car.gif)
+
+It simply creates a rainbow trail of test results. It also counts the number of examples as they execute and highlights failed and pending specs.
+
+The rainbow changes colors as it runs!.
+
+Works with RSpec 3.x
+
+Based on [Matt Sears](https://github.com/mattsears/nyan-cat-formatter) Nyan Cat RSpec Formatter
+
+Using  Rainbow
+---------------
+
+You can either specify the formatting when using the `rspec` command:
+
+    rspec --format RainbowFormatter
+
+Or add `--format RainbowFormatter` to a `.rspec` file placed in your project's root directory,
+so that you won't have to specify the `--format` option everytime you run the command.
+
+#### Only animation formatter .rspec file
+```
+--color
+--format RainbowFormatter
+```
+
+#### Music formatter .rspec file
+```
+--color
+--format RainbowMusicFormatter
+```
+
+Then run `rspec spec` and enjoy Rainbow formatted text output accompanied by Rainbow song by default!.
+
+All music was composed by [Maria Delfina Ciarrochi](https://soundcloud.com/mariadelfinaciarrochi)
+
+**This currently only works on Mac OS X or on Linux (if you have mpg321 or mpg123 installed).**
+
+#### With running test output
+```
+--color
+--format RainbowVerboseFormatter
+```
+
+Displays "running" line with name of test on the first line.
+
+
+#### Display failed tests immediately
+```
+--color
+--format RainbowInstaFailFormatter
+```
+
+Displays failed tests immediately!
+
+
+### Using with Bundler
+
+To use Rainbow formatter with a project that uses Bundler (Rails or Sinatra f.e.) you need to add Rainbow Cat dependecy to your Gemfile:
+
+```ruby
+group :test do
+  gem "rainbow_formatter"
+end
+```
+
+And then run `bundle install`.
+
+Customizing Rainbow
+---------------------------------
+You can create your own version, with your own song and draw, this way:
+
+```ruby
+module YourCustomMode
+  def ascii_array
+    'your_ascii_animation_array'
+  end
+  def rainbow_mp3
+    'your_song_path'
+  end
+end
+
+RainbowFormatter.configure do |config|
+  config.formatter = YourCustomMode
+  # OR config.formatter = :tina_dream OR onw of already bundle modes below
+end
+```
+
+It's easy to build your array using a string [escape tool](https://www.freeformatter.com/java-dotnet-escape.html#ad-output). Each position of array should be an escaped version of chosen ascii and could be used one after the other as an animation. You can view some examples at /lib/formatter/custom folder. [This](https://www.asciiart.eu) is a good start point to choose some asciis.
+
+#### Already bundled modes:
+
+1. :car
+2. :dog
+3. :monkey
+4. :tina_bike
+5. :tina_dream
+
+Contributing
+----------
+
+Once you've made your great commits:
+
+1. Fork Rainbow
+2. Create a topic branch - git checkout -b my_branch
+3. Push to your branch - git push origin my_branch
+4. Create a Pull Request from your branch
+5. That's it!
+
+Author
+----------
+[Federico Farina](https://github.com/fedefa)
+
+[Maria Delfina Ciarrochi](https://soundcloud.com/mariadelfinaciarrochi)

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+desc 'Default: run the rspec examples'
+task default: :spec

data/demo.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'spec/spec_helper'
+
+describe RainbowFormatter do
+  before do
+    sleep(0.5) # Just to slow it down a little :-)
+  end
+
+  15.times do
+    it 'Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit..' do
+      expect(0).to eql(0)
+    end
+    it 'Another passed' do
+      expect(0).to eql(0)
+    end
+
+    it 'One failed' do
+      expect(0).to eql(1)
+    end
+
+    it 'pending specs' if [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1].sample == 1
+  end
+end

data/lib/formatter/common.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module Formatter
+  module Common
+    ESC      = "\e["
+    NND      = "#{ESC}0m"
+    PASS     = '='
+    PASS_ARY = ['-', '_'].freeze
+    FAIL     = '*'
+    ERROR    = '!'
+    PENDING  = '+'
+
+    VT100_CODES =
+      {
+        black: 30,
+        red: 31,
+        green: 32,
+        yellow: 33,
+        blue: 34,
+        magenta: 35,
+        cyan: 36,
+        white: 37,
+        bold: 1
+      }.freeze
+
+    VT100_CODE_VALUES = VT100_CODES.invert
+
+    def self.included(base)
+      base.class_eval do
+        attr_reader :current, :example_results, :color_index, :pending_count, :failure_count, :example_count
+      end
+    end
+
+    # Increments the example count and displays the current progress
+    #
+    # @returns nothing
+    def tick(mark: PASS)
+      @example_results << mark
+      @current = @current > @example_count ? @example_count : @current + 1
+      @animation_index = (@animation_index + 1) % ascii_array.size
+      dump_progress
+    end
+
+    # Determine which Ascii to format(display.
+    #
+    # @return [String] Ascii to display
+    def ascii_to_display
+      ascii_array[@animation_index % ascii_array.size]
+    end
+
+    # Displays the current progress in all Rainbow glory
+    #
+    # @return nothing
+    def dump_progress
+      output.print(progress_lines.join("\n") + eol)
+    end
+
+    # Determines line by line tail plus score output
+    #
+    # @return [Array]
+    def progress_lines
+      rainbow_trails = rainbow_trail.split("\n")
+      [
+        rainbow_trails.each_with_index.inject([]) do |result, (trail, index)|
+          value = trail_progress_line_score(index)
+          result << "#{value} #{trail}"
+        end
+      ].flatten
+    end
+
+    def trail_progress_line_score(trail_index)
+      if scoreboard[trail_index]
+        "#{scoreboard[trail_index]}/#{@example_count}:"
+      else
+        ' ' * "#{scoreboard[0]}/#{@example_count}:".size
+      end
+    end
+
+    # Determines how we end the trail line. If complete, return a newline etc.
+    #
+    # @return [String]
+    def eol
+      return "\n" if @current == @example_count
+
+      length = progress_lines.length - 1
+      length.positive? ? format("\e[1A" * length + "\r") : "\r"
+    end
+
+    # Calculates the current flight length
+    #
+    # @return [Fixnum]
+    def current_width
+      # padding_width + example_width + ascii_length
+      padding_width + (@current * example_width) + ascii_length
+    end
+
+    # Gets the padding for the current example count
+    #
+    # @return [Fixnum]
+    def padding_width
+      @example_count.to_s.length * 2 + 6
+    end
+
+    # A Unix trick using stty to get the console columns
+    #
+    # @return [Fixnum]
+    def terminal_width
+      stty_size = `stty size 2>/dev/null`
+      default_width = if !stty_size || defined? JRUBY_VERSION
+                        80
+                      else
+                        stty_size.split.map(&:to_i).reverse.first - 1
+                      end
+      @terminal_width ||= default_width
+    end
+
+    # 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
+    #
+    # @return [Array]
+    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
+
+    # Creates a rainbow trail
+    #
+    # @return [String] the sprintf format of the Nyan cat
+    def rainbow_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
+      ascii_to_display.split("\n").each_with_index.map do |line, _index|
+        "#{marks.join}#{line}"
+      end.join("\n")
+    end
+
+    # Times a mark has to be repeated
+    def example_width(_item = 1)
+      1
+    end
+
+    # Colorizes the string with raindow colors of the rainbow
+    #
+    # @params string [String]
+    # @return [String]
+    def rainbowify(string)
+      c = colors[@color_index % colors.size]
+      @color_index += 1
+      "#{ESC}38;5;#{c}m#{string}#{NND}"
+    end
+
+    # Calculates the colors of the rainbow
+    #
+    # @return [Array]
+    def colors
+      @colors ||= (0...(6 * 7)).map do |n|
+        pi3 = Math::PI / 3
+        n *= 1.0 / 6
+        r  = (3 * Math.sin(n) + 3).to_i
+        g  = (3 * Math.sin(n + 2 * pi3) + 3).to_i
+        b  = (3 * Math.sin(n + 4 * pi3) + 3).to_i
+        36 * r + 6 * g + b + 16
+      end
+    end
+
+    # Determines how to color the example.  If pass, it is rainbowified, otherwise
+    # we assign red if failed or yellow if an error occurred.
+    #
+    # @return [String]
+    def highlight(mark = PASS)
+      case mark
+      when PASS then rainbowify PASS_ARY[@color_index % 2]
+      when FAIL then "\e[31m#{mark}\e[0m"
+      when ERROR then "\e[33m#{mark}\e[0m"
+      when PENDING then "\e[33m#{mark}\e[0m"
+      else mark
+      end
+    end
+
+    # Converts a float of seconds into a minutes/seconds string
+    #
+    # @return [String]
+    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
+
+    # Determines if the specs have completed
+    #
+    # @returns [Boolean] true if finished; false otherwise
+    def finished?
+      (@current == @example_count)
+    end
+
+    # Determines if the any specs failed or are in pending state
+    #
+    # @returns [Boolean] true if failed or pending; false otherwise
+    def failed_or_pending?
+      (@failure_count.to_i.positive? || @pending_count.to_i.positive?)
+    end
+
+    # Returns the ascii length
+    #
+    # @returns [Fixnum]
+    def ascii_length
+      ascii_to_display.split("\n").group_by(&:size).max.first
+    end
+
+    def success_color(text)
+      wrap(text, :green)
+    end
+
+    def pending_color(text)
+      wrap(text, :yellow)
+    end
+
+    def failure_color(text)
+      wrap(text, :red)
+    end
+
+    def console_code_for(code_or_symbol)
+      if VT100_CODE_VALUES.key?(code_or_symbol)
+        code_or_symbol
+      else
+        VT100_CODES.fetch(code_or_symbol) do
+          console_code_for(:white)
+        end
+      end
+    end
+
+    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
+  end
+end