rainbow_formatter 0.1.5

data/lib/formatter/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'formatter/custom/car'
+require 'formatter/custom/dog'
+require 'formatter/custom/monkey'
+require 'formatter/custom/tina_bike'
+require 'formatter/custom/tina_dream'
+
+module Formatter
+  class Configuration
+    attr_accessor :formatter
+
+    def initialize
+      @formatter = :tina_bike
+    end
+  end
+end

data/lib/formatter/custom/car.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Formatter
+  module Custom
+    module Car
+      # rubocop:disable Metrics/LineLength
+      def ascii_array
+        ["   -           __\r\n --          ~( @\\   \\  \r\n---   _________]_[__/_>________\r\n     /  ____ \\ <>     |  ____  \\\r\n    =\\_/ __ \\_\\_______|_/ __ \\__D\r\n________(__)_____________(__)____",
+         "    -           __\r\n   --         ~( @\\   \\\r\n  ---  _________]_[__/_>________\r\n     /  ____ \\ <>     |  ____  \\\r\n    =\\_/ __ \\_\\_______|_/ __ \\__D\r\n________(__)_____________(__)____"]
+      end
+      # rubocop:enable Metrics/LineLength
+
+      def rainbow_mp3
+        File.expand_path('../../../data/tina_dream.mp3', __dir__)
+      end
+    end
+  end
+end

data/lib/formatter/custom/dog.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Formatter
+  module Custom
+    module Dog
+      # rubocop:disable Metrics/LineLength
+      def ascii_array
+        ["                  ;~~,__\r\n   :-....,-------'`-'._.'\r\n    `-,,,  ,       ,'~~'\r\n        ; ,'~.__; /\r\n        :|      :|\r\n        `-'     `-'",
+         "                  ;~~,__\r\n   :-....,-------'`-'._.'\r\n    `-,,,  ,       ,'~~'\r\n        ; ,'~.__; /--.\r\n        :| :|   :|``(;\r\n        `-'`-'  `-'",
+         "                  ;~~,__\r\n   :-....,-------'`-'._.'\r\n    `-,,,  ,       ;'~~'\r\n       ,'_,'~.__; '--.\r\n      //'       ````(;\r\n     `-'",
+         "                .--~~,__\r\n   :-....,-------`~~'._.'\r\n    `-,,,  ,_      ;'~U'\r\n     _,-' ,'`-__; '--.\r\n    (_/'~~      ''''(;"]
+      end
+      # rubocop:enable Metrics/LineLength
+
+      def rainbow_mp3
+        File.expand_path('../../../data/tina_dream.mp3', __dir__)
+      end
+    end
+  end
+end

data/lib/formatter/custom/monkey.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Formatter
+  module Custom
+    module Monkey
+      # rubocop:disable Metrics/LineLength
+      def ascii_array
+        ["      .-\"-. \r\n    _/.-.-.\\\r\n   /|( o o )|\\\r\n  | //  \"  \\\\ |\r\n / / \\'---'/ \\ \\\r\n \\ \\_/`\"\"\"`\\_/ /\r\n  \\           /",
+         "      .-\"-.\r\n    _/_-.-_\\\r\n   / __} {__ \\\r\n  / //  \"  \\\\ \\\r\n / / \\'---'/ \\ \\\r\n \\ \\_/`\"\"\"`\\_/ /\r\n  \\           /"]
+      end
+      # rubocop:enable Metrics/LineLength
+
+      def rainbow_mp3
+        File.expand_path('../../../data/tina_dream.mp3', __dir__)
+      end
+    end
+  end
+end

data/lib/formatter/custom/tina_bike.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Formatter
+  module Custom
+    module TinaBike
+      # rubocop:disable Metrics/LineLength
+      def ascii_array
+        [" -          /\\**/\\    \r\n --       _(  o_o )   \r\n ---   (_/    u--u)   \r\n    /==(    ___||)\r\n   /d\\\"P\\ )=\\d\\\"Pb, \r\n  8 || ===/8=== || 8|  \r\n  P,    ,d P,    ,d`  \r\n    `\"\"\"     `\"\"\"",
+         "  -          /\\**/\\     \n  --       _(  o_o )   \n  ---  (_/    u--u)   \n    /==(    ___||)\n   /d\\\"P\\ )=\\d\\\"Pb, \n  8 || ===/8=== || 8|\n  P,    ,d P,    ,d`\n    `\"\"\"     `\"\"\""]
+      end
+      # rubocop:enable Metrics/LineLength
+
+      def rainbow_mp3
+        File.expand_path('../../../data/tina_bike.mp3', __dir__)
+      end
+    end
+  end
+end

data/lib/formatter/custom/tina_dream.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Formatter
+  module Custom
+    module TinaDream
+      # rubocop:disable Metrics/LineLength
+      def ascii_array
+        ["                      \r\n     /\\_____/\\\r\n    /  o   o  \\  \r\n   ( ==  ^  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)",
+         "                      \r\n     /\\_____/\\\r\n    / --   -- \\  \r\n   ( ==  ^  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)",
+         "                      \r\n     /\\_____/\\\r\n    / --   -- \\  \r\n   ( ==  o  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)",
+         "         ZzzZ         \r\n     /\\_____/\\\r\n    / --   -- \\  \r\n   ( ==  o  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)",
+         "          ZzzZz       \r\n     /\\_____/\\\r\n    / --   -- \\  \r\n   ( ==  o  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)",
+         "          ZzzZzz      \r\n     /\\_____/\\\r\n    / --   -- \\  \r\n   ( ==  o  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)",
+         "          ZzzZzzZ     \r\n     /\\_____/\\\r\n    / --   -- \\  \r\n   ( ==  o  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)",
+         "           ZzzZzzZz   \r\n     /\\_____/\\\r\n    / --   -- \\  \r\n   ( ==  o  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)",
+         "            ZzzZzzZzz \r\n     /\\_____/\\\r\n    / --   -- \\  \r\n   ( ==  o  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)",
+         "                      \r\n     /\\_____/\\\r\n    /  0   0  \\  \r\n   ( ==  o  == )\r\n    )          (\r\n   (           )\r\n  ( (  )   (  ) )\r\n (__(__)___(__)__)"]
+      end
+      # rubocop:enable Metrics/LineLength
+
+      def rainbow_mp3
+        File.expand_path('../../../data/tina_dream.mp3', __dir__)
+      end
+    end
+  end
+end

data/lib/formatter/insta_fail.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Formatter
+  module InstaFail
+    def progress_lines
+      # Display last failed example output
+      errors_dump = []
+      errors_dump.concat(@failed_examples.last.fully_formatted(@failure_count).split("\n")) if @failed_examples.size.positive?
+      super.concat(errors_dump)
+    end
+  end
+end

data/lib/formatter/music.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Formatter
+  module Music
+    def osx?
+      platform.downcase.include?('darwin')
+    end
+
+    def linux?
+      platform.downcase.include?('linux')
+    end
+
+    def kernel=(kernel)
+      @kernel = kernel
+    end
+
+    def kernel
+      @kernel ||= Kernel
+    end
+
+    def platform=(platform)
+      @platform = platform
+    end
+
+    def platform
+      @platform ||= RUBY_PLATFORM
+    end
+
+    def start(input)
+      super
+      @music_thread = Thread.new { start_music_or_kill(Thread.current) }
+      wait_for_music_to_start(@music_thread)
+    end
+
+    def dump_summary(*args)
+      kill_music
+      super
+    end
+
+    private
+
+    def kill_music
+      if @music_thread && @music_thread['music_pid']
+        @music_thread.kill
+        Process.kill('KILL', @music_thread['music_pid'])
+      end
+    end
+
+    def linux_player
+      %w[mpg321 mpg123].find do |player|
+        kernel.system("which #{player} >/dev/null 2>&1 && type #{player} >/dev/null 2>&1")
+      end
+    end
+
+    def music_command
+      # this isn't really threadsafe but it'll work if we're careful
+      return @music_command if @music_command
+
+      if osx?
+        @music_command = "afplay #{rainbow_mp3}"
+      elsif linux? && linux_player
+        @music_command = "#{linux_player} #{rainbow_mp3} >/dev/null 2>&1"
+      end
+    end
+
+    def start_music_or_kill(thread)
+      thread.exit unless File.exist?(rainbow_mp3) && music_command
+      loop do
+        thread['music_pid'] = kernel.spawn(music_command)
+        thread['started_playing'] ||= true
+        Process.wait(thread['music_pid'])
+      end
+    end
+
+    def wait_for_music_to_start(music_thread)
+      sleep 0.001 while !music_thread['started_playing'] && music_thread.status
+    end
+  end
+end

data/lib/formatter/verbose.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Formatter
+  module Verbose
+    def progress_lines
+      label = "running: #{example_name}"
+      label = label.slice(0, terminal_width - 3).concat('...') if label.size > terminal_width
+      super.concat(
+        [
+          format("%-#{terminal_width}s", finished? ? '' : label)
+        ]
+      )
+    end
+  end
+end

