Documentation ¶
Overview ¶
Package gemspec extracts *.gemspec files.
Index ¶
- type Config
- type Extractor
- func (Extractor) Ecosystem(i *extractor.Inventory) string
- func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
- func (e Extractor) FileRequired(api filesystem.FileAPI) bool
- func (e Extractor) Name() string
- func (e Extractor) Requirements() *plugin.Capabilities
- func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL
- func (e Extractor) Version() int
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v0.1.2
type Config struct { // Stats is a stats collector for reporting metrics. Stats stats.Collector // MaxFileSizeBytes is the maximum file size this extractor will unmarshal. If // `FileRequired` gets a bigger file, it will return false, MaxFileSizeBytes int64 }
Config is the configuration for the Extractor.
func DefaultConfig ¶ added in v0.1.2
func DefaultConfig() Config
DefaultConfig returns the default configuration for the extractor.
type Extractor ¶
type Extractor struct {
// contains filtered or unexported fields
}
Extractor extracts RubyGem package info from *.gemspec files.
func New ¶ added in v0.1.2
New returns a Ruby gemspec extractor.
For most use cases, initialize with: ``` e := New(DefaultConfig()) ```
func (Extractor) Ecosystem ¶ added in v0.1.3
Ecosystem returns the OSV Ecosystem of the software extracted by this extractor.
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
Extract extracts packages from the .gemspec file.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired return true if the specified file matched the .gemspec file pattern.
func (Extractor) Requirements ¶ added in v0.1.3
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.
Click to show internal directories.
Click to hide internal directories.