Class: Bibliothecary::Parsers::Vcpkg

Inherits:
Object
  • Object
show all
Includes:
Analyser
Defined in:
lib/bibliothecary/parsers/vcpkg.rb

Class Method Summary collapse

Methods included from Analyser

create_analysis, create_error_analysis, included

Class Method Details

.format_requirement(version, port_version) ⇒ Object 



96
97
98
99
100
101
102
103
104
 
# File 'lib/bibliothecary/parsers/vcpkg.rb', line 96

def self.format_requirement(version, port_version)
  return "*" unless version

  if port_version && port_version > 0
    return "#{version}##{port_version}"
  end

  version
end

.mapping ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/bibliothecary/parsers/vcpkg.rb', line 8

def self.mapping
  {
    match_filename("vcpkg.json") => {
      kind: "manifest",
      parser: :parse_vcpkg_json,
    },
    # _generated-vcpkg-list.json is the output of `vcpkg list --x-json`.
    match_filename("_generated-vcpkg-list.json") => {
      kind: "lockfile",
      parser: :parse_vcpkg_list_json,
    },
  }
end

.parse_vcpkg_json(file_contents, options: {}) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/bibliothecary/parsers/vcpkg.rb', line 22

def self.parse_vcpkg_json(file_contents, options: {})
  dependencies = []
  manifest = JSON.parse(file_contents)
  deps = manifest["dependencies"]

  if !deps || deps.empty?
    return ParserResult.new(dependencies: dependencies)
  end

  overrides = {}
  manifest["overrides"]&.each do |override|
    if override.is_a?(Hash) && override["name"]
      override_version = override["version"] || override["version-semver"] || override["version-date"] || override["version-string"]
      overrides[override["name"]] = format_requirement(override_version, override["port-version"])
    end
  end

  deps.each do |dep|
    if dep.is_a?(String)
      # Simple string format: "boost-system"
      name = dep
      requirement = nil
      is_development = false
    elsif dep.is_a?(Hash)
      # Object format: { "name": "cpprestsdk", "version>=": "2.10.0", ... }
      name = dep["name"]
      requirement = if dep["version>="]
                      ">=#{dep['version>=']}"
                    end
      is_development = dep["host"] == true
    end

    # Skip entries with no name
    next if name.nil? || name.empty?

    requirement = overrides[name] if overrides[name]

    dependencies << Dependency.new(
      platform: platform_name,
      name: name,
      requirement: requirement,
      type: is_development ? "development" : "runtime",
      source: options.fetch(:filename, nil)
    )
  end

  ParserResult.new(dependencies: dependencies)
end

.parse_vcpkg_list_json(file_contents, options: {}) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bibliothecary/parsers/vcpkg.rb', line 71

def self.parse_vcpkg_list_json(file_contents, options: {})
  # parses the output of `vcpkg list --x-json`
  dependencies = []
  manifest = JSON.parse(file_contents)

  manifest.each_value do |package_info|
    name = package_info["package_name"]
    version = package_info["version"]
    port_version = package_info["port_version"]

    # Skip entries with no name
    next if name.nil? || name.empty?

    dependencies << Dependency.new(
      platform: platform_name,
      name: name,
      requirement: format_requirement(version, port_version),
      type: "runtime",
      source: options.fetch(:filename, nil)
    )
  end

  ParserResult.new(dependencies: dependencies)
end