state_boss 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 193bc7af16fd92e12f96a6497720a30177ecb704b847768ab1260c862d2fe176
+  data.tar.gz: fc9f786b6aeb7c17d4491e9fa785b50ddf55a5866776c81f364f615893fe3db2
+SHA512:
+  metadata.gz: df722492b1dfbed2600a0b18c92ac0e950177c4c3de9f2b5192c6c1780c319e1cbb09cae0305c289f3c4c9cd7b5041f13dcd0d9db43db791c64e9ac3e97b7eea
+  data.tar.gz: 1da9712327670dac4fa265be2516a8f90ff276e8bcac7478d579fd245069bc373af84f8757673454e5e39616e8149ae921d7e2a1b6b0e8fbecd7bb705d7a4d7e

data/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: test
+
+on:
+  pull_request:
+
+  push:
+
+jobs:
+  ubuntu:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby:
+          - 2.4.10
+          - 2.5.8
+          - 2.6.6
+          - 2.7.2
+          - head
+    steps:
+      - uses: actions/checkout@v1
+      - name: setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: bundle install
+        run: bundle install --jobs=4 --path=vendor/bundle
+      - name: run test
+        run: bundle exec rake
+        continue-on-error: ${{ matrix.ruby == 'head' }}
+    timeout-minutes: 60

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

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 p.wadachi@gmail.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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in state_boss.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ta1kt0me
+
+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,72 @@
+# StateBoss
+
+state_boss is state machine for PORO.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'state_boss'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install state_boss
+
+## Usage
+
+```ruby
+class Monster
+  include StateBoss
+
+  state_machine do
+    state :eevee, to: [:jolteon, :vaporeon, :flareon], as: :default
+    state :jolteon, as: :finish
+    state :vaporeon, as: :finish
+    state :flareon, as: :finish
+
+    event(:water_stone, to: :vaporeon) do
+      puts "use water stone"
+    end
+
+    event(:thunder_stone, to: :jolteon) do
+      puts "use thunder stone"
+    end
+
+    event(:fire_stone, to: :flareon) do
+      puts "use fire stone"
+    end
+  end
+end
+
+monster = Monster.new # => #<Monster:0x00007fd129052380>
+monster.current_state # => eevee
+monster.eevee?        # => true
+monster.jolteon?      # => false
+monster.thunder_stone # => use thunder stone
+monster.jolteon?      # => true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/ta1kt0me/state_boss. 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/ta1kt0me/state_boss/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 StateBoss project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ta1kt0me/state_boss/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "state_boss"
+
+# 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/lib/state_boss.rb

@@ -0,0 +1,119 @@
+require "state_boss/version"
+require "state_boss/event_history"
+
+module StateBoss
+  include EventHistory
+
+  class InvalidTransitionError < StandardError; end
+  class StateInitializationError < StandardError; end
+
+  def self.included(klass)
+    klass.extend ClassMethods
+    klass.prepend Initializer
+
+    klass.class_eval do
+      @default_state = nil
+      @events = {}
+      @transitions = {}
+    end
+  end
+
+  def current_state
+    _state
+  end
+
+  def next_states
+    transitions = self.class.instance_variable_get(:@transitions)
+    transitions[_state][:to]
+  end
+
+  def finished_state?
+    next_states.nil?
+  end
+
+  private
+
+  attr_reader :_state
+
+  def ready?
+    !_state.nil?
+  end
+
+  module Initializer
+    def initialize(*args, &block)
+      super
+
+      @_state = self.class.instance_variable_get(:@default_state)
+    end
+  end
+
+  module ClassMethods
+    def state_machine(&block)
+      class_eval do
+        block.call
+      end
+
+      raise StateInitializationError, 'state is uninitialized.' if @default_state.nil?
+
+      @transitions.keys.each do |key|
+        define_method("#{key}?") do
+          _state == key
+        end
+      end
+
+      @events.keys.each do |key|
+        define_method(key) do
+          raise InvalidTransitionError, 'state transition finished.' if finished_state?
+
+          events = self.class.instance_variable_get(:@events)
+          to = events[key][:to]
+
+          transitions = self.class.instance_variable_get(:@transitions)
+
+          unless transitions[_state][:to].include?(to)
+            raise InvalidTransitionError, "can't change state from #{current_state} to #{to}"
+          end
+
+          before_state = _state
+          @_state = to
+
+          begin
+            callback = events[key][:callback]
+            result = callback.call(self) if !callback.nil?
+
+            record_event(before_state, key)
+
+            result
+          rescue => e
+            @_state = before_state
+
+            raise e
+          end
+        end
+      end
+    end
+
+    def state(key, values)
+      if values.key?(:as)
+        if values[:as] == :default
+          if @default_state
+            raise InvalidTransitionError, "Already set :#{@default_state} as default state."
+          end
+
+          @default_state = key
+        end
+
+        values.merge!(to: nil) if values[:as] == :finish
+      end
+
+      @transitions[key] = values
+    end
+
+    def event(name, to:, &block)
+      @events[name] = {
+        to: to || [],
+        callback: block,
+      }
+    end
+  end
+end

data/lib/state_boss/event_history.rb

@@ -0,0 +1,24 @@
+module StateBoss
+  module EventHistory
+    def event_history
+      _event_history
+    end
+
+    def record_event(before_state, event)
+      @_event_history = (_event_history || []) << {
+        before_state: before_state,
+        event: event,
+      }
+    end
+
+    private
+
+    def _event_history
+      if defined?(@_event_history)
+        @_event_history
+      else
+        @_event_history = []
+      end
+    end
+  end
+end

data/lib/state_boss/version.rb

@@ -0,0 +1,3 @@
+module StateBoss
+  VERSION = "0.1.0"
+end

data/state_boss.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/state_boss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "state_boss"
+  spec.version       = StateBoss::VERSION
+  spec.authors       = ["ta1kt0me"]
+  spec.email         = ["p.wadachi@gmail.com"]
+
+  spec.summary       = %q{state_boss is state machine for PORO}
+  spec.description   = %q{state_boss is state machine for PORO}
+  spec.homepage      = "https://github.com/ta1kt0me/state_boss"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.10")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_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)/}) }
+  end
+
+  spec.test_files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(test)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("byebug", "~> 11.1")
+  spec.add_development_dependency("rake", "~> 12.0")
+  spec.add_development_dependency("minitest", "~> 5.0")
+end

data/test/state_boss_test.rb

@@ -0,0 +1,190 @@
+require "test_helper"
+require "state_boss"
+
+class StateBossTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::StateBoss::VERSION
+  end
+
+  def test_current_state
+    monster = charmander_class.new
+    assert_equal monster.current_state, :charmander
+
+    monster.evolve_first
+    assert_equal monster.current_state, :charmeleon
+
+    monster.evolve_second
+    assert_equal monster.current_state, :charizard
+  end
+
+  def test_next_states
+    monster = eevee_class.new
+    assert_equal monster.next_states, [:jolteon, :vaporeon, :flareon]
+  end
+
+  def test_finished_state?
+    monster = eevee_class.new
+    assert_nil monster.water_stone
+    assert_equal monster.finished_state?, true
+  end
+
+  def test_events
+    monster = chansey_class.new(100)
+
+    assert_equal monster.alive?, true
+    assert_equal monster.fainting?, false
+    assert_equal monster.pokemon_shock, 0
+    assert_equal monster.alive?, false
+    assert_equal monster.fainting?, true
+    assert_equal monster.pokemon_center, 100
+  end
+
+  def test_event_history
+    monster = chansey_class.new(100)
+    monster.pokemon_shock
+    monster.pokemon_center
+
+    expected = [
+      { before_state: :alive, event: :pokemon_shock },
+      { before_state: :fainting, event: :pokemon_center }
+    ]
+
+    assert monster.event_history, expected
+  end
+
+  def test_state_initialization_error
+    assert_raises(StateBoss::StateInitializationError) do
+      Class.new {
+        include StateBoss
+
+        state_machine do
+          state :walking, to: :flying
+          state :flying, as: :finish
+        end
+      }
+    end
+  end
+
+  def test_mismatch_to_state
+    ketsuban = Class.new {
+      include StateBoss
+
+      state_machine do
+        state :walking, to: [:flying], as: :default
+        state :flying, to: [:surfing]
+        state :surf, to: [:walking]
+
+        event :fly, to: :surfing
+      end
+    }.new
+
+    assert_raises(StateBoss::InvalidTransitionError) do
+      ketsuban.fly
+    end
+  end
+
+  def test_default_state_twice
+    assert_raises(StateBoss::InvalidTransitionError) do
+      Class.new {
+        include StateBoss
+
+        state_machine do
+          state :walking, as: :default
+          state :flying, as: :default
+        end
+      }
+    end
+  end
+
+  def test_change_finieshed_state
+    ketsuban = Class.new {
+      include StateBoss
+
+      state_machine do
+        state :walking, to: [:flying], as: :default
+        state :flying, as: :finish
+
+        event(:fly, to: :flying)
+      end
+    }.new
+
+    ketsuban.fly
+
+    assert_raises(StateBoss::InvalidTransitionError) do
+      ketsuban.fly
+    end
+  end
+
+  def test_rollback_state_in_error
+    ketsuban = Class.new {
+      include StateBoss
+
+      state_machine do
+        state :walking, to: [:flying], as: :default
+        state :flying, as: :finish
+
+        event(:fly, to: :flying) { raise RuntimeError }
+      end
+    }.new
+
+    assert_raises(RuntimeError) do
+      ketsuban.fly
+    end
+
+    assert_equal ketsuban.walking?, true
+  end
+
+  private
+
+  def charmander_class
+    Class.new do
+      include StateBoss
+
+      state_machine do
+        state :charmander, to: [:charmeleon], as: :default
+        state :charmeleon, to: [:charizard]
+        state :charizard, as: :finish
+
+        event :evolve_first, to: :charmeleon
+        event :evolve_second, to: :charizard
+      end
+    end
+  end
+
+  def eevee_class
+    Class.new do
+      include StateBoss
+
+      state_machine do
+        state :eevee, to: [:jolteon, :vaporeon, :flareon], as: :default
+        state :jolteon, as: :finish
+        state :vaporeon, as: :finish
+        state :flareon, as: :finish
+
+        event :water_stone, to: :vaporeon
+        event :thunder_stone, to: :jolteon
+        event :fire_stone, to: :flareon
+      end
+    end
+  end
+
+  def chansey_class
+    Class.new do
+      include StateBoss
+
+      attr_writer :life
+
+      def initialize(life)
+        @life = life
+      end
+
+      state_machine do
+        state :alive, to: [:fainting], as: :default
+        state :fainting, to: [:alive]
+
+        event(:pokemon_shock, to: :fainting) { |object| object.life = 0 }
+        event(:pokemon_center, to: :alive) { |object| object.life = 100 }
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "state_boss"
+
+require "minitest/autorun"

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: state_boss
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ta1kt0me
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: state_boss is state machine for PORO
+email:
+- p.wadachi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/state_boss.rb
+- lib/state_boss/event_history.rb
+- lib/state_boss/version.rb
+- state_boss.gemspec
+- test/state_boss_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ta1kt0me/state_boss
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ta1kt0me/state_boss
+  source_code_uri: https://github.com/ta1kt0me/state_boss
+  changelog_uri: https://github.com/ta1kt0me/state_boss
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.10
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: state_boss is state machine for PORO
+test_files:
+- test/state_boss_test.rb
+- test/test_helper.rb