felflame 1.0.2 → 4.0.1

data/lib/felflame/system_manager.rb

@@ -1,10 +1,11 @@
-class FelFlame
+# frozen_string_literal: true
+
+module FelFlame
   class Systems
     # How early this System should be executed in a list of Systems
     attr_accessor :priority
 
     # The Constant name assigned to this System
-    attr_reader :const_name
 
     # Allows overwriting the storage of triggers, such as for clearing.
     # This method should generally only need to be used internally and
@@ -12,10 +13,20 @@ class FelFlame
     # @!visibility private
     attr_writer :addition_triggers, :removal_triggers, :attr_triggers
 
+    # Stores all the scenes this system is a part of.
+    attr_writer :scenes
+
+    def scenes
+      @scenes ||= []
+    end
+
     def priority=(priority)
       @priority = priority
-      FelFlame::Stage.systems.sort_by!(&:priority)
+      scenes.each do |scene|
+        scene.systems = scene.systems.sort_by(&:priority)
+      end
     end
+
     # Stores references to components or their managers that trigger
     # this component when a component or component from that manager
     # is added to an entity.
@@ -34,7 +45,6 @@ class FelFlame
       @removal_triggers ||= []
     end
 
-
     # Stores references to systems that should be triggered when an
     # attribute from this manager is changed
     # Do not edit this hash as it is managed by FelFlame automatically.
@@ -43,13 +53,47 @@ class FelFlame
       @attr_triggers ||= {}
     end
 
-    class <<self
-      include Enumerable
+    class << self
+      # Stores the systems in {FelFlame::Components}. This
+      # is needed because calling `FelFlame::Components.constants`
+      # will not let you iterate over the value of the constants
+      # but will instead give you an array of symbols. This caches
+      # the convertion of those symbols to the actual value of the
+      # constants
+      def const_cache
+        @const_cache || update_const_cache
+      end
 
-      # Iterate over all Systems, sorted by their priority. You also call other enumerable methods instead of each, such as +each_with_index+ or +select+
-      # @return [Enumerator]
-      def each(&block)
-        constants.map { |sym| const_get(sym) }.sort_by(&:priority).reverse.each(&block)
+      # Updates the array that stores the constants.
+      # Used internally by FelFlame
+      # @!visibility private
+      def update_const_cache
+        @const_cache = constants.map do |constant|
+          const_get constant
+        end
+      end
+
+      # Forwards undefined methods to the array of constants
+      # if the array can handle the request. Otherwise tells
+      # the programmer their code errored
+      # @!visibility private
+      def respond_to_missing?(method, *)
+        if const_cache.respond_to? method
+          true
+        else
+          super
+        end
+      end
+
+      # Makes system module behave like arrays with additional
+      # methods for managing the array
+      # @!visibility private
+      def method_missing(method, *args, **kwargs, &block)
+        if const_cache.respond_to? method
+          const_cache.send(method, *args, **kwargs, &block)
+        else
+          super
+        end
       end
     end
 
@@ -70,15 +114,17 @@ class FelFlame
     # @param block [Proc] The code you wish to be executed when the system is triggered. Can be defined by using a +do end+ block or using +{ }+ braces.
     def initialize(name, priority: 0, &block)
       FelFlame::Systems.const_set(name, self)
-      @const_name = name
+      FelFlame::Systems.update_const_cache
       @priority = priority
       @block = block
+      @scenes = []
     end
 
     # Manually execute the system a single time
     def call
       @block.call
     end
+
     # Redefine what code is executed by this System when it is called upon.
     # @param block [Proc] The code you wish to be executed when the system is triggered. Can be defined by using a +do end+ block or using +{ }+ braces.
     def redefine(&block)
@@ -109,16 +155,16 @@ class FelFlame
     # @param component_or_manager [Component or ComponentManager] The object to clear triggers from. Use Nil to clear triggers from all components associated with this system.
     # @return [Boolean] +true+
     def clear_triggers(*trigger_types, component_or_manager: nil)
-      trigger_types = [:addition_triggers, :removal_triggers, :attr_triggers] if trigger_types.empty?
+      trigger_types = %i[addition_triggers removal_triggers attr_triggers] if trigger_types.empty?
 
       if trigger_types.include? :attr_triggers
-        if (trigger_types - [:addition_triggers,
-            :removal_triggers,
-            :attr_triggers]).empty?
+        if (trigger_types - %i[addition_triggers
+                               removal_triggers
+                               attr_triggers]).empty?
 
           if component_or_manager.nil?
-            #remove all attrs
-            self.attr_triggers.each do |cmp_or_mgr, attrs|
+            # remove all attrs
+            attr_triggers.each do |cmp_or_mgr, attrs|
               attrs.each do |attr|
                 next if cmp_or_mgr.attr_triggers[attr].nil?
 
