feat: initial version

Author: GordianDziwis

.github/workflows/ci.yml

@@ -0,0 +1,90 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+
+jobs:
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.86.0
+          profile: minimal
+          override: true
+      - uses: Swatinem/rust-cache@v2
+      - uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --all-features --workspace
+
+  rustfmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.86.0
+          profile: minimal
+          override: true
+          components: rustfmt
+      - uses: Swatinem/rust-cache@v2
+      - name: Check formatting
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.86.0
+          profile: minimal
+          override: true
+          components: clippy
+      - uses: Swatinem/rust-cache@v2
+      - name: Clippy check
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: --all-targets --all-features --workspace -- -D warnings
+
+  docs:
+    name: Docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: 1.86.0
+          profile: minimal
+          override: true
+      - uses: Swatinem/rust-cache@v2
+      - name: Check documentation
+        env:
+          RUSTDOCFLAGS: -D warnings
+        uses: actions-rs/cargo@v1
+        with:
+          command: doc
+          args: --no-deps --document-private-items --all-features --workspace --examples
+

.gitignore

@@ -0,0 +1,19 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# RustRover
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "linked-data-core"
+description = "Core library for Linked Data crates"
+homepage = "https://github.com/luminvent/linked-data-core"
+repository = "https://github.com/luminvent/linked-data-core"
+version = "0.0.1"
+edition = "2024"
+license = "MIT"
+
+[dependencies]
+iref = { version = "3", features = ["serde"] }
+proc-macro-error = "1"
+proc-macro2 = "1"
+quote = "1"
+snafu = "0.8"
+syn = { version = "2", features = ["visit", "extra-traits"] }

rustfmt.toml

@@ -0,0 +1 @@
+tab_spaces = 2

src/attributes.rs

@@ -0,0 +1,27 @@
+use iref::IriBuf;
+use snafu::ResultExt;
+use syn::{Attribute, LitStr};
+
+use crate::{Error, InvalidIriSnafu};
+
+mod ast;
+pub mod field;
+mod parse;
+pub mod r#type;
+pub mod variant;
+
+fn parse_ld_attributes<T: syn::parse::Parse>(attrs: &[Attribute]) -> Result<Vec<T>, Error> {
+  Ok(
+    attrs
+      .iter()
+      .filter(|attr| attr.path().is_ident("ld"))
+      .map(|attr| attr.parse_args::<T>())
+      .collect::<Result<_, _>>()?,
+  )
+}
+
+fn parse_iri(lit_iri: LitStr) -> Result<IriBuf, Error> {
+  IriBuf::new(lit_iri.value()).context(InvalidIriSnafu {
+    span: lit_iri.span(),
+  })
+}

src/attributes/ast.rs

@@ -0,0 +1,78 @@
+use syn::LitStr;
+
+/// Represents attribute contents that can be parsed from #[ld(...)] on structs.
+///
+/// Possible formats:
+/// - type = "http://example.org/Person"
+/// - prefix("ex" = "http://example.org/")
+#[derive(Debug)]
+pub enum StructAttribute {
+  Type(TypeAttribute),
+  Prefix(PrefixAttribute),
+}
+
+/// Represents attribute contents that can be parsed from #[ld(...)] on enums.
+///
+/// Possible formats:
+/// - prefix("ex" = "http://example.org/")
+#[derive(Debug)]
+pub enum EnumAttribute {
+  Prefix(PrefixAttribute),
+}
+
+/// Represents attribute contents that can be parsed from #[ld(...)] on enum variants.
+///
+/// Possible formats:
+/// - "http://example.org/property"
+#[derive(Debug)]
+pub enum VariantAttribute {
+  Iri(LitStr),
+}
+
+/// Represents attribute contents that can be parsed from #[ld(...)] on struct fields.
+///
+/// Possible formats:
+/// - ignore
+/// - "http://example.org/property"
+/// - flatten
+/// - id
+/// - type
+/// - graph
+#[derive(Debug)]
+pub enum FieldAttribute {
+  /// Marks the field to be ignored during serialization/deserialization
+  Ignore,
+  /// Specifies the IRI for the field
+  Iri(LitStr),
+  /// Indicates that field's contents should be flattened
+  Flatten,
+  /// Marks the field as an ID field
+  Id,
+  /// Marks the field as a graph value
+  Graph,
+}
+
+/// Represents a type attribute value.
+///
+/// Format: type = "http://example.org/Type" or type = "prefix:Type"
+#[derive(Debug)]
+pub struct TypeAttribute {
+  pub identifier: LitStr,
+}
+
+/// Represents a prefix attribute value.
+///
+/// Format: prefix("ex" = "http://example.org/")
+#[derive(Debug)]
+pub struct PrefixAttribute {
+  pub mapping: PrefixMapping,
+}
+
+/// Represents a prefix mapping with a prefix and an IRI.
+///
+/// Format: "ex" = "http://example.org/"
+#[derive(Debug)]
+pub struct PrefixMapping {
+  pub prefix: LitStr,
+  pub iri: LitStr,
+}

src/attributes/field.rs

@@ -0,0 +1,60 @@
+use iref::IriBuf;
+use snafu::ResultExt;
+
+use crate::attributes::ast::FieldAttribute;
+use crate::attributes::parse_ld_attributes;
+use crate::prefix_mappings::PrefixMappings;
+use crate::{Error, InvalidMappingSnafu};
+
+#[derive(Debug, Default)]
+pub struct RdfFieldAttributes {
+  pub flatten: bool,
+  pub is_graph: bool,
+  pub ignore: bool,
+  pub predicate: Option<IriBuf>,
+  pub is_id: bool,
+}
+
+impl RdfFieldAttributes {
+  pub fn try_from_attrs(
+    attrs: Vec<syn::Attribute>,
+    prefix_mappings: &PrefixMappings,
+  ) -> Result<Self, Error> {
+    let field_attrs = parse_ld_attributes(&attrs)?;
+
+    let mut attributes = RdfFieldAttributes::default();
+
+    for attr in field_attrs {
+      match attr {
+        FieldAttribute::Ignore => {
+          attributes.ignore = true;
+        }
+        FieldAttribute::Iri(lit_str) => {
+          if attributes.predicate.is_some() {
+            return Err(Error::MultipleIris {
+              span: lit_str.span(),
+            });
+          }
+          let iri = prefix_mappings
+            .expand(lit_str.value())
+            .context(InvalidMappingSnafu {
+              span: lit_str.span(),
+            })?;
+          attributes.predicate = Some(iri);
+        }
+        FieldAttribute::Flatten => {
+          attributes.flatten = true;
+        }
+        FieldAttribute::Id => {
+          attributes.is_id = true;
+        }
+
+        FieldAttribute::Graph => {
+          attributes.is_graph = true;
+        }
+      }
+    }
+
+    Ok(attributes)
+  }
+}