draco-state 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.travis.yml +6 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +36 -0
- data/LICENSE.txt +21 -0
- data/README.md +68 -0
- data/Rakefile +6 -0
- data/Smaug.toml +19 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/draco-state.gemspec +28 -0
- data/lib/draco/state.rb +100 -0
- metadata +73 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: a072d49796e17bd4a4e19b7a78457d47befdf450b91605a2cabfdca6b8072d30
|
4
|
+
data.tar.gz: b64b05ac5b8bac24220222ed716fd9b9f7e00181c2f3565d424c21e54a32d4e5
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 432e4b740902cd279e75f1da93727db0cbfc3928d28f30991fdf0291efd22023b74ca1d3231cad91d840d83d18fb81f79d95f919995cba926197e0763069ad82
|
7
|
+
data.tar.gz: b449ef779494d8f4e92a6762b358726f61e89e419551dc20213fbbd17985b80983c3210e237b764c397f5941116abfb84b1d4c204c57842d0a19164aae3772de
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at matt@guitsaru.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,36 @@
|
|
1
|
+
GIT
|
2
|
+
remote: https://github.com/guitsaru/draco
|
3
|
+
revision: b3ae4faa72439c9c9932d407f53f70c490bf9806
|
4
|
+
branch: main
|
5
|
+
specs:
|
6
|
+
draco (0.5.1)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
diff-lcs (1.4.4)
|
12
|
+
rake (12.3.3)
|
13
|
+
rspec (3.10.0)
|
14
|
+
rspec-core (~> 3.10.0)
|
15
|
+
rspec-expectations (~> 3.10.0)
|
16
|
+
rspec-mocks (~> 3.10.0)
|
17
|
+
rspec-core (3.10.1)
|
18
|
+
rspec-support (~> 3.10.0)
|
19
|
+
rspec-expectations (3.10.1)
|
20
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
21
|
+
rspec-support (~> 3.10.0)
|
22
|
+
rspec-mocks (3.10.0)
|
23
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
24
|
+
rspec-support (~> 3.10.0)
|
25
|
+
rspec-support (3.10.1)
|
26
|
+
|
27
|
+
PLATFORMS
|
28
|
+
ruby
|
29
|
+
|
30
|
+
DEPENDENCIES
|
31
|
+
draco!
|
32
|
+
rake (~> 12.0)
|
33
|
+
rspec (~> 3.0)
|
34
|
+
|
35
|
+
BUNDLED WITH
|
36
|
+
2.2.3
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2020 Matt Pruitt
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
# Draco::State
|
2
|
+
|
3
|
+
This library provides a DSL to define state based entities in [Draco](https://github.com/guitsaru/draco).
|
4
|
+
|
5
|
+
## Usage
|
6
|
+
|
7
|
+
### Entities
|
8
|
+
|
9
|
+
This plugin allows you to specify a set of components where only one component can be active at a time. This allows
|
10
|
+
you to build state machine based systems or just to keep your entities from getting in unnatural states.
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
class Guard < Draco::Entity
|
14
|
+
include Draco::State
|
15
|
+
|
16
|
+
state [Walking, Running, Jumping, Standing], default: Standing.new
|
17
|
+
end
|
18
|
+
```
|
19
|
+
|
20
|
+
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:
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
guard = Guard.new
|
24
|
+
guard.components << Walking.new
|
25
|
+
|
26
|
+
guard.state_changed.from
|
27
|
+
# => {class: "Standing"}
|
28
|
+
|
29
|
+
guard.state_changed.to
|
30
|
+
# => {class: "Walking"}
|
31
|
+
|
32
|
+
guard.state_changed.at
|
33
|
+
# => 2021-01-05 00:44:24.522127229 +0700
|
34
|
+
```
|
35
|
+
|
36
|
+
### Systems
|
37
|
+
|
38
|
+
Since the `Draco::StateChanged` component was added, we can write a system to deal with newly changed entities:
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
class StateSystem < Draco::System
|
42
|
+
filter Draco::StateChanged
|
43
|
+
|
44
|
+
def tick(args)
|
45
|
+
entity.components.add(Active)
|
46
|
+
entity.components.delete(entity.state_changed)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
## Development
|
52
|
+
|
53
|
+
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.
|
54
|
+
|
55
|
+
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).
|
56
|
+
|
57
|
+
## Contributing
|
58
|
+
|
59
|
+
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).
|
60
|
+
|
61
|
+
|
62
|
+
## License
|
63
|
+
|
64
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
65
|
+
|
66
|
+
## Code of Conduct
|
67
|
+
|
68
|
+
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
ADDED
data/Smaug.toml
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
[package]
|
2
|
+
name = "draco-state"
|
3
|
+
authors = ["Matt Pruitt <matt@guitsaru.com>"]
|
4
|
+
version = "0.2.0"
|
5
|
+
homepage = "https://github.com/guitsaru/draco-state"
|
6
|
+
repository = "https://github.com/guitsaru/draco-state"
|
7
|
+
keywords = ["draco", "ECS"]
|
8
|
+
|
9
|
+
# Optional:
|
10
|
+
# documentation = "https://example.com"
|
11
|
+
|
12
|
+
# Which files do you want to be automatically required from your package.
|
13
|
+
requires = ["lib/draco/state.rb"]
|
14
|
+
|
15
|
+
[package.installs]
|
16
|
+
|
17
|
+
[dragonruby]
|
18
|
+
version = "2.7"
|
19
|
+
edition = "standard"
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "draco/state"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/draco-state.gemspec
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
require "draco"
|
2
|
+
require_relative 'lib/draco/state'
|
3
|
+
|
4
|
+
Gem::Specification.new do |spec|
|
5
|
+
spec.name = "draco-state"
|
6
|
+
spec.version = Draco::State::VERSION
|
7
|
+
spec.authors = ["Matt Pruitt"]
|
8
|
+
spec.email = ["matt@guitsaru.com"]
|
9
|
+
|
10
|
+
spec.summary = %q{A Draco add-on to enable writing state machines}
|
11
|
+
spec.homepage = "https://github.com/guitsaru/draco-state"
|
12
|
+
spec.license = "MIT"
|
13
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
|
14
|
+
|
15
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
16
|
+
spec.metadata["source_code_uri"] = spec.homepage
|
17
|
+
|
18
|
+
# Specify which files should be added to the gem when it is released.
|
19
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
20
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
21
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
22
|
+
end
|
23
|
+
spec.bindir = "exe"
|
24
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
25
|
+
spec.require_paths = ["lib"]
|
26
|
+
|
27
|
+
spec.add_dependency "draco", "~> 0.6"
|
28
|
+
end
|
data/lib/draco/state.rb
ADDED
@@ -0,0 +1,100 @@
|
|
1
|
+
module Draco
|
2
|
+
module State
|
3
|
+
VERSION = "0.2.0"
|
4
|
+
|
5
|
+
class InvalidDefaultError < StandardError; end
|
6
|
+
class NoStatesDefinedError < StandardError; end
|
7
|
+
class NotAnEntityError < StandardError; end
|
8
|
+
class StateExistsError < StandardError; end
|
9
|
+
class StateNotSetError < StandardError; end
|
10
|
+
|
11
|
+
def self.included(mod)
|
12
|
+
raise NotAnEntityError, "Draco::State can only be included on Draco::Entity subclasses." unless mod.ancestors.include?(Draco::Entity)
|
13
|
+
|
14
|
+
mod.extend(ClassMethods)
|
15
|
+
mod.prepend(EntityPlugin)
|
16
|
+
end
|
17
|
+
|
18
|
+
module ClassMethods
|
19
|
+
def state(values, options = {})
|
20
|
+
raise Draco::State::StateExistsError, "This entity already has a state defined" if @default_state
|
21
|
+
raise Draco::State::NoStatesDefinedError, "This entity has no possible states defined." if values.nil? || values.empty?
|
22
|
+
|
23
|
+
@default_state = options.delete(:default) || values.first.new
|
24
|
+
@state_options = values
|
25
|
+
unless values.include?(@default_state.class)
|
26
|
+
message = ["The default state is not a member of the possible states."]
|
27
|
+
messate += "Make sure you initialize the class." if @default_state.is_a?(Class)
|
28
|
+
|
29
|
+
raise Draco::State::InvalidDefaultError, message.join(" ")
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
module EntityPlugin
|
35
|
+
def after_initialize
|
36
|
+
super
|
37
|
+
components.add(self.class.instance_variable_get(:@default_state))
|
38
|
+
end
|
39
|
+
|
40
|
+
def before_component_added(component)
|
41
|
+
component = super || component
|
42
|
+
options = self.class.instance_variable_get(:@state_options)
|
43
|
+
return component unless options.include?(component.class)
|
44
|
+
|
45
|
+
from = previous_state
|
46
|
+
if !has_state_change?(component) && from
|
47
|
+
state_change = Draco::StateChanged.new(from: from, to: component, at: Time.now)
|
48
|
+
|
49
|
+
components.add(state_change)
|
50
|
+
end
|
51
|
+
|
52
|
+
component
|
53
|
+
end
|
54
|
+
|
55
|
+
def after_component_added(component)
|
56
|
+
component = super || component
|
57
|
+
options = self.class.instance_variable_get(:@state_options)
|
58
|
+
|
59
|
+
return component unless options.include?(component.class)
|
60
|
+
state_change = state_change_component
|
61
|
+
components.delete(state_change.from) if state_change
|
62
|
+
end
|
63
|
+
|
64
|
+
def before_component_removed(component)
|
65
|
+
component = super || component
|
66
|
+
options = self.class.instance_variable_get(:@state_options)
|
67
|
+
|
68
|
+
return component unless options.include?(component.class)
|
69
|
+
state_change = state_change_component
|
70
|
+
raise Draco::State::StateNotSetError, "removing #{component.inspect} would leave this entity in an invalid state" unless state_change && state_change.from == component
|
71
|
+
end
|
72
|
+
|
73
|
+
private
|
74
|
+
def state_change_component
|
75
|
+
state_change_name = Draco.underscore(Draco::StateChanged.name.to_s).to_sym
|
76
|
+
components[state_change_name]
|
77
|
+
end
|
78
|
+
|
79
|
+
def has_state_change?(component)
|
80
|
+
return false unless state_change_component
|
81
|
+
return state_change_component.to == component
|
82
|
+
end
|
83
|
+
|
84
|
+
def previous_state
|
85
|
+
name =
|
86
|
+
self.class.instance_variable_get(:@state_options)
|
87
|
+
.map { |state| Draco.underscore(state.name.to_s).to_sym }
|
88
|
+
.find { |name| components[name] }
|
89
|
+
|
90
|
+
components[name] if name
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
class StateChanged < Draco::Component
|
96
|
+
attribute :from
|
97
|
+
attribute :to
|
98
|
+
attribute :at
|
99
|
+
end
|
100
|
+
end
|
metadata
ADDED
@@ -0,0 +1,73 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: draco-state
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Matt Pruitt
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-03-11 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: draco
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.6'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.6'
|
27
|
+
description:
|
28
|
+
email:
|
29
|
+
- matt@guitsaru.com
|
30
|
+
executables: []
|
31
|
+
extensions: []
|
32
|
+
extra_rdoc_files: []
|
33
|
+
files:
|
34
|
+
- ".gitignore"
|
35
|
+
- ".rspec"
|
36
|
+
- ".travis.yml"
|
37
|
+
- CODE_OF_CONDUCT.md
|
38
|
+
- Gemfile
|
39
|
+
- Gemfile.lock
|
40
|
+
- LICENSE.txt
|
41
|
+
- README.md
|
42
|
+
- Rakefile
|
43
|
+
- Smaug.toml
|
44
|
+
- bin/console
|
45
|
+
- bin/setup
|
46
|
+
- draco-state.gemspec
|
47
|
+
- lib/draco/state.rb
|
48
|
+
homepage: https://github.com/guitsaru/draco-state
|
49
|
+
licenses:
|
50
|
+
- MIT
|
51
|
+
metadata:
|
52
|
+
homepage_uri: https://github.com/guitsaru/draco-state
|
53
|
+
source_code_uri: https://github.com/guitsaru/draco-state
|
54
|
+
post_install_message:
|
55
|
+
rdoc_options: []
|
56
|
+
require_paths:
|
57
|
+
- lib
|
58
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - ">="
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: 2.3.0
|
63
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - ">="
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: '0'
|
68
|
+
requirements: []
|
69
|
+
rubygems_version: 3.2.3
|
70
|
+
signing_key:
|
71
|
+
specification_version: 4
|
72
|
+
summary: A Draco add-on to enable writing state machines
|
73
|
+
test_files: []
|