Class: Bundler::Audit::Database

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/audit/database.rb

Overview

Represents the directory of advisories, grouped by gem name and CVE number.

Constant Summary collapse

PATH =

directory containing advisories

File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','data','ruby-advisory-db','gems'))

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path = PATH) ⇒ Database

Initializes the Advisory Database.

Parameters:

  • path (String) (defaults to: PATH) —

    The path to the advisory database.

Raises:

  • (ArgumentError) —

    The path was not a directory.



45
46
47
48
49
50
51
 
# File 'lib/bundler/audit/database.rb', line 45

def initialize(path=PATH)
  unless File.directory?(path)
    raise(ArgumentError,"#{path.dump} is not a directory")
  end

  @path = path
end

Instance Attribute Details

#path ⇒ Object (readonly)

The path to the advisory database



34
35
36
 
# File 'lib/bundler/audit/database.rb', line 34

def path
  @path
end

Instance Method Details

#advisories {|advisory| ... } ⇒ Enumerator

Enumerates over every advisory in the database.

Yields:

  • (advisory) —

    If a block is given, it will be passed each advisory.

Yield Parameters:

  • advisory (Advisory) —

    An advisory from the database.

Returns:

  • (Enumerator) —

    If no block is given, an Enumerator will be returned.



65
66
67
68
69
70
71
 
# File 'lib/bundler/audit/database.rb', line 65

def advisories(&block)
  return enum_for(__method__) unless block_given?

  each_advisory_path do |path|
    yield Advisory.load(path)
  end
end

#advisories_for(name) {|advisory| ... } ⇒ Enumerator

Enumerates over advisories for the given gem.

Parameters:

  • name (String) —

    The gem name to lookup.

Yields:

  • (advisory) —

    If a block is given, each advisory for the given gem will be yielded.

Yield Parameters:

  • advisory (Advisory) —

    An advisory for the given gem.

Returns:

  • (Enumerator) —

    If no block is given, an Enumerator will be returned.



88
89
90
91
92
93
94
 
# File 'lib/bundler/audit/database.rb', line 88

def advisories_for(name)
  return enum_for(__method__,name) unless block_given?

  each_advisory_path_for(name) do |path|
    yield Advisory.load(path)
  end
end

#check_gem(gem) {|advisory| ... } ⇒ Enumerator

Verifies whether the gem is effected by any advisories.

Parameters:

  • gem (Gem::Specification) —

    The gem to verify.

Yields:

  • (advisory) —

    If a block is given, it will be passed advisories that effect the gem.

Yield Parameters:

  • advisory (Advisory) —

    An advisory that effects the specific version of the gem.

Returns:

  • (Enumerator) —

    If no block is given, an Enumerator will be returned.



112
113
114
115
116
117
118
119
120
 
# File 'lib/bundler/audit/database.rb', line 112

def check_gem(gem)
  return enum_for(__method__,gem) unless block_given?

  advisories_for(gem.name) do |advisory|
    if advisory.vulnerable?(gem.version)
      yield advisory
    end
  end
end

#each_advisory_path {|path| ... } ⇒ Object (protected)

Enumerates over every advisory path in the database.

Yields:

  • (path) —

    The given block will be passed each advisory path.

Yield Parameters:

  • path (String) —

    A path to an advisory .yml file.



163
164
165
 
# File 'lib/bundler/audit/database.rb', line 163

def each_advisory_path(&block)
  Dir.glob(File.join(@path,'*','*.yml'),&block)
end

#each_advisory_path_for(name) {|path| ... } ⇒ Object (protected)

Enumerates over the advisories for the given gem.

Parameters:

  • name (String) —

    The gem of the gem.

Yields:

  • (path) —

    The given block will be passed each advisory path.

Yield Parameters:

  • path (String) —

    A path to an advisory .yml file.



179
180
181
 
# File 'lib/bundler/audit/database.rb', line 179

def each_advisory_path_for(name,&block)
  Dir.glob(File.join(@path,name,'*.yml'),&block)
end

#inspect ⇒ String

Inspects the database.

Returns:

  • (String) —

    The inspected database.



148
149
150
 
# File 'lib/bundler/audit/database.rb', line 148

def inspect
  "#<#{self.class}:#{self}>"
end

#size ⇒ Integer

The number of advisories within the database.

Returns:

  • (Integer) —

    The number of advisories.



128
129
130
 
# File 'lib/bundler/audit/database.rb', line 128

def size
  each_advisory_path.count
end

#to_s ⇒ String

Converts the database to a String.

Returns:

  • (String) —

    The path to the database.



138
139
140
 
# File 'lib/bundler/audit/database.rb', line 138

def to_s
  @path
end