refactor formatters to delegate profiling to the profiler

Author: JonRowe

lib/rspec/core/formatters/json_formatter.rb

@@ -6,36 +6,17 @@ module Core
     module Formatters
       # @private
       class JsonFormatter < BaseFormatter
-        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :close,
-                            :example_group_started, :example_group_finished,
-                            :example_started
+        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :close
 
         attr_reader :output_hash
 
         def initialize(output)
           super
-          @example_groups= {} #todo rename, maybe example_groups_data ...
           @output_hash = {
             :version => RSpec::Core::Version::STRING
           }
         end
 
-        #todo remove duplication with lib/rspec/core/formatters/profile_formatter.rb line 16
-        def example_group_started(notification)
-          @example_groups[notification.group.id] = Hash.new(0)
-          @example_groups[notification.group.id][:start] = Time.now
-          @example_groups[notification.group.id][:description] = notification.group.top_level_description
-        end
-
-        def example_group_finished(notification)
-          @example_groups[notification.group.id][:total_time] =  Time.now - @example_groups[notification.group.id][:start]
-        end
-
-        def example_started(notification)
-          group = notification.example.example_group.parent_groups.last.id
-          @example_groups[group][:count] += 1
-        end
-
         def message(notification)
           (@output_hash[:messages] ||= []) << notification.message
         end
@@ -91,9 +72,8 @@ def dump_profile_slowest_examples(profile)
 
         # @api private
         def dump_profile_slowest_example_groups(profile)
-          slowest_groups = profile.calculate_slowest_groups(@example_groups)
           @output_hash[:profile] ||= {}
-          @output_hash[:profile][:groups] = slowest_groups.map do |loc, hash|
+          @output_hash[:profile][:groups] = profile.slowest_groups.map do |loc, hash|
             hash.update(:location => loc)
           end
         end

lib/rspec/core/formatters/profile_formatter.rb

@@ -6,36 +6,15 @@ module Formatters
       # @api private
       # Formatter for providing profile output.
       class ProfileFormatter
-        Formatters.register self, :dump_profile, :example_group_started, :example_group_finished, :example_started
+        Formatters.register self, :dump_profile
 
         def initialize(output)
-          @example_groups = {} #todo rename, maybe groups_data, groups_information or profile_information
           @output = output
         end
 
         # @private
         attr_reader :output
 
-        # @private
-        def example_group_started(notification)
-          @example_groups[notification.group.id] = Hash.new(0)
-          @example_groups[notification.group.id][:start] = Time.now
-          @example_groups[notification.group.id][:description] = notification.group.top_level_description
-        end
-
-        # @private
-        def example_group_finished(notification)
-          @example_groups[notification.group.id][:total_time] =  Time.now - @example_groups[notification.group.id][:start]
-        end
-
-        # @private
-        def example_started(notification)
-          #todo: maybe move example_group.parent_groups.last to an example or notification method like example.last_anscestor_group
-          group = notification.example.example_group.parent_groups.last.id
-          @example_groups[group][:count] += 1
-        end
-
-
         # @api public
         #
         # This method is invoked after the dumping the summary if profiling is
@@ -63,11 +42,10 @@ def dump_profile_slowest_examples(profile)
         end
 
         def dump_profile_slowest_example_groups(profile)
-          slowest_groups = profile.calculate_slowest_groups(@example_groups)
-          return if slowest_groups.empty?
+          return if profile.slowest_groups.empty?
 
-          @output.puts "\nTop #{slowest_groups.size} slowest example groups:"
-          slowest_groups.each do |loc, hash|
+          @output.puts "\nTop #{profile.slowest_groups.size} slowest example groups:"
+          profile.slowest_groups.each do |loc, hash|
             average = "#{bold(Helpers.format_seconds(hash[:average]))} #{bold("seconds")} average"
             total   = "#{Helpers.format_seconds(hash[:total_time])} seconds"
             count   = Helpers.pluralize(hash[:count], "example")

spec/rspec/core/formatters/json_formatter_spec.rb

@@ -186,9 +186,7 @@ def profile *groups
         expect(formatter.output_hash[:profile][:groups].first.keys).to match_array([:total_time, :count, :description, :average, :location, :start])
       end
 
-      #todo the group profiling dont use the example clock anymore
-      #I need to adapt this test
-      xit "ranks the example groups by average time" do
+      it "ranks the example groups by average time" do
         expect(formatter.output_hash[:profile][:groups].first[:description]).to eq("slow group")
       end
     end