aasm 2.1.1 → 5.2.0

data/spec/models/simple_custom_example.rb

@@ -0,0 +1,53 @@
+class CustomAASMBase < AASM::Base
+  # A custom transiton that we want available across many AASM models.
+  def count_transitions!
+    klass.class_eval do
+      aasm :with_klass => CustomAASMBase do
+        after_all_transitions :increment_transition_count
+      end
+    end
+  end
+
+  # A custom annotation that we want available across many AASM models.
+  def requires_guards!
+    klass.class_eval do
+      attr_reader :authorizable_called,
+        :transition_count,
+        :fillable_called
+
+      def authorizable?
+        @authorizable_called = true
+      end
+
+      def fillable?
+        @fillable_called = true
+      end
+
+      def increment_transition_count
+        @transition_count ||= 0
+        @transition_count += 1
+      end
+    end
+  end
+end
+
+class SimpleCustomExample
+  include AASM
+
+  # Let's build an AASM state machine with our custom class.
+  aasm :with_klass => CustomAASMBase do
+    requires_guards!
+    count_transitions!
+
+    state :initialised, :initial => true
+    state :filled_out
+    state :authorised
+
+    event :fill_out do
+      transitions :from => :initialised, :to => :filled_out, :guard => :fillable?
+    end
+    event :authorise do
+      transitions :from => :filled_out, :to => :authorised, :guard => :authorizable?
+    end
+  end
+end

data/spec/models/simple_example.rb

@@ -0,0 +1,23 @@
+class SimpleExample
+  include AASM
+  aasm do
+    state :initialised, :initial => true
+    state :filled_out
+    state :denied
+    state :authorised
+
+    event :fill_out do
+      transitions :from => :initialised, :to => :filled_out
+    end
+
+    event :deny do
+      transitions from: :initialised, to: :denied
+    end
+
+    event :authorise do
+      transitions :from => :filled_out, :to => :authorised
+    end
+
+  end
+
+end

data/spec/models/simple_example_with_guard_args.rb

@@ -0,0 +1,17 @@
+class SimpleExampleWithGuardArgs
+  include AASM
+  aasm do
+    state :initialised, :initial => true
+    state :filled_out_with_args
+
+    event :fill_out_with_args do
+      transitions :guard => [:arg_is_valid?],
+                  :from => :initialised,
+                  :to => :filled_out_with_args
+    end
+  end
+
+  def arg_is_valid?(arg)
+    return arg
+  end
+end

data/spec/models/simple_multiple_example.rb

@@ -0,0 +1,42 @@
+class SimpleMultipleExample
+  include AASM
+  aasm(:move) do
+    state :standing, :initial => true
+    state :walking
+    state :running
+
+    event :walk do
+      transitions :from => :standing, :to => :walking
+    end
+    event :run do
+      transitions :from => [:standing, :walking], :to => :running
+    end
+    event :hold do
+      transitions :from => [:walking, :running], :to => :standing
+    end
+  end
+
+  aasm(:work) do
+    state :sleeping, :initial => true
+    state :processing
+
+    event :start do
+      transitions :from => :sleeping, :to => :processing
+    end
+    event :stop do
+      transitions :from => :processing, :to => :sleeping
+    end
+  end
+
+  aasm(:question) do
+    state :answered, :initial => true
+    state :asked
+
+    event :ask, :binding_event => :start do
+      transitions :from => :answered, :to => :asked
+    end
+    event :answer, :binding_event => :stop do
+      transitions :from => :asked, :to => :answered
+    end
+  end
+end

data/spec/models/state_machine_with_failed_event.rb

@@ -0,0 +1,20 @@
+class StateMachineWithFailedEvent
+  include AASM
+
+  aasm do
+    state :init, :initial => true
+    state :failed
+    state :sent
+
+    event :failed do
+      transitions :from => :init, :to => :failed
+    end
+    event :send, :before => :callback do
+      transitions :from => :init, :to => :sent
+    end
+  end
+
+  def callback
+    true
+  end
+end

data/spec/models/states_on_one_line_example.rb

@@ -0,0 +1,8 @@
+class StatesOnOneLineExample
+  include AASM
+
+  aasm :one_line do
+    state :initial, :initial => true
+    state :first, :second
+  end
+end

data/spec/models/sub_class.rb

@@ -0,0 +1,41 @@
+require_relative 'super_class'
+
+class SubClass < SuperClass
+  # Add an after callback that is not defined in the parent
+  aasm.state_machine.events[:foo].options[:after] = [:after_foo_event]
+
+  # Add global callback that is not defined in the parent
+  aasm.state_machine.global_callbacks[:after_all_transitions] = :after_all_event
+
+  attr_accessor :called_after
+
+  def after_foo_event
+    self.called_after = true
+  end
+
+  def after_all_event; end
+end
+
+class SubClassMultiple < SuperClassMultiple
+  # Add after callbacks that are not defined in the parent
+  aasm(:left).state_machine.events[:foo].options[:after] = [:left_after_foo_event]
+  aasm(:right).state_machine.events[:close].options[:after] = [:right_after_close_event]
+
+  # Add global callback that is not defined in the parent
+  aasm(:left).state_machine.global_callbacks[:after_all_transitions] = :left_after_all_event
+  aasm(:right).state_machine.global_callbacks[:after_all_transitions] = :right_after_all_event
+
+  attr_accessor :left_called_after, :right_called_after
+
+  def left_after_foo_event
+    self.left_called_after = true
+  end
+
+  def right_after_close_event
+    self.right_called_after = true
+  end
+
+  def left_after_all_event; end
+
+  def right_after_all_event; end
+end

data/spec/models/sub_class_with_more_states.rb

@@ -0,0 +1,18 @@
+require_relative 'super_class'
+
+class SubClassWithMoreStates < SuperClass
+  include AASM
+  aasm do
+    state :foo
+  end
+end
+
+class SubClassWithMoreStatesMultiple < SuperClassMultiple
+  include AASM
+  aasm(:left) do
+    state :foo
+  end
+  aasm(:right) do
+    state :archived
+  end
+end

data/spec/models/sub_classing.rb

@@ -0,0 +1,3 @@
+class SubClassing < Silencer
+  
+end

data/spec/models/super_class.rb

@@ -0,0 +1,46 @@
+class SuperClass
+  include AASM
+
+  aasm do
+    state :read
+    state :ended
+
+    event :foo do
+      transitions :to => :ended, :from => [:read]
+    end
+  end
+
+  def update_state
+    if may_foo?
+      foo!
+    end
+  end
+end
+
+class SuperClassMultiple
+  include AASM
+
+  aasm(:left) do
+    state :read
+    state :ended
+
+    event :foo do
+      transitions :to => :ended, :from => [:read]
+    end
+  end
+
+  aasm(:right) do
+    state :opened
+    state :closed
+
+    event :close do
+      transitions :to => :closed, :from => [:opened]
+    end
+  end
+
+  def update_state
+    if may_foo?
+      foo!
+    end
+  end
+end

data/spec/models/this_name_better_not_be_in_use.rb

@@ -0,0 +1,11 @@
+class ThisNameBetterNotBeInUse
+  include AASM
+
+  aasm do
+    state :initial
+    state :symbol
+    state :string
+    state :array
+    state :proc
+  end
+end

data/spec/models/timestamps_example.rb

@@ -0,0 +1,19 @@
+class TimestampsExample
+  include AASM
+
+  attr_accessor :opened_at
+  attr_reader :closed_at
+
+  aasm timestamps: true do
+    state :opened
+    state :closed
+
+    event :open do
+      transitions to: :opened
+    end
+
+    event :close do
+      transitions to: :closed
+    end
+  end
+end

data/spec/models/timestamps_with_named_machine_example.rb

@@ -0,0 +1,13 @@
+class TimestampsWithNamedMachineExample
+  include AASM
+
+  attr_accessor :opened_at
+
+  aasm :my_state, timestamps: true do
+    state :opened
+
+    event :open do
+      transitions to: :opened
+    end
+  end
+end

data/spec/models/valid_state_name.rb

@@ -0,0 +1,23 @@
+class ValidStateName
+  include AASM
+  aasm do
+    state :invalid, :initial => true
+    state :valid
+
+    event :valid do
+      transitions :to => :valid, :from => [:invalid]
+    end
+  end
+end
+
+class ValidStateNameMultiple
+  include AASM
+  aasm(:left) do
+    state :invalid, :initial => true
+    state :valid
+
+    event :valid do
+      transitions :to => :valid, :from => [:invalid]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+require 'aasm'
+require 'rspec'
+require 'aasm/rspec'
+require 'i18n'
+require 'pry'
+
+# require 'ruby-debug'; Debugger.settings[:autoeval] = true; debugger; rubys_debugger = 'annoying'
+# require 'ruby-debug/completion'
+# require 'pry'
+
+SEQUEL_DB = defined?(JRUBY_VERSION) ? 'jdbc:sqlite::memory:' : 'sqlite:/'
+
+def load_schema
+  require 'logger'
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+  ActiveRecord::Base.establish_connection(config['sqlite3'])
+  require File.dirname(__FILE__) + "/database.rb"
+end
+
+# custom spec helpers
+Dir[File.dirname(__FILE__) + "/spec_helpers/**/*.rb"].sort.each { |f| require File.expand_path(f) }
+
+# example model classes
+Dir[File.dirname(__FILE__) + "/models/*.rb"].sort.each { |f| require File.expand_path(f) }
+
+I18n.load_path << 'spec/en.yml'
+I18n.enforce_available_locales = false
+I18n.default_locale = :en

