Module: RubyLens

Defined in:

lib/rubylens.rb,
lib/rubylens.rb,
lib/rubylens/cli.rb,
lib/rubylens/paths.rb,
lib/rubylens/errors.rb,
lib/rubylens/version.rb,
lib/rubylens/generator.rb,
lib/rubylens/atomic_output.rb,
lib/rubylens/clip/renderer.rb,
lib/rubylens/report_writer.rb,
lib/rubylens/clip/toolchain.rb,
lib/rubylens/clip_generator.rb,
lib/rubylens/default_output.rb,
lib/rubylens/git_repository.rb,
lib/rubylens/index/manifest.rb,
lib/rubylens/showcase_model.rb,
lib/rubylens/artifact_marker.rb,
lib/rubylens/showcase_writer.rb,
lib/rubylens/clip/chrome_page.rb,
lib/rubylens/clip/deadline_io.rb,
lib/rubylens/art_model_builder.rb,
lib/rubylens/index/source_path.rb,
lib/rubylens/dependency_warning.rb,
lib/rubylens/showcase_generator.rb,
lib/rubylens/index/location_index.rb,
lib/rubylens/index/rspec_extractor.rb,
lib/rubylens/index/rubydex_adapter.rb,
lib/rubylens/morphology_classifier.rb,
lib/rubylens/report_asset_assembler.rb,
lib/rubylens/clip/web_socket_channel.rb,
lib/rubylens/index/git_package_source.rb,
lib/rubylens/index/declaration_collector.rb,
lib/rubylens/model/dependency_aggregation.rb,
lib/rubylens/index/constant_reference_collector.rb

Defined Under Namespace

Modules: ArtifactMarker, AtomicOutput, Clip, DefaultOutput, DependencyWarning, Index, Model, Paths Classes: ArtModelBuilder, CLI, ClipGenerator, ClipResult, Error, GenerationPipeline, Generator, GitError, GitRepository, MorphologyClassifier, ReportAssetAssembler, ReportWriter, Result, ShowcaseGenerator, ShowcaseModel, ShowcaseWriter

Constant Summary

INDEXABLE_EXTENSIONS =

File extensions RubyLens selects for indexing with Rubydex.

%w[.rb .rake .rbs .ru].freeze

VERSION =

"0.2.1"

Class Method Summary

• .generate_clip(path: Dir.pwd, output: nil, lockfile: nil, details: false, progress: nil) ⇒ Object
• .generate_report(path: Dir.pwd, output: nil, lockfile: nil) ⇒ Object
• .generate_showcase(path: Dir.pwd, output: nil, lockfile: nil, details: false) ⇒ Object

Class Method Details

.generate_clip(path: Dir.pwd, output: nil, lockfile: nil, details: false, progress: nil) ⇒ Object

# File 'lib/rubylens.rb', line 38

def generate_clip(path: Dir.pwd, output: nil, lockfile: nil, details: false, progress: nil)
  ClipGenerator.new(path: path, output: output, lockfile: lockfile, details: details, progress: progress).call
end

.generate_report(path: Dir.pwd, output: nil, lockfile: nil) ⇒ Object

# File 'lib/rubylens.rb', line 30

def generate_report(path: Dir.pwd, output: nil, lockfile: nil)
  Generator.new(path: path, output: output, lockfile: lockfile).call
end

.generate_showcase(path: Dir.pwd, output: nil, lockfile: nil, details: false) ⇒ Object

# File 'lib/rubylens.rb', line 34

def generate_showcase(path: Dir.pwd, output: nil, lockfile: nil, details: false)
  ShowcaseGenerator.new(path: path, output: output, lockfile: lockfile, details: details).call
end