Organize things and rename the package to Rinf

.github/workflows/build_test.yaml

@@ -61,12 +61,6 @@ jobs:
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Install shorthand CLI tool
-        run: cargo install --path shorthand/
-
-      - name: Create a Flutter app for testing
-        run: flutter create test_app
-
       - name: Setup Ninja and GTK3 toolchain (Only Linux target)
         if: matrix.target == 'linux'
         run: |
@@ -80,52 +74,60 @@ jobs:
           distribution: "zulu"
           java-version: "11"
 
+      - name: Install the CLI tool
+        working-directory: rust_crate/
+        run: cargo install --path ./
+
+      - name: Create a Flutter app for testing
+        working-directory: flutter_ffi_plugin/
+        run: flutter create test_app
+
       - name: Fetch Flutter dependencies
-        working-directory: test_app/
+        working-directory: flutter_ffi_plugin/test_app/
         run: flutter pub get
 
       - name: Add this framework as a dependency
-        working-directory: test_app/
-        run: dart pub add "rust_in_flutter:{'path':'../'}"
+        working-directory: flutter_ffi_plugin/test_app/
+        run: dart pub add "rinf:{'path':'../'}"
 
       - name: Apply Rust template
-        working-directory: test_app/
-        run: rifs template
+        working-directory: flutter_ffi_plugin/test_app/
+        run: rinf template
 
       - name: Generate message files
-        working-directory: test_app/
-        run: rifs message
+        working-directory: flutter_ffi_plugin/test_app/
+        run: rinf message
 
       - name: Build the example app
         if: matrix.target == 'linux'
-        working-directory: test_app/
+        working-directory: flutter_ffi_plugin/test_app/
         run: flutter build linux
 
       - name: Build the example app
         if: matrix.target == 'android'
-        working-directory: test_app/
+        working-directory: flutter_ffi_plugin/test_app/
         run: |
           flutter build apk
           flutter build appbundle
 
       - name: Build the example app
         if: matrix.target == 'windows'
-        working-directory: test_app/
+        working-directory: flutter_ffi_plugin/test_app/
         run: flutter build windows
 
       - name: Build the example app
         if: matrix.target == 'macos'
-        working-directory: test_app/
+        working-directory: flutter_ffi_plugin/test_app/
         run: flutter build macos
 
       - name: Build the example app
         if: matrix.target == 'ios'
-        working-directory: test_app/
+        working-directory: flutter_ffi_plugin/test_app/
         run: flutter build ios --no-codesign
 
       - name: Build the example app
         if: matrix.target == 'web'
-        working-directory: test_app/
+        working-directory: flutter_ffi_plugin/test_app/
         run: |
-          rifs wasm --release
+          rinf wasm --release
           flutter build web

.github/workflows/formatting_test.yaml

@@ -39,20 +39,20 @@ jobs:
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Install shorthand CLI tool
-        working-directory: shorthand/
-        run: cargo install --path ./
-
       - name: Install Clippy
         run: rustup component add clippy
 
+      - name: Install the CLI tool
+        working-directory: rust_crate/
+        run: cargo install --path ./
+
       - name: Fetch Flutter dependencies
-        working-directory: example/
+        working-directory: flutter_ffi_plugin/example/
         run: flutter pub get
 
       - name: Generate message files
-        working-directory: example/
-        run: rifs message
+        working-directory: flutter_ffi_plugin/example/
+        run: rinf message
 
       - name: Check for any errors
         run: |

.gitignore

@@ -32,5 +32,5 @@ build/
 target/
 
 # Others
