Class: Packages::Go::ModuleVersion

Inherits:
Object
  • Object
show all
Includes:
Gitlab::Utils::StrongMemoize
Defined in:
app/models/packages/go/module_version.rb

Constant Summary collapse

VALID_TYPES =
%i[ref commit pseudo].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Constructor Details

#initialize(mod, type, commit, name: nil, semver: nil, ref: nil) ⇒ ModuleVersion

Returns a new instance of ModuleVersion.

Raises:

  • (ArgumentError)

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'app/models/packages/go/module_version.rb', line 18

def initialize(mod, type, commit, name: nil, semver: nil, ref: nil)
  raise ArgumentError.new("invalid type '#{type}'") unless VALID_TYPES.include? type
  raise ArgumentError.new("mod is required") unless mod
  raise ArgumentError.new("commit is required") unless commit

  if type == :ref
    raise ArgumentError.new("ref is required") unless ref
  elsif type == :pseudo
    raise ArgumentError.new("name is required") unless name
    raise ArgumentError.new("semver is required") unless semver
  end

  @mod = mod
  @type = type
  @commit = commit
  @name = name if name
  @semver = semver if semver
  @ref = ref if ref
end

Instance Attribute Details

#commitObject (readonly)

Returns the value of attribute commit


10
11
12
# File 'app/models/packages/go/module_version.rb', line 10

def commit
  @commit
end

#modObject (readonly)

Returns the value of attribute mod


10
11
12
# File 'app/models/packages/go/module_version.rb', line 10

def mod
  @mod
end

#refObject (readonly)

Returns the value of attribute ref


10
11
12
# File 'app/models/packages/go/module_version.rb', line 10

def ref
  @ref
end

#typeObject (readonly)

Returns the value of attribute type


10
11
12
# File 'app/models/packages/go/module_version.rb', line 10

def type
  @type
end

Instance Method Details

#archiveObject


58
59
60
61
62
63
64
65
66
67
# File 'app/models/packages/go/module_version.rb', line 58

def archive
  suffix_len = @mod.path == '' ? 0 : @mod.path.length + 1

  Zip::OutputStream.write_buffer do |zip|
    files.each do |file|
      zip.put_next_entry "#{full_name}/#{file[suffix_len...]}"
      zip.write blob_at(file)
    end
  end
end

#excludedObject


75
76
77
78
79
80
81
# File 'app/models/packages/go/module_version.rb', line 75

def excluded
  strong_memoize(:excluded) do
    ls_tree
      .filter { |f| f.end_with?('/go.mod') && f != @mod.path + '/go.mod' }
      .map    { |f| f[0..-7] }
  end
end

#filesObject


69
70
71
72
73
# File 'app/models/packages/go/module_version.rb', line 69

def files
  strong_memoize(:files) do
    ls_tree.filter { |e| !excluded.any? { |n| e.start_with? n } }
  end
end

#full_nameObject


42
43
44
# File 'app/models/packages/go/module_version.rb', line 42

def full_name
  "#{mod.name}@#{name || commit.sha}"
end

#gomodObject


46
47
48
49
50
51
52
53
54
55
56
# File 'app/models/packages/go/module_version.rb', line 46

def gomod
  strong_memoize(:gomod) do
    if strong_memoized?(:blobs)
      blob_at(@mod.path + '/go.mod')
    elsif @mod.path.empty?
      @mod.project.repository.blob_at(@commit.sha, 'go.mod')&.data
    else
      @mod.project.repository.blob_at(@commit.sha, @mod.path + '/go.mod')&.data
    end
  end
end

#nameObject


38
39
40
# File 'app/models/packages/go/module_version.rb', line 38

def name
  @name || @ref&.name
end

#valid?Boolean

Returns:

  • (Boolean)

83
84
85
# File 'app/models/packages/go/module_version.rb', line 83

def valid?
  @mod.path_valid?(major) && @mod.gomod_valid?(gomod)
end