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/analyser/analysis.rb,
lib/bibliothecary/analyser/matchers.rb,
lib/bibliothecary/parsers/cocoapods.rb,
lib/bibliothecary/parsers/packagist.rb,
lib/bibliothecary/related_files_info.rb,
lib/bibliothecary/analyser/determinations.rb,
lib/bibliothecary/multi_parsers/cyclonedx.rb,
lib/bibliothecary/multi_parsers/json_runtime.rb,
lib/bibliothecary/runner/multi_manifest_filter.rb,
lib/bibliothecary/multi_parsers/dependencies_csv.rb,
lib/bibliothecary/multi_parsers/bundler_like_manifest.rb

Defined Under Namespace

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

Constant Summary collapse

VERSION_OPERATORS = 
/[~^<>*"]/
VERSION = 
"8.5.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object 



95
96
97
98
99
 
# File 'lib/bibliothecary.rb', line 95

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

Class Method Details

.analyse(path, ignore_unparseable_files: true) ⇒ Object Also known as: analyze 



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

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

.analyse_file(file_path, contents) ⇒ Object Also known as: analyze_file 



46
47
48
 
# File 'lib/bibliothecary.rb', line 46

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

.applicable_package_managers(info) ⇒ Object 



30
31
32
 
# File 'lib/bibliothecary.rb', line 30

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

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

Yields:



106
107
108
 
# File 'lib/bibliothecary.rb', line 106

def self.configure
  yield(configuration)
end

.find_manifests(path) ⇒ Object 



58
59
60
 
# File 'lib/bibliothecary.rb', line 58

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

.find_manifests_from_contents(file_path_contents_hash) ⇒ Object 



66
67
68
 
# File 'lib/bibliothecary.rb', line 66

def self.find_manifests_from_contents(file_path_contents_hash)
  runner.find_manifests_from_contents(file_path_contents_hash)
end

.find_manifests_from_paths(paths) ⇒ Object 



62
63
64
 
# File 'lib/bibliothecary.rb', line 62

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

.identify_manifests(file_list) ⇒ Object 



50
51
52
 
# File 'lib/bibliothecary.rb', line 50

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

.ignored_dirs ⇒ Object 



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

def self.ignored_dirs
  configuration.ignored_dirs
end

.ignored_files ⇒ Object 



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

def self.ignored_files
  configuration.ignored_files
end

.load_file_info_list(path) ⇒ Object 



34
35
36
 
# File 'lib/bibliothecary.rb', line 34

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

.load_file_info_list_from_contents(file_path_contents_hash) ⇒ Object 



42
43
44
 
# File 'lib/bibliothecary.rb', line 42

def self.load_file_info_list_from_contents(file_path_contents_hash)
  runner.load_file_info_list_from_contents(file_path_contents_hash)
end

.load_file_info_list_from_paths(paths) ⇒ Object 



38
39
40
 
# File 'lib/bibliothecary.rb', line 38

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.



26
27
28
 
# File 'lib/bibliothecary.rb', line 26

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

.package_managers ⇒ Object 



54
55
56
 
# File 'lib/bibliothecary.rb', line 54

def self.package_managers
  runner.package_managers
end

.reset ⇒ Object 



101
102
103
104
 
# File 'lib/bibliothecary.rb', line 101

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

.runner ⇒ Object 



90
91
92
93
 
# File 'lib/bibliothecary.rb', line 90

def self.runner
  configuration
  @runner
end

.utf8_string(string) ⇒ Object 



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

def self.utf8_string(string)
  string
    .force_encoding("UTF-8") # treat all strings as utf8
    .sub(/^\xEF\xBB\xBF/, '') # remove any Byte Order Marks so JSON, etc don't fail while parsing them.
end