snapbot 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb7768e6e3ac46cacf84d569a0d8026062418160d39c5ae1e214875ac0f4b26d
-  data.tar.gz: 50467bc231c453c7c81129181f90c21759f5acb2f121fbaf07bfd5313dcaea80
+  metadata.gz: b343dc1ae312d937e8999b491789a0335d79577e3a8d2ebcce764c42a4871a87
+  data.tar.gz: 89b3faeec45989c19e9a8f3497320ddac2a7728ee91d5c784557a1235bb58ea4
 SHA512:
-  metadata.gz: 0331b6031f3fe4e3ee09aef66a1030bfec968f5df8c7308c2dd09933e0c63cfad55e54dab10e7bf0e9dc568216d34bbd3f8ac32c5bd6e524750ad676fbb49988
-  data.tar.gz: 06757de1f42e455f6b8565661426bba4a94e609d567a5d2a2c6d8cdb8be8e5aed4b16e97334a009d34bda3b400707b2796a9a4b88b507a407b58e1ca8df2a798
+  metadata.gz: a66b1ddbad1589af9bbd087ceb201d50342fe8e252e6fa1b2107878fe2e1d2a9bc306ef72c6a15b720735e0eda76324148f2317808c7aeb44fc31300350e99d1
+  data.tar.gz: 18070e47081d20037e437a8d4c50eb50393edf23990d2102685792b51a43fde62eed90a9539cd37993d8941d080a5f44474d8e6223d500f4480109c973e81e1b

data/.rubocop.yml

@@ -1,6 +1,13 @@
 AllCops:
   TargetRubyVersion: 2.6
   SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - Steepfile
+    - vendor/bundle/**/*
+
+Gemspec/RequireMFA:
+  Enabled: false
 
 Metrics/AbcSize:
   Exclude:
@@ -15,6 +22,9 @@ Metrics/MethodLength:
   Exclude:
     - spec/support/fixture_database.rb
 
+Style/DoubleNegation:
+  Enabled: false
+
 Style/StderrPuts:
   Exclude:
     - lib/snapbot/diagram/renderer.rb

data/Gemfile

@@ -5,6 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in snapbot.gemspec
 gemspec
 
+gem "launchy", "~> 2.5.0"
+
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"

data/README.md

@@ -1,13 +1,18 @@
 # Snapbot
 
