rspec-activerecord-formatter 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '08dd87f7aa390ba4918b877798c35de853c02243'
-  data.tar.gz: f4e7986bc385496bdc26213995fb109765be26fd
+SHA256:
+  metadata.gz: 796768aef6b284e761135f02bf4fde2991c6542905abd5084fc77e3fb8005f2b
+  data.tar.gz: 459eab6e0f667b0c683d465a335d9f6f21ee3976d75440fc1c53a4c75c04e0f0
 SHA512:
-  metadata.gz: 740c19e2671ea78b0460fd83a3f1c08ef4c40fa120bf495fff54bd7970a5bca3c9144e128542b54e6c1606dbbc8ac52b153d6d00b37618a479d0881e8acd1264
-  data.tar.gz: b2e55d67fc0b296e847f75c20ec6a6352f871322ccb0403c9f56ccbd0a2b4ad23db44b99f7c87f6b041b03c4e9a7caf19165d9ac8742bd911292d91719247c82
+  metadata.gz: fe56977ad258d136496454cdca232bb1516dd8e265fd6b5e3239ca6bba9b34286b3785a47e4bb8e42272cf1ed9fc69d4bc760b44c3e28ec0a8daeef16086e3ba
+  data.tar.gz: bd6ed8ff7fa849d319d2e1bccfd9893fa7f6e647c71224279242849788bdaef46e1567ae002cbe43a468d7292cd11338d2713422b22fd9550d4e407b7441bc8b

data/README.md

@@ -27,14 +27,14 @@ The current answer is to change your `.rspec` initializer to include the followi
 
     --require rspec-activerecord-formatter
     --require rails_helper
-    --format ActiveRecordFormatter
+    --format ActiveRecordDocumentationFormatter
 
 We have to include the rails_helper so that ActiveRecord is loaded prior to trying to load the
 formatter. That way, we can hook into AR creations.
 
 You can also run the formatter as a one-off option to rspec:
 
-    rspec path/to/example_spec.rb --require rspec-activerecord-formatter --require rails_helper --format ActiveRecordFormatter
+    rspec path/to/example_spec.rb --require rspec-activerecord-formatter --require rails_helper --format ActiveRecordDocumentationFormatter
 
 Once you set the formatter, you should now see the number of objects created and total queries
 for each of your tests:
@@ -45,12 +45,17 @@ You'll also get a summary at the end of your test run:
 
 ![Test summary.](https://github.com/jmmastey/rspec-activerecord-formatter/raw/master/doc/images/demo_1.png "Test summary.")
 
+If you want less granularity, you can also use the progress formatter:
+
+    --require rspec-activerecord-formatter
+    --require rails_helper
+    --format ActiveRecordProgressFormatter
+
 Next Steps
 ------------
 * The method I was using to count AR objects doesn't work well with DatabaseCleaner when not explicitly wiring the library into `before` blocks.
   I'd like to be able to go back to a method other than scanning for `INSERT INTO` strings.
 * Configuration, especially formatting the output to optionally outdent the counts.
-* Add a `--profile`-like behavior to output the most offending tests.
 * The current dependency versions are a vague guess. They can and should clearly be more lenient.
 * I dunno, tests.
 

data/lib/rspec-activerecord-formatter.rb

@@ -1 +1,6 @@
+require "rspec/activerecord/helpers/collector"
+require "rspec/activerecord/helpers/report"
+require 'rspec/activerecord/base'
+require 'rspec/activerecord/progress_formatter'
+require 'rspec/activerecord/documentation_formatter'
 require 'rspec/activerecord/formatter'

data/lib/rspec/activerecord/base.rb

@@ -0,0 +1,43 @@
+class ActiveRecordFormatterBase
+  attr_reader :colorizer, :summary, :collector
+
+  def initialize(summary, collector)
+    @colorizer  = ::RSpec::Core::Formatters::ConsoleCodes
+    @summary    = summary
+    @collector  = collector
+  end
+
+  def colorized_summary
+    formatted = "\nFinished in #{summary.formatted_duration} " \
+      "(files took #{summary.formatted_load_time} to load)\n" \
+      "#{colorized_expanded_totals}\n"
+
+    unless summary.failed_examples.empty?
+      formatted << summary.colorized_rerun_commands(colorizer) << "\n"
+    end
+
+    formatted
+  end
+
+  private
+
+  def colorized_expanded_totals
+    if summary.failure_count > 0
+      colorizer.wrap(expanded_totals_line, RSpec.configuration.failure_color)
+    elsif summary.pending_count > 0
+      colorizer.wrap(expanded_totals_line, RSpec.configuration.pending_color)
+    else
+      colorizer.wrap(expanded_totals_line, RSpec.configuration.success_color)
+    end
+  end
+
+  def expanded_totals_line
+    summary_text = ::RSpec::Core::Formatters::Helpers.pluralize(summary.example_count, "example")
+    summary_text << ", " << ::RSpec::Core::Formatters::Helpers.pluralize(summary.failure_count, "failure")
+    summary_text << ", #{summary.pending_count} pending" if summary.pending_count > 0
+    summary_text << ", #{collector.total_objects} AR objects"
+    summary_text << ", #{collector.total_queries} AR queries"
+
+    summary_text
+  end
+end

data/lib/rspec/activerecord/documentation_formatter.rb

@@ -0,0 +1,58 @@
+class ActiveRecordDocumentationFormatter < ::RSpec::Core::Formatters::DocumentationFormatter
+  attr_reader :collector, :colorizer, :report
+
+  ::RSpec::Core::Formatters.register self, :start, :dump_summary,
+                                           :example_started, :example_group_started,
+                                           :example_group_finished
+
+  def initialize(output)
+    super
+
+    @colorizer  = ::RSpec::Core::Formatters::ConsoleCodes
+    @collector  = ActiveRecordFormatterHelpers::Collector.new
+    @report     = ActiveRecordFormatterHelpers::Report.new(collector)
+  end
+
+  def start(_start_notification)
+    output.puts "Recording and reporting ActiveRecord select and creation counts."
+    super
+  end
+
+  def example_group_started(example_group)
+    collector.group_started(example_group.group)
+    super
+  end
+
+  def example_group_finished(example_group)
+    collector.group_finished(example_group.group)
+    super
+  end
+
+  def example_started(example)
+    collector.reset_example(example)
+  end
+
+  def dump_summary(summary)
+    base = ActiveRecordFormatterBase.new(summary, collector)
+    output.puts base.colorized_summary
+
+    output.puts "\nOutputting Detailed Profile Data to #{report.report_path}"
+    report.write
+  end
+
+  protected
+
+  def passed_output(example)
+    "#{current_indentation}#{example_counts}" +
+      colorizer.wrap(example.description.strip, :success)
+  end
+
+  def failure_output(example)
+    "#{current_indentation}#{example_counts}" +
+      colorizer.wrap("#{example.description.strip} (FAILED - #{next_failure_index})", :failure)
+  end
+
+  def example_counts(suffix: " ")
+    "(%02d, %02d)#{suffix}" % [collector.objects_count, collector.query_count]
+  end
+end

data/lib/rspec/activerecord/formatter.rb

@@ -1,107 +1 @@
-require_relative "helpers/collector"
-
-class ActiveRecordFormatter < ::RSpec::Core::Formatters::DocumentationFormatter
-  attr_reader :collector, :colorizer, :configuration
-
-  ::RSpec::Core::Formatters.register self, :start, :dump_summary,
-                                           :example_started, :example_group_started,
-                                           :example_group_finished
-
-  def initialize(output)
-    super
-
-    @colorizer      = ::RSpec::Core::Formatters::ConsoleCodes
-    @collector      = ActiveRecordFormatterHelpers::Collector.new
-  end
-
-  def start(start_notification)
-    output.puts "Recording and reporting ActiveRecord select and creation counts."
-  end
-
-  def example_group_started(example_group)
-    collector.group_started(example_group.group)
-    super
-  end
-
-  def example_group_finished(example_group)
-    collector.group_finished(example_group.group)
-    super
-  end
-
-  def example_started(example)
-    collector.reset_example(example)
-  end
-
-  def dump_summary(summary)
-    formatted = "\nFinished in #{summary.formatted_duration} " \
-      "(files took #{summary.formatted_load_time} to load)\n" \
-      "#{colorized_expanded_totals(summary)}\n"
-
-    unless summary.failed_examples.empty?
-      formatted << summary.colorized_rerun_commands(colorizer) << "\n"
-    end
-
-    output.puts formatted
-    write_profile_summary
-  end
-
-  def write_profile_summary
-    output_report_filename = Time.now.strftime("ar_%Y_%m_%d_%H_%m_%S.txt")
-    report_dir = Rails.root.join("tmp", "profile")
-    output_report_path = report_dir.join(output_report_filename)
-
-    output.puts "\nOutputting Detailed Profile Data to #{output_report_path}"
-    Dir.mkdir(report_dir) unless File.exists?(report_dir)
-    File.open(output_report_path, "wb") do |f|
-      f.puts "#{collector.total_objects} AR objects, #{collector.total_queries} AR queries"
-
-      f.puts ""
-      f.puts "Worst Example Groups by Object Creation"
-      collector.most_expensive_groups.first(50).each do |name, count|
-        f.puts "%-5s %s" % [count, name]
-      end
-
-      f.puts ""
-      f.puts "Most Common Queries"
-      collector.most_common_query_names.first(50).each do |name, count|
-        f.puts "%-5s %s" % [count, name]
-      end
-    end
-  end
-
-  protected
-
-  def passed_output(example)
-    "#{current_indentation}#{example_counts}" +
-      colorizer.wrap(example.description.strip, :success)
-  end
-
-  def failure_output(example)
-    "#{current_indentation}#{example_counts}" +
-      colorizer.wrap("#{example.description.strip} (FAILED - #{next_failure_index})", :failure)
-  end
-
-  def example_counts(suffix: " ")
-    "(%02d, %02d)#{suffix}" % [collector.objects_count, collector.query_count]
-  end
-
-  def colorized_expanded_totals(summary)
-    if summary.failure_count > 0
-      colorizer.wrap(expanded_totals_line(summary), RSpec.configuration.failure_color)
-    elsif summary.pending_count > 0
-      colorizer.wrap(expanded_totals_line(summary), RSpec.configuration.pending_color)
-    else
-      colorizer.wrap(expanded_totals_line(summary), RSpec.configuration.success_color)
-    end
-  end
-
-  def expanded_totals_line(summary)
-    summary_text = ::RSpec::Core::Formatters::Helpers.pluralize(summary.example_count, "example")
-    summary_text << ", " << ::RSpec::Core::Formatters::Helpers.pluralize(summary.failure_count, "failure")
-    summary_text << ", #{summary.pending_count} pending" if summary.pending_count > 0
-    summary_text << ", #{collector.total_objects} AR objects"
-    summary_text << ", #{collector.total_queries} AR queries"
-
-    summary_text
-  end
-end
+ActiveRecordFormatter = ActiveRecordDocumentationFormatter

data/lib/rspec/activerecord/helpers/report.rb

@@ -0,0 +1,44 @@
+module ActiveRecordFormatterHelpers
+  class Report
+    attr_reader :report_path, :default_path, :report_dir, :collector
+
+    def initialize(collector)
+      @collector = collector
+
+      @report_dir   = Rails.root.join("tmp", "profile")
+      @report_path  = report_dir.join(timestamped_filename)
+      @default_path = report_dir.join('ar_most_recent.txt')
+    end
+
+    def write
+      write_file(file_path: report_path)
+      write_file(file_path: default_path)
+    end
+
+    private
+
+    def timestamped_filename
+      Time.now.strftime("ar_%Y_%m_%d_%H_%m_%S.txt")
+    end
+
+    def write_file(file_path:)
+      Dir.mkdir(report_dir) unless File.exists?(report_dir)
+
+      File.open(file_path, "wb") do |f|
+        f.puts "#{collector.total_objects} AR objects, #{collector.total_queries} AR queries"
+
+        f.puts ""
+        f.puts "Worst Example Groups by Object Creation"
+        collector.most_expensive_groups.first(50).each do |name, count|
+          f.puts "%-5s %s" % [count, name]
+        end
+
+        f.puts ""
+        f.puts "Most Common Queries"
+        collector.most_common_query_names.first(50).each do |name, count|
+          f.puts "%-5s %s" % [count, name]
+        end
+      end
+    end
+  end
+end

data/lib/rspec/activerecord/progress_formatter.rb

@@ -0,0 +1,44 @@
+require_relative "helpers/collector"
+require_relative "helpers/report"
+
+class ActiveRecordProgressFormatter < ::RSpec::Core::Formatters::ProgressFormatter
+  attr_reader :collector, :colorizer, :report
+
+  ::RSpec::Core::Formatters.register self, :start, :dump_summary,
+                                           :example_started, :example_group_started,
+                                           :example_group_finished
+
+  def initialize(output)
+    super
+
+    @colorizer  = ::RSpec::Core::Formatters::ConsoleCodes
+    @collector  = ActiveRecordFormatterHelpers::Collector.new
+    @report     = ActiveRecordFormatterHelpers::Report.new(collector)
+  end
+
+  def start(_start_notification)
+    output.puts "Recording and reporting ActiveRecord select and creation counts."
+    super
+  end
+
+  def example_group_started(example_group)
+    collector.group_started(example_group.group)
+    super
+  end
+
+  def example_group_finished(example_group)
+    collector.group_finished(example_group.group)
+  end
+
+  def example_started(example)
+    collector.reset_example(example)
+  end
+
+  def dump_summary(summary)
+    base = ActiveRecordFormatterBase.new(summary, collector)
+    output.puts base.colorized_summary
+
+    output.puts "\nOutputting Detailed Profile Data to #{report.report_path}"
+    report.write
+  end
+end

data/rspec-activerecord-formatter.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 Gem::Specification.new do |gem|
 
   gem.name    = "rspec-activerecord-formatter"
-  gem.version = "1.3.0"
+  gem.version = "2.0.0"
 
   gem.summary     = "Adds object creations and queries to Rspec output."
   gem.description = "Creates a new formatter for ActiveRecord that can help you diagnose performance issues in RSpec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-activerecord-formatter
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Joseph Mastey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2019-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,8 +72,12 @@ files:
 - doc/images/demo_1.png
 - doc/images/demo_2.png
 - lib/rspec-activerecord-formatter.rb
+- lib/rspec/activerecord/base.rb
+- lib/rspec/activerecord/documentation_formatter.rb
 - lib/rspec/activerecord/formatter.rb
 - lib/rspec/activerecord/helpers/collector.rb
+- lib/rspec/activerecord/helpers/report.rb
+- lib/rspec/activerecord/progress_formatter.rb
 - rspec-activerecord-formatter.gemspec
 - spec/collector_spec.rb
 - spec/formatter_spec.rb
@@ -98,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Adds object creations and queries to Rspec output.