dots_formatter 0.0.1

data/README.md

@@ -0,0 +1,35 @@
+# Dots formatter
+
+An RSpec formatter that has nothing to do with dots, honest.
+
+Format your Rspec output simply, but informatively.
+
+For example, running with guard, your RSpec output could look like
+this:
+
+![Passing](docs/all_passing.jpg))
+
+Or get instance feedback when an example fails:
+
+![Failing](docs/with_failure.jpg))
+
+If you set debug mode to true then you can get each test on a new line
+with the time taken for each test.
+
+Currently only works with RSpec 3 and up.
+
+To run, clone the repo then in either a project specific .rspec file or
+in your home .rspec file, or directly on the command line:
+
+```ruby
+--require /path/to/dots_formatter/lib/dots_formmater.rb
+--format DotsFormatter
+```
+
+## TODO
+
+* Port RSpec 3 to RSpec 2
+* Better Readme
+* Gem-ify
+* Debug as command line option
+* Tests

data/dots_formatter.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'dots_formatter'
+  s.version     = '0.0.1'
+  s.date        = '2015-05-14'
+  s.summary     = "A simple, informative RSpec formatter"
+  s.description = "Get instance feedback on number of passed:failed:pending / total with quick failure status"
+  s.authors     = ["Paul Brennan"]
+  s.email       = 'paul@dryule.com'
+  s.files       = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.homepage    =  'https://github.com/yule/dots_formatter'
+  s.license     = 'MIT'
+end

data/lib/dots_formatter/dots_formatter_rspec_2.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+require 'rspec/core/formatters/progress_formatter'
+class Rspec2 < RSpec::Core::Formatters::BaseTextFormatter
+
+  def start(number)
+    super(number)
+    output.puts
+  end
+
+  def example_started(example)
+    super(example)
+    print_progress(example)
+  end
+
+  def example_passed(example)
+    super(example)
+    #print_progress
+  end
+  
+  def example_failed(example)
+    super(example)
+    @failure_count += 1
+    print_progress(example)
+  end
+
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    output.puts
+    output.puts
+    output.puts "Finished in #{format_duration duration}"
+    output.puts
+    if failure_count == 0
+      output.puts success_color("┌" +  "--------------" + "-".ljust(20,"-") + "┐")
+      output.puts success_color("│" +  "　(＾ヽ--△<＾)" + " ".ljust(20) + "│")
+      output.puts success_color("│" +  " /　　　　　~▽" + " ".ljust(20) + "│")
+      output.puts success_color("│" +  "士　0　o　0 士" + " #{example_count} test#{example_count > 1? 's' : ' '}".ljust(20) + "│")
+      output.puts success_color("│" +  " メ ＿＿＿ メ " + " ".ljust(20) + "│") 
+      output.puts success_color("│" +  "　　/ へ`-L、 " + " No failures.".ljust(20) + "│")
+      output.puts success_color("│" +  " (~(　し′｜ ）" + " ".ljust(20) + "│")
+      output.puts success_color("└" +  "--------------" + "-".ljust(20,"-") + "┘")
+    else
+      output.puts failure_color("┌" + "-".ljust(50,"-")  + "┐")
+      output.puts failure_color("│   #{example_count} test#{example_count > 1? 's' : ' '}, #{failure_count} failure#{failure_count > 1? 's' : ' '}".ljust(50) + " │")
+      output.puts failure_color("└" + "-".ljust(50,"-")  + "┘")
+      super
+    end
+  end
+
+  def print_progress(example)
+    if @failure_count > 0
+      output.print failure_color("\r ● #{@examples.count - @failure_count}/#{@example_count}. #{@pending_count + '. pending.' if @pending_count > 0} #{example.full_description.ljust(150)}")
+    elsif @pending_count > 0
+      output.print pending_color("\r ● #{@examples.count - @failure_count}/#{@example_count}. #{@pending_count} pending #{example.full_description.ljust(150)}")
+    else
+      output.print success_color("\r ● #{@examples.count - @failure_count}/#{@example_count} #{example.full_description.ljust(150)}\r")
+    end
+
+  end
+
+end

data/lib/dots_formatter/dots_formatter_rspec_3.rb