+![example workflow](https://github.com/rgarner/snapbot/actions/workflows/main.yml/badge.svg)
+
 Snapbot generates little diagrams via `save_and_open_diagram` for you to visualise the small constellations of 
 ActiveRecord objects that you find in feature and integration tests. These are most often made by
  [FactoryBot](https://github.com/thoughtbot/factory_bot) or some other fixture-handling method, but this gem has no 
  opinions on those (beyond namechecking).
+ 
+![example](docs/img/models.svg)
 
 ## Installation
 
-Either `gem install snapbot` or add the gem to your project's `:test` group in the gemfile:
+Snapbot requires [Graphviz](https://graphviz.org/download/#executable-packages), and cannot function without it.
+Install this first, then add the gem to your project's `:test` group in the gemfile:
 
 ```ruby 
   group :test do 
@@ -30,6 +35,28 @@ Use:
   save_and_open_diagram
 ```
 
+## RSpec integration
+
+Sometimes it's useful to see the models you created as preconditions vs the ones your code has created in response to
+those. If you use RSpec's [`let` construct](https://relishapp.com/rspec/rspec-core/v/3-11/docs/helper-methods/let-and-let)
+then Snapbot will match these automatically for you and annotate the diagram. For example:
+
+```ruby
+  include Snapbot::Diagram
+  describe "the categorised post creator" do
+    let(:blog)   { create :blog }
+    let(:author) { create :author }
+
+    it "creates posts automatically, categorised" do
+      CategorisedPostCreator.new(blog, author).run
+      save_and_open_diagram
+      expect(Post.count).to eql(2)
+    end
+  end
+```
+
+![annotated diagram](docs/img/models-with-lets.svg)
+
 ## Why?
 
 Sometimes, you need to create a few ActiveRecord objects for your test suite. Sometimes, there will be a little cluster

data/Rakefile

@@ -3,10 +3,12 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
+Dir["lib/tasks/*.rake"].each { |file| import file }
+
 RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[spec rubocop steep:check]

data/Steepfile

@@ -0,0 +1,43 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"                         # Directory name
+  # check "Gemfile"                   # File name
+  # check "app/models/**/*.rb"        # Glob
+  # ignore "lib/templates/*.rb"
+
+  library "set"
+  # library "rspec"
+  # library "strong_json"           # Gems
+
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  configure_code_diagnostics(D::Ruby.lenient) # `lenient` diagnostics setting
+  configure_code_diagnostics do |hash|             # You can setup everything yourself
+    # lib/snapbot/reflector.rb:73:35: [error] Unsupported block params pattern, probably masgn?
+    # │ Diagnostic ID: Ruby::UnsupportedSyntax
+    # │
+    # └       hash.each_with_object([]) do |(key, value), array|
+    #                                      ~~~~~~~~~~~~~~~~~~~~~
+    # This disables that ^^
+    hash[D::Ruby::UnsupportedSyntax] = :information
+
+    # 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|
+    #   ~~~~~~~~~
+    #
+    # This disables that ^^ but probably a bit too much. Can we restrict to renderer.rb?
+    hash[D::Ruby::UnexpectedBlockGiven] = :information
+  end
+end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname", "set"       # Standard libraries
+# end

data/docs/img/models-with-lets.svg

@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Generated by graphviz version 3.0.0 (20220226.1711)
+ -->
+<!-- Title: g Pages: 1 -->
+<svg width="322pt" height="247pt"
+ viewBox="0.00 0.00 322.10 246.60" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(28.8 217.8)">
+<title>g</title>
+<polygon fill="white" stroke="transparent" points="-28.8,28.8 -28.8,-217.8 293.3,-217.8 293.3,28.8 -28.8,28.8"/>
+<!-- Category#1 -->
+<g id="node1" class="node">
+<title>Category#1</title>
+<path fill="none" stroke="black" d="M12,-149.5C12,-149.5 57,-149.5 57,-149.5 63,-149.5 69,-155.5 69,-161.5 69,-161.5 69,-173.5 69,-173.5 69,-179.5 63,-185.5 57,-185.5 57,-185.5 12,-185.5 12,-185.5 6,-185.5 0,-179.5 0,-173.5 0,-173.5 0,-161.5 0,-161.5 0,-155.5 6,-149.5 12,-149.5"/>
+<text text-anchor="start" x="9.5" y="-164.5" font-family="ArialMT" font-size="10.00">Category#1</text>
+</g>
+<!-- Post#1 -->
+<g id="node4" class="node">
+<title>Post#1</title>
+<path fill="none" stroke="black" d="M77.5,-73.5C77.5,-73.5 107.5,-73.5 107.5,-73.5 113.5,-73.5 119.5,-79.5 119.5,-85.5 119.5,-85.5 119.5,-97.5 119.5,-97.5 119.5,-103.5 113.5,-109.5 107.5,-109.5 107.5,-109.5 77.5,-109.5 77.5,-109.5 71.5,-109.5 65.5,-103.5 65.5,-97.5 65.5,-97.5 65.5,-85.5 65.5,-85.5 65.5,-79.5 71.5,-73.5 77.5,-73.5"/>
+<text text-anchor="start" x="77.5" y="-88.5" font-family="ArialMT" font-size="10.00">Post#1</text>
+</g>
+<!-- Category#1&#45;&gt;Post#1 -->
+<g id="edge1" class="edge">
+<title>Category#1&#45;&gt;Post#1</title>
+<path fill="none" stroke="black" d="M53.51,-142.25C59.92,-134.07 67.07,-124.94 73.48,-116.76"/>
+<polygon fill="black" stroke="black" points="51.02,-140.31 47.95,-149.34 55.98,-144.2 51.02,-140.31"/>
+<polygon fill="black" stroke="black" points="76.05,-118.6 79.12,-109.57 71.09,-114.71 76.05,-118.6"/>
+</g>
+<!-- Post#2 -->
+<g id="node5" class="node">
+<title>Post#2</title>
+<path fill="none" stroke="black" d="M160.5,-73.5C160.5,-73.5 190.5,-73.5 190.5,-73.5 196.5,-73.5 202.5,-79.5 202.5,-85.5 202.5,-85.5 202.5,-97.5 202.5,-97.5 202.5,-103.5 196.5,-109.5 190.5,-109.5 190.5,-109.5 160.5,-109.5 160.5,-109.5 154.5,-109.5 148.5,-103.5 148.5,-97.5 148.5,-97.5 148.5,-85.5 148.5,-85.5 148.5,-79.5 154.5,-73.5 160.5,-73.5"/>
+<text text-anchor="start" x="160.5" y="-88.5" font-family="ArialMT" font-size="10.00">Post#2</text>
+</g>
+<!-- Category#1&#45;&gt;Post#2 -->
+<g id="edge2" class="edge">
+<title>Category#1&#45;&gt;Post#2</title>
+<path fill="none" stroke="black" d="M75.24,-145.12C95.75,-134.36 120.36,-121.44 140.07,-111.1"/>
+<polygon fill="black" stroke="black" points="73.71,-142.37 67.2,-149.34 76.64,-147.94 73.71,-142.37"/>
+<polygon fill="black" stroke="black" points="141.68,-113.81 148.19,-106.83 138.76,-108.23 141.68,-113.81"/>
+</g>
+<!-- Category#2 -->
+<g id="node2" class="node">
+<title>Category#2</title>
+<path fill="none" stroke="black" d="M153,-0.5C153,-0.5 198,-0.5 198,-0.5 204,-0.5 210,-6.5 210,-12.5 210,-12.5 210,-24.5 210,-24.5 210,-30.5 204,-36.5 198,-36.5 198,-36.5 153,-36.5 153,-36.5 147,-36.5 141,-30.5 141,-24.5 141,-24.5 141,-12.5 141,-12.5 141,-6.5 147,-0.5 153,-0.5"/>
+<text text-anchor="start" x="150.5" y="-15.5" font-family="ArialMT" font-size="10.00">Category#2</text>
+</g>
+<!-- Author#1 -->
+<g id="node3" class="node">
+<title>Author#1</title>
+<path fill="none" stroke="black" d="M110,-146.5C110,-146.5 159,-146.5 159,-146.5 165,-146.5 171,-152.5 171,-158.5 171,-158.5 171,-176.5 171,-176.5 171,-182.5 165,-188.5 159,-188.5 159,-188.5 110,-188.5 110,-188.5 104,-188.5 98,-182.5 98,-176.5 98,-176.5 98,-158.5 98,-158.5 98,-152.5 104,-146.5 110,-146.5"/>
+<text text-anchor="start" x="107.5" y="-174.1" font-family="Monaco" font-size="8.00">let(:author)</text>
+<text text-anchor="start" x="115" y="-157.5" font-family="ArialMT" font-size="10.00">Author#1</text>
+</g>
+<!-- Author#1&#45;&gt;Post#1 -->
+<g id="edge4" class="edge">
+<title>Author#1&#45;&gt;Post#1</title>
+<path fill="none" stroke="black" d="M118.56,-138.42C113.08,-128.76 107.1,-118.22 102.25,-109.69"/>
+<polygon fill="black" stroke="black" points="115.84,-140.01 123.02,-146.28 121.32,-136.9 115.84,-140.01"/>
+</g>
+<!-- Author#1&#45;&gt;Post#2 -->
+<g id="edge5" class="edge">
+<title>Author#1&#45;&gt;Post#2</title>
+<path fill="none" stroke="black" d="M150.22,-138.13C155.53,-128.55 161.3,-118.14 165.98,-109.69"/>
+<polygon fill="black" stroke="black" points="147.31,-136.88 145.7,-146.28 152.82,-139.93 147.31,-136.88"/>
+</g>
+<!-- Post#2&#45;&gt;Category#2 -->
+<g id="edge8" class="edge">
+<title>Post#2&#45;&gt;Category#2</title>
+<path fill="none" stroke="black" d="M175.5,-64.13C175.5,-58.07 175.5,-51.64 175.5,-45.59"/>
+<polygon fill="black" stroke="black" points="172.35,-64.31 175.5,-73.31 178.65,-64.31 172.35,-64.31"/>
+<polygon fill="black" stroke="black" points="178.65,-45.53 175.5,-36.53 172.35,-45.53 178.65,-45.53"/>
+</g>
+<!-- Blog#1 -->
+<g id="node6" class="node">
+<title>Blog#1</title>
+<path fill="none" stroke="black" d="M212.5,-146.5C212.5,-146.5 252.5,-146.5 252.5,-146.5 258.5,-146.5 264.5,-152.5 264.5,-158.5 264.5,-158.5 264.5,-176.5 264.5,-176.5 264.5,-182.5 258.5,-188.5 252.5,-188.5 252.5,-188.5 212.5,-188.5 212.5,-188.5 206.5,-188.5 200.5,-182.5 200.5,-176.5 200.5,-176.5 200.5,-158.5 200.5,-158.5 200.5,-152.5 206.5,-146.5 212.5,-146.5"/>
+<text text-anchor="start" x="209.5" y="-174.1" font-family="Monaco" font-size="8.00">let(:blog)</text>
+<text text-anchor="start" x="217" y="-157.5" font-family="ArialMT" font-size="10.00">Blog#1</text>
+</g>
+<!-- Blog#1&#45;&gt;Post#1 -->
+<g id="edge9" class="edge">
+<title>Blog#1&#45;&gt;Post#1</title>
+<path fill="none" stroke="black" d="M192.4,-145.3C169.12,-133 140.41,-117.83 119.75,-106.91"/>
+<polygon fill="black" stroke="black" points="190.95,-148.1 200.38,-149.52 193.9,-142.53 190.95,-148.1"/>
+</g>
+<!-- Blog#1&#45;&gt;Post#2 -->
+<g id="edge10" class="edge">
+<title>Blog#1&#45;&gt;Post#2</title>
+<path fill="none" stroke="black" d="M211.32,-139C203.75,-129.18 195.45,-118.39 188.74,-109.69"/>
+<polygon fill="black" stroke="black" points="208.94,-141.07 216.92,-146.28 213.93,-137.23 208.94,-141.07"/>
+</g>
+</g>
+</svg>

data/docs/img/models.svg

@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Generated by graphviz version 3.0.0 (20220226.1711)
+ -->
+<!-- Title: g Pages: 1 -->
+<svg width="297pt" height="241pt"
+ viewBox="0.00 0.00 297.10 240.60" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(28.8 211.8)">
+<title>g</title>
+<polygon fill="white" stroke="transparent" points="-28.8,28.8 -28.8,-211.8 268.3,-211.8 268.3,28.8 -28.8,28.8"/>
+<!-- Category#1 -->
+<g id="node1" class="node">
+<title>Category#1</title>
+<path fill="none" stroke="black" d="M12,-146.5C12,-146.5 57,-146.5 57,-146.5 63,-146.5 69,-152.5 69,-158.5 69,-158.5 69,-170.5 69,-170.5 69,-176.5 63,-182.5 57,-182.5 57,-182.5 12,-182.5 12,-182.5 6,-182.5 0,-176.5 0,-170.5 0,-170.5 0,-158.5 0,-158.5 0,-152.5 6,-146.5 12,-146.5"/>
+<text text-anchor="start" x="9.5" y="-161.5" font-family="ArialMT" font-size="10.00">Category#1</text>
+</g>
+<!-- Post#1 -->
+<g id="node4" class="node">
+<title>Post#1</title>
+<path fill="none" stroke="black" d="M70.5,-73.5C70.5,-73.5 100.5,-73.5 100.5,-73.5 106.5,-73.5 112.5,-79.5 112.5,-85.5 112.5,-85.5 112.5,-97.5 112.5,-97.5 112.5,-103.5 106.5,-109.5 100.5,-109.5 100.5,-109.5 70.5,-109.5 70.5,-109.5 64.5,-109.5 58.5,-103.5 58.5,-97.5 58.5,-97.5 58.5,-85.5 58.5,-85.5 58.5,-79.5 64.5,-73.5 70.5,-73.5"/>
+<text text-anchor="start" x="70.5" y="-88.5" font-family="ArialMT" font-size="10.00">Post#1</text>
+</g>
+<!-- Category#1&#45;&gt;Post#1 -->
+<g id="edge1" class="edge">
+<title>Category#1&#45;&gt;Post#1</title>
+<path fill="none" stroke="black" d="M52.19,-138.87C57.3,-131.76 62.87,-124 67.97,-116.91"/>
+<polygon fill="black" stroke="black" points="49.54,-137.17 46.85,-146.31 54.65,-140.84 49.54,-137.17"/>
+<polygon fill="black" stroke="black" points="70.58,-118.68 73.27,-109.53 65.46,-115 70.58,-118.68"/>
+</g>
+<!-- Post#2 -->
+<g id="node5" class="node">
+<title>Post#2</title>
+<path fill="none" stroke="black" d="M153.5,-73.5C153.5,-73.5 183.5,-73.5 183.5,-73.5 189.5,-73.5 195.5,-79.5 195.5,-85.5 195.5,-85.5 195.5,-97.5 195.5,-97.5 195.5,-103.5 189.5,-109.5 183.5,-109.5 183.5,-109.5 153.5,-109.5 153.5,-109.5 147.5,-109.5 141.5,-103.5 141.5,-97.5 141.5,-97.5 141.5,-85.5 141.5,-85.5 141.5,-79.5 147.5,-73.5 153.5,-73.5"/>
+<text text-anchor="start" x="153.5" y="-88.5" font-family="ArialMT" font-size="10.00">Post#2</text>
+</g>
+<!-- Category#1&#45;&gt;Post#2 -->
+<g id="edge2" class="edge">
+<title>Category#1&#45;&gt;Post#2</title>
+<path fill="none" stroke="black" d="M74.6,-142.26C93.24,-132.38 115.22,-120.73 133.22,-111.19"/>
+<polygon fill="black" stroke="black" points="73.07,-139.5 66.6,-146.49 76.02,-145.06 73.07,-139.5"/>
+<polygon fill="black" stroke="black" points="134.71,-113.97 141.19,-106.97 131.76,-108.4 134.71,-113.97"/>
+</g>
+<!-- Category#2 -->
+<g id="node2" class="node">
+<title>Category#2</title>
+<path fill="none" stroke="black" d="M146,-0.5C146,-0.5 191,-0.5 191,-0.5 197,-0.5 203,-6.5 203,-12.5 203,-12.5 203,-24.5 203,-24.5 203,-30.5 197,-36.5 191,-36.5 191,-36.5 146,-36.5 146,-36.5 140,-36.5 134,-30.5 134,-24.5 134,-24.5 134,-12.5 134,-12.5 134,-6.5 140,-0.5 146,-0.5"/>
+<text text-anchor="start" x="143.5" y="-15.5" font-family="ArialMT" font-size="10.00">Category#2</text>
+</g>
+<!-- Author#1 -->
+<g id="node3" class="node">
+<title>Author#1</title>
+<path fill="none" stroke="black" d="M110.5,-146.5C110.5,-146.5 144.5,-146.5 144.5,-146.5 150.5,-146.5 156.5,-152.5 156.5,-158.5 156.5,-158.5 156.5,-170.5 156.5,-170.5 156.5,-176.5 150.5,-182.5 144.5,-182.5 144.5,-182.5 110.5,-182.5 110.5,-182.5 104.5,-182.5 98.5,-176.5 98.5,-170.5 98.5,-170.5 98.5,-158.5 98.5,-158.5 98.5,-152.5 104.5,-146.5 110.5,-146.5"/>
+<text text-anchor="start" x="107.5" y="-161.5" font-family="ArialMT" font-size="10.00">Author#1</text>
+</g>
+<!-- Author#1&#45;&gt;Post#1 -->
+<g id="edge4" class="edge">
+<title>Author#1&#45;&gt;Post#1</title>
+<path fill="none" stroke="black" d="M112.59,-138.29C106.95,-128.76 100.67,-118.14 95.57,-109.53"/>
+<polygon fill="black" stroke="black" points="110.04,-140.17 117.33,-146.31 115.46,-136.96 110.04,-140.17"/>
+</g>
+<!-- Author#1&#45;&gt;Post#2 -->
+<g id="edge5" class="edge">
+<title>Author#1&#45;&gt;Post#2</title>
+<path fill="none" stroke="black" d="M142.06,-138.29C147.56,-128.76 153.69,-118.14 158.67,-109.53"/>
+<polygon fill="black" stroke="black" points="139.2,-136.94 137.42,-146.31 144.65,-140.09 139.2,-136.94"/>
+</g>
+<!-- Post#2&#45;&gt;Category#2 -->
+<g id="edge8" class="edge">
+<title>Post#2&#45;&gt;Category#2</title>
+<path fill="none" stroke="black" d="M168.5,-64.13C168.5,-58.07 168.5,-51.64 168.5,-45.59"/>
+<polygon fill="black" stroke="black" points="165.35,-64.31 168.5,-73.31 171.65,-64.31 165.35,-64.31"/>
+<polygon fill="black" stroke="black" points="171.65,-45.53 168.5,-36.53 165.35,-45.53 171.65,-45.53"/>
+</g>
+<!-- Blog#1 -->
+<g id="node6" class="node">
+<title>Blog#1</title>
+<path fill="none" stroke="black" d="M197.5,-146.5C197.5,-146.5 227.5,-146.5 227.5,-146.5 233.5,-146.5 239.5,-152.5 239.5,-158.5 239.5,-158.5 239.5,-170.5 239.5,-170.5 239.5,-176.5 233.5,-182.5 227.5,-182.5 227.5,-182.5 197.5,-182.5 197.5,-182.5 191.5,-182.5 185.5,-176.5 185.5,-170.5 185.5,-170.5 185.5,-158.5 185.5,-158.5 185.5,-152.5 191.5,-146.5 197.5,-146.5"/>
+<text text-anchor="start" x="197.5" y="-161.5" font-family="ArialMT" font-size="10.00">Blog#1</text>
+</g>
+<!-- Blog#1&#45;&gt;Post#1 -->
+<g id="edge9" class="edge">
+<title>Blog#1&#45;&gt;Post#1</title>
+<path fill="none" stroke="black" d="M177.14,-143.73C156.75,-132.33 131.52,-118.23 112.7,-107.71"/>
+<polygon fill="black" stroke="black" points="175.86,-146.63 185.26,-148.27 178.94,-141.13 175.86,-146.63"/>
+</g>
+<!-- Blog#1&#45;&gt;Post#2 -->
+<g id="edge10" class="edge">
+<title>Blog#1&#45;&gt;Post#2</title>
+<path fill="none" stroke="black" d="M197.06,-138.58C191.1,-128.97 184.44,-118.23 179.05,-109.53"/>
+<polygon fill="black" stroke="black" points="194.43,-140.32 201.85,-146.31 199.79,-137 194.43,-140.32"/>
+</g>
+</g>
+</svg>

data/lib/snapbot/diagram/dot_generator.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "snapbot/reflector"
-require "snapbot/diagram/dot_generator/relationship"
 
 if defined?(::RSpec)
   require "snapbot/rspec/lets"
@@ -13,15 +12,17 @@ module Snapbot
     # Get a visual handle on what small constellations of objects we're creating
     # in specs
     class DotGenerator
-      def initialize(label: "g", attrs: false, ignore_lets: %i[])
+      def initialize(label: "g", attrs: false, ignore_lets: %i[], rspec: false)
         @label = label
         @options = { attrs: attrs }
         @ignore_lets = ignore_lets
 
-        return unless defined?(::RSpec)
-
-        example = binding.of_caller(1).eval("self")
-        collect_lets(example)
+        @lets_by_value = if rspec
+                           example = binding.of_caller(1).eval("self")
+                           collect_lets(example)
+                         else
+                           {}
+                         end
       end
 
       def dot
@@ -38,7 +39,7 @@ module Snapbot
       end
 
       def collect_lets(example)
-        @lets_by_value = RSpec::Lets.new(example).collect.each_with_object({}) do |sym, lets_by_value|
+        RSpec::Lets.new(example).collect.each_with_object({}) do |sym, lets_by_value|
           value = example.send(sym) unless @ignore_lets.include?(sym)
           lets_by_value[value] = sym if value.is_a?(reflector.base_activerecord_class)
         end
@@ -70,7 +71,7 @@ module Snapbot
               label=<
                 <table border="0" cellborder="0">
                   <%- if @lets_by_value[instance] -%>
-                  <tr><td fontsize="8"><font face="Monaco" point-size="8">let(:<%= @lets_by_value[instance] %>)</font></td></tr>
+                  <tr><td><font face="Monaco,Courier,monospace" point-size="8">let(:<%= @lets_by_value[instance] %>)</font></td></tr>
                   <%- end -%>
                   <tr><td><%= instance_name(instance) %></td></tr>
                 </table>
@@ -79,9 +80,11 @@ module Snapbot
                 <table border="0" cellborder="0">
                   <%- attributes(instance).each_pair do |attr, value| -%>
                   <tr>
-                    <td align="left" width="200" port="<%= attr %>">
+                    <td align="left" port="<%= attr %>">
                       <%= attr %>
-                      <font face="Arial BoldMT" color="grey60"><%= value.inspect %></font>
+                    </td>
+                    <td align="left">
+                      <font color="grey50"><%= value.inspect %></font>
                     </td>
                   </tr>
                   <%- end -%>

data/lib/snapbot/diagram.rb

@@ -2,27 +2,29 @@
 
 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)
+      args.reverse_merge!(rspec: !!defined?(RSpec))
       dot = DotGenerator.new(**args).dot
       filename = Renderer.new(dot).save
 
-      unless open_command.present?
-        warn "No `open` command available. File saved to #{filename}"
+      unless launchy_present?
+        warn "Cannot open diagram – install `launchy`. File saved to #{filename}"
         return
       end
 
-      _stdout, stderr, status = Open3.capture3("#{open_command} #{filename}")
-      raise stderr unless status.exitstatus.zero?
+      Launchy.open(Renderer::OUTPUT_FILENAME)
     end
 
-    def open_command
-      `which open`.chomp
+    def launchy_present?
+      require "launchy"
+      true
+    rescue LoadError
+      false
     end
   end
 end

data/lib/snapbot/reflector.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_record"
+require "snapbot/reflector/relationship"
 
 module Snapbot
   # Reflect models and instances in a way that's useful for generating a diagram
@@ -25,7 +26,7 @@ module Snapbot
       /^ActiveRecord::SchemaMigration$/
     ].freeze
     def activerecord_ignore?(klass)
-      ACTIVERECORD_IGNORE.any? { |r| klass.name =~ r }
+      ACTIVERECORD_IGNORE.any? { |r| klass.name =~ r } || klass.abstract_class
     end
 
     def instances

data/lib/snapbot/version.rb

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

data/lib/tasks/steep.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :steep do
+  desc "Run `steep check`"
+  task :check do
+    system("steep check", exception: true)
+  end
+end

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

@@ -0,0 +1,25 @@
+module Snapbot
+  module Diagram
+    # Get a visual handle on what small constellations of objects we're creating
+    # in specs
+    class DotGenerator
+      def initialize: (?label: ::String, ?attrs: bool, ?ignore_lets: Array[Symbol], ?rspec: bool) -> void
+      def dot: () -> ::String
+
+      @label: String
+      @attrs: bool
+      @ignore_lets: Array[Symbol]
+
+      @options: Hash[Object, Object]
+      @lets_by_value: Hash[Object, Symbol]
+      @reflector: Reflector
+
+      private
+
+      def reflector: () -> Reflector
+      def collect_lets: (::RSpec::Core::ExampleGroup example) -> untyped
+      def instance_name: (ActiveRecord::Base `instance`) -> ::String
+      def template: () -> ::String
+    end
+  end
+end

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

@@ -0,0 +1,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"
+
+      @dot: String
+
+      def initialize: (String dot) -> void
+      def save: () -> String
+
+      private
+
+      def graphviz_executable: () -> ::String
+      def ensure_graphviz: () -> void
+    end
+  end
+end

data/sig/lib/snapbot/diagram.rbs

@@ -0,0 +1,9 @@
+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 open_command: () -> untyped
+  end
+end

data/sig/lib/snapbot/reflector/relationship.rbs

@@ -0,0 +1,14 @@
+module Snapbot
+  class Reflector
+    # A source/destination-based relationship
+    class Relationship
+      attr_accessor source: ::String
+
+      attr_accessor destination: ::String
+
+      def initialize: (::String source, ::String destination) -> void
+
+      def ==: (Relationship other) -> bool
+    end
+  end
+end

data/sig/lib/snapbot/reflector.rbs

@@ -0,0 +1,38 @@
+module ActiveRecord
+  class Base
+  end
+
+  module Reflection
+    class AssociationReflection
+      def name: () -> Symbol
+    end
+  end
+end
+
+module Snapbot
+  # Reflect models and instances in a way that's useful for generating a diagram
+  class Reflector
+    ACTIVERECORD_IGNORE: ::Array[::Regexp]
+
+    @models: Array[Class]
+    @instances: Array[ActiveRecord::Base]
+    @relationships: Set[Relationship]
+
+    def base_activerecord_class: () -> Class
+    def models: (?only_with_records: bool) -> Array[Class]
+    def activerecord_ignore?: (Class klass) -> bool
+    def instances: () -> Array[ActiveRecord::Base]
+
+    # A Set of relationships to other identified entities
+    def relationships: () -> Set[Relationship]
+    def add_relationships: (ActiveRecord::Base `instance`, Set[Relationship] set) -> untyped
+    def reflect_associations: (ActiveRecord::Base `instance`) -> Array[ActiveRecord::Reflection::AssociationReflection]
+    def attributes: (ActiveRecord::Base `instance`) -> Hash[Symbol, Object]
+
+    private
+
+    def instance_name: (ActiveRecord::Base `instance`) -> ::String
+    # Remains commented out, as is private, and https://github.com/ruby/rbs/issues/734#issuecomment-1192607498
+    # def escape_hash: (Hash[Symbol, Object] hash) -> untyped
+  end
+end

data/sig/lib/snapbot/rspec/lets.rbs

@@ -0,0 +1,25 @@
+module RSpec
+  module Core
+    class ExampleGroup
+    end
+  end
+end
+
+module Snapbot
+  module RSpec
+    # Collect RSpec `let`s for a given example and all her parents
+    class Lets
+      @lets: Array[Symbol]
+      @lets_by_value: Hash[Object, Symbol]
+      @example: ::RSpec::Core::ExampleGroup
+
+      def initialize: (::RSpec::Core::ExampleGroup example) -> void
+
+      def collect: () -> Array[Symbol]
+
+      private
+
+      def _collect: (::RSpec::Core::ExampleGroup klass, Array[Symbol] lets) -> Array[Symbol]
+    end
+  end
+end

data/snapbot.gemspec

@@ -35,7 +35,10 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activerecord", version_string
   spec.add_runtime_dependency "activesupport", version_string
 
+  spec.add_development_dependency "launchy"
+  spec.add_development_dependency "rbs"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "steep"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapbot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Russell Garner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - rgarner@zephyros-systems.co.uk
@@ -95,14 +137,24 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
+- docs/img/models-with-lets.svg
+- docs/img/models.svg
 - lib/snapbot.rb
 - 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/reflector/relationship.rb
 - lib/snapbot/rspec/lets.rb
 - lib/snapbot/version.rb
+- lib/tasks/steep.rake
+- sig/lib/snapbot/diagram.rbs
+- sig/lib/snapbot/diagram/dot_generator.rbs
+- sig/lib/snapbot/diagram/renderer.rbs
+- sig/lib/snapbot/reflector.rbs
+- sig/lib/snapbot/reflector/relationship.rbs
+- sig/lib/snapbot/rspec/lets.rbs
 - sig/snapbot.rbs
 - snapbot.gemspec
 homepage: https://github.com/rgarner/snapbot