-**/*.lock
+*.lock
 /documentation/site/

Cargo.toml

@@ -1,3 +1,3 @@
 [workspace]
-members = ["./example/native/*", "./shorthand"]
+members = ["./flutter_ffi_plugin/example/native/*", "./rust_crate"]
 resolver = "2"

README.md

@@ -1,25 +1,25 @@
-# Rust-In-Flutter
+# Rinf: Rust in Flutter
 
-[![Pub Version](https://img.shields.io/pub/v/rust_in_flutter)](https://pub.dev/packages/rust_in_flutter)
-[![Pub Popularity](https://img.shields.io/pub/popularity/rust_in_flutter)](https://pub.dev/packages/rust_in_flutter)
-[![Pub Points](https://img.shields.io/pub/points/rust_in_flutter)](https://pub.dev/packages/rust_in_flutter)
-[![GitHub Stars](https://img.shields.io/github/stars/cunarist/rust-in-flutter)](https://github.com/cunarist/rust-in-flutter/stargazers)
-[![Build Test](https://github.com/cunarist/rust-in-flutter/actions/workflows/build_test.yaml/badge.svg)](https://github.com/cunarist/rust-in-flutter/actions/workflows/build_test.yaml?query=branch%3Amain)
-[![GitHub License](https://img.shields.io/github/license/cunarist/rust-in-flutter)](https://github.com/cunarist/rust-in-flutter/blob/main/LICENSE)
+[![Pub Version](https://img.shields.io/pub/v/rinf)](https://pub.dev/packages/rinf)
+[![Pub Popularity](https://img.shields.io/pub/popularity/rinf)](https://pub.dev/packages/rinf)
+[![Pub Points](https://img.shields.io/pub/points/rinf)](https://pub.dev/packages/rinf)
+[![GitHub Stars](https://img.shields.io/github/stars/cunarist/rinf)](https://github.com/cunarist/rinf/stargazers)
+[![Build Test](https://github.com/cunarist/rinf/actions/workflows/build_test.yaml/badge.svg)](https://github.com/cunarist/rinf/actions/workflows/build_test.yaml?query=branch%3Amain)
+[![GitHub License](https://img.shields.io/github/license/cunarist/rinf)](https://github.com/cunarist/rinf/blob/main/LICENSE)
 
 **Rust as your Flutter backend, Flutter as your Rust frontend**
 
-![Preview](https://github.com/cunarist/rust-in-flutter/assets/66480156/ae82aad9-02f9-4a1e-93f9-69907511baf8)
+![Preview](https://github.com/cunarist/rinf/assets/66480156/ae82aad9-02f9-4a1e-93f9-69907511baf8)
 
 This is a production-ready framework for creating beautiful and performant cross-platform apps using Flutter and Rust with batteries fully included. Simply add this framework to your app project, and you're all set to write Flutter and Rust together!
 
 ## 🎮 Demo
 
-Visit the [demo](https://rif-demo.cunarist.com/) running on the web to experience the smoothness and delightfulness that comes from the combination of Flutter and Rust. You can also dive into the [example code](https://github.com/cunarist/rust-in-flutter/tree/main/example).
+Visit the [demo](https://rinf-demo.cunarist.com/) running on the web to experience the smoothness and delightfulness that comes from the combination of Flutter and Rust. You can also dive into the [example code](https://github.com/cunarist/rinf/tree/main/flutter_ffi_plugin/example).
 
 ## 🖥️ Platform Support
 
-All platforms available with Flutter are [tested](https://github.com/cunarist/rust-in-flutter/actions/workflows/build_test.yaml?query=branch%3Amain) and supported. Challenging build settings are automatically handled by this framework.
+All platforms available with Flutter are [tested](https://github.com/cunarist/rinf/actions/workflows/build_test.yaml?query=branch%3Amain) and supported. Challenging build settings are automatically handled by this framework.
 
 - ✅ Linux: Tested and supported
 - ✅ Android: Tested and supported
@@ -34,7 +34,7 @@ All platforms available with Flutter are [tested](https://github.com/cunarist/ru
 - **Minimal**: This is not a bulky framework that requires you to install so many dependencies and use complicated CLI commands. Just focus on your code using your preferred Flutter and Rust libraries.
 - **High-level interface**: No messing with sensitive build files, no concerns about memory safety. Stay with Dart and Rust that you're familiar with.
 - **Low-level control**: Though the hard things are kept beneath the surface, you are free to modify the underlying logic such as concurrency or debugging features. There is no hidden mechanism that prevents your understanding.
-- **Well maintained**: Our [automated workflows](https://github.com/cunarist/rust-in-flutter/actions) including build tests are always kept passing, thanks to the main branch protection rule. Also, the number of external dependencies is kept as low as possible and documentations are thoughtfully organized.
+- **Well maintained**: Our [automated workflows](https://github.com/cunarist/rinf/actions) including build tests are always kept passing, thanks to the main branch protection rule. Also, the number of external dependencies is kept as low as possible and documentations are thoughtfully organized.
 - **Efficient**: No memory copy when sending native data, no hidden threads and web workers with memory overhead. This is a really thin wrapper around Dart and Rust.
 - **Scalable**: You are able to use an arbitrary number of Rust library crates as you want, perhaps including ones that you've already been working on.
 - **Logical API**: You declare RESTful messages, not functions for APIs, which provides greater stability. Requesting from Dart and responsing from Rust, as well as streaming from Rust to Dart is possible. Messages are type-safe and flexible because it's powered by the well-known [Protobuf](https://protobuf.dev/) serialization. You also have the ability to send large binary data from Rust to Dart without any memory copy.
@@ -57,10 +57,10 @@ Rust has garnered a devoted following, being [the most loved programming languag
 
 ## 📖 Documentation
 
-Check out the [documentation](https://rif-docs.cunarist.com) for everything you need to know about how to use this thing.
+Check out the [documentation](https://rinf-docs.cunarist.com) for everything you need to know about how to use this thing.
 
 ## 👥 Contributors
 
 We appreciate your contribution to the development of this project! We're always open to discussions and pull requests, so please do not hesitate to leave your ideas or opinions at our GitHub repository.
 
-[![GitHub contributors (via allcontributors.org)](https://contrib.rocks/image?repo=cunarist/rust-in-flutter)](https://github.com/cunarist/rust-in-flutter/graphs/contributors)
+[![GitHub contributors (via allcontributors.org)](https://contrib.rocks/image?repo=cunarist/rinf)](https://github.com/cunarist/rinf/graphs/contributors)

automate/__main__.py

@@ -1,6 +1,5 @@
 import os
 import sys
-import re
 
 
 def exit():
@@ -40,25 +39,31 @@ def remove_files_in_folder(directory: str, prefix: str):
     # Temporarily add `ffi` package
     # because `flutter_rust_bridge_codegen` wants it,
     # though the generated code doesn't use it.
+    os.chdir("./flutter_ffi_plugin/")
     command = "dart pub add ffi"
     os.system(command)
+    os.chdir("../")
 
     # Delete previous bridge files.
-    remove_files_in_folder("./example/native/hub/src/bridge", "bridge")
-    remove_files_in_folder("./lib/src", "bridge")
+    remove_files_in_folder(
+        "./flutter_ffi_plugin/example/native/hub/src/bridge", "bridge"
+    )
+    remove_files_in_folder("./flutter_ffi_plugin/lib/src", "bridge")
 
     # Generate bridge files.
     command = "flutter_rust_bridge_codegen"
-    command += " --rust-input ./example/native/hub/src/bridge/api.rs"
-    command += " --rust-output ./example/native/hub/src/bridge/bridge_generated.rs"
-    command += " --dart-output ./lib/src/bridge_generated.dart"
-    command += " --dart-decl-output ./lib/src/bridge_definitions.dart"
+    command += " --rust-input ./flutter_ffi_plugin/example/native/hub/src/bridge/api.rs"
+    command += " --rust-output ./flutter_ffi_plugin/example/native/hub/src/bridge/bridge_generated.rs"
+    command += " --dart-output ./flutter_ffi_plugin/lib/src/bridge_generated.dart"
+    command += (
+        " --dart-decl-output ./flutter_ffi_plugin/lib/src/bridge_definitions.dart"
+    )
     command += " --class-name Bridge"
     command += " --wasm"
     os.system(command)
 
     # Remove an unnecessary root import.
-    filepath = "./example/native/hub/src/lib.rs"
+    filepath = "./flutter_ffi_plugin/example/native/hub/src/lib.rs"
     with open(filepath, mode="r", encoding="utf8") as file:
         lines = file.readlines()
     for turn, line in enumerate(lines):
@@ -68,7 +73,7 @@ def remove_files_in_folder(directory: str, prefix: str):
         file.write("".join(lines))
 
     # Modify some code.
-    directory_path = "./lib/src/"
+    directory_path = "./flutter_ffi_plugin/lib/src/"
     search_string = "package:flutter_rust_bridge/flutter_rust_bridge.dart"
     replace_string = "bridge_engine/exports.dart"
     replace_string_in_files(directory_path, search_string, replace_string)
@@ -88,7 +93,7 @@ def remove_files_in_folder(directory: str, prefix: str):
     replace_string = ""
     replace_string_in_files(directory_path, search_string, replace_string)
 
-    directory_path = "./example/native/hub/src/bridge"
+    directory_path = "./flutter_ffi_plugin/example/native/hub/src/bridge"
     search_string = "flutter_rust_bridge::"
     replace_string = "crate::bridge::bridge_engine::"
     replace_string_in_files(directory_path, search_string, replace_string)
@@ -111,13 +116,15 @@ def remove_files_in_folder(directory: str, prefix: str):
     os.system(command)
 
     # Remove temporarily added `ffi` package.
+    os.chdir("./flutter_ffi_plugin/")
     command = "dart pub remove ffi"
     os.system(command)
+    os.chdir("../")
 
 elif sys.argv[1] == "cargokit-update":
     print("Updating CargoKit...")
     command = "git subtree pull"
-    command += " --prefix cargokit"
+    command += " --prefix flutter_ffi_plugin/cargokit"
     command += " https://github.com/irondash/cargokit.git"
     command += " main"
     command += " --squash"

documentation/docs/applying-template.md

@@ -5,13 +5,13 @@
 First of all, add this framework to your Flutter project.
 
 ```bash
-flutter pub add rust_in_flutter
+flutter pub add rinf
 ```
 
 Then, simply run this in the command-line from your Flutter project's directory.
 
 ```bash
-rifs template
+rinf template
 ```
 
 After running the command, you'll have new files and folders as your starter Rust template.
@@ -48,7 +48,7 @@ After running the command, you'll have new files and folders as your starter Rus
 Be aware that the message code in Dart and Rust doesn't exist yet. You need to generate message code from the `.proto` files in the `./messages` folder. To do this, run the following command:
 
 ```bash
-rifs message
+rinf message
 ```
 
 Don't forget to read the guides in `./native/README.md` first. Various comments are written in the actual code to help you understand the whole structure. Also, you might want to remove `sample_crate` in production.

documentation/docs/contribution.md

@@ -4,4 +4,4 @@
 
 We appreciate your contribution to the development of this project! We're always open to discussions and pull requests, so please do not hesitate to leave your ideas or opinions at our GitHub repository.
 
-[![GitHub contributors (via allcontributors.org)](https://contrib.rocks/image?repo=cunarist/rust-in-flutter)](https://github.com/cunarist/rust-in-flutter/graphs/contributors)
+[![GitHub contributors (via allcontributors.org)](https://contrib.rocks/image?repo=cunarist/rinf)](https://github.com/cunarist/rinf/graphs/contributors)