puremvc 1.0.0 → 1.0.1

data/sig/lib/interfaces/i_view.rbs

@@ -0,0 +1,71 @@
+module PureMVC
+  # The interface definition for a PureMVC View.
+  #
+  # In PureMVC, <code>_IView</code> implementors assume these responsibilities:
+  #
+  # In PureMVC, the <code>View</code> class assumes these responsibilities:
+  # - Maintain a cache of <code>_IMediator</code> instances.
+  # - Provide methods for registering, retrieving, and removing <code>_IMediators</code>.
+  # - Managing the observer lists for each <code>_INotification</code> in the application.
+  # - Providing a method for attaching <code>_IObservers</code> to an <code>_INotification</code>'s observer list.
+  # - Providing a method for broadcasting an <code>_INotification</code>.
+  # - Notifying the <code>_IObservers</code> of a given <code>_INotification</code> when it is broadcast.
+  interface _IView
+    # Register an <code>_IObserver</code> to be notified of <code>_INotifications</code> with a given name.
+    #
+    # @param notification_name [String] the name of the <code>_INotifications</code> to notify this <code>_IObserver</code> of
+    # @param observer [_IObserver] the <code>_IObserver</code> to register
+    def register_observer: (String notification_name, _IObserver observer) -> void
+
+    # Notify the <code>_IObservers</code> for a particular <code>_INotification</code>.
+    #
+    # All previously attached <code>_IObservers</code> for this <code>_INotification</code>'s
+    # list are notified and are passed a reference to the <code>_INotification</code> in
+    # the order in which they were registered.
+    #
+    # @param notification [_INotification] the <code>_INotification</code> to notify <code>_IObservers</code> of.
+    def notify_observers: (_INotification notification) -> void
+
+    # Remove a group of observers from the observer list for a given <code>Notification</code> name.
+    #
+    # @param notification_name [String] which observer list to remove from
+    # @param notify_context [untyped] remove the observers with this object as their notifyContext
+    def remove_observer: (String notification_name, untyped notify_context) -> void
+
+    # Register an <code>_IMediator</code> instance with the <code>View</code>.
+    #
+    # Registers the <code>_IMediator</code> so that it can be retrieved by name,
+    # and further interrogates the <code>_IMediator</code> for its
+    # <code>_INotification</code> interests.
+    #
+    # If the <code>_IMediator</code> returns any <code>_INotification</code>
+    # names to be notified about, an <code>Observer</code> is created encapsulating
+    # the <code>_IMediator</code> instance's <code>handleNotification</code> method
+    # and registering it as an <code>Observer</code> for all <code>_INotifications</code> the
+    # <code>_IMediator</code> is interested in.
+    #
+    # @param mediator [_IMediator] a reference to the <code>_IMediator</code> instance
+    def register_mediator: (_IMediator mediator) -> void
+
+    # Retrieve an <code>_IMediator</code> 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> instance previously registered with the given <code>mediatorName</code>.
+    def retrieve_mediator: (String mediator_name) -> _IMediator?
+
+    # Check if a <code>Mediator</code> is registered or not.
+    #
+    # @param mediator_name [String]
+    # @return [Boolean] whether a <code>Mediator</code> is registered with the given <code>mediatorName</code>.
+    def has_mediator?: (String mediator_name) -> bool
+
+    # Remove an <code>_IMediator</code> from the <code>View</code>.
+    #
+    # @param mediator_name [String] name of the <code>_IMediator</code> instance to be removed.
+    # @return [_IMediator] the <code>_IMediator</code> that was removed from the <code>View</code>
+    def remove_mediator: (String mediator_name) -> _IMediator?
+  end
+
+  # Assert that the given `View` type parameter is a subtype of `_IView`
+  type validate_view[View < _IView] = top
+end

data/sig/lib/patterns/command/macro_command.rbs

@@ -0,0 +1,18 @@
+module PureMVC
+
+  class MacroCommand < Notifier
+
+    include _ICommand
+
+    @sub_commands: Array[^() -> _ICommand]
+
+    def initialize: () -> void
+
+    def initialize_macro_command: () -> void
+
+    def add_sub_command: () { () -> _ICommand } -> void
+  end
+
+  # Type-level assertion that MacroCommand conforms to _ICommand
+  type macro_command_validation = validate_command[MacroCommand]
+end

data/sig/lib/patterns/command/simple_command.rbs

