Merge pull request #149 from ebroto/feature/license-with-askalono

Replace license crate with askalono

.gitignore

@@ -13,3 +13,6 @@
 
 # nix result from nix-build
 result
+
+# generated license cache
+resources/licenses/cache.bin.gz

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "resources/licenses/spdx"]
+	path = resources/licenses/spdx
+	url = https://github.com/spdx/license-list-data

Cargo.toml

@@ -12,13 +12,16 @@ exclude = ["assets/*.png"]
 colored= "1.8.0"
 git2 = {version = "0.7.5", default-features = false}
 tokei = "10.0"
-license = "0.8.1"
+askalono = "0.3.0"
 bytecount = "0.5.1"
 clap = "2.33.0"
 strum = "0.16.0"
 strum_macros = "0.16.0"
 image = "0.22.3"
 
+[build-dependencies]
+askalono = "0.3.0"
+
 [target.'cfg(windows)'.dependencies]
 ansi_term = "0.12"
 

build.rs

@@ -0,0 +1,23 @@
+extern crate askalono;
+
+use std::fs::File;
+use std::path::Path;
+
+use askalono::Store;
+
+const EMBEDDED_CACHE: &str = "resources/licenses/cache.bin.gz";
+
+fn main() {
+    if Path::new(EMBEDDED_CACHE).exists() {
+        println!("cargo:warning=onefetch license cache file already exists; not re-building");
+        return;
+    }
+
+    let mut store = Store::new();
+    store
+        .load_spdx(Path::new("resources/licenses/spdx/json/details"), false)
+        .expect("Couldn't create a store from SPDX data. Have submodules been initialized?");
+
+    let mut cache = File::create(EMBEDDED_CACHE).unwrap();
+    store.to_cache(&mut cache).unwrap();
+}

src/error.rs

@@ -16,6 +16,8 @@ pub enum Error {
     ReferenceInfoError,
     /// Image probably doesn't exist or has wrong format
     ImageLoadError,
+    /// Could not initialize the license detector
+    LicenseDetectorError,
 }
 
 impl std::fmt::Debug for Error {
@@ -29,6 +31,7 @@ impl std::fmt::Debug for Error {
             Error::BareGitRepo => "Unable to run onefetch on bare git repos",
             Error::ReferenceInfoError => "Error while retrieving reference information",
             Error::ImageLoadError => "Could not load the specified image",
+            Error::LicenseDetectorError => "Could not initialize the license detector",
         };
         write!(f, "{}", content)
     }

src/info.rs

@@ -6,7 +6,7 @@ use std::process::Command;
 use colored::{Color, ColoredString, Colorize};
 use git2::Repository;
 use image::DynamicImage;
-use license;
+use license::Detector;
 
 use crate::image_backends;
 use crate::language::Language;
@@ -581,6 +581,8 @@ impl Info {
     }
 
     fn get_project_license(dir: &str) -> Result<String> {
+        let detector = Detector::new()?;
+
         let output = fs::read_dir(dir)
             .map_err(|_| Error::ReadDirectory)?
             .filter_map(std::result::Result::ok)
@@ -596,9 +598,9 @@ impl Info {
                 }, // TODO: multiple prefixes, like COPYING?
             )
             .filter_map(|entry| {
-                license::from_text_ext(&fs::read_to_string(entry).unwrap_or_else(|_| "".into()))
+                let contents = fs::read_to_string(entry).unwrap_or_default();
+                detector.analyze(&contents)
             })
-            .map(|license| license.name().to_string())
             .collect::<Vec<_>>()
             .join(", ");
 

src/license.rs

@@ -0,0 +1,26 @@
+use askalono::{Store, TextData};
+
+use crate::Error;
+
+type Result<T> = std::result::Result<T, Error>;
+
+static CACHE_DATA: &[u8] = include_bytes!("../resources/licenses/cache.bin.gz");
+
+pub struct Detector {
+    store: Store,
+}
+
+impl Detector {
+    pub fn new() -> Result<Self> {
+        Store::from_cache(CACHE_DATA)
+            .map(|store| Self { store })
+            .map_err(|_| Error::LicenseDetectorError)
+    }
+
+    pub fn analyze(&self, text: &str) -> Option<String> {
+        self.store
+            .analyze(&TextData::from(text))
+            .ok()
+            .map(|license| license.name)
+    }
+}

src/main.rs

@@ -1,8 +1,8 @@
 extern crate bytecount;
 
+extern crate askalono;
 extern crate colored;
 extern crate git2;
-extern crate license;
 extern crate tokei;
 #[macro_use]
 extern crate clap;
@@ -33,6 +33,7 @@ mod error;
 mod image_backends;
 mod info;
 mod language;
+mod license;
 
 use ascii_art::AsciiArt;
 use commit_info::CommitInfo;