rspec_overview 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf40c3329b0d98739b0e00a6a202bb23d9b5c205
-  data.tar.gz: e34c2e84a63d87523a889ba3fa2ad13d8b5cb542
+  metadata.gz: 91ecf4bf56b43ba4727d25899adcc5523827de5c
+  data.tar.gz: 3b280c205f00035b4455644041daf5bbdb73fd55
 SHA512:
-  metadata.gz: 71f0ab02f6846a6a0ca731ace4b7d90ab0e6ffb6b4f2d26914399b736cbb7fff7307317732b13275af9281c5284a702261660c18cc7ab770fcd71437040208c9
-  data.tar.gz: bf7efbaf8b0408422fab6844252aced0686c48d5b81b0b7f1db5472c4dffbdaa5841c05b7d49968d4002508c4886968b6caff5d09d5ff87875b6637fda4484a6
+  metadata.gz: 48e0d3b44f2cd9e4d71c8978df408e884560123c1c51bf053f316f2f8a3385de27a6f6eebdcc836b1bda9571a3bb041b6c1ae9e9f5d3989bccae9a2a22f87119
+  data.tar.gz: c524cde83bcf2ba4c857787132c1d7d685b10a32d1f6afb0cb336f2c6add205bb8fb7b96c894a0f2abac580b3011172bb29093ddd767fced9e1832a2b2c465a2

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## v0.2.0
+- Add CSV format support
+
+## v0.1.1
+- Tweak style of table titles
+
+## v0.1.0
+- Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec_overview (0.1.1)
+    rspec_overview (0.2.0)
       rspec-core (~> 3.0)
       terminal-table (~> 1.6)
 

data/README.md

