state_transition 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e196c6420a2f21db25e9e847ebf8dc7d6cf4564
+  data.tar.gz: c3c3b778f89fbec0cdbcd616a48d0833cf973355
+SHA512:
+  metadata.gz: b9ba0df6dd2d1d0d6d1749e10233eee2239d78e734cea7b140358683bdebe84d4a1c1a99d59521ce375787a56364f9380c4b382c6b0f4977c3a7b97f209a5859
+  data.tar.gz: bc90f482fbf910cbdffb5f89d4e782ff154aa4c142396a5129e54e8b2f8560e7c552f6b300d5cb4c4a679518e87560cc04d16fe4c40f66d9e97a605e9735ecbf

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+**/*.swp
+*.swp
+**/*~
+*.*~
+*~

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in state_transition.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 siman-man
+
+MIT License
+
+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,54 @@
+# StateTransition
+
+https://github.com/jakesgordon/javascript-state-machine
+これが便利だったのでRuby verを作ってみた。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'state_transition'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install state_transition
+
+## Usage
+
+    require 'state_transition'
+
+    state = StateTransition::StateMachine.new({
+      initial: :first,
+
+      actions: [
+        { name: "move_first", from: [ :second, :third ], to: :first },
+        { name: "move_second", from: [ :first, :third ], to: :second },
+        { name: "move_third", from: :second, to: :third },
+      ],
+
+      callbacks: {
+        before_second: -> { puts "before_second" },
+        after_second: -> { puts "after_second" },
+      }
+    })
+
+    puts state.current            #=> :first
+    puts state.can_move?(:second) #=> true
+    puts state.can_move?(:third)  #=> false
+
+    state.move_second
+
+    puts state.current            #=> :second
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/state_transition/version.rb

@@ -0,0 +1,3 @@
+module StateTransition
+  VERSION = "0.0.1"
+end

data/lib/state_transition.rb

@@ -0,0 +1,82 @@
+require "state_transition/version"
+
+module StateTransition
+  class StateMachine
+    attr_reader :current
+    attr_accessor :state_list
+
+    def initialize(data = nil)
+      @state_list = []
+      @state_graph = Hash.new{|hash, key| hash[key] = []}
+      @callbacks = {}
+      @sequence = 3
+
+      begin
+        @current = data[:initial] 
+      rescue 
+        raise StandardError, "StateMachine: Not define first state."
+      end
+
+      set_state(data[:initial])
+
+      create_move_action(data[:actions] || [])
+      create_callbacks(data[:callbacks] || [])
+    end
+
+    def have_state?(state)
+      @state_list.include?(state)
+    end
+
+    def create_move_action(actions)
+      actions.each do |action|
+        name = action[:name]
+        from = action[:from]
+          to = action[:to]
+
+        set_state(from)
+        set_state(to)
+        create_edge(from, to)
+
+        StateMachine.class_eval do
+          define_method name do
+            if can_move?(to)
+              before_func = ("before_" + to.to_s).to_sym
+              after_func  = ("after_" + to.to_s).to_sym
+              if @callbacks[before_func] 
+                @callbacks[before_func].call
+              end
+              @current = to
+              @callbacks[after_func].call if @callbacks[after_func]
+            else
+              raise StandardError, "Can not move from '#{@current}' to '#{to}'!"
+            end
+          end
+        end
+      end
+    end
+
+    def create_callbacks(callbacks)
+      callbacks.each do |name, function|
+        @callbacks[name] = function
+      end
+    end
+
+    def can_move?(state)
+      @state_graph[@current].include?(state)
+    end
+
+    def set_state(state)
+      @state_list.push state unless have_state?(state) || !state.kind_of?(Symbol)
+    end
+
+    def create_edge(from, to)
+      if from.kind_of?(Array) 
+        from.each do |state|
+          @state_graph[state].push to unless @state_graph[state].include?(to)
+        end
+      else
+        @state_graph[from].push to
+      end
+    end
+  end
+end

data/sample/example.rb

@@ -0,0 +1,24 @@
+require 'state_transition'
+
+state = StateTransition::StateMachine.new({
+  initial: :first,
+
+  actions: [
+    { name: "move_first", from: [ :second, :third ], to: :first },
+    { name: "move_second", from: [ :first, :third ], to: :second },
+    { name: "move_third", from: :second, to: :third },
+  ],
+
+  callbacks: {
+    before_second: -> { puts "before_second" },
+    after_second: -> { puts "after_second" },
+  }
+})
+
+puts state.current            #=> :first
+puts state.can_move?(:second) #=> true
+puts state.can_move?(:third)  #=> false
+
+state.move_second           
+
+puts state.current            #=> :second

