From 0fbb48c7b0ef7070664945ef22840b0bfbfe9153 Mon Sep 17 00:00:00 2001 From: realtradam Date: Fri, 9 Jul 2021 03:32:01 -0400 Subject: gem conversion --- .byebug_history | 20 +++ .gitignore | 6 + .rspec | 1 + .rubocop.yml | 13 ++ CHANGELOG.md | 5 + Gemfile | 19 +-- Gemfile.lock | 25 +++ LICENSE.txt | 21 +++ README.md | 39 +++++ Rakefile | 22 ++- bin/console | 15 ++ bin/setup | 8 + codeclimate/env.rb | 2 +- codeclimate/test-reporter-latest-linux-amd64 | Bin 0 -> 13206167 bytes component_manager.rb | 245 --------------------------- entity_manager.rb | 135 --------------- felflame.gemspec | 37 ++++ felflame.rb | 57 ------- lib/felflame.rb | 59 +++++++ lib/felflame/component_manager.rb | 245 +++++++++++++++++++++++++++ lib/felflame/entity_manager.rb | 135 +++++++++++++++ lib/felflame/scene_manager.rb | 58 +++++++ lib/felflame/stage_manager.rb | 70 ++++++++ lib/felflame/system_manager.rb | 213 +++++++++++++++++++++++ lib/felflame/version.rb | 5 + scene_manager.rb | 58 ------- spec/component_manager_spec.rb | 2 +- spec/entity_manager_spec.rb | 2 +- spec/scene_manager_spec.rb | 2 +- spec/stage_manager_spec.rb | 2 +- spec/system_manager_spec.rb | 2 +- stage_manager.rb | 70 -------- system_manager.rb | 213 ----------------------- 33 files changed, 1000 insertions(+), 806 deletions(-) create mode 100644 .byebug_history create mode 100644 .rspec create mode 100644 .rubocop.yml create mode 100644 CHANGELOG.md create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100755 bin/console create mode 100755 bin/setup create mode 100755 codeclimate/test-reporter-latest-linux-amd64 delete mode 100644 component_manager.rb delete mode 100644 entity_manager.rb create mode 100644 felflame.gemspec delete mode 100644 felflame.rb create mode 100644 lib/felflame.rb create mode 100644 lib/felflame/component_manager.rb create mode 100644 lib/felflame/entity_manager.rb create mode 100644 lib/felflame/scene_manager.rb create mode 100644 lib/felflame/stage_manager.rb create mode 100644 lib/felflame/system_manager.rb create mode 100644 lib/felflame/version.rb delete mode 100644 scene_manager.rb delete mode 100644 stage_manager.rb delete mode 100644 system_manager.rb diff --git a/.byebug_history b/.byebug_history new file mode 100644 index 0000000..7212ba8 --- /dev/null +++ b/.byebug_history @@ -0,0 +1,20 @@ +c +s +var instance +s +var instance +s +v args +s +v instance +s +v instance +v const +v +v all +v args +v local +v +tr +s +n diff --git a/.gitignore b/.gitignore index 53b3214..0a3e337 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,8 @@ +/.bundle/ +/pkg/ +/spec/reports/ +/tmp/ + # Ignore generated coverage coverage/* coverage @@ -5,6 +10,7 @@ coverage # Ignore yard metadata .yardoc/* .yardoc +/_yardoc/ # Ignore codeclimate executable and env vars codeclimate/env.rb diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..c99d2e7 --- /dev/null +++ b/.rspec @@ -0,0 +1 @@ +--require spec_helper diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..bfef2d0 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,13 @@ +AllCops: + TargetRubyVersion: 2.4 + +Style/StringLiterals: + Enabled: true + EnforcedStyle: double_quotes + +Style/StringLiteralsInInterpolation: + Enabled: true + EnforcedStyle: double_quotes + +Layout/LineLength: + Max: 120 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5f29f71 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +## [Unreleased] + +## [0.1.0] - 2021-07-09 + +- Initial release diff --git a/Gemfile b/Gemfile index 7a5783f..57f3b06 100644 --- a/Gemfile +++ b/Gemfile @@ -1,18 +1,11 @@ -source 'https://rubygems.org' +# frozen_string_literal: true -ruby '2.7.3' +source "https://rubygems.org" -group :test do - gem 'minitest-reporters', '~> 1.4', '>= 1.4.3', require: false - gem 'rspec', '~> 3.10' - gem 'simplecov', '~> 0.21.2', require: false - gem 'simplecov-console', '~> 0.9.1' - gem 'simplecov_json_formatter', '~> 0.1.3', require: false -end +# Specify your gem's dependencies in felflame.gemspec +gemspec -group :docs do - gem 'redcarpet', '~> 3.5', '>= 3.5.1', require: false - gem 'yard', '~> 0.9.26', require: false -end +ruby '2.7.3' gem "rake", "~> 13.0" + diff --git a/Gemfile.lock b/Gemfile.lock index d0180ff..6a25741 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,13 @@ +PATH + remote: . + specs: + felflame (1.0.0.beta1) + GEM remote: https://rubygems.org/ specs: ansi (1.5.0) + ast (2.4.2) builder (3.2.4) diff-lcs (1.4.4) docile (1.4.0) @@ -11,8 +17,14 @@ GEM builder minitest (>= 5.0) ruby-progressbar + parallel (1.20.1) + parser (3.0.1.1) + ast (~> 2.4.1) + rainbow (3.0.0) rake (13.0.3) redcarpet (3.5.1) + regexp_parser (2.1.1) + rexml (3.2.5) rspec (3.10.0) rspec-core (~> 3.10.0) rspec-expectations (~> 3.10.0) @@ -26,6 +38,17 @@ GEM diff-lcs (>= 1.2.0, < 2.0) rspec-support (~> 3.10.0) rspec-support (3.10.2) + rubocop (1.17.0) + parallel (~> 1.10) + parser (>= 3.0.0.0) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 1.8, < 3.0) + rexml + rubocop-ast (>= 1.7.0, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 1.4.0, < 3.0) + rubocop-ast (1.7.0) + parser (>= 3.0.1.1) ruby-progressbar (1.11.0) simplecov (0.21.2) docile (~> 1.1) @@ -46,10 +69,12 @@ PLATFORMS ruby DEPENDENCIES + felflame! minitest-reporters (~> 1.4, >= 1.4.3) rake (~> 13.0) redcarpet (~> 3.5, >= 3.5.1) rspec (~> 3.10) + rubocop (~> 1.7) simplecov (~> 0.21.2) simplecov-console (~> 0.9.1) simplecov_json_formatter (~> 0.1.3) diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..82abdd9 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2021 realtradam + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..467cf39 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Felflame + +Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/felflame`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'felflame' +``` + +And then execute: + + $ bundle install + +Or install it yourself as: + + $ gem install felflame + +## Usage + +TODO: Write usage instructions here + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/felflame. + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/Rakefile b/Rakefile index 310dacd..0ea508a 100644 --- a/Rakefile +++ b/Rakefile @@ -1,20 +1,17 @@ - -#require 'rake/testtask' +# frozen_string_literal: true +# require 'rubygems' require 'bundler/setup' require 'rspec/core/rake_task' require 'yard' require_relative './codeclimate/export-coverage' - +require "bundler/gem_tasks" +require "rubocop/rake_task" task :default => [:spec, :yard, 'coverage:format'] +#task default: :rubocop -# For installing FelPacks -Gem::Specification.find_all.each do |a_gem| - next unless a_gem.name.include? 'felpack-' - - Dir.glob("#{a_gem.gem_dir}/lib/#{a_gem.name.gsub('-', '/')}/tasks/*.rake").each { |r| load r } -end +RuboCop::RakeTask.new namespace :coverage do desc 'format coverage so it can be exported to codeclimate' @@ -39,3 +36,10 @@ end #end RSpec::Core::RakeTask.new :spec + +# For installing FelPacks +#Gem::Specification.find_all.each do |a_gem| +# next unless a_gem.name.include? 'felpack-' +# +# Dir.glob("#{a_gem.gem_dir}/lib/#{a_gem.name.gsub('-', '/')}/tasks/*.rake").each { |r| load r } +#end diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..c0dca2c --- /dev/null +++ b/bin/console @@ -0,0 +1,15 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require "bundler/setup" +require "felflame" + +# You can add fixtures and/or initialization code here to make experimenting +# with your gem easier. You can also use a different console, if you like. + +# (If you use this, don't forget to add pry to your Gemfile!) +# require "pry" +# Pry.start + +require "irb" +IRB.start(__FILE__) diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/bin/setup @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -euo pipefail +IFS=$'\n\t' +set -vx + +bundle install + +# Do any other automated setup that you need to do here diff --git a/codeclimate/env.rb b/codeclimate/env.rb index 59129ab..0a0ad43 100644 --- a/codeclimate/env.rb +++ b/codeclimate/env.rb @@ -1 +1 @@ -ENV['CC_TEST_REPORTER_ID'] = '' +ENV['CC_TEST_REPORTER_ID'] = '48d1c389052ea205cb4d72b05f7606fc53a9b5def70c2bfdd957efb73657d32c' diff --git a/codeclimate/test-reporter-latest-linux-amd64 b/codeclimate/test-reporter-latest-linux-amd64 new file mode 100755 index 0000000..bb04747 Binary files /dev/null and b/codeclimate/test-reporter-latest-linux-amd64 differ diff --git a/component_manager.rb b/component_manager.rb deleted file mode 100644 index 1cfd76d..0000000 --- a/component_manager.rb +++ /dev/null @@ -1,245 +0,0 @@ -class FelFlame - class Components - @component_map = [] - class <] - def addition_triggers - @addition_triggers ||= [] - end - - # Stores references to systems that should be triggered when a - # component from this manager is removed. - # Do not edit this array as it is managed by FelFlame automatically. - # @return [Array] - def removal_triggers - @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. - # @return [Hash>] - def attr_triggers - @attr_triggers ||= {} - end - - # Creates a new component and sets the values of the attributes given to it. If an attritbute is not passed then it will remain as the default. - # @param attrs [Keyword: Value] You can pass any number of Keyword-Value pairs - # @return [Component] - def initialize(**attrs) - # Prepare the object - # (this is a function created with metaprogramming - # in FelFlame::Components - set_defaults - - # Generate ID - new_id = self.class.data.find_index { |i| i.nil? } - new_id = self.class.data.size if new_id.nil? - @id = new_id - - # Fill params - attrs.each do |key, value| - send "#{key}=", value - end - - # Save Component - self.class.data[new_id] = self - end - - class <] - def addition_triggers - @addition_triggers ||= [] - end - - # Stores references to systems that should be triggered when this - # component is removed from an enitity. - # Do not edit this array as it is managed by FelFlame automatically. - # @return [Array] - def removal_triggers - @removal_triggers ||= [] - end - - # Stores references to systems that should be triggered when an - # attribute from this component changed. - # Do not edit this hash as it is managed by FelFlame automatically. - # @return [Hash] - def attr_triggers - @attr_triggers ||= {} - end - - # @return [Array] Array of all Components that belong to a given component manager - # @!visibility private - def data - @data ||= [] - end - - # Gets a Component from the given {id unique ID}. Usage is simular to how an Array lookup works. - # - # @example - # # this gets the 'Health' Component with ID 7 - # FelFlame::Components::Health[7] - # @param component_id [Integer] - # @return [Component] Returns the Component that uses the given unique {id ID}, nil if there is no Component associated with the given {id ID} - def [](component_id) - data[component_id] - end - - # Iterates over all components within the component manager. - # Special Enumerable methods like +map+ or +each_with_index+ are not implemented - # @return [Enumerator] - def each(&block) - data.compact.each(&block) - end - end - - # An alias for the {id ID Reader} - # @return [Integer] - def to_i - id - end - - # A list of entity ids that are linked to the component - # @return [Array] - def entities - @entities ||= [] - end - - # Update attribute values using a hash or keywords. - # @return [Hash] Hash of updated attributes - def update_attrs(**opts) - opts.each do |key, value| - send "#{key}=", value - end - end - - # Execute systems that have been added to execute on variable change - # @return [Boolean] +true+ - def attr_changed_trigger_systems(attr) - systems_to_execute = self.class.attr_triggers[attr] - systems_to_execute = [] if systems_to_execute.nil? - - systems_to_execute |= attr_triggers[attr] unless attr_triggers[attr].nil? - - systems_to_execute.sort_by(&:priority).reverse.each(&:call) - true - end - - # Removes this component from the list and purges all references to this Component from other Entities, as well as its {id ID} and data. - # @return [Boolean] +true+. - def delete - addition_triggers.each do |system| - system.clear_triggers component_or_manager: self - end - # This needs to be cloned because indices get deleted as - # the remove command is called, breaking the loop if it - # wasn't referencing a clone(will get Nil errors) - iter = entities.map(&:clone) - iter.each do |entity_id| - FelFlame::Entities[entity_id].remove self #unless FelFlame::Entities[entity_id].nil? - end - self.class.data[id] = nil - instance_variables.each do |var| - instance_variable_set(var, nil) - end - true - end - - # @return [Hash] A hash, where all the keys are attributes linked to their respective values. - def attrs - return_hash = instance_variables.each_with_object({}) do |key, final| - final[key.to_s.delete_prefix('@').to_sym] = instance_variable_get(key) - end - return_hash.delete(:attr_triggers) - return_hash - end - - # Export all data into a JSON String, which could then later be loaded or saved to a file - # TODO: This function is not yet complete - # @return [String] a JSON formatted String - #def to_json - # # should return a json or hash of all data in this component - #end - end -end diff --git a/entity_manager.rb b/entity_manager.rb deleted file mode 100644 index 74fc4c3..0000000 --- a/entity_manager.rb +++ /dev/null @@ -1,135 +0,0 @@ -class FelFlame - class Entities - # Holds the unique ID of this entity - # @return [Integer] - attr_reader :id - - # A seperate attr_writer was made for documentation readability reasons. - # Yard will list attr_reader is readonly which is my intention. - # This value needs to be changable as it is set by other functions. - # @!visibility private - attr_writer :id - - # Creating a new Entity - # @param components [Components] Can be any number of components, identical duplicates will be automatically purged however different components from the same component manager are allowed. - # @return [Entity] - def initialize(*components) - # Assign new unique ID - new_id = self.class.data.find_index(&:nil?) - new_id = self.class.data.size if new_id.nil? - self.id = new_id - - # Add each component - add(*components) - - self.class.data[id] = self - end - - # A hash that uses component manager constant names as keys, and where the values of those keys are arrays that contain the {FelFlame::ComponentManager#id IDs} of the components attached to this entity. - # @return [Hash>] - def components - @components ||= {} - end - - # An alias for the {#id ID reader} - # @return [Integer] - def to_i - id - end - - # Removes this Entity from the list and purges all references to this Entity from other Components, as well as its {id ID} and data. - # @return [Boolean] +true+ - def delete - components.each do |component_manager, component_array| - component_array.each do |component_id| - component_manager[component_id].entities.delete(id) - #self.remove FelFlame::Components.const_get(component_manager.name)[component_id] - end - end - FelFlame::Entities.data[id] = nil - @components = {} - @id = nil - true - end - - # Add any number components to the Entity. - # @param components_to_add [Component] Any number of components created from any component manager - # @return [Boolean] +true+ - def add(*components_to_add) - components_to_add.each do |component| - if components[component.class].nil? - components[component.class] = [component.id] - component.entities.push id - check_systems component, :addition_triggers - elsif !components[component.class].include? component.id - components[component.class].push component.id - component.entities.push id - check_systems component, :addition_triggers - end - end - true - end - - # triggers every system associated with this component's trigger - # @return [Boolean] +true+ - # @!visibility private - def check_systems(component, trigger_type) - component_calls = component.class.send(trigger_type) - component.send(trigger_type).each do |system| - component_calls |= [system] - end - component_calls.sort_by(&:priority).reverse.each(&:call) - true - end - - # Remove a component from the Entity - # @param components_to_remove [Component] A component created from any component manager - # @return [Boolean] +true+ - def remove(*components_to_remove) - components_to_remove.each do |component| - check_systems component, :removal_triggers if component.entities.include? id - component.entities.delete id - components[component.class].delete component.id - end - true - end - - # Export all data into a JSON String which can then be saved into a file - # TODO: This function is not yet complete - # @return [String] A JSON formatted String - #def to_json() end - - class <] Array of all Entities that exist - # @!visibility private - def data - @data ||= [] - end - - # Gets an Entity from the given {id unique ID}. Usage is simular to how an Array lookup works - # - # @example - # # This gets the Entity with ID 7 - # FelFlame::Entities[7] - # @param entity_id [Integer] - # @return [Entity] returns the Entity that uses the given unique ID, nil if there is no Entity associated with the given ID - def [](entity_id) - data[entity_id] - end - - # Iterates over all entities. The data is compacted so that means index does not correlate to ID. - # You also call other enumerable methods instead of each, such as +each_with_index+ or +select+ - # @return [Enumerator] - def each(&block) - data.compact.each(&block) - end - - # Creates a new entity using the data from a JSON string - # TODO: This function is not yet complete - # @param json_string [String] A string that was exported originally using the {FelFlame::Entities#to_json to_json} function - # @param opts [Keywords] What values(its {FelFlame::Entities#id ID} or the {FelFlame::ComponentManager#id component IDs}) should be overwritten TODO: this might change - #def from_json(json_string, **opts) end - end - end -end diff --git a/felflame.gemspec b/felflame.gemspec new file mode 100644 index 0000000..4ea9dd5 --- /dev/null +++ b/felflame.gemspec @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +require_relative "lib/felflame/version" + +Gem::Specification.new do |spec| + spec.name = "felflame" + spec.version = Felflame::VERSION + spec.authors = ["realtradam"] + spec.email = ["mr.malczewski@gmail.com"] + + spec.summary = "TODO: Write a short summary, because RubyGems requires one." + spec.description = "TODO: Write a longer description or delete this line." + spec.homepage = "TODO: Put your gem's website or public repo URL here." + spec.license = "MIT" + spec.required_ruby_version = ">= 2.4.0" + + spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" + + spec.metadata["homepage_uri"] = spec.homepage + spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here." + spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here." + + # Specify which files should be added to the gem when it is released. + # The `git ls-files -z` loads the files in the RubyGem that have been added into git. + spec.files = Dir.chdir(File.expand_path(__dir__)) do + `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) } + end + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + # Uncomment to register a new dependency of your gem + # spec.add_dependency "example-gem", "~> 1.0" + + # For more information and examples about making a new gem, checkout our + # guide at: https://bundler.io/guides/creating_gem.html +end diff --git a/felflame.rb b/felflame.rb deleted file mode 100644 index 7ed7897..0000000 --- a/felflame.rb +++ /dev/null @@ -1,57 +0,0 @@ -require_relative './entity_manager' -require_relative './component_manager' -require_relative './system_manager' -require_relative './scene_manager' -require_relative './stage_manager' - -# The FelFlame namespace where all its functionality resides under. -class FelFlame - class <] + def addition_triggers + @addition_triggers ||= [] + end + + # Stores references to systems that should be triggered when a + # component from this manager is removed. + # Do not edit this array as it is managed by FelFlame automatically. + # @return [Array] + def removal_triggers + @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. + # @return [Hash>] + def attr_triggers + @attr_triggers ||= {} + end + + # Creates a new component and sets the values of the attributes given to it. If an attritbute is not passed then it will remain as the default. + # @param attrs [Keyword: Value] You can pass any number of Keyword-Value pairs + # @return [Component] + def initialize(**attrs) + # Prepare the object + # (this is a function created with metaprogramming + # in FelFlame::Components + set_defaults + + # Generate ID + new_id = self.class.data.find_index { |i| i.nil? } + new_id = self.class.data.size if new_id.nil? + @id = new_id + + # Fill params + attrs.each do |key, value| + send "#{key}=", value + end + + # Save Component + self.class.data[new_id] = self + end + + class <] + def addition_triggers + @addition_triggers ||= [] + end + + # Stores references to systems that should be triggered when this + # component is removed from an enitity. + # Do not edit this array as it is managed by FelFlame automatically. + # @return [Array] + def removal_triggers + @removal_triggers ||= [] + end + + # Stores references to systems that should be triggered when an + # attribute from this component changed. + # Do not edit this hash as it is managed by FelFlame automatically. + # @return [Hash] + def attr_triggers + @attr_triggers ||= {} + end + + # @return [Array] Array of all Components that belong to a given component manager + # @!visibility private + def data + @data ||= [] + end + + # Gets a Component from the given {id unique ID}. Usage is simular to how an Array lookup works. + # + # @example + # # this gets the 'Health' Component with ID 7 + # FelFlame::Components::Health[7] + # @param component_id [Integer] + # @return [Component] Returns the Component that uses the given unique {id ID}, nil if there is no Component associated with the given {id ID} + def [](component_id) + data[component_id] + end + + # Iterates over all components within the component manager. + # Special Enumerable methods like +map+ or +each_with_index+ are not implemented + # @return [Enumerator] + def each(&block) + data.compact.each(&block) + end + end + + # An alias for the {id ID Reader} + # @return [Integer] + def to_i + id + end + + # A list of entity ids that are linked to the component + # @return [Array] + def entities + @entities ||= [] + end + + # Update attribute values using a hash or keywords. + # @return [Hash] Hash of updated attributes + def update_attrs(**opts) + opts.each do |key, value| + send "#{key}=", value + end + end + + # Execute systems that have been added to execute on variable change + # @return [Boolean] +true+ + def attr_changed_trigger_systems(attr) + systems_to_execute = self.class.attr_triggers[attr] + systems_to_execute = [] if systems_to_execute.nil? + + systems_to_execute |= attr_triggers[attr] unless attr_triggers[attr].nil? + + systems_to_execute.sort_by(&:priority).reverse.each(&:call) + true + end + + # Removes this component from the list and purges all references to this Component from other Entities, as well as its {id ID} and data. + # @return [Boolean] +true+. + def delete + addition_triggers.each do |system| + system.clear_triggers component_or_manager: self + end + # This needs to be cloned because indices get deleted as + # the remove command is called, breaking the loop if it + # wasn't referencing a clone(will get Nil errors) + iter = entities.map(&:clone) + iter.each do |entity_id| + FelFlame::Entities[entity_id].remove self #unless FelFlame::Entities[entity_id].nil? + end + self.class.data[id] = nil + instance_variables.each do |var| + instance_variable_set(var, nil) + end + true + end + + # @return [Hash] A hash, where all the keys are attributes linked to their respective values. + def attrs + return_hash = instance_variables.each_with_object({}) do |key, final| + final[key.to_s.delete_prefix('@').to_sym] = instance_variable_get(key) + end + return_hash.delete(:attr_triggers) + return_hash + end + + # Export all data into a JSON String, which could then later be loaded or saved to a file + # TODO: This function is not yet complete + # @return [String] a JSON formatted String + #def to_json + # # should return a json or hash of all data in this component + #end + end +end diff --git a/lib/felflame/entity_manager.rb b/lib/felflame/entity_manager.rb new file mode 100644 index 0000000..74fc4c3 --- /dev/null +++ b/lib/felflame/entity_manager.rb @@ -0,0 +1,135 @@ +class FelFlame + class Entities + # Holds the unique ID of this entity + # @return [Integer] + attr_reader :id + + # A seperate attr_writer was made for documentation readability reasons. + # Yard will list attr_reader is readonly which is my intention. + # This value needs to be changable as it is set by other functions. + # @!visibility private + attr_writer :id + + # Creating a new Entity + # @param components [Components] Can be any number of components, identical duplicates will be automatically purged however different components from the same component manager are allowed. + # @return [Entity] + def initialize(*components) + # Assign new unique ID + new_id = self.class.data.find_index(&:nil?) + new_id = self.class.data.size if new_id.nil? + self.id = new_id + + # Add each component + add(*components) + + self.class.data[id] = self + end + + # A hash that uses component manager constant names as keys, and where the values of those keys are arrays that contain the {FelFlame::ComponentManager#id IDs} of the components attached to this entity. + # @return [Hash>] + def components + @components ||= {} + end + + # An alias for the {#id ID reader} + # @return [Integer] + def to_i + id + end + + # Removes this Entity from the list and purges all references to this Entity from other Components, as well as its {id ID} and data. + # @return [Boolean] +true+ + def delete + components.each do |component_manager, component_array| + component_array.each do |component_id| + component_manager[component_id].entities.delete(id) + #self.remove FelFlame::Components.const_get(component_manager.name)[component_id] + end + end + FelFlame::Entities.data[id] = nil + @components = {} + @id = nil + true + end + + # Add any number components to the Entity. + # @param components_to_add [Component] Any number of components created from any component manager + # @return [Boolean] +true+ + def add(*components_to_add) + components_to_add.each do |component| + if components[component.class].nil? + components[component.class] = [component.id] + component.entities.push id + check_systems component, :addition_triggers + elsif !components[component.class].include? component.id + components[component.class].push component.id + component.entities.push id + check_systems component, :addition_triggers + end + end + true + end + + # triggers every system associated with this component's trigger + # @return [Boolean] +true+ + # @!visibility private + def check_systems(component, trigger_type) + component_calls = component.class.send(trigger_type) + component.send(trigger_type).each do |system| + component_calls |= [system] + end + component_calls.sort_by(&:priority).reverse.each(&:call) + true + end + + # Remove a component from the Entity + # @param components_to_remove [Component] A component created from any component manager + # @return [Boolean] +true+ + def remove(*components_to_remove) + components_to_remove.each do |component| + check_systems component, :removal_triggers if component.entities.include? id + component.entities.delete id + components[component.class].delete component.id + end + true + end + + # Export all data into a JSON String which can then be saved into a file + # TODO: This function is not yet complete + # @return [String] A JSON formatted String + #def to_json() end + + class <] Array of all Entities that exist + # @!visibility private + def data + @data ||= [] + end + + # Gets an Entity from the given {id unique ID}. Usage is simular to how an Array lookup works + # + # @example + # # This gets the Entity with ID 7 + # FelFlame::Entities[7] + # @param entity_id [Integer] + # @return [Entity] returns the Entity that uses the given unique ID, nil if there is no Entity associated with the given ID + def [](entity_id) + data[entity_id] + end + + # Iterates over all entities. The data is compacted so that means index does not correlate to ID. + # You also call other enumerable methods instead of each, such as +each_with_index+ or +select+ + # @return [Enumerator] + def each(&block) + data.compact.each(&block) + end + + # Creates a new entity using the data from a JSON string + # TODO: This function is not yet complete + # @param json_string [String] A string that was exported originally using the {FelFlame::Entities#to_json to_json} function + # @param opts [Keywords] What values(its {FelFlame::Entities#id ID} or the {FelFlame::ComponentManager#id component IDs}) should be overwritten TODO: this might change + #def from_json(json_string, **opts) end + end + end +end diff --git a/lib/felflame/scene_manager.rb b/lib/felflame/scene_manager.rb new file mode 100644 index 0000000..315dd55 --- /dev/null +++ b/lib/felflame/scene_manager.rb @@ -0,0 +1,58 @@ +class FelFlame + class Scenes + # The Constant name assigned to this Scene + attr_reader :const_name + + # Allows overwriting the storage of systems, such as for clearing. + # This method should generally only need to be used internally and + # not by a game developer/ + # @!visibility private + attr_writer :systems + + # Create a new Scene using the name given + # @param name [String] String format must follow requirements of a constant + def initialize(name) + FelFlame::Scenes.const_set(name, self) + @const_name = name + end + + # The list of Systems this Scene contains + # @return [Array] + def systems + @systems ||= [] + end + + # Execute all systems in this Scene, in the order of their priority + # @return [Boolean] +true+ + def call + systems.each(&:call) + true + end + + # Adds any number of Systems to this Scene + # @return [Boolean] +true+ + def add(*systems_to_add) + self.systems |= systems_to_add + systems.sort_by!(&:priority) + FelFlame::Stage.update_systems_list if FelFlame::Stage.scenes.include? self + true + end + + # Removes any number of SystemS from this Scene + # @return [Boolean] +true+ + def remove(*systems_to_remove) + self.systems -= systems_to_remove + systems.sort_by!(&:priority) + FelFlame::Stage.update_systems_list if FelFlame::Stage.scenes.include? self + true + end + + # Removes all Systems from this Scene + # @return [Boolean] +true+ + def clear + systems.clear + FelFlame::Stage.update_systems_list if FelFlame::Stage.scenes.include? self + true + end + end +end diff --git a/lib/felflame/stage_manager.rb b/lib/felflame/stage_manager.rb new file mode 100644 index 0000000..87ee955 --- /dev/null +++ b/lib/felflame/stage_manager.rb @@ -0,0 +1,70 @@ +class FelFlame + class Stage + class <] + def scenes + @scenes ||= [] + end + + # Stores systems in the order the stage manager needs to call them + # This method should generally only need to be used internally and not by a game developer + # @!visibility private + def systems + @systems ||= [] + end + end + end +end diff --git a/lib/felflame/system_manager.rb b/lib/felflame/system_manager.rb new file mode 100644 index 0000000..cab2c4d --- /dev/null +++ b/lib/felflame/system_manager.rb @@ -0,0 +1,213 @@ +class 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 + # not by a game developer. + # @!visibility private + attr_writer :addition_triggers, :removal_triggers, :attr_triggers + + def priority=(priority) + @priority = priority + FelFlame::Stage.systems.sort_by!(&:priority) + 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. + # Do not edit this hash as it is managed by FelFlame automatically. + # @return [Array] + def addition_triggers + @addition_triggers ||= [] + end + + # Stores references to components or their managers that trigger + # this component when a component or component from that manager + # is removed from an entity. + # Do not edit this hash as it is managed by FelFlame automatically. + # @return [Array] + def removal_triggers + @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. + # @return [Hash>] + def attr_triggers + @attr_triggers ||= {} + end + + class <] - def systems - @systems ||= [] - end - - # Execute all systems in this Scene, in the order of their priority - # @return [Boolean] +true+ - def call - systems.each(&:call) - true - end - - # Adds any number of Systems to this Scene - # @return [Boolean] +true+ - def add(*systems_to_add) - self.systems |= systems_to_add - systems.sort_by!(&:priority) - FelFlame::Stage.update_systems_list if FelFlame::Stage.scenes.include? self - true - end - - # Removes any number of SystemS from this Scene - # @return [Boolean] +true+ - def remove(*systems_to_remove) - self.systems -= systems_to_remove - systems.sort_by!(&:priority) - FelFlame::Stage.update_systems_list if FelFlame::Stage.scenes.include? self - true - end - - # Removes all Systems from this Scene - # @return [Boolean] +true+ - def clear - systems.clear - FelFlame::Stage.update_systems_list if FelFlame::Stage.scenes.include? self - true - end - end -end diff --git a/spec/component_manager_spec.rb b/spec/component_manager_spec.rb index 9c53cd2..1c732ac 100644 --- a/spec/component_manager_spec.rb +++ b/spec/component_manager_spec.rb @@ -1,4 +1,4 @@ -require_relative '../felflame.rb' +require 'felflame' describe 'Components' do diff --git a/spec/entity_manager_spec.rb b/spec/entity_manager_spec.rb index 2db4787..78300c2 100644 --- a/spec/entity_manager_spec.rb +++ b/spec/entity_manager_spec.rb @@ -1,4 +1,4 @@ -require_relative '../felflame.rb' +require 'felflame' #class EntitiesTest < Minitest::Test diff --git a/spec/scene_manager_spec.rb b/spec/scene_manager_spec.rb index b2afab0..f2aee01 100644 --- a/spec/scene_manager_spec.rb +++ b/spec/scene_manager_spec.rb @@ -1,4 +1,4 @@ -require_relative '../felflame.rb' +require 'felflame' #class EntitiesTest < Minitest::Test diff --git a/spec/stage_manager_spec.rb b/spec/stage_manager_spec.rb index 793758c..ed1125c 100644 --- a/spec/stage_manager_spec.rb +++ b/spec/stage_manager_spec.rb @@ -1,4 +1,4 @@ -require_relative '../felflame.rb' +require 'felflame' #class EntitiesTest < Minitest::Test diff --git a/spec/system_manager_spec.rb b/spec/system_manager_spec.rb index 783b1a7..aab4d8f 100644 --- a/spec/system_manager_spec.rb +++ b/spec/system_manager_spec.rb @@ -1,4 +1,4 @@ -require_relative '../felflame.rb' +require 'felflame' describe 'Components' do diff --git a/stage_manager.rb b/stage_manager.rb deleted file mode 100644 index 87ee955..0000000 --- a/stage_manager.rb +++ /dev/null @@ -1,70 +0,0 @@ -class FelFlame - class Stage - class <] - def scenes - @scenes ||= [] - end - - # Stores systems in the order the stage manager needs to call them - # This method should generally only need to be used internally and not by a game developer - # @!visibility private - def systems - @systems ||= [] - end - end - end -end diff --git a/system_manager.rb b/system_manager.rb deleted file mode 100644 index cab2c4d..0000000 --- a/system_manager.rb +++ /dev/null @@ -1,213 +0,0 @@ -class 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 - # not by a game developer. - # @!visibility private - attr_writer :addition_triggers, :removal_triggers, :attr_triggers - - def priority=(priority) - @priority = priority - FelFlame::Stage.systems.sort_by!(&:priority) - 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. - # Do not edit this hash as it is managed by FelFlame automatically. - # @return [Array] - def addition_triggers - @addition_triggers ||= [] - end - - # Stores references to components or their managers that trigger - # this component when a component or component from that manager - # is removed from an entity. - # Do not edit this hash as it is managed by FelFlame automatically. - # @return [Array] - def removal_triggers - @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. - # @return [Hash>] - def attr_triggers - @attr_triggers ||= {} - end - - class <