#221

Committed 08 Aug 2025 08:48AM UTC coverage: 71.116% (-0.2%) from 71.35%

Build # #221

Build Type

push

github

Committed by

srs-mate

Commit Message

chore: remove comment

Run Details

650 of 914 relevant lines covered (71.12%)

10.47 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/main/scala/io/github/srs/controller/ControllerModule.scala

package io.github.srs.controller

import scala.compiletime.deferred
import scala.concurrent.duration.FiniteDuration

import cats.effect.IO
import cats.effect.std.Queue
import cats.syntax.all.*
import io.github.srs.model.*
import io.github.srs.model.SimulationConfig.SimulationStatus
import io.github.srs.model.UpdateLogic.*
import io.github.srs.model.logic.*
import io.github.srs.utils.SimulationDefaults.SimulationConfig.maxCount

/**
 * Module that defines the controller logic for the Scala Robotics Simulator.
 */
object ControllerModule:

  /**
   * Controller trait that defines the interface for the controller.
   *
   * @tparam S
   *   the type of the state, which must extend [[ModelModule.State]].
   */
  trait Controller[S <: ModelModule.State]:
    /**
     * Starts the controller with the initial state.
     *
     * @param initialState
     *   the initial state of the simulation.
     */
    def start(initialState: S): IO[Unit]

    /**
     * Runs the simulation loop, processing events from the queue and updating the state.
     *
     * @param s
     *   the current state of the simulation.
     * @param queue
     *   a concurrent queue that holds events to be processed.
     * @return
     *   an [[IO]] task that completes when the simulation loop ends.
     */
    def simulationLoop(s: S, queue: Queue[IO, Event]): IO[Unit]

  end Controller

  /**
   * Provider trait that defines the interface for providing a controller.
   *
   * @tparam S
   *   the type of the state, which must extend [[ModelModule.State]].
   */
  trait Provider[S <: ModelModule.State]:
    val controller: Controller[S]

  /**
   * Defines the dependencies required by the controller module. In particular, it requires a
   * [[io.github.srs.view.ViewModule.Provider]] and a [[io.github.srs.model.ModelModule.Provider]].
   */
  type Requirements[S <: ModelModule.State] =
    io.github.srs.view.ViewModule.Provider[S] & io.github.srs.model.ModelModule.Provider[S]

  /**
   * Component trait that defines the interface for creating a controller.
   *
   * @tparam S
   *   the type of the simulation state, which must extend [[ModelModule.State]].
   */
  trait Component[S <: ModelModule.State]:
    context: Requirements[S] =>
    given inc: IncrementLogic[S] = deferred

    given tick: TickLogic[S] = deferred

    given pause: PauseLogic[S] = deferred

    given resume: ResumeLogic[S] = deferred

    given stop: StopLogic[S] = deferred

    object Controller:
      /**
       * Creates a controller instance.
       *
       * @return
       *   a [[Controller]] instance.
       */
      def apply(): Controller[S] = new ControllerImpl

      /**
       * Private controller implementation that delegates the simulation loop to the provided model and view.
       */
      private class ControllerImpl extends Controller[S]:

        override def start(initialState: S): IO[Unit] =
          val randInt: Int = initialState.simulationRNG.nextIntBetween(0, maxCount)._1
          val list = List.fill(randInt)(Event.Increment)
          for
            queueSim <- Queue.unbounded[IO, Event]
            _ <- context.view.init(queueSim)
            _ <- produceEvents(queueSim, list)
            _ <- simulationLoop(initialState, queueSim)
          yield ()

        override def simulationLoop(s: S, queue: Queue[IO, Event]): IO[Unit] =
          def loop(state: S): IO[Unit] =
            for
              events <- queue.tryTakeN(Some(50))
              newState <- handleEvents(events, state)
              _ <- context.view.render(newState)
              nextState <-
                if newState.simulationStatus == SimulationStatus.RUNNING then
                  tickEvents(newState.simulationSpeed.tickSpeed, newState)
                else IO.pure(newState)
              stop = newState.simulationStatus == SimulationStatus.STOPPED ||
                newState.simulationTime.exists(max => newState.elapsedTime >= max)
              _ <- if stop then IO.unit else loop(nextState)
            yield ()

          loop(s)

        private def produceEvents[A](queue: Queue[IO, A], events: List[A]): IO[Unit] =
          events.traverse_(queue.offer)

        private def tickEvents(tickSpeed: FiniteDuration, state: S): IO[S] =
          for
            _ <- IO.sleep(tickSpeed)
            tick <- handleEvent(Event.Tick(tickSpeed), state)
          yield tick

        private def handleEvents(events: Seq[Event], state: S): IO[S] =
          for finalState <- events.foldLeft(IO.pure(state)) { (taskState, event) =>
              for
                currentState <- taskState
                newState <- handleEvent(event, currentState)
              yield newState
            }
          yield finalState

        private def handleEvent(event: Event, state: S): IO[S] =
          event match
            case Event.Increment if state.simulationStatus == SimulationStatus.RUNNING =>
              context.model.increment(state)
            case Event.Tick(deltaTime) if state.simulationStatus == SimulationStatus.RUNNING =>
              context.model.tick(state, deltaTime)
            case Event.Pause => context.model.pause(state)
            case Event.Resume => context.model.resume(state)
            case Event.Stop => context.model.stop(state)
            case Event.TickSpeed(speed) => context.model.tickSpeed(state, speed)
            case _ => IO.pure(state)

      end ControllerImpl

    end Controller

  end Component

  /**
   * Interface trait that combines the provider and component traits for the controller module.
   *
   * @tparam S
   *   the type of the simulation state, which must extend [[ModelModule.State]].
   */
  trait Interface[S <: ModelModule.State] extends Provider[S] with Component[S]:
    self: Requirements[S] =>
