rails-response-dumper 5.2.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06cd448e735f58a98621946c8469f104ed6d732a12d7434e5e35a702b95f30f0
-  data.tar.gz: e77dcfbeca89d6f0379a4e52e31fea8bd6229eb83546dabff2af014810c7be34
+  metadata.gz: 788b942da1a65cd0b19a82d33f23bba37cb4a260319f37f17c558f71d33e44b8
+  data.tar.gz: af367f3c8103532b4ab7f9ccfb9942b458a0b48c8a31d5cec3ce79c4a6515c5a
 SHA512:
-  metadata.gz: fb2761d033cb2ddf080f79417139b6515e5586e41511e0c030dd346577f7df41bb80281cfc837683f9cdf2c5f24ac4c4fa30b818ce3d5e83dc9fae2ae057d350
-  data.tar.gz: 3534eb64a93627900862d6bd9d58b878b865b7d384b42b56f140301840aa72134d120c66a84c6a7d355a5d831bc9471a3c99eabea086681a4bee49e176f3ffff
+  metadata.gz: 3558c86a4f92d736449a14b5a24074759c686eb98b0ef57386412d45a081c4a184470b2dec61f527e2cb5fa34e9163fb6a0cbc72e2b043b4f05c19d0b328de06
+  data.tar.gz: 5998a7c43305baa14faaa4e6591aa3cc1b6fea49c4f567ad3551694011d9c6592b2a35457915790f38a5bb245a78e61f44808a38d832dcb6378986856ef38db3

data/lib/rails_response_dumper/option_parser.rb

@@ -4,14 +4,42 @@ require 'optparse'
 
 module RailsResponseDumper
   def self.parse_options!
-    options = {}
+    options = { 'dumps-dir' => Rails.root.join('dumps') }
 
     OptionParser.new do |opts|
+      opts.banner += ' [glob]'
+
+      opts.separator ''
+      opts.separator 'Filtering:'
+      opts.separator 'Run for specific files or globs:'
+      opts.separator '  rails-response-dumper path/to/a_dumper.rb'
+
+      opts.separator ''
+      opts.separator 'Options:'
+
+      opts.on('--dumps-dir PATH', 'Output dumps to this directory.') do |v|
+        options['dumps-dir'] = v
+      end
+
       opts.on('--fail-fast', 'Abort the run after first failure.') do |v|
         options[:fail_fast] = v
       end
+
+      opts.on('--verbose', 'Output dumper and dump block names.') do |v|
+        options[:verbose] = v
+      end
+
+      opts.on('--order TYPE', 'Run dumps by the specified order type.') do |v|
+        options[:order] = v
+      end
+
+      opts.on('--exclude-response-headers', 'Do not output response headers.') do |v|
+        options[:exclude_response_headers] = v
+      end
     end.parse!
 
+    options[:filenames] = ARGV
+
     options.freeze
   end
 end

data/lib/rails_response_dumper/runner.rb

@@ -12,16 +12,53 @@ module RailsResponseDumper
     end
 
     def run_dumps
-      dumps_dir = Rails.root.join('dumps')
-      FileUtils.rm_rf dumps_dir
+      dumps_dir = options['dumps-dir']
+
+      if options[:filenames].present?
+        globs = options[:filenames]
+      else
+        globs = ['dumpers/**/*.rb']
+        FileUtils.rm_rf dumps_dir
+      end
+
       FileUtils.mkdir_p dumps_dir
 
-      Dir[Rails.root.join('dumpers/**/*.rb')].each { |f| require f }
+      globs.each do |glob|
+        Dir[Rails.root.join(glob)].each { |f| require f }
+      end
 
       errors = []
 
-      RailsResponseDumper::Defined.dumpers.each do |defined|
-        defined.blocks.each do |dump_block|
+      dumper_blocks = RailsResponseDumper::Defined.dumpers.flat_map do |defined|
+        if options[:filenames].present?
+          # clear previous dumps for that file in case removed from updated dump file
+          FileUtils.rm_rf "#{dumps_dir}/#{defined.name.underscore}/"
+        end
+
+        defined.blocks.map do |dump_block|
+          [defined, dump_block]
+        end
+      end
+
+      if options[:order].present?
+        seed = if options[:order] == 'random'
+                 Random.new_seed
+               else
+                 Integer(options[:order])
+               end
+
+        puts "Randomized with seed #{seed}"
+
+        random = Random.new(seed)
+        dumper_blocks.shuffle!(random: random)
+      end
+
+      catch :fail_fast do
+        dumper_blocks.each do |(defined, dump_block)|
+          name = "#{defined.name}.#{dump_block.name}"
+
+          print "#{name} " if options[:verbose]
+
           defined.reset_models!
           dumper = defined.klass.new
           dumper.mock_setup
@@ -58,6 +95,7 @@ module RailsResponseDumper
             end
 
             request = response.request
+
             dump = {
               request: {
                 method: request.method,
@@ -66,25 +104,30 @@ module RailsResponseDumper
               },
               response: {
                 status: response.status,
-                status_text: response.status_message,
+                statusText: response.status_message,
                 headers: response.headers,
                 body: response.body
               }
             }
+
+            dump[:response].delete(:headers) if options[:exclude_response_headers]
+
             File.write("#{dumper_dir}/#{index}.json", JSON.pretty_generate(dump))
           end
 
           RailsResponseDumper.print_color('.', :green)
+          print("\n") if options[:verbose]
         rescue StandardError => e
           errors << {
             dumper_location: dump_block.block.source_location.join(':'),
-            name: "#{defined.name}.#{dump_block.name}",
+            name: name,
             exception: e
           }
 
           RailsResponseDumper.print_color('F', :red)
+          print("\n") if options[:verbose]
 
-          break if options[:fail_fast]
+          throw :fail_fast if options[:fail_fast]
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-response-dumper
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Pioneer Valley Books
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails