import_graph 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 643fb90a7e318b156f633d33fbafa2a82fa5e5a0a404cf4642a62bf963f1ecc1
+  data.tar.gz: 0ea777046f633f6a60c71035154f2847328e11248ceb3e0a62942cc1a900a840
+SHA512:
+  metadata.gz: d082363cd9b5ec8f4f28bad1d10a0f3aa3eec220aeccf0598cec6996855481a4376a25f219c6ea659648418efabb5fbf0c0eded700207c5418630bb3422f4609
+  data.tar.gz: cc8196e5d13471e03452044c0dabab5560a41a4b1497365d3177df05530044583065147f0e28be93520498429a9059a4b817ccfea0512d7b75f65c7e4f3fdc97

data/lib/import_graph/dep_graph.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ImportGraph
+  # Source of truth for the dependency graph for the provided directory
+  class DepGraph
+    attr_accessor :graph
+
+    def initialize(graph, dir_path)
+      @graph = graph
+      @dependees = {}
+      @dir_path = dir_path
+    end
+
+    # Get all the files that this file depends on
+    def get_dependent_files(file_path)
+      return nil unless @graph.has_key? file_path
+
+      @graph[file_path]
+    end
+
+    # Get all the files that depend on this file
+    def get_dependee_files(file_path)
+      return @dependees[file_path] if @dependees.has_key? file_path
+
+      @dependees[file_path] = Set.new
+      @graph.keys.each do |key|
+        @dependees[file_path].add key if @graph[key].include? file_path
+      end
+
+      @dependees[file_path]
+    end
+  end
+end

data/lib/import_graph/parser/autoload.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ImportGraph
+  module Parser
+    class Autoload
+      include RuboCop::AST
+      include Util
+
+      AUTOLOAD_PATTERN = NodePattern.new <<~PATTERN
+        (send nil? :autoload (sym ...) (str $_))
+      PATTERN
+
+      def initialize(file_trees)
+        @file_trees = file_trees
+      end
+
+      def parse
+        matches = Set.new
+        @file_trees.keys.each { |file_path| matches.merge(parse_file(file_path)) }
+        matches
+      end
+
+      def parse_file(file_path)
+        matches = Set.new
+        @file_trees[file_path].each_node do |node|
+          match = AUTOLOAD_PATTERN.match node
+          next if match.nil?
+
+          matches.add(build_match_object(:autoload, file_path, match)) unless match.nil?
+        end
+        matches
+      end
+    end
+  end
+end

data/lib/import_graph/parser/load.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ImportGraph
+  module Parser
+    class Load
+      include RuboCop::AST
+      include Util
+
+      LOAD_PATTERN = NodePattern.new <<~PATTERN
+        (send nil? :load (str $_))#{' '}
+      PATTERN
+
+      def initialize(file_trees)
+        @file_trees = file_trees
+      end
+
+      def parse
+        matches = Set.new
+        @file_trees.keys.each { |file_path| matches.merge(parse_file(file_path)) }
+        matches
+      end
+
+      def parse_file(file_path)
+        matches = Set.new
+        @file_trees[file_path].each_node do |node|
+          match = LOAD_PATTERN.match node
+          next if match.nil?
+
+          matches.add(build_match_object(:load, file_path, match)) unless match.nil?
+        end
+        matches
+      end
+    end
+  end
+end

