tiny_state_machine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e73ac446ec51e6ca9fda676416868b29f4250a1
+  data.tar.gz: a674b37787627af75f5cd9dac8736d5200db6599
+SHA512:
+  metadata.gz: d9ec2246715eb7890ca29417de863c94da29fd022a73a4bb0be3d1d73a40fae3c46f9ab0a46edd0aa6a5bd1fef734230f5ba06f066deac5cfb196730ce2aa8d9
+  data.tar.gz: 317ab0c573459371109fef951c6bb3b57ead149fbe474a780d2256658912719a2cb8907b1d7b98e9a08850f974421d5145ec7ec5ff69b911bcbc3e0d313c6542

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Geoffroy Montel
+
+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,69 @@
+# TinyStateMachine
+
+Yet another state machine for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tiny_state_machine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tiny_state_machine
+
+## Usage
+
+```ruby
+sm = TinyStateMachine::Machine.new :in_store do |sm|
+  sm.event :buy, :in_store => :new
+  sm.event :use, :new => :used
+  sm.event :use, :used => :used
+  sm.event :break, :used => :broken
+  sm.event :fix, :broken => :used
+  sm.on_state_change do |event, from_state, to_state|
+    puts "new state = #{to_state}"
+  end
+end
+
+sm.trigger(:buy)
+# new state = new
+# => :new
+
+sm.trigger(:buy)
+# TinyStateMachine::InvalidEvent: Invalid event 'buy' from state 'new'
+
+sm.trigger(:use)
+# new state = used
+# => :used
+
+sm.state
+# => :used
+
+sm.trigger(:use)
+# new state = used
+# => :used
+```
+
+## Tests
+
+```bash
+bundle install # to install rspec
+bundle exec rspec # to run tests
+```
+
+## 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
+
+## Author
+Copyright (c) 2014 Geoffroy Montel (@g_montel)
+MIT License

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tiny_state_machine/version.rb

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

data/lib/tiny_state_machine.rb

@@ -0,0 +1,73 @@
+require "tiny_state_machine/version"
+
+module TinyStateMachine
+  # raised when an invalid event is triggered
+  class InvalidEvent < StandardError
+  end
+
+  # A tiny state machine
+  # @example
+  #   sm = TinyStateMachine::Machine.new :in_store do |sm|
+  #     sm.event :buy, :in_store => :new
+  #     sm.event :use, :new => :used
+  #     sm.event :use, :used => :used
+  #     sm.event :break, :used => :broken
+  #     sm.event :fix, :broken => :used
+  #     sm.on_state_change do |event, from_state, to_state|
+  #       puts "new state = #{to_state}"
+  #     end
+  #   end
+
+  class Machine
+    # @return [String or Symbol] current state of the state machine.
+    attr_reader :state
+
+    # Construct a tiny state machine with an initial state.
+    #
+    # @param initial_state [String or Symbol] state the machine is in after initialization
+    # @yield [self] yields the machine for easy definition of states
+    # @yieldparam [Machine] self
+    def initialize(initial_state)
+      @state = initial_state
+      @events = Array.new
+      @callback_block = nil
+      if block_given?
+        yield self
+      end
+    end
+
+    # declare events
+    #
+    # @param event [String or Symbol] state name
+    # @param hash [Hash] a Hash in the form : old_state => new_state
+    def event(event, hash)
+      hash.each do |from, to|
+        @events << { event: event, from: from, to: to }
+      end
+    end
+
+    # trigger an event. 
+    # It will return the new state the machine is in 
+    # and call the listener's block
+    #
+    # @see on_state_change
+    # @param event [String or Symbol] event to trigger
+    # @raise [InvalidEvent] if the event is invalid (incorrect state)
+    # @return the new state the machine is in
+    def trigger(event)
+      e = @events.find { |e| e[:event] == event && e[:from] == @state }
+      raise InvalidEvent, "Invalid event '#{event}' from state '#{@state}'" if e.nil?
+      old_state = @state
+      @state = e[:to]
+      @callback_block.call(event, old_state, @state) if @callback_block
+      @state
+    end
+
+    # register a listener to a state change. 
+    #
+    # @param block [Proc] block that will be triggered
+    def on_state_change(&block)
+      @callback_block = block
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'tiny_state_machine'

data/spec/tiny_state_machine_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+module TinyStateMachine
+
+  describe Machine do
+    describe "#event" do
+      it "should register an event" do
+        sm = TinyStateMachine::Machine.new :in_store
+        expect { sm.event :buy, :in_store => :new }.not_to raise_error
+      end
+    end
+
+    describe "#on_state_change" do
+      it "should register a callback block" do
+        sm = TinyStateMachine::Machine.new :in_store
+        expect { sm.on_state_change do |event, from_state, to_state|
+          puts "new state = #{to_state}"
+        end }.not_to raise_error
+      end
+    end
+
+    describe "#trigger" do
+      it "should return the new state if the event is valid" do
+        sm = TinyStateMachine::Machine.new :in_store do |sm|
+          sm.event :buy, :in_store => :new
+        end
+        expect(sm.trigger(:buy)).to eql :new
+      end
+
+      it "should raise an InvalidEvent error if the event is unknown" do
+        sm = TinyStateMachine::Machine.new :in_store do |sm|
+          sm.event :buy, :in_store => :new
+        end
+        expect { sm.trigger(:use) }.to raise_error(InvalidEvent)
+      end
+
+      it "should update the state machine state" do
+        sm = TinyStateMachine::Machine.new :in_store do |sm|
+          sm.event :buy, :in_store => :new
+        end
+        sm.trigger(:buy)
+        expect(sm.state).to eql :new
+      end
+
+      it "should call the callback block" do
+        callback = double('callback', :change => true)
+        
+        sm = TinyStateMachine::Machine.new :in_store do |sm|
+          sm.event :buy, :in_store => :new
+          sm.on_state_change do |event, from_state, to_state|
+            callback.change(event, from_state, to_state)
+          end
+        end
+
+        sm.trigger(:buy)
+        expect(callback).to have_received(:change).with(:buy, :in_store, :new)
+      end
+    end
+
+  end
+
+end

data/tiny_state_machine.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tiny_state_machine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tiny_state_machine"
+  spec.version       = TinyStateMachine::VERSION
+  spec.authors       = ["Geoffroy Montel"]
+  spec.email         = ["g_montel@yahoo.com"]
+  spec.description   = "Tiny State Machine for Ruby"
+  spec.summary       = "A tiny (few dozen lines) state machine with callback for Ruby"
+  spec.homepage      = "https://github.com/geoffroymontel/tiny_state_machine"
+  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,100 @@
+--- !ruby/object:Gem::Specification
+name: tiny_state_machine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoffroy Montel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-26 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: Tiny State Machine for Ruby
+email:
+- g_montel@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/tiny_state_machine.rb
+- lib/tiny_state_machine/version.rb
+- spec/spec_helper.rb
+- spec/tiny_state_machine_spec.rb
+- tiny_state_machine.gemspec
+homepage: https://github.com/geoffroymontel/tiny_state_machine
+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.3
+signing_key: 
+specification_version: 4
+summary: A tiny (few dozen lines) state machine with callback for Ruby
+test_files:
+- spec/spec_helper.rb
+- spec/tiny_state_machine_spec.rb