blast_radius 0.1.0

data/lib/blast_radius/node.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module BlastRadius
+  class Node
+    attr_reader :model_class, :association_name, :dependent_type,
+                :association_type, :children, :parent, :depth,
+                :through, :polymorphic
+
+    def initialize(model_class, options = {})
+      @model_class = model_class
+      @association_name = options[:association_name]
+      @dependent_type = options[:dependent_type]
+      @association_type = options[:association_type]
+      @through = options[:through]
+      @polymorphic = options[:polymorphic] || false
+      @parent = options[:parent]
+      @depth = options[:depth] || 0
+      @children = []
+    end
+
+    def add_child(child_node)
+      @children << child_node
+    end
+
+    # Check if this node creates a circular reference
+    # @return [Boolean] true if circular reference detected
+    def circular_reference?
+      ancestors.any? { |ancestor| ancestor.model_class == @model_class }
+    end
+
+    # Get all ancestor nodes
+    # @return [Array<Node>] array of ancestor nodes
+    def ancestors
+      return [] unless @parent
+
+      [@parent] + @parent.ancestors
+    end
+
+    # Get model name as string
+    # @return [String] model class name
+    def model_name
+      @model_class.name
+    end
+
+    # Check if this is the root node
+    # @return [Boolean] true if root node
+    def root?
+      @parent.nil?
+    end
+
+    # Check if this is a leaf node
+    # @return [Boolean] true if leaf node
+    def leaf?
+      @children.empty?
+    end
+
+    # Get the path from root to this node
+    # @return [Array<String>] array of model names
+    def path
+      return [model_name] if root?
+
+      @parent.path + [model_name]
+    end
+  end
+end

data/lib/blast_radius/railtie.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module BlastRadius
+  class Railtie < Rails::Railtie
+    railtie_name :blast_radius
+
+    rake_tasks do
+      load 'tasks/blast_radius.rake'
+    end
+
+    # Add ActiveRecord extensions
+    initializer 'blast_radius.active_record' do
+      ActiveSupport.on_load(:active_record) do
+        extend BlastRadius::ActiveRecordExtension::ClassMethods
+        include BlastRadius::ActiveRecordExtension::InstanceMethods
+      end
+    end
+  end
+end

data/lib/blast_radius/version.rb

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

data/lib/blast_radius.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'blast_radius/version'
+require_relative 'blast_radius/configuration'
+require_relative 'blast_radius/analyzer'
+require_relative 'blast_radius/node'
+require_relative 'blast_radius/dependency_tree'
+require_relative 'blast_radius/impact_calculator'
+require_relative 'blast_radius/formatters/base'
+require_relative 'blast_radius/formatters/text_formatter'
+require_relative 'blast_radius/formatters/mermaid_formatter'
+require_relative 'blast_radius/formatters/json_formatter'
+require_relative 'blast_radius/formatters/dot_formatter'
+require_relative 'blast_radius/formatters/html_formatter'
+require_relative 'blast_radius/active_record_extension'
+
+# Load Railtie if Rails is available
+require_relative 'blast_radius/railtie' if defined?(Rails::Railtie)
+
+module BlastRadius
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration
+      @configuration = Configuration.new
+    end
+
+    # Analyze a model class and return dependency tree
+    # @param model_class [Class] ActiveRecord model class
+    # @param options [Hash] options for analysis
+    # @return [Node] root node of dependency tree
+    def analyze(model_class, options = {})
+      tree = DependencyTree.new(configuration)
+      tree.build(model_class, options)
+    end
+  end
+end