data/spec/spec_helpers/active_record.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+begin
+  require 'active_record'
+
+  puts "active_record #{ActiveRecord::VERSION::STRING} gem found, running ActiveRecord specs \e[32m#{'✔'}\e[0m"
+rescue LoadError
+  puts "active_record gem not found, not running ActiveRecord specs \e[31m#{'✖'}\e[0m"
+end

data/spec/spec_helpers/dynamoid.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+begin
+  require 'dynamoid'
+  require 'aws-sdk-resources'
+  puts "dynamoid #{Dynamoid::VERSION} gem found, running Dynamoid specs \e[32m#{'✔'}\e[0m"
+
+  ENV['ACCESS_KEY'] ||= 'abcd'
+  ENV['SECRET_KEY'] ||= '1234'
+
+  Aws.config.update(
+    region: 'us-west-2',
+    credentials: Aws::Credentials.new(ENV['ACCESS_KEY'], ENV['SECRET_KEY'])
+  )
+
+  Dynamoid.configure do |config|
+    config.namespace = 'dynamoid_tests'
+    config.endpoint = "http://#{ENV['DYNAMODB_HOST'] || '127.0.0.1'}:" \
+                      "#{ENV['DYNAMODB_PORT'] || 30180}"
+    config.warn_on_scan = false
+  end
+
+  Dynamoid.logger.level = Logger::FATAL
+
+  RSpec.configure do |c|
+    c.before(:each) do
+      Dynamoid.adapter.list_tables.each do |table|
+        Dynamoid.adapter.delete_table(table) if table =~ /^#{Dynamoid::Config.namespace}/
+      end
+      Dynamoid.adapter.tables.clear
+    end
+  end
+rescue LoadError
+  puts "dynamoid gem not found, not running Dynamoid specs \e[31m#{'✖'}\e[0m"
+end

data/spec/spec_helpers/mongoid.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+begin
+  require 'mongoid'
+  puts "mongoid #{Mongoid::VERSION} gem found, running mongoid specs \e[32m#{'✔'}\e[0m"
+
+  if Mongoid::VERSION.to_f <= 5
+    Mongoid::Config.sessions = {
+      default: {
+        database: "mongoid_#{Process.pid}",
+        hosts: ["#{ENV['MONGODB_HOST'] || 'localhost'}:" \
+                "#{ENV['MONGODB_PORT'] || 27017}"]
+      }
+    }
+  else
+    Mongoid::Config.send(:clients=, {
+      default: {
+        database: "mongoid_#{Process.pid}",
+        hosts: ["#{ENV['MONGODB_HOST'] || 'localhost'}:" \
+                "#{ENV['MONGODB_PORT'] || 27017}"]
+      }
+    })
+  end
+rescue LoadError
+  puts "mongoid gem not found, not running mongoid specs \e[31m#{'✖'}\e[0m"
+end

data/spec/spec_helpers/nobrainer.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+begin
+  require 'nobrainer'
+
+  NoBrainer.configure do |config|
+    config.app_name = :aasm
+    config.environment = :test
+    config.warn_on_active_record = false
+  end
+
+  puts "nobrainer #{Gem.loaded_specs['nobrainer'].version} gem found, running nobrainer specs \e[32m#{'✔'}\e[0m"
+rescue LoadError
+  puts "nobrainer gem not found, not running nobrainer specs \e[31m#{'✖'}\e[0m"
+end

data/spec/spec_helpers/redis.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+begin
+  require 'redis-objects'
+  require 'redis/objects/version'
+  puts "redis-objects #{Redis::Objects::VERSION} gem found, running Redis specs \e[32m#{'✔'}\e[0m"
+
+  Redis.current = Redis.new(host: (ENV['REDIS_HOST'] || '127.0.0.1'),
+                            port: (ENV['REDIS_PORT'] || 6379))
+
+  RSpec.configure do |c|
+    c.before(:each) do
+      Redis.current.keys('redis_*').each { |k| Redis.current.del k }
+    end
+  end
+rescue LoadError
+  puts "redis-objects gem not found, not running Redis specs \e[31m#{'✖'}\e[0m"
+end

