rails-response-dumper 6.2.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73dcaa40fd7df83e967942ad22721fc066a08f624b694363edfffbd191765bbc
-  data.tar.gz: dc938ffbf89617b146af39061fcebe5a85d0d428f24947b1d652ded64e99fbcb
+  metadata.gz: 0440c636303c8b08698e78f7e8de3dbc5815aa0112f1af94195c233c072a8115
+  data.tar.gz: 2f71c8824b9c3ec3324ad3df89ff7b7d1d57df1614161ee2cb4d7159ae9466bc
 SHA512:
-  metadata.gz: c78f1ae041fc130039eee769bb00f1e936fc257458fc156ecbeca7b2ec4db8e2e7c25effbbd3c8476486f913be722087005b7ea6b959355041caefe9e4a482c7
-  data.tar.gz: 6ba7ea3b302bea3a5d8bca08e0d1d2b62f065b73a238a7f21f4044dbcb1ce40ba2b92fcc1cc8fd06f8cb5e5fa2a503cd242d050227668927827c215d85b109ef
+  metadata.gz: 1cd987f5bc5274530b1ae896bb1917b21dcd1804858cf7f243df285b605b67f936c8614747873d5a2c5c719e2da79a9189ecef0b628cd08ecbbedeb391d4a479
+  data.tar.gz: 424fb1aede5523cd47a17ceaca8b254c9ccef0413f8a32c44cbd6b1f73bdfcd755814e67c50a88d28a5d2242981f1c0322aba57f54480acad694cc1a791d87f4

data/lib/rails_response_dumper/option_parser.rb

@@ -29,6 +29,10 @@ module RailsResponseDumper
         options[:verbose] = v
       end
 
+      opts.on('--profile', 'Enable profiling of dumps and list the slowest.') do |v|
+        options[:profile] = v
+      end
+
       opts.on('--order TYPE', 'Run dumps by the specified order type.') do |v|
         options[:order] = v
       end

data/lib/rails_response_dumper/runner.rb

@@ -17,7 +17,7 @@ module RailsResponseDumper
       if options[:filenames].present?
         globs = options[:filenames]
       else
-        globs = ['dumpers/**/*.rb']
+        globs = ['dumpers/**/*_dumper.rb']
         FileUtils.rm_rf dumps_dir
       end
 
@@ -53,6 +53,8 @@ module RailsResponseDumper
         dumper_blocks.shuffle!(random: random)
       end
 
+      profile = {}
+
       catch :fail_fast do
         dumper_blocks.each do |(defined, dump_block)|
           name = "#{defined.name}.#{dump_block.name}"
@@ -64,12 +66,14 @@ module RailsResponseDumper
           dumper.mock_setup
           begin
             rollback_after do
+              t0 = Time.now
               dumper.instance_eval(&defined.before_block) if defined.before_block
               begin
                 dumper.instance_eval(&dump_block.block)
               ensure
                 dumper.instance_eval(&defined.after_block) if defined.after_block
               end
+              profile[name] = Time.now - t0
             end
           ensure
             dumper.mock_teardown
@@ -98,23 +102,29 @@ module RailsResponseDumper
 
             dump = {
               request: {
-                method: request.method,
                 url: request.url,
-                body: request.body.string
+                env: request.headers.to_h
               },
               response: {
                 status: response.status,
                 statusText: response.status_message,
-                headers: response.headers,
-                body: response.body
+                headers: response.headers
               }
             }
 
+            # request.headers includes nonstandard internal data, some of which also lacks default deterministic
+            # serialization. Here we only want CGI standard and HTTP variables.
+            dump[:request][:env].filter! do |key|
+              key.in?(ActionDispatch::Http::Headers::CGI_VARIABLES) || key.start_with?('HTTP_')
+            end
+
             dump[:response].delete(:headers) if options[:exclude_response_headers]
 
             dump[:timestamp] = timestamp.iso8601 unless options[:exclude_timestamp]
 
             File.write("#{dumper_dir}/#{index}.json", JSON.pretty_generate(dump))
+            File.write("#{dumper_dir}/#{index}.request_body", request.body.string, mode: 'wb')
+            File.write("#{dumper_dir}/#{index}.response_body", response.body, mode: 'wb')
           end
 
           RailsResponseDumper.print_color('.', :green)
@@ -134,21 +144,36 @@ module RailsResponseDumper
       end
 
       puts
-      return if errors.blank?
 
-      puts
-      errors.each do |error|
-        RailsResponseDumper.print_color(
-          "#{error[:dumper_location]} #{error[:name]} received #{error[:exception]}\n",
-          :red
-        )
-        error[:exception].full_message(highlight: RailsResponseDumper::COLORIZE).lines do |line|
-          RailsResponseDumper.print_color(line, :cyan)
+      unless errors.blank?
+        puts
+
+        errors.each do |error|
+          RailsResponseDumper.print_color(
+            "#{error[:dumper_location]} #{error[:name]} received #{error[:exception]}\n",
+            :red
+          )
+          error[:exception].full_message(highlight: RailsResponseDumper::COLORIZE).lines do |line|
+            RailsResponseDumper.print_color(line, :cyan)
+          end
+          puts
         end
+      end
+
+      if options.include?(:profile)
+        puts
+
+        # Sort in descending order to obtain the 10 slowest dumps.
+        timings = profile.to_a.sort_by { |(_key, value)| -value }
+        timings.first(10).each do |(dump, time)|
+          formatted_time = format('%.2f', time)
+          puts "#{dump} #{formatted_time} s"
+        end
+
         puts
       end
 
-      exit(false)
+      exit(errors.blank?)
     end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-response-dumper
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Pioneer Valley Books
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,7 +48,7 @@ description: |
   Rails Response Dumper is a library and command line tool to dump HTTP
   responses from a Rails application to the file system. These responses can
   then be consumed by other tools for testing and verification purposes.
-email: 
+email:
 executables:
 - rails-response-dumper
 extensions: []
@@ -67,7 +67,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Dump HTTP responses from a Rails application to the file system
 test_files: []