snapshot_inspector 0.1.1

data/lib/snapshot_inspector/test/rspec_helpers.rb

@@ -0,0 +1,45 @@
+module SnapshotInspector
+  module Test
+    module RSpecHelpers
+      extend ActiveSupport::Concern
+
+      # Takes a snapshot of a given +snapshotee+.
+      #
+      # A +snapshotee+ can be an instance of +ActionDispatch::TestResponse+ or +ActionMailer::MessageDelivery+.
+      #
+      # +take_snapshot+ needs to be called after the +snapshotee+ object becomes available
+      # for inspection in the lifecycle of the spec (e.g. request or mailer spec). You can take one or
+      # more snapshots in a single spec.
+      #
+      # Snapshots are taken only when explicitly enabled with an environment variable +TAKE_SNAPSHOTS=1+.
+      #
+      # E.g. +bin/rspec TAKE_SNAPSHOTS=1+
+      #
+      # @param snapshotee [ActionDispatch::TestResponse, ActionMailer::MessageDelivery]
+      # @return SnapshotInspector::Snapshot
+      def take_snapshot(snapshotee)
+        return unless SnapshotInspector.configuration.snapshot_taking_enabled
+
+        increment_take_snapshot_counter_scoped_by_test
+
+        SnapshotInspector::Snapshot.persist(
+          snapshotee: snapshotee,
+          context: {
+            test_framework: :rspec,
+            example: RSpec.current_example.metadata.except(:execution_result).as_json.with_indifferent_access,
+            take_snapshot_index: _take_snapshot_counter - 1
+          }
+        )
+      end
+
+      private
+
+      attr_reader :_take_snapshot_counter
+
+      def increment_take_snapshot_counter_scoped_by_test
+        @_take_snapshot_counter ||= 0
+        @_take_snapshot_counter += 1
+      end
+    end
+  end
+end

data/lib/snapshot_inspector/test/test_unit_helpers.rb

@@ -0,0 +1,48 @@
+module SnapshotInspector
+  module Test
+    module TestUnitHelpers
+      extend ActiveSupport::Concern
+
+      # Takes a snapshot of a given +snapshotee+.
+      #
+      # A +snapshotee+ can be an instance of +ActionDispatch::TestResponse+ or +ActionMailer::MessageDelivery+.
+      #
+      # +take_snapshot+ needs to be called after the +snapshotee+ object becomes available
+      # for inspection in the lifecycle of the test (e.g. integration or mailer test). You can take one or
+      # more snapshots in a single test case.
+      #
+      # Snapshots are taken only when explicitly enabled with a flag +--take-snapshots+
+      # or when an environment variable +TAKE_SNAPSHOTS=1+ is set.
+      #
+      # E.g. +bin/rails test --take-snapshots+
+      #
+      # @param snapshotee [ActionDispatch::TestResponse, ActionMailer::MessageDelivery]
+      # @return SnapshotInspector::Snapshot
+      def take_snapshot(snapshotee)
+        return unless SnapshotInspector.configuration.snapshot_taking_enabled
+
+        increment_take_snapshot_counter_scoped_by_test
+
+        SnapshotInspector::Snapshot.persist(
+          snapshotee: snapshotee,
+          context: {
+            test_framework: :test_unit,
+            method_name: method_name,
+            source_location: method(method_name).source_location,
+            test_case_name: self.class.to_s,
+            take_snapshot_index: _take_snapshot_counter - 1
+          }
+        )
+      end
+
+      private
+
+      attr_reader :_take_snapshot_counter
+
+      def increment_take_snapshot_counter_scoped_by_test
+        @_take_snapshot_counter ||= 0
+        @_take_snapshot_counter += 1
+      end
+    end
+  end
+end

data/lib/snapshot_inspector/version.rb

@@ -0,0 +1,3 @@
+module SnapshotInspector
+  VERSION = "0.1.1"
+end

data/lib/snapshot_inspector.rb

