Class: Dependabot::DependencyFile

Inherits:
Object
  • Object
show all
Defined in:
lib/dependabot/dependency_file.rb

Defined Under Namespace

Classes: ContentEncoding, Operation

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, content:, directory: "/", type: "file", support_file: false, vendored_file: false, symlink_target: nil, content_encoding: ContentEncoding::UTF_8, deleted: false, operation: Operation::UPDATE, mode: nil) ⇒ DependencyFile

Returns a new instance of DependencyFile.



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
 
# File 'lib/dependabot/dependency_file.rb', line 23

def initialize(name:, content:, directory: "/", type: "file",
               support_file: false, vendored_file: false, symlink_target: nil,
               content_encoding: ContentEncoding::UTF_8, deleted: false,
               operation: Operation::UPDATE, mode: nil)
  @name = name
  @content = content
  @directory = clean_directory(directory)
  @symlink_target = symlink_target
  @support_file = support_file
  @vendored_file = vendored_file
  @content_encoding = content_encoding
  @operation = operation

  # Make deleted override the operation. Deleted is kept when operation
  # was introduced to keep compatibility with downstream dependants.
  @operation = Operation::DELETE if deleted

  # Type is used *very* sparingly. It lets the git_modules updater know that
  # a "file" is actually a submodule, and lets our Go updaters know which
  # file represents the main.go.
  # New use cases should be avoided if at all possible (and use the
  # support_file flag instead)
  @type = type

  begin
    @mode = File.stat(realpath).mode.to_s(8)
  rescue StandardError
    @mode = mode
  end

  return unless (type == "symlink") ^ symlink_target

  raise "Symlinks must specify a target!" unless symlink_target
  raise "Only symlinked files must specify a target!" if symlink_target
end

Instance Attribute Details

#content ⇒ Object

Returns the value of attribute content.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def content
  @content
end

#content_encoding ⇒ Object

Returns the value of attribute content_encoding.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def content_encoding
  @content_encoding
end

#directory ⇒ Object

Returns the value of attribute directory.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def directory
  @directory
end

#mode ⇒ Object

Returns the value of attribute mode.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def mode
  @mode
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def name
  @name
end

#operation ⇒ Object

Returns the value of attribute operation.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def operation
  @operation
end

#support_file ⇒ Object

Returns the value of attribute support_file.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def support_file
  @support_file
end

#symlink_target ⇒ Object

Returns the value of attribute symlink_target.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def symlink_target
  @symlink_target
end

#type ⇒ Object

Returns the value of attribute type.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def type
  @type
end

#vendored_file ⇒ Object

Returns the value of attribute vendored_file.



8
9
10
 
# File 'lib/dependabot/dependency_file.rb', line 8

def vendored_file
  @vendored_file
end

Instance Method Details

#==(other) ⇒ Object 



84
85
86
87
88
89
90
 
# File 'lib/dependabot/dependency_file.rb', line 84

def ==(other)
  return false unless other.instance_of?(self.class)

  my_hash = to_h.reject { |k| k == "support_file" }
  their_hash = other.to_h.reject { |k| k == "support_file" }
  my_hash == their_hash
end

#binary? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/dependabot/dependency_file.rb', line 120

def binary?
  content_encoding == ContentEncoding::BASE64
end

#decoded_content ⇒ Object 



124
125
126
127
128
 
# File 'lib/dependabot/dependency_file.rb', line 124

def decoded_content
  return Base64.decode64(content) if binary?

  content
end

#deleted ⇒ Object 



108
109
110
 
# File 'lib/dependabot/dependency_file.rb', line 108

def deleted
  @operation == Operation::DELETE
end

#deleted=(deleted) ⇒ Object 



112
113
114
 
# File 'lib/dependabot/dependency_file.rb', line 112

def deleted=(deleted)
  @operation = deleted ? Operation::DELETE : Operation::UPDATE
end

#deleted? ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/dependabot/dependency_file.rb', line 116

def deleted?
  deleted
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/dependabot/dependency_file.rb', line 96

def eql?(other)
  self == other
end

#hash ⇒ Object 



92
93
94
 
# File 'lib/dependabot/dependency_file.rb', line 92

def hash
  to_h.hash
end

#path ⇒ Object 



76
77
78
 
# File 'lib/dependabot/dependency_file.rb', line 76

def path
  Pathname.new(File.join(directory, name)).cleanpath.to_path
end

#realpath ⇒ Object 



80
81
82
 
# File 'lib/dependabot/dependency_file.rb', line 80

def realpath
  (symlink_target || path).sub(%r{^/}, "")
end

#support_file? ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/dependabot/dependency_file.rb', line 100

def support_file?
  @support_file
end

#to_h ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/dependabot/dependency_file.rb', line 59

def to_h
  details = {
    "name" => name,
    "content" => content,
    "directory" => directory,
    "type" => type,
    "support_file" => support_file,
    "content_encoding" => content_encoding,
    "deleted" => deleted,
    "operation" => operation,
    "mode" => mode
  }

  details["symlink_target"] = symlink_target if symlink_target
  details
end

#vendored_file? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/dependabot/dependency_file.rb', line 104

def vendored_file?
  @vendored_file
end