draco-state 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a072d49796e17bd4a4e19b7a78457d47befdf450b91605a2cabfdca6b8072d30
+  data.tar.gz: b64b05ac5b8bac24220222ed716fd9b9f7e00181c2f3565d424c21e54a32d4e5
+SHA512:
+  metadata.gz: 432e4b740902cd279e75f1da93727db0cbfc3928d28f30991fdf0291efd22023b74ca1d3231cad91d840d83d18fb81f79d95f919995cba926197e0763069ad82
+  data.tar.gz: b449ef779494d8f4e92a6762b358726f61e89e419551dc20213fbbd17985b80983c3210e237b764c397f5941116abfb84b1d4c204c57842d0a19164aae3772de

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matt@guitsaru.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in draco-state.gemspec
+# gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "draco", git: "https://github.com/guitsaru/draco", branch: "main"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GIT
+  remote: https://github.com/guitsaru/draco
+  revision: b3ae4faa72439c9c9932d407f53f70c490bf9806
+  branch: main
+  specs:
+    draco (0.5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  draco!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Matt Pruitt
+
+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.

data/README.md

@@ -0,0 +1,68 @@
+# Draco::State
+
+This library provides a DSL to define state based entities in [Draco](https://github.com/guitsaru/draco).
+
+## Usage
+
+### Entities
+
+This plugin allows you to specify a set of components where only one component can be active at a time. This allows
+you to build state machine based systems or just to keep your entities from getting in unnatural states.
+
+```ruby
+class Guard < Draco::Entity
+  include Draco::State
+
+  state [Walking, Running, Jumping, Standing], default: Standing.new
+end
+```
+
+If you don't define a default component, it will create an instance of the first component in the list. When you want to switch states, just add the new component:
+
+```ruby
+guard = Guard.new
+guard.components << Walking.new
+
+guard.state_changed.from
+# => {class: "Standing"}
+
+guard.state_changed.to
+# => {class: "Walking"}
+
+guard.state_changed.at
+# => 2021-01-05 00:44:24.522127229 +0700
+```
+
+### Systems
+
+Since the `Draco::StateChanged` component was added, we can write a system to deal with newly changed entities:
+
+```ruby
+class StateSystem < Draco::System
+  filter Draco::StateChanged
+
+  def tick(args)
+    entity.components.add(Active)
+    entity.components.delete(entity.state_changed)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, 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]/draco-state. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/draco-state/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Draco::StateMachine project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/draco-state/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Smaug.toml

@@ -0,0 +1,19 @@
+[package]
+name = "draco-state"
+authors = ["Matt Pruitt <matt@guitsaru.com>"]
+version = "0.2.0"
+homepage = "https://github.com/guitsaru/draco-state"
+repository = "https://github.com/guitsaru/draco-state" 
+keywords = ["draco", "ECS"]
+
+# Optional:
+# documentation = "https://example.com"
+
+# Which files do you want to be automatically required from your package.
+requires = ["lib/draco/state.rb"]
+
+[package.installs]
+
+[dragonruby]
+version = "2.7"
+edition = "standard"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "draco/state"
+
+# 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__)

data/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

data/draco-state.gemspec

@@ -0,0 +1,28 @@
+require "draco"
+require_relative 'lib/draco/state'
+
+Gem::Specification.new do |spec|
+  spec.name          = "draco-state"
+  spec.version       = Draco::State::VERSION
+  spec.authors       = ["Matt Pruitt"]
+  spec.email         = ["matt@guitsaru.com"]
+
+  spec.summary       = %q{A Draco add-on to enable writing state machines}
+  spec.homepage      = "https://github.com/guitsaru/draco-state"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "draco", "~> 0.6"
+end

data/lib/draco/state.rb

@@ -0,0 +1,100 @@
+module Draco
+  module State
+    VERSION = "0.2.0"
+
+    class InvalidDefaultError < StandardError; end
+    class NoStatesDefinedError < StandardError; end
+    class NotAnEntityError < StandardError; end
+    class StateExistsError < StandardError; end
+    class StateNotSetError < StandardError; end
+
+    def self.included(mod)
+      raise NotAnEntityError, "Draco::State can only be included on Draco::Entity subclasses." unless mod.ancestors.include?(Draco::Entity)
+
+      mod.extend(ClassMethods)
+      mod.prepend(EntityPlugin)
+    end
+
+    module ClassMethods
+      def state(values, options = {})
+        raise Draco::State::StateExistsError, "This entity already has a state defined" if @default_state
+        raise Draco::State::NoStatesDefinedError, "This entity has no possible states defined." if values.nil? || values.empty?
+
+        @default_state = options.delete(:default) || values.first.new
+        @state_options = values
+        unless values.include?(@default_state.class)
+          message = ["The default state is not a member of the possible states."]
+          messate += "Make sure you initialize the class." if @default_state.is_a?(Class)
+
+          raise Draco::State::InvalidDefaultError, message.join(" ")
+        end
+      end
+    end
+
+    module EntityPlugin
+      def after_initialize
+        super
+        components.add(self.class.instance_variable_get(:@default_state))
+      end
+
+      def before_component_added(component)
+        component = super || component
+        options = self.class.instance_variable_get(:@state_options)
+        return component unless options.include?(component.class)
+
+        from = previous_state
+        if !has_state_change?(component) && from
+          state_change = Draco::StateChanged.new(from: from, to: component, at: Time.now)
+
+          components.add(state_change)
+        end
+
+        component
+      end
+
+      def after_component_added(component)
+        component = super || component
+        options = self.class.instance_variable_get(:@state_options)
+
+        return component unless options.include?(component.class)
+        state_change = state_change_component
+        components.delete(state_change.from) if state_change
+      end
+
+      def before_component_removed(component)
+        component = super || component
+        options = self.class.instance_variable_get(:@state_options)
+
+        return component unless options.include?(component.class)
+        state_change = state_change_component
+        raise Draco::State::StateNotSetError, "removing #{component.inspect} would leave this entity in an invalid state" unless state_change && state_change.from == component
+      end
+
+      private
+      def state_change_component
+        state_change_name = Draco.underscore(Draco::StateChanged.name.to_s).to_sym
+        components[state_change_name]
+      end
+
+      def has_state_change?(component)
+        return false unless state_change_component
+        return state_change_component.to == component
+      end
+
+      def previous_state
+        name =
+          self.class.instance_variable_get(:@state_options)
+          .map { |state| Draco.underscore(state.name.to_s).to_sym }
+          .find { |name| components[name] }
+
+        components[name] if name
+      end
+    end
+  end
+
+  class StateChanged < Draco::Component
+    attribute :from
+    attribute :to
+    attribute :at
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: draco-state
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Matt Pruitt
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: draco
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description:
+email:
+- matt@guitsaru.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- Smaug.toml
+- bin/console
+- bin/setup
+- draco-state.gemspec
+- lib/draco/state.rb
+homepage: https://github.com/guitsaru/draco-state
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/guitsaru/draco-state
+  source_code_uri: https://github.com/guitsaru/draco-state
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A Draco add-on to enable writing state machines
+test_files: []