Class: Datadog::CI::SourceCode::StaticDependenciesExtractor

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog/ci/source_code/static_dependencies_extractor.rb

Overview

StaticDependenciesExtractor extracts static constant dependencies from Ruby bytecode.

For each ISeq (compiled Ruby code), it:

  1. Extracts the source file path

  2. Filters by root_path and ignored_path

  3. Scans bytecode for constant references

  4. Resolves constants to their source file locations

  5. Filters dependency paths by root_path and ignored_path

Examples:

extractor = StaticDependenciesExtractor.new("/app", "/app/vendor")
iseq = RubyVM::InstructionSequence.of(some_method)
extractor.extract(iseq)
deps = extractor.dependencies_map
# => { "/app/foo.rb" => { "/app/bar.rb" => true } }

Defined Under Namespace

Classes: BytecodeScanner

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root_path, ignored_path = nil) ⇒ StaticDependenciesExtractor

Initialize a new StaticDependenciesExtractor.

Parameters:

  • root_path (String) —

    Only process files under this path

  • ignored_path (String, nil) (defaults to: nil) —

    Exclude files under this path



150
151
152
153
154
155
 
# File 'lib/datadog/ci/source_code/static_dependencies_extractor.rb', line 150

def initialize(root_path, ignored_path = nil)
  @root_path = root_path
  @ignored_path = ignored_path
  @dependencies_map = {}
  @bytecode_scanner = BytecodeScanner.new
end

Instance Attribute Details

#dependencies_map ⇒ Hash{String => Hash{String => Boolean}} (readonly)

Returns Map of source file to dependencies.

Returns:

  • (Hash{String => Hash{String => Boolean}}) —

    Map of source file to dependencies



138
139
140
 
# File 'lib/datadog/ci/source_code/static_dependencies_extractor.rb', line 138

def dependencies_map
  @dependencies_map
end

#ignored_path ⇒ String? (readonly)

Returns Ignored path prefix for exclusion.

Returns:

  • (String, nil) —

    Ignored path prefix for exclusion



144
145
146
 
# File 'lib/datadog/ci/source_code/static_dependencies_extractor.rb', line 144

def ignored_path
  @ignored_path
end

#root_path ⇒ String (readonly)

Returns Root path prefix for filtering.

Returns:

  • (String) —

    Root path prefix for filtering



141
142
143
 
# File 'lib/datadog/ci/source_code/static_dependencies_extractor.rb', line 141

def root_path
  @root_path
end

Instance Method Details

#extract(iseq) ⇒ void

This method returns an undefined value.

Extract constant dependencies from an ISeq.

Parameters:

  • iseq (RubyVM::InstructionSequence) —

    The instruction sequence to process



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/datadog/ci/source_code/static_dependencies_extractor.rb', line 161

def extract(iseq)
  path = extract_absolute_path(iseq)
  return if path.nil?
  return unless PathFilter.included?(path, root_path, ignored_path)

  body = extract_body(iseq)
  return if body.nil?

  deps = get_or_create_deps(path)
  constant_names = @bytecode_scanner.scan(body)

  constant_names.each do |const_name|
    resolve_and_store_dependency(const_name, deps)
  end
end

#reset ⇒ void

This method returns an undefined value.

Reset the dependencies map.



180
181
182
 
# File 'lib/datadog/ci/source_code/static_dependencies_extractor.rb', line 180

def reset
  @dependencies_map = {}
end