ruby

package

v1.1.10 Latest Latest Go to latest Published: Jul 13, 2021 License: MPL-2.0 Imports: 10 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fossas/fossa-cli

Links

Open Source Insights

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)
type Options

Constants ¶

View Source

const (
	AnalyzerName = "ruby"

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

Variables ¶

View Source

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 ¶ added in v1.0.8

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"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL