state_shifter 0.7.2 → 0.8.0

data/Gemfile

@@ -7,6 +7,7 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem 'activerecord', '~> 3.2.x'
+  gem 'sqlite3'
   gem "rspec", "~> 2.8.0"
   gem "yard", "~> 0.7"
   gem 'redcarpet' 

data/Gemfile.lock

@@ -40,6 +40,7 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
+    sqlite3 (1.3.6)
     tzinfo (0.3.33)
     yard (0.8.2.1)
 
@@ -54,4 +55,5 @@ DEPENDENCIES
   redcarpet
   rspec (~> 2.8.0)
   simplecov
+  sqlite3
   yard (~> 0.7)

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.8.0

data/examples/malformed_persistence.rb

@@ -1,4 +1,4 @@
-class Advanced
+class MalformedPersistence
   include StateShifter::Definition
 
   ### 

data/examples/missing_persistence.rb

@@ -0,0 +1,98 @@
+class MissingPersistence < ActiveRecord::Base
+  include StateShifter::Definition
+
+  ### 
+
+  persist_attribute :lollies
+
+  state_machine do
+
+    state :initialized do
+
+      event :start_date_changed, :call => :handle_start_date_changed
+      event :forced_start => :running
+      event :start_date_reached => :running, :if => :start_date_reached?
+      event :abort_initialized_contest => :finalized
+    end
+
+    state :running do
+
+      on_entry do |previous_state, trigger_event|
+        running_entry previous_state, trigger_event
+      end
+
+      event :abort_running_contest => :notify_stakeholders 
+      event :changed_properties
+      event :keep_users_engaged
+      event :deadline_reached => :notify_organizers, :if => :entries_deadline_reached?
+      event :spots_filled  => :notify_organizers, :if => :spots_filled?
+      event :deadline_reached_without_approvals  => :notify_pending_users, :if => :entries_deadline_reached_without_approvals?
+      event :deadline_reached_without_entries => :finalized, :if => :entries_deadline_reached_without_entries?
+    end
+
+    state :notify_organizers do
+      on_entry :send_notification_to_organizers
+      event :organizers_notified => :awaiting_organizer_reply
+    end
+
+    state :awaiting_organizer_reply do
+      event :organizer_confirmation_missing => :notify_stakeholders, :if => :organizer_confirmation_deadline_reached?
+      event :keep_organizers_engaged
+      event :organizer_confirmation_received => :notify_approved_users
+      event :organizer_has_more_tickets  => :running
+    end
+
+    state :notify_stakeholders do
+      on_entry :send_notification_to_stakeholders
+      event :stakeholders_notified => :cancelled
+    end
+
+    state :cancelled
+
+    state :notify_pending_users do
+      on_entry :send_notification_to_pending_users
+      event :pending_users_notified => :finalized
+    end
+
+    state :notify_approved_users do
+      on_entry :send_notification_to_approved_users
+      event :approved_users_notified => :send_list_to_organizers
+     end
+
+    state :send_list_to_organizers do
+      on_entry :send_guestlist_to_organizers
+      event :list_sent_to_organizers => :awaiting_attendance
+    end
+
+    state :awaiting_attendance do
+      event :remind_to_fill_in_report => :create_report_filling_requests
+    end
+
+    state :create_report_filling_requests do
+      on_entry :send_report_filling_requests
+      event :finalize => :finalized
+    end
+
+    state :finalized
+
+    on_transition do |from,to,trigger_event, duration|
+      benchmark from, to, trigger_event, duration
+    end
+  end
+
+
+  ###
+
+  def entries_deadline_reached?
+    true
+  end
+
+  def running_entry previous_state, trigger_event
+    #
+  end
+
+  def benchmark from, to, trigger_event, duration
+    #
+  end
+
+end

data/examples/review.rb

@@ -0,0 +1,33 @@
+class Review < ActiveRecord::Base
+  include StateShifter::Definition
+
+  state_machine do 
+
+    # first state to be defined is the initial one
+    state :new do
+      event :submit => :awaiting_review
+    end
+
+    state :awaiting_review do
+      event :review => :being_reviewed
+    end
+
+    state :being_reviewed do
+      event :accept => :accepted, :if => :cool_article?
+      event :reject => :rejected, :if => :bad_article?
+    end
+
+    state :accepted
+    state :rejected
+
+  end
+
+  def cool_article?
+    true
+  end
+
+  def bad_article?
+    false
+  end
+
+end

