draco 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1057daf5d6bb88b4877d001fe21d123557cb720df446d9ff2c0111a58baceb0f
-  data.tar.gz: a96296838c903442df84482a8eb57346fc8225a34a6842f352d8d3ec1cc955cb
+  metadata.gz: 363ccf9c3649a752219bca392bdc13b88defbd864a63afb5615969986e59c070
+  data.tar.gz: 81dcbc8225646cec6efc357ecaacfd89334e9a183caad035cf4bd2ece9a01470
 SHA512:
-  metadata.gz: 502d00bc7c2d3e099548c8c2211182ae95bbb0d35de8dba9e20f232046803740bfa3331a8bf94a414b4c5ecaad7c86a570fdcb53fec8325e07191eec4342a3ec
-  data.tar.gz: f19a25eca8d942dea85a8835f8e239d3a81613a9667c788dba4eadb021876b90938e533bb049bf50155f316a16fe43065dd730b9578a927ea3691a2775b8538f
+  metadata.gz: aa089a7a6abe9b615d07e8def023fad13fedcbca605e78bc1acf181431b1659961811074a9238f79702b7e1e9ddd76782a173fd079ed5f7ae04a2ee83905c660
+  data.tar.gz: e6a70346719b8cf5e5269924158bcbad7ed4ea66440686c57931b7dc6232d467adf6abeac5740970e6d16a573d61a66af27c5626599ed115a7a87624d9ac9bdf

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.5.0 (December 31, 2020)
+
+Features:
+
+  - Add `Draco::Tag` to easily define tag components [#6](https://github.com/guitsaru/draco/pull/6)

data/README.md

@@ -47,7 +47,7 @@ These can be shared across many different types of game objects.
 class Visible < Draco::Component; end
 ```
 
-`Visible` is an example of a label component. An entity either has it, or it doesn't. We can also associate data with our
+`Visible` is an example of a tag component. An entity either has it, or it doesn't. We can also associate data with our
 components.
 
 ```ruby
@@ -68,6 +68,16 @@ component.x
 # => 110
 ```
 
+#### Tag Components
+
+The `Visible` class above is an example of a tag component. These are common enough that we don't necessarily want to
+define a bunch of empty component classes. Draco provides a way to generate these classes at runtime.
+
+```ruby
+Draco::Tag(:visible)
+# => Visible
+```
+
 ### Entities
 
 Entities are independant game objects. They consist of a unique id and a list of components.

data/lib/draco.rb

@@ -5,7 +5,7 @@
 # An Entity Component System is an architectural pattern used in game development to decouple behavior from objects.
 module Draco
   # Public: The version of the library. Draco uses semver to version releases.
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 
   # Public: A general purpose game object that consists of a unique id and a collection of Components.
   class Entity
@@ -300,6 +300,23 @@ module Draco
     end
   end
 
+  # Internal: Empty module to enable Tag() method.
+  module Tag; end
+
+  # Public: Creates a new empty component at runtime. If the given Class already exists, it reuses the existing Class.
+  #
+  # name - The symbol or string name of the component. It can be either camelcase or underscored.
+  #
+  # Returns a Class with superclass of Draco::Component.
+  def self.Tag(name) # rubocop:disable Naming/MethodName
+    klass_name = camelize(name)
+
+    return Object.const_get(klass_name) if Object.const_defined?(klass_name)
+
+    klass = Class.new(Component)
+    Object.const_set(klass_name, klass)
+  end
+
   # Public: Systems contain the logic of the game.
   # The System runs on each tick and manipulates the Entities in the World.
   class System
@@ -518,16 +535,23 @@ module Draco
       def [](*components_or_ids)
         components_or_ids
           .flatten
-          .map do |component_or_id|
-            if component_or_id.is_a?(Numeric)
-              Array(@entity_ids[component_or_id])
-            else
-              @component_to_entities[component_or_id]
-            end
-          end
+          .map { |component_or_id| select_entities(component_or_id) }
           .reduce { |acc, i| i & acc }
       end
 
+      # Internal: Gets entities by component or id.
+      #
+      # component_or_id - The Component Class or entity id to select.
+      #
+      # Returns an Array of Entities.
+      def select_entities(component_or_id)
+        if component_or_id.is_a?(Numeric)
+          Array(@entity_ids[component_or_id])
+        else
+          @component_to_entities[component_or_id]
+        end
+      end
+
       # Internal: Adds Entities to the EntityStore
       #
       # entities - The Entity or Array list of Entities to add to the EntityStore.
@@ -717,13 +741,36 @@ module Draco
   #
   # Returns a String.
   def self.underscore(string)
-    string.split("::").last.bytes.map.with_index do |byte, i|
+    string.to_s.split("::").last.bytes.map.with_index do |byte, i|
       if byte > 64 && byte < 97
-        downcased = byte + 32 # gemspec
+        downcased = byte + 32
         i.zero? ? downcased.chr : "_#{downcased.chr}"
       else
         byte.chr
       end
     end.join
   end
+
+  # Internal: Converts an underscored string into a camel case string.
+  #
+  # Examples
+  #
+  #   camlize("camel_case")
+  #   # => "CamelCase"
+  #
+  # Returns a string.
+  def self.camelize(string) # rubocop:disable Metrics/MethodLength
+    modifier = -32
+
+    string.to_s.bytes.map do |byte|
+      if byte == 95
+        modifier = -32
+        nil
+      else
+        char = (byte + modifier).chr
+        modifier = 0
+        char
+      end
+    end.compact.join
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: draco
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Pruitt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies: []
 description: A library for Entities, Components, and Systems in games.
 email:
@@ -22,6 +22,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - COMM-LICENSE
 - Gemfile