puremvc 1.0.0 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26e147a6639ad6b8e4143b15143b5612a47a0b87bd658d4eb9777702482ccf9d
+  data.tar.gz: d2c91173162c28ab377facb590c02fe2f7bff293cd23967ffdd5cbdc3c4adf44
+SHA512:
+  metadata.gz: 10b4b062f5759403f465ddf24f3070c80b09d895181ebd161d624aa1cf4b43d6297c9a7edb26fde3f8edbdb60d3500ac715f1ddec10c9e27a46230db933085e9
+  data.tar.gz: 87da5a1fc550e1954b7c2da6abe9add951878414bde033d880650a1431bf31638010fbf676a5174d2303f31c26a658abae62d86b0ae99e348162e6ce39fd1a87

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.2] - 2025-08-14
+### Changed
+- Updated structure
+
+## [1.0.1] - 2025-08-14
+### Changed
+- Bumped version to 1.0.1 to allow Multicore override after initial 1.0.0 standard release on rubygems.org
+
+## [1.0.0] - 2025-08-14
+### Added
+- Initial release of the framework

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Saad Shams <saad.shams@puremvc.org>
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,88 @@
+## [PureMVC](http://puremvc.github.com/) Ruby MultiCore Framework [![Ruby](https://github.com/PureMVC/puremvc-ruby-multicore-framework/actions/workflows/ruby.yml/badge.svg)](https://github.com/PureMVC/puremvc-ruby-multicore-framework/actions/workflows/ruby.yml)
+
+PureMVC is a lightweight framework for creating applications based upon the classic [Model-View-Controller](http://en.wikipedia.org/wiki/Model-view-controller) design meta-pattern. It supports [modular programming](http://en.wikipedia.org/wiki/Modular_programming) through the use of [Multiton](http://en.wikipedia.org/wiki/Multiton) Core actors instead of the [Singletons](http://en.wikipedia.org/wiki/Singleton_pattern) used in the [Standard](https://github.com/PureMVC/puremvc-ruby-standard-framework/wiki) Version.
+
+* [Ruby Gem](https://rubygems.org/gems/puremvc)
+* [API Docs](http://puremvc.org/pages/docs/Ruby/multicore/)
+
+## Installation
+```shell
+gem install puremvc
+```
+
+## Platforms / Technologies
+* [Ruby](https://en.wikipedia.org/wiki/Ruby_(programming_language))
+* [Command-line interface](https://en.wikipedia.org/wiki/Command-line_interface)
+* [Cross-platform software](https://en.wikipedia.org/wiki/Cross-platform_software)
+
+---
+## Development
+
+### Install Dependencies
+```shell
+bundle install
+```
+
+### Lint Code
+```shell
+bundle exec rubocop
+```
+
+### Generate RBS Signatures
+```shell
+rbs prototype rb src/**/*.rb --out-dir=sig
+```
+
+### Run Type Checking
+```shell
+steep check
+```
+
+### Test
+```shell
+ruby -Itest -e 'Dir["test/**/*_test.rb"].each { |file| require_relative file }'
+RubyMine: Test file name mask: **/{*_test,test_*,*_spec}.rb
+```
+
+### Generate Documentation
+```shell
+yard doc src/**/*.rb --protected --private
+open doc/index.html
+```
+
+#### Publish
+##### 1. Setup RubyGems API Key
+```shell
+mkdir -p ~/.gem
+cat > ~/.gem/credentials <<EOF
+---
+:rubygems_api_key: API_KEY
+EOF
+chmod 0600 ~/.gem/credentials
+```
+##### 2. Build the gem
+```shell
+gem build puremvc.gemspec
+gem push puremvc-1.0.0.gem
+```
+
+## Reference
+* [Ruby](https://www.ruby-lang.org/en)
+* [RBS](https://github.com/ruby/rbs)
+* [YARD: Yay! A Ruby Documentation Tool](https://rubydoc.info/gems/yard)
+
+---
+
+## License
+* PureMVC MultiCore Framework for Ruby 
+* PureMVC - Copyright © 2025 [Saad Shams](https://www.linkedin.com/in/muizz/)
+* PureMVC - Copyright © 2025 [Futurescale, Inc.](http://futurescale.com/)
+* All rights reserved.
+
+* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of Futurescale, Inc., PureMVC.org, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/sig/core/controller.rbs

@@ -0,0 +1,40 @@
+module PureMVC
+
+  class Controller
+
+    include _IController
+
+    MULTITON_MSG: String
+
+    self.@instance_map: Hash[String, _IController]
+
+    self.@mutex: Mutex
+
+    @multiton_key: String
+
+    @view: _IView?
+
+    @command_map: Hash[String, ^() -> _ICommand]
+
+    @command_mutex: Mutex
+
+    def self.instance_map: () -> Hash[String, _IController]
+
+    private
+
+    def self.mutex: () -> Mutex
+
+    public
+
+    def self.get_instance: (String key) { (String k) -> _IController } -> _IController
+
+    def self.remove_controller: (String key) -> void
+
+    def initialize: (String key) -> void
+
+    def initialize_controller: () -> void
+  end
+
+  # Type-level assertion that Controller conforms to _IController
+  type controller_validation = validate_controller[Controller]
+end

data/sig/core/model.rbs

@@ -0,0 +1,38 @@
+module PureMVC
+
+  class Model
+
+    include _IModel
+
+    MULTITON_MSG: String
+
+    self.@instance_map: Hash[String, _IModel]
+
+    self.@mutex: Mutex
+
+    @multiton_key: String
+
+    @proxy_map: Hash[String, _IProxy]
+
+    @proxy_mutex: Mutex
+
+    def self.instance_map: () -> Hash[String, _IModel]
+
+    private
+
+    def self.mutex: () -> Mutex
+
+    public
+
+    def self.get_instance: (String key) { (String k) -> _IModel } -> _IModel
+
+    def self.remove_model: (String key) -> void
+
+    def initialize: (String key) -> void
+
+    def initialize_model: () -> void
+  end
+
+  # Type-level assertion that Model conforms to _IModel
+  type model_validation = validate_model[Model]
+end

data/sig/core/view.rbs

@@ -0,0 +1,42 @@
+module PureMVC
+
+  class View
+
+    include _IView
+
+    MULTITON_MSG: String
+
+    self.@instance_map: Hash[String, _IView]
+
+    self.@mutex: Mutex
+
+    @multiton_key: String
+
+    @observer_map: Hash[String, Array[_IObserver]]
+
+    @observer_mutex: Mutex
+
+    @mediator_map: Hash[String, _IMediator]
+
+    @mediator_mutex: Mutex
+
+    def self.instance_map: () -> Hash[String, _IView]
+
+    private
+
+    def self.mutex: () -> Mutex
+
+    public
+
+    def self.get_instance: (String key) { (String k) -> _IView } -> _IView
+
+    def self.remove_view: (String key) -> void
+
+    def initialize: (String key) -> void
+
+    def initialize_view: () -> void
+  end
+
+  # Type-level assertion that View conforms to _IView
+  type view_validation = validate_view[View]
+end

data/sig/interfaces/i_command.rbs

@@ -0,0 +1,18 @@
+module PureMVC
+  # The interface definition for a PureMVC Command.
+  #
+  # @see INotification
+  interface _ICommand
+
+    include _INotifier
+
+    # Execute the <code>_ICommand</code>'s logic to handle a given <code>_INotification</code>.
+    #
+    # @abstract This method must be implemented by the concrete command.
+    # @param notification [_INotification] an _INotification to handle.
+    def execute: (_INotification notification) -> void
+  end
+
+  # Assert that the given `Command` type parameter is a subtype of `_ICommand`
+  type validate_command[Command < _ICommand] = top
+end

data/sig/interfaces/i_controller.rbs

@@ -0,0 +1,52 @@
+module PureMVC
+  # The interface definition for a PureMVC Controller.
+  #
+  # In PureMVC, an <code>_IController</code> implementor
+  # follows the 'Command and Controller' strategy, and
+  # assumes these responsibilities:
+  #
+  # - Remembering which <code>_ICommand</code>s
+  #   are intended to handle which <code>_INotifications</code>.
+  # - Registering itself as an <code>_IObserver</code> with
+  #   the <code>View</code> for each <code>_INotification</code>
+  #   that it has an <code>_ICommand</code> mapping for.
+  # - Creating a new instance of the proper <code>_ICommand</code>
+  #   to handle a given <code>_INotification</code> when notified by the <code>View</code>.
+  # - Calling the <code>_ICommand</code>'s <code>execute</code>
+  #   method, passing in the <code>_INotification</code>.
+  #
+  # @see INotification
+  # @see ICommand
+  interface _IController
+    # Register a particular <code>_ICommand</code> class as the handler
+    # for a particular <code>_INotification</code>.
+    #
+    # @abstract This method must be implemented by the concrete command.
+    # @param notification_name [String] the name of the <code>_INotification</code>
+    # @param factory [^() -> _ICommand] the class of the _ICommand
+    def register_command: (String notification_name) { () -> _ICommand  } -> void
+
+    # Execute the <code>ICommand</code> previously registered as the
+    # handler for <code>INotification</code>s with the given notification name.
+    #
+    # @abstract This method must be implemented by the concrete command.
+    # @param notification [_INotification] the <code>_INotification</code> to execute the associated <code>_ICommand</code> for
+    def execute_command: (_INotification notification) -> void
+
+    # Check if a Command is registered for a given Notification.
+    #
+    # @abstract This method must be implemented by the concrete command.
+    # @param notification_name [String]
+    # @return [Boolean] whether a Command is currently registered for the given <code>notificationName</code>.
+    def has_command?: (String notification_name) -> bool
+
+    # Remove a previously registered <code>_ICommand</code> to <code>_INotification</code> mapping.
+    #
+    # @abstract This method must be implemented by the concrete command.
+    # @param notification_name [String] the name of the <code>_INotification</code> to remove the <code>_ICommand</code> mapping for
+    def remove_command: (String notification_name) -> void
+  end
+
+  # Assert that the given `Controller` type parameter is a subtype of `_IController`
+  type validate_controller[Controller < _IController] = top
+end

data/sig/interfaces/i_facade.rbs

@@ -0,0 +1,116 @@
+module PureMVC
+  # The interface definition for a PureMVC Facade.
+  #
+  # The Facade Pattern suggests providing a single
+  # class to act as a central point of communication
+  # for a subsystem.
+  #
+  # In PureMVC, the Facade acts as an interface between
+  # the core MVC actors (<code>Model</code>, <code>View</code>, <code>Controller</code>) and
+  # the rest of your application.
+  #
+  # @see IModel
+  # @see IView
+  # @see IController
+  # @see ICommand
+  # @see INotification
+  interface _IFacade
+
+    # Register an <code>_ICommand</code> with the <code>Controller</code>.
+    #
+    # @param notification_name [String] the name of the <code>_INotification</code> to associate the <code>_ICommand</code> with.
+    # @param factory [^() -> _ICommand] the factory to produce an instance of the _ICommand
+    def register_command: (String notification_name) { () -> _ICommand } -> void
+
+    # Check if a Command is registered for a given Notification
+    #
+    # @param notification_name [String]
+    # @return [Boolean] whether a Command is currently registered for the given <code>notification_name</code>.
+    def has_command?: (String notification_name) -> bool
+
+    # Remove a previously registered <code>_ICommand</code> to <code>_INotification</code> mapping from the Controller.
+    #
+    # @param notification_name [String] the name of the <code>_INotification</code> to remove the <code>_ICommand</code> mapping for
+    def remove_command: (String notification_name) -> void
+
+    # Register an <code>_IProxy</code> with the <code>Model</code> by name.
+    #
+    # @param proxy [_IProxy] the <code>_IProxy</code> to be registered with the <code>Model</code>.
+    def register_proxy: (_IProxy proxy) -> void
+
+    # Retrieve a <code>IProxy</code> from the <code>Model</code> by name.
+    #
+    # @param proxy_name [String] the name of the <code>_IProxy</code> instance to be retrieved.
+    # @return [_IProxy | nil] the <code>IProxy</code> previously registered by <code>proxy_name</code> with the <code>Model</code>.
+    def retrieve_proxy: (String proxy_name) -> _IProxy?
+
+    # Check if a Proxy is registered
+    #
+    # @param proxy_name [String]
+    # @return [Boolean] whether a Proxy is currently registered with the given <code>proxy_name</code>.
+    def has_proxy?: (String proxy_name) -> bool
+
+    # Remove an <code>_IProxy</code> instance from the <code>Model</code> by name.
+    #
+    # @param proxy_name [String] the <code>_IProxy</code> to remove from the <code>Model</code>.
+    # @return [_IProxy | nil] the <code>_IProxy</code> that was removed from the <code>Model</code>
+    def remove_proxy: (String proxy_name) -> _IProxy?
+
+    # Register an <code>_IMediator</code> instance with the <code>View</code>.
+    #
+    # @param mediator [_IMediator] a reference to the <code>_IMediator</code> instance
+    def register_mediator: (_IMediator mediator) -> void
+
+    # Retrieve an <code>_IMediator</code> instance from the <code>View</code>.
+    #
+    # @param mediator_name [String] the name of the <code>_IMediator</code> instance to retrieve
+    # @return [_IMediator | nil] the <code>_IMediator</code> previously registered with the given <code>mediator_name</code>.
+    def retrieve_mediator: (String mediator_name) -> _IMediator?
+
+    # Check if a Mediator is registered or not
+    #
+    # @param mediator_name [String]
+    # @return [Boolean] whether a Mediator is registered with the given <code>mediator_name</code>.
+    def has_mediator?: (String mediator_name) -> bool
+
+    # Remove an <code>_IMediator</code> instance from the <code>View</code>.
+    #
+    # @param mediator_name [String] name of the <code>IMediator</code> instance to be removed.
+    # @return [_IMediator | nil] the <code>_IMediator</code> instance previously registered with the given <code>mediator_name</code>.
+    def remove_mediator: (String mediator_name) -> _IMediator?
+
+    # Initialize this _INotifier instance.
+    #
+    # This is how a </code>Notifier</code> gets its multitonKey.
+    # Calls to <code>send_notification</code> or to access the
+    # facade will fail until after this method has been called.
+    #
+    # @param key [String] The multitonKey for this INotifier to use.
+    def initialize_notifier: (String key) -> void
+
+    # Notify <code>Observer</code>s.
+    #
+    # This method is left public mostly for backward
+    # compatibility and to allow you to send custom
+    # notification classes using the facade.
+    #
+    # Usually you should call sendNotification
+    # and pass the parameters, never having to
+    # construct the notification yourself.
+    #
+    # @param notification [_INotification] the <code>_INotification</code> to have the <code>View</code> notify <code>Observers</code> of.
+    def notify_observers: (_INotification notification) -> void
+
+    # Send a <code>_INotification</code>.
+    #
+    # Convenience method to prevent having to construct new
+    # notification instances in our implementation code.
+    #
+    # @param name [String] The name of the notification to send.
+    # @param body [Object, nil] The body of the notification (optional).
+    # @param type [String, nil] The type of the notification (optional).
+    def send_notification: (String name, ?Object? body, ?String? type) -> void
+  end
+
+  type validate_facade[Facade < _IFacade] = top
+end

data/sig/interfaces/i_mediator.rbs

@@ -0,0 +1,60 @@
+module PureMVC
+  #
+  # The interface definition for a PureMVC <code>_IMediator</code>.
+  #
+  # In PureMVC, <code>_IMediator</code> implementors assume these responsibilities:
+  #
+  # * Implement a common method that returns a list of all <code>_INotification</code>s
+  #   the <code>_IMediator</code> has interest in.
+  # * Implement a notification callback method.
+  # * Implement methods that are called when the <code>_IMediator</code> is registered or removed from the <code>View</code>.
+  #
+  # Additionally, <code>_IMediator</code>s typically:
+  #
+  # * Act as an intermediary between one or more view components such as text boxes or list controls,
+  #   maintaining references and coordinating their behavior.
+  # * In Flash-based apps, this is often the place where event listeners are
+  #   added to view components, and their handlers implemented.
+  # * Respond to and generate <code>_INotifications</code>, interacting with the rest of the PureMVC app.
+  #
+  # When an <code>_IMediator</code> is registered with the <code>_IView</code>,
+  # the <code>_IView</code> will call the <code>_IMediator</code>'s <code>list_notification_interests</code> method.
+  # The <code>_IMediator</code> will return an <code>Array</code> of <code>_INotification</code> names
+  # which it wishes to be notified about.
+  #
+  # The <code>_IView</code> will then create an <code>Observer</code> object
+  # encapsulating that <code>IMediator</code>'s <code>handle_notification</code> method
+  # and register it as an Observer for each <code>_INotification</code> name returned by <code>list_notification_interests</code>.
+  #
+  # @see INotification
+  interface _IMediator
+
+    include _INotifier
+
+    # @return [String] The name of the Mediator.
+    def name: () -> String
+
+    # @return [Object, nil] The view component associated with this Mediator.
+    def view: () -> Object?
+    def view=: (Object?) -> void
+
+    # List <code>_INotification</code> interests.
+    #
+    # @return [Array] an <code>Array</code> of the <code>_INotification</code> names this <code>_IMediator</code> has an interest in.
+    def list_notification_interests: () -> Array[String]
+
+    # Handle an <code>INotification</code>.
+    #
+    # @param notification [_INotification] the <code>_INotification</code> to be handled
+    def handle_notification: (_INotification notification) -> void
+
+    # Called by the View when the Mediator is registered.
+    def on_register: () -> void
+
+    # Called by the View when the Mediator is registered.
+    def on_remove: () -> void
+  end
+
+  # Assert that the given `Mediator` type parameter is a subtype of `_IMediator`
+  type validate_mediator[Mediator < _IMediator] = top
+end

data/sig/interfaces/i_model.rbs

@@ -0,0 +1,38 @@
+module PureMVC
+  # The interface definition for a PureMVC Model.
+  #
+  # In PureMVC, <code>_IModel</code> implementors provide
+  # access to <code>_IProxy</code> objects by named lookup.
+  #
+  # An <code>_IModel</code> assumes these responsibilities:
+  #
+  # - Maintain a cache of <code>_IProxy</code> instances
+  # - Provide methods for registering, retrieving, and removing <code>_IProxy</code> instances
+  interface _IModel
+    # Register an <code>_IProxy</code> instance with the <code>Model</code>.
+    #
+    # @param proxy [_IProxy] an object reference to be held by the <code>Model</code>.
+    def register_proxy: (_IProxy proxy) -> void
+
+    # Retrieve an <code>_IProxy</code> instance from the <code>Model</code>.
+    #
+    # @param proxy_name [String]
+    # @return [_IProxy] the <code>_IProxy</code> instance previously registered with the given <code>proxyName</code>.
+    def retrieve_proxy: (String proxy_name) -> _IProxy?
+
+    # Check if a <code>Proxy</code> is registered.
+    #
+    # @param proxy_name [String]
+    # @return [Boolean] whether a <code>Proxy</code> is currently registered with the given <code>proxyName</code>.
+    def has_proxy?: (String proxy_name) -> bool
+
+    # Remove an <code>_IProxy</code> instance from the <code>Model</code>.
+    #
+    # @param proxy_name [String] name of the <code>_IProxy</code> instance to be removed.
+    # @return [_IProxy | nil] the <code>_IProxy</code> that was removed from the <code>Model</code>.
+    def remove_proxy: (String proxy_name) -> _IProxy?
+  end
+
+  # Assert that the given `Model` type parameter is a subtype of `_IModel`
+  type validate_model[Model < _IModel] = top
+end

data/sig/interfaces/i_notification.rbs

@@ -0,0 +1,52 @@
+module PureMVC
+  # The interface definition for a PureMVC Notification.
+  #
+  # PureMVC does not rely upon underlying event models such
+  # as the one provided with Flash, and ActionScript 3 does
+  # not have an inherent event model.
+  #
+  # The Observer Pattern as implemented within PureMVC exists
+  # to support event-driven communication between the
+  # application and the actors of the MVC triad.
+  #
+  # Notifications are not meant to be a replacement for Events
+  # in Flex/Flash/AIR. Generally, <code>_IMediator</code> implementors
+  # place event listeners on their view components, which they
+  # then handle in the usual way. This may lead to the broadcast of <code>Notification</code>s to
+  # trigger <code>_ICommand</code>s or to communicate with other <code>_IMediators</code>.
+  # <code>_IProxy</code> and <code>_ICommand</code>
+  # instances communicate with each other and <code>_IMediator</code>s
+  # by broadcasting <code>_INotification</code>s.
+  #
+  # A key difference between Flash <code>Event</code>s and PureMVC
+  # <code>Notification</code>s is that <code>Event</code>s follow the
+  # 'Chain of Responsibility' pattern, 'bubbling' up the display hierarchy
+  # until some parent component handles the <code>Event</code>, while
+  # PureMVC <code>Notification</code>s follow a 'Publish/Subscribe'
+  # pattern. PureMVC classes need not be related to each other in a
+  # parent/child relationship to communicate with one another
+  # using <code>Notification</code>s.
+  #
+  # @see IView
+  # @see IObserver
+  interface _INotification
+    # @return [String] the name of the notification
+    def name: () -> String
+
+    # @return [Object, nil] the body of the notification
+    def body: () -> Object?
+    def body=: (Object?) -> void
+
+    # @return [String, nil] the type of the notification
+    def type: () -> String?
+    def type=: (String?) -> void
+
+    # Get the string representation of the <code>_INotification</code> instance
+    #
+    # @return [String]
+    def to_s: () -> String
+  end
+
+  # Assert that the given `Notification` type parameter is a subtype of `_INotification`
+  type validate_notification[Notification < _INotification] = top
+end

data/sig/interfaces/i_notifier.rbs

@@ -0,0 +1,48 @@
+module PureMVC
+  # The interface definition for a PureMVC Notifier.
+  #
+  # <code>MacroCommand, Command, Mediator</code> and <code>Proxy</code>
+  # all have a need to send <code>Notifications</code>.
+  #
+  # The <code>_INotifier</code> interface provides a common method called
+  # <code>sendNotification</code> that relieves implementation code of
+  # the necessity to actually construct <code>Notifications</code>.
+  #
+  # The <code>Notifier</code> class, which all the above-mentioned classes
+  # extend, also provides an initialized reference to the <code>Facade</code>
+  # Singleton, which is required for the convenience method
+  # for sending <code>Notifications</code>, but also eases implementation as these
+  # classes have frequent <code>Facade</code> interactions and usually require
+  # access to the facade anyway.
+  #
+  # @see IFacade
+  # @see INotification
+  interface _INotifier
+    # Initialize this _INotifier instance.
+    #
+    # This is how a </code>Notifier</code> gets its multitonKey.
+    # Calls to <code>send_notification</code> or to access the
+    # facade will fail until after this method has been called.
+    #
+    # @param key [String] The multitonKey for this INotifier to use.
+    def initialize_notifier: (String key) -> void
+
+    # Send a <code>_INotification</code>.
+    #
+    # Convenience method to prevent having to construct new
+    # notification instances in our implementation code.
+    #
+    # @param name [String] The name of the notification to send.
+    # @param body [Object, nil] The body of the notification (optional).
+    # @param type [String, nil] The type of the notification (optional).
+    def send_notification: (String name, ?Object? body, ?String? type) -> void
+
+    # Return the Multiton Facade instance
+    #
+    # @raise [RuntimeError] if the <code>multiton_key</code> is not set
+    # @return [_IFacade] the facade instance for the notifier's key
+    def facade: () -> _IFacade
+  end
+
+  type validate_notifier[Notifier < _INotifier] = top
+end