data/examples/review_custom_persistence.rb

@@ -0,0 +1,35 @@
+class ReviewCustomPersistence < ActiveRecord::Base
+  include StateShifter::Definition
+
+  persist_attribute :stamp
+
+  state_machine do 
+
+    # first state to be defined is the initial one
+    state :new do
+      event :submit => :awaiting_review
+    end
+
+    state :awaiting_review do
+      event :review => :being_reviewed
+    end
+
+    state :being_reviewed do
+      event :accept => :accepted, :if => :cool_article?
+      event :reject => :rejected, :if => :bad_article?
+    end
+
+    state :accepted
+    state :rejected
+
+  end
+
+  def cool_article?
+    true
+  end
+
+  def bad_article?
+    false
+  end
+
+end

data/lib/state_shifter/definition/active_record_integration_methods.rb

@@ -0,0 +1,24 @@
+module StateShifter
+  module Definition
+    module ActiveRecordIntegrationMethods
+
+      class ::StateShifter::Definition::StatePersistenceAttributeNotPresent < RuntimeError; end 
+
+      def get_current_state
+        raise StatePersistenceAttributeNotPresent unless self.attribute_names.include? self.class.persist_attr_name.to_s
+        read_attribute self.class.persist_attr_name
+      end
+
+      def set_current_state value
+        raise StatePersistenceAttributeNotPresent unless self.attribute_names.include? self.class.persist_attr_name.to_s
+        update_attribute self.class.persist_attr_name, value
+      end
+
+      def write_initial_state
+        raise StatePersistenceAttributeNotPresent unless self.attribute_names.include? self.class.persist_attr_name.to_s
+        write_attribute self.class.persist_attr_name, self.class.state_machine_definition.initial_state.name.to_sym
+      end
+
+    end
+  end
+end

data/lib/state_shifter/definition/instance_methods.rb

@@ -3,7 +3,7 @@ module StateShifter
     module InstanceMethods
 
       def current_state
-        @current_state ||=  get_current_state
+        get_current_state
       end
 
       def get_current_state
@@ -19,11 +19,11 @@ module StateShifter
       end
 
       def next_states
-        _next_states current_state
+        _next_states get_current_state
       end
 
       def transitionable_states
-        _next_states current_state, {:check_guards => true}
+        _next_states get_current_state, {:check_guards => true}
       end
 
       def state_names
@@ -52,7 +52,7 @@ module StateShifter
       end
 
       def current_state_def
-        state_machine_definition.get(:state, current_state)
+        state_machine_definition.get(:state, get_current_state)
       end
 
       def call_state_entry_callback trigger, old_state
@@ -73,7 +73,7 @@ module StateShifter
         _start = Time.now
 
         # BOOP!
-        old_state = current_state
+        old_state = get_current_state
         set_current_state args[:to].to_sym
         #
 
@@ -81,7 +81,7 @@ module StateShifter
 
         call_state_entry_callback(args[:trigger], old_state) if current_state_def.has_entry_callback?
         
-        self.instance_exec(old_state, current_state, args[:trigger].to_sym, (Time.now - _start), &state_machine_definition.on_transition_proc) if state_machine_definition.has_on_transition_proc?
+        self.instance_exec(old_state, get_current_state, args[:trigger].to_sym, (Time.now - _start), &state_machine_definition.on_transition_proc) if state_machine_definition.has_on_transition_proc?
 
         true
       end

data/lib/state_shifter/definition.rb

@@ -4,6 +4,13 @@ module StateShifter
     def self.included klass
       klass.send :include, InstanceMethods
       klass.extend ClassMethods
+
+      if Object.const_defined?(:ActiveRecord)
+        if klass < ActiveRecord::Base
+          klass.send :include, ActiveRecordIntegrationMethods
+          klass.before_validation :write_initial_state
+        end
+      end
     end
 
   end

data/lib/state_shifter.rb

@@ -4,6 +4,7 @@ require 'state_shifter/definition'
 require 'state_shifter/definition/contents'
 require 'state_shifter/definition/class_methods'
 require 'state_shifter/definition/instance_methods'