@@ -0,0 +1,11 @@
+module PureMVC
+
+  class SimpleCommand < Notifier
+
+    include _ICommand
+
+  end
+
+  # Type-level assertion that SimpleCommand conforms to _ICommand
+  type simple_command_validation = validate_command[SimpleCommand]
+end

data/sig/lib/patterns/facade/facade.rbs

@@ -0,0 +1,48 @@
+module PureMVC
+
+  class Facade
+
+    include _IFacade
+
+    self.@instance_map: Hash[String, _IFacade]
+
+    self.@mutex: Mutex
+
+    @model: _IModel?
+
+    @controller: _IController?
+
+    @view: _IView?
+
+    @multiton_key: String
+
+    MULTITON_MSG: String
+
+    def self.instance_map: () -> Hash[String, _IFacade]
+
+    private
+
+    def self.mutex: () -> Mutex
+
+    public
+
+    def self.get_instance: (String key) { (String k) -> _IFacade } -> _IFacade
+
+    def self.has_core?: (String key) -> bool
+
+    def self.remove_core: (String key) -> void
+
+    def initialize: (String key) -> void
+
+    def initialize_facade: () -> void
+
+    def initialize_controller: () -> void
+
+    def initialize_model: () -> void
+
+    def initialize_view: () -> void
+  end
+
+  # Type-level assertion that Facade conforms to _IFacade
+  type facade_validation = validate_facade[Facade]
+end

data/sig/lib/patterns/mediator/mediator.rbs

@@ -0,0 +1,18 @@
+module PureMVC
+
+  class Mediator < Notifier
+
+    include _IMediator
+
+    NAME: String
+
+    attr_reader name: String
+
+    attr_accessor component: Object?
+
+    def initialize: (?String? name, ?Object? component) -> void
+  end
+
+  # Type-level assertion that Mediator conforms to _IMediator
+  type mediator_validation = validate_mediator[Mediator]
+end

data/sig/lib/patterns/observer/notification.rbs

@@ -0,0 +1,18 @@
+module PureMVC
+
+  class Notification
+
+    include _INotification
+
+    attr_reader name: String
+
+    attr_accessor body: Object?
+
+    attr_accessor type: String?
+
+    def initialize: (String name, ?Object? body, ?String? type) -> void
+  end
+
+  # Type-level assertion that Notification conforms to _INotification
+  type notification_validation = validate_notification[Notification]
+end

data/sig/lib/patterns/observer/notifier.rbs

@@ -0,0 +1,17 @@
+module PureMVC
+
+  class Notifier
+
+    include _INotifier
+
+    @multiton_key: String
+
+    MULTITON_MSG: String
+
+    def multiton_key: () -> String
+
+  end
+
+  # Type-level assertion that Notifier conforms to _INotifier
+  type notifier_validation = validate_notifier[Notifier]
+end

data/sig/lib/patterns/observer/observer.rbs

@@ -0,0 +1,20 @@
+module PureMVC
+
+  class Observer
+
+    include _IObserver
+
+    attr_accessor notify: Method?
+
+    attr_accessor context: Object?
+
+    def initialize: (?Method? notify, ?Object? context) -> void
+
+    def notify_observer: (_INotification) -> void
+
+    def compare_notify_context?: (Object) -> bool
+  end
+
+  # Type-level assertion that Observer conforms to _IObserver
+  type observer_validation = validate_observer[Observer]
+end

data/sig/lib/patterns/proxy/proxy.rbs

@@ -0,0 +1,19 @@
+module PureMVC
+
+  class Proxy < Notifier
+
+    include _IProxy
+
+    NAME: String
+
+    attr_reader name: String
+
+    attr_accessor data: Object?
+
+    def initialize: (?String? name, ?Object? data) -> void
+  end
+
+  # Type-level assertion that Proxy conforms to _IProxy
+  type proxy_validation = validate_proxy[Proxy]
+end
+

metadata

@@ -1,68 +1,83 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: puremvc
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.0.1
 platform: ruby
-authors: 
-- Jake Dempsey
-autorequire: 
+authors:
+- Saad Shams
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2011-07-27 00:00:00 -03:00
-default_executable: 
+date: 2025-08-14 00:00:00.000000000 Z
 dependencies: []
-
-description: PureMVC is a lightweight framework for creating applications based upon the classic Model-View-Controller design meta-pattern. This is the specific implementation for the Ruby language based on the Standard Version AS3 reference.
-email: jake.dempsey@puremvc.org
+description: PureMVC is a lightweight framework for Model-View-Controller app development.
+email:
+- saad.shams@puremvc.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- version.txt
-files: 
-- src/org/puremvc/ruby/core/controller.rb
-- src/org/puremvc/ruby/core/model.rb
-- src/org/puremvc/ruby/core/view.rb
-- src/org/puremvc/ruby/patterns/command/macro_command.rb
-- src/org/puremvc/ruby/patterns/command/simple_command.rb
-- src/org/puremvc/ruby/patterns/facade/facade.rb
-- src/org/puremvc/ruby/patterns/mediator/mediator.rb
-- src/org/puremvc/ruby/patterns/observer/notification.rb
-- src/org/puremvc/ruby/patterns/observer/notifier.rb
-- src/org/puremvc/ruby/patterns/observer/observer.rb
-- src/org/puremvc/ruby/patterns/proxy/proxy.rb
-- puremvc.rb
-- version.txt
-has_rdoc: true
-homepage: http://trac.puremvc.org/PureMVC_Ruby/
-licenses: []
-
-post_install_message: 
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/core/controller.rb
+- lib/core/model.rb
+- lib/core/view.rb
+- lib/patterns/command/macro_command.rb
+- lib/patterns/command/simple_command.rb
+- lib/patterns/facade/facade.rb
+- lib/patterns/mediator/mediator.rb
+- lib/patterns/observer/notification.rb
+- lib/patterns/observer/notifier.rb
+- lib/patterns/observer/observer.rb
+- lib/patterns/proxy/proxy.rb
+- lib/puremvc.rb
+- sig/lib/core/controller.rbs
+- sig/lib/core/model.rbs
+- sig/lib/core/view.rbs
+- sig/lib/interfaces/i_command.rbs
+- sig/lib/interfaces/i_controller.rbs
+- sig/lib/interfaces/i_facade.rbs
+- sig/lib/interfaces/i_mediator.rbs
+- sig/lib/interfaces/i_model.rbs
+- sig/lib/interfaces/i_notification.rbs
+- sig/lib/interfaces/i_notifier.rbs
+- sig/lib/interfaces/i_observer.rbs
+- sig/lib/interfaces/i_proxy.rbs
+- sig/lib/interfaces/i_view.rbs
+- sig/lib/patterns/command/macro_command.rbs
+- sig/lib/patterns/command/simple_command.rbs
+- sig/lib/patterns/facade/facade.rbs
+- sig/lib/patterns/mediator/mediator.rbs
+- sig/lib/patterns/observer/notification.rbs
+- sig/lib/patterns/observer/notifier.rbs
+- sig/lib/patterns/observer/observer.rbs
+- sig/lib/patterns/proxy/proxy.rbs
+homepage: https://github.com/puremvc/puremvc-ruby-multicore-framework
+licenses:
+- BSD-3-Clause
+metadata:
+  steep_types: sig
+  github_repo: https://github.com/puremvc/puremvc-ruby-multicore-framework
+  source_code_uri: https://github.com/puremvc/puremvc-ruby-multicore-framework
+  bug_tracker_uri: https://github.com/puremvc/puremvc-ruby-multicore-framework/issues
+post_install_message:
 rdoc_options: []
-
-require_paths: 
-- .
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.6.2
-signing_key: 
-specification_version: 3
-summary: Lightweight Framework for applications based upon the classic Model-View-Controller design meta-pattern.
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: PureMVC Multicore Framework
 test_files: []
-

data/puremvc.rb

@@ -1,13 +0,0 @@
-$:.unshift File.join(File.dirname(__FILE__), 'src/org/puremvc/ruby')
-require 'singleton'
-require 'patterns/facade/facade'
-require 'patterns/proxy/proxy'
-require 'patterns/observer/observer'
-require 'patterns/observer/notification'
-require 'patterns/observer/notifier'
-require 'patterns/mediator/mediator'
-require 'patterns/command/macro_command'
-require 'patterns/command/simple_command'
-require 'core/controller'
-require 'core/model'
-require 'core/view'

data/src/org/puremvc/ruby/core/controller.rb

@@ -1,76 +0,0 @@
-# In PureMVC, the Controller class assumes these responsibilities:
-# * Remembering which Command is intended to handle which Notification.
-# * Registering itself as an Observer with the View for each Notification that it has an Command mapping for.
-# * Creating instances of the proper Command to handle a given Notification when notified by the View.
-# * Calling the Command's execute method, passing in the Notification. 
-#  
-# Your application must register any Commands with the Controller.
-#
-# The simplest way is to subclass Facade, and use its initializeController method to add your registrations. 
-# 
-# * Command refers to SimpleCommand or MacroCommand
-
-
-class Controller
-  attr_accessor :command_map, :view
-  
-  include Singleton
-  
-  # This Controller implementation is a Singleton, 
-  # so you can not call the constructor 
-  # directly, but instead call the static Singleton 
-  # Factory method Controller.instance
-  def initialize
-    @command_map = {}
-    initialize_controller
-  end
-
-  # Initialize the Singleton Controller instance.
-  #
-  # Called Automatically by the construcor.
-  #
-  # Note that if you are using a subclass of View in your application, you should also
-  # subclass Controller and override the initialize_controller method in the following way:
-  #
-  # <tt>
-  #   def initialize_controller
-  #      @view = MyView.instance
-  #   end
-  # </tt>
-  def initialize_controller
-    @view = View.instance
-  end
-  
-   # If a Command has previously been registered to handle a given Notification, then it is executed
-  def execute_command(notification)
-    return unless @command_map[notification.name]
-    @command_map[notification.name].new().execute(notification)
-  end
-  
-  
-  # Register a particular Command class as the handler for a particular Notification.
-  #
-  # If a Command has already been registered to handle Notification's with this name, it is 
-  # no longer user, the new Command is used instead.
-  # 
-  # The Observer for the new Command is only created if this is the first time a Command
-  # has been registered for this Notification name.
-  def register_command(notification_name, command_class)
-    @view.register_observer( notification_name, Observer.new(:execute_command, self) );
-    @command_map[notification_name] = command_class
-  end
-  
-  # Check if a command is registered for a given Notification
-  def has_command?(notification_name)
-    !@command_map[notification_name].nil?
-  end
-  
-  # Remove a previously registered Command for a given Notification
-  def remove_command(notification_name)
-    @view.remove_observer(notification_name, self)
-    @command_map.delete(notification_name)
-  end
-end
-# PureMVC Port to Ruby by Jake Dempsey <jake.dempsey@puremvc.org>
-# PureMVC - Copyright(c) 2006-2008 Futurescale, Inc., Some rights reserved.
-# Your reuse is governed by the Creative Commons Attribution 3.0 License

data/src/org/puremvc/ruby/core/model.rb

@@ -1,57 +0,0 @@
-# In PureMVC, the Model class provides access to model objects (Proxies) by named lookup. 
-# 
-# The Model assumes these responsibilities:
-#  * Maintain a cache of Proxy instances.
-#  * Provide methods for registering, retrieving, and removing Proxy instances.
-# 
-# Your application must register Proxy instances with the Model. 
-# Typically, you use an Command to create and register Proxy
-# instances once the Facade has initialized the Core actors.
-
-class Model
-  
-  include Singleton
-  attr_accessor :proxy_map
-
-  
-  # This Model implementation is a Singleton, so you can not call the constructor 
-  # directly, but instead call the static Singleton Factory method Model.instance
-  def initialize
-    @proxy_map = {}
-    initialize_model
-  end
-  
-  
-  # Initialize the Singleton Model instance.
-  # 
-  # Called automatically by the constructor, this is your opportunity to initialize the Singleton
-  # instance in your subclass without overriding the constructor.
-  def initialize_model
-  end
-  
-  # Register a Proxy with the Model.
-  def register_proxy(proxy)
-    @proxy_map[proxy.name] = proxy
-    proxy.on_register
-  end
-  
-  # Retrieve a Proxy from the Model
-  def retrieve_proxy(proxy_name)
-    @proxy_map[proxy_name]
-  end
-  
-  # Check if a Proxy is registered.
-  def has_proxy?(proxy_name)
-    !@proxy_map[proxy_name].nil?
-  end
-  
-  # Remove a Proxy from teh Model.
-  def remove_proxy(proxy_name)
-    proxy = @proxy_map.delete(proxy_name)
-    proxy.on_remove
-    proxy
-  end
-end
-# PureMVC Port to Ruby by Jake Dempsey <jake.dempsey@puremvc.org>
-# PureMVC - Copyright(c) 2006-2008 Futurescale, Inc., Some rights reserved.
-# Your reuse is governed by the Creative Commons Attribution 3.0 License

