snapbot 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ff9b478fc49144d2edf97c515e52f946b3f73a0d939e0de6d9789e6ab207a1b
-  data.tar.gz: 3d10ece40e5e1e2dfc67f8552746f6c2f326b54d0977a2a39764f1ba008a9a97
+  metadata.gz: bb58059025b35d29e5d762be3719f21461f225a2950c51efe54161009b1412ca
+  data.tar.gz: a08b6fe2a72289b2946ac7461920863a7226a9d24b12a24d3b23dbe1f2ca00dd
 SHA512:
-  metadata.gz: dff17039b7af000c3d9a6fb17ba2fc21af8da0a0ab3a72a9b2af098f8b0e06b7c5b3a3230b547d78886f5e9bd320c9c30f2095fdb9e55ee5c892488be5c04e6b
-  data.tar.gz: 578806b5e7c84b72691ebad4069ac39a51c0fcd04b79b62282fbb57fbf096dc88e29e8c23d801e1ed230a8925dc4b004d1c80b80520d7eb3ece9caf612e208e3
+  metadata.gz: 31970a0125ab31512d051b4a8dac26e324fa556dd6ccfdffa1a83dc8bc9b6a962f5423150bcc634c45420cc59e12258b3d034b1210765b7c63cbba033b8a3277
+  data.tar.gz: 530cebe2837a43ea3a9bddcdb63ed3bdda8666d3a2dd05cb79926e3d6f9c5b3c41da750e8d5dfc6c67fa3784c4f1c672b4620c0e2d135a1825bf87b1182b76fa

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/dot_generator.rb

@@ -40,7 +40,7 @@ module Snapbot
       def collect_lets(example)
         @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)
+          lets_by_value[value] = sym if value.is_a?(reflector.base_activerecord_class)
         end
       end
 

data/lib/snapbot/diagram/renderer.rb

@@ -0,0 +1,45 @@
+# 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)
+        FileUtils.mkdir_p(File.dirname(OUTPUT_FILENAME))
+
+        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/reflector.rb

@@ -5,12 +5,14 @@ require "active_record"
 module Snapbot
   # Reflect models and instances in a way that's useful for generating a diagram
   class Reflector
-    BASE_ACTIVERECORD_CLASS = defined?(ApplicationRecord) ? ApplicationRecord : ActiveRecord::Base
+    def base_activerecord_class
+      defined?(ApplicationRecord) ? ApplicationRecord : ActiveRecord::Base
+    end
 
     def models(only_with_records: true)
       @models ||= begin
         Rails.application.eager_load! if defined?(Rails)
-        BASE_ACTIVERECORD_CLASS.descendants.reject do |c|
+        base_activerecord_class.descendants.reject do |c|
           c.to_s == "Schema" || (only_with_records && c.count.zero?)
         end
       end

data/lib/snapbot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 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