finity 0.0.3 → 0.0.4

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Martin Donath
+Copyright (c) 2012 Martin Donath <md@struct.cc>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation files

data/README.md

@@ -1,25 +1,28 @@
 # Finity
 
-**Finity** tries to be an extremly lightweight state machine implementation with an easily readable syntax
-which is essential if you have tens or hundreds of transitions. It is inspired by [transitions][], 
-a great state machine implementation tightly integrated with ActiveRecord by Jakub Kuźma and Timo Rößner.
-
-[https://github.com/troessner/transitions][transitions]
-
-The goal of **Finity** is to provide a state machine implementation which is as slim and fast as possible
-while maintaining a beautiful and readable syntax. If you need ActiveModel/ActiveRecord integration,
-[transitions][] is your weapon of choice. However, if you only need a plain state machine implementation
-which is optimized for readability and efficiency, give **Finity** a spin.
+**Finity** tries to be an extremly lightweight state machine implementation
+with an easily readable syntax which is essential if you have tens or hundreds
+of transitions. It is inspired by [transitions][], a great state machine
+implementation tightly integrated with ActiveRecord by Jakub Kuźma and
+Timo Rößner.
+
+The goal of **Finity** is to provide a state machine implementation which is as
+slim and fast as possible while maintaining a beautiful and readable syntax. If
+you need ActiveModel/ActiveRecord integration,[transitions][] is your weapon of
+choice. However, if you only need a plain state machine implementation which is
+optimized for readability and efficiency, give **Finity** a spin.
 
 ## Installation
 
-If you use Rails, include this into your Gemfile and run `bundle install` via command line:
+If you use Rails, include this into your Gemfile and run `bundle install` via
+command line:
 
-```
+``` ruby
 gem 'finity'
 ```
 
-If you're not using Rails, you can install **Finity** with `gem` via command line:
+If you're not using Rails, you can install **Finity** with `gem` via command
+line:
 
 ```
 gem install finity
@@ -27,11 +30,12 @@ gem install finity
 
 ## Usage
 
-**Finity** can transform any class into a state machine. The only thing you have to do is to include it
-and define some transitions. For example, consider a state machine modelling the different states of reading
-the contents of a file:
+**Finity** can transform any class into a state machine. The only thing you
+have to do is to include it and define some transitions. For example, consider
+a state machine modelling the different states of reading the contents of a
+file:
 
-```
+``` ruby
 class Readfile
   include Finity
 
@@ -65,10 +69,11 @@ end
 
 ## States
 
-A state is defined by its name and can define transition functions upon entering and leaving the state.
-These functions can be either referenced as Symbols, Strings, Procs or Lambda:
+A state is defined by its name and can define transition functions upon
+entering and leaving the state. These functions can be either referenced as
+Symbols, Strings, Procs or Lambda:
 
-```
+``` ruby
 state :some_state,
   :enter => proc { do_something and some_other_thing },
   :leave => :execute_leave_action!
@@ -76,11 +81,12 @@ state :some_state,
 
 ## Events and Transitions
 
-Events are like states defined by their names and can trigger several transitions from several states 
-to other states. The transitions are evaluated in the order they are defined. If a valid transition is
-found, the execution is stopped and the transition performed:
+Events are like states defined by their names and can trigger several
+transitions from several states to other states. The transitions are evaluated
+in the order they are defined. If a valid transition is found, the execution is
+stopped and the transition performed:
 
-```
+``` ruby
 event :some_event do
   transitions :from => [:some_state, :another_state], :to => :another_state,
     :if => proc { is_some_condition_true? },
@@ -91,12 +97,13 @@ event :some_event do
 end
 ```
 
-Transitions can be guarded by decision functions (`:if`) and execute another function upon successful
-matching (`:do`). Transitions are triggered by the method `event!` which is defined for the including
-object. Many other state machine implementations define one method for each event and for each state,
+Transitions can be guarded by decision functions (`:if`) and execute another
+function upon successful matching (`:do`). Transitions are triggered by the
+method `event!` which is defined for the including object. Many other state
+machine implementations define one method for each event and for each state,
 however, **Finity** tries to be as minimally invasive as possible:
 
-```
+``` ruby
 object = SomeClassIncludingFinity.new
 if object.state? :some_state
   object.event! :some_event

data/lib/finity.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Martin Donath
+# Copyright (c) 2012 Martin Donath <md@struct.cc>
 
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation files
@@ -33,22 +33,21 @@ module Finity
 
   # Class methods to be injected into the including class upon inclusion.
   module ClassMethods
-    attr_accessor :machine
 
     # Instantiate a new state machine for the including class by accepting a
     # block with state and event (and subsequent transition) definitions.
     def finity options = {}, &block
-      @machine = Machine.new self, options, &block
+      @finity ||= Machine.new self, options, &block
     end
 
     # Return the names of all registered states.
     def states
-      @machine.states.map { |name, _| name }
+      @finity.states.map { |name, _| name }
     end
 
     # Return the names of all registered events.
     def events
-      @machine.events.map { |name, _| name }
+      @finity.events.map { |name, _| name }
     end
   end
 

data/lib/finity/event.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Martin Donath
+# Copyright (c) 2012 Martin Donath <md@struct.cc>
 
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation files

data/lib/finity/machine.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Martin Donath
+# Copyright (c) 2012 Martin Donath <md@struct.cc>
 
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation files
@@ -22,25 +22,35 @@
 
 module Finity
   class Machine
-    attr_accessor :states, :events, :current
+    attr_accessor :states, :events
 
     # Initialize a new state machine within the provided class and define
     # methods for querying the current state and initiating transitions.
+    # The current state must be bound to the including instance, otherwise
+    # there may be problems due to caching between requests.
     def initialize klass, options = {}, &block
-      @klass, @states, @events, @inital = klass, {}, {}, options.delete(:inital)
+      @klass, @states, @events = klass, {}, {}
+      instance_eval &block if block_given?
+      @initial = current = options.delete(:initial) || initial
+      @klass.send :define_method, :current do |*args|
+        unless self.instance_variable_defined? :@current
+          self.instance_variable_set :@current, current
+        end
+        self.instance_variable_get :@current
+      end
       @klass.send :define_method, :event! do |*args|
-        klass.machine.update self, *args
+        self.instance_variable_set :@current, (
+          klass.finity.update self, self.current, *args
+        )
       end
       @klass.send :define_method, :state? do |*args|
-        klass.machine.current.name.eql? *args
+        klass.finity.current.name.eql? *args
       end
-      instance_eval &block if block_given?
-      @current = inital
     end
 
     # Return the name of the initial state.
-    def inital
-      @inital ||= @states.keys.first unless @states.first.nil?
+    def initial
+      @initial ||= @states.keys.first unless @states.first.nil?
     end
 
     # Register a state.
@@ -55,16 +65,17 @@ module Finity
 
     # An event occured, so update the state machine by evaluating the
     # transition functions and notify the left and entered state.
-    def update object, event
-      current ||= @states[@current || inital]
-      if state = @events[event].handle(object, current)
+    def update object, current, event
+      now ||= @states[current]
+      if state = @events[event].handle(object, now)
         if @states[state].nil?
-          raise InvalidState, "Invalid state '#{state}'"
+          raise InvalidState, "Invalid state #{state}"
         end
-        current.leave object
-        current = @states[@current = state]
-        current.enter object
+        now.leave object
+        now = @states[current = state]
+        now.enter object
       end
+      current
     end
   end
 end

data/lib/finity/state.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Martin Donath
+# Copyright (c) 2012 Martin Donath <md@struct.cc>
 
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation files

data/lib/finity/transition.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Martin Donath
+# Copyright (c) 2012 Martin Donath <md@struct.cc>
 
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation files

data/lib/finity/version.rb

@@ -1,3 +1,3 @@
 module Finity
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,39 +1,36 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: finity
-version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
 platform: ruby
-authors:
+authors: 
 - Martin Donath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-07-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1'
-description: Extremly lightweight state machine implementation with an easily readable
-  syntax, which is essential if you have tens or hundreds of transitions.
+      - !ruby/object:Gem::Version 
+        version: "1"
+    version: 
+description: Extremly lightweight state machine implementation with an easily readable syntax, which is essential if you have tens or hundreds of transitions.
 email: md@struct.cc
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - Gemfile
 - LICENSE
 - README.md
@@ -44,28 +41,33 @@ files:
 - lib/finity/state.rb
 - lib/finity/transition.rb
 - lib/finity/version.rb
+has_rdoc: true
 homepage: http://github.com/squidfunk/finity
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
       version: 1.3.6
+  version: 
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Slim and more readable state machine for Ruby
 test_files: []
+