rails-response-dumper 6.1.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59962fdb92a1c349f0261e238a2ed342980353b2a3f51c0f61ec13cae47b42dd
-  data.tar.gz: 1fbc0d60ce41ed61c956f57d4a473eaa74f88cfe2d66f0198897a8565bb8fd81
+  metadata.gz: b8c34317cf334351116255b3598e642eae81b92ff4495a0d4bbaa0c1fe93e6df
+  data.tar.gz: 9a4c62261212c2d78aa2fe9d4ccc8512712b78b3331c6e14566a395ac787162a
 SHA512:
-  metadata.gz: 8118f205179b4d16c035ecbe371e35f2eba95befe8196d493ad9c7a7461fcd83e241fcfb1b55cc79ac11458e8c7db59dd72203a3703f56776b6371fea5428944
-  data.tar.gz: fe1aed1e3e48342a9665f16254695ebef5acd64213b43e2afcb222455c7c83e08435a13fc26957a49c520f9b1c4bf22df0251e0325e40e5555002b7245711387
+  metadata.gz: f9fcdde55d4e5d59a6949a9530c03db0b41df112bdc8e5b01ca1b55b665d077605910bb0ea23fa41da48c8aa185e6ff78d3f561233ed5cbb064b59af7c51d668
+  data.tar.gz: 3359004f505f4c2f5ba83d993a94f707ff7ac482e35b7ef65d97e0e6d85a491ef9b37908cbc5356e5273aff14a4e40bb5f7f58c5f03d85eb390a9d4d7ce252cc

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
@@ -36,6 +40,10 @@ module RailsResponseDumper
       opts.on('--exclude-response-headers', 'Do not output response headers.') do |v|
         options[:exclude_response_headers] = v
       end
+
+      opts.on('--exclude-timestamp', 'Do not output a timestamp with each dump.') do |v|
+        options[:exclude_timestamp] = v
+      end
     end.parse!
 
     options[:filenames] = ARGV

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
@@ -86,7 +90,7 @@ module RailsResponseDumper
           dumper_dir = "#{dumps_dir}/#{klass_path}/#{dump_block.name}"
           FileUtils.mkdir_p dumper_dir
 
-          dumper.responses.each_with_index do |response, index|
+          dumper.responses.each_with_index do |(response, timestamp), index|
             unless response.status == dump_block.expected_status_codes[index]
               raise <<~ERROR.squish
                 unexpected status code #{response.status} #{response.status_message}
@@ -99,20 +103,22 @@ module RailsResponseDumper
             dump = {
               request: {
                 method: request.method,
-                url: request.url,
-                body: request.body.string
+                url: request.url
               },
               response: {
                 status: response.status,
                 statusText: response.status_message,
-                headers: response.headers,
-                body: response.body
+                headers: response.headers
               }
             }
 
             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)
@@ -132,21 +138,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

data/lib/response_dumper.rb

@@ -35,7 +35,7 @@ class ResponseDumper
     module_eval <<~RUBY, __FILE__, __LINE__ + 1
       def #{method}(...)
         result = super
-        self.responses << response
+        self.responses << [response, Time.zone.now]
         result
       end
     RUBY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-response-dumper
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Pioneer Valley Books
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2024-02-29 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.4.10
-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: []