Merge pull request #10 from felipesanches/more_checks_2024_sep_20

More checks (2024/09/20)

Author: simoncozens

.gitignore

@@ -3,5 +3,4 @@ foo*
 python
 docs
 Cargo.lock
-*.ttf
 flamegraph.svg

fontspector-checkapi/Cargo.toml

@@ -11,7 +11,9 @@ crate-type = ["cdylib", "rlib"]
 pluginator = {workspace = true}
 
 [dependencies]
+font-types = { workspace = true }
 read-fonts = {workspace = true}
+write-fonts = { workspace = true }
 skrifa = {workspace = true}
 fontspector-checkhelper = {workspace = true}
 

fontspector-checkapi/src/codetesting.rs

@@ -0,0 +1,99 @@
+use crate::{
+    prelude::*,
+    Check,
+    CheckResult,
+    Context,
+    FileTypeConvert,
+    StatusCode,
+};
+use font_types::NameId;
+use read_fonts::TableProvider;
+use serde_json::Map;
+use write_fonts::{
+    FontBuilder,
+    tables::name::{Name, NameRecord}
+};
+
+#[macro_export] macro_rules! TEST_FILE {
+    ($fname:expr) => {
+        Testable::new(concat!(
+            env!("CARGO_MANIFEST_DIR"),
+            "/resources/test/",
+            $fname
+        ))
+        .unwrap()
+    };
+}
+
+pub fn run_check(
+    check: Check<'_>,
+    font: Testable,
+) -> std::option::Option<CheckResult> {
+    let ctx: Context = Context {
+        skip_network: false,
+        network_timeout: Some(10),
+        configuration: Map::new(),
+        check_metadata: check.metadata(),
+    };
+    check.run(&TestableType::Single(&font), &ctx, None)
+}
+
+pub fn assert_pass(check_result: std::option::Option<CheckResult>) {
+    let status = check_result.unwrap().worst_status();
+    assert_eq!(status, StatusCode::Pass);
+}
+
+pub fn assert_results_contain(
+    check_result: std::option::Option<CheckResult>,
+    severity: StatusCode,
+    code: Option<String>,
+) {
+    let subresults = check_result.unwrap().subresults;
+    assert!(subresults
+        .iter()
+        .any(|subresult| subresult.severity == severity && subresult.code == code));
+}
+
+pub fn set_name_entry(font: &mut Testable, platform: u16, encoding: u16, language: u16, nameid: NameId, new_string: String){
+    use std::collections::BTreeSet;
+
+    let f = TTF.from_testable(&font).unwrap();
+    let name = f.font().name().unwrap();
+
+    let new_record = NameRecord::new(
+        platform,
+        encoding,
+        language,
+        nameid,
+        new_string.to_string().into(),
+    );
+    let mut new_records: BTreeSet<NameRecord> = name
+        .name_record()
+        .iter()
+        .filter(|record| record.name_id() != nameid)
+        .map(|r| {
+            #[allow(clippy::unwrap_used)]
+            NameRecord::new(
+                r.platform_id(),
+                r.encoding_id(),
+                r.language_id(),
+                r.name_id(),
+                r.string(name.string_data())
+                    .unwrap()
+                    .chars()
+                    .collect::<String>()
+                    .to_string()
+                    .into(),
+            )
+        })
+        .collect();
+    new_records.insert(new_record);
+    let new_nametable = Name::new(new_records);
+    let new_bytes = FontBuilder::new()
+        .add_table(&new_nametable)
+        .unwrap()
+        .copy_missing_tables(f.font())
+        .build();
+
+    font.contents = new_bytes;
+}

fontspector-checkapi/src/lib.rs

@@ -1,6 +1,7 @@
 #![deny(clippy::unwrap_used, clippy::expect_used)]
 mod check;
 mod checkresult;
+pub mod codetesting;
 pub mod constants;
 mod context;
 mod filetype;

profile-googlefonts/Cargo.toml

@@ -4,12 +4,16 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+chrono = "0.4.38"                                                                              # For metadata date checks
 fontspector-checkapi = { path = "../fontspector-checkapi" }
-protobuf ={ git = "https://github.com/cmyr/rust-protobuf", branch="parse-unicode-strings" }
+font-types = { workspace = true }
+google-fonts-languages = { git = "https://github.com/googlefonts/lang", branch = "rust" }
 itertools = "0.13.0"
-
-chrono="0.4.38"  # For metadata date checks
-google-fonts-languages = { git="https://github.com/googlefonts/lang", branch = "rust" }
+protobuf = { git = "https://github.com/cmyr/rust-protobuf", branch = "parse-unicode-strings" }
+read-fonts = { workspace = true }
+write-fonts = { workspace = true }
+regex = "1.10.6"
+skrifa = { workspace = true }
 
 [build-dependencies]
-protobuf-codegen ={ git = "https://github.com/cmyr/rust-protobuf", branch="parse-unicode-strings" }
+protobuf-codegen = { git = "https://github.com/cmyr/rust-protobuf", branch = "parse-unicode-strings" }

profile-googlefonts/resources/test/nunito/DESCRIPTION.en_us.html

@@ -0,0 +1 @@
+<p>Nunito is a well balanced Sans Serif with rounded terminals. Nunito has been designed mainly to be used as a display font but is useable as a text font too. Nunito has been designed to be used freely across the internet by web browsers on desktop computers, laptops and mobile devices.</p>

profile-googlefonts/resources/test/nunito/METADATA.pb

@@ -0,0 +1,135 @@
+name: "Nunito"
+designer: "Vernon Adams"
+license: "OFL"
+category: "SANS_SERIF"
+date_added: "2012-08-12"
+fonts {
+  name: "Nunito"
+  style: "normal"
+  weight: 200
+  filename: "Nunito-ExtraLight.ttf"
+  post_script_name: "Nunito-ExtraLight"
+  full_name: "Nunito ExtraLight"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "italic"
+  weight: 200
+  filename: "Nunito-ExtraLightItalic.ttf"
+  post_script_name: "Nunito-ExtraLightItalic"
+  full_name: "Nunito ExtraLight Italic"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "normal"
+  weight: 300
+  filename: "Nunito-Light.ttf"
+  post_script_name: "Nunito-Light"
+  full_name: "Nunito Light"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "italic"
+  weight: 300
+  filename: "Nunito-LightItalic.ttf"
+  post_script_name: "Nunito-LightItalic"
+  full_name: "Nunito Light Italic"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "normal"
+  weight: 400
+  filename: "Nunito-Regular.ttf"
+  post_script_name: "Nunito-Regular"
+  full_name: "Nunito Regular"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "italic"
+  weight: 400
+  filename: "Nunito-Italic.ttf"
+  post_script_name: "Nunito-Italic"
+  full_name: "Nunito Italic"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "normal"
+  weight: 600
+  filename: "Nunito-SemiBold.ttf"
+  post_script_name: "Nunito-SemiBold"
+  full_name: "Nunito SemiBold"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "italic"
+  weight: 600
+  filename: "Nunito-SemiBoldItalic.ttf"
+  post_script_name: "Nunito-SemiBoldItalic"
+  full_name: "Nunito SemiBold Italic"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "normal"
+  weight: 700
+  filename: "Nunito-Bold.ttf"
+  post_script_name: "Nunito-Bold"
+  full_name: "Nunito Bold"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "italic"
+  weight: 700
+  filename: "Nunito-BoldItalic.ttf"
+  post_script_name: "Nunito-BoldItalic"
+  full_name: "Nunito Bold Italic"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "normal"
+  weight: 800
+  filename: "Nunito-ExtraBold.ttf"
+  post_script_name: "Nunito-ExtraBold"
+  full_name: "Nunito ExtraBold"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "italic"
+  weight: 800
+  filename: "Nunito-ExtraBoldItalic.ttf"
+  post_script_name: "Nunito-ExtraBoldItalic"
+  full_name: "Nunito ExtraBold Italic"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "normal"
+  weight: 900
+  filename: "Nunito-Black.ttf"
+  post_script_name: "Nunito-Black"
+  full_name: "Nunito Black"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+fonts {
+  name: "Nunito"
+  style: "italic"
+  weight: 900
+  filename: "Nunito-BlackItalic.ttf"
+  post_script_name: "Nunito-BlackItalic"
+  full_name: "Nunito Black Italic"
+  copyright: "Copyright 2014 The Nunito Project Authors ([email protected])"
+}
+subsets: "latin"
+subsets: "latin-ext"
+subsets: "menu"
+subsets: "vietnamese"

profile-googlefonts/resources/test/nunito/Nunito-Black.ttf

@@ -0,0 +1,93 @@
+Copyright 2014 The Nunito Project Authors ([email protected])
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.