snapbot 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb7768e6e3ac46cacf84d569a0d8026062418160d39c5ae1e214875ac0f4b26d
-  data.tar.gz: 50467bc231c453c7c81129181f90c21759f5acb2f121fbaf07bfd5313dcaea80
+  metadata.gz: 7f8b1c94c13ad202a7a33eb020d8aa4c6fc66b3123a08f0f210c13a2b91598c3
+  data.tar.gz: 54ade2525a1d3f0497c4148610488b350bacc2c2860ed7e6969d5fb237cce0f9
 SHA512:
-  metadata.gz: 0331b6031f3fe4e3ee09aef66a1030bfec968f5df8c7308c2dd09933e0c63cfad55e54dab10e7bf0e9dc568216d34bbd3f8ac32c5bd6e524750ad676fbb49988
-  data.tar.gz: 06757de1f42e455f6b8565661426bba4a94e609d567a5d2a2c6d8cdb8be8e5aed4b16e97334a009d34bda3b400707b2796a9a4b88b507a407b58e1ca8df2a798
+  metadata.gz: 7b4b99a9dd2bf1dea4174ff924eed781818f29707a89b94d3952830ecd59368fbb2632d90c3633414aa175ac03741dcfaa322698160f8e2484d1b1884cdbad5d
+  data.tar.gz: cd76dec5c1fd06383679a1d35b06cd8cd59d17e8c9a676395efbe30065c79b1baa99cad653f6589557243a1ace625050b470b7133843d41663fdc210dfd02fc0

data/.rubocop.yml

@@ -1,6 +1,9 @@
 AllCops:
   TargetRubyVersion: 2.6
   SuggestExtensions: false
+  Exclude:
+    - Steepfile
+
 
 Metrics/AbcSize:
   Exclude:

data/README.md

@@ -1,5 +1,7 @@
 # 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 

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/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"

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.2.1"
 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]) -> 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,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activerecord", version_string
   spec.add_runtime_dependency "activesupport", version_string
 
+  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapbot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Russell Garner
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
+- !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 +94,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 +123,22 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - 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