Class: LicenseFinder::MavenDependencyFinder

Inherits:
Object
  • Object
show all
Defined in:
lib/license_finder/package_utils/maven_dependency_finder.rb

Instance Method Summary collapse

Constructor Details

#initialize(project_path, m2_path) ⇒ MavenDependencyFinder

Returns a new instance of MavenDependencyFinder.



5
6
7
8
 
# File 'lib/license_finder/package_utils/maven_dependency_finder.rb', line 5

def initialize(project_path, m2_path)
  @project_path = project_path
  @m2_path = m2_path
end

Instance Method Details

#add_info_from_m2(dep) ⇒ Object

Add the name of the JAR file to allow later retrieval of license and notice files, and add the name, description and URL from the POM XML file.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/license_finder/package_utils/maven_dependency_finder.rb', line 26

def add_info_from_m2(dep)
  m2_artifact_dir = @m2_path
    .join(dep['groupId'].tr('.', '/'))
    .join(dep['artifactId'])
    .join(dep['version'])
  artifact_basename = "#{dep['artifactId']}-#{dep['version']}"

  # Basic support for Maven classifiers. So far, only "jakarta" is supported. Unfortunately,
  # we do not have access to the "classifier" field here (licenses.xml does not have it).
  jar_file = m2_artifact_dir.join("#{artifact_basename}.jar")
  jar_file = m2_artifact_dir.join("#{artifact_basename}-jakarta.jar") unless File.exist?(jar_file) || !File.exist?(m2_artifact_dir.join("#{artifact_basename}-jakarta.jar"))

  dep.store('jarFile', jar_file)

  add_info_from_pom(m2_artifact_dir.join("#{artifact_basename}.pom"), dep)
end

#add_info_from_pom(pom_file, dep) ⇒ Object

Extract name, description and URL from pom.xml



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/license_finder/package_utils/maven_dependency_finder.rb', line 44

def add_info_from_pom(pom_file, dep)
  pom = XmlSimple.xml_in(pom_file.read, { 'ForceArray' => false })

  name = pom['name']
  dep.store('summary', name) unless name.nil?

  description = pom['description']
  dep.store('description', description) unless description.nil?

  url = pom['url']
  dep.store('homepage', url) unless url.nil?
end

#dependencies ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/license_finder/package_utils/maven_dependency_finder.rb', line 10

def dependencies
  options = {
    'GroupTags' => { 'licenses' => 'license', 'dependencies' => 'dependency' },
    'ForceArray' => %w[license dependency]
  }

  Pathname
    .glob(@project_path.join('**', 'target', 'generated-resources', 'licenses.xml'))
    .map(&:read)
    .flat_map { |xml| XmlSimple.xml_in(xml, options)['dependencies'] }
    .reject(&:empty?)
    .each { |dep| add_info_from_m2(dep) }
end