end ControllerModule

1	package io.github.srs.controller
2
3	import scala.compiletime.deferred
4	import scala.concurrent.duration.FiniteDuration
5
6	import cats.effect.IO
7	import cats.effect.std.Queue
8	import cats.syntax.all.*
9	import io.github.srs.model.*
10	import io.github.srs.model.SimulationConfig.SimulationStatus
11	import io.github.srs.model.UpdateLogic.*
12	import io.github.srs.model.logic.*
13	import io.github.srs.utils.SimulationDefaults.SimulationConfig.maxCount
14
15	/**
16	* Module that defines the controller logic for the Scala Robotics Simulator.
17	*/
18	object ControllerModule:
19		×
20	/**
21	* Controller trait that defines the interface for the controller.
22	*
23	* @tparam S
24	* the type of the state, which must extend [[ModelModule.State]].
25	*/
26	trait Controller[S <: ModelModule.State]:
27	/**	×
28	* Starts the controller with the initial state.
29	*
30	* @param initialState
31	* the initial state of the simulation.
32	*/
33	def start(initialState: S): IO[Unit]
34
35	/**
36	* Runs the simulation loop, processing events from the queue and updating the state.
37	*
38	* @param s
39	* the current state of the simulation.
40	* @param queue
41	* a concurrent queue that holds events to be processed.
42	* @return
43	* an [[IO]] task that completes when the simulation loop ends.
44	*/
45	def simulationLoop(s: S, queue: Queue[IO, Event]): IO[Unit]
46
47	end Controller
48
49	/**
50	* Provider trait that defines the interface for providing a controller.
51	*
52	* @tparam S
53	* the type of the state, which must extend [[ModelModule.State]].
54	*/
55	trait Provider[S <: ModelModule.State]:
56	val controller: Controller[S]
57
58	/**
59	* Defines the dependencies required by the controller module. In particular, it requires a
60	* [[io.github.srs.view.ViewModule.Provider]] and a [[io.github.srs.model.ModelModule.Provider]].
61	*/
62	type Requirements[S <: ModelModule.State] =
63	io.github.srs.view.ViewModule.Provider[S] & io.github.srs.model.ModelModule.Provider[S]
64
65	/**
66	* Component trait that defines the interface for creating a controller.
67	*
68	* @tparam S
69	* the type of the simulation state, which must extend [[ModelModule.State]].
70	*/
71	trait Component[S <: ModelModule.State]:
72	context: Requirements[S] =>	×
73	given inc: IncrementLogic[S] = deferred
74
75	given tick: TickLogic[S] = deferred
76
77	given pause: PauseLogic[S] = deferred
78
79	given resume: ResumeLogic[S] = deferred
80
81	given stop: StopLogic[S] = deferred
82
83	object Controller:
84	/**	×
85	* Creates a controller instance.
86	*
87	* @return
88	* a [[Controller]] instance.
89	*/
90	def apply(): Controller[S] = new ControllerImpl
91		×
92	/**
93	* Private controller implementation that delegates the simulation loop to the provided model and view.
94	*/
95	private class ControllerImpl extends Controller[S]:
96		×
97	override def start(initialState: S): IO[Unit] =
98	val randInt: Int = initialState.simulationRNG.nextIntBetween(0, maxCount)._1	×
99	val list = List.fill(randInt)(Event.Increment)	×
100	for	×
101	queueSim <- Queue.unbounded[IO, Event]	×
102	_ <- context.view.init(queueSim)	×
103	_ <- produceEvents(queueSim, list)
104	_ <- simulationLoop(initialState, queueSim)
105	yield ()
106		×
107	override def simulationLoop(s: S, queue: Queue[IO, Event]): IO[Unit] =
108	def loop(state: S): IO[Unit] =	×
109	for	×
110	events <- queue.tryTakeN(Some(50))	×
111	newState <- handleEvents(events, state)	×
112	_ <- context.view.render(newState)
113	nextState <-
114	if newState.simulationStatus == SimulationStatus.RUNNING then
115	tickEvents(newState.simulationSpeed.tickSpeed, newState)
116	else IO.pure(newState)
117	stop = newState.simulationStatus == SimulationStatus.STOPPED \|\|
118	newState.simulationTime.exists(max => newState.elapsedTime >= max)
119	_ <- if stop then IO.unit else loop(nextState)
120	yield ()
121		×
122	loop(s)
123		×
124	private def produceEvents[A](queue: Queue[IO, A], events: List[A]): IO[Unit] =
125	events.traverse_(queue.offer)	×
126		×
127	private def tickEvents(tickSpeed: FiniteDuration, state: S): IO[S] =
128	for	×
129	_ <- IO.sleep(tickSpeed)	×
130	tick <- handleEvent(Event.Tick(tickSpeed), state)	×
131	yield tick
132		×
133	private def handleEvents(events: Seq[Event], state: S): IO[S] =
134	for finalState <- events.foldLeft(IO.pure(state)) { (taskState, event) =>	×
135	for	×
136	currentState <- taskState
137	newState <- handleEvent(event, currentState)
138	yield newState
139	}
140	yield finalState	×
141		×
142	private def handleEvent(event: Event, state: S): IO[S] =
143	event match	×
144	case Event.Increment if state.simulationStatus == SimulationStatus.RUNNING =>	×
145	context.model.increment(state)	×
146	case Event.Tick(deltaTime) if state.simulationStatus == SimulationStatus.RUNNING =>	×
147	context.model.tick(state, deltaTime)	×
148	case Event.Pause => context.model.pause(state)	×
149	case Event.Resume => context.model.resume(state)	×
150	case Event.Stop => context.model.stop(state)	×
151	case Event.TickSpeed(speed) => context.model.tickSpeed(state, speed)	×
152	case _ => IO.pure(state)	×
153		×
154	end ControllerImpl
155
156	end Controller
157
158	end Component
159
160	/**
161	* Interface trait that combines the provider and component traits for the controller module.
162	*
163	* @tparam S
164	* the type of the simulation state, which must extend [[ModelModule.State]].
165	*/
166	trait Interface[S <: ModelModule.State] extends Provider[S] with Component[S]:
167	self: Requirements[S] =>
168	end ControllerModule

Scala-Robotics-Simulator / PPS-22-srs / #221

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous