feat(enum): add basic enum support

* feat(enum): add basic enum support

Fixes: #178
Refs: #302

* feat(enum): add support for string backed enums

Refs: #178

* ci(enum): exclude `enum` feature on PHP 8.0

Refs: #178

* feat(enum): implement `IntoZval` and `FromZval` for enums

Refs: #178

* feat(enum): implement `TryFrom` and `Into` for backed enum

Refs: #178

* feat(enum): add stub generation

Refs: #178

* docs(enum): extend enum documentation

Refs: #178

* refactor(enum): use `value` for discriminants to be less verbose

Refs: #178

* test(enum): add enum testcases

Refs: #178

* refactor(enum): use raii box pattern for enum values

Refs: #178

Author: Xenira

.github/workflows/build.yml

@@ -80,6 +80,7 @@ jobs:
         env:
           DOCS_RS: ""
         run: cargo clean && cargo build
+
   build:
     name: Build and Test
     runs-on: ${{ matrix.os }}
@@ -161,12 +162,12 @@ jobs:
       - name: Build
         env:
           EXT_PHP_RS_TEST: ""
-        run: cargo build --release --features closure,anyhow --all
+        run: cargo build --release --features closure,anyhow --workspace ${{ matrix.php == '8.0' && '--no-default-features' || '' }}
       # Test
       - name: Test inline examples
         # Macos fails on unstable rust. We skip the inline examples test for now.
         if: "!(contains(matrix.os, 'macos') && matrix.rust == 'nightly')"
-        run: cargo test --release --all --features closure,anyhow --no-fail-fast
+        run: cargo test --release --workspace --features closure,anyhow --no-fail-fast ${{ matrix.php == '8.0' && '--no-default-features' || '' }}
   build-zts:
     name: Build with ZTS
     runs-on: ubuntu-latest

.github/workflows/coverage.yml

@@ -2,10 +2,10 @@ name: coverage
 on:
   push:
     branches-ignore:
-      - 'release-plz-*'
+      - "release-plz-*"
   pull_request:
     branches-ignore:
-      - 'release-plz-*'
+      - "release-plz-*"
 env:
   # increment this manually to force cache eviction
   RUST_CACHE_PREFIX: "v0-rust"
@@ -63,6 +63,6 @@ jobs:
           cargo tarpaulin --version
       - name: Run tests
         run: |
-          cargo tarpaulin --engine llvm --workspace --all-features --tests --exclude tests --exclude-files docsrs_bindings.rs --timeout 120 --out Xml
+          cargo tarpaulin --engine llvm --workspace --all-features --tests --exclude tests --exclude-files docsrs_bindings.rs --exclude-files "crates/macros/tests/expand/*.expanded.rs" --timeout 120 --out Xml
       - name: Upload coverage
         uses: coverallsapp/github-action@v2

.lefthook.yml

@@ -17,8 +17,8 @@ pre-commit:
         The `docsrs_bindings.rs` file seems to be out of date.
         Please check the updated bindings in `docsrs_bindings.rs` and commit the changes.
     - name: "macro docs"
-      run: tools/update_lib_docs.sh && git diff --exit-code crates/macros/src/lib.rs
-      glob: "guide/src/macros/*.md"
-      fail_text: |
-        The macro crates documentation seems to be out of date.
-        Please check the updated documentation in `crates/macros/src/lib.rs` and commit the changes.
+      run: tools/update_lib_docs.sh
+      glob:
+        - "guide/src/macros/*.md"
+        - "crates/macros/src/lib.rs"
+      stage_fixed: true

Cargo.toml

@@ -38,9 +38,11 @@ native-tls = "0.2"
 zip = "4.0"
 
 [features]
+default = ["enum"]
 closure = []
 embed = []
 anyhow = ["dep:anyhow"]
+enum = []
 
 [workspace]
 members = [

allowed_bindings.rs

@@ -87,6 +87,9 @@ bind! {
     zend_declare_class_constant,
     zend_declare_property,
     zend_do_implement_interface,
+    zend_enum_add_case,
+    zend_enum_get_case,
+    zend_enum_new,
     zend_execute_data,
     zend_function_entry,
     zend_hash_clean,
@@ -114,6 +117,7 @@ bind! {
     zend_register_bool_constant,
     zend_register_double_constant,
     zend_register_ini_entries,
+    zend_register_internal_enum,
     zend_ini_entry_def,
     zend_register_internal_class_ex,
     zend_register_long_constant,
@@ -191,6 +195,7 @@ bind! {
     ZEND_ACC_DEPRECATED,
     ZEND_ACC_DONE_PASS_TWO,
     ZEND_ACC_EARLY_BINDING,
+    ZEND_ACC_ENUM,
     ZEND_ACC_FAKE_CLOSURE,
     ZEND_ACC_FINAL,
     ZEND_ACC_GENERATOR,

build.rs

@@ -261,7 +261,7 @@ fn generate_bindings(defines: &[(&str, &str)], includes: &[PathBuf]) -> Result<S
     Ok(bindings)
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
 enum ApiVersion {
     Php80 = 2020_09_30,
     Php81 = 2021_09_02,
@@ -272,8 +272,15 @@ enum ApiVersion {
 
 impl ApiVersion {
     /// Returns the minimum API version supported by ext-php-rs.
-    pub const fn min() -> Self {
-        ApiVersion::Php80
+    pub fn min() -> Self {
+        [
+            ApiVersion::Php80,
+            #[cfg(feature = "enum")]
+            ApiVersion::Php81,
+        ]
+        .into_iter()
+        .max()
+        .unwrap_or(Self::max())
     }
 
     /// Returns the maximum API version supported by ext-php-rs.

crates/cli/Cargo.toml

@@ -11,7 +11,7 @@ edition = "2018"
 categories = ["api-bindings", "command-line-interface"]
 
 [dependencies]
-ext-php-rs = { version = "0.14", path = "../../" }
+ext-php-rs = { version = "0.14", default-features = false, path = "../../" }
 
 clap = { version = "4.0", features = ["derive"] }
 anyhow = "1"
@@ -22,3 +22,7 @@ semver = "1.0"
 
 [lints.rust]
 missing_docs = "warn"
+
+[features]
+default = ["enum"]
+enum = ["ext-php-rs/enum"]

crates/macros/Cargo.toml

@@ -6,7 +6,7 @@ homepage = "https://github.com/davidcole1340/ext-php-rs"
 license = "MIT OR Apache-2.0"
 version = "0.11.2"
 authors = ["David Cole <[email protected]>"]
-edition = "2018"
+edition = "2021"
 
 [lib]
 proc-macro = true
@@ -19,6 +19,7 @@ proc-macro2 = "1.0.26"
 lazy_static = "1.4.0"
 anyhow = "1.0"
 convert_case = "0.8.0"
+itertools = "0.14.0"
 
 [lints.rust]
 missing_docs = "warn"