data/lib/formatter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Formatter
+  VERSION = '0.1.5'
+end

data/lib/rainbow_formatter.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'formatter/configuration'
+require 'formatter/common'
+require 'ostruct'
+require 'pry'
+
+class RainbowFormatter
+  include Formatter::Common
+
+  attr_reader :example_name, :ascii_array, :output
+
+  RSpec::Core::Formatters.register self, :start, :example_started, :example_passed, :example_pending, :example_failed,
+                                   :start_dump, :dump_summary
+
+  BUNDLED_MODES = {
+    tina_bike: Formatter::Custom::TinaBike,
+    tina_dream: Formatter::Custom::TinaDream,
+    car: Formatter::Custom::Car,
+    dog: Formatter::Custom::Dog,
+    monkey: Formatter::Custom::Monkey
+  }.freeze
+
+  def initialize(output)
+    @output = output
+    @current = @color_index = @passing_count = @failure_count = @pending_count = @animation_index = 0
+    @example_results = []
+    @failed_examples = []
+    @pending_examples = []
+    setup_formatter
+  end
+
+  def setup_formatter
+    formatter = RainbowFormatter.configuration.formatter
+    formatter = BUNDLED_MODES.dig(formatter) unless formatter.is_a?(Module)
+    singleton_class.send(:include, formatter)
+  end
+
+  def self.configuration
+    @configuration ||= Formatter::Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  def start(start_notification)
+    # TODO: Lazy fix for specs.
+    @example_count = if start_notification.is_a?(Integer)
+                       start_notification
+                     else
+                       start_notification.count
+                     end
+  end
+
+  def start_dump(_notification)
+    @current = @example_count
+  end
+
+  def example_started(notification)
+    notification = notification.example if notification.respond_to?(:example)
+    @example_name = notification.full_description
+  end
+
+  def example_passed(_notification)
+    tick
+  end
+
+  def example_pending(notification)
+    @pending_examples << notification
+    @pending_count += 1
+    tick(mark: PENDING)
+  end
+
+  def example_failed(notification)
+    @failed_examples << notification
+    @failure_count += 1
+    tick(mark: FAIL)
+  end
+
+  def dump_summary(notification)
+    duration = notification.duration
+    summary = "\nYou've rainbowified for #{format_duration(duration)}\n".split(//).map { |c| rainbowify(c) }
+    output.puts summary.join
+    output.puts notification.fully_formatted
+    dump_commands_to_rerun_failed_examples if respond_to?(:dump_commands_to_rerun_failed_examples)
+  end
+end

data/lib/rainbow_insta_fail_formatter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rainbow_formatter'
+require 'formatter/insta_fail'
+
+RainbowInstaFailFormatter = Class.new(RainbowFormatter) do
+  include Formatter::InstaFail
+
+  RSpec::Core::Formatters.register(self, :example_passed, :example_pending, :example_failed, :start_dump, :start)
+end

data/lib/rainbow_music_formatter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rainbow_formatter'
+require 'formatter/music'
+
+RainbowMusicFormatter = Class.new(RainbowFormatter) do
+  include Formatter::Music
+
+  RSpec::Core::Formatters.register(self, :example_passed, :example_pending, :example_failed, :start_dump, :start)
+end

data/lib/rainbow_verbose_formatter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rainbow_formatter'
+require 'formatter/verbose'
+
+RainbowVerboseFormatter = Class.new(RainbowFormatter) do
+  include Formatter::Verbose
+
+  RSpec::Core::Formatters.register(self, :example_passed, :example_pending, :example_failed, :start_dump, :start)
+end

data/rainbow_formatter.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'formatter/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rainbow_formatter'
+  s.version     = Formatter::VERSION
+  s.authors     = ['Federico Farina']
+  s.email       = ['federicojosefarina@gmail.com']
+  s.platform = Gem::Platform::RUBY
+  s.homepage    = 'https://github.com/fedefa/rainbow-formatter'
+  s.summary     = 'Customizable RSpec formatter'
+  s.description = 'Customizable ascii-music RSpec formattter'
+  s.license = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rspec', '>= 3', '< 4'
+
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake'
+end

data/spec/rainbow_formatter_spec.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'stringio'
+
+describe RainbowFormatter do
+  before do
+    rspec_bin = $PROGRAM_NAME.split('/').last
+    @output = StringIO.new
+    if rspec_bin == 'rspec'
+      @formatter = RainbowFormatter.new(@output)
+      @example = RSpec::Core::ExampleGroup.describe.example
+    else
+      formatter_options = OpenStruct.new(colour: true, dry_run: false, autospec: nil)
+      @formatter = RainbowFormatter.new(formatter_options, @output)
+      @example = Spec::Example::ExampleProxy.new('should pass')
+      @formatter.instance_variable_set(:@example_group, OpenStruct.new(description: 'group'))
+    end
+    @formatter.start(2)
+    @formatter.example_started(@example)
+  end
+
+  shared_examples 'a test' do
+    it 'should call the increment method' do
+      expect(@formatter).to receive(:tick)
+      @formatter.example_passed(@example)
+    end
+  end
+
+  describe 'passed, pending and failed' do
+    before do
+      allow(@formatter).to receive(:tick)
+    end
+
+    describe 'example_passed' do
+      it_behaves_like 'a test'
+      it 'should update the scoreboard' do
+        expect(@formatter.scoreboard.size).to eq(4)
+      end
+    end
+
+    describe 'example_pending' do
+      it_behaves_like 'a test'
+
+      it 'should increment the pending count' do
+        expect do
+          @formatter.example_pending(@example)
+        end.to change(@formatter, :pending_count).by(1)
+      end
+    end
+
+    describe 'example_failed' do
+      it_behaves_like 'a test'
+
+      it 'should increment the failure count' do
+        expect do
+          @formatter.example_failed(@example)
+        end.to change(@formatter, :failure_count).by(1)
+      end
+
+      it 'should return finished if the specs are finished' do
+        @formatter.example_failed(@example)
+        allow(@formatter).to receive(:finished?).and_return(true)
+      end
+    end
+  end
+
+  describe 'tick' do
+    before do
+      allow(@formatter).to receive(:current).and_return(1)
+      allow(@formatter).to receive(:example_count).and_return(2)
+      @formatter.tick
+    end
+
+    it 'should increment the current' do
+      expect(@formatter.current).to eql(1)
+    end
+
+    it 'should store the marks in an array' do
+      expect(@formatter.example_results).to include('=')
+    end
+  end
+
+  describe 'rainbowify' do
+    it 'should increment the color index count' do
+      expect do
+        @formatter.rainbowify('=')
+      end.to change(@formatter, :color_index).by(1)
+    end
+  end
+
+  describe 'highlight' do
+    it 'should rainbowify passing examples' do
+      expect(@formatter.highlight('=')).to eq("\e[38;5;154m-\e[0m")
+    end
+
+    it 'should mark failing examples as red' do
+      expect(@formatter.highlight('*')).to eq("\e[31m*\e[0m")
+    end
+
+    it 'should mark pending examples as yellow' do
+      expect(@formatter.highlight('!')).to eq("\e[33m!\e[0m")
+    end
+  end
+
+  describe 'start' do
+    it 'should set the total amount of specs' do
+      expect(@formatter.example_count).to eq(2)
+    end
+
+    it 'should set the current to 0' do
+      expect(@formatter.current).to eq(0)
+    end
+  end
+
+  describe '#format_duration' do
+    it 'should return just seconds for sub 60 seconds' do
+      expect(@formatter.format_duration(5.3)).to eq('5.3 seconds')
+    end
+
+    it 'should remove that extra zero if it is not needed' do
+      expect(@formatter.format_duration(1.0)).to eq('1 second')
+    end
+
+    it 'should plurlaize seconds' do
+      expect(@formatter.format_duration(1.1)).to eq('1.1 seconds')
+    end
+
+    it 'add a minute if it is just over 60 seconds' do
+      expect(@formatter.format_duration(63.2543456456)).to eq('1 minute and 3.25 seconds')
+    end
+
+    it 'should pluralize minutes' do
+      expect(@formatter.format_duration(987.34)).to eq('16 minutes and 27.34 seconds')
+    end
+  end
+
+  describe 'example width' do
+    [15, 36, 60].each do |n|
+      context "for #{n} examples" do
+        before { @formatter.start(n) }
+
+        [0.25, 0.5, 0.75].each do |p|
+          i = (n * p).to_i
+          before { i.times { @formatter.tick } }
+
+          context "when in example #{i}" do
+            it 'should return 1 as the example width' do
+              expect(@formatter.example_width).to eq(1)
+            end
+          end
+        end
+      end
+    end
+  end
+end