add project & mock macro

7 files changed, 531 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4fffb2f
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+/target
+/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..fc4fb8d
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,7 @@
+[package]
+name = "ridicule"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+paste = "1.0.12"
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..14ef2d6
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 HampusM
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
diff --git a/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..170fea6
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,19 @@
+Copyright (c) 2023 HampusM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/examples/simple.rs b/examples/simple.rs
new file mode 100644
index 0000000..a0a5860
--- /dev/null
+++ b/examples/simple.rs
@@ -0,0 +1,45 @@
+use std::fmt::Debug;
+
+use ridicule::mock;
+
+trait SomeFoobar
+{
+    fn do_something(&self) -> bool;
+}
+
+trait Foo
+{
+    fn bar<Baz>(&self, num: u128) -> Baz;
+
+    fn biz<Fiz: Debug, Bar>(&self, fiz: Fiz) -> &Bar;
+
+    fn baz<Foobar>(&self, name: &str, foobar: Foobar)
+    where
+        Foobar: SomeFoobar;
+}
+
+mock! {
+    MockFoo;
+
+    impl Foo for MockFoo {
+        fn bar<Baz>(self: (&Self), num: u128) -> Baz;
+
+        fn biz<Fiz: (Debug +), Bar>(self: (&Self), fiz: Fiz) -> &Bar;
+
+        fn baz<Foobar>(self: (&Self), name: &str, foobar: Foobar)
+            where (
+                Foobar: SomeFoobar
+            );
+    }
+}
+
+fn main()
+{
+    let mut mock_foo = MockFoo::new();
+
+    mock_foo.expect_bar().returning(|_me, num| {
+        println!("bar was called with {num}");
+    });
+
+    mock_foo.bar::<()>(123);
+}
diff --git a/rustfmt.toml b/rustfmt.toml
new file mode 100644
index 0000000..4d1e29f
--- /dev/null
+++ b/rustfmt.toml
@@ -0,0 +1,11 @@
+max_width = 90
+brace_style = "AlwaysNextLine"
+group_imports = "StdExternalCrate"
+wrap_comments = true
+comment_width = 90
+format_code_in_doc_comments = true
+imports_layout = "HorizontalVertical"
+imports_granularity = "Module"
+newline_style = "Unix"
+reorder_impl_items = true
+
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..9f404f1
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,245 @@
+#[macro_export]
+macro_rules! mock {
+    (
+        $mock: ident;
+
+        impl $mocked_trait: ident for $mocked_trait_target: ident {
+            $(
+                fn $func: ident$(<
+                    $($type_param: tt$(: ($($type_param_bound: tt +)+))?),*
+                >)?(
+                    self: ($($self_type: tt)+),
+                    $($func_param: ident: $func_param_type: ty),*
+                )$( -> $return_type: ty)?
+                    $(where ($($where: tt)*))?;
+            )*
+        }
+    ) => {
+        $crate::__private::paste! {
+        mod [<__ $mock>] {
+        use super::*;
+
+        pub struct $mock {
+            $(
+                [<$func _expectations>]: std::collections::HashMap<
+                    Vec<$crate::__private::type_id::TypeID>,
+                    [<$mock Expectation _ $func>]$(<$($crate::__to_unit!($type_param)),*>)?
+                >,
+            )*
+        }
+
+        impl $mock
+        {
+            pub fn new() -> Self
+            {
+                Self {
+                    $(
+                        [<$func _expectations>]: std::collections::HashMap::new()
+                    ),*
+                }
+            }
+
+            $(
+                #[allow(unused)]
+                pub(crate) fn [<expect_ $func>]$(<
+                    $($type_param$(: $($type_param_bound +)*)?),*
+                >)?(&mut self)
+                    -> &mut [<$mock Expectation _ $func>]$(<$($type_param),*>)?
+                $(where $($where)*)?
+                {
+                    let ids = vec![
+                        $($($crate::__private::type_id::TypeID::of::<$type_param>()),*)?
+                    ];
+
+                    let expectation =
+                        [<$mock Expectation _ $func>]$(::<$($type_param),*>)?::new()
+                            .strip_type_params();
+
+                    self.[<$func _expectations>].insert(ids.clone(), expectation);
+
+                    self.[<$func _expectations>]
+                        .get_mut(&ids)
+                        .unwrap()
+                        .with_type_params_mut()
+                }
+            )*
+        }
+
+        impl $mocked_trait for $mock {
+            $(
+                fn $func$(<$($type_param$(: $($type_param_bound +)+)?),*>)?(
+                    self: $($self_type)+,
+                    $($func_param: $func_param_type),*
+                )$( -> $return_type)?
+                $(where $($where)*)?
+                {
+                    let ids = vec![
+                        $($($crate::__private::type_id::TypeID::of::<$type_param>()),*)?
+                    ];
+
+                    let expectation = self
+                        .[<$func _expectations>]
+                        .get(&ids)
+                        .expect(concat!(
+                            "No expectation found for function ",
+                            stringify!($func)
+                        ))
+                        .with_type_params$(::<$($type_param),*>)?();
+
+                    let Some(returning) = &expectation.returning else {
+                        panic!(concat!(
+                            "Expectation for function",
+                            stringify!($func),
+                            " is missing a function to call")
+                        );
+                    };
+
+                    returning(self, $($func_param),*)
+                }
+            )*
+        }
+
+        $(
+            #[allow(non_camel_case_types, non_snake_case)]
+            pub struct [<$mock Expectation _ $func>]$(<$($type_param),*>)? {
+                returning: Option<
+                    fn(
+                        $crate::__replace_ref_type!($($self_type)*, $mock),
+                        $($func_param_type),*
+                    )$( -> $return_type)?>,
+
+                $(
+                    $([<$type_param _phantom>]: std::marker::PhantomData<$type_param>,)*
+                )?
+            }
+
+            impl$(<$($type_param),*>)? [<$mock Expectation _ $func>]$(<
+                $($type_param),*
+            >)? {
+                #[allow(unused)]
+                fn new() -> Self {
+                    Self {
+                        returning: None,
+                        $(
+                            $([<$type_param _phantom>]: std::marker::PhantomData,)*
+                        )?
+                    }
+                }
+
+                #[allow(unused)]
+                pub fn returning(
+                    &mut self,
+                    func: fn(
+                        $crate::__replace_ref_type!($($self_type)*, $mock),
+                        $($func_param_type),*
+                    )$( -> $return_type)?
+                ) -> &mut Self
+                {
+                    self.returning = Some(func);
+
+                    self
+                }
+
+                #[allow(unused)]
+                fn strip_type_params(
+                    self,
+                ) -> [<$mock Expectation _ $func>]$(<$($crate::__to_unit!($type_param)),*>)?
+                {
+                    $crate::__if_empty_else!(($($($type_param)*)?); {
+                        // No type parameters are present
+                        self
+                    }, {
+                        // Type parameters are present
+                        unsafe { std::mem::transmute(self) }
+                    })
+
+                }
+            }
+
+            impl [<$mock Expectation _ $func>]$(<$($crate::__to_unit!($type_param)),*>)? {
+                fn with_type_params$(<$($type_param),*>)?(
+                    &self,
+                ) -> &[<$mock Expectation _ $func>]$(<$($type_param),*>)?
+                {
+                    unsafe { &*(self as *const Self).cast() }
+                }
+
+                #[allow(unused)]
+                fn with_type_params_mut$(<$($type_param),*>)?(
+                    &mut self,
+                ) -> &mut [<$mock Expectation _ $func>]$(<$($type_param),*>)?
+                {
+                    unsafe { &mut *(self as *mut Self).cast() }
+                }
+            }
+        )*
+        }
+
+        use [<__ $mock>]::$mock;
+        }
+    };
+}
+
+#[doc(hidden)]
+pub mod __private
+{
+    pub use paste::paste;
+
+    pub mod type_id
+    {
+        #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
+        pub struct TypeID
+        {
+            id: usize,
+        }
+
+        impl TypeID
+        {
+            #[inline]
+            pub fn of<T>() -> Self
+            {
+                Self {
+                    id: Self::of::<T> as usize,
+                }
+            }
+        }
+    }
+
+    #[macro_export]
+    #[doc(hidden)]
+    macro_rules! __to_unit {
+        ($anything: tt) => {
+            ()
+        };
+    }
+
+    #[macro_export]
+    #[doc(hidden)]
+    macro_rules! __replace_ref_type {
+        (&$old_type: tt, $new_type: tt) => {
+            &$new_type
+        };
+
+        (&mut $old_type: tt, $new_type: tt) => {
+            &mut $new_type
+        };
+    }
+
+    #[macro_export]
+    #[doc(hidden)]
+    macro_rules! __if_empty_else {
+        (($($input: tt)*); $if_empty: block, $else: block) => {
+            $crate::__if_empty_else!(@($($input)*); $if_empty, $else)
+        };
+
+        // Empty
+        (@(); $if_empty: block, $else: block) => {
+            $if_empty
+        };
+
+        // Not empty
+        (@($($input: tt)+); $if_empty: block, $else: block) => {
+            $else
+        };
+    }
+}