@@ -127,49 +173,48 @@ class FelFlame
               self.attr_triggers = {}
             end
           else
-            #remove attrs relevant to comp_or_man
-            unless self.attr_triggers[component_or_manager].nil?
-              self.attr_triggers[component_or_manager].each do |attr|
+            # remove attrs relevant to comp_or_man
+            unless attr_triggers[component_or_manager].nil?
+              attr_triggers[component_or_manager].each do |attr|
                 component_or_manager.attr_triggers[attr].delete self
               end
-              self.attr_triggers[component_or_manager] = []
+              attr_triggers[component_or_manager] = []
             end
           end
 
-        else
+        elsif component_or_manager.nil?
 
-          if component_or_manager.nil?
-            (trigger_types - [:addition_triggers, :removal_triggers, :attr_triggers]).each do |attr|
-              #remove attr
-              self.attr_triggers.each do |cmp_or_mgr, attrs|
-                cmp_or_mgr.attr_triggers[attr].delete self
-              end
-            end
-            self.attr_triggers.delete (trigger_types - [:addition_triggers,
-                                                        :removal_triggers,
-                                                        :attr_triggers])
-          else
-            #remove attr from component_or_manager
-            (trigger_types - [:addition_triggers, :removal_triggers, :attr_triggers]).each do |attr|
-              next if component_or_manager.attr_triggers[attr].nil?
-              component_or_manager.attr_triggers[attr].delete self
+          (trigger_types - %i[addition_triggers removal_triggers attr_triggers]).each do |attr|
+            # remove attr
+            attr_triggers.each do |cmp_or_mgr, _attrs|
+              cmp_or_mgr.attr_triggers[attr].delete self
             end
-            self.attr_triggers[component_or_manager] -= trigger_types unless self.attr_triggers[component_or_manager].nil?
           end
+          attr_triggers.delete(trigger_types - %i[addition_triggers
+                                                  removal_triggers
+                                                  attr_triggers])
+        else
+          # remove attr from component_or_manager
+          (trigger_types - %i[addition_triggers removal_triggers attr_triggers]).each do |attr|
+            next if component_or_manager.attr_triggers[attr].nil?
+
+            component_or_manager.attr_triggers[attr].delete self
+          end
+          attr_triggers[component_or_manager] -= trigger_types unless attr_triggers[component_or_manager].nil?
 
         end
       end
 
-      (trigger_types & [:removal_triggers, :addition_triggers] - [:attr_triggers]).each do |trigger_type|
+      (trigger_types & %i[removal_triggers addition_triggers] - [:attr_triggers]).each do |trigger_type|
         if component_or_manager.nil?
-          #remove all removal triggers
-          self.send(trigger_type).each do |trigger|
+          # remove all removal triggers
+          send(trigger_type).each do |trigger|
             trigger.send(trigger_type).delete self
           end
-          self.send("#{trigger_type.to_s}=", [])
+          send("#{trigger_type}=", [])
         else
-          #remove removal trigger relevant to comp/man
-          self.send(trigger_type).delete component_or_manager
+          # remove removal trigger relevant to comp/man
+          send(trigger_type).delete component_or_manager
           component_or_manager.send(trigger_type).delete self
         end
       end
@@ -202,10 +247,10 @@ class FelFlame
       else
         component_or_manager.attr_triggers[attr] |= [self]
       end
-      if self.attr_triggers[component_or_manager].nil?
-        self.attr_triggers[component_or_manager] = [attr]
+      if attr_triggers[component_or_manager].nil?
+        attr_triggers[component_or_manager] = [attr]
       else
-        self.attr_triggers[component_or_manager] |= [attr]
+        attr_triggers[component_or_manager] |= [attr]
       end
       true
     end

data/lib/felflame/version.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# :nocov:
+# Keeps the version of the Gem
 module Felflame
-  VERSION = "1.0.2"
+  # The version of the Gem
+  VERSION = '4.0.1'
 end
+# :nocov:

data/lib/felflame.rb

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
+
+puts 'WARNING: you are using a deprecated gem, it has been renamed.'
+puts 'Please change to: https://rubygems.org/gems/felecs'
+
 require_relative 'felflame/entity_manager'
 require_relative 'felflame/component_manager'
 require_relative 'felflame/system_manager'
 require_relative 'felflame/scene_manager'
 require_relative 'felflame/stage_manager'
+require_relative 'felflame/order'
 
-require_relative "felflame/version"
+require_relative 'felflame/version'
 
 # The FelFlame namespace where all its functionality resides under.
