Module: Bibliothecary

Defined in:
lib/bibliothecary.rb,
lib/bibliothecary/cli.rb,
lib/bibliothecary/runner.rb,
lib/bibliothecary/version.rb,
lib/bibliothecary/analyser.rb,
lib/bibliothecary/file_info.rb,
lib/bibliothecary/exceptions.rb,
lib/bibliothecary/parsers/go.rb,
lib/bibliothecary/parsers/dub.rb,
lib/bibliothecary/parsers/elm.rb,
lib/bibliothecary/parsers/hex.rb,
lib/bibliothecary/parsers/npm.rb,
lib/bibliothecary/parsers/pub.rb,
lib/bibliothecary/parsers/cpan.rb,
lib/bibliothecary/parsers/cran.rb,
lib/bibliothecary/parsers/pypi.rb,
lib/bibliothecary/configuration.rb,
lib/bibliothecary/parsers/bower.rb,
lib/bibliothecary/parsers/cargo.rb,
lib/bibliothecary/parsers/conda.rb,
lib/bibliothecary/parsers/julia.rb,
lib/bibliothecary/parsers/maven.rb,
lib/bibliothecary/parsers/nuget.rb,
lib/bibliothecary/parsers/shard.rb,
lib/bibliothecary/parsers/meteor.rb,
lib/bibliothecary/parsers/clojars.rb,
lib/bibliothecary/parsers/hackage.rb,
lib/bibliothecary/parsers/haxelib.rb,
lib/bibliothecary/parsers/carthage.rb,
lib/bibliothecary/parsers/rubygems.rb,
lib/bibliothecary/parsers/swift_pm.rb,
lib/bibliothecary/parsers/cocoapods.rb,
lib/bibliothecary/parsers/packagist.rb,
lib/bibliothecary/related_files_info.rb

Defined Under Namespace

Modules: Analyser, Parsers Classes: CLI, Configuration, FileInfo, FileParsingError, RelatedFilesInfo, RemoteParsingError, Runner

Constant Summary collapse

VERSION =
"6.9.4"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configurationObject



73
74
75
76
77
# File 'lib/bibliothecary.rb', line 73

def self.configuration
  @configuration ||= Configuration.new
  @runner = Runner.new(@configuration)
  @configuration
end

Class Method Details

.analyse(path, ignore_unparseable_files: true) ⇒ Object



15
16
17
# File 'lib/bibliothecary.rb', line 15

def self.analyse(path, ignore_unparseable_files: true)
  runner.analyse(path, ignore_unparseable_files: ignore_unparseable_files)
end

.analyse_file(file_path, contents) ⇒ Object



36
37
38
# File 'lib/bibliothecary.rb', line 36

def self.analyse_file(file_path, contents)
  runner.analyse_file(file_path, contents)
end

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

Yields:



84
85
86
# File 'lib/bibliothecary.rb', line 84

def self.configure
  yield(configuration)
end

.find_manifests(path) ⇒ Object



48
49
50
# File 'lib/bibliothecary.rb', line 48

def self.find_manifests(path)
  runner.find_manifests(path)
end

.find_manifests_from_paths(paths) ⇒ Object



52
53
54
# File 'lib/bibliothecary.rb', line 52

def self.find_manifests_from_paths(paths)
  runner.find_manifests_from_paths(paths)
end

.identify_manifests(file_list) ⇒ Object



40
41
42
# File 'lib/bibliothecary.rb', line 40

def self.identify_manifests(file_list)
  runner.identify_manifests(file_list)
end

.ignored_dirsObject



56
57
58
# File 'lib/bibliothecary.rb', line 56

def self.ignored_dirs
  configuration.ignored_dirs
end

.ignored_filesObject



60
61
62
# File 'lib/bibliothecary.rb', line 60

def self.ignored_files
  configuration.ignored_files
end

.init_package_manager(info) ⇒ Object



24
25
26
# File 'lib/bibliothecary.rb', line 24

def self.init_package_manager(info)
  runner.init_package_manager(info)
end

.load_file_info_list(path) ⇒ Object



28
29
30
# File 'lib/bibliothecary.rb', line 28

def self.load_file_info_list(path)
  runner.load_file_info_list(path)
end

.load_file_info_list_from_paths(paths) ⇒ Object



32
33
34
# File 'lib/bibliothecary.rb', line 32

def self.load_file_info_list_from_paths(paths)
  runner.load_file_info_list_from_paths(paths)
end

.load_file_list(path) ⇒ Object

deprecated; use load_file_info_list.



20
21
22
# File 'lib/bibliothecary.rb', line 20

def self.load_file_list(path)
  runner.load_file_list(path)
end

.package_managersObject



44
45
46
# File 'lib/bibliothecary.rb', line 44

def self.package_managers
  runner.package_managers
end

.resetObject



79
80
81
82
# File 'lib/bibliothecary.rb', line 79

def self.reset
  @configuration = Configuration.new
  @runner = Runner.new(@configuration)
end

.runnerObject



68
69
70
71
# File 'lib/bibliothecary.rb', line 68

def self.runner
  configuration
  @runner
end