data/src/org/puremvc/ruby/core/view.rb

@@ -1,112 +0,0 @@
-# In PureMVC, the View class assumes these responsibilities:
-# 
-# * Maintain a cache of IMediator instances.
-# * Provide methods for registering, retrieving, and removing Mediators.
-# * Notifiying Mediators when they are registered or removed.
-# * Managing the observer lists for each Notification in the application.
-# * Providing a method for attaching Observers to an Notification's observer list.
-# * Providing a method for broadcasting an Notification.
-# * Notifying the Observers of a given Notification when it broadcast.
-class View
-  include Singleton
-  
-  attr_accessor :mediator_map, :observer_map
-  
-  
-  # This View implementation is a Singleton, so you should not call the constructor 
-  # directly, but instead call the static Singleton Factory method View.instance.
-  def initialize
-    @mediator_map = {}
-    @observer_map = {}
-    initialize_view
-  end
-  
-  # Initialize the Singleton View instance.
-  # 
-  # Called automatically by the constructor, this is your opportunity to initialize 
-  # the Singleton instance in your subclass without overriding the constructor
-  def initialize_view
-  end
-  
-  # Register an Observer to be notified of Notifications with a given name.
-  def register_observer(notification_name, observer)
-    observers = @observer_map[notification_name]
-    if observers.nil?
-      @observer_map[notification_name] = observer
-    else
-      observers = Array(@observer_map[notification_name])
-      observers << observer
-      @observer_map[notification_name] = observers
-    end
-  end
-  
-  # Notify the Observers for a particular Notification.
-  #
-  # All previously attached Observers for this Notification's list are notified
-  # and are passed a reference to the Notification in the order in which they were registered.
-  def notify_observers(notification)
-    observers = Array(@observer_map[notification.name])
-    observers.each{|observer| observer.notify_observer(notification)}
-  end
-  
-  # Remove the observer for a given notify context from an observer list for a given 
-  # Notification name.
-  def remove_observer(notification_name, observer)
-    observers = @observer_map[notification_name]
-    observers = [observers] unless observers.is_a?(Array)
-    @observer_map[notification_name] = observers.reject { |o| o.compare_notify_context(observer) }
-    @observer_map.delete(notification_name) if observers.size.zero?
-  end
-  
-  # Register a Mediator instance with the View.
-  # 
-  # Registers the Mediator so that it can be retrieved by name and further interrogates
-  # the mediator for its Notification interests.
-  #
-  # If the mediator returns any Notifiation name to be notified about, an Observer is created
-  # encapsulating the Mediator instance's handle_notification method and registering it as an
-  # Observer for all Notifications the Mediator is interested in.
-  def register_mediator(mediator)
-    unless @mediator_map[mediator.name]
-      @mediator_map[mediator.name] = mediator
-      observer = Observer.new(:handle_notification, mediator)
-      mediator.list_notification_interests.each do |interest|
-        register_observer(interest, observer)
-      end
-      mediator.on_register
-    end
-  end
-  
-  # Retrieve a mediator from the View.
-  #
-  # returns the previously registered Mediator with the given name.
-  def retrieve_mediator(mediator_name)
-    @mediator_map[mediator_name]
-  end
-  
-  # Remove a Mediator from the View.
-  #
-  # returns the Mediator that was removed.
-  def remove_mediator(mediator_name)
-    mediator = @mediator_map[mediator_name]
-    if mediator
-      mediator.list_notification_interests.each do |interest|
-        remove_observer(interest, mediator)
-      end
-      @mediator_map.delete(mediator_name)
-      mediator.on_remove
-    end
-    mediator
-  end
-  
-  # Check if a Mediator is registered or not.
-  #
-  # returns whether a Mediator is registered with the given name.
-  def has_mediator?(mediator_name)
-    !@mediator_map[mediator_name].nil?
-  end
-  
-end
-# PureMVC Port to Ruby by Jake Dempsey <jake.dempsey@puremvc.org>
-# PureMVC - Copyright(c) 2006-2008 Futurescale, Inc., Some rights reserved.
-# Your reuse is governed by the Creative Commons Attribution 3.0 License