rspec-activerecord-formatter 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 573d9da6bd2d49e858ad2598ecf931c7b9909cc4d53881ed84d27b9e071310c5
-  data.tar.gz: a4f40473db9a50e226ba87b5512b031a1adacf5694f1872ef1571763e997f212
+  metadata.gz: db1b2dbddfb326ac8143998c1b7cc204d90d84f83ccfabe9f3cc022d435a49d8
+  data.tar.gz: 7f29a63684b8e1ce6614e99cbf6ad978739f2f08357d14abc7a4209f2fd866ea
 SHA512:
-  metadata.gz: 87e83e43deaad1f964e3cc88264ab51779a0362c789f18a5ea3d33d1116059866f7f3df0c8946f936462215b94a8f4440bafb1f11143bf5a7d5a2f964a62f433
-  data.tar.gz: '068fbce81ae37fe58c1e0d97d61f4024cab3cd233618f870d8e4b842d25291810872504dc53c21e702379a92a4aca472dde66fbdb7869a7d57a6ef1524dac255'
+  metadata.gz: 9f7f871268d7ce2c007d1bede488b073e443ee5e93ae6ed9f07ca7e787811b2bd38d373ca5843c34403dc877942c1b7908f83ed9729f6c5010f71801dbced20d
+  data.tar.gz: 5dc551ee718ce1fdd0e5ce8997f105750b2295d2e7a9b14e399acce10ee5a17be8a07b76bd51c8d21c30b8c2278337b224cb0d8dda5916977f8082040e72a07a

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 Gemfile.lock
 coverage
+*.gem

data/lib/rspec/activerecord/formatter.rb

@@ -4,7 +4,8 @@ class ActiveRecordFormatter < ::RSpec::Core::Formatters::DocumentationFormatter
   attr_reader :collector, :colorizer, :configuration
 
   ::RSpec::Core::Formatters.register self, :start, :dump_summary,
-                                           :example_started, :example_passed, :example_failed
+                                           :example_started, :example_group_started,
+                                           :example_group_finished
 
   def initialize(output)
     super
@@ -17,8 +18,18 @@ class ActiveRecordFormatter < ::RSpec::Core::Formatters::DocumentationFormatter
     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
+    collector.reset_example(example)
   end
 
   def dump_summary(summary)
@@ -35,15 +46,25 @@ class ActiveRecordFormatter < ::RSpec::Core::Formatters::DocumentationFormatter
   end
 
   def write_profile_summary
-    output_report_filename = Time.now.strftime("rspec_activerecord_result_%Y_%m_%d_%H_%m_%S.txt")
-    output_report_path = Rails.root.join("tmp", output_report_filename)
+    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)
 
-    puts "\nOutputting Detailed Profile Data to #{output_report_path}"
+    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\n"
-      f.puts "Query Summary"
-      collector.most_common_query_names.each do |name, count|
-        f.puts "%-4s %s" % [count, name]
+      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

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

@@ -2,7 +2,9 @@ require 'active_support/notifications'
 
 module ActiveRecordFormatterHelpers
   class Collector
-    attr_reader :query_count, :objects_count, :total_queries, :total_objects, :query_names
+    attr_reader :query_count, :objects_count, :total_queries, :total_objects,
+                :query_names, :active_groups, :group_counts
+
     SKIP_QUERIES = ["SELECT tablename FROM pg_tables", "select sum(ct) from (select count(*) ct from"]
 
     def initialize
@@ -11,6 +13,8 @@ module ActiveRecordFormatterHelpers
       @total_queries  = 0
       @total_objects  = 0
       @query_names    = Hash.new(0)
+      @group_counts   = Hash.new(0)
+      @active_groups  = []
 
       ActiveSupport::Notifications.subscribe("sql.active_record", method(:record_query))
     end
@@ -18,29 +22,60 @@ module ActiveRecordFormatterHelpers
     def record_query(*_unused, data)
       return if SKIP_QUERIES.any? { |q| data[:sql].index(q) == 0 }
 
-      @query_count    += 1
-      @total_queries  += 1
-
-      if query_is_an_insert?(data[:sql])
-        @objects_count  += 1
-        @total_objects  += 1
-      end
-
-      name = data[:name] || "Unnamed"
-      @query_names[name] += 1
+      inc_query
+      inc_object if query_is_an_insert?(data[:sql])
+      inc_query_name(data)
     end
 
     def most_common_query_names
-      @query_names.sort_by(&:last).reverse
+      query_names.sort_by(&:last).reverse
     end
 
-    def reset_example
+    def most_expensive_groups
+      group_counts.sort_by(&:last).reverse
+    end
+
+    def reset_example(_)
       @query_count   = 0
       @objects_count = 0
     end
 
+    def group_started(group)
+      return unless group.parent_groups.length > 1
+
+      active_groups.push(group_path(group))
+    end
+
+    def group_finished(group)
+      active_groups.delete(group_path(group))
+    end
+
     protected
 
+    def inc_object
+      @objects_count  += 1
+      @total_objects  += 1
+
+      active_groups.each do |group|
+        @group_counts[group] += 1
+      end
+    end
+
+    def inc_query
+      @query_count    += 1
+      @total_queries  += 1
+    end
+
+    def inc_query_name(data)
+      name = data[:name] || "Unnamed"
+
+      query_names[name] += 1
+    end
+
+    def group_path(group)
+      group.parent_groups.reverse.map(&:description).join(' ')
+    end
+
     # TODO: what happens if we try to create many records at once?
     # TODO: are there any false positives we need to worry about? false negatives?
     def query_is_an_insert?(query)

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.1.0"
+  gem.version = "1.2.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-activerecord-formatter
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Joseph Mastey