-class FelFlame
-  class <<self
+module FelFlame
+  class << self
     # :nocov:
 
     # An alias for {FelFlame::Stage.call}. It executes a single frame in the game.
@@ -18,26 +24,28 @@ class FelFlame
     # :nocov:
   end
 
-  # Creates and manages Entities. Allows accessing Entities using their {FelFlame::Entities#id ID}. Entities are just collections of Components.
+  # Creates and manages Entities. Entities are just collections of Components.
+  # You can use array methods directly on this class to access Entities.
   class Entities; end
 
-  # Creates component managers and allows accessing them them under the {FelFlame::Components} namespace as Constants
+  # Creates component managers and allows accessing them them under the {FelFlame::Components} namespace as Constants.
+  # You can use array methods directly on this class to access Component Managers.
   #
   # To see how component managers are used please look at the {FelFlame::ComponentManager} documentation.
-  class Components; end
+  module Components; end
 
-  # Creates an manages Systems. Systems are the logic of the game and do not contain any data within them.
-  #
-  # TODO: Improve Systems overview
+  # Creates and manages Systems. Systems are the logic of the game and do not contain any data within them. Any systems you create are accessable under the {FelFlame::Systems} namespace as Constants.
+  # You can use array methods directly on this class to access Systems.
   class Systems; end
 
-  # Creates and manages Scenes. Scenes are collections of Systems, and execute all the Systems when called upon.
-  # 
-  # TODO: Improve Scenes overview
+  # Creates and manages Scenes. Scenes are collections of Systems, and execute all the Systems when called upon. Any scenes you create are accessable under the {FelFlame::Scenes} namespace as Constants.
   class Scenes; end
 
-  # Stores Scenes which you want to execute on each frame. When called upon will execute all Systems in the Scenes in the Stage and will execute them according to their priority order.
-  class Stage; end
+  # Stores Scenes you add to it which you want to execute on each frame. When called upon will execute all Systems in the Scenes in the Stage and will execute them according to their priority order.
+  module Stage; end
+
+  # Sets the priority of a list of Systems or Scenes for you in the order you pass them to this class.
+  module Order; end
 end
 
 # An alias for {FelFlame}
@@ -53,7 +61,10 @@ FF::Cmp = FelFlame::Components
 FF::Sys = FelFlame::Systems
 
 # An alias for {FelFlame::Scenes}
-FF::Sce = FelFlame::Scenes
+FF::Scn = FelFlame::Scenes
 
 # An alias for {FelFlame::Stage}
 FF::Stg = FelFlame::Stage
+
+# An alias for {FelFlame::
+FF::Odr = FelFlame::Order

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: felflame
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 4.0.1
 platform: ruby
 authors:
 - Tradam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
@@ -31,109 +31,109 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.4.3
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: simplecov-console
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: simplecov_json_formatter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: simplecov_json_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.26
+        version: 0.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.26
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 0.9.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 0.9.26
 description:
 email:
 - felflame@tradam.dev
@@ -146,7 +146,7 @@ files:
 - ".inch.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".yardopts"
+- ".ruby-version"
 - CHANGELOG.mdown
 - Gemfile
 - Gemfile.lock
@@ -162,15 +162,18 @@ files:
 - docs/FelFlame/Entities.html
 - docs/FelFlame/Helper.html
 - docs/FelFlame/Helper/ComponentManager.html
+- docs/FelFlame/Order.html
 - docs/FelFlame/Scenes.html
 - docs/FelFlame/Stage.html
 - docs/FelFlame/Systems.html
+- docs/Felflame_.html
 - docs/_index.html
 - docs/class_list.html
 - docs/css/common.css
 - docs/css/full_list.css
 - docs/css/style.css
 - docs/file.README.html
+- docs/file.version.html
 - docs/file_list.html
 - docs/frames.html
 - docs/index.html
@@ -183,6 +186,7 @@ files:
 - lib/felflame.rb
 - lib/felflame/component_manager.rb
 - lib/felflame/entity_manager.rb
+- lib/felflame/order.rb
 - lib/felflame/scene_manager.rb
 - lib/felflame/stage_manager.rb
 - lib/felflame/system_manager.rb
@@ -211,5 +215,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: The Engine Agnostic ECS Ruby Framework
+summary: 'Renamed to FelECS: https://rubygems.org/gems/felecs'
 test_files: []

data/.yardopts

@@ -1,13 +0,0 @@
---readme README.mdown
---markup=markdown|textile|rdoc(default)
---protected
---no-private
-
-LICENSE
-README.mdown
-system_manager.rb
-component_manager.rb
-entity_manager.rb
-scene_manager.rb
-stage_manager.rb
-felflame.rb