ruby

Documentation

Overview

Package ruby contains components for interrogating ruby packages in container layers.

Package ruby contains components for interrogating ruby packages in container layers.

Index

• Variables
• func NewCoalescer(_ context.Context) (indexer.Coalescer, error)
• func NewEcosystem(_ context.Context) *indexer.Ecosystem
• type RepoScanner
  • func (*RepoScanner) Kind() string
  • func (*RepoScanner) Name() string
  • func (rs *RepoScanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Repository, error)
  • func (*RepoScanner) Version() string
• type Scanner
  • func (*Scanner) Kind() string
  • func (*Scanner) Name() string
  • func (ps *Scanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Package, error)
  • func (*Scanner) Version() string

Variables

var (
	Repository = claircore.Repository{
		Name: repository,
		URI:  "https://rubygems.org/gems/",
	}
)

Functions

func NewCoalescer

func NewCoalescer(_ context.Context) (indexer.Coalescer, error)

func NewEcosystem

func NewEcosystem(_ context.Context) *indexer.Ecosystem

NewEcosystem provides the set of scanners for the ruby ecosystem.

Types

type RepoScanner

type RepoScanner struct{}

func (*RepoScanner) Kind

func (*RepoScanner) Kind() string

Kind implements scanner.VersionedScanner.

func (*RepoScanner) Name

func (*RepoScanner) Name() string

Name implements scanner.VersionedScanner.

func (*RepoScanner) Scan

func (rs *RepoScanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Repository, error)

Scan attempts to find gems and record the package information there.

A return of (nil, nil) is expected if there's nothing found.

func (*RepoScanner) Version

func (*RepoScanner) Version() string

Version implements scanner.VersionedScanner.

type Scanner

type Scanner struct{}

Scanner implements the scanner.PackageScanner interface.

It looks for files that seem like gems, and looks at the metadata recorded there. This type attempts to follow the specs documented here: https://guides.rubygems.org/specification-reference/.

The zero value is ready to use.

func (*Scanner) Kind

func (*Scanner) Kind() string

Kind implements scanner.VersionedScanner.

func (*Scanner) Name

func (*Scanner) Name() string

Name implements scanner.VersionedScanner.

func (*Scanner) Scan

func (ps *Scanner) Scan(ctx context.Context, layer *claircore.Layer) ([]*claircore.Package, error)

Scan attempts to find gems and record the package information there.

A return of (nil, nil) is expected if there's nothing found.

func (*Scanner) Version

func (*Scanner) Version() string

Version implements scanner.VersionedScanner.