Class: Bibliothecary::Parsers::Go

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

Constant Summary collapse

GPM_REGEXP = 
/^(.+)\s+(.+)$/
GOMOD_REGEX = 
/^(require\s+)?(.+)\s+(.+)$/
GOMOD_IGNORABLE_REGEX = 
/^(\/\/|module\s|go\s|exclude\s|replace\s|require\s+\(|\))/m
GOSUM_REGEX = 
/^(.+)\s+(.+)\s+(.+)$/

Class Method Summary collapse

Methods included from Analyser

create_analysis, create_error_analysis, included

Class Method Details

.map_dependencies(manifest, attr_name, dep_attr_name, version_attr_name, type) ⇒ Object 



153
154
155
156
157
158
159
160
161
 
# File 'lib/bibliothecary/parsers/go.rb', line 153

def self.map_dependencies(manifest, attr_name, dep_attr_name, version_attr_name, type)
  manifest.fetch(attr_name,[]).map do |dependency|
    {
      name: dependency[dep_attr_name],
      requirement: dependency[version_attr_name]  || '*',
      type: type
    }
  end
end

.mapping ⇒ Object 



14
15
16
17
18
19
20
21
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
 
# File 'lib/bibliothecary/parsers/go.rb', line 14

def self.mapping
  {
    # Go Modules (recommended)
    match_filename("go.mod") => {
      kind: 'manifest',
      parser: :parse_go_mod
    },
    match_filename("go.sum") => {
      kind: 'lockfile',
      parser: :parse_go_sum
    },
    # Glide (unmaintained: https://github.com/Masterminds/glide#go-modules)
    match_filename("glide.yaml") => {
      kind: 'manifest',
      parser: :parse_glide_yaml
    },
    match_filename("glide.lock") => {
      kind: 'lockfile',
      parser: :parse_glide_lockfile
    },
    # Godep (unmaintained: https://github.com/tools/godep)
    match_filename("Godeps/Godeps.json") => {
      kind: 'manifest',
      parser: :parse_godep_json
    },
    match_filename("Godeps", case_insensitive: true) => {
      kind: 'manifest',
      parser: :parse_gpm
    },
    # Govendor (unmaintained: https://github.com/kardianos/govendor)
    match_filename("vendor/manifest") => {
      kind: 'manifest',
      parser: :parse_gb_manifest
    },
    match_filename("vendor/vendor.json") => {
      kind: 'manifest',
      parser: :parse_govendor
    },
    # Go dep (deprecated: https://github.com/golang/dep#dep)
    match_filename("Gopkg.toml") => {
      kind: 'manifest',
      parser: :parse_dep_toml
    },
    match_filename("Gopkg.lock") => {
      kind: 'lockfile',
      parser: :parse_dep_lockfile
    },
    match_filename("go-resolved-dependencies.json") => {
      kind: 'lockfile',
      parser: :parse_go_resolved
    },
  }
end

.parse_dep_lockfile(file_contents) ⇒ Object 



113
114
115
116
 
# File 'lib/bibliothecary/parsers/go.rb', line 113

def self.parse_dep_lockfile(file_contents)
  manifest = Tomlrb.parse file_contents
  map_dependencies(manifest, 'projects', 'name', 'revision', 'runtime')
end

.parse_dep_toml(file_contents) ⇒ Object 



108
109
110
111
 
# File 'lib/bibliothecary/parsers/go.rb', line 108

def self.parse_dep_toml(file_contents)
  manifest = Tomlrb.parse file_contents
  map_dependencies(manifest, 'constraint', 'name', 'version', 'runtime')
end

.parse_gb_manifest(file_contents) ⇒ Object 



103
104
105
106
 
# File 'lib/bibliothecary/parsers/go.rb', line 103

def self.parse_gb_manifest(file_contents)
  manifest = JSON.parse file_contents
  map_dependencies(manifest, 'dependencies', 'importpath', 'revision', 'runtime')
end

.parse_glide_lockfile(file_contents) ⇒ Object 



98
99
100
101
 
# File 'lib/bibliothecary/parsers/go.rb', line 98

def self.parse_glide_lockfile(file_contents)
  manifest = YAML.load file_contents
  map_dependencies(manifest, 'imports', 'name', 'version', 'runtime')
end

.parse_glide_yaml(file_contents) ⇒ Object 



92
93
94
95
96
 
# File 'lib/bibliothecary/parsers/go.rb', line 92

def self.parse_glide_yaml(file_contents)
  manifest = YAML.load file_contents
  map_dependencies(manifest, 'import', 'package', 'version', 'runtime') +
  map_dependencies(manifest, 'devImports', 'package', 'version', 'development')
end

.parse_go_mod(file_contents) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/bibliothecary/parsers/go.rb', line 118

def self.parse_go_mod(file_contents)
  deps = []
  file_contents.lines.map(&:strip).each do |line|
    next if line.match(GOMOD_IGNORABLE_REGEX)
    if match = line.gsub(/(\/\/(.*))/, '').match(GOMOD_REGEX)
      deps << {
        name: match[2].strip,
        requirement: match[3].strip || '*',
        type: 'runtime'
      }
    end
  end
  deps
end

.parse_go_resolved(file_contents) ⇒ Object 



147
148
149
150
151
 
# File 'lib/bibliothecary/parsers/go.rb', line 147

def self.parse_go_resolved(file_contents)
  JSON.parse(file_contents)
    .select { |dep| dep["Main"] != "true" }
    .map { |dep| { name: dep["Path"], requirement: dep["Version"], type: 'runtime' } }
end

.parse_go_sum(file_contents) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/bibliothecary/parsers/go.rb', line 133

def self.parse_go_sum(file_contents)
  deps = []
  file_contents.lines.map(&:strip).each do |line|
    if match = line.match(GOSUM_REGEX)
      deps << {
        name: match[1].strip,
        requirement: match[2].strip.split('/').first || '*',
        type: 'runtime'
      }
    end
  end
  deps.uniq
end

.parse_godep_json(file_contents) ⇒ Object 



68
69
70
71
 
# File 'lib/bibliothecary/parsers/go.rb', line 68

def self.parse_godep_json(file_contents)
  manifest = JSON.parse file_contents
  map_dependencies(manifest, 'Deps', 'ImportPath', 'Rev', 'runtime')
end

.parse_govendor(file_contents) ⇒ Object 



87
88
89
90
 
# File 'lib/bibliothecary/parsers/go.rb', line 87

def self.parse_govendor(file_contents)
  manifest = JSON.load file_contents
  map_dependencies(manifest, 'package', 'path', 'revision', 'runtime')
end

.parse_gpm(file_contents) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/bibliothecary/parsers/go.rb', line 73

def self.parse_gpm(file_contents)
  deps = []
  file_contents.split("\n").each do |line|
    match = line.gsub(/(\#(.*))/, '').match(GPM_REGEXP)
    next unless match
    deps << {
      name: match[1].strip,
      requirement: match[2].strip || '*',
      type: 'runtime'
    }
  end
  deps
end