snapbot 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b343dc1ae312d937e8999b491789a0335d79577e3a8d2ebcce764c42a4871a87
-  data.tar.gz: 89b3faeec45989c19e9a8f3497320ddac2a7728ee91d5c784557a1235bb58ea4
+  metadata.gz: fd8932c76924b2ce01335b13174915694258dcd419d5c7da3fe5daa45a7e66c7
+  data.tar.gz: 9aa4282ef7e47c1789b742f28a977c8ea387d526ed0a8b4d524b6e205120d4f1
 SHA512:
-  metadata.gz: a66b1ddbad1589af9bbd087ceb201d50342fe8e252e6fa1b2107878fe2e1d2a9bc306ef72c6a15b720735e0eda76324148f2317808c7aeb44fc31300350e99d1
-  data.tar.gz: 18070e47081d20037e437a8d4c50eb50393edf23990d2102685792b51a43fde62eed90a9539cd37993d8941d080a5f44474d8e6223d500f4480109c973e81e1b
+  metadata.gz: 5c3e26e2eedb55db8876619da0c63fb79754b8c584d3ed1cf6599fbc37d8f8174af90f706bf6c5ee34e88e60a4482ab57b438613c04e426992a0f8ab80b13499
+  data.tar.gz: 3153f489921edecb2ca66bb7781911d0ff13e3ce563749773e649cb5a8c1c6229cc67f89cfbdcb96e17e9270cfcdc65ea2a4af7aa10e2cec8f29f6977e397357

data/README.md

@@ -20,13 +20,19 @@ Install this first, then add the gem to your project's `:test` group in the gemf
   end 
 ```
 
-Add to your tests:
+`include Snapbot::Diagram` in your tests.
 
+For RSpec, you may prefer to put something like
+
+```ruby
+  RSpec.config do |config|
+    config.include Snapbot::Diagram, type: :feature
+  end
 ```
-  include Snapbot::Diagram
-```
 
-Use:
+in your `spec/rails_helper` to have it mixed in automatically (to features, in this case).
+
+## Usage example
 
 ```
   blog = Blog.create(title: 'My blog')

data/Steepfile

@@ -26,7 +26,7 @@ target :lib do
     # lib/snapbot/diagram/renderer.rb:21:58: [error] The method cannot be called with a block
     # │ Diagnostic ID: Ruby::UnexpectedBlockGiven
     # │
-    # └         IO.popen("dot -Tsvg -o #{OUTPUT_FILENAME}", "w+") do |pipe|
+    # └         IO.popen("dot -Tsvg -o #{DEFAULT_OUTPUT_FILENAME}", "w+") do |pipe|
     #   ~~~~~~~~~
     #
     # This disables that ^^ but probably a bit too much. Can we restrict to renderer.rb?

data/lib/snapbot/diagram/renderer.rb

@@ -7,23 +7,23 @@ module Snapbot
     # Render some DOT via Graphviz dot command line
     class Renderer
       INSTALL_GRAPHVIZ_URL = "https://graphviz.org/download/#executable-packages"
-      OUTPUT_FILENAME      = "tmp/models.svg"
+      DEFAULT_OUTPUT_FILENAME = "tmp/models.svg"
 
       def initialize(dot)
         @dot = dot
       end
 
-      def save
+      def save(path = DEFAULT_OUTPUT_FILENAME)
         ensure_graphviz
-        FileUtils.rm(OUTPUT_FILENAME, force: true)
-        FileUtils.mkdir_p(File.dirname(OUTPUT_FILENAME))
+        FileUtils.rm(path, force: true)
+        FileUtils.mkdir_p(File.dirname(path))
 
-        IO.popen("dot -Tsvg -o #{OUTPUT_FILENAME}", "w") do |pipe|
+        IO.popen("dot -Tsvg -o #{path}", "w") do |pipe|
           pipe.puts(@dot)
         end
 
-        warn "Written to #{OUTPUT_FILENAME}"
-        OUTPUT_FILENAME
+        warn "Written to #{path}"
+        path
       end
 
       private

data/lib/snapbot/diagram.rb

@@ -7,17 +7,21 @@ 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)
-      args.reverse_merge!(rspec: !!defined?(RSpec))
-      dot = DotGenerator.new(**args).dot
-      filename = Renderer.new(dot).save
+    def save_and_open_diagram(path = Renderer::DEFAULT_OUTPUT_FILENAME, **args)
+      filename = save_diagram(path, **args)
 
       unless launchy_present?
-        warn "Cannot open diagram – install `launchy`. File saved to #{filename}"
+        warn "Cannot open diagram – install `launchy`."
         return
       end
 
-      Launchy.open(Renderer::OUTPUT_FILENAME)
+      Launchy.open(filename)
+    end
+
+    def save_diagram(path = Renderer::DEFAULT_OUTPUT_FILENAME, **args)
+      args.reverse_merge!(rspec: !!defined?(RSpec))
+      dot = DotGenerator.new(**args).dot
+      Renderer.new(dot).save(path)
     end
 
     def launchy_present?

data/lib/snapbot/version.rb

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

data/sig/lib/snapbot/diagram/renderer.rbs

@@ -2,18 +2,19 @@ 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"
+      INSTALL_GRAPHVIZ_URL:    String
+      DEFAULT_OUTPUT_FILENAME: String
 
       @dot: String
 
       def initialize: (String dot) -> void
-      def save: () -> String
+      def save: (?String path) -> String
 
       private
 
       def graphviz_executable: () -> ::String
       def ensure_graphviz: () -> void
+      def launchy_present?: () -> bool
     end
   end
 end

data/sig/lib/snapbot/diagram.rbs

@@ -2,7 +2,8 @@ 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: (**untyped args) -> (nil | untyped)
+    def save_diagram: (?String path, **untyped args) -> (nil | untyped)
+    def save_and_open_diagram: (?String path, **untyped args) -> (nil | untyped)
 
     def open_command: () -> untyped
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapbot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Russell Garner