rspec_numbering_formatter 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.#*

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec_numbering_formatter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 conanite
+
+MIT License
+
+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,62 @@
+# RspecNumberingFormatter
+
+An rspec formatter that shows elapsed time, example count, example description, and example location, with no scrolling except for errors.
+
+Output looks something like this:
+
+    $ rspec spec --format RspecNumberingFormatter
+    5678 examples
+       3:18   3999 A Widget when updated should not show widget status unless fa /spec/models/widgets/widget_update_spec.rb:42
+
+This formatter uses ANSI escape sequences to overwrite and re-use the same line so you do
+not get massive amounts of information scrolling past; you just see where you are in the
+process, and how much time has elapsed so far.
+
+A problem with the otherwise-excellent "progress" formatter arises when you have a large
+number of examples taking a long time to run (like, anything more than sixty seconds). You
+see a red "F" in the output, but you have to wait till the end of the process to see what
+the problem is.
+
+Another problem is that when you have zillions of examples, the "progress" formatter turns
+your terminal into a sea of dots, and it's hard to know when your run will be finished. This
+format prints the elapsed time along with the example count at the beginning of each line,
+the better to help you judge how long you need to wait before hitting the magic DEPLOY button.
+
+This formatter outputs failure information immediately so you can proceed with fixing instead
+of twiddling your thumbs or browsing your favourite social site while your test suite hums
+away in the background. This formatter means you can be more efficient while coding. Basically,
+it makes you a better person. You should start using this formatter now.
+
+Note: (seriously) if your main project has 6,000 rspec examples, like mine does, it's probably
+pathological, and you should probably refactor, as I should. This formatter can help you cope
+while you're waiting for the doctor.
+
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+    group :test do
+      gem 'rspec_numbering_formatter'
+    end
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Run rspec thus:
+
+    $ bundle exec rspec spec --format RspecNumberingFormatter
+
+Enjoy the immediate boost to your productivity.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rspec_numbering_formatter.rb

@@ -0,0 +1,39 @@
+require 'rspec/core/formatters/base_text_formatter'
+
+# useful reference: http://ascii-table.com/ansi-escape-sequences.php
+
+class RspecNumberingFormatter < RSpec::Core::Formatters::BaseTextFormatter
+  VERSION = "0.0.1"
+
+  attr_accessor :run_count
+
+  def start(example_count)
+    @pwd = `pwd`
+    @start_time = Time.now
+    @run_count = 0
+    super
+    output.puts "#{example_count} examples"
+  end
+
+  def example_passed(example)
+    super
+    elapsed = (Time.now - @start_time).to_i
+    secs = elapsed % 60
+    mins = elapsed / 60
+    elapsed = "#{mins}:#{secs.to_s.rjust(2, '0')}"
+    @run_count += 1
+    output.print "\r\e[K#{elapsed.rjust(8)} #{@run_count.to_s.rjust(10)} #{example.full_description[0..100].ljust(101)}  #{truncate_pwd(example.location)[0..100]}"
+  end
+
+  def example_failed(example)
+    super
+    @run_count += 1
+    output.puts failure_color("\r\e[K#{@run_count.to_s.rjust(10)} #{example.full_description}")
+    output.puts failure_color("           #{truncate_pwd example.location}")
+    dump_failure_info example
+  end
+
+  def truncate_pwd str
+    str.sub @pwd, ""
+  end
+end

data/rspec_numbering_formatter.gemspec

@@ -0,0 +1,24 @@
+# -*- coding: utf-8; mode: ruby  -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rspec_numbering_formatter'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rspec_numbering_formatter"
+  gem.version       = RspecNumberingFormatter::VERSION
+  gem.authors       = ["Conan Dalton"]
+  gem.license       = 'MIT'
+  gem.email         = ["conan@conandalton.net"]
+  gem.description   = %q{ An rspec formatter that shows elapsed time, example count, example description, and example location, with no scrolling except for errors. }
+  gem.summary       = %q{ RSpec formatter with more information in less space  }
+  gem.homepage      = "https://github.com/conanite/rspec_numbering_formatter"
+
+  gem.add_development_dependency 'rspec', '~> 2.9'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/rspec_numbering_formatter_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe RspecNumberingFormatter do
+  it "should produce helpful output" do
+    rspec_command = 'bundle exec rspec spec/sample-specs --format RspecNumberingFormatter -P "**/*_spec_sample.rb" 2>&1'
+    output = `#{rspec_command}`
+    output.gsub!(/Finished in \d+.\d+ seconds/, 'Finished in some seconds').gsub!(/\r/, "\n*").gsub!(/\e/, 'ESC')
+    output.should == "4 examples
+
+*ESC[K    0:00          1 first should be nil                                                                                    ./spec/sample-specs/first_spec_sample.rb:4
+*ESC[K    0:00          2 first should be non-nil                                                                                ./spec/sample-specs/first_spec_sample.rb:8
+*ESC[K         3 second sample should include a broken test
+           ./spec/sample-specs/second_spec_sample.rb:4
+     Failure/Error: (1 + 1).should == 3
+       expected: 3
+            got: 2 (using ==)
+
+*ESC[K    0:00          4 second sample should be true                                                                           ./spec/sample-specs/second_spec_sample.rb:8
+Failures:
+
+  1) second sample should include a broken test
+     Failure/Error: (1 + 1).should == 3
+       expected: 3
+            got: 2 (using ==)
+     # ./spec/sample-specs/second_spec_sample.rb:5:in `block (2 levels) in <top (required)>'
+
+Finished in some seconds
+4 examples, 1 failure
+
+Failed examples:
+
+rspec ./spec/sample-specs/second_spec_sample.rb:4 # second sample should include a broken test
+"
+  end
+end

data/spec/sample-specs/first_spec_sample.rb

@@ -0,0 +1,11 @@
+require 'sample_spec_helper'
+
+describe "first" do
+  it "should be nil" do
+    [].first.should == nil
+  end
+
+  it "should be non-nil" do
+    [:a].first.should == :a
+  end
+end

data/spec/sample-specs/second_spec_sample.rb

@@ -0,0 +1,11 @@
+require 'sample_spec_helper'
+
+describe "second sample" do
+  it "should include a broken test" do
+    (1 + 1).should == 3
+  end
+
+  it "should be true" do
+    true.should == true
+  end
+end

data/spec/sample_spec_helper.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rspec_numbering_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Conan Dalton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: ! ' An rspec formatter that shows elapsed time, example count, example
+  description, and example location, with no scrolling except for errors. '
+email:
+- conan@conandalton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec_numbering_formatter.rb
+- rspec_numbering_formatter.gemspec
+- spec/rspec_numbering_formatter_spec.rb
+- spec/sample-specs/first_spec_sample.rb
+- spec/sample-specs/second_spec_sample.rb
+- spec/sample_spec_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/conanite/rspec_numbering_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: RSpec formatter with more information in less space
+test_files:
+- spec/rspec_numbering_formatter_spec.rb
+- spec/sample-specs/first_spec_sample.rb
+- spec/sample-specs/second_spec_sample.rb
+- spec/sample_spec_helper.rb
+- spec/spec_helper.rb