rspec_overview 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f4558b861fa108b0a0810d3fae12a7a2ea625bf
+  data.tar.gz: 5bfea330b3482aa5b75337a4715950b1850e56f5
+SHA512:
+  metadata.gz: b25e8431b9829f4958a17aed61ace2b4f1f782ca53eae84969c2be2f8ca5367f3ecd430c22d429d36605e28c03b1a9bdc2727acf28fd1c69b0fbee4aa7c495f3
+  data.tar.gz: b744a21eebfd6797b75a3ff0847bf17d1040dc78c5cd4155aea95cf0cbf5aaba3a1da249ba5c2362eecb93c67d4f60dda64ffe79a035a56d45229e41b8023233

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--format progress
+--format RspecOverview::Formatter

data/.ruby-version

@@ -0,0 +1 @@
+2.4.3

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+before_install: gem install bundler -v 1.16.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    rspec_overview (0.1.0)
+      rspec-core (~> 3.0)
+      terminal-table (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry-byebug (~> 3.5)
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  rspec_overview!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,86 @@
+# RspecOverview
+
+[![Build Status](https://travis-ci.org/odlp/rspec_overview.svg?branch=master)](https://travis-ci.org/odlp/rspec_overview)
+
+Take `RspecOverview::Formatter` a spin when you're new to a project & need an
+overview:
+
+- How are the tests structured?
+- How many tests are there by meta-type (feature, model, controller)?
+- Which tests are taking the most time?
+
+## Usage
+
+In your `Gemfile`:
+
+```ruby
+group :test do
+  gem "rspec_overview"
+end
+```
+
+Then `bundle`. The overview formatter can be used standalone, or mix & match
+with other formatters:
+
+```sh
+# With the progress formatter:
+bundle exec rspec --format progress --format RspecOverview::Formatter
+
+# With the documentation formatter:
+bundle exec rspec --format documentation --format RspecOverview::Formatter
+```
+
+## Example output
+
+Run against [thoughtbot/administrate][administrate]:
+
+[administrate]: https://github.com/thoughtbot/administrate
+
+```
+Randomized with seed 40301
+................................................................................
+................................................................................
+................................................................................
+................................................................................
+...........................................
+
+Finished in 19.36 seconds (files took 3.99 seconds to load)
+363 examples, 0 failures
+
+Summary by Type or Subfolder
++---------------------+---------------+--------------+-------------------------+
+| Type or Subfolder   | Example count | Duration (s) | Average per example (s) |
++---------------------+---------------+--------------+-------------------------+
+| feature             | 83            | 9.88         | 0.11905                 |
+| controller          | 46            | 3.56         | 0.07738                 |
+| generator           | 73            | 2.49         | 0.03408                 |
+| ./spec/lib          | 95            | 1.02         | 0.0107                  |
+| ./spec/i18n_spec.rb | 2             | 0.93344      | 0.46672                 |
+| view                | 15            | 0.75198      | 0.05013                 |
+| model               | 28            | 0.33824      | 0.01208                 |
+| ./spec/administrate | 5             | 0.06623      | 0.01325                 |
+| helper              | 7             | 0.02385      | 0.00341                 |
+| ./spec/dashboards   | 9             | 0.01684      | 0.00187                 |
++---------------------+---------------+--------------+-------------------------+
+
+Summary by File
++-------------------------------------------------------------+---------------+--------------+-------------------------+
+| File                                                        | Example count | Duration (s) | Average per example (s) |
++-------------------------------------------------------------+---------------+--------------+-------------------------+
+| ./spec/features/index_page_spec.rb                          | 11            | 2.09         | 0.1899                  |
+| ./spec/controllers/admin/blog/posts_controller_spec.rb      | 16            | 1.64         | 0.1025                  |
+| ./spec/features/orders_form_spec.rb                         | 7             | 1.28         | 0.1825                  |
+| ./spec/i18n_spec.rb                                         | 2             | 0.93344      | 0.46672                 |
+| ./spec/generators/routes_generator_spec.rb                  | 8             | 0.87447      | 0.10931                 |
+| ./spec/controllers/admin/log_entries_controller_spec.rb     | 6             | 0.84819      | 0.14137                 |
+| ./spec/generators/dashboard_generator_spec.rb               | 21            | 0.8094       | 0.03854                 |
+| ./spec/features/show_page_spec.rb                           | 9             | 0.79038      | 0.08782                 |
+| ./spec/lib/fields/date_time_spec.rb                         | 8             | 0.703        | 0.08787                 |
+| ./spec/features/orders_index_spec.rb                        | 6             | 0.67226      | 0.11204                 |
+| ./spec/features/log_entries_index_spec.rb                   | 6             | 0.66303      | 0.11051                 |
+| ./spec/features/search_spec.rb                              | 3             | 0.6555       | 0.2185                  |
+| <abridged>                                                  | <abridged>    | <abridged>   | <abridged>              |
++-------------------------------------------------------------+---------------+--------------+-------------------------+
+
+Randomized with seed 40301
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec_overview/formatter"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec_overview.rb

@@ -0,0 +1,5 @@
+require "rspec_overview/formatter"
+require "rspec_overview/version"
+
+module RspecOverview
+end

data/lib/rspec_overview/formatter.rb

@@ -0,0 +1,73 @@
+require "rspec/core"
+require "terminal-table"
+require_relative "result_row"
+
+module RspecOverview
+  class Formatter
+    RSpec::Core::Formatters.register self, :dump_summary
+
+    def initialize(output)
+      @output = output
+    end
+
+    def dump_summary(summary)
+      summarize_by_type(summary.examples)
+      summarize_by_file(summary.examples)
+    end
+
+    private
+
+    attr_reader :output
+
+    def summarize_by_type(examples)
+      summarize_by("Type or Subfolder", examples, &method(:type_or_subfolder))
+    end
+
+    def summarize_by_file(examples)
+      summarize_by("File", examples) { |example| example.file_path }
+    end
+
+    def summarize_by(column_name, examples)
+      data = {}
+
+      examples.each do |example|
+        identifier = yield(example) || "none"
+        data[identifier] ||= ResultRow.new(identifier)
+        data[identifier].example_count += 1
+        data[identifier].duration_raw += example.execution_result.run_time
+      end
+
+      headings = [
+        column_name, "Example count", "Duration (s)", "Average per example (s)"
+      ]
+
+      rows = values_in_descending_duration(data).map do |row|
+        [
+          row.identifier,
+          row.example_count,
+          helpers.format_seconds(row.duration_raw),
+          helpers.format_seconds(row.avg_duration),
+        ]
+      end
+
+      output.puts "\nSummary by #{column_name}"
+      print_table(headings: headings, rows: rows)
+    end
+
+    def type_or_subfolder(example)
+      example.metadata[:type] || example.file_path.slice(/.\/[^\/]+\/[^\/]+/)
+    end
+
+    def values_in_descending_duration(data)
+      data.values.sort_by(&:duration_raw).reverse_each
+    end
+
+    def helpers
+      RSpec::Core::Formatters::Helpers
+    end
+
+    def print_table(headings:, rows:)
+      output.puts Terminal::Table.new(headings: headings, rows: rows)
+    end
+  end
+end

data/lib/rspec_overview/result_row.rb

@@ -0,0 +1,14 @@
+class ResultRow
+  attr_reader :identifier
+  attr_accessor :example_count, :duration_raw
+
+  def initialize(identifier)
+    @identifier = identifier
+    @example_count = 0
+    @duration_raw = 0.0
+  end
+
+  def avg_duration
+    duration_raw / example_count
+  end
+end

data/lib/rspec_overview/version.rb

@@ -0,0 +1,3 @@
+module RspecOverview
+  VERSION = "0.1.0"
+end

data/rspec_overview.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rspec_overview/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_overview"
+  spec.version       = RspecOverview::VERSION
+  spec.authors       = ["Oli Peate"]
+  spec.email         = ["oliverp@gmail.com"]
+
+  spec.summary       = "See an overview of your RSpec test suite"
+  spec.homepage      = "https://github.com/odlp/rspec_overview"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec-core", "~> 3.0"
+  spec.add_dependency "terminal-table", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry-byebug", "~> 3.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rspec_overview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oli Peate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  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'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: 
+email:
+- oliverp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec_overview.rb
+- lib/rspec_overview/formatter.rb
+- lib/rspec_overview/result_row.rb
+- lib/rspec_overview/version.rb
+- rspec_overview.gemspec
+homepage: https://github.com/odlp/rspec_overview
+licenses: []
+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.6.14
+signing_key: 
+specification_version: 4
+summary: See an overview of your RSpec test suite
+test_files: []