Module: Bootprint

Defined in:

lib/bootprint/analysis.rb,
lib/bootprint.rb,
lib/bootprint/cli.rb,
lib/bootprint/diff.rb,
lib/bootprint/rules.rb,
lib/bootprint/docker.rb,
lib/bootprint/doctor.rb,
lib/bootprint/errors.rb,
lib/bootprint/policy.rb,
lib/bootprint/schema.rb,
lib/bootprint/plugins.rb,
lib/bootprint/railtie.rb,
lib/bootprint/version.rb,
lib/bootprint/snapshot.rb,
lib/bootprint/diagnosis.rb,
lib/bootprint/sanitizer.rb,
lib/bootprint/formatters.rb,
lib/bootprint/rules/rule.rb,
lib/bootprint/rails_state.rb,
lib/bootprint/configuration.rb,
lib/bootprint/rules/builtin.rb,
lib/bootprint/rules/finding.rb,
lib/bootprint/rules/registry.rb,
lib/bootprint/collectors/gems.rb,
lib/bootprint/formatters/json.rb,
lib/bootprint/collectors/rails.rb,
lib/bootprint/formatters/human.rb,
lib/bootprint/formatters/sarif.rb,
lib/bootprint/security/auditor.rb,
lib/bootprint/collectors/runtime.rb,
lib/bootprint/formatters/markdown.rb,
lib/bootprint/collectors/libraries.rb,
lib/bootprint/collectors/toolchain.rb,
lib/bootprint/initializer_profiler.rb,
lib/bootprint/collectors/filesystem.rb,
lib/bootprint/collectors/environment.rb,
lib/bootprint/collectors/operating_system.rb

Overview

Backward-compatible facade for the 0.1 API.

Defined Under Namespace

Modules: Collectors, Docker, Formatters, InitializerProfiler, Plugin, Plugins, RailsState, Rules, Sanitizer, Schema, Security Classes: Analysis, CLI, Configuration, ConfigurationError, Diagnosis, Diff, DockerError, Doctor, Error, InvalidSnapshotError, PluginError, Policy, Railtie, Report, Snapshot

Constant Summary

VERSION =

"0.2.0"

Class Method Summary

• .capture(label: nil, **options) ⇒ Object
• .configuration ⇒ Object
• .configure {|configuration| ... } ⇒ Object
• .rule(name, severity: nil, &block) ⇒ Object

Class Method Details

.capture(label: nil, **options) ⇒ Object

# File 'lib/bootprint.rb', line 28

def capture(label: nil, **options)
  Snapshot.capture(label:, **options)
end

.configuration ⇒ Object

# File 'lib/bootprint.rb', line 16

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:

• (configuration)

# File 'lib/bootprint.rb', line 20

def configure
  yield(configuration)
end

.rule(name, severity: nil, &block) ⇒ Object

# File 'lib/bootprint.rb', line 24

def rule(name, severity: nil, &block)
  Rules.define(name, severity: severity, &block)
end