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

• Constants
• Variables
• func Discover(dir string, options map[string]interface{}) ([]module.Module, error)
• func NewDiscover(dir module.Filepath) (map[module.Filepath]module.DiscoveredStrategies, *errors.Error)
• type Analyzer
  • func New(m module.Module) (*Analyzer, error)
  • func (a *Analyzer) Analyze() (graph.Deps, error)
  • func (a *Analyzer) Build() error
  • func (a *Analyzer) Clean() error
  • func (a *Analyzer) IsBuilt() (bool, error)
• type Options

Constants

const (
	AnalyzerName = "ruby"

	BundlerListStrategy     = "list"
	BundlerLockStrategy     = "lockfile"
	BundlerListLockStrategy = "list-lockfile"
)

Variables

var RubyAnalyzer = module.AnalyzerV2{
	Name:         AnalyzerName,
	DiscoverFunc: NewDiscover,
	Strategies: module.Strategies{
		Named: map[module.StrategyName]module.Strategy{
			BundlerListStrategy:     analyzeBundlerList,
			BundlerLockStrategy:     analyzeBundlerLockfile,
			BundlerListLockStrategy: analyzeBundlerListLockfile,
		},
		Optimal: []module.StrategyName{BundlerListLockStrategy},
		SortedNames: []module.StrategyName{
			BundlerListLockStrategy,
			BundlerLockStrategy,
			BundlerListStrategy,
		},
	},
}

Functions

func Discover

func Discover(dir string, options map[string]interface{}) ([]module.Module, error)

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

func NewDiscover

func NewDiscover(dir module.Filepath) (map[module.Filepath]module.DiscoveredStrategies, *errors.Error)

Types

type Analyzer

type Analyzer struct {
	Bundler bundler.Bundler
	Module  module.Module
	Options Options
}

func New

func New(m module.Module) (*Analyzer, error)

func (*Analyzer) Analyze

func (a *Analyzer) Analyze() (graph.Deps, error)

func (*Analyzer) Build

func (a *Analyzer) Build() error

func (*Analyzer) Clean

func (a *Analyzer) Clean() error

Clean logs a warning and does nothing for Ruby.

func (*Analyzer) IsBuilt

func (a *Analyzer) IsBuilt() (bool, error)

type Options

type Options struct {
	Strategy     string `mapstructure:"strategy"`
	LockfilePath string `mapstructure:"gemfile-lock-path"`
}