mezzaluna_load_path/
lib.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
#![warn(clippy::all)]
#![warn(clippy::pedantic)]
#![warn(clippy::cargo)]
#![allow(clippy::manual_let_else)]
#![allow(clippy::question_mark)] // https://github.com/rust-lang/rust-clippy/issues/8281
#![allow(unknown_lints)]
#![warn(missing_docs)]
#![warn(missing_debug_implementations)]
#![warn(missing_copy_implementations)]
#![warn(rust_2018_idioms)]
#![warn(rust_2021_compatibility)]
#![warn(trivial_casts, trivial_numeric_casts)]
#![warn(unused_qualifications)]
#![warn(variant_size_differences)]
#![forbid(unsafe_code)]
// Enable feature callouts in generated documentation:
// https://doc.rust-lang.org/beta/unstable-book/language-features/doc-cfg.html
//
// This approach is borrowed from tokio.
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(docsrs, feature(doc_alias))]

//! Ruby load path builders.
//!
//! An Artichoke Ruby VM may load code (called "features") from several file
//! system locations. These locations form the `$LOAD_PATH` global.
//!
//! Code and native extensions from the Ruby Core library and Ruby Standard
//! Library can be loaded from an [in-memory virtual file system].
//!
//! [in-memory virtual file system]: RubyCore
//!
#![cfg_attr(feature = "rubylib", doc = "Users can prepend items to the load path at interpreter")]
#![cfg_attr(
    feature = "rubylib",
    doc = "boot by setting the [`RUBYLIB` environment variable](Rubylib)."
)]
//!
//! This crate exports builders which can be used to construct the initial load
//! path at interpreter boot. See their documentation for more details.
//!
//! # Examples
//!
//! ```
//! # #[cfg(feature = "rubylib")]
//! # fn example() -> Option<()> {
//! use std::ffi::OsStr;
//! use std::path::PathBuf;
//! use mezzaluna_load_path::{RubyCore, Rubylib};
//!
//! let core_loader = RubyCore::new();
//! let rubylib_loader = Rubylib::with_rubylib(OsStr::new("lib"))?;
//!
//! // Assemble the load path in priority order.
//! let load_path = rubylib_loader
//!     .into_load_path()
//!     .into_iter()
//!     .chain(core_loader.load_path().into_iter().map(PathBuf::from))
//!     .collect::<Box<[PathBuf]>>();
//!
//! assert_eq!(load_path.len(), 3);
//! # Some(())
//! # }
//! # #[cfg(feature = "rubylib")]
//! # example().unwrap();
//! ```

// Ensure code blocks in `README.md` compile
#[cfg(all(doctest, feature = "rubylib"))]
#[doc = include_str!("../README.md")]
mod readme {}

mod ruby_core;
#[cfg(feature = "rubylib")]
mod rubylib;

pub use ruby_core::RubyCore;
#[cfg(feature = "rubylib")]
pub use rubylib::Rubylib;

#[cfg(all(test, feature = "rubylib"))]
mod tests {
    use std::ffi::OsStr;
    use std::path::{Path, PathBuf};

    use super::*;

    #[test]
    fn test_assemble_load_path() {
        let core_loader = RubyCore::new();
        let rubylib_loader = Rubylib::with_rubylib(OsStr::new("lib")).unwrap();

        // Assemble the load path in priority order.
        let load_path = rubylib_loader
            .into_load_path()
            .into_iter()
            .chain(core_loader.load_path().into_iter().map(PathBuf::from))
            .collect::<Box<[PathBuf]>>();

        assert_eq!(load_path.len(), 3);
        assert_eq!(load_path.first().unwrap(), Path::new("lib"));
    }
}