dm-is-persistent_state_machine 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 michael
+
+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.rdoc

@@ -0,0 +1,17 @@
+= dm-is-persistent_state_machine
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 michael. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dm-is-persistent_state_machine"
+    gem.summary = %Q{A persistent State Machine for DataMapper}
+    gem.description = %Q{A persistent State Machine for DataMapper}
+    gem.email = "ma@zive.at"
+    gem.homepage = "http://github.com/michael/dm-is-persistent_state_machine"
+    gem.authors = ["michael"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dm-is-persistent_state_machine #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/dm-is-persistent_state_machine.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-is-persistent_state_machine}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["michael"]
+  s.date = %q{2010-01-04}
+  s.description = %q{A persistent State Machine for DataMapper}
+  s.email = %q{ma@zive.at}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "dm-is-persistent_state_machine.gemspec",
+     "lib/dm-is-persistent_state_machine.rb",
+     "lib/dm-is-persistent_state_machine/is/persistent_state_machine.rb",
+     "test/helper.rb",
+     "test/test_dm-is-persistent_state_machine.rb"
+  ]
+  s.homepage = %q{http://github.com/michael/dm-is-persistent_state_machine}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A persistent State Machine for DataMapper}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_dm-is-persistent_state_machine.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/dm-is-persistent_state_machine/is/persistent_state_machine.rb

@@ -0,0 +1,122 @@
+class StateTransition
+  include DataMapper::Resource
+
+  property :id,             Serial
+
+  property :state_id,       Integer, :required => true, :min => 1
+  property :target_id,      Integer, :required => true, :min => 1
+  property :state_event_id, Integer, :required => true, :min => 1
+  
+  belongs_to :state
+  belongs_to :target, 'State', :child_key => [:target_id]
+  belongs_to :state_event
+end
+
+class State
+  include DataMapper::Resource
+
+  property :id,          Serial
+  property :code,        String, :required => true, :unique => true, :unique_index => true
+  property :name,        String, :required => true, :unique => true, :unique_index => true
+  property :editable,    Boolean
+  property :sorter,      Integer
+  property :type,        Discriminator
+
+  # outgoing transitions
+  has n, :state_transitions, 'StateTransition', :child_key => [:state_id]
+  
+  def events
+    evts = []
+    state_transitions.each do |transition|
+      # uses the generic event method
+      evts << transition.state_event
+    end
+    evts
+  end
+  
+  # obj is the caller object
+  def trigger_event!(obj, event_code)
+    event = StateEvent.first(:code => event_code)
+    state_transitions.each do |transition|
+      if transition.state_event == event    
+        obj.state = transition.target
+        obj.after_trigger_event(event)
+        return true
+      end
+    end
+    return false
+  end
+end
+
+class StateEvent
+  include DataMapper::Resource
+  
+  property :id, Serial
+  property :code, String, :required => true, :unique => true, :unique_index => true
+  property :name, String, :required => true, :unique => true, :unique_index => true
+  property :type, Discriminator
+end
+
+
+module DataMapper
+  module Is
+    module PersistentStateMachine
+      
+      class DmIsPersistentStateMachineException < Exception; end
+      
+      ##
+      # fired when plugin gets included into Resource
+      #
+      def self.included(base)
+ 
+      end
+ 
+      ##
+      # Methods that should be included in DataMapper::Model.
+      # Normally this should just be your generator, so that the namespace
+      # does not get cluttered. ClassMethods and InstanceMethods gets added
+      # in the specific resources when you fire is :example
+      ##
+    
+      def is_persistent_state_machine
+ 
+        # Add class-methods
+        extend DataMapper::Is::PersistentStateMachine::ClassMethods
+        extend Forwardable
+        # Add instance-methods
+        include DataMapper::Is::PersistentStateMachine::InstanceMethods
+        
+        # target object must have a status associated
+        property :state_id, Integer, :required => true, :min => 1
+        belongs_to :state
+        
+        DataMapper.logger.info "registering persistent state machine..."
+        
+        # define delegators
+        def_delegators :@state, :events
+        
+        # generate a FooState class that is derived from State        
+        state_model = Object.full_const_set(self.to_s+"State", Class.new(State))
+        # generate a FooStateEvent class that is derived from StateEvent
+        event_model = Object.full_const_set(self.to_s+"StateEvent", Class.new(StateEvent))
+      end
+      
+      ##
+      # fired after trigger_event! is called on resource
+      #
+      def after_trigger_event(event)
+      end
+  
+      module ClassMethods
+        
+      end # ClassMethods
+ 
+      module InstanceMethods
+        def trigger_event!(event_code)
+          # delegate to State#trigger!
+          self.state.trigger_event!(self, event_code)
+        end
+      end # InstanceMethods
+    end # PersistentStateMachine
+  end # Is
+end # DataMapper

data/lib/dm-is-persistent_state_machine.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'forwardable'
+
+require 'dm-core'
+require 'dm-types'
+require 'dm-timestamps'
+require 'dm-validations'
+require 'dm-aggregates'
+
+require 'dm-is-persistent_state_machine/is/persistent_state_machine'
+
+# Activate the plugin
+DataMapper::Model.append_extensions DataMapper::Is::PersistentStateMachine

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dm-is-persistent_state_machine'
+
+class Test::Unit::TestCase
+end

data/test/test_dm-is-persistent_state_machine.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestDmIsPersistentStateMachine < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-persistent_state_machine
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- michael
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-04 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A persistent State Machine for DataMapper
+email: ma@zive.at
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- dm-is-persistent_state_machine.gemspec
+- lib/dm-is-persistent_state_machine.rb
+- lib/dm-is-persistent_state_machine/is/persistent_state_machine.rb
+- test/helper.rb
+- test/test_dm-is-persistent_state_machine.rb
+has_rdoc: true
+homepage: http://github.com/michael/dm-is-persistent_state_machine
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A persistent State Machine for DataMapper
+test_files: 
+- test/helper.rb
+- test/test_dm-is-persistent_state_machine.rb