spec_upon_a_time 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54a79563bd2b651b8a072b74be7307beb628eb37
+  data.tar.gz: 922c348940d1e6a0ca1bd32bf916b53b2faca0e0
+SHA512:
+  metadata.gz: b62044638a8d6514e0685635d0c70665a859e415697f02cfdf45d98c2d4a1d6868209bfab0faf2f96b65cf8e960db5a806ccef4e74b3733576f855b484fde51e
+  data.tar.gz: 84c6ba524b6e48b062265bfe28f35d5374cd249af2ef6d6850e9fb75ea6c3052d6907d41c6b5297bda07f8d99092189e7b9df19a55b024ba6e56c6b7899f0ba3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TJ Taylor
+
+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,38 @@
+# SpecUponATime
+
+A RSpec 3 style formatter that prints specs in documentation format with the
+time it took to run each spec.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spec_upon_a_time'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spec_upon_a_time
+
+## Usage
+
+Run your specs with the formatter set:
+
+    $ bundle exec rspec --format SpecUponATime::Formatter
+
+Or add it to your `.rspec` file:
+
+    --format SpecUponATime::Formatter
+
+## Contributing
+
+1. Fork it ( https://github.com/dugancathal/spec_upon_a_time/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/spec_upon_a_time.rb

@@ -0,0 +1,5 @@
+require 'spec_upon_a_time/version'
+require 'spec_upon_a_time/formatter'
+
+module SpecUponATime
+end

data/lib/spec_upon_a_time/formatter.rb

@@ -0,0 +1,36 @@
+require 'rspec/core/formatters/documentation_formatter'
+
+module SpecUponATime
+  class Formatter < RSpec::Core::Formatters::DocumentationFormatter
+    RSpec::Core::Formatters.register self, :example_group_started, :example_group_finished,
+                                  :example_passed, :example_pending, :example_failed
+    private
+
+    def passed_output(example)
+      codes.wrap("#{current_indentation}#{example.description.strip} " \
+                 "(#{run_time_for(example)})", :success)
+    end
+
+    def pending_output(example, message)
+      codes.wrap("#{current_indentation}#{example.description.strip} " \
+                 "(#{run_time_for(example)}) " \
+                 "(PENDING: #{message})",
+                 :pending)
+    end
+
+    def failure_output(example, _exception)
+      codes.wrap("#{current_indentation}#{example.description.strip} " \
+                 "(#{run_time_for(example)}) " \
+                 "(FAILED - #{next_failure_index})",
+                 :failure)
+    end
+
+    def run_time_for(example)
+      example.execution_result.run_time
+    end
+
+    def codes
+      RSpec::Core::Formatters::ConsoleCodes
+    end
+  end
+end

data/lib/spec_upon_a_time/version.rb

@@ -0,0 +1,3 @@
+module SpecUponATime
+  VERSION = '1.0.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'spec_upon_a_time'
+require 'rspec'
+RSpec.configure do |config|
+end

data/spec/spec_upon_a_time_formatter_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+require 'spec_upon_a_time/formatter'
+
+module SpecUponATime
+  describe Formatter do
+    def example_notification(example)
+      ::RSpec::Core::Notifications::ExampleNotification.for(example)
+    end
+
+    def execution_result(values)
+      RSpec::Core::Example::ExecutionResult.new.tap do |er|
+        values.each { |name, value| er.__send__(:"#{name}=", value) }
+      end
+    end
+
+    def reporter
+      @reporter ||= setup_reporter
+    end
+
+    def setup_reporter(*streams)
+      config.add_formatter described_class, *streams
+      @formatter = config.formatters.first
+      @reporter = config.reporter
+    end
+
+    def output
+      @output ||= StringIO.new
+    end
+
+    def config
+      @configuration ||=
+        begin
+          config = RSpec::Core::Configuration.new
+          config.output_stream = output
+          config
+        end
+    end
+
+    %w(passed failed pending).each do |spec_type|
+      it "includes the execution time in #{spec_type} spec output" do
+        reporter.notify :start, ::RSpec::Core::Notifications::StartNotification.new(2)
+        reporter.notify :"example_#{spec_type}", example_notification(
+          double('example 1',
+            description: 'first example',
+            execution_result: execution_result(status: spec_type, run_time: '0.0001')
+          )
+        )
+
+        expect(output.string).to match(/first example \(0.0001\)/)
+      end
+    end
+  end
+end

data/spec_upon_a_time.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spec_upon_a_time/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spec_upon_a_time"
+  spec.version       = SpecUponATime::VERSION
+  spec.authors       = ["TJ Taylor"]
+  spec.email         = ["dugancathal@gmail.com"]
+  spec.summary       = %q{An RSpec3 Formatter that prints the runtime for each spec}
+  spec.description   = %q{Ever wanted to know how long a spec took BEFORE your whole suite is done? Well look no further.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: spec_upon_a_time
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- TJ Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ever wanted to know how long a spec took BEFORE your whole suite is done?
+  Well look no further.
+email:
+- dugancathal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spec_upon_a_time.rb
+- lib/spec_upon_a_time/formatter.rb
+- lib/spec_upon_a_time/version.rb
+- spec/spec_helper.rb
+- spec/spec_upon_a_time_formatter_spec.rb
+- spec_upon_a_time.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An RSpec3 Formatter that prints the runtime for each spec
+test_files:
+- spec/spec_helper.rb
+- spec/spec_upon_a_time_formatter_spec.rb