ruby

Documentation

Overview

Package ruby provides analysers for Ruby projects.

A `BuildTarget` in Ruby is the directory of the Ruby project, generally containing `Gemfile` and `Gemfile.lock`.

Index

• func AddSpecs(lookup map[string]pkg.ID, sections []bundler.Section)
• func AddToGraph(graph map[pkg.ID]pkg.Package, lookup map[string]pkg.ID, ...)
• func FilteredLockfile(gems []bundler.Gem, lockfile bundler.Lockfile) ([]pkg.Import, map[pkg.ID]pkg.Package)
• func FromGems(gems []bundler.Gem) ([]pkg.Import, map[pkg.ID]pkg.Package)
• func FromLockfile(lockfile bundler.Lockfile) ([]pkg.Import, map[pkg.ID]pkg.Package)
• type Analyzer
  • func New(opts map[string]interface{}) (*Analyzer, error)
  • func (a *Analyzer) Analyze(m module.Module) (module.Module, error)
  • func (a *Analyzer) Build(m module.Module) error
  • func (a *Analyzer) Clean(m module.Module) error
  • func (a *Analyzer) Discover(dir string) ([]module.Module, error)
  • func (a *Analyzer) IsBuilt(m module.Module) (bool, error)
• type Options

Functions

func AddSpecs

func AddSpecs(lookup map[string]pkg.ID, sections []bundler.Section)

func AddToGraph

func AddToGraph(graph map[pkg.ID]pkg.Package, lookup map[string]pkg.ID, sections []bundler.Section)

func FilteredLockfile

func FilteredLockfile(gems []bundler.Gem, lockfile bundler.Lockfile) ([]pkg.Import, map[pkg.ID]pkg.Package)

func FromGems

func FromGems(gems []bundler.Gem) ([]pkg.Import, map[pkg.ID]pkg.Package)

func FromLockfile

func FromLockfile(lockfile bundler.Lockfile) ([]pkg.Import, map[pkg.ID]pkg.Package)

Types

type Analyzer

type Analyzer struct {
	RubyCmd     string
	RubyVersion string

	BundlerCmd     string
	BundlerVersion string

	Bundler bundler.Bundler
	Options Options
}

func New

func New(opts map[string]interface{}) (*Analyzer, error)

func (*Analyzer) Analyze

func (a *Analyzer) Analyze(m module.Module) (module.Module, error)

func (*Analyzer) Build

func (a *Analyzer) Build(m module.Module) error

func (*Analyzer) Clean

func (a *Analyzer) Clean(m module.Module) error

Clean logs a warning and does nothing for Ruby.

func (*Analyzer) Discover

func (a *Analyzer) Discover(dir string) ([]module.Module, error)

Discover constructs modules in all directories with a `Gemfile`.

func (*Analyzer) IsBuilt

func (a *Analyzer) IsBuilt(m module.Module) (bool, error)

type Options

type Options struct {
	Strategy string `mapstructure:"strategy"`
}