snapbot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ff9b478fc49144d2edf97c515e52f946b3f73a0d939e0de6d9789e6ab207a1b
-  data.tar.gz: 3d10ece40e5e1e2dfc67f8552746f6c2f326b54d0977a2a39764f1ba008a9a97
+  metadata.gz: aa9a6b0cbc5334ac7078254f385f9c859c0ea22d7ca4821741bade0b4c32cca6
+  data.tar.gz: 8e69a33b99977466a92b9772abaa2e2d889a0d7ff200ed81c5effb01581eb014
 SHA512:
-  metadata.gz: dff17039b7af000c3d9a6fb17ba2fc21af8da0a0ab3a72a9b2af098f8b0e06b7c5b3a3230b547d78886f5e9bd320c9c30f2095fdb9e55ee5c892488be5c04e6b
-  data.tar.gz: 578806b5e7c84b72691ebad4069ac39a51c0fcd04b79b62282fbb57fbf096dc88e29e8c23d801e1ed230a8925dc4b004d1c80b80520d7eb3ece9caf612e208e3
+  metadata.gz: 1de519ae9f8e26a44d081682b83ca89d101daf00f5665c7d04a4ed1bb7c8ee701a72b476b45d9d5760ff2621e498d8bbe0ddfb3bde386fc4f188a16cee3c82db
+  data.tar.gz: 6f549408fbffc23fc5f96f620dc0be49df614b84ce0e5c913fb375422bcec052f36e065a63080f03be3a2992c7f7a519873ab0efcb31bd9610e5b2f2bdf2340e

data/.rubocop.yml

@@ -7,6 +7,10 @@ Metrics/BlockLength:
     - spec/**/*_spec.rb
     - snapbot.gemspec
 
+Style/StderrPuts:
+  Exclude:
+    - lib/snapbot/diagram/renderer.rb
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/lib/snapbot/diagram/renderer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Snapbot
+  module Diagram
+    # Render some DOT via Graphviz dot command line
+    class Renderer
+      INSTALL_GRAPHVIZ_URL = "https://graphviz.org/download/#executable-packages"
+      OUTPUT_FILENAME      = "tmp/models.svg"
+
+      def initialize(dot)
+        @dot = dot
+      end
+
+      def save
+        ensure_graphviz
+        FileUtils.rm(OUTPUT_FILENAME, force: true)
+        IO.popen("dot -Tsvg -o #{OUTPUT_FILENAME}", "w") do |pipe|
+          pipe.puts(@dot)
+        end
+
+        warn "Written to #{OUTPUT_FILENAME}"
+        OUTPUT_FILENAME
+      end
+
+      private
+
+      def graphviz_executable
+        `which dot`
+      end
+
+      def ensure_graphviz
+        return unless graphviz_executable.empty?
+
+        warn <<~GRAPHVIZ
+          The graphviz executable `dot` was not found.
+          Install from #{INSTALL_GRAPHVIZ_URL}
+        GRAPHVIZ
+      end
+    end
+  end
+end

data/lib/snapbot/diagram.rb

@@ -1,11 +1,28 @@
 # frozen_string_literal: true
 
+require "snapbot/diagram/dot_generator"
+require "snapbot/diagram/renderer"
+require "open3"
+
 module Snapbot
   # Print the small constellation of objects in your integration test and how they relate.
   # Requires Graphviz. Optimised for Mac. YMMV.
   module Diagram
     def save_and_open_diagram(**args)
-      DotGenerator.new(**args).open
+      dot = DotGenerator.new(**args).dot
+      filename = Renderer.new(dot).save
+
+      unless open_command.present?
+        warn "No `open` command available. File saved to #{filename}"
+        return
+      end
+
+      _stdout, stderr, status = Open3.capture3("#{open_command} #{filename}")
+      raise stderr unless status.exitstatus.zero?
+    end
+
+    def open_command
+      `which open`.chomp
     end
   end
 end

data/lib/snapbot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Russell Garner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -99,6 +99,7 @@ files:
 - lib/snapbot/diagram.rb
 - lib/snapbot/diagram/dot_generator.rb
 - lib/snapbot/diagram/dot_generator/relationship.rb
+- lib/snapbot/diagram/renderer.rb
 - lib/snapbot/reflector.rb
 - lib/snapbot/rspec/lets.rb
 - lib/snapbot/version.rb