snapbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ff9b478fc49144d2edf97c515e52f946b3f73a0d939e0de6d9789e6ab207a1b
+  data.tar.gz: 3d10ece40e5e1e2dfc67f8552746f6c2f326b54d0977a2a39764f1ba008a9a97
+SHA512:
+  metadata.gz: dff17039b7af000c3d9a6fb17ba2fc21af8da0a0ab3a72a9b2af098f8b0e06b7c5b3a3230b547d78886f5e9bd320c9c30f2095fdb9e55ee5c892488be5c04e6b
+  data.tar.gz: 578806b5e7c84b72691ebad4069ac39a51c0fcd04b79b62282fbb57fbf096dc88e29e8c23d801e1ed230a8925dc4b004d1c80b80520d7eb3ece9caf612e208e3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+    - snapbot.gemspec
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rgarner@zephyros-systems.co.uk. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in snapbot.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Russell Garner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Snapbot
+
+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).
+
+## Installation
+
+Either `gem install snapbot` or add the gem to your project's `:test` group in the gemfile:
+
+```ruby 
+  group :test do 
+    gem 'snapbot' 
+  end 
+```
+
+Add to your tests:
+
+```
+  include Snapbot::Diagram
+```
+
+Use:
+
+```
+  blog = Blog.create(title: 'My blog')
+  post = Post.create(title: 'My post', blog: blog)
+  
+  save_and_open_diagram
+```
+
+## Why?
+
+Sometimes, you need to create a few ActiveRecord objects for your test suite. Sometimes, there will be a little cluster
+of objects that need to exist for an integration spec or feature spec to run reliably. And sometimes, it will be 4.30pm
+and your fixtures or FactoryBot factories feel like they're slipping from what you can reasonably hold in your head.
+
+We don't all write tests like this. Or rather, not all our tests are like this. But when they are, 
+`save_and_open_diagram` is a quick way to see what's what.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rgarner/snapbot. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of
+conduct](https://github.com/rgarner/snapbot/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Snapbot project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/rgarner/snapbot/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/snapbot/diagram/dot_generator/relationship.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Snapbot
+  class Reflector
+    # A source/destination-based relationship
+    class Relationship
+      attr_accessor :source, :destination
+
+      def initialize(source, destination)
+        self.source = source
+        self.destination = destination
+      end
+
+      def equals(other)
+        source == other.source && destination == other.destination
+      end
+    end
+  end
+end

data/lib/snapbot/diagram/dot_generator.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "snapbot/reflector"
+require "snapbot/diagram/dot_generator/relationship"
+
+if defined?(::RSpec)
+  require "snapbot/rspec/lets"
+  require "binding_of_caller"
+end
+
+module Snapbot
+  module Diagram
+    # 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[])
+        @label = label
+        @options = { attrs: attrs }
+        @ignore_lets = ignore_lets
+
+        return unless defined?(::RSpec)
+
+        example = binding.of_caller(1).eval("self")
+        collect_lets(example)
+      end
+
+      def dot
+        renderer = ERB.new(template, trim_mode: "-")
+        renderer.result(self.binding)
+      end
+
+      private
+
+      delegate :instances, :relationships, :attributes, to: :reflector
+
+      def reflector
+        @reflector ||= Reflector.new
+      end
+
+      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)
+        end
+      end
+
+      def instance_name(instance)
+        "#{instance.model_name}##{instance.id}"
+      end
+
+      def template
+        <<~ERB
+          digraph "<%= @label %>" {
+            rankdir = "LR";
+            ranksep = "0.5";
+            nodesep = "0.4";
+            pad = "0.4,0.4";
+            margin = "0,0";
+            concentrate = "true";
+            labelloc = "t";
+            fontsize = "13";
+            fontname = "Arial BoldMT";
+            splines = "spline";
+            node[ shape  =  "Mrecord" , fontsize  =  "10" , fontname  =  "ArialMT" , margin  =  "0.07,0.05" , penwidth  =  "1.0"];
+            edge[ fontname  =  "ArialMT" , fontsize  =  "7" , dir  =  "both" , arrowsize  =  "0.9" , penwidth  =  "1.0" , labelangle  =  "32" , labeldistance  =  "1.8"];
+            rankdir = "TB";
+            splines = "spline";
+            <%- instances.each do |instance| -%>
+            "<%= instance_name(instance) %>" [
+              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>
+                  <%- end -%>
+                  <tr><td><%= instance_name(instance) %></td></tr>
+                </table>
+                <%- if @options[:attrs] -%>
+                |
+                <table border="0" cellborder="0">
+                  <%- attributes(instance).each_pair do |attr, value| -%>
+                  <tr>
+                    <td align="left" width="200" port="<%= attr %>">
+                      <%= attr %>
+                      <font face="Arial BoldMT" color="grey60"><%= value.inspect %></font>
+                    </td>
+                  </tr>
+                  <%- end -%>
+                </table>
+                <%- end -%>
+              >
+            ];
+            <% end %>
+            <%- relationships.each do |relationship| -%>
+            "<%= relationship.source %>" -> "<%= relationship.destination %>" [arrowhead = "none", arrowtail = "normal", weight = "6"];
+            <%- end -%>
+          }
+        ERB
+      end
+    end
+  end
+end

data/lib/snapbot/diagram.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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
+    end
+  end
+end

data/lib/snapbot/reflector.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+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 models(only_with_records: true)
+      @models ||= begin
+        Rails.application.eager_load! if defined?(Rails)
+        BASE_ACTIVERECORD_CLASS.descendants.reject do |c|
+          c.to_s == "Schema" || (only_with_records && c.count.zero?)
+        end
+      end
+    end
+
+    def instances
+      @instances ||= models.each_with_object([]) do |klass, array|
+        array << klass.all
+      end.flatten
+    end
+
+    # A Set of relationships to other identified entities
+    def relationships
+      @relationships ||= instances.each_with_object(Set.new) do |instance, set|
+        add_relationships(instance, set)
+      end
+    end
+
+    def add_relationships(instance, set)
+      reflect_associations(instance).each do |association|
+        records = Array(instance.send(association.name)).compact
+        records.each do |record|
+          set.add(Relationship.new(instance_name(instance), instance_name(record)))
+        end
+      end
+    end
+
+    def reflect_associations(instance)
+      (
+        instance.class.reflect_on_all_associations(:has_many).reject { |a| a.name == :schemas } +
+          instance.class.reflect_on_all_associations(:has_one)
+      ).flatten
+    end
+
+    def attributes(instance)
+      instance.attributes.to_h.transform_values { |v| v.is_a?(Hash) ? escape_hash(v) : v }
+    end
+
+    private
+
+    def instance_name(instance)
+      "#{instance.model_name}##{instance.id}"
+    end
+
+    def escape_hash(hash)
+      hash.each_with_object([]) do |(key, value), array|
+        array << "#{key}: #{value.nil? ? "nil" : value}"
+      end.join(", ")
+    end
+  end
+end

data/lib/snapbot/rspec/lets.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Snapbot
+  module RSpec
+    # Collect RSpec `let`s for a given example and all her parents
+    class Lets
+      def initialize(example)
+        @example = example
+      end
+
+      def collect
+        _collect(@example.class, [])
+      end
+
+      private
+
+      def _collect(klass, lets)
+        lets.tap do
+          next if klass.to_s == "RSpec::ExampleGroups"
+
+          lets.concat(klass::LetDefinitions.instance_methods(false))
+          parent_class = klass.to_s.deconstantize.constantize
+
+          _collect(parent_class, lets)
+        end
+      end
+    end
+  end
+end

data/lib/snapbot/version.rb

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

data/lib/snapbot.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "snapbot/version"
+require "snapbot/diagram"
+
+module Snapbot
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/snapbot.rbs

@@ -0,0 +1,4 @@
+module Snapbot
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/snapbot.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/snapbot/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "snapbot"
+  spec.version = Snapbot::VERSION
+  spec.authors = ["Russell Garner"]
+  spec.email = ["rgarner@zephyros-systems.co.uk"]
+
+  spec.summary = "A `save_and_open_diagram` tool to visualise ActiveRecord test records"
+  spec.homepage = "https://github.com/rgarner/snapbot"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rgarner/snapbot"
+  spec.metadata["changelog_uri"] = "https://github.com/rgarner/snapbot/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "binding_of_caller", "~> 1.0"
+
+  version_string = [">= 6.1"]
+  spec.add_runtime_dependency "actionpack", version_string
+  spec.add_runtime_dependency "activerecord", version_string
+  spec.add_runtime_dependency "activesupport", version_string
+
+  spec.add_development_dependency "sqlite3"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: snapbot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Russell Garner
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/snapbot.rb
+- lib/snapbot/diagram.rb
+- lib/snapbot/diagram/dot_generator.rb
+- lib/snapbot/diagram/dot_generator/relationship.rb
+- lib/snapbot/reflector.rb
+- lib/snapbot/rspec/lets.rb
+- lib/snapbot/version.rb
+- sig/snapbot.rbs
+- snapbot.gemspec
+homepage: https://github.com/rgarner/snapbot
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rgarner/snapbot
+  source_code_uri: https://github.com/rgarner/snapbot
+  changelog_uri: https://github.com/rgarner/snapbot/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A `save_and_open_diagram` tool to visualise ActiveRecord test records
+test_files: []