rspec_spinner 0.4.5

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-12-18
+
+* 1 major enhancement:
+  * Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nicholas A. Evans, Marcos Piccinini
+ 
+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/Manifest.txt

@@ -0,0 +1,18 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/rspec_spinner.rb
+lib/rspec_spinner/bar.rb
+lib/rspec_spinner/base.rb
+lib/rspec_spinner/spinner.rb
+rspec_spinner.gemspec
+script/console
+script/destroy
+script/generate
+spec/rspec_spinner_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,21 @@
+== TO USE:
+
+Require RspecSpinner on spec/spec_helper.rb:
+
+  require 'spec'
+  require 'rspec_spinner'
+  ...
+  
+
+Change your spec.opts --formatter to "spinner":
+
+  --formatter RspecSpinner::Bar
+  
+or:
+
+  --formatter RspecSpinner::Spinner
+                            
+                            
+Have fun!
+
+http://github.com/nofxx/rspec_spinner

data/README.rdoc

@@ -0,0 +1,59 @@
+= rspec-spinner
+
+* http://github.com/nofxx/rspec-spinner
+
+Adds an extra formatter that looks like this:
+
+  Foo::Error ......
+  SLOW SPEC: 10.0314  Foo should raise Bar
+  PENDING SPEC: Foo should get Bar
+  891/1808:  49% |=======================                        | ETA:  00:00:21
+
+   
+Or this:
+
+  46%  \                                                          ETA:  00:00:23
+  
+
+No dots and Fs, just what you need to know: FAILURES, PENDINGS and SLOW ones. 
+
+
+== INSTALL:
+
+  sudo gem install rspec_spinner
+
+
+== TO USE:
+
+Require RspecSpinner on spec/spec_helper.rb:
+
+  require 'spec'
+  require 'rspec_spinner'
+  ...
+  
+
+Change your spec.opts --formatter to:
+
+  --formatter RspecSpinner::Bar
+  
+or:
+
+  --formatter RspecSpinner::Spinner
+                            
+                            
+Have fun! 
+  
+
+== REQUIREMENTS:
+
+* rspec
+* rtui (http://github.com/nofxx/rtui)
+
+
+== LICENSE:
+
+(The MIT License)
+
+Based on the Advanced Progress Bar by Nicholas A. Evans
+
+Copyright (c) 2008 Marcos Piccinini

data/Rakefile

@@ -0,0 +1,32 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/rspec_spinner'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('rspec_spinner', RspecSpinner::VERSION) do |p|
+  p.developer('Marcos Piccinini', 'x@nofxx.com')
+  p.summary = "Some extra formatters for rspec"
+  p.description = "Some extra formatters for rspec"
+  p.url = "http://github.com/nofxx/postgis_adapter"
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' 
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+     ['rspec','>=1.1.11'],
+     ['rtui','>= 0.1.8']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/rspec_spinner/bar.rb

@@ -0,0 +1,16 @@
+module RspecSpinner
+  class Bar < RspecSpinnerBase
+
+
+    def start(example_count)
+      @current     = 0
+      @total       = example_count
+      @error_state = :all_passing
+      @pbar        = Rtui::Progress.new("#{example_count} examples", example_count,
+      {:out => output})
+    end
+  end
+end
+
+
+

data/lib/rspec_spinner/base.rb

@@ -0,0 +1,129 @@
+require "spec/runner/formatter/base_text_formatter"
+require "rubygems"
+require "rtui"
+
+module RspecSpinner
+  class RspecSpinnerBase < Spec::Runner::Formatter::BaseTextFormatter
+    # Threshold for slow specs, in seconds.
+    # Anything that takes longer than this will be printed out
+    #THRESHOLD = 0.25
+    THRESHOLD = 3.0
+
+    attr_reader :total, :current
+
+    def start(example_count)
+      @current     = 0
+     # @subject     = "oi"
+      @total       = example_count
+      @error_state = :all_passing
+      @pbar        = Rtui::Progress.new("#{example_count} examples", example_count,
+      {:out => output, :components => [:percentage, :spinner, :stat]})
+      @pbar.subject = "Starting..."
+    end
+
+    def example_started(example)
+      super
+      @start_time = Time.now
+    end
+
+    def example_passed(example)
+      print_warning_if_slow(example_group.description,
+                            example.description,
+                            Time.now - @start_time)
+      increment
+    end
+
+    # third param is optional, because earlier versions of rspec sent only two args
+    def example_pending(example, message, pending_caller=nil)
+      immediately_dump_pending(example.full_description, message, pending_caller)
+      mark_error_state_pending
+      increment
+    end
+
+    def example_failed(example, counter, failure)
+      immediately_dump_failure(counter, failure)
+      mark_error_state_failed
+      increment
+    end
+
+    def start_dump
+      @pbar.subject = ""
+      with_color do
+        @pbar.finish
+      end
+      output.flush
+    end
+
+    def dump_failure(*args)
+      # no-op; we summarized failures as we were running
+    end
+
+    def method_missing(sym, *args)
+      # ignore
+    end
+
+    # stolen and slightly modified from BaseTextFormatter#dump_failure
+    def immediately_dump_failure(counter, failure)
+      erase_current_line
+      output.puts
+      output.print "#{counter.to_s}) "
+      output.puts colourise("#{failure.header}\n#{failure.exception.message}", failure)
+      output.puts format_backtrace(failure.exception.backtrace)
+      output.puts
+    end
+
+    # stolen and modified from BaseTextFormatter#dump_pending
+    def immediately_dump_pending(desc, msg, called_from)
+      erase_current_line
+      output.puts yellow("PENDING SPEC:") + " #{desc} (#{msg})"
+      output.puts "  Called from #{called_from}" if called_from
+    end
+
+    def increment
+      with_color do
+        @current += 1
+        # HACK: need to make sure the progress is printed, even when the bar hasn't changed
+        @pbar.instance_variable_set("@previous", 0)
+        @pbar.instance_variable_set("@title", "#{current}/#{total}")
+        @pbar.inc
+      #  @pbar.subject = @subject if @subject
+      end
+      output.flush
+    end
+
+    ERROR_STATE_COLORS = {
+      :all_passing  => "\e[32m", # green
+      :some_pending => "\e[33m", # yellow
+      :some_failed  => "\e[31m", # red
+    }
+
+    def with_color
+      use_color = colour? && output_to_tty?
+      output.print ERROR_STATE_COLORS[@error_state] if use_color
+      yield
+      output.print "\e[0m" if use_color
+    end
+
+    def mark_error_state_failed
+      @error_state = :some_failed
+    end
+
+    def mark_error_state_pending
+      @error_state = :some_pending unless @error_state == :some_failed
+    end
+
+    def erase_current_line
+      output.print "\e[K"
+    end
+
+    def print_warning_if_slow(group, example, elapsed)
+      if elapsed > THRESHOLD
+        #mark_error_state(:pending)
+        erase_current_line
+        output.print yellow("SLOW SPEC: #{sprintf("%.4f", elapsed)} ")
+        output.print " #{group} #{example}"
+        output.puts
+      end
+    end
+  end
+end

data/lib/rspec_spinner/spinner.rb

@@ -0,0 +1,18 @@
+module RspecSpinner
+  class Spinner < RspecSpinnerBase
+
+
+    def start(example_count)
+      @current     = 0
+      @total       = example_count
+      @error_state = :all_passing
+      @pbar        = Rtui::Progress.new("#{example_count} examples", example_count,
+      {:out => output, :components => [:percentage, :spinner, :subject, :stat]})
+    end
+
+    def example_started(example)
+      @pbar.subject = example.description
+      super
+    end
+  end
+end

data/lib/rspec_spinner.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+#require "spec/runner/options"
+require "rspec_spinner/base"
+require "rspec_spinner/spinner"
+require "rspec_spinner/bar"
+
+module RspecSpinner
+  VERSION = '0.4.5'
+end
+
+#module Spec
+#  module Runner
+#    class Options
+#      EXAMPLE_FORMATTERS.merge({ 'spinner'  => ['spec/runner/formatter/spinner_formatter',                'Formatter::SpinnerFormatter'] })
+#    end
+##  end
+#end

data/rspec_spinner.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rspec_spinner}
+  s.version = "0.4.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marcos Piccinini"]
+  s.date = %q{2008-12-21}
+  s.description = %q{Some extra formatters for rspec}
+  s.email = ["x@nofxx.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
+  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "lib/rspec_spinner.rb", "lib/rspec_spinner/bar.rb", "lib/rspec_spinner/base.rb", "lib/rspec_spinner/spinner.rb", "rspec_spinner.gemspec", "script/console", "script/destroy", "script/generate", "spec/rspec_spinner_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/nofxx/postgis_adapter}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rspec_spinner}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Some extra formatters for rspec}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rspec>, [">= 1.1.11"])
+      s.add_runtime_dependency(%q<rtui>, [">= 0.1.8"])
+      s.add_development_dependency(%q<newgem>, [">= 1.2.1"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.1.11"])
+      s.add_dependency(%q<rtui>, [">= 0.1.8"])
+      s.add_dependency(%q<newgem>, [">= 1.2.1"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.1.11"])
+    s.add_dependency(%q<rtui>, [">= 0.1.8"])
+    s.add_dependency(%q<newgem>, [">= 1.2.1"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rspec-spinner.rb'}"
+puts "Loading rspec-spinner gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/rspec_spinner_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rspec-spinner'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: rspec_spinner
+version: !ruby/object:Gem::Version 
+  version: 0.4.5
+platform: ruby
+authors: 
+- Marcos Piccinini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-21 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.11
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rtui
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Some extra formatters for rspec
+email: 
+- x@nofxx.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- MIT-LICENSE
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/rspec_spinner.rb
+- lib/rspec_spinner/bar.rb
+- lib/rspec_spinner/base.rb
+- lib/rspec_spinner/spinner.rb
+- rspec_spinner.gemspec
+- script/console
+- script/destroy
+- script/generate
+- spec/rspec_spinner_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/nofxx/postgis_adapter
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rspec_spinner
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Some extra formatters for rspec
+test_files: []
+