@@ -0,0 +1,42 @@
+abort "`snapshot_inspector` is only meant to be loaded in the `development` and `test` environments. Your current environment is `#{Rails.env}`. Move the gem into the `group :development, :test` block in your Gemfile." unless Rails.env.development? || Rails.env.test?
+
+require "snapshot_inspector/version"
+require "snapshot_inspector/engine"
+require "minitest/snapshot_inspector_plugin"
+require "importmap-rails"
+
+module SnapshotInspector
+  module Test
+    autoload :TestUnitHelpers, "snapshot_inspector/test/test_unit_helpers"
+    autoload :RSpecHelpers, "snapshot_inspector/test/rspec_helpers"
+  end
+
+  STORAGE_DIRECTORY = "tmp/snapshot_inspector"
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  class Configuration
+    attr_accessor :importmap, :snapshot_taking_enabled, :storage_directory, :host, :route_path
+
+    def initialize
+      @importmap = Importmap::Map.new
+      @snapshot_taking_enabled = ENV.fetch("TAKE_SNAPSHOTS", nil) == "1"
+      @storage_directory = nil
+      @host = "http://localhost:3000"
+      @route_path = "/rails/snapshots"
+    end
+  end
+
+  def self.initialize_configuration
+    self.configuration ||= Configuration.new
+  end
+
+  def self.configure
+    initialize_configuration
+    yield(configuration)
+  end
+end
+
+SnapshotInspector.initialize_configuration

data/lib/tasks/tmp.rake

@@ -0,0 +1,10 @@
+require "snapshot_inspector/storage"
+
+namespace :tmp do
+  namespace :snapshots do
+    desc "Clear all files in the snapshots storage directory (e.g. tmp/snapshots)"
+    task :clear do
+      SnapshotInspector::Storage.clear
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: snapshot_inspector
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tomaz Zlender
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+description: Take snapshots of responses and mail messages while testing, and inspect
+  them in a browser. A Ruby on Rails engine.
+email:
+- tomaz@zlender.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/snapshot_inspector/manifest.js
+- app/assets/javascripts/snapshot_inspector/application.js
+- app/assets/stylesheets/snapshot_inspector/application.css
+- app/assets/stylesheets/snapshot_inspector/snapshots.css
+- app/assets/stylesheets/snapshot_inspector/snapshots/mail.css
+- app/assets/stylesheets/snapshot_inspector/snapshots/not_found.css
+- app/assets/stylesheets/snapshot_inspector/snapshots/response.css
+- app/controllers/snapshot_inspector/application_controller.rb
+- app/controllers/snapshot_inspector/snapshots/mail_controller.rb
+- app/controllers/snapshot_inspector/snapshots/response_controller.rb
+- app/controllers/snapshot_inspector/snapshots_controller.rb
+- app/helpers/snapshot_inspector/application_helper.rb
+- app/helpers/snapshot_inspector/snapshots_helper.rb
+- app/mailers/snapshot_inspector/application_mailer.rb
+- app/models/snapshot_inspector/snapshot.rb
+- app/models/snapshot_inspector/snapshot/context.rb
+- app/models/snapshot_inspector/snapshot/mail_type.rb
+- app/models/snapshot_inspector/snapshot/response_type.rb
+- app/models/snapshot_inspector/snapshot/rspec_context.rb
+- app/models/snapshot_inspector/snapshot/test_unit_context.rb
+- app/models/snapshot_inspector/snapshot/type.rb
+- app/views/layouts/snapshot_inspector/application.html.erb
+- app/views/snapshot_inspector/snapshots/index.html.erb
+- app/views/snapshot_inspector/snapshots/mail/show.html.erb
+- app/views/snapshot_inspector/snapshots/not_found.html.erb
+- app/views/snapshot_inspector/snapshots/response/raw.html.erb
+- app/views/snapshot_inspector/snapshots/response/show.html.erb
+- config/importmap.rb
+- config/routes.rb
+- lib/minitest/snapshot_inspector_plugin.rb
+- lib/snapshot_inspector.rb
+- lib/snapshot_inspector/engine.rb
+- lib/snapshot_inspector/storage.rb
+- lib/snapshot_inspector/test/action_mailer_headers.rb
+- lib/snapshot_inspector/test/rspec_helpers.rb
+- lib/snapshot_inspector/test/test_unit_helpers.rb
+- lib/snapshot_inspector/version.rb
+- lib/tasks/tmp.rake
+homepage: https://github.com/tomazzlender/snapshot_inspector
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tomazzlender/snapshot_inspector
+  source_code_uri: https://github.com/tomazzlender/snapshot_inspector
+  changelog_uri: https://github.com/tomazzlender/snapshot_inspector/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key:
+specification_version: 4
+summary: Take snapshots of responses and mail messages while testing, and inspect
+  them in a browser. A Ruby on Rails engine.
+test_files: []