data/lib/import_graph/parser/main.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module ImportGraph
+  module Parser
+    # Main entry point for parsing that coordinates all the parsers
+    class Main
+      include RuboCop::AST
+      include Util
+      attr_reader :file_trees
+
+      # skipcq: RB-LI1087
+      def initialize(dir_path, config)
+        @dir_path = File.expand_path(dir_path)
+        raise ArgumentError, "No such directory #{@dir_path}" unless Dir.exist? @dir_path
+
+        @files_list = Dir.glob(File.join(dir_path, '**', '*.rb'))
+        @files_list = @files_list.map { |path| File.expand_path(path) }
+        @path_manager = PathManager.new(@dir_path)
+
+        @parsers = [RequireRelative, Require, Load, Autoload]
+        @third_party = config[:third_party] || false
+        @file_trees = gen_syntax_trees
+      end
+
+      def parse
+        graph = {}
+        matches = Set.new
+
+        @parsers.each do |parser_klass|
+          parser = parser_klass.new(@file_trees)
+          local_matches = parser.parse
+
+          matches.merge(local_matches)
+        end
+        third_party_graph = {}
+        third_party_graph = ThirdParty.new(@dir_path).parse if @third_party == true
+
+        matches = @path_manager.resolve_paths(matches)
+        matches.each do |match|
+          add_edge(graph, match[:from], match[:to])
+        end
+
+        combine_graphs(graph, third_party_graph)
+        DepGraph.new(graph, @dir_path)
+      end
+
+      def add_edge(graph, from, to)
+        to = cleanup_absolute_path(@dir_path, to) if to.start_with? @dir_path
+        graph[from] = Set.new unless graph.key? from
+
+        graph[from].add to
+      end
+
+      def combine_graphs(main, third_party)
+        return if third_party.empty? || third_party.nil?
+
+        third_party.each_key do |from|
+          third_party[from].each do |to|
+            add_edge(
+              main,
+              cleanup_absolute_path(@dir_path, from),
+              cleanup_absolute_path(@dir_path, to)
+            )
+          end
+        end
+      end
+
+      def gen_syntax_trees
+        file_trees_list =
+          Parallel.map(@files_list) do |file_path|
+            {
+              path: cleanup_absolute_path(@dir_path, file_path),
+              tree:
+                ProcessedSource.new(File.read(file_path), RUBY_VERSION.to_f).ast
+            }
+          end
+
+        file_trees_list.each_with_object({}) do |file_pair, obj|
+          obj[file_pair[:path]] = file_pair[:tree]
+        end
+      end
+    end
+  end
+end

data/lib/import_graph/parser/require.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ImportGraph
+  module Parser
+    class Require
+      include RuboCop::AST
+      include Util
+
+      REQUIRE_PATTERN = NodePattern.new <<~PATTERN
+        (send nil? :require (str $_))
+      PATTERN
+
+      def initialize(file_trees)
+        @file_trees = file_trees
+      end
+
+      def parse
+        matches = Set.new
+        @file_trees.keys.each { |file_path| matches.merge(parse_file(file_path)) }
+        matches
+      end
+
+      def parse_file(file_path)
+        matches = Set.new
+        @file_trees[file_path].each_node do |node|
+          match = REQUIRE_PATTERN.match node
+          next if match.nil?
+
+          matches.add(build_match_object(:require, file_path, match)) unless match.nil?
+        end
+        matches
+      end
+    end
+  end
+end

data/lib/import_graph/parser/require_relative.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ImportGraph
+  module Parser
+    # Parser that tracks all the require_relative calls in the files
+    class RequireRelative
+      include Util
+      include RuboCop::AST
+
+      def initialize(file_trees)
+        @file_trees = file_trees
+      end
+
+      REQUIRE_RELATIVE_PATTERN = NodePattern.new <<~PATTERN
+        (send nil? :require_relative (str $_))
+      PATTERN
+
+      def parse
+        matches = Set.new
+        @file_trees.keys.each { |file_path| matches.merge(parse_file(file_path)) }
+        matches
+      end
+
+      def parse_file(file_path)
+        matches = Set.new
+        @file_trees[file_path].each_node do |node|
+          match = REQUIRE_RELATIVE_PATTERN.match node
+          next if match.nil?
+
+          match_obj = { method: :require_relative, from: file_path, to: match }
+          matches.add build_match_object(:require_relative, file_path, match) unless match.nil?
+        end
+        matches
+      end
+    end
+  end
+end

