snapshot_ui 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63bfd50e7e9795cf6ea6ef899d84d07aa333fbfe309e79f3476e2686fceae58f
-  data.tar.gz: d524af4e1ef098840a7119685d8a60c27301cb5b6bf91064b0350011535e3d58
+  metadata.gz: ed5906abe86dd34b16173cdbff8239e7f649ab4ace8adceabf250c90165b1879
+  data.tar.gz: fce78cca8afc9baffd515257e1f5e7a564e27d803b6c2e3a84341441254d7ead
 SHA512:
-  metadata.gz: b5756f817fb9f6c7f73f0dcf61aa9436698826fc1ef6a0722cd9a53eb2ea201cb4aa30615a33a443170fc16874f83d52ee8dfd40017d9f59a258ff9c64af0cc9
-  data.tar.gz: 8cad2af17162a97a97bf84837b39063eef97d57ec2835675498d98507f425d07a01956645fb86b6f92592493ed08c76a2ac84eb476d9a79bb73c7fd0b3133137
+  metadata.gz: 2c64f1972c0f1261fe57e09e8aad3e9e9ba174184dbc9ff82ed988012e27a8d2340818629189d90a41d3ea7f2d11725ff9ec546500b32a1c0adddf6d2ec083a7
+  data.tar.gz: 791edbd08ad2eaffed422b850063dc8b3c5914a2214f8914f2079607c03a6c0b3cfa8b6608618e4d54750953886b633a9a7d26f3c975c8e06f5ced609f533b1f

data/lib/minitest/snapshot_ui_plugin.rb

@@ -12,6 +12,8 @@ module Minitest
     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
@@ -22,7 +24,7 @@ module Minitest
     def report
       SnapshotUI.publish_snapshots_in_progress
 
-      io.print "\n\nUI snapshots are ready for review at #{SnapshotUI.configuration.web_url}"
+      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,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "colorize"
+
 module SnapshotUI
   class Configuration
     attr_writer :storage_directory, :project_root_directory
@@ -12,11 +14,28 @@ module SnapshotUI
     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.2.0"
+  VERSION = "0.3.0"
 end

data/lib/snapshot_ui.rb

@@ -5,8 +5,8 @@ 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
 
@@ -23,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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tomaz Zlender
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -96,6 +96,7 @@ files:
 - 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