snapshot_ui 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db2e79495a612dd8f9e73f84537b5237c214faf5290915f40a451b27c517fb10
-  data.tar.gz: 5f68e150a5439073be54508096b9a085277d1cfe03292a78e396c6f790c17a0d
+  metadata.gz: ed5906abe86dd34b16173cdbff8239e7f649ab4ace8adceabf250c90165b1879
+  data.tar.gz: fce78cca8afc9baffd515257e1f5e7a564e27d803b6c2e3a84341441254d7ead
 SHA512:
-  metadata.gz: e20faf53a0f05035d90e76e10d08a7a067728899df4bc6e5dc9c3dda944c7414579b334650c4b9a8edfc1ad2889bb7b65537d22120cb9cbc2a92b4b0378d2598
-  data.tar.gz: c6fa887d47cfec6bf20f91146e37f0165655601b4d3a38bb43e74b735dcde65da4453a672d147cb305f0cc67dc4d5338ece722b7224f428527917e8f49b30370
+  metadata.gz: 2c64f1972c0f1261fe57e09e8aad3e9e9ba174184dbc9ff82ed988012e27a8d2340818629189d90a41d3ea7f2d11725ff9ec546500b32a1c0adddf6d2ec083a7
+  data.tar.gz: 791edbd08ad2eaffed422b850063dc8b3c5914a2214f8914f2079607c03a6c0b3cfa8b6608618e4d54750953886b633a9a7d26f3c975c8e06f5ced609f533b1f

data/README.md

@@ -1,16 +1,8 @@
-# SnapshotUI
+# Snapshot UI
 
-## Things to do next
+Take snapshots of responses in integration tests, and display them in a browser.
 
-- Live reloads after a test run and new snapshots become published
-- Accept not only "response" objects but also just plain strings for testing UI helpers (think buttons, etc.)
-- Make it easier to navigate between a list of snapshots and the code
-- Ability to disable or enable javascript of the rendered snapshots
-
-## Things to do in the far future
-
-- Different representations of snapshot lists
-- Spatially display snapshots and how they connect to each other to demonstrate UI flows
-- Extract more information out of response snapshots - path, page title, how they connect to other snapshots
-- Possibility to add notes to snapshots from within tests (`take_snapshot response, note: "...")
+Works with any kind of Rack application and minitest testing framework.
 
+> ℹ️ The Snapshot UI is the next generation of a similar library, [Snapshot Inspector](https://github.com/tomazzlender/snapshot_inspector).
+> It works with any kind of Rack application, not just Rails applications. Future development will take place here, and Snapshot Inspector will be eventually archived.

data/lib/minitest/snapshot_ui_plugin.rb

@@ -0,0 +1,30 @@
+require "snapshot_ui"
+require "minitest"
+
+module Minitest
+  class << self
+    def plugin_snapshot_ui_options(opts, _options)
+      opts.on "--take-snapshots", "Take UI snapshots" do
+        ENV["TAKE_SNAPSHOTS"] = "true"
+      end
+    end
+
+    def plugin_snapshot_ui_init(_options)
+      return unless SnapshotUI.snapshot_taking_enabled?
+
+      SnapshotUI.exit_if_not_configured!
+
+      reporter << SnapshotUIReporter.new
+
+      SnapshotUI.clear_snapshots_in_progress
+    end
+  end
+
+  class SnapshotUIReporter < Reporter
+    def report
+      SnapshotUI.publish_snapshots_in_progress
+
+      io.puts "\n\nUI snapshots are ready for review at #{SnapshotUI.configuration.web_url}"
+    end
+  end
+end

data/lib/snapshot_ui/colorize.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SnapshotUI
+  module Colorize
+    module_function
+
+    def red(string)
+      "\e[31m#{string}\e[0m"
+    end
+
+    def green(string)
+      "\e[32m#{string}\e[0m"
+    end
+  end
+end

data/lib/snapshot_ui/configuration.rb

@@ -1,20 +1,41 @@
 # frozen_string_literal: true
 
+require_relative "colorize"
+
 module SnapshotUI
   class Configuration
     attr_writer :storage_directory, :project_root_directory
+    attr_accessor :web_url
 
-    def initialize(project_root_directory:, storage_directory:)
+    def initialize(project_root_directory:, storage_directory:, web_url:)
       @project_root_directory = project_root_directory
       @storage_directory = storage_directory
+      @web_url = web_url
     end
 
     def storage_directory
-      Pathname.new(@storage_directory)
+      Pathname.new(@storage_directory) if @storage_directory
     end
 
     def project_root_directory
-      Pathname.new(@project_root_directory)
+      Pathname.new(@project_root_directory) if @project_root_directory
+    end
+
+    def exit_if_not_configured!
+      return unless project_root_directory.nil? || storage_directory.nil? || web_url.nil?
+
+      puts Colorize.red("Looks like SnapshotUI is not configured yet. Example configuration:\n")
+
+      puts <<~CONFIG
+        #{Colorize.green("SnapshotUI.configure do |config|")}
+          #{Colorize.green('config.storage_directory = "/path/to/tmp/snapshot_ui"')} #{Colorize.red("# Current value is `#{storage_directory.inspect}`")}
+          #{Colorize.green('config.project_root_directory = "/path/to/project/root"')} #{Colorize.red("# Current value is `#{project_root_directory.inspect}`")}
+          #{Colorize.green("config.web_url = \"#{web_url}\"")} #{Colorize.red("# Current value is `#{web_url.inspect}`")}
+        #{Colorize.green("end")}
+
+      CONFIG
+
+      raise SystemExit.new(1)
     end
   end
 end

data/lib/snapshot_ui/test/minitest_helpers.rb

@@ -16,6 +16,8 @@ module SnapshotUI
           raise ArgumentError.new(message)
         end
 
+        SnapshotUI.exit_if_not_configured!
+
         increment_take_snapshot_counter_scoped_by_test
 
         SnapshotUI::Snapshot.persist(

data/lib/snapshot_ui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SnapshotUI
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/snapshot_ui.rb

@@ -5,8 +5,9 @@ require_relative "snapshot_ui/configuration"
 
 module SnapshotUI
   DEFAULT_CONFIGURATION = {
-    project_root_directory: ".",
-    storage_directory: "tmp/snapshot_ui"
+    project_root_directory: nil,
+    storage_directory: nil,
+    web_url: "http://localhost:3000/ui/snapshots"
   }.freeze
 
   def self.configure
@@ -22,14 +23,24 @@ module SnapshotUI
   end
 
   def self.publish_snapshots_in_progress
+    exit_if_not_configured!
+
     Snapshot.publish_snapshots_in_progress
   end
 
   def self.clear_snapshots_in_progress
+    exit_if_not_configured!
+
     Snapshot.clear_snapshots_in_progress
   end
 
   def self.clear_snapshots
+    exit_if_not_configured!
+
     Snapshot.clear_snapshots
   end
+
+  def self.exit_if_not_configured!
+    configuration.exit_if_not_configured!
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot_ui
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tomaz Zlender
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -92,9 +92,11 @@ files:
 - LICENSE.txt
 - README.md
 - bin/snapshot_ui
+- lib/minitest/snapshot_ui_plugin.rb
 - lib/snapshot_ui.rb
 - lib/snapshot_ui/cli.rb
 - lib/snapshot_ui/cli/watcher.ru
+- lib/snapshot_ui/colorize.rb
 - lib/snapshot_ui/configuration.rb
 - lib/snapshot_ui/snapshot.rb
 - lib/snapshot_ui/snapshot/context.rb