@@ -0,0 +1,101 @@
+# coding: utf-8
+RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+module RSpec 
+  module Core
+    module Formatters 
+
+      class Dots < BaseTextFormatter
+
+        Formatters.register self, :example_passed, :example_pending, :example_started,
+              :example_failed, :start, :dump_failures
+        
+        attr_accessor :passes, :fails, :runs, :pendings, :screen_width, :start_time, :example_start, :debug
+
+        def initialize(output)
+          @passes = 0
+          @fails = 0 
+          @runs = 0
+          @pendings = 0
+          @screen_width = `tput cols`.to_i - 1
+          @debug = false
+          super(output)
+        end
+
+        def start(notification)
+          @start_time = Time.now
+          @example_count = notification.count
+          output.puts #new line
+        end
+
+        def example_started(example)
+          @example_start = Time.now
+          print_progress(example)
+        end
+
+        def example_pending(example)
+          @runs += 1
+          @pendings += 1
+          print_progress(example, true)
+        end
+
+        def example_passed(example)
+          @runs += 1
+          @passes += 1
+          print_progress(example, true)
+        end
+        
+        def example_failed(example)
+          @fails += 1
+          @runs += 1
+          failure = ConsoleCodes.wrap("\r Failed example: ", :failure) + 
+                    ConsoleCodes.wrap(example.example.full_description, :white)
+          output.puts failure[0..@screen_width].ljust(@screen_width) unless @debug
+          print_progress(example, true)
+        end
+
+
+        def dump_summary(summary)
+          output.puts
+          output.puts
+          colour = (@fails == 0)? :success : :failure 
+
+          output.puts ConsoleCodes.wrap("┌" + "-".ljust(50,"-")  + "┐", colour)
+          output.puts ConsoleCodes.wrap("│   #{summary.example_count} test#{summary.example_count == 1? '' : 's'}".ljust(50) + " |", colour)
+          output.puts ConsoleCodes.wrap("|   #{@fails} failure#{@fails == 1? '' : 's'}".ljust(50) + " |", colour)
+          output.puts ConsoleCodes.wrap("|   Ran in #{Helpers.format_duration summary.duration}".ljust(50) + " |", colour)
+          output.puts ConsoleCodes.wrap("└" + "-".ljust(50,"-")  + "┘", colour)
+          output.puts
+          output.puts summary.colorized_rerun_commands
+        end
+
+        def dump_failures(notification)
+           output.puts
+           output.puts notification.fully_formatted_failed_examples
+        end
+
+        def print_progress(example, finish = false)
+
+          tot = ConsoleCodes.wrap("#{@example_count}", :white)
+          fls = ConsoleCodes.wrap("#{fails}", :failure)
+          suc = ConsoleCodes.wrap("#{@runs - @fails}", :success)
+          png = ConsoleCodes.wrap("#{@pendings}", :pending) 
+          current_dur = Time.now - @start_time
+          prev_dur = Time.now - @example_start
+          tim = ConsoleCodes.wrap( "(Running #{Helpers.format_duration current_dur})", :cyan)
+          dot = ConsoleCodes.wrap(" ● ", @fails == 0 ? :success : :failure)
+
+          if @debug
+            run = ConsoleCodes.wrap(" Just ran: #{example.example.description}, which took ", :cyan)
+            tim2 = ConsoleCodes.wrap(Helpers.format_duration(prev_dur), :red)
+            output.puts " #{dot}#{suc}:#{fls}:#{png}/#{tot}#{dot} #{run}#{tim2}" if finish
+          else
+            run = ConsoleCodes.wrap(" Now running: #{example.example.description}", :cyan) unless finish
+            all = "\r  #{dot}#{suc}:#{fls}:#{png} / #{tot}#{dot} #{tim} #{run}".ljust(@screen_width)+"\r"
+            output.print all
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dots_formatter.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+
+if Gem::Version.new(RSpec::Core::Version::STRING).release >= Gem::Version.new('3.0.0')
+  require_relative './dots_formatter/dots_formatter_rspec_3'
+  DotsFormatter = RSpec::Core::Formatters::Dots
+else
+  require_relative './dots_formmater/dots_formatter_rspec_2'
+  DotsFormatter = Rspec2
+end
+

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: dots_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Brennan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies: []
+description: Get instance feedback on number of passed:failed:pending / total with
+  quick failure status
+email: paul@dryule.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- docs/all_passing.jpg
+- docs/with_failure.jpg
+- dots_formatter.gemspec
+- lib/dots_formatter.rb
+- lib/dots_formatter/dots_formatter_rspec_2.rb
+- lib/dots_formatter/dots_formatter_rspec_3.rb
+homepage: https://github.com/yule/dots_formatter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple, informative RSpec formatter
+test_files: []