Merge pull request #3 from sers-dev/rename_crate

rename crate to tyra

Author: Bobonium

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.3.0
+
+- renamed to `tyra`
+  - equal to `tyractorsaur` release `0.2.0`
+  - all releases before `0.2.0` will still be available as `tyractorsaur`, but will not be migrated to `tyra`
+  - all releases after this one will only be available as `tyra`
+
 # 0.2.0
 
 - add documentation link to metadata
@@ -112,7 +119,7 @@ Although a lot of work went into Refactoring of the public facing API, please do
 
 # 0.0.1
 
-- initial release. Each published release on https://crates.io/crates/tyractorsaur will be tracked in GitHub releases 
+- initial release. Each published release on https://crates.io/crates/tyra will be tracked in GitHub releases 
 - core functionality is working
   - create system and spawn pools 
   - create actors and add them into pools of the existing system 

Cargo.toml

@@ -1,20 +1,20 @@
 [package]
-name = "tyractorsaur"
-version = "0.2.0"
+name = "tyra"
+version = "0.3.0"
 authors = ["sers.dev <admin@sers.dev>"]
 edition = "2018"
 license = "MIT OR Apache-2.0"
-repository = "https://github.com/sers-dev/tyractorsaur"
-homepage = "https://github.com/sers-dev/tyractorsaur"
-documentation = "https://docs.rs/tyractorsaur"
+repository = "https://github.com/sers-dev/tyra"
+homepage = "https://github.com/sers-dev/tyra"
+documentation = "https://docs.rs/tyra"
 description = "Typed Actor System"
-keywords = ["typed", "actor", "scaling", "concurrency", "tyractorsaur"]
+keywords = ["typed", "actor", "scaling", "concurrency", "tyra"]
 categories = ["network-programming", "asynchronous", "concurrency"]
 exclude = ["/.github", ".gitignore"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [lib]
-name = "tyractorsaur"
+name = "tyra"
 path = "src/lib.rs"
 
 [dependencies]

README.md

@@ -1,18 +1,18 @@
-# Tyractorsaur (TYped Rust ACTOR "SAUR")
+# Tyra (TYped Rust Actor)
 
-`Tyractorsaur` is a cross platform Typed Actor System Written in Rust.
+`Tyra` is a cross platform Typed Actor System Written in Rust.
 
 
 ## Current State
 
 It is `NOT` production ready.
-`Tyractorsaur` is in very early development steps. 
+`Tyra` is in very early development steps. 
 The current development status can be tracked in the [CHANGELOG.md](CHANGELOG.md)
 
 
 ## Documentation
 
-[docs.rs](https://docs.rs/tyractorsaur/) or generate your own with `cargo doc`
+[docs.rs](https://docs.rs/tyra/) or generate your own with `cargo doc`
 
 
 ## License

examples/actor.rs

@@ -1,7 +1,7 @@
 use std::process::exit;
 use std::time::Duration;
-use tyractorsaur::prelude::{
-    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyractorsaurConfig,
+use tyra::prelude::{
+    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyraConfig,
 };
 
 struct MessageA {
@@ -57,7 +57,7 @@ impl Handler<MessageB> for HelloWorld {
 }
 
 fn main() {
-    let actor_config = TyractorsaurConfig::new().unwrap();
+    let actor_config = TyraConfig::new().unwrap();
     let actor_system = ActorSystem::new(actor_config);
 
     actor_system.add_pool("aye");

examples/benchmark.rs

@@ -1,8 +1,8 @@
 use std::process::exit;
 use std::thread::sleep;
 use std::time::{Duration, Instant};
-use tyractorsaur::prelude::{
-    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyractorsaurConfig,
+use tyra::prelude::{
+    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyraConfig,
 };
 
 struct MessageA {}
@@ -73,7 +73,7 @@ impl Handler<MessageA> for Benchmark {
 }
 
 fn main() {
-    let actor_config = TyractorsaurConfig::new().unwrap();
+    let actor_config = TyraConfig::new().unwrap();
     let actor_system = ActorSystem::new(actor_config);
 
     let message_count = 10000000;

examples/error.rs

@@ -1,7 +1,7 @@
 use std::process::exit;
 use std::time::Duration;
-use tyractorsaur::prelude::{
-    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyractorsaurConfig,
+use tyra::prelude::{
+    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyraConfig,
 };
 
 #[derive(Clone)]
@@ -44,7 +44,7 @@ impl ActorFactory<ErrActor> for ErrActorFactory {
 }
 
 fn main() {
-    let actor_config = TyractorsaurConfig::new().unwrap();
+    let actor_config = TyraConfig::new().unwrap();
     let actor_system = ActorSystem::new(actor_config);
 
     let hw = ErrActorFactory {

examples/router.rs

@@ -1,10 +1,10 @@
 use std::process::exit;
 use std::thread::sleep;
 use std::time::Duration;
-use tyractorsaur::prelude::{
-    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyractorsaurConfig,
+use tyra::prelude::{
+    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyraConfig,
 };
-use tyractorsaur::router::{
+use tyra::router::{
     AddActorMessage, RemoveActorMessage, RoundRobinRouterFactory, RouterMessage,
 };
 
@@ -32,7 +32,7 @@ impl Handler<MessageA> for HelloWorld {
 }
 
 fn main() {
-    let actor_config = TyractorsaurConfig::new().unwrap();
+    let actor_config = TyraConfig::new().unwrap();
     let actor_system = ActorSystem::new(actor_config);
 
     let hw = HelloWorldFactory {};

examples/sleep.rs

@@ -1,8 +1,8 @@
 use std::process::exit;
 use std::thread::sleep;
 use std::time::Duration;
-use tyractorsaur::prelude::{
-    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyractorsaurConfig,
+use tyra::prelude::{
+    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyraConfig,
 };
 
 #[derive(Clone)]
@@ -47,7 +47,7 @@ impl ActorFactory<SleepActor> for SleepActorFactory {
 }
 
 fn main() {
-    let actor_config = TyractorsaurConfig::new().unwrap();
+    let actor_config = TyraConfig::new().unwrap();
     let actor_system = ActorSystem::new(actor_config);
 
     let hw = SleepActorFactory {

examples/stop.rs

@@ -1,8 +1,8 @@
 use std::process::exit;
 use std::thread::sleep;
 use std::time::Duration;
-use tyractorsaur::prelude::{
-    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyractorsaurConfig,
+use tyra::prelude::{
+    Actor, ActorFactory, ActorMessage, ActorSystem, ActorContext, Handler, TyraConfig,
 };
 
 #[derive(Clone)]
@@ -42,7 +42,7 @@ impl ActorFactory<StopActor> for StopActorFactory {
 }
 
 fn main() {
-    let actor_config = TyractorsaurConfig::new().unwrap();
+    let actor_config = TyraConfig::new().unwrap();
     let actor_system = ActorSystem::new(actor_config);
 
     let hw = StopActorFactory {};

src/actor/actor.rs

@@ -18,7 +18,7 @@ use std::panic::UnwindSafe;
 /// Basic usage:
 ///
 /// ```rust
-/// use tyractorsaur::prelude::{TyractorsaurConfig, ActorSystem, Actor, ActorFactory, ActorContext, SerializedMessage};
+/// use tyra::prelude::{TyraConfig, ActorSystem, Actor, ActorFactory, ActorContext, SerializedMessage};
 ///
 /// struct TestActor {}
 ///

src/actor/actor_builder.rs

@@ -2,7 +2,7 @@ use crate::actor::actor::Actor;
 use crate::actor::actor_config::{ActorConfig, RestartPolicy};
 use crate::actor::actor_factory::ActorFactory;
 use crate::actor::actor_wrapper::ActorWrapper;
-use crate::config::tyractorsaur_config::DEFAULT_POOL;
+use crate::config::tyra_config::DEFAULT_POOL;
 use crate::system::actor_system::ActorSystem;
 use std::panic::UnwindSafe;
 use crossbeam_channel::{unbounded, bounded};

src/actor/actor_factory.rs

@@ -12,7 +12,7 @@ use std::panic::UnwindSafe;
 /// Basic usage:
 ///
 /// ```rust
-/// use tyractorsaur::prelude::{Actor, SerializedMessage, ActorFactory, ActorContext};
+/// use tyra::prelude::{Actor, SerializedMessage, ActorFactory, ActorContext};
 ///
 /// struct TestActor {}
 ///

src/actor/handler.rs

@@ -11,7 +11,7 @@ use crate::message::system_stop_message::SystemStopMessage;
 /// Basic usage:
 ///
 /// ```rust
-/// use tyractorsaur::prelude::{TyractorsaurConfig, ActorSystem, Actor, ActorFactory, ActorContext, SerializedMessage, ActorMessage, Handler};
+/// use tyra::prelude::{TyraConfig, ActorSystem, Actor, ActorFactory, ActorContext, SerializedMessage, ActorMessage, Handler};
 ///
 /// struct TestActor {}
 /// impl Actor for TestActor {}

src/config/mod.rs

@@ -1,8 +1,8 @@
 pub mod global_config;
 pub mod pool_config;
-pub mod tyractorsaur_config;
+pub mod tyra_config;
 
 pub mod prelude {
     pub use crate::config::pool_config::ThreadPoolConfig;
-    pub use crate::config::tyractorsaur_config::TyractorsaurConfig;
+    pub use crate::config::tyra_config::TyraConfig;
 }

src/config/pool_config.rs

@@ -1,7 +1,7 @@
 use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
 
-/// See [default.toml](https://github.com/sers-dev/tyractorsaur/blob/master/src/config/default.toml) for documentation of all configurations & their defaults
+/// See [default.toml](https://github.com/sers-dev/tyra/blob/master/src/config/default.toml) for documentation of all configurations & their defaults
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct ThreadPoolConfig {
     pub actor_limit: usize,
@@ -18,7 +18,7 @@ impl ThreadPoolConfig {
     /// Basic usage:
     ///
     /// ```rust
-    /// use tyractorsaur::prelude::ThreadPoolConfig;
+    /// use tyra::prelude::ThreadPoolConfig;
     ///
     /// let config = ThreadPoolConfig::new(0, 1, 2, 1.0);
     /// ```

src/config/tyractorsaur_config.rs renamed to src/config/tyra_config.rs

@@ -6,17 +6,17 @@ use serde::{Deserialize, Serialize};
 
 pub const DEFAULT_POOL: &str = "default";
 
-/// See [default.toml](https://github.com/sers-dev/tyractorsaur/blob/master/src/config/default.toml) for documentation of all configurations & their defaults
+/// See [default.toml](https://github.com/sers-dev/tyra/blob/master/src/config/default.toml) for documentation of all configurations & their defaults
 #[derive(Debug, Serialize, Deserialize, Clone)]
-pub struct TyractorsaurConfig {
+pub struct TyraConfig {
     pub general: GeneralConfig,
     pub thread_pool: PoolConfig,
 }
 
-impl TyractorsaurConfig {
+impl TyraConfig {
     /// Required for [ActorSystem.new](../prelude/struct.ActorSystem.html#method.new)
     ///
-    /// Loads default config from [default.toml](https://github.com/sers-dev/tyractorsaur/blob/master/src/config/default.toml)
+    /// Loads default config from [default.toml](https://github.com/sers-dev/tyra/blob/master/src/config/default.toml)
     /// Overwrites defaults through environment variables. Replace toml `.` with `_CONFIG_`, i.e. `TYRACTORSAUR_GENERAL_CONFIG_DEFAULT_MAILBOX_SIZE=1`
     ///
     /// Replaces `$HOSTNAME` with the actual hostname of the system for the `TYRACTORSAUR_GENERAL_CONFIG_NAME`
@@ -27,9 +27,9 @@ impl TyractorsaurConfig {
     ///
     /// ```rust
     ///
-    /// use tyractorsaur::prelude::TyractorsaurConfig;
+    /// use tyra::prelude::TyraConfig;
     ///
-    /// let mut config = TyractorsaurConfig::new().unwrap();
+    /// let mut config = TyraConfig::new().unwrap();
     /// config.general.name = String::from("HelloWorld");
     /// ```
     pub fn new() -> Result<Self, ConfigError> {
@@ -45,7 +45,7 @@ impl TyractorsaurConfig {
             .merge(Environment::with_prefix("TYRACTORSAUR").separator("_CONFIG_"))
             .expect("Could not parse ENV variables");
 
-        let mut parsed: TyractorsaurConfig = config.try_into().expect("Could not parse Config");
+        let mut parsed: TyraConfig = config.try_into().expect("Could not parse Config");
         if parsed.general.name == "$HOSTNAME" {
             parsed.general.name = String::from(hostname::get().unwrap().to_str().unwrap());
         }

src/lib.rs

@@ -1,4 +1,4 @@
-//! Tyractorsaur is a [configurable](./prelude/struct.TyractorsaurConfig.html) typed actor framework
+//! Tyra is a [configurable](./prelude/struct.TyraConfig.html) typed actor framework
 //!
 //! An [Actor](./prelude/trait.Actor.html) is an object with which you can only interact by sending predefined [messages](./prelude/trait.ActorMessage.html)
 //!
@@ -11,7 +11,7 @@
 //! Basic usage:
 //!
 //! ```rust
-//! use tyractorsaur::prelude::*;
+//! use tyra::prelude::*;
 //! use std::process::exit;
 //! use std::time::Duration;
 //!
@@ -41,7 +41,7 @@
 //!
 //! fn main() {
 //!     // create a new actor system with the default config
-//!     let actor_config = TyractorsaurConfig::new().unwrap();
+//!     let actor_config = TyraConfig::new().unwrap();
 //!     let actor_system = ActorSystem::new(actor_config);
 //!
 //!     // create an actor and send it a message
@@ -66,7 +66,7 @@
 //! ```text
 //!                             ┌──────────────────────┐
 //!                             │                      │
-//!                             │  TyractorsaurConfig  │
+//!                             │  TyraConfig  │
 //!                             │                      │
 //!                             └──────────┬───────────┘
 //!                                        │

src/message/actor_message.rs

@@ -5,7 +5,7 @@
 /// Basic usage:
 ///
 /// ```rust
-/// use tyractorsaur::prelude::ActorMessage;
+/// use tyra::prelude::ActorMessage;
 ///
 /// struct FooBar {}
 /// impl ActorMessage for FooBar {}

src/routers/round_robin_router.rs

@@ -25,7 +25,7 @@ where
 /// Basic usage:
 ///
 /// ```rust
-/// use tyractorsaur::prelude::*;
+/// use tyra::prelude::*;
 /// use std::process::exit;
 /// use std::time::Duration;
 ///
@@ -54,8 +54,8 @@ where
 /// }
 ///
 /// // create a new actor system with the default config
-/// use tyractorsaur::router::{RoundRobinRouterFactory, AddActorMessage, RouterMessage};
-/// let actor_config = TyractorsaurConfig::new().unwrap();
+/// use tyra::router::{RoundRobinRouterFactory, AddActorMessage, RouterMessage};
+/// let actor_config = TyraConfig::new().unwrap();
 /// let actor_system = ActorSystem::new(actor_config);
 ///
 /// // create the actor