data/sample/example2.rb

@@ -0,0 +1,44 @@
+require 'state_transition'
+
+class HelloWorld
+  attr_reader :state
+
+  def initialize
+    @hello = "Hello World!"
+
+    @state = StateTransition::StateMachine.new({
+      initial: 'first',
+
+      actions: [
+        { name: 'one',  from: 'first', to: 'second' },
+        { name: 'two',  from: 'second', to: 'third' },
+        { name: 'three', from: 'third', to: 'first' },
+        { name: 'reset', from: ['first', 'second', 'thrid'], to: 'first' }
+      ],
+
+      callbacks: {
+        before_first: -> { say_world },
+        before_second: -> { say_hello },
+        before_third: -> { say_hello_world },
+      }
+    })
+  end
+
+  def say_hello
+    puts "hello"
+  end
+
+  def say_hello_world
+    puts @hello
+  end
+
+  def say_world
+    puts "world"
+  end
+end
+
+h = HelloWorld.new
+
+h.state.one
+h.state.two
+h.state.three

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'state_transition'

data/spec/state_transition_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe StateTransition do
+
+  it 'should have a version number' do
+    StateTransition::VERSION.should_not be_nil
+  end
+
+  describe "no initialize" do
+    it "should be error occured." do
+      lambda{ state = StateTransition::StateMachine.new() }.should raise_error(StandardError)
+    end
+  end
+
+  describe "init state" do
+    before :all do
+      @sequence = []
+      @state = StateTransition::StateMachine.new({
+        initial: :first,
+
+        actions: [
+          { name: 'two', from: :first, to: :second },
+          { name: 'three', from: :second, to: :third },
+          { name: 'reset', from: [:first, :second, :third], to: :first }
+        ],
+
+        callbacks: {
+          before_first: -> { @sequence << "before_first" },
+          before_second: -> { @sequence << "before_second" },
+          before_third: -> { @sequence << "before_third" },
+          after_first: -> { @sequence << "after_first" },
+          after_second: -> { @sequence << "after_second"; puts "Hello World!" },
+          after_third: -> { @sequence << "after_third" },
+        }
+      })
+    end
+
+    it "should @state have three(:first, :second, :third) state" do
+      @state.have_state?(:first).should be_true
+      @state.have_state?(:second).should be_true
+      @state.have_state?(:third).should be_true
+    end
+
+    it "should first state is :first" do
+      @state.current.should == :first
+    end
+
+    describe "test for callbacks" do
+      before :each do 
+        @state.reset
+      end
+
+      it "check callback when move second." do
+        @sequence.clear
+        @state.two
+
+        @sequence[0].should == "before_second"
+        @sequence[1].should == "after_second"
+      end
+    end
+
+    describe "about move state" do
+      before :each do
+        @state.reset
+      end
+
+      it "should be 'two' action after state 'second'" do
+        @state.two
+        @state.current.should == :second
+      end
+
+      it "should be :first state after 'reset' action." do
+        @state.two
+        @state.reset
+        @state.current.should == :first
+      end
+
+      it "should be can move from 'first' to 'second'" do
+        @state.can_move?(:second).should be_true
+      end
+
+      it "should be cannot move from 'first' to 'third'" do
+        @state.can_move?(:third).should be_false
+      end
+
+      it "should be raised error invalid action" do
+        lambda{ @state.three }.should raise_error(StandardError)
+      end
+    end
+  end
+end

data/state_transition.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'state_transition/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "state_transition"
+  spec.version       = StateTransition::VERSION
+  spec.authors       = ["siman-man"]
+  spec.email         = ["k128585@ie.u-ryukyu.ac.jp"]
+  spec.description   = %q{This is ruby state_machine.}
+  spec.summary       = %q{This is ruby state_machine.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: state_transition
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- siman-man
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is ruby state_machine.
+email:
+- k128585@ie.u-ryukyu.ac.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/state_transition.rb
+- lib/state_transition/version.rb
+- sample/example.rb
+- sample/example2.rb
+- spec/spec_helper.rb
+- spec/state_transition_spec.rb
+- state_transition.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: This is ruby state_machine.
+test_files:
+- spec/spec_helper.rb
+- spec/state_transition_spec.rb