yertle_formatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9adda953589b6451c5fce9e5ce135fbe4f7e7c5
+  data.tar.gz: 29cfe6d9574ae4f7fd7e6476bdaba2a8357b08f3
+SHA512:
+  metadata.gz: d499e65800aa3767b0e7dae45b6d4288780bc54a0828dd725678fef6cee93cb9548590668d9732a02c815dd04e7081757efe86503bbdb960bd81934ce45c36ec
+  data.tar.gz: ad9422336dd78b638165bb456e9ba6b85d114281c4ceb3f0db19d5a46d152ecfcdf283dfb5f25552e3835dcb6832d65e231a9917097faef309c7d106fc8644f9

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-*

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  enabled: true

data/.pullreview.yml

@@ -0,0 +1,6 @@
+rules:
+  ignore:
+    - missing_class_documentation
+    - missing_method_documentation
+    - prefer_single_quoted_strings
+    - use_a_logger

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "2.2"
+  - "2.1.5"
+  - "2.0.0-p598"
+  - "1.9.3-p551"
+script: bundle exec rspec spec
+sudo: false
+cache: bundler

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,37 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Uncomment and set this to only include directories you want to watch
+#
+# directories %(app lib config test spec feature)
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ed Gibbs
+
+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,53 @@
+# YertleFormatter
+[![Build Status](https://travis-ci.org/edgibbs/yertle_formatter.svg?branch=master)](https://travis-ci.org/edgibbs/yertle_formatter)
+[![Coverage Status](https://img.shields.io/coveralls/edgibbs/yertle_formatter.svg)](https://coveralls.io/r/edgibbs/yertle_formatter?branch=master)
+[![Code Climate](https://codeclimate.com/github/edgibbs/yertle_formatter/badges/gpa.svg)](https://codeclimate.com/github/edgibbs/yertle_formatter)
+[![PullReview stats](https://www.pullreview.com/github/edgibbs/yertle_formatter/badges/master.svg?)](https://www.pullreview.com/github/edgibbs/yertle_formatter/reviews/master)
+
+![Yertle Screen Shot](yertle_screenshot.png)
+
+An RSpec 3 formatter for highlighting slow specs.  Slow specs are marked with turtles (:turtle:) and a summary of slow specs are returned at the end of the run.
+
+## Usage
+
+Basic usage is like any other RSpec formatter:
+
+    rspec --format YertleFormatter
+
+Or to make it the default add the following to your .rspec file:
+
+    require --format YertleFormatter
+
+It defaults to defining slow specs as slower than 0.2 seconds.  You can modify this by setting an environment varaible:
+
+    YERTLE_SLOW_TIME=1.0
+
+Or you can add the use a configurable flag for yertle_slow_time in your RSpec configuration:
+
+```ruby
+RSpec.configure do |config|
+  config.yertle_slow_time = 1.0
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yertle_formatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yertle_formatter
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yertle_formatter/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/version.rb

@@ -0,0 +1 @@
+VERSION = "0.0.1"

data/lib/yertle_formatter.rb

@@ -0,0 +1,62 @@
+require "rspec/core/formatters/base_text_formatter"
+
+class YertleFormatter < RSpec::Core::Formatters::BaseTextFormatter
+  RSpec::Core::Formatters.register self, :example_passed, :dump_summary
+
+  attr_reader :slow_specs
+
+  def example_passed(notification)
+    if slow_spec?(notification.example)
+      @slow_specs = true
+      print_turtle
+    else
+      print_dot
+    end
+  end
+
+  def dump_summary(summary_notification)
+    super(summary_notification)
+    summarize_slow_specs(summary_notification) if slow_specs
+  end
+
+  private
+
+  def slow_spec?(example)
+    example.metadata[:execution_result].run_time > threshold
+  end
+
+  def print_turtle
+    output.print "\u{1f422} "
+  end
+
+  def print_dot
+    output.print "."
+  end
+
+  def threshold
+    slow_time_environment_variable || RSpec.configuration.yertle_slow_time || 0.1
+  end
+
+  def slow_time_environment_variable
+    ENV["YERTLE_SLOW_TIME"] ? ENV["YERTLE_SLOW_TIME"].to_f : nil
+  end
+
+  def summarize_slow_specs(summary_notification)
+    output.puts "\n------"
+    slow_spec_examples(summary_notification).each do |example|
+      slow_test_description = <<-SLOW_TEST_OUTPUT
+"#{example.full_description}" #{example.metadata[:execution_result].run_time} seconds
+#{example.location}
+      SLOW_TEST_OUTPUT
+      output.puts slow_test_description
+    end
+  end
+
+  def slow_spec_examples(summary_notification)
+    summary_notification.examples.select do |example|
+      slow_spec?(example)
+    end.sort do |example_1, example_2|
+      example_2.metadata[:execution_result].run_time <=> example_1.metadata[:execution_result].run_time
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "coveralls"
+
+Coveralls.wear!
+
+Dir[File.join(".", "lib", "**/*.rb")].each do |file|
+  require file
+end
+
+RSpec.configure do |configuration|
+  configuration.add_setting :yertle_slow_time
+  configuration.yertle_slow_time = 0.1
+end

data/spec/yertle_formatter_spec.rb

@@ -0,0 +1,161 @@
+require "spec_helper"
+
+shared_examples "a slow test" do |run_time|
+  it "displays a turtle emoji" do
+    execution_result.send(:run_time=, run_time)
+    formatter.example_passed(notification)
+    expect(output.string).to eq("\u{1f422} ")
+  end
+
+  it "sets slow specs flag to true" do
+    execution_result.send(:run_time=, run_time)
+    formatter.example_passed(notification)
+    expect(formatter.slow_specs).to be true
+  end
+end
+
+shared_examples "a fast test" do |run_time|
+  it "displays the default dot" do
+    execution_result.send(:run_time=, run_time)
+    expect(output).to receive(:print).with(".")
+    formatter.example_passed(notification)
+  end
+
+  it "leaves slow specs flag as false" do
+    execution_result.send(:run_time=, run_time)
+    formatter.example_passed(notification)
+    expect(formatter.slow_specs).to be_falsey
+  end
+end
+
+describe YertleFormatter do
+  let(:output) { StringIO.new }
+  let(:formatter) { YertleFormatter.new(output) }
+  let(:notification) { instance_double("RSpec::Core::Notifications::ExampleNotification") }
+  let(:execution_result) { RSpec::Core::Example::ExecutionResult.new }
+  let(:example) { RSpec::Core::Example.new(RSpec::Core::AnonymousExampleGroup, "description", {}) }
+
+  before do
+    RSpec.configuration.yertle_slow_time = nil
+    ENV.delete("YERTLE_SLOW_TIME")
+  end
+
+  describe "#example_passed" do
+    before do
+      allow(example).to receive(:metadata) { { execution_result: execution_result } }
+      allow(notification).to receive(:example) { example }
+    end
+
+    context "with YERTLE_SLOW_TIME configured" do
+      before do
+        ENV["YERTLE_SLOW_TIME"] = "0.4"
+      end
+
+      it_behaves_like "a slow test", 0.5
+
+      it_behaves_like "a fast test", 0.3
+    end
+
+    context "with yertle_slow_time configured" do
+      before do
+        RSpec.configuration.yertle_slow_time = 0.2
+      end
+
+      it_behaves_like "a slow test", 0.3
+
+      it_behaves_like "a fast test", 0.1
+    end
+
+    context "with YERTLE_SLOW_TIME and yertle_slow_time configured" do
+      before do
+        ENV["YERTLE_SLOW_TIME"] = "0.4"
+        RSpec.configuration.yertle_slow_time = 0.1
+      end
+
+      context "uses the environment variable setting" do
+        it_behaves_like "a slow test", 0.5
+
+        it_behaves_like "a fast test", 0.3
+      end
+    end
+
+    context "with no yertle_slow_time or YERTLE_SLOW_TIME configured" do
+      it_behaves_like "a slow test", 0.2
+
+      it_behaves_like "a fast test", 0.01
+    end
+  end
+
+  describe "#dump_summary" do
+    let(:fast_example) { RSpec::Core::Example.new(RSpec::Core::AnonymousExampleGroup, "Fast Test Description", {}) }
+    let(:fast_execution_result) { RSpec::Core::Example::ExecutionResult.new }
+    let(:fast_metadata) { { execution_result: fast_execution_result } }
+    let(:slow_example) { RSpec::Core::Example.new(RSpec::Core::AnonymousExampleGroup, "Slow Test Description", {}) }
+    let(:slow_execution_result) { RSpec::Core::Example::ExecutionResult.new }
+    let(:slow_metadata) { { execution_result: slow_execution_result } }
+    let(:slower_example) { RSpec::Core::Example.new(RSpec::Core::AnonymousExampleGroup, "Slower Test Description", {}) }
+    let(:slower_execution_result) { RSpec::Core::Example::ExecutionResult.new }
+    let(:slower_metadata) { { execution_result: slower_execution_result } }
+    let(:summary_notification) do
+      notification = RSpec::Core::Notifications::SummaryNotification.new
+      notification.examples = [fast_example, slow_example, slower_example]
+      notification.duration = 9
+      notification.load_time = 5
+      notification.failed_examples = []
+      notification.pending_examples = []
+      notification
+    end
+
+    context "with slow tests" do
+      let(:final_output) do
+        <<-FINAL_OUTPUT
+
+Finished in 9 seconds (files took 5 seconds to load)
+3 examples, 0 failures
+
+------
+" Slower Test Description" 0.3 seconds
+./spec/yertle_formatter_spec.rb:96
+" Slow Test Description" 0.2 seconds
+./spec/yertle_formatter_spec.rb:93
+        FINAL_OUTPUT
+      end
+
+      before do
+        formatter.instance_variable_set(:@slow_specs, true)
+        allow(fast_example).to receive(:metadata) { fast_metadata }
+        fast_execution_result.send(:run_time=, 0.01)
+        allow(slow_example).to receive(:metadata) { slow_metadata }
+        slow_execution_result.send(:run_time=, 0.2)
+        allow(slower_example).to receive(:metadata) { slower_metadata }
+        slower_execution_result.send(:run_time=, 0.3)
+      end
+
+      it "displays a sorted list of the slow tests after the default summary" do
+        formatter.dump_summary(summary_notification)
+        expect(output.string).to eq(final_output)
+      end
+    end
+
+    context "with no slow tests" do
+      let(:final_output) do
+        <<-FINAL_OUTPUT
+
+Finished in 9 seconds (files took 5 seconds to load)
+2 examples, 0 failures
+        FINAL_OUTPUT
+      end
+
+      before do
+        summary_notification.examples = [fast_example, fast_example]
+        allow(fast_example).to receive(:metadata) { fast_metadata }
+        fast_execution_result.send(:run_time=, 0.01)
+      end
+
+      it "displays just the default summary and a separator" do
+        formatter.dump_summary(summary_notification)
+        expect(output.string).to eq(final_output)
+      end
+    end
+  end
+end

data/yertle_formatter.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yertle_formatter"
+  spec.version       = VERSION
+  spec.authors       = ["Ed Gibbs"]
+  spec.email         = ["edward_gibbs@yahoo.com"]
+  spec.summary       = %q{An RSpec 3 formatter highlighting slow specs.}
+  spec.description   = %q{Slow specs are marked with turtles and a summary of slow specs are returned at the end of the run.}
+  spec.homepage      = "https://github.com/edgibbs/yertle_formatter"
+  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_runtime_dependency 'rspec', '>=3.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "guard-rspec"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: yertle_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ed Gibbs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Slow specs are marked with turtles and a summary of slow specs are returned
+  at the end of the run.
+email:
+- edward_gibbs@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".pullreview.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/version.rb
+- lib/yertle_formatter.rb
+- spec/spec_helper.rb
+- spec/yertle_formatter_spec.rb
+- yertle_formatter.gemspec
+- yertle_screenshot.png
+homepage: https://github.com/edgibbs/yertle_formatter
+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.4.4
+signing_key: 
+specification_version: 4
+summary: An RSpec 3 formatter highlighting slow specs.
+test_files:
+- spec/spec_helper.rb
+- spec/yertle_formatter_spec.rb