data/lib/import_graph/parser/third_party.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ImportGraph
+  module Parser
+    # Directories that use a third party autoloader (Zeitwerk)
+    # are not straightforward to parse for. In this case, `rubrowser`
+    # is used to scan for defined constants and if any file is found
+    # using that constant, we call it a dependent file.
+    class ThirdParty
+      def initialize(dir_path)
+        @dir_path = dir_path
+      end
+
+      def parse
+        return @dependency_graph unless @dependency_graph.nil?
+
+        obj = run_rubrowser
+
+        # Create a hash linking constant definitions with the file they were defined in
+        definitions = {}
+        obj['definitions'].each do |definition|
+          definitions[definition['namespace']] = definition['file']
+        end
+
+        # Go through the relations, if a file uses a certain constant
+        # add the file for that constant definition in the adjacency list
+        @dependency_graph = {}
+        obj['relations'].each do |reln|
+          if definitions.key? reln['resolved_namespace']
+            @dependency_graph[reln['file']] = [] unless @dependency_graph.key? reln['file']
+            @dependency_graph[reln['file']] << definitions[reln['resolved_namespace']]
+          end
+        end
+
+        @dependency_graph
+      end
+
+      # runs rubrowser and returns a Ruby hash with constant definitions
+      # and the files they were defined in. Also a list of relations, i.e
+      # Which constant was used in which file
+      def run_rubrowser
+        json_output = `rubrowser -j #{@dir_path}`
+        JSON.parse(json_output)
+      end
+    end
+  end
+end

data/lib/import_graph/path_manager.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ImportGraph
+  class PathManager
+    def initialize(dir_path)
+      @dir_path = dir_path
+    end
+
+    def resolve_paths(matches)
+      # run a map on matches and modify the paths
+      matches.map do |match|
+        local = match
+        local[:to] += '.rb' unless local[:to].end_with? '.rb'
+        case local[:method]
+        when :require, :load, :autoload
+          if local[:to].start_with?('./') || local[:to].start_with?('../')
+            local[:to] = File.expand_path(File.join(Dir.pwd, local[:to]))
+          end
+        end
+        local
+      end
+    end
+  end
+end

data/lib/import_graph/scanner.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Entry point for the ImportGraph gem
+module ImportGraph
+  # Scanner class is the starting interface though which you interact with the gem.
+  class Scanner
+    attr_reader :graph
+
+    # @param dir_path [String] Absolute path of the directory that you want scanned
+    # @param config [Hash] Configuration for the Scanner
+    def initialize(dir_path, config)
+      @dir_path = dir_path
+      @graph = nil
+      @config = config
+    end
+
+    def generate_graph
+      main_parser = Parser::Main.new(@dir_path, @config)
+      @graph = main_parser.parse
+    end
+
+    def get_dependents_from_file(file_path)
+      @graph.get_dependent_files(file_path)
+    end
+
+    def get_dependees_from_file(file_path)
+      @graph.get_dependee_files(file_path)
+    end
+  end
+end

data/lib/import_graph/util.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ImportGraph
+  module Util
+    def build_match_object(method, from, to)
+      { method: method, from: from, to: to }
+    end
+
+    def cleanup_absolute_path(dir_path, child_path)
+      clean_path = child_path.gsub(dir_path, '')
+      clean_path = clean_path[1..] if clean_path.start_with? '/'
+      clean_path
+    end
+  end
+end

data/lib/import_graph.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'parallel'
+require 'rubocop-ast'
+require 'json'
+require 'rubrowser'
+require 'set'
+require 'pathname'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module ImportGraph
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: import_graph
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Syed Faraaz Ahmad
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: 'Import Graph is a Gem that creates a dependency graph of all the ruby
+  files in a given directory.
+
+  '
+email:
+- faraaz@deepsource.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/import_graph.rb
+- lib/import_graph/dep_graph.rb
+- lib/import_graph/parser/autoload.rb
+- lib/import_graph/parser/load.rb
+- lib/import_graph/parser/main.rb
+- lib/import_graph/parser/require.rb
+- lib/import_graph/parser/require_relative.rb
+- lib/import_graph/parser/third_party.rb
+- lib/import_graph/path_manager.rb
+- lib/import_graph/scanner.rb
+- lib/import_graph/util.rb
+homepage: https://github.com/deepsourcelabs/import-graph-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/deepsourcelabs/import-graph-ruby
+  source_code_uri: https://github.com/deepsourcelabs/import-graph-ruby
+  changelog_uri: https://github.com/deepsourcelabs/import-graph-ruby/blob/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 gem to create a dependency graph of all the Ruby files within a directory
+test_files: []