state_machine_history 0.2.1

data/README.rdoc

@@ -0,0 +1,70 @@
+= state_machine_history
+state_machine_history is an extension of the state_machine[https://github.com/pluginaweek/state_machine] gem,
+that logs transitions between states and allows to check if a state was visited earlier.
+
+== Install
+  gem install state_machine_history
+
+=== Ruby On Rails 2.x
+Add the gem dependency to environment.rb:
+  ...
+  config.gem 'state_machine_history'
+  ...
+Generate the migration:
+  script/generate state_machine_history_2 create_machine_history
+Run the migration
+  rake db:migrate
+
+=== Ruby On Rails 3
+In Gemfile:
+  gem 'state_machine_history'
+Generate the migration:
+  rails generate state_machine_history create_machine_history
+Run the migration:
+  rake db:migrate
+
+== Usage
+This gem adds logging function to the state_machine gem.
+Sample:
+
+=== Class definition
+
+  class Order
+    state_machine :initial => :not_selected do
+      # Switch on state machine logging 
+      track_history
+
+      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
+    end
+  end
+
+=== Using extensions
+
+  order = Order.new
+  # Perform transition (state change is logged)
+  order.choose
+  # Find whether order has visited not_selected state before selected one
+  order.was_there?(:not_selected, :selected) #=> true
+  # Find whether order has visited not_selected state before the current one
+  order.was_there?(:not_selected)  #=> true
+
+== 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/generators/state_machine_history/state_machine_history_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class StateMachineHistoryGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+   
+  def create_migration_file
+    migration_template 'create_machine_history.rb', 'db/migrate/create_machine_history.rb'
+  end
+end

data/generators/state_machine_history/templates/create_machine_history.rb

@@ -0,0 +1,16 @@
+class CreateMachineHistory < ActiveRecord::Migration
+  def self.up
+    create_table :machine_histories do |t|
+      t.column :loggable_id, :integer
+      t.column :loggable_type, :string
+      t.column :from_state, :string
+      t.column :to_state, :string
+      t.column :event, :string
+      t.column :created_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :machine_histories
+  end
+end

data/generators/state_machine_history_2/USAGE

@@ -0,0 +1,7 @@
+Description:
+    The state machine history generator creates a migration to add the history table.
+
+Example:
+    ./script/generate state_machine_history_2 create_machine_history
+
+    This will create a migration in db/migrate/.  Run "rake db:migrate" to update your database.

data/generators/state_machine_history_2/state_machine_history_2_generator.rb

@@ -0,0 +1,11 @@
+class StateMachineHistory2Generator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.migration_template "create_machine_history.rb", "db/migrate"
+    end
+  end
+
+  def file_name
+    'create_machine_history'
+  end
+end

data/generators/state_machine_history_2/templates/create_machine_history.rb

@@ -0,0 +1,16 @@
+class CreateMachineHistory < ActiveRecord::Migration
+  def self.up
+    create_table :machine_histories do |t|
+      t.column :loggable_id, :integer
+      t.column :loggable_type, :string
+      t.column :from_state, :string
+      t.column :to_state, :string
+      t.column :event, :string
+      t.column :created_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :machine_histories
+  end
+end

data/lib/machine_history.rb

@@ -0,0 +1,5 @@
+class MachineHistory < ActiveRecord::Base
+  belongs_to :loggable, :polymorphic => true
+
+  validates_presence_of :loggable, :event, :from_state, :to_state
+end

data/lib/state_machine_history.rb

@@ -0,0 +1,64 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__) + "/../"))
+require 'lib/machine_history'
+require 'rubygems'
+require 'state_machine'
+
+module StateMachineHistory
+
+  class InvalidState < StandardError
+  end
+  
+  def self.included(base)
+    base.class_eval do
+      
+      def track_history
+        self.owner_class.class_eval do
+          has_one :machine_log, :as => :loggable
+        end
+        
+        before_transition(any => any) do |object, transition|
+          MachineHistory.create(:loggable => object,
+            :from_state=>transition.from_name.to_s, :to_state=>transition.to_name.to_s,
+            :event=>transition.event.to_s )
+        end
+      end
+      
+      alias_method :define_event_helpers_original, :define_event_helpers
+
+      def define_event_helpers
+        define_event_helpers_original
+
+        # Define the method which determines whether we visited a state before current or particular one
+        define_instance_method(:was_there?) do |machine, object, from_state, to_state|
+          to_state ||= object.state
+          from_state = from_state.to_s
+          to_state = to_state.to_s
+
+          is_from_state = machine.states.detect {|item| item.name.to_s == from_state}
+          raise InvalidState, "\"#{from_state}\" is an unknown state machine state" unless is_from_state
+          
+          is_to_state = machine.states.detect {|item| item.name.to_s == to_state}
+          raise InvalidState, "\"#{to_state}\" is an unknown state machine state" unless is_to_state
+          
+          history = MachineHistory.find(:last, :conditions => {:loggable_id => object.id,
+            :to_state => to_state})
+
+          next false if history.nil?
+
+          date = history.created_at
+          is_state = MachineHistory.find(:last,
+            :conditions => ["loggable_id = ? and from_state = ? and created_at <= ?",
+            object.id, from_state, date])
+          
+          is_state ? true : false
+        end
+      end
+
+    end
+  end
+  
+end
+
+class StateMachine::Machine
+  include StateMachineHistory
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: state_machine_history
+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-17 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: 
+- generators/state_machine_history/state_machine_history_generator.rb
+- generators/state_machine_history/templates/create_machine_history.rb
+- generators/state_machine_history_2/state_machine_history_2_generator.rb
+- generators/state_machine_history_2/templates/create_machine_history.rb
+- generators/state_machine_history_2/USAGE
+- lib/machine_history.rb
+- lib/state_machine_history.rb
+- README.rdoc
+has_rdoc: true
+homepage: https://github.com/SphereConsultingInc/state_machine_history/
+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: []
+