state_machine_ext 0.2.1

data/README.rdoc

@@ -0,0 +1,61 @@
+= state_machine extensions
+state_machine_ext is an extension of the state_machine[https://github.com/pluginaweek/state_machine] gem.
+
+== Install
+  gem install state_machine_ext
+
+== Usage
+This gem adds state groups functionality and method to find all possible transitions from a state.
+Below is an example of the features offered:
+
+=== Class definition
+
+  class Order
+    state_machine :initial => :not_selected do
+      event :choose do
+        transition :not_selected => :selected
+      end
+      event :add_to_basket do
+        transition :selected => :in_basket
+      end
+      event :pay do
+        transition :in_basket => :paid
+      end
+      event :to_send do
+        transition :paid => :sent
+      end
+
+      #initialize groups of the states
+      group :not_paid do
+        state :not_selected
+        state :selected
+        state :in_basket
+      end
+      group :in_progress do
+        state :paid, :sent
+      end
+    end
+  end
+
+=== Using extensions
+
+  order = Order.new
+  # returns the array of all the states which we can reach from the current one
+  order.state_all_transitions                #=> [:sent, :paid, :in_basket, :selected]
+  # same for the particular state
+  order.state_all_transitions(:in_basket)    #=> [:sent, :paid]
+  # check whether a group includes some state
+  order.group(:not_paid).include?(:selected) #=> true
+  # find groups to which belongs a state
+  order.find_group(:paid)                    #=> [:in_progress]
+
+
+== Credits
+
+=== Project Team
+* Mykhaylo Sorochan - Project Manager
+* Dmitriy Landberg - Software Developer
+* Nataliya Shatokhina - Tester
+* Sergey Mostovoy - Extension idea
+
+Copyright (c) 2010 {Sphere Consulting Inc.}[http://www.sphereinc.com], released under the MIT license (see LICENSE).

data/lib/group.rb

@@ -0,0 +1,36 @@
+module StateMachineExt
+
+  class InvalidState < StandardError
+  end
+  
+  class Group
+
+    attr_accessor :name
+
+    def initialize(name, parent)
+      @machine = parent
+      @name = name
+      @group_states = []
+    end
+
+    def state(*args)
+      args.each do |arg|
+        is_include = false
+        @machine.states.each do |state|
+          if state.name == arg
+            @group_states << state
+            is_include = true
+          end
+        end
+        raise InvalidState, "\"#{arg}\" is an unknown state machine state" unless is_include
+      end
+    end
+
+    def include?(state)
+      group_state = @group_states.detect {|item| item.name == state}
+      group_state.nil? ? false : true
+    end
+    
+  end
+
+end

data/lib/state_machine_ext.rb

@@ -0,0 +1,89 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__) + "/../"))
+require 'rubygems'
+require 'state_machine'
+require 'lib/group'
+
+module StateMachineExt
+
+  class InvalidGroup < StandardError
+  end
+  
+  def self.included(base)
+    base.class_eval do
+
+      def group(name, &block)
+        @groups = [] if @groups.nil?
+        group = @groups.detect {|item| item.name == name}
+        @groups << group = Group.new(name,self) if group.nil?
+        group.instance_eval(&block) if block
+      end
+      
+      attr_accessor :groups
+      alias_method :define_event_helpers_original, :define_event_helpers
+
+      def define_event_helpers
+        define_event_helpers_original
+
+        # Define the method that returns the group with the given name
+        define_instance_method(:group) do |machine, object, request_group|
+          group = nil
+          group = @groups.detect {|item| item.name == request_group}
+          if group.nil?
+            raise InvalidGroup, "\"#{request_group}\" is an unknown state machine group"
+          end
+          
+          group
+        end
+
+        # Define the method that returns the state machine's group for the given
+        # state
+        define_instance_method(:find_group) do |machine, object, request_state|
+          @groups.inject([]) do |res,group|
+            res << group.name if group.include?(request_state.to_sym)
+            res
+          end
+        end
+
+        #Define the method that returns all states which can be reached
+        #from the given one
+        define_instance_method(attribute(:all_transitions)) do |machine, object, *args|
+          next_transitions = []
+          request_state = []
+         
+          transitions = return_transition(next_transitions, request_state, machine, object, *args)
+
+          transitions.inject([]) do |res,trans|
+            res << trans.to_name unless trans.is_a?(Array)
+            res.uniq
+          end
+        end
+      end
+      
+      def return_transition(next_transitions, request_state, machine, object, *args)
+        state = args.empty? ? object.state_name : args.first
+        request_state << state
+
+        *args = {:from => args.first} unless args.empty?
+        transitions = machine.events.transitions_for(object, *args)
+
+        transitions.each do |transition|
+          unless request_state.include?(transition.to_name)
+            next_transition = 
+              return_transition(next_transitions, request_state,
+              machine, object, transition.to_name)
+            next_transitions << next_transition unless next_transition.empty?
+          end
+          next_transitions << transition
+        end
+
+        next_transitions
+      end
+      private :return_transition
+    end
+  end
+
+end
+
+class StateMachine::Machine
+  include StateMachineExt
+end

data/nbproject/private/private.properties

@@ -0,0 +1 @@
+file.reference.ExtendedStateMachine-lib=/mnt/hgfs/server/ExtendedStateMachine/lib

data/nbproject/private/private.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
+    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
+</project-private>

data/nbproject/project.properties

@@ -0,0 +1,4 @@
+main.file=
+platform.active=Ruby_1
+source.encoding=UTF-8
+src.dir=${file.reference.ExtendedStateMachine-lib}

data/nbproject/project.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.ruby.rubyproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
+            <name>ExStateMachine</name>
+            <source-roots>
+                <root id="src.dir"/>
+            </source-roots>
+            <test-roots/>
+        </data>
+    </configuration>
+</project>

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: state_machine_ext
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Sphere Consulting Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: state_machine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 9
+        - 4
+        version: 0.9.4
+  type: :runtime
+  version_requirements: *id001
+description: "  Extensions for the state_machine gem\n"
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/group.rb
+- lib/state_machine_ext.rb
+- nbproject/private/private.properties
+- nbproject/private/private.xml
+- nbproject/project.properties
+- nbproject/project.xml
+- README.rdoc
+has_rdoc: true
+homepage: https://github.com/SphereConsultingInc/state_machine_ext/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Extensions for the state_machine gem
+test_files: []
+