feat: Slightly refactor public API (#17)

Author: mitsuhiko

src/decoder.rs

@@ -256,7 +256,7 @@ fn decode_index(rsm: RawSourceMap) -> Result<SourceMapIndex> {
         _ => "<invalid>".into(),
     });
 
-    Ok(SourceMapIndex::new(
+    Ok(SourceMapIndex::new_ram_bundle_compatible(
         file,
         sections,
         rsm.x_facebook_offsets,

src/ram_bundle.rs

@@ -334,7 +334,7 @@ fn test_basic_ram_bundle_split() -> std::result::Result<(), Box<std::error::Erro
     let sourcemap_file = File::open("./tests/fixtures/ram_bundle/basic.jsbundle.map")?;
     let ism = SourceMapIndex::from_reader(sourcemap_file)?;
 
-    assert!(ism.is_for_react_native());
+    assert!(ism.is_for_ram_bundle());
 
     let x_facebook_offsets = ism.x_facebook_offsets().unwrap();
     assert_eq!(x_facebook_offsets.len(), 5);

src/types.rs

@@ -791,6 +791,25 @@ impl SourceMapIndex {
     pub fn new(
         file: Option<String>,
         sections: Vec<SourceMapSection>,
+    ) -> SourceMapIndex {
+        SourceMapIndex {
+            file,
+            sections,
+            x_facebook_offsets: None,
+            x_metro_module_paths: None,
+        }
+    }
+
+    /// Constructs a new sourcemap index from raw components including the
+    /// facebook RAM bundle extensions.
+    ///
+    /// - `file`: an optional filename of the index
+    /// - `sections`: a vector of source map index sections
+    /// - `x_facebook_offsets`: a vector of facebook offsets
+    /// - `x_metro_module_paths`: a vector of metro module paths
+    pub fn new_ram_bundle_compatible(
+        file: Option<String>,
+        sections: Vec<SourceMapSection>,
         x_facebook_offsets: Option<Vec<Option<u32>>>,
         x_metro_module_paths: Option<Vec<String>>,
     ) -> SourceMapIndex {
@@ -905,16 +924,19 @@ impl SourceMapIndex {
         self.flatten()?.rewrite(options)
     }
 
-    pub fn is_for_react_native(&self) -> bool {
+    /// Returns `true` if this sourcemap is for a RAM bundle.
+    pub fn is_for_ram_bundle(&self) -> bool {
         self.x_facebook_offsets.is_some() && self.x_metro_module_paths.is_some()
     }
 
-    pub fn x_facebook_offsets(&self) -> Option<&Vec<Option<u32>>> {
-        self.x_facebook_offsets.as_ref()
+    /// Returns embeded x-facebook-offset values.
+    pub fn x_facebook_offsets(&self) -> Option<&[Option<u32>]> {
+        self.x_facebook_offsets.as_ref().map(|x| &x[..])
     }
 
-    pub fn x_metro_module_paths(&self) -> Option<&Vec<String>> {
-        self.x_metro_module_paths.as_ref()
+    /// Returns embedded metro module paths.
+    pub fn x_metro_module_paths(&self) -> Option<&[String]> {
+        self.x_metro_module_paths.as_ref().map(|x| &x[..])
     }
 }
 

tests/test_index.rs

@@ -51,7 +51,7 @@ fn test_basic_indexed_sourcemap() {
     files.insert("file2.js", f2.lines().collect());
 
     let mut ism = SourceMapIndex::from_reader(input).unwrap();
-    assert!(!ism.is_for_react_native());
+    assert!(!ism.is_for_ram_bundle());
 
     for section_id in 0..ism.get_section_count() {
         let section = ism.get_section_mut(section_id).unwrap();
@@ -135,5 +135,5 @@ fn test_indexed_sourcemap_for_react_native() {
     }"#;
 
     let ism = SourceMapIndex::from_reader(input).unwrap();
-    assert!(ism.is_for_react_native());
+    assert!(ism.is_for_ram_bundle());
 }