+require 'state_shifter/definition/active_record_integration_methods'
 
 class ::StateShifter::TransitionHalted < Exception ; end
 class ::StateShifter::GuardMethodUndefined < Exception ; end

data/spec/state_shifter_spec.rb

@@ -1,11 +1,14 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require_relative '../examples/simple'
 require_relative '../examples/advanced'
+require_relative '../examples/review'
+require_relative '../examples/review_custom_persistence'
 
 shared_examples_for 'a simple state machine' do
   
   before(:each) do
     @state_machine = described_class.new
+    @state_machine.save if @state_machine.class < ActiveRecord::Base
   end
 
   it 'should have all states and events defined' do
@@ -19,6 +22,7 @@ shared_examples_for 'a simple state machine' do
 
     @state_machine.submit
     @state_machine.initial_state.should == :new
+
     @state_machine.current_state.should == :awaiting_review
   end
 
@@ -162,3 +166,60 @@ describe 'Advanced state machine functionality' do
 
 end
 
+describe Review do
+
+  before(:all) do
+    ActiveRecord::Migration.verbose = false
+
+    ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+
+    ActiveRecord::Schema.define do
+      create_table :reviews do |t|
+        t.string    :current_state
+      end
+    end
+  end
+
+  it_should_behave_like 'a simple state machine'
+
+end
+
+describe ReviewCustomPersistence do
+
+  before(:all) do
+    ActiveRecord::Migration.verbose = false
+
+    ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+
+    ActiveRecord::Schema.define do
+      create_table :review_custom_persistences do |t|
+        t.string    :stamp
+      end
+    end
+  end
+
+  it_should_behave_like 'a simple state machine'
+
+end
+
+describe 'Malformed persistence definition' do
+
+  before(:all) do
+    ActiveRecord::Migration.verbose = false
+
+    ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+
+    ActiveRecord::Schema.define do
+      create_table :missing_persistences do |t|
+        t.string    :xyz
+      end
+    end
+  end
+
+  it 'should complain when the persist attribute is not present' do
+    require_relative '../examples/missing_persistence'
+    review_custom_persistence = MissingPersistence.new
+    lambda { review_custom_persistence.save }.should raise_error(StateShifter::Definition::StatePersistenceAttributeNotPresent)
+  end
+
+end

data/state_shifter.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "state_shifter"
-  s.version = "0.7.2"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bruno Antunes"]
@@ -29,9 +29,13 @@ Gem::Specification.new do |s|
     "examples/malformed_events.rb",
     "examples/malformed_persistence.rb",
     "examples/malformed_states.rb",
+    "examples/missing_persistence.rb",
+    "examples/review.rb",
+    "examples/review_custom_persistence.rb",
     "examples/simple.rb",
     "lib/state_shifter.rb",
     "lib/state_shifter/definition.rb",
+    "lib/state_shifter/definition/active_record_integration_methods.rb",
     "lib/state_shifter/definition/class_methods.rb",
     "lib/state_shifter/definition/contents.rb",
     "lib/state_shifter/definition/instance_methods.rb",
@@ -52,6 +56,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<activerecord>, ["~> 3.2.x"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
       s.add_development_dependency(%q<redcarpet>, [">= 0"])
@@ -61,6 +66,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>, [">= 0"])
     else
       s.add_dependency(%q<activerecord>, ["~> 3.2.x"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
       s.add_dependency(%q<redcarpet>, [">= 0"])
@@ -71,6 +77,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<activerecord>, ["~> 3.2.x"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<yard>, ["~> 0.7"])
     s.add_dependency(%q<redcarpet>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_shifter
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.x
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -159,9 +175,13 @@ files:
 - examples/malformed_events.rb
 - examples/malformed_persistence.rb
 - examples/malformed_states.rb
+- examples/missing_persistence.rb
+- examples/review.rb
+- examples/review_custom_persistence.rb
 - examples/simple.rb
 - lib/state_shifter.rb
 - lib/state_shifter/definition.rb
+- lib/state_shifter/definition/active_record_integration_methods.rb
 - lib/state_shifter/definition/class_methods.rb
 - lib/state_shifter/definition/contents.rb
 - lib/state_shifter/definition/instance_methods.rb
@@ -185,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2788732275758639550
+      hash: 3920605756095371187
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: