openhood-simple_state_machine 2.0.0 → 3.0.0

data/Gemfile.lock

@@ -6,27 +6,30 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      arel (~> 2.0.10)
-      tzinfo (~> 0.3.23)
-    activesupport (3.0.9)
-    arel (2.0.10)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    arel (2.2.1)
     bson (1.3.1)
-    builder (2.1.2)
+    bson_ext (1.3.1)
+    builder (3.0.0)
     diff-lcs (1.1.2)
-    i18n (0.5.0)
+    i18n (0.6.0)
     mongo (1.3.1)
       bson (>= 1.3.1)
     mongo_mapper (0.9.1)
       activemodel (~> 3.0)
       activesupport (~> 3.0)
       plucky (~> 0.3.8)
+    multi_json (1.0.3)
     plucky (0.3.8)
       mongo (~> 1.3)
     rake (0.8.7)
@@ -38,14 +41,15 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
-    sqlite3 (1.3.3)
-    tzinfo (0.3.28)
+    sqlite3 (1.3.4)
+    tzinfo (0.3.30)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activerecord (>= 3.0.0)
+  bson_ext (~> 1.3.0)
   mongo_mapper (~> 0.9.0)
   openhood-simple_state_machine!
   rake (~> 0.8.7)

data/README.md

@@ -0,0 +1,71 @@
+SimpleStateMachine
+==================
+
+Allow an Active Record or MongoMapper model to act as a finite state machine just as the popular plugin acts_as_state_machine but with many enhancements such as the possibility to have multiple states per object.
+
+It can work together with the classic act_as_state_machine on the same project but both cannot be used at the same time for one given Active Record model. Moreover, simple_state_machine work standalone and doesn't require acts_as_state_machine.
+
+You also get magic methods to check current state and a way to revert to previous state in database (or initial value for a new record) if something went wrong.
+
+
+Dependencies
+------------
+
+* Ruby 1.8.7 or 1.9.2
+
+Lazy dependencies
+-----------------
+
+* gem "active_record", ">= 3.0.0"
+* gem "mongo_mapper", "~> 0.9.0"
+
+Usage
+-----
+
+* With ActiveRecord
+
+          require "simple_state_machine/active_record"
+
+          class Chicken < ActiveRecord::Base
+            state_machine :user_state, [:pending, :active, :removed, :on_hold]
+            state_machine :validation_state, [:waiting, :reviewed, :validated, :invalid]
+            def user_activate!
+              return false if !user_state_pending?
+              self.user_state = :active
+              save! rescue user_state_revert
+              user_state_active?
+            end
+          end
+
+          # And then you can do:
+
+          c = Chicken.create # c.user_state = :pending
+          c.user_activate! # c.user_state = :active
+
+* With MongoMapper
+
+          require "simple_state_machine/mongo_mapper"
+
+          class Chicken
+            include MongoMapper::Document
+            plugin SimpleStateMachine::MongoMapper
+
+            state_machine :user_state, [:pending, :active, :removed, :on_hold]
+            state_machine :validation_state, [:waiting, :reviewed, :validated, :invalid]
+            def user_activate!
+              return false if !user_state_pending?
+              self.user_state = :active
+              save! rescue user_state_revert
+              user_state_active?
+            end
+          end
+
+          # And then you can do:
+
+          c = Chicken.create # c.user_state = :pending
+          c.user_activate! # c.user_state = :active
+          
+License
+-------
+
+SimpleStateMachine is Copyright © 2010-2011 Openhood.com It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/lib/simple_state_machine/active_record.rb

@@ -10,8 +10,8 @@ module SimpleStateMachine
 
     module ClassMethods
       def state_machine(column, states)
-        create_empty_state_machine unless inheritable_attributes.key? :states
-        inheritable_attributes[:states][column.to_sym] = states
+        create_empty_state_machine unless respond_to? :states
+        self.states[column.to_sym] = states
         validates_inclusion_of column, :in => states
         # should also override getter/setter to convert to strings
         self.class_eval <<-eos
@@ -40,9 +40,9 @@ module SimpleStateMachine
     private
 
       def create_empty_state_machine
-        write_inheritable_attribute :states, {} # add a class variable
-        class_inheritable_reader    :states     # make it read-only
-    
+        class_attribute :states
+        self.states = {}
+
         after_initialize :set_initial_states
         self.class_eval do
           def set_initial_states

data/lib/simple_state_machine/mongo_mapper.rb

@@ -4,14 +4,14 @@ module SimpleStateMachine
 
     included do
       class_eval do
-        write_inheritable_attribute :states, {}
-        class_inheritable_reader :states
+        class_attribute :states
+        self.states = {}
       end
     end
 
     module ClassMethods
       def state_machine(column, column_states)
-        inheritable_attributes[:states][column.to_sym] = column_states
+        states[column.to_sym] = column_states
 
         key column, String
         validates_inclusion_of column, :in => column_states

data/lib/simple_state_machine/version.rb

@@ -1,3 +1,3 @@
 module SimpleStateMachine
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

data/simple_state_machine.gemspec

@@ -21,5 +21,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rspec", ["~> 2.6.0"])
   s.add_development_dependency("sqlite3")
   s.add_development_dependency("activerecord", [">= 3.0.0"])
+  s.add_development_dependency("bson_ext", ["~> 1.3.0"])
   s.add_development_dependency("mongo_mapper", ["~> 0.9.0"])
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhood-simple_state_machine
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-22 00:00:00.000000000 +02:00
-default_executable: 
+date: 2011-10-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2161201240 !ruby/object:Gem::Requirement
+  requirement: &2152903280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +22,10 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *2161201240
+  version_requirements: *2152903280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2161198760 !ruby/object:Gem::Requirement
+  requirement: &2152902760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +33,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2161198760
+  version_requirements: *2152902760
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2161197360 !ruby/object:Gem::Requirement
+  requirement: &2152902380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161197360
+  version_requirements: *2152902380
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2161195840 !ruby/object:Gem::Requirement
+  requirement: &2152901820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +55,21 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *2161195840
+  version_requirements: *2152901820
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &2152901300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152901300
 - !ruby/object:Gem::Dependency
   name: mongo_mapper
-  requirement: &2161188280 !ruby/object:Gem::Requirement
+  requirement: &2152932540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,7 +77,7 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *2161188280
+  version_requirements: *2152932540
 description: Same as acts_as_state_machine but on multiple columns and with more strict
   validation, allow creation of complex events with parameters, used successfully
   on critical financial applications for quite a long time
@@ -80,7 +90,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.textile
+- README.md
 - Rakefile
 - init.rb
 - lib/simple_state_machine.rb
@@ -93,7 +103,6 @@ files:
 - spec/simple_state_machine/mongo_mapper_spec.rb
 - spec/spec_helper.rb
 - spec/support/mongo_mapper_helper.rb
-has_rdoc: true
 homepage: http://github.com/openhood/simple_state_machine
 licenses: []
 post_install_message: 
@@ -114,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Same as acts_as_state_machine but on multiple columns and with more strict

data/README.textile

@@ -1,50 +0,0 @@
-h2. State Machine
-
-Allow an Active Record or MongoMapper model to act as a finite state machine just as the popular plugin acts_as_state_machine but with many enhancements such as the possibility to have multiple states per object.
-
-It can work together with the classic act_as_state_machine on the same project but both cannot be used at the same time for one given Active Record model. Moreover, simple_state_machine work standalone and doesn't require acts_as_state_machine.
-
-You also get magic methods to check current state and a way to revert to previous state in database (or initial value for a new record) if something went wrong.
-
-h3. Example for ActiveRecord
-
-  require "simple_state_machine/active_record"
-  
-  class Chicken < ActiveRecord::Base
-    state_machine :user_state, [:pending, :active, :removed, :on_hold]
-    state_machine :validation_state, [:waiting, :reviewed, :validated, :invalid]
-    def user_activate!
-      return false if !user_state_pending?
-      self.user_state = :active
-      save! rescue user_state_revert
-      user_state_active?
-    end       
-  end
-
-And then you can do:
-
-  c = Chicken.create # c.user_state = :pending
-  c.user_activate! # c.user_state = :active
-  
-h3. Example for MongoMapper
-
-  require "simple_state_machine/mongo_mapper"
-
-  class Chicken
-    include MongoMapper::Document
-    plugin SimpleStateMachine::MongoMapper
-
-    state_machine :user_state, [:pending, :active, :removed, :on_hold]
-    state_machine :validation_state, [:waiting, :reviewed, :validated, :invalid]
-    def user_activate!
-      return false if !user_state_pending?
-      self.user_state = :active
-      save! rescue user_state_revert
-      user_state_active?
-    end       
-  end
-
-And then you can do:
-
-  c = Chicken.create # c.user_state = :pending
-  c.user_activate! # c.user_state = :active