Split code into features (#137)

* upgrade async-std to 1.6 beta

* add ip feature

* add glob feature

* add cacehd feature

* fix runtime-tokio clippy warnings

* add watcher feature

* don't clone if watcher feature has been disabled

* use async-rs/async-std#768 for fixing tests

* activate all features for bench test over previous version

* benchmark pull_request and decrease the threshold

* switch to github actions

* fix typo

* Fix: cargo test features doesn't like space

* better management of feature:logging and feature:watcher

* use async-std/master for testing

* add basic wasm32 support

* use runtime-async-std for wasm32 test

* fix clippy warnings

* fix typo

* make other tests avalaible only on no-wasm32 target

* finish split code into features && bump version

.github/workflows/benchmark.yml

@@ -1,5 +1,6 @@
 name: Benchmark
 on:
+  pull_request:
   push:
     branches:
       - master
@@ -23,7 +24,8 @@ jobs:
           github-token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
           auto-push: true
           # Show alert with commit comment on detecting possible performance regression
-          alert-threshold: '200%'
+          alert-threshold: '150%'
           comment-on-alert: true
+          comment-always: true
           fail-on-alert: true
           alert-comment-cc-users: '@GopherJ'

.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Auto Build CI
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@master
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          components: rustfmt, clippy
+          override: true
+
+      - name: Install Dependencies
+        run: sudo apt-get install libssl-dev
+
+      - name: Cargo Clean
+        uses: actions-rs/cargo@v1
+        with:
+          command: clean
+
+      - name: Cargo Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+
+      # Todo: https://github.com/rust-lang/cargo/issues/2980
+      - name: Cargo Test For All Features Using async-std
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --no-default-features --features runtime-async-std,cached,glob,ip,watcher,logging
+
+      - name: Cargo Test For All Features Using tokio
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --no-default-features --features runtime-tokio,cached,glob,ip,watcher,logging
+
+      - name: Cargo Check Wasm
+        uses: actions-rs/cargo@v1
+        with:
+          command:  check
+          target: wasm32-unknown-unknown
+          override: true
+          args: --no-default-features --features runtime-async-std,cached,glob,ip,watcher,logging
+
+      - name: Cargo Clippy
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: -- -D warnings
+
+      - name: Cargo Fmt Check
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check

.github/workflows/coverage.yml

@@ -0,0 +1,33 @@
+name: Coverage
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  cover:
+    name: Auto Codecov Coverage
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@master
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+
+      - name: Run cargo-tarpaulin
+        uses: actions-rs/[email protected]
+        with:
+          args: --out Xml
+
+      - name: Upload to codecov.io
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{secrets.CODECOV_TOKEN}}

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "casbin"
-version = "0.7.1"
+version = "0.7.2"
 authors = ["Joey <[email protected]>", "Cheng JIANG <[email protected]>"]
 edition = "2018"
 license = "Apache-2.0"
@@ -15,27 +15,34 @@ keywords = ["auth", "authorization", "rbac", "acl", "abac"]
 [dependencies]
 regex = "1.3.1"
 rhai = { version = "0.13.0", default-features = false, features = ["sync", "only_i32", "no_function", "no_float"] }
-ip_network = "0.3.4"
-ttl_cache = "0.5.1"
+ip_network = { version = "0.3.4", optional = true }
+ttl_cache = { version = "0.5.1", optional = true }
 lazy_static = "1.4.0"
 indexmap = "1.3.1"
 async-std = { version = "1.5.0", optional = true }
 async-trait = "0.1.24"
 log = { version = "0.4.8", optional = true }
 tokio = { version = "0.2.11", optional = true, default-features = false }
-globset = "0.4.5"
+globset = { version = "0.4.5", optional = true }
 thiserror = "1.0.14"
 
 [features]
 default = ["runtime-async-std"]
 
-runtime-tokio = ["tokio/fs", "tokio/io-util", "tokio/stream", "tokio/rt-threaded", "tokio/blocking"]
+runtime-tokio = ["tokio/fs", "tokio/io-util"]
 runtime-async-std = ["async-std"]
 logging = ["log"]
+ip = ["ip_network"]
+glob = ["globset"]
+cached = ["ttl_cache"]
+watcher = []
 
 [profile.release.build-override]
 opt-level = 0
 
-[dev-dependencies]
+[target.'cfg(target_arch = "wasm32")'.dev-dependencies]
 async-std = { version = "1.5.0", features = [ "attributes" ] }
+
+[target.'cfg(not(target_arch = "wasm32"))'.dev-dependencies]
 tokio = { version = "0.2.11", features = [ "full" ] }
+async-std = { version = "1.5.0", features = [ "attributes" ] }

README.md

@@ -4,8 +4,8 @@
 [![Crates.io](https://img.shields.io/crates/v/casbin.svg)](https://crates.io/crates/casbin)
 [![crates.io](https://img.shields.io/crates/d/casbin)](https://crates.io/crates/casbin)
 [![Docs](https://docs.rs/casbin/badge.svg)](https://docs.rs/casbin)
-[![Build Status](https://travis-ci.org/casbin/casbin-rs.svg?branch=master)](https://travis-ci.org/casbin/casbin-rs)
-[![codecov](https://codecov.io/gh/casbin/casbin-rs/branch/master/graph/badge.svg)](https://codecov.io/gh/casbin/casbin-rs)
+[![CI](https://github.com/casbin/casbin-rs/workflows/CI/badge.svg)](https://github.com/casbin/casbin-rs/actions)
+[![Codecov](https://codecov.io/gh/casbin/casbin-rs/branch/master/graph/badge.svg)](https://codecov.io/gh/casbin/casbin-rs)
 
 **Casbin-RS** is a powerful and efficient open-source access control library for Rust projects. It provides support for enforcing authorization based on various [access control models](https://en.wikipedia.org/wiki/Computer_security_model).
 
@@ -27,7 +27,7 @@ Add this package to `Cargo.toml` of your project. (Check https://crates.io/crate
 
 ```toml
 [dependencies]
-casbin = { version = "0.7.1", default-features = false, features = ["runtime-async-std", "logging"] }
+casbin = { version = "0.7.2", default-features = false, features = ["runtime-async-std", "logging"] }
 async-std = { version = "1.5.0", features = ["attributes"] }
 env_logger = "0.7.1"
 ```

benches/benchmark.rs

@@ -63,6 +63,7 @@ fn b_benchmark_basic_model(b: &mut Bencher) {
     });
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benmark_cached_basic_model(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new(
@@ -89,6 +90,7 @@ fn b_benchmark_rbac_model(b: &mut Bencher) {
     });
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_rbac_model(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new(
@@ -139,6 +141,7 @@ fn b_benchmark_rbac_model_small(b: &mut Bencher) {
     b.iter(|| await_future(e.enforce(&["user501", "data9", "read"])).unwrap());
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_rbac_model_small(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new("examples/rbac_model.conf", ())).unwrap();
@@ -213,6 +216,7 @@ fn b_benchmark_rbac_model_medium(b: &mut Bencher) {
     b.iter(|| await_future(e.enforce(&["user5001", "data15", "read"])).unwrap());
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_rbac_model_medium(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new("examples/rbac_model.conf", ())).unwrap();
@@ -287,6 +291,7 @@ fn b_benchmark_rbac_model_large(b: &mut Bencher) {
     b.iter(|| await_future(e.enforce(&["user50001", "data1500", "read"])).unwrap());
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_rbac_model_large(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new("examples/rbac_model.conf", ())).unwrap();
@@ -335,6 +340,7 @@ fn b_benchmark_rbac_with_resource_roles(b: &mut Bencher) {
     b.iter(|| await_future(e.enforce(&["alice", "data1", "read"])).unwrap());
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_rbac_with_resource_roles(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new(
@@ -357,6 +363,7 @@ fn b_benchmark_rbac_model_with_domains(b: &mut Bencher) {
     b.iter(|| await_future(e.enforce(&["alice", "domain1", "data1", "read"])).unwrap());
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_rbac_model_with_domains(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new(
@@ -375,6 +382,7 @@ fn b_benchmark_abac_model(b: &mut Bencher) {
     b.iter(|| await_future(e.enforce(&["alice", r#"{"Owner": "alice"}"#, "read"])).unwrap());
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_abac_model(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new("examples/abac_model.conf", ())).unwrap();
@@ -393,6 +401,7 @@ fn b_benchmark_key_match(b: &mut Bencher) {
     b.iter(|| await_future(e.enforce(&["alice", "/alice_data/resource1", "GET"])).unwrap());
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_key_match(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new(
@@ -415,6 +424,7 @@ fn b_benchmark_rbac_with_deny(b: &mut Bencher) {
     b.iter(|| await_future(e.enforce(&["alice", "data1", "read"])).unwrap());
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_rbac_with_deny(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new(
@@ -437,6 +447,7 @@ fn b_benchmark_priority_model(b: &mut Bencher) {
     b.iter(|| await_future(e.enforce(&["alice", "data1", "read"])).unwrap());
 }
 
+#[cfg(feature = "cached")]
 #[bench]
 fn b_benchmark_cached_priority_model(b: &mut Bencher) {
     let mut e = await_future(CachedEnforcer::new(

src/adapter/mod.rs

@@ -1,9 +1,11 @@
 use async_trait::async_trait;
 
+#[cfg(not(target_arch = "wasm32"))]
 pub mod file_adapter;
 pub mod memory_adapter;
 pub mod null_adapter;
 
+#[cfg(not(target_arch = "wasm32"))]
 pub use file_adapter::FileAdapter;
 pub use memory_adapter::MemoryAdapter;
 pub use null_adapter::NullAdapter;