Skip to content

Commit

Permalink
no need for ReadState anymore
Browse files Browse the repository at this point in the history
  • Loading branch information
alto committed Apr 24, 2013
1 parent 3a331e8 commit 044e84b
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 50 deletions.
2 changes: 1 addition & 1 deletion lib/aasm/persistence.rb
Expand Up @@ -18,7 +18,7 @@ def load_persistence(base)
private

def require_files_for(persistence)
['base', 'read_state', "#{persistence}_persistence"].each do |file_name|
['base', "#{persistence}_persistence"].each do |file_name|
require File.join(File.dirname(__FILE__), 'persistence', file_name)
end
end
Expand Down
3 changes: 1 addition & 2 deletions lib/aasm/persistence/active_record_persistence.rb
Expand Up @@ -7,7 +7,6 @@ module ActiveRecordPersistence
# * includes InstanceMethods
#
# Unless the corresponding methods are already defined, it includes
# * ReadState
# * WriteState
# * WriteStateWithoutPersistence
#
Expand All @@ -32,10 +31,10 @@ module ActiveRecordPersistence
# end
#
def self.included(base)
base.send(:include, AASM::Persistence::Base)
base.extend AASM::Persistence::Base::ClassMethods
base.extend AASM::Persistence::ActiveRecordPersistence::ClassMethods
base.send(:include, AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
base.send(:include, AASM::Persistence::ReadState)
base.send(:include, AASM::Persistence::ActiveRecordPersistence::WriteState) unless base.method_defined?(:aasm_write_state)
base.send(:include, AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence) unless base.method_defined?(:aasm_write_state_without_persistence)

Expand Down
36 changes: 35 additions & 1 deletion lib/aasm/persistence/base.rb
Expand Up @@ -2,6 +2,40 @@ module AASM
module Persistence
module Base

# Returns the value of the aasm_column - called from <tt>aasm.current_state</tt>
#
# If it's a new record, and the aasm state column is blank it returns the initial state
# (example provided here for ActiveRecord, but it's true for Mongoid as well):
#
# class Foo < ActiveRecord::Base
# include AASM
# aasm :column => :status do
# state :opened
# state :closed
# end
# end
#
# foo = Foo.new
# foo.current_state # => :opened
# foo.close
# foo.current_state # => :closed
#
# foo = Foo.find(1)
# foo.current_state # => :opened
# foo.aasm_state = nil
# foo.current_state # => nil
#
# NOTE: intended to be called from an event
#
# This allows for nil aasm states - be sure to add validation to your model
def aasm_read_state
if new_record?
send(self.class.aasm_column).blank? ? aasm.determine_state_name(self.class.aasm_initial_state) : send(self.class.aasm_column).to_sym
else
send(self.class.aasm_column).nil? ? nil : send(self.class.aasm_column).to_sym
end
end

module ClassMethods
# Maps to the aasm_column in the database. Defaults to "aasm_state". You can write
# (example provided here for ActiveRecord, but it's true for Mongoid as well):
Expand Down Expand Up @@ -39,7 +73,7 @@ def aasm_column(column_name=nil)
# @aasm_column
AASM::StateMachine[self].config.column
end
end
end # ClassMethods

end # Base
end # Persistence
Expand Down
3 changes: 1 addition & 2 deletions lib/aasm/persistence/mongoid_persistence.rb
Expand Up @@ -7,7 +7,6 @@ module MongoidPersistence
# * includes InstanceMethods
#
# Unless the corresponding methods are already defined, it includes
# * ReadState
# * WriteState
# * WriteStateWithoutPersistence
#
Expand All @@ -34,10 +33,10 @@ module MongoidPersistence
# end
#
def self.included(base)
base.send(:include, AASM::Persistence::Base)
base.extend AASM::Persistence::Base::ClassMethods
base.extend AASM::Persistence::MongoidPersistence::ClassMethods
base.send(:include, AASM::Persistence::MongoidPersistence::InstanceMethods)
base.send(:include, AASM::Persistence::ReadState)
base.send(:include, AASM::Persistence::MongoidPersistence::WriteState) unless base.method_defined?(:aasm_write_state)
base.send(:include, AASM::Persistence::MongoidPersistence::WriteStateWithoutPersistence) unless base.method_defined?(:aasm_write_state_without_persistence)

Expand Down
41 changes: 0 additions & 41 deletions lib/aasm/persistence/read_state.rb

This file was deleted.

3 changes: 0 additions & 3 deletions spec/unit/persistence/active_record_persistence_spec.rb
Expand Up @@ -18,7 +18,6 @@
let(:klass) {Gate}
it_should_behave_like "aasm model"
it "should include all persistence mixins" do
klass.included_modules.should be_include(AASM::Persistence::ReadState)
klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
end
Expand All @@ -28,7 +27,6 @@
let(:klass) {Writer}
it_should_behave_like "aasm model"
it "should include include all persistence mixins but write state" do
klass.included_modules.should be_include(AASM::Persistence::ReadState)
klass.included_modules.should_not be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
end
Expand All @@ -38,7 +36,6 @@
let(:klass) {Transient}
it_should_behave_like "aasm model"
it "should include all mixins but persistence" do
klass.included_modules.should be_include(AASM::Persistence::ReadState)
klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
klass.included_modules.should_not be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
end
Expand Down

0 comments on commit 044e84b

Please sign in to comment.