wizard_machine 0.0.0

data/CHANGELOG

@@ -0,0 +1,4 @@
+0.0.0 (Aug 25th, 2009)
+
+* just getting started. Added the initial gem files.
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Owens
+
+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/Manifest

@@ -0,0 +1,8 @@
+CHANGELOG
+lib/wizard_machine.rb
+lib/wizard_machine_controller_extensions.rb
+LICENSE
+Rakefile
+README
+TODO
+Manifest

data/README

@@ -0,0 +1,15 @@
+= wizard_machine
+
+A Rails gem for managing the states of a model by defining wizard steps.
+
+== Install
+
+gem install wizard_machine
+
+== Usage
+
+...coming soon
+
+== Tutorial
+
+...coming soon

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('wizard_machine', '0.0.0') do |p|
+  p.project        = "wizard-machine"
+  p.description    = "A Rails gem for managing the states of a model by defining wizard steps."
+  p.url            = "http://rubyforge.org/projects/wizard-machine"
+  p.author         = 'Ryan Owens'
+  p.email          = "ryan (at) infoether (dot) com"
+  p.ignore_pattern = ["tmp/*", "script/*", "wizard_machine_notes.txt"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/lib/wizard_machine.rb

@@ -0,0 +1,128 @@
+module WizardMachine
+
+  def self.__wizard_machine_processing_class
+    @__wizard_machine_processing_class
+  end
+
+  def self.__wizard_machine_processing_class=(klass)
+    raise "__wizard_machine_processing_class is already set (#{@__wizard_machine_processing_class.name}). Make sure you are calling setup_wizard_events! (#{klass.name}). " if !klass.nil? && !@__wizard_machine_processing_class.nil?
+    @__wizard_machine_processing_class = klass
+  end
+  
+  def self.included(base)
+    WizardMachine.__wizard_machine_processing_class = base
+    base.send :include, AASM
+    base.extend(ClassMethods)
+
+    # base.aasm_column :state #default is :aasm_state
+
+    base.after_create :created!
+    
+    base.aasm_initial_state :new
+    base.aasm_state :new
+  end
+  
+  module ClassMethods
+    
+    def wizard_state(*args)
+      @all_state_names = nil
+      @wizard_state_names = nil
+      aasm_state(*args)
+    end
+    
+    def wizard_state_is(state)
+      Proc.new { |service_account| service_account.wizard_state == state }
+    end
+
+    def all_state_names
+      @all_state_names ||= self.aasm_states.collect(&:name)
+    end
+
+    def wizard_state_names
+      @wizard_state_names ||= all_state_names - [:new]
+    end
+    
+    def wizard_total_steps
+      wizard_state_names.size-1
+    end
+
+    def setup_wizard_events!
+      aasm_state :wizard_complete
+      
+      aasm_event :created do
+        transitions :to => WizardMachine.__wizard_machine_processing_class.wizard_state_names.first, :from => [:new]
+      end
+      aasm_event :wizard_complete do
+        transitions :to => :wizard_complete, :from => WizardMachine.__wizard_machine_processing_class.all_state_names
+      end
+      wizard_state_names.each do |state|
+        aasm_event state do
+          transitions :to => state, :from => WizardMachine.__wizard_machine_processing_class.all_state_names
+        end
+      end
+      WizardMachine.__wizard_machine_processing_class = nil
+    end
+    
+  end
+
+  def set_state!(state)
+    raise "No state with name: #{state.inspect}. wizard_states: #{self.wizard_state_names.inspect}" unless valid_state?(state)
+    self.send "#{state}!"
+  end
+  
+  def valid_state?(state)
+    state = state.intern if state.respond_to? :intern
+    all_state_names.include? state
+  end
+
+  #TODO consider using wizard_state_names for the index. does it matter? this should just be internal, so it shouldn't really matter (I think).
+  def state_index
+    all_state_names.index wizard_state
+  end
+  
+  def wizard_state
+    raise "Model is saved in an invalid state. You must have changed some of the wizard_states. Invalid state: #{aasm_current_state.inspect}. wizard_states: #{self.wizard_state_names.inspect}" unless valid_state?(aasm_current_state)
+    aasm_current_state
+  end
+
+  def wizard_current_step
+    state_index
+  end
+
+  def previous_state_index
+    state_index.zero? ? 0 : state_index - 1
+  end
+
+  def next_state_index
+    wizard_complete? ? nil : state_index + 1
+  end
+
+  def next_state_name
+    all_state_names[next_state_index]
+  end
+
+  def next_state!
+    set_state! next_state_name
+  end
+
+  def previous_wizard_state
+    all_state_names[previous_state_index]
+  end
+
+  def previous_state!
+    set_state! previous_wizard_state
+  end
+
+  def wizard_complete?
+    :wizard_complete == wizard_state
+  end
+
+  def all_state_names
+    self.class.all_state_names
+  end
+
+  def wizard_state_names
+    self.class.wizard_state_names
+  end
+  
+end

data/lib/wizard_machine_controller_extensions.rb

@@ -0,0 +1,26 @@
+module WizardMachineControllerExtensions
+
+#TODO ad the ability to auto-gen certain actions into the plugin. For now this isn't actually used.
+
+  def self.included(base)
+    # base.send :include, AASM
+    base.extend(ClassMethods)
+    
+    self << class
+      #each state has its own action which needs to setup the service_account object from the params
+      # before_filter :service_account, :only => ServiceAccount.wizard_state_names
+    end
+    
+  end
+  
+  module ClassMethods
+    
+    # def wizard_state(*args)
+    #   @all_state_names = nil
+    #   @wizard_state_names = nil
+    #   aasm_state(*args)
+    # end
+    
+  end
+
+end

data/wizard_machine.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wizard_machine}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Owens"]
+  s.date = %q{2009-08-25}
+  s.description = %q{A Rails gem for managing the states of a model by defining wizard steps.}
+  s.email = %q{ryan (at) infoether (dot) com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/wizard_machine.rb", "lib/wizard_machine_controller_extensions.rb", "LICENSE", "README", "TODO"]
+  s.files = ["CHANGELOG", "lib/wizard_machine.rb", "lib/wizard_machine_controller_extensions.rb", "LICENSE", "Rakefile", "README", "TODO", "Manifest", "wizard_machine.gemspec"]
+  s.homepage = %q{http://rubyforge.org/projects/wizard-machine}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Wizard_machine", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{wizard-machine}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Rails gem for managing the states of a model by defining wizard steps.}
+
+  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
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: wizard_machine
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Ryan Owens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-25 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A Rails gem for managing the states of a model by defining wizard steps.
+email: ryan (at) infoether (dot) com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/wizard_machine.rb
+- lib/wizard_machine_controller_extensions.rb
+- LICENSE
+- README
+- TODO
+files: 
+- CHANGELOG
+- lib/wizard_machine.rb
+- lib/wizard_machine_controller_extensions.rb
+- LICENSE
+- Rakefile
+- README
+- TODO
+- Manifest
+- wizard_machine.gemspec
+has_rdoc: true
+homepage: http://rubyforge.org/projects/wizard-machine
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Wizard_machine
+- --main
+- README
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: wizard-machine
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Rails gem for managing the states of a model by defining wizard steps.
+test_files: []
+