@@ -2,11 +2,11 @@
 
 [![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 and need an
-overview:
+Take `RspecOverview::Formatter` for a spin when you're new to a project and need
+an overview:
 
 - How are the tests structured?
-- How many tests are there by meta-type (feature, model, controller)?
+- How many tests are there by type (feature, model, controller)?
 - Which tests are taking the most time?
 
 ## Usage
@@ -30,6 +30,14 @@ bundle exec rspec --format progress --format RspecOverview::Formatter
 bundle exec rspec --format documentation --format RspecOverview::Formatter
 ```
 
+### CSV format
+
+You can also produce a CSV for further analysis:
+
+```sh
+bundle exec rspec --format RspecOverview::FormatterCsv --out overview.csv
+```
+
 ## Example output
 
 Run against [thoughtbot/administrate][administrate]:

data/Rakefile

@@ -3,4 +3,9 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+RSpec::Core::RakeTask.new(:spec_with_formatters) do |t|
+  t.rspec_opts =
+    "--format RspecOverview::Formatter --format RspecOverview::FormatterCsv"
+end
+
+task default: [:spec, :spec_with_formatters]

data/lib/rspec_overview.rb

@@ -1,4 +1,5 @@
 require "rspec_overview/formatter"
+require "rspec_overview/formatter_csv"
 require "rspec_overview/version"
 
 module RspecOverview

data/lib/rspec_overview/formatter.rb

@@ -1,6 +1,6 @@
 require "rspec/core"
-require "terminal-table"
-require_relative "result_row"
+require_relative "output/table"
+require_relative "result"
 
 module RspecOverview
   class Formatter
@@ -20,7 +20,9 @@ module RspecOverview
     attr_reader :output
 
     def summarize_by_type(examples)
-      summarize_by("Type or Subfolder", examples, &method(:type_or_subfolder))
+      summarize_by("Type or Subfolder", examples) do |example|
+        example.metadata[:type] || extract_subfolder(example.file_path)
+      end
     end
 
     def summarize_by_file(examples)
@@ -28,51 +30,40 @@ module RspecOverview
     end
 
     def summarize_by(column_name, examples)
-      data = {}
+      results = {}
 
       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
+        results[identifier] ||= Result.new(identifier)
+        results[identifier].example_count += 1
+        results[identifier].duration_raw += example.execution_result.run_time
       end
 
-      title = "Summary by #{column_name}"
-
       headings = [
         column_name, "Example count", "Duration (s)", "Average per example (s)"
       ]
 
-      rows = values_in_descending_duration(data).map(&method(:as_table_row))
-
-      print_table(title: title, 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
+      output_format.generate(
+        output: output,
+        title: "Summary by #{column_name}",
+        headings: headings,
+        rows: results_as_rows(results),
+      )
     end
 
-    def as_table_row(row)
-      [
-        row.identifier,
-        row.example_count,
-        format_seconds(row.duration_raw),
-        format_seconds(row.avg_duration),
-      ]
+    def extract_subfolder(file_path)
+      file_path.slice(/.\/[^\/]+\/[^\/]+/)
     end
 
-    def format_seconds(duration)
-      RSpec::Core::Formatters::Helpers.format_seconds(duration)
+    def results_as_rows(results)
+      results.values
+        .sort_by(&:duration_raw)
+        .reverse_each
+        .map(&:to_a)
     end
 
-    def print_table(title:, headings:, rows:)
-      table = Terminal::Table.new(title: title, headings: headings, rows: rows)
-      output.puts "\n"
-      output.puts table
+    def output_format
+      RspecOverview::Output::Table.new
     end
   end
 end

data/lib/rspec_overview/formatter_csv.rb

@@ -0,0 +1,13 @@
+require_relative "output/csv"
+
+module RspecOverview
+  class FormatterCsv < Formatter
+    RSpec::Core::Formatters.register self, :dump_summary
+
+    private
+
+    def output_format
+      RspecOverview::Output::Csv.new
+    end
+  end
+end

data/lib/rspec_overview/output/csv.rb

@@ -0,0 +1,22 @@
+require "csv"
+
+module RspecOverview
+  module Output
+    class Csv
+      def generate(output:, title:, headings:, rows:)
+        csv_string = CSV.generate(**csv_options, headers: headings) do |csv|
+          rows.each { |row| csv << row }
+        end
+
+        output.puts title
+        output.puts csv_string
+      end
+
+      private
+
+      def csv_options
+        { write_headers: true, force_quotes: true }
+      end
+    end
+  end
+end

data/lib/rspec_overview/output/table.rb

@@ -0,0 +1,16 @@
+require "terminal-table"
+
+module RspecOverview
+  module Output
+    class Table
+      def generate(output:, title:, headings:, rows:)
+        output.puts "\n"
+        output.puts Terminal::Table.new(
+          title: title,
+          headings: headings,
+          rows: rows,
+        )
+      end
+    end
+  end
+end

data/lib/rspec_overview/result.rb

@@ -0,0 +1,28 @@
+class Result
+  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_seconds
+    format_seconds(duration_raw / example_count)
+  end
+
+  def duration_seconds
+    format_seconds(duration_raw)
+  end
+
+  def to_a
+    [identifier, example_count, duration_seconds, avg_duration_seconds]
+  end
+
+  private
+
+  def format_seconds(duration)
+    RSpec::Core::Formatters::Helpers.format_seconds(duration)
+  end
+end

data/lib/rspec_overview/version.rb

@@ -1,3 +1,3 @@
 module RspecOverview
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_overview
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Oli Peate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-28 00:00:00.000000000 Z
+date: 2018-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -105,6 +105,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -114,7 +115,10 @@ files:
 - bin/setup
 - lib/rspec_overview.rb
 - lib/rspec_overview/formatter.rb
-- lib/rspec_overview/result_row.rb
+- lib/rspec_overview/formatter_csv.rb
+- lib/rspec_overview/output/csv.rb
+- lib/rspec_overview/output/table.rb
+- lib/rspec_overview/result.rb
 - lib/rspec_overview/version.rb
 - rspec_overview.gemspec
 homepage: https://github.com/odlp/rspec_overview

data/lib/rspec_overview/result_row.rb

@@ -1,14 +0,0 @@
-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