data/spec/spec_helpers/remove_warnings.rb

@@ -0,0 +1 @@
+AASM::Configuration.hide_warnings = true

data/spec/spec_helpers/sequel.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+begin
+  require 'sequel'
+  puts "sequel #{Sequel::VERSION} gem found, running Sequel specs \e[32m#{'✔'}\e[0m"
+rescue LoadError
+  puts "sequel gem not found, not running Sequel specs \e[31m#{'✖'}\e[0m"
+end

data/spec/unit/abstract_class_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+if defined?(ActiveRecord)
+  require 'models/active_record/person'
+
+  load_schema
+  describe 'Abstract subclassing' do
+
+    it 'should have the parent states' do
+      Person.aasm.states.each do |state|
+        expect(Base.aasm.states).to include(state)
+      end
+      expect(Person.aasm.states).to eq(Base.aasm.states)
+    end
+
+    it 'should have the same events as its parent' do
+      expect(Base.aasm.events).to eq(Person.aasm.events)
+    end
+
+    it 'should not break aasm methods when super class is abstract_class' do
+      person = Person.new
+      person.status = 'active'
+      person.deactivate!
+      expect(person.aasm.current_state).to eq(:inactive)
+    end
+
+  end
+end

data/spec/unit/api_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+if defined?(ActiveRecord)
+  require 'models/default_state.rb'
+  require 'models/provided_state.rb'
+  require 'models/active_record/persisted_state.rb'
+  require 'models/active_record/provided_and_persisted_state.rb'
+
+  load_schema
+
+  describe "reading the current state" do
+    it "uses the AASM default" do
+      expect(DefaultState.new.aasm.current_state).to eql :alpha
+    end
+
+    it "uses display option" do
+      expect(DefaultState.new.aasm.human_state).to eql "ALPHA"
+    end
+
+    it "uses the provided method" do
+      expect(ProvidedState.new.aasm.current_state).to eql :beta
+    end
+
+    it "uses the persistence storage" do
+      expect(PersistedState.new.aasm.current_state).to eql :alpha
+    end
+
+    it "uses the provided method even if persisted" do
+      expect(ProvidedAndPersistedState.new.aasm.current_state).to eql :gamma
+    end
+
+    context "after dup" do
+      it "uses the persistence storage" do
+        source = PersistedState.create!
+        copy = source.dup
+        copy.save!
+
+        copy.release!
+
+        expect(source.aasm_state).to eql 'alpha'
+        expect(source.aasm.current_state).to eql :alpha
+
+        source2 = PersistedState.find(source.id)
+        expect(source2.reload.aasm_state).to eql 'alpha'
+        expect(source2.aasm.current_state).to eql :alpha
+
+        expect(copy.aasm_state).to eql 'beta'
+        expect(copy.aasm.current_state).to eql :beta
+      end
+    end
+  end
+
+  describe "writing and persisting the current state" do
+    it "uses the AASM default" do
+      o = DefaultState.new
+      o.release!
+      expect(o.persisted_store).to be_nil
+    end
+
+    it "uses the provided method" do
+      o = ProvidedState.new
+      o.release!
+      expect(o.persisted_store).to eql :beta
+    end
+
+    it "uses the persistence storage" do
+      o = PersistedState.new
+      o.release!
+      expect(o.persisted_store).to be_nil
+    end
+
+    it "uses the provided method even if persisted" do
+      o = ProvidedAndPersistedState.new
+      o.release!
+      expect(o.persisted_store).to eql :beta
+    end
+  end
+
+  describe "writing the current state without persisting it" do
+    it "uses the AASM default" do
+      o = DefaultState.new
+      o.release
+      expect(o.transient_store).to be_nil
+    end
+
+    it "uses the provided method" do
+      o = ProvidedState.new
+      o.release
+      expect(o.transient_store).to eql :beta
+    end
+
+    it "uses the persistence storage" do
+      o = PersistedState.new
+      o.release
+      expect(o.transient_store).to be_nil
+    end
+
+    it "uses the provided method even if persisted" do
+      o = ProvidedAndPersistedState.new
+      o.release
+      expect(o.transient_store).to eql :beta
+    end
+  end
+end

data/spec/unit/basic_two_state_machines_example_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe 'on initialization' do
+  let(:example) { BasicTwoStateMachinesExample.new }
+
+  it 'should be in the initial state' do
+    expect(example.aasm(:search).current_state).to eql :initialised
+    expect(example.aasm(:sync).current_state).to eql :unsynced
+  end
+end