rigor-module-graph 0.1.0

data/lib/rigor/module_graph/zeitwerk_resolver.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Rigor
+  module ModuleGraph
+    # Converts a Ruby source path into the fully-qualified constant
+    # the Zeitwerk convention says it should define.
+    #
+    # Pure function, no I/O. The plugin instantiates one per run from
+    # `.rigor.yml` config and asks for `resolve(path)` per file. Two
+    # configuration knobs:
+    #
+    # - `autoload_paths`: roots stripped from the path before
+    #   camelising. Defaults to the standard Rails layout.
+    # - `concern_dirs`: directories that act as transparent
+    #   namespaces under Zeitwerk (`app/models/concerns/auditable.rb`
+    #   resolves to `Auditable`, not `Concerns::Auditable`).
+    #
+    # The resolver is order-sensitive: longer / more specific roots
+    # MUST be tried before their parents so `app/models/concerns/foo.rb`
+    # picks up the concern root, not `app/models`. We sort by length
+    # descending at construction time, so config order does not matter.
+    class ZeitwerkResolver
+      DEFAULT_AUTOLOAD_PATHS = %w[
+        app/models
+        app/controllers
+        app/services
+        app/jobs
+        app/mailers
+        app/helpers
+        app/channels
+        app/workers
+        lib
+      ].freeze
+
+      DEFAULT_CONCERN_DIRS = %w[
+        app/models/concerns
+        app/controllers/concerns
+      ].freeze
+
+      attr_reader :autoload_paths, :concern_dirs
+
+      def initialize(autoload_paths: DEFAULT_AUTOLOAD_PATHS,
+                     concern_dirs: DEFAULT_CONCERN_DIRS,
+                     project_root: nil)
+        @project_root = project_root && File.expand_path(project_root)
+        @autoload_paths = normalise_roots(autoload_paths)
+        @concern_dirs = normalise_roots(concern_dirs)
+        @sorted_roots = (@concern_dirs + @autoload_paths).sort_by { |r| -r.length }.uniq
+      end
+
+      # @param path [String] either relative to the project root or
+      #   absolute. Both `app/models/billing/invoice.rb` and the
+      #   `realpath` form work.
+      # @return [String, nil] the inferred constant name, or nil when
+      #   the path is not under any configured root or has no .rb
+      #   extension.
+      def resolve(path)
+        return nil unless path
+
+        rel = relativise(path)
+        return nil unless rel
+        return nil unless rel.end_with?(".rb")
+
+        root = @sorted_roots.find { |r| rel.start_with?(r + "/") }
+        return nil unless root
+
+        suffix = rel[(root.length + 1)..]
+        camelise_path(suffix.delete_suffix(".rb"))
+      end
+
+      # True when `inferred` matches the (probably syntax-derived)
+      # `actual` constant under Zeitwerk's conventions. We compare
+      # ignoring leading "::" since absolute / relative are not a
+      # meaningful distinction here.
+      def matches?(actual, inferred)
+        return false if actual.nil? || inferred.nil?
+
+        strip_leading(actual) == strip_leading(inferred)
+      end
+
+      def relativise(path)
+        absolute = File.expand_path(path)
+        if @project_root && absolute.start_with?(@project_root + "/")
+          absolute[(@project_root.length + 1)..]
+        elsif path.start_with?("/")
+          # Absolute path with no project root configured: try every
+          # autoload root as a suffix match. Used by integration runs
+          # where files live in a tmpdir.
+          suffix = @sorted_roots.find { |r| absolute.include?("/" + r + "/") }
+          if suffix
+            idx = absolute.rindex("/" + suffix + "/")
+            absolute[(idx + 1)..]
+          end
+        else
+          path
+        end
+      end
+
+      def normalise_roots(roots)
+        Array(roots).map { |r| r.to_s.sub(%r{/+\z}, "") }.reject(&:empty?).freeze
+      end
+
+      def strip_leading(name)
+        name.sub(/\A::/, "")
+      end
+
+      def camelise_path(rel_no_ext)
+        rel_no_ext.split("/").map { |seg| camelise_segment(seg) }.join("::")
+      end
+
+      def camelise_segment(segment)
+        segment.split("_").map(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/rigor-module-graph.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# == rigor-module-graph
+#
+# Class/module/constant dependency graph for Ruby projects, built
+# on Rigor[https://rigor.typedduck.fail/]. Loading this file pulls
+# in every public piece of the gem: the Edge value type, the
+# Analyzer, the renderers (Dot/Mermaid/CycleDetector), and — when
+# +Rigor::Plugin::Base+ is already defined — the Rigor plugin that
+# wires the node rules.
+#
+# Most users interact with this gem through the +rigor-module-graph+
+# command-line wrapper (see Rigor::ModuleGraph::CLI), not by
+# requiring it directly.
+
+require_relative "rigor/module_graph/version"
+require_relative "rigor/module_graph/edge"
+require_relative "rigor/module_graph/node"
+require_relative "rigor/module_graph/constant_name"
+require_relative "rigor/module_graph/zeitwerk_resolver"
+require_relative "rigor/module_graph/inflector"
+require_relative "rigor/module_graph/visibility_map"
+require_relative "rigor/module_graph/analyzer"
+require_relative "rigor/module_graph/dot"
+require_relative "rigor/module_graph/mermaid"
+require_relative "rigor/module_graph/cycle_detector"
+require_relative "rigor/module_graph/reachability"
+require_relative "rigor/module_graph/stats"
+require_relative "rigor/module_graph/packwerk_overlay"
+require_relative "rigor/module_graph/uml/class_diagram"
+require_relative "rigor/module_graph/html_view"
+require_relative "rigor/module_graph/plugin"

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rigor-module-graph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nozomi Hijikata
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rigortype
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |
+  Rigor plugin and CLI that extract Ruby class/module/constant dependencies
+  (inheritance, include/prepend/extend, constant references) and emit
+  Graphviz DOT, SVG, and Mermaid output. The class/module-level
+  counterpart to Packwerk/Graphwerk.
+email:
+- b8yukifsukeo999n@gmail.com
+executables:
+- rigor-module-graph
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/rigor-module-graph
+- lib/rigor-module-graph.rb
+- lib/rigor/module_graph/analyzer.rb
+- lib/rigor/module_graph/cli.rb
+- lib/rigor/module_graph/constant_name.rb
+- lib/rigor/module_graph/cycle_detector.rb
+- lib/rigor/module_graph/dot.rb
+- lib/rigor/module_graph/edge.rb
+- lib/rigor/module_graph/html_view.rb
+- lib/rigor/module_graph/inflector.rb
+- lib/rigor/module_graph/mermaid.rb
+- lib/rigor/module_graph/node.rb
+- lib/rigor/module_graph/packwerk_overlay.rb
+- lib/rigor/module_graph/plugin.rb
+- lib/rigor/module_graph/plugin/rigor_plugin.rb
+- lib/rigor/module_graph/reachability.rb
+- lib/rigor/module_graph/stats.rb
+- lib/rigor/module_graph/templates/view.html.erb
+- lib/rigor/module_graph/uml/class_diagram.rb
+- lib/rigor/module_graph/version.rb
+- lib/rigor/module_graph/visibility_map.rb
+- lib/rigor/module_graph/zeitwerk_resolver.rb
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://rubydoc.info/gems/rigor-module-graph
+  changelog_uri: https://github.com/nozomemein/rigor-module-graph/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/nozomemein/rigor-module-graph
+  bug_tracker_uri: https://github.com/nozomemein/rigor-module-graph/issues
+  homepage_uri: https://github.com/nozomemein/rigor-module-graph
+  rubygems_mfa_required: 'true'
+rdoc_options:
+- "--main"
+- README.md
+- "--markup"
+- rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 4.0.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Class/module/constant dependency graph for Ruby projects, built on Rigor.
+test_files: []