rails-response-dumper 2.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d60e4df92e8fd8339624f1fa9244ace8b901368b64278579027bf9d824d4185
-  data.tar.gz: 796e5b8b849ea40a02657078a7d324c2846fabdc29c31bf36fee50a362d48395
+  metadata.gz: 22c747acb9c14801e9dcb12be0d5dc1031932f8b5111620b8599903294116b1d
+  data.tar.gz: 5c97ba8bc6bdab090c0b6e93f01fede4638fe3e16f3e52abe9b1c0020bee7c9d
 SHA512:
-  metadata.gz: 12ed413c69767aa0936b88f7e526c2ec419cdc435707390272a370c5f41c3dcbcaa845685c039b8dbe148110044d7aedb9e19916658aab59c2ffb365ec9024f5
-  data.tar.gz: 8afe7bd7ba82df75de81a97576bdebb967fc116c42ddd37c36965d9ad027ac03b998b95994d9483c2a383ba76d96986ab2dffb68ee28ea6b6a970aae460a9650
+  metadata.gz: ae56654d82cd2dae48600ca54fcb4f07a9b2b2e02656f16db68326ed8c01b378b5b7ad2dc82202cdb6cb393d63037144068c12245fe80f02995448015bbd699f
+  data.tar.gz: b2f9e80a7069deec3e36d182bf3c4ed2e45838a3909c5633951e7bb1a728425d72e9533c6d7befe12caca9e84da55326913c2317ea03493f4a18d3901aaa7a7b

data/bin/rails-response-dumper

@@ -1,125 +1,12 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'fileutils'
-require 'mime/types'
-require 'rspec/mocks'
-
 ENV['RAILS_ENV'] ||= 'test'
-require "#{Dir.pwd}/config/environment"
-
-class ResponseDumper
-  include ActionDispatch::Integration::Runner
-  include RSpec::Mocks::ExampleMethods
-
-  attr_reader :expected_status_code
-
-  def self.inherited(subclass)
-    super
-    dumpers << subclass
-  end
-
-  def self.dumpers
-    @dumpers ||= []
-  end
-
-  def self.reset_models(*models)
-    @reset_models ||= []
-    @reset_models += models
-  end
-
-  def self.reset_models!
-    reset_models.each do |model|
-      model.connection.exec_query "TRUNCATE #{model.quoted_table_name} RESTART IDENTITY CASCADE"
-    end
-  end
-
-  # Delegates to `Rails.application`.
-  def app
-    Rails.application
-  end
-
-  def expect_status_code!(status_code)
-    @expected_status_code = Rack::Utils::SYMBOL_TO_STATUS_CODE[status_code]
-  end
-
-  def responses
-    @responses ||= []
-  end
-
-  def mock_setup
-    RSpec::Mocks.setup
-  end
-
-  def mock_teardown
-    RSpec::Mocks.verify
-  ensure
-    RSpec::Mocks.teardown
-  end
-
-  [:get, :post, :patch, :put, :head, :delete].each do |method|
-    module_eval <<~RUBY, __FILE__, __LINE__ + 1
-      def #{method}(...)
-        result = super
-        self.responses << response
-        result
-      end
-    RUBY
-  end
-
-  # The list of methods is too long to be useful so shorten to just the class
-  # name.
-  def inspect
-    "#<#{self.class.name}>"
-  end
-end
-
-def run_dumps
-  dumps_dir = Rails.root.join('dumps')
-  FileUtils.rm_rf dumps_dir
-  FileUtils.mkdir_p dumps_dir
-
-  Dir[Rails.root.join('dumpers/**/*.rb')].each { |f| require f }
-
-  ResponseDumper.dumpers.each do |klass|
-    klass.instance_methods.each do |method|
-      next unless method.start_with?('dump_')
-
-      klass.reset_models!
-
-      dumper = klass.new
-      dumper.mock_setup
-      begin
-        ActiveRecord::Base.transaction do
-          dumper.expect_status_code!(:ok)
-          dumper.send(method)
-          raise ActiveRecord::Rollback
-        end
-      ensure
-        dumper.mock_teardown
-      end
-
-      klass_path = klass.name.underscore
-      dumper_dir = "#{dumps_dir}/#{klass_path}/#{method}"
-      FileUtils.mkdir_p dumper_dir
-
-      dumper.responses.each_with_index do |response, index|
-        unless response.status == dumper.expected_status_code
-          raise <<~ERROR.squish
-            Dumped response has unexpected status code #{response.status} #{response.status_message}
-            (expected #{dumper.expected_status_code})
-          ERROR
-        end
-
-        mime = response.content_type.split(/ *; */).first
-        extension = MIME::Types[mime].first.preferred_extension
-        File.write("#{dumper_dir}/#{index}.#{extension}", response.body)
-      end
-    end
-  end
-end
+require 'rails_response_dumper'
 
 # Prevent database truncation if the environment is production.
 abort 'The Rails environment is running in production mode!' if Rails.env.production?
-ActiveRecord::Migration.maintain_test_schema!
-run_dumps
+ActiveRecord::Migration.maintain_test_schema! if defined?(ActiveRecord::Base)
+
+runner = RailsResponseDumper::Runner.new
+runner.run_dumps

data/lib/rails_response_dumper/defined.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+require_relative 'dump_block'
+
+module RailsResponseDumper
+  class Defined
+    attr_accessor :name, :klass
+
+    delegate :include, to: :klass
+
+    def self.dumpers
+      @dumpers ||= []
+    end
+
+    def initialize(name, &block)
+      self.name = name
+      self.klass = Class.new(ResponseDumper)
+
+      instance_eval(&block)
+
+      self.class.dumpers << self
+    end
+
+    def dump(name, status_codes: [:ok], &block)
+      blocks << DumpBlock.new(
+        name,
+        status_codes.map { |status_code| Rack::Utils::SYMBOL_TO_STATUS_CODE[status_code] },
+        block
+      )
+    end
+
+    def blocks
+      @blocks ||= []
+    end
+
+    def reset_models(*models)
+      @reset_models ||= []
+      @reset_models += models
+    end
+
+    def reset_models!
+      reset_models.each do |model|
+        model.connection.exec_query <<~SQL.squish
+          TRUNCATE #{model.quoted_table_name} RESTART IDENTITY CASCADE
+        SQL
+      end
+    end
+  end
+end

data/lib/rails_response_dumper/dump_block.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsResponseDumper
+  DumpBlock = Struct.new('DumpBlock', :name, :expected_status_codes, :block)
+end

data/lib/rails_response_dumper/runner.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'mime/types'
+require_relative 'defined'
+
+module RailsResponseDumper
+  class Runner
+    def run_dumps
+      dumps_dir = Rails.root.join('dumps')
+      FileUtils.rm_rf dumps_dir
+      FileUtils.mkdir_p dumps_dir
+
+      Dir[Rails.root.join('dumpers/**/*.rb')].each { |f| require f }
+
+      RailsResponseDumper::Defined.dumpers.each do |defined|
+        defined.blocks.each do |dump_block|
+          defined.reset_models!
+
+          dumper = defined.klass.new
+          dumper.mock_setup
+          begin
+            rollback_after do
+              dumper.instance_eval(&dump_block.block)
+            end
+          ensure
+            dumper.mock_teardown
+          end
+
+          unless dumper.responses.count == dump_block.expected_status_codes.count
+            raise <<~ERROR.squish
+              #{defined.name}.#{dump_block.name} received
+              #{dumper.responses.count} responses
+              (expected #{dump_block.expected_status_codes.count})
+            ERROR
+          end
+
+          klass_path = defined.name.underscore
+          dumper_dir = "#{dumps_dir}/#{klass_path}/#{dump_block.name}"
+          FileUtils.mkdir_p dumper_dir
+
+          dumper.responses.each_with_index do |response, index|
+            unless response.status == dump_block.expected_status_codes[index]
+              raise <<~ERROR.squish
+                #{defined.name}.#{dump_block.name} has unexpected status
+                code #{response.status} #{response.status_message}
+                (expected #{dump_block.expected_status_codes[index]})
+              ERROR
+            end
+
+            if response.content_type
+              mime = response.content_type.split(/ *; */).first
+              extension = ".#{MIME::Types[mime].first.preferred_extension}"
+            else
+              extension = ''
+            end
+            File.write("#{dumper_dir}/#{index}#{extension}", response.body)
+          end
+        end
+      end
+    end
+
+    private
+
+    def rollback_after
+      if defined?(ActiveRecord::Base)
+        ActiveRecord::Base.transaction do
+          yield
+          raise ActiveRecord::Rollback
+        end
+      else
+        # ActiveRecord is not installed.
+        yield
+      end
+    end
+  end
+end

data/lib/rails_response_dumper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'rails_response_dumper/runner'
+require_relative 'response_dumper'

data/lib/response_dumper.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "#{Dir.pwd}/config/environment"
+require 'rspec/mocks'
+
+class ResponseDumper
+  include ActionDispatch::Integration::Runner
+  include ActiveSupport::Testing::TimeHelpers
+  include RSpec::Mocks::ExampleMethods
+
+  def self.define(name, &block)
+    RailsResponseDumper::Defined.new(name, &block)
+  end
+
+  # Delegates to `Rails.application`.
+  def app
+    Rails.application
+  end
+
+  def responses
+    @responses ||= []
+  end
+
+  def mock_setup
+    RSpec::Mocks.setup
+  end
+
+  def mock_teardown
+    RSpec::Mocks.verify
+  ensure
+    RSpec::Mocks.teardown
+  end
+
+  %i[get post patch put head delete].each do |method|
+    module_eval <<~RUBY, __FILE__, __LINE__ + 1
+      def #{method}(...)
+        result = super
+        self.responses << response
+        result
+      end
+    RUBY
+  end
+
+  # The list of methods is too long to be useful so shorten to just the class
+  # name.
+  def inspect
+    "#<#{self.class.name}>"
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rails-response-dumper
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Pioneer Valley Books
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -34,16 +48,16 @@ dependencies:
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 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
@@ -55,6 +69,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/rails-response-dumper
+- lib/rails_response_dumper.rb
+- lib/rails_response_dumper/defined.rb
+- lib/rails_response_dumper/dump_block.rb
+- lib/rails_response_dumper/runner.rb
+- lib/response_dumper.rb
 homepage: https://github.com/Pioneer-Valley-Books/rails-response-dumper
 licenses:
 - MIT
@@ -75,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Dump HTTP responses from a Rails application to the file system