Refactor module paths (#101)

* Refactor module layout

* Fixed documentation tests

* Removed skel, moved macro crate

* Ignore folders for crate publish

* Fix builder for zts

* Add `rustfmt.toml`, wrap all comments #96

* Fixed up documentation links, tidied up

* Add `Zend` prefix to callable and hashtable

* Updated guide types

* Updated changelog

Author: davidcole1340

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Version 0.6.0
+
+- Reorganized project. [#101]
+  - Changed (almost all) module paths. Too many changes to list them all, check
+    out the docs.
+  - Removed `skel` project.
+
+[#101]: https://github.com/davidcole1340/ext-php-rs/pull/101
+
 ## Version 0.5.3
 
 - Fixed docs.rs PHP bindings file.

Cargo.toml

@@ -9,11 +9,12 @@ version = "0.5.3"
 authors = ["David Cole <[email protected]>"]
 edition = "2018"
 categories = ["api-bindings"]
+exclude = ["/.github", "/.crates", "/guide"]
 
 [dependencies]
 bitflags = "1.2.1"
 parking_lot = "0.11.2"
-ext-php-rs-derive = { version = "=0.5.2", path = "./ext-php-rs-derive" }
+ext-php-rs-derive = { version = "=0.5.2", path = "./crates/macros" }
 
 [build-dependencies]
 bindgen = { version = "0.59" }
@@ -25,8 +26,7 @@ closure = []
 
 [workspace]
 members = [
-    "ext-php-rs-derive",
-    "example/skel"
+    "crates/macros",
 ]
 
 [package.metadata.docs.rs]

README.md

@@ -85,8 +85,6 @@ easily), structs have to be hard coded in.
 
 Check out one of the example projects:
 
-- [ext-skel](example/skel) - Testbed for testing the library. Check out previous
-  commits as well to see what else is possible.
 - [anonaddy-sequoia](https://gitlab.com/willbrowning/anonaddy-sequoia) - Sequoia
   encryption PHP extension.
 - [opus-php](https://github.com/davidcole1340/opus-php/tree/rewrite_rs) -

build.rs

@@ -12,8 +12,8 @@ const MAX_PHP_API_VER: u32 = 20200930;
 
 fn main() {
     // rerun if wrapper header is changed
-    println!("cargo:rerun-if-changed=src/wrapper/wrapper.h");
-    println!("cargo:rerun-if-changed=src/wrapper/wrapper.c");
+    println!("cargo:rerun-if-changed=src/wrapper.h");
+    println!("cargo:rerun-if-changed=src/wrapper.c");
 
     let out_path = PathBuf::from(env::var("OUT_DIR").unwrap()).join("bindings.rs");
 
@@ -40,8 +40,8 @@ fn main() {
     }
 
     // Ensure the PHP API version is supported.
-    // We could easily use grep and sed here but eventually we want to support Windows,
-    // so it's easier to just use regex.
+    // We could easily use grep and sed here but eventually we want to support
+    // Windows, so it's easier to just use regex.
     let php_i_cmd = Command::new("php")
         .arg("-i")
         .output()
@@ -71,7 +71,7 @@ fn main() {
 
     // Build `wrapper.c` and link to Rust.
     cc::Build::new()
-        .file("src/wrapper/wrapper.c")
+        .file("src/wrapper.c")
         .includes(
             str::replace(includes.as_ref(), "-I", "")
                 .split(' ')
@@ -80,7 +80,7 @@ fn main() {
         .compile("wrapper");
 
     let mut bindgen = bindgen::Builder::default()
-        .header("src/wrapper/wrapper.h")
+        .header("src/wrapper.h")
         .clang_args(includes.split(' '))
         .parse_callbacks(Box::new(bindgen::CargoCallbacks))
         .rustfmt_bindings(true)
@@ -143,8 +143,9 @@ impl Configure {
     }
 }
 
-/// Array of functions/types used in `ext-php-rs` - used to allowlist when generating
-/// bindings, as we don't want to generate bindings for everything (i.e. stdlib headers).
+/// Array of functions/types used in `ext-php-rs` - used to allowlist when
+/// generating bindings, as we don't want to generate bindings for everything
+/// (i.e. stdlib headers).
 const ALLOWED_BINDINGS: &[&str] = &[
     "HashTable",
     "_Bucket",

crates/macros/.gitignore

@@ -0,0 +1 @@
+../../.gitignore

ext-php-rs-derive/Cargo.toml crates/macros/Cargo.tomlext-php-rs-derive/Cargo.toml renamed to crates/macros/Cargo.toml

@@ -0,0 +1 @@
+../../LICENSE_APACHE

crates/macros/LICENSE_APACHE

@@ -0,0 +1 @@
+../../LICENSE_MIT

crates/macros/LICENSE_MIT

@@ -0,0 +1 @@
+../../README.md

crates/macros/README.md

@@ -199,7 +199,7 @@ impl Property {
             PropertyType::Field { field_name } => {
                 let field_name = Ident::new(field_name, Span::call_site());
                 quote! {
-                    (#name, ::ext_php_rs::php::types::props::Property::field(|obj: &mut Self| &mut obj.#field_name)),
+                    (#name, ::ext_php_rs::props::Property::field(|obj: &mut Self| &mut obj.#field_name)),
                 }
             }
             PropertyType::Method { getter, setter } => {
@@ -216,7 +216,7 @@ impl Property {
                     quote! { None }
                 };
                 quote! {
-                    (#name, ::ext_php_rs::php::types::props::Property::method(#getter, #setter)),
+                    (#name, ::ext_php_rs::props::Property::method(#getter, #setter)),
                 }
             }
         }