data/lib/tasks/blast_radius.rake

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+namespace :blast_radius do
+  desc 'Visualize dependency tree for all models or a specific model'
+  task :visualize, %i[model_name format] => :environment do |_t, args|
+    require 'blast_radius'
+
+    format = (args[:format] || ENV['FORMAT'] || 'text').to_sym
+
+    if args[:model_name]
+      # Visualize specific model
+      begin
+        model_class = args[:model_name].constantize
+        output = model_class.blast_radius(format: format)
+        puts output
+      rescue NameError
+        puts "Error: Model '#{args[:model_name]}' not found"
+        exit 1
+      end
+    else
+      # Visualize all models
+      analyzer = BlastRadius::Analyzer.new
+      models = analyzer.all_models
+
+      puts "Found #{models.size} models:"
+      puts
+
+      models.each do |model|
+        puts "=== #{model.name} ==="
+        output = model.blast_radius(format: format)
+        puts output
+        puts
+      end
+    end
+  end
+
+  desc 'Calculate the impact of deleting a specific record'
+  task :impact, %i[model_name record_id] => :environment do |_t, args|
+    require 'blast_radius'
+
+    unless args[:model_name] && args[:record_id]
+      puts 'Usage: rake blast_radius:impact[ModelName,record_id]'
+      exit 1
+    end
+
+    begin
+      model_class = args[:model_name].constantize
+      record = model_class.find(args[:record_id])
+
+      calculator = BlastRadius::ImpactCalculator.new
+      impact = calculator.dry_run(record)
+
+      puts "Impact of deleting #{model_class.name}##{record.id}:"
+      puts
+
+      if impact.empty?
+        puts 'No dependent records would be affected.'
+      else
+        total_count = impact.values.sum { |v| v[:count] }
+        puts "Total records affected: #{total_count}"
+        puts
+
+        impact.each do |model_name, info|
+          puts "#{model_name}:"
+          puts "  Count: #{info[:count]}"
+          puts "  Dependent type: #{info[:dependent_type]}"
+          puts "  Sample IDs: #{info[:sample_ids].join(', ')}"
+          puts
+        end
+      end
+    rescue NameError
+      puts "Error: Model '#{args[:model_name]}' not found"
+      exit 1
+    rescue ActiveRecord::RecordNotFound
+      puts "Error: #{args[:model_name]}##{args[:record_id]} not found"
+      exit 1
+    end
+  end
+
+  desc 'Generate HTML visualization and save to file'
+  task :html, %i[model_name output_file] => :environment do |_t, args|
+    require 'blast_radius'
+
+    unless args[:model_name]
+      puts 'Usage: rake blast_radius:html[ModelName,output_file]'
+      exit 1
+    end
+
+    output_file = args[:output_file] || 'blast_radius.html'
+
+    begin
+      model_class = args[:model_name].constantize
+      html = model_class.blast_radius(format: :html)
+
+      File.write(output_file, html)
+      puts "HTML visualization saved to: #{output_file}"
+    rescue NameError
+      puts "Error: Model '#{args[:model_name]}' not found"
+      exit 1
+    end
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: blast_radius
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: 'A gem to visualize which records will be deleted due to dependent: :destroy
+  and similar options in ActiveRecord associations'
+email:
+- t.yudai92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/blast_radius.rb
+- lib/blast_radius/active_record_extension.rb
+- lib/blast_radius/analyzer.rb
+- lib/blast_radius/configuration.rb
+- lib/blast_radius/dependency_tree.rb
+- lib/blast_radius/formatters/base.rb
+- lib/blast_radius/formatters/dot_formatter.rb
+- lib/blast_radius/formatters/html_formatter.rb
+- lib/blast_radius/formatters/json_formatter.rb
+- lib/blast_radius/formatters/mermaid_formatter.rb
+- lib/blast_radius/formatters/text_formatter.rb
+- lib/blast_radius/html/graph.js
+- lib/blast_radius/html/styles.css
+- lib/blast_radius/html/template.html.erb
+- lib/blast_radius/impact_calculator.rb
+- lib/blast_radius/node.rb
+- lib/blast_radius/railtie.rb
+- lib/blast_radius/version.rb
+- lib/tasks/blast_radius.rake
+homepage: https://github.com/ydah/blast_radius
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ydah/blast_radius
+  source_code_uri: https://github.com/ydah/blast_radius
+  changelog_uri: https://github.com/ydah/blast_radius/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Visualize the cascade deletion impact in Rails applications
+test_files: []