snapbot 0.2.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bd122996f917b0e18388a91aaeba183028d54a6b5e2fc58c05559f3a5103b6a
-  data.tar.gz: 15ce511a21b7d1dd96553a45959dce0e9ebfb9ad9ba2624d369af615742ec80b
+  metadata.gz: 3ccc2f9565d40b7b3dd10ffd1f92054e7b718eb28613cdc9336531f35a916204
+  data.tar.gz: 661b49c7b72f6a55736a88fcdafc74e249d6d59c8fcbd115b0fcf6c89442ee51
 SHA512:
-  metadata.gz: 34c2e342537c4085fcef8e9ae08e2cde45d8b200e8f7d4e3f369f745ce41ddae3ac5b36a8735c7d568c37427038107e061b9525372f8cc6c9be21ab2d4ad6f20
-  data.tar.gz: 4fbe87ef32e963c62eb44fe5f54e26901f7dd33e0c1ca048d962a066a0bb9de2abb5516ccc24b20c84fe8e1f86c435b27c04d2bb85b2ddf30b06efd367d30dba
+  metadata.gz: d19d016d55b593f14106933bb66926d5d9b18b1b986deabfd644ab7f5c27dddb33cfe1ed6ef50952aea72d833eda570937ae6dac1be41d7519c06f403cba64d2
+  data.tar.gz: 22416a76acec3531aa6487de788068c919e69023d9569237daa7990f3db088fe853a3c0a2594632b0edab29a9ea6013921a5379c24878bc6fd8f3d3e89cf04c1

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

@@ -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

@@ -1,29 +1,27 @@
 # 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"
+      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

@@ -2,28 +2,33 @@
 
 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
+    def save_and_open_diagram(path = Renderer::DEFAULT_OUTPUT_FILENAME, **args)
+      filename = save_diagram(path, **args)
 
-      unless open_command.present?
-        warn "No `open` command available. File saved to #{filename}"
+      unless launchy_present?
+        warn "Cannot open diagram – install `launchy`."
         return
       end
 
-      _stdout, stderr, status = Open3.capture3("#{open_command} #{filename}")
-      raise stderr unless status.exitstatus.zero?
+      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 open_command
-      `which open`.chomp
+    def launchy_present?
+      require "launchy"
+      true
+    rescue LoadError
+      false
     end
   end
 end

data/lib/snapbot/reflector.rb

@@ -44,6 +44,8 @@ module Snapbot
 
     def add_relationships(instance, set)
       reflect_associations(instance).each do |association|
+        next unless valid_association?(association) # Skip POROs
+
         records = Array(instance.send(association.name)).compact
         records.each do |record|
           set.add(Relationship.new(instance_name(instance), instance_name(record)))
@@ -65,6 +67,18 @@ module Snapbot
 
     private
 
+    # rubocop:disable Style/RescueModifier
+    def valid_association?(association)
+      # AR7.x raises an ArgumentError when the class is a PORO. AR6.x would fall over
+      # later with NoMethodError on `relation_delegate_class`. Either way, we're not
+      # valid if the association.klass is not descended from our `base_activerecord_class`
+      return true if (association.klass rescue ArgumentError) < base_activerecord_class
+
+      warn "#{association.active_record} -> :#{association.name} is not a valid association. " \
+           "Make sure it inherits from #{base_activerecord_class}"
+    end
+    # rubocop:enable Style/RescueModifier
+
     def instance_name(instance)
       "#{instance.model_name}##{instance.id}"
     end

data/lib/snapbot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Snapbot
-  VERSION = "0.2.2"
+  VERSION = "0.4.1"
 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

data/snapbot.gemspec

@@ -35,6 +35,7 @@ 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapbot
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Russell Garner
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 2022-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -66,6 +66,20 @@ 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