start implementing analyzers

It turns out that the different encounters do require quite some
encounter-specific logic, not only to determine whether the CM was
activated, but also to determine whether the fight was successful, the
duration of the fight, later the phases, ...

Wrapping all of this in pre-defined "triggers" (like CmTrigger) feels
like it will be a bit unfitting, so with this patch we have introduced
the evtclib::Analyzer, which can be used to analyze the fights.
Currently, the whole CM detection logic has been moved to this new
interface, and soon we also want the success-detection logic in there.

The tests pass and the interface of Log::is_cm is unchanged.

1 files changed, 65 insertions, 0 deletions

diff --git a/src/analyzers/mod.rs b/src/analyzers/mod.rs
new file mode 100644
index 0000000..5ad88ec
--- /dev/null
+++ b/src/analyzers/mod.rs
@@ -0,0 +1,65 @@
+//! Traits and structures to analyze fights.
+//!
+//! Fights need different logic to determine some data, for example each fight has a different way
+//! to determine whether or not the Challenge Mote was activated, whether or not the fight was
+//! successful, ...
+//!
+//! This module aims to unify that logic by providing a trait [`Analyzer`][Analyzer], which
+//! provides a unified interface to query this information. You can use
+//! [`Log::analyzer`][Log::analyzer] or [`for_log`][for_log] to obtain an analyzer fitting for the
+//! encounter that is represented by the log.
+//!
+//! The implementation of the different analyzers is split off in different submodules:
+//! * [`raids`][raids] for the raid-related encounters.
+//!
+//! Note that you should not create concrete analyzers on your own, as the behaviour is not
+//! specified when you use a wrong analyzer for the given log. Rely only on
+//! [`Log::analyzer`][Log::analyzer] (or [`for_log`][for_log]) and the methods defined in
+//! [`Analyzer`][Analyzer].
+
+use crate::{Boss, Log};
+
+pub mod fractals;
+pub mod helpers;
+pub mod raids;
+
+/// An [`Analyzer`][Analyzer] is something that implements fight-dependent analyzing of the log.
+pub trait Analyzer {
+    /// Returns a reference to the log being analyzed.
+    fn log(&self) -> &Log;
+
+    /// Checks whether the fight was done with the challenge mote activated.
+    fn is_cm(&self) -> bool;
+}
+
+/// Returns the correct [`Analyzer`][Analyzer] for the given log file.
+///
+/// See also [`Log::analyzer`][Log::analyzer].
+pub fn for_log<'l>(log: &'l Log) -> Option<Box<dyn Analyzer + 'l>> {
+    let boss = log.encounter()?;
+
+    match boss {
+        Boss::Cairn => Some(Box::new(raids::Cairn::new(log))),
+        Boss::MursaatOverseer => Some(Box::new(raids::MursaatOverseer::new(log))),
+        Boss::Samarog => Some(Box::new(raids::Samarog::new(log))),
+        Boss::Deimos => Some(Box::new(raids::Deimos::new(log))),
+
+        Boss::SoullessHorror => Some(Box::new(raids::SoullessHorror::new(log))),
+        Boss::Dhuum => Some(Box::new(raids::Dhuum::new(log))),
+
+        Boss::ConjuredAmalgamate => Some(Box::new(raids::ConjuredAmalgamate::new(log))),
+        Boss::LargosTwins => Some(Box::new(raids::LargosTwins::new(log))),
+        Boss::Qadim => Some(Box::new(raids::Qadim::new(log))),
+
+        Boss::CardinalAdina => Some(Box::new(raids::CardinalAdina::new(log))),
+        Boss::CardinalSabir => Some(Box::new(raids::CardinalSabir::new(log))),
+        Boss::QadimThePeerless => Some(Box::new(raids::QadimThePeerless::new(log))),
+
+        Boss::Skorvald => Some(Box::new(fractals::Skorvald::new(log))),
+        Boss::Artsariiv | Boss::Arkk | Boss::MAMA | Boss::Siax | Boss::Ensolyss => {
+            Some(Box::new(fractals::GenericFractal::new(log)))
+        }
+
+        _ => None,
+    }
+}