Typos and cleanup (#356)

* #355 typo

* #354 clearer message for public mode

* #353 rename static folder to templates

* #351 remove config subcommand

* #352 preffered - preferred

* #349 typo default env

* #357 try --locked build

Author: joepio

.github/workflows/main.yml

@@ -56,13 +56,14 @@ jobs:
       - name: Install cargo-llvm-cov
         uses: taiki-e/install-action@cargo-llvm-cov
       - name: Generate code coverage
-        run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
+        run: cargo llvm-cov --all-features --workspace --lcov --locked --output-path lcov.info
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: lcov.info
           fail_ci_if_error: true
+
   fmt:
     name: Rustfmt
     runs-on: ubuntu-latest

cli/src/main.rs

@@ -192,14 +192,6 @@ fn main() -> AtomicResult<()> {
                     .required(true)
                 )
         )
-        .subcommand(
-            Command::new("config")
-                .about("Returns the path of the config file")
-                .arg(Arg::new("subject")
-                    .help("Subject URL or bookmark of the resource to be destroyed")
-                    .required(true)
-                )
-        )
         .subcommand(Command::new("list").about("List all bookmarks"))
         .subcommand(Command::new("validate").about("Validates the store").hide(true))
         .get_matches();

cli/src/new.rs

@@ -43,7 +43,7 @@ pub fn new(context: &mut Context) -> AtomicResult<()> {
 fn prompt_instance<'a>(
     context: &'a Context,
     class: &Class,
-    preffered_shortname: Option<String>,
+    preferred_shortname: Option<String>,
 ) -> CLIResult<(Resource, Option<String>)> {
     // Not sure about the best way t
     // The Path is the thing at the end of the URL, from the domain
@@ -54,7 +54,7 @@ fn prompt_instance<'a>(
     let write_ctx = context.get_write_context();
 
     let mut subject = format!("{}/{}", write_ctx.server, path);
-    if let Some(sn) = &preffered_shortname {
+    if let Some(sn) = &preferred_shortname {
         subject = format!("{}/{}-{}", write_ctx.server, path, sn);
     }
 
@@ -68,15 +68,15 @@ fn prompt_instance<'a>(
 
     for prop_subject in &class.requires {
         let field = context.store.get_property(prop_subject)?;
-        if field.subject == atomic_lib::urls::SHORTNAME && preffered_shortname.clone().is_some() {
+        if field.subject == atomic_lib::urls::SHORTNAME && preferred_shortname.clone().is_some() {
             new_resource.set_propval_string(
                 field.subject.clone(),
-                &preffered_shortname.clone().unwrap(),
+                &preferred_shortname.clone().unwrap(),
                 &context.store,
             )?;
             println!(
                 "Shortname set to {}",
-                preffered_shortname.clone().unwrap().bold().green()
+                preferred_shortname.clone().unwrap().bold().green()
             );
             continue;
         }

cli/src/print.rs

@@ -12,10 +12,10 @@ use crate::Context;
 pub const SERIALIZE_OPTIONS: [&str; 7] =
     ["pretty", "json", "jsonld", "jsonad", "nt", "turtle", "n3"];
 
-/// Returns preffered serialization format. Defaults to pretty.
+/// Returns preferred serialization format. Defaults to pretty.
 pub fn get_serialization(argmatches: &ArgMatches) -> AtomicResult<Format> {
-    let format = if let Some(preffered_format) = argmatches.value_of("as") {
-        match preffered_format {
+    let format = if let Some(preferred_format) = argmatches.value_of("as") {
+        match preferred_format {
             "pretty" => (Format::Pretty),
             "json" => (Format::Json),
             "jsonld" => (Format::JsonLd),

server/default.env

@@ -1,5 +1,6 @@
-# This file contains default environment variables for runnign atomic-server.
-# You can also set these using the command line by passing flags, such as `atomic-server --domain localhost`.
+# This file contains default environment variables for running atomic-server.
+# You can also set these using the command line by passing flags,
+# such as `atomic-server --domain localhost`.
 # Uncomment lines (remove the `#`) where you want to make adjustments.
 
 # domain name where the server is hosted, including subdoman, without schema (http) and port

server/openapi.yml

@@ -14,7 +14,7 @@ paths:
   "/":
     get:
       summary: Get a resource
-      description: Send an HTTP GET request to the URL of the resource. The preffered serialization format is [JSON-AD](https://docs.atomicdata.dev/core/json-ad.html), since that contains full URLs, but it also supports plain JSON, JSON-LD, Turtle and N-Triples.
+      description: Send an HTTP GET request to the URL of the resource. The preferred serialization format is [JSON-AD](https://docs.atomicdata.dev/core/json-ad.html), since that contains full URLs, but it also supports plain JSON, JSON-LD, Turtle and N-Triples.
       parameters:
         - in: header
           name: x-atomic-public-key

server/src/config.rs

@@ -65,15 +65,15 @@ pub struct Opts {
     #[clap(long, env = "ATOMIC_CONFIG_DIR")]
     pub config_dir: Option<PathBuf>,
 
-    /// CAUTION: Makes data public on the `/search` endpoint. When enabled, it allows POSTing to the /search endpoint and returns search results as single triples, without performing authentication checks. See https://github.com/joepio/atomic-data-rust/blob/master/server/rdf-search.md
+    /// CAUTION: Makes data publicly readable on the `/search` endpoint. When enabled, it allows POSTing to the /search endpoint and returns search results as single triples, without performing authentication checks. See https://github.com/joepio/atomic-data-rust/blob/master/server/rdf-search.md
     #[clap(long, env = "ATOMIC_RDF_SEARCH")]
     pub rdf_search: bool,
 
-    /// By default, Atomic-Server keeps previous verions of resources indexed in Search. When enabling this flag, previous versions of resources are removed from the search index when their values are updated.
+    /// By default, Atomic-Server keeps previous versions of resources indexed in Search. When enabling this flag, previous versions of resources are removed from the search index when their values are updated.
     #[clap(long, env = "ATOMIC_REMOVE_PREVIOUS_SEARCH")]
     pub remove_previous_search: bool,
 
-    /// CAUTION: Skip authentication checks, making all data public. Improves performance.
+    /// CAUTION: Skip authentication checks, making all data publicly readable. Improves performance.
     #[clap(long, env = "ATOMIC_PUBLIC_MODE")]
     pub public_mode: bool,
 

server/src/content_types.rs

@@ -43,7 +43,7 @@ impl ContentType {
     }
 }
 
-/// Returns the preffered content type.
+/// Returns the preferred content type.
 /// Defaults to HTML if none is found.
 pub fn get_accept(map: &HeaderMap) -> ContentType {
     let accept_header = match map.get("Accept") {

server/src/handlers/single_page_app.rs

@@ -6,7 +6,7 @@ use actix_web::HttpResponse;
 pub async fn single_page(
     appstate: actix_web::web::Data<AppState>,
 ) -> AtomicServerResult<HttpResponse> {
-    let template = include_str!("../../static/atomic-data-browser.html");
+    let template = include_str!("../../templates/atomic-data-browser.html");
     let body = template
         .replace("{ script }", &appstate.config.opts.script)
         .replace("{ asset_url }", &appstate.config.opts.asset_url);