aasm 5.1.0 → 5.2.0

data/spec/database.rb

@@ -5,17 +5,10 @@ ActiveRecord::Migration.suppress_messages do
     end
   end
 
-  ActiveRecord::Migration.create_table "simple_new_dsls", :force => true do |t|
-    t.string "status"
-  end
-  ActiveRecord::Migration.create_table "multiple_simple_new_dsls", :force => true do |t|
-    t.string "status"
-  end
-  ActiveRecord::Migration.create_table "implemented_abstract_class_dsls", :force => true do |t|
-    t.string "status"
-  end
-  ActiveRecord::Migration.create_table "users", :force => true do |t|
-    t.string "status"
+  %w(simple_new_dsls multiple_simple_new_dsls implemented_abstract_class_dsls users multiple_namespaceds).each do |table_name|
+    ActiveRecord::Migration.create_table table_name, :force => true do |t|
+      t.string "status"
+    end
   end
 
   ActiveRecord::Migration.create_table "complex_active_record_examples", :force => true do |t|
@@ -56,4 +49,9 @@ ActiveRecord::Migration.suppress_messages do
     t.string "state"
     t.string "some_string"
   end
+
+  ActiveRecord::Migration.create_table "timestamp_examples", :force => true do |t|
+    t.string "aasm_state"
+    t.datetime "opened_at"
+  end
 end

data/spec/en.yml

@@ -4,9 +4,6 @@ en:
       localizer_test_model:
         close: "Let's close it!"
 
-    attributes:
-      localizer_test_model:
-        aasm_state/opened: "It's open now!"
     errors:
       messages:
         record_invalid: "Invalid record"

data/spec/{en_deprecated_style.yml → localizer_test_model_deprecated_style.yml}

@@ -1,10 +1,13 @@
 en:
   activerecord:
-    events:
+    attributes:
       localizer_test_model:
-        close: "Let's close it!"
+        aasm_state:
+          opened: "It's open now!"
 
+fr:
+  activerecord:
     attributes:
       localizer_test_model:
         aasm_state:
-          opened: "It's open now!"
+          opened: "C'est ouvert maintenant!"

data/spec/localizer_test_model_new_style.yml

@@ -0,0 +1,11 @@
+en:
+  activerecord:
+    attributes:
+      localizer_test_model:
+        aasm_state/opened: "It's open now!"
+
+fr:
+  activerecord:
+    attributes:
+      localizer_test_model:
+        aasm_state/opened: "C'est ouvert maintenant!"

data/spec/models/active_record/localizer_test_model.rb

@@ -11,24 +11,32 @@ end
 
 describe 'localized state names' do
   before(:all) do
-    I18n.load_path << 'spec/en.yml'
-    I18n.default_locale = :en
+    I18n.load_path << 'spec/localizer_test_model_new_style.yml'
     I18n.reload!
   end
 
   after(:all) do
-    I18n.load_path.clear
+    I18n.load_path.delete('spec/localizer_test_model_new_style.yml')
+    I18n.backend.load_translations
   end
 
   it 'should localize' do
     state = LocalizerTestModel.aasm.states.detect {|s| s == :opened}
     expect(state.localized_name).to eq("It's open now!")
     expect(state.human_name).to eq("It's open now!")
+    expect(state.display_name).to eq("It's open now!")
+
+    I18n.with_locale(:fr) do
+      expect(state.localized_name).to eq("C'est ouvert maintenant!")
+      expect(state.human_name).to eq("C'est ouvert maintenant!")
+      expect(state.display_name).to eq("C'est ouvert maintenant!")
+    end
   end
 
   it 'should use fallback' do
     state = LocalizerTestModel.aasm.states.detect {|s| s == :closed}
     expect(state.localized_name).to eq('Closed')
     expect(state.human_name).to eq('Closed')
+    expect(state.display_name).to eq('Closed')
   end
 end

data/spec/models/active_record/namespaced.rb

@@ -0,0 +1,16 @@
+class MultipleNamespaced < ActiveRecord::Base
+  include AASM
+
+  aasm(:status, namespace: :car) do
+    state :unsold, initial: true
+    state :sold
+
+    event :sell do
+      transitions from: :unsold, to: :sold
+    end
+
+    event :return do
+      transitions from: :sold, to: :unsold
+    end
+  end
+end

data/spec/models/active_record/timestamp_example.rb

@@ -0,0 +1,16 @@
+class TimestampExample < ActiveRecord::Base
+  include AASM
+
+  aasm column: :aasm_state, 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/default_state.rb

@@ -2,7 +2,7 @@ class DefaultState
   attr_accessor :transient_store, :persisted_store
   include AASM
   aasm do
-    state :alpha, :initial => true
+    state :alpha, :initial => true, display: 'ALPHA'
     state :beta
     state :gamma
     event :release do

data/spec/models/mongoid/timestamp_example_mongoid.rb

@@ -0,0 +1,20 @@
+class TimestampExampleMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :status, type: String
+  field :opened_at, type: Time
+
+  aasm column: :status, 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_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/spec_helper.rb

@@ -13,6 +13,7 @@ $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'
@@ -34,3 +35,7 @@ Dir[File.dirname(__FILE__) + "/spec_helpers/**/*.rb"].sort.each { |f| require Fi
 
 # 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/unit/api_spec.rb

@@ -13,6 +13,10 @@ if defined?(ActiveRecord)
       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

data/spec/unit/inspection_multiple_spec.rb

@@ -166,11 +166,15 @@ describe "special cases" do
 end
 
 describe 'aasm.states_for_select' do
-  it "should return a select friendly array of states" do
-    expect(FooMultiple.aasm(:left)).to respond_to(:states_for_select)
-    expect(FooMultiple.aasm(:left).states_for_select).to eq(
-      [['Open', 'open'], ['Closed', 'closed'], ['Final', 'final']]
-    )
+  context 'without I18n' do
+    before { allow(Module).to receive(:const_defined?).with(:I18n).and_return(nil) }
+
+    it "should return a select friendly array of states" do
+      expect(FooMultiple.aasm(:left)).to respond_to(:states_for_select)
+      expect(FooMultiple.aasm(:left).states_for_select).to eq(
+        [['Open', 'open'], ['Closed', 'closed'], ['Final', 'final']]
+      )
+    end
   end
 end
 

data/spec/unit/inspection_spec.rb

@@ -102,9 +102,13 @@ describe "special cases" do
 end
 
 describe 'aasm.states_for_select' do
-  it "should return a select friendly array of states" do
-    expect(Foo.aasm).to respond_to(:states_for_select)
-    expect(Foo.aasm.states_for_select).to eq([['Open', 'open'], ['Closed', 'closed'], ['Final', 'final']])
+  context 'without I18n' do
+    before { allow(Module).to receive(:const_defined?).with(:I18n).and_return(nil) }
+
+    it "should return a select friendly array of states" do
+      expect(Foo.aasm).to respond_to(:states_for_select)
+      expect(Foo.aasm.states_for_select).to eq([['Open', 'open'], ['Closed', 'closed'], ['Final', 'final']])
+    end
   end
 end
 

data/spec/unit/localizer_spec.rb

@@ -1,20 +1,18 @@
 require 'spec_helper'
 
-if defined?(ActiceRecord)
-  require 'i18n'
-
-  I18n.enforce_available_locales = false
+if defined?(ActiveRecord)
+  require 'models/active_record/localizer_test_model'
   load_schema
 
   describe AASM::Localizer, "new style" do
     before(:all) do
-      I18n.load_path << 'spec/en.yml'
-      I18n.default_locale = :en
+      I18n.load_path << 'spec/localizer_test_model_new_style.yml'
       I18n.reload!
     end
 
     after(:all) do
-      I18n.load_path.clear
+      I18n.load_path.delete('spec/localizer_test_model_new_style.yml')
+      I18n.backend.load_translations
     end
 
     let (:foo_opened) { LocalizerTestModel.new }
@@ -31,25 +29,42 @@ if defined?(ActiceRecord)
     end
 
     context 'aasm.human_event_name' do
-      it 'should return translated event name' do
-        expect(LocalizerTestModel.aasm.human_event_name(:close)).to eq("Let's close it!")
+      context 'with event name' do
+        it 'should return translated event name' do
+          expect(LocalizerTestModel.aasm.human_event_name(:close)).to eq("Let's close it!")
+        end
+
+        it 'should return humanized event name' do
+          expect(LocalizerTestModel.aasm.human_event_name(:open)).to eq("Open")
+        end
       end
 
-      it 'should return humanized event name' do
-        expect(LocalizerTestModel.aasm.human_event_name(:open)).to eq("Open")
+      context 'with event object' do
+        it 'should return translated event name' do
+          event = LocalizerTestModel.aasm.events.detect { |e| e.name == :close }
+
+          expect(LocalizerTestModel.aasm.human_event_name(event)).to eq("Let's close it!")
+        end
+
+        it 'should return humanized event name' do
+          event = LocalizerTestModel.aasm.events.detect { |e| e.name == :open }
+
+          expect(LocalizerTestModel.aasm.human_event_name(event)).to eq("Open")
+        end
       end
     end
   end
 
   describe AASM::Localizer, "deprecated style" do
     before(:all) do
-      I18n.load_path << 'spec/en_deprecated_style.yml'
-      I18n.default_locale = :en
+      I18n.load_path << 'spec/localizer_test_model_deprecated_style.yml'
       I18n.reload!
+      I18n.backend.load_translations
     end
 
     after(:all) do
-      I18n.load_path.clear
+      I18n.load_path.delete('spec/localizer_test_model_deprecated_style.yml')
+      I18n.backend.load_translations
     end
 
     let (:foo_opened) { LocalizerTestModel.new }
@@ -66,12 +81,28 @@ if defined?(ActiceRecord)
     end
 
     context 'aasm.human_event_name' do
-      it 'should return translated event name' do
-        expect(LocalizerTestModel.aasm.human_event_name(:close)).to eq("Let's close it!")
+      context 'with event name' do
+        it 'should return translated event name' do
+          expect(LocalizerTestModel.aasm.human_event_name(:close)).to eq("Let's close it!")
+        end
+
+        it 'should return humanized event name' do
+          expect(LocalizerTestModel.aasm.human_event_name(:open)).to eq("Open")
+        end
       end
 
-      it 'should return humanized event name' do
-        expect(LocalizerTestModel.aasm.human_event_name(:open)).to eq("Open")
+      context 'with event object' do
+        it 'should return translated event name' do
+          event = LocalizerTestModel.aasm.events.detect { |e| e.name == :close }
+
+          expect(LocalizerTestModel.aasm.human_event_name(event)).to eq("Let's close it!")
+        end
+
+        it 'should return humanized event name' do
+          event = LocalizerTestModel.aasm.events.detect { |e| e.name == :open }
+
+          expect(LocalizerTestModel.aasm.human_event_name(event)).to eq("Open")
+        end
       end
     end
   end

data/spec/unit/persistence/active_record_persistence_multiple_spec.rb

@@ -331,6 +331,23 @@ if defined?(ActiveRecord)
         expect(MultipleSimpleNewDsl.unknown_scope).to contain_exactly(dsl2)
       end
     end
+
+    context "when namespeced" do
+      it "add namespaced scopes" do
+        expect(MultipleNamespaced).to respond_to(:car_unsold)
+        expect(MultipleNamespaced).to respond_to(:car_sold)
+
+        expect(MultipleNamespaced.car_unsold.is_a?(ActiveRecord::Relation)).to be_truthy
+        expect(MultipleNamespaced.car_sold.is_a?(ActiveRecord::Relation)).to be_truthy
+      end
+      it "add unnamespaced scopes" do
+        expect(MultipleNamespaced).to respond_to(:unsold)
+        expect(MultipleNamespaced).to respond_to(:sold)
+
+        expect(MultipleNamespaced.unsold.is_a?(ActiveRecord::Relation)).to be_truthy
+        expect(MultipleNamespaced.sold.is_a?(ActiveRecord::Relation)).to be_truthy
+      end
+    end
   end # scopes
 
   describe "direct assignment" do

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -837,4 +837,16 @@ if defined?(ActiveRecord)
       expect(example.complete!).to be_falsey
     end
   end
+
+  describe 'testing the timestamps option' do
+    let(:example) { TimestampExample.create! }
+
+    it 'should update existing timestamp columns' do
+      expect { example.open! }.to change { example.reload.opened_at }.from(nil).to(instance_of(::Time))
+    end
+
+    it 'should not fail if there is no corresponding timestamp column' do
+      expect { example.close! }.to change { example.reload.aasm_state }
+    end
+  end
 end

data/spec/unit/persistence/mongoid_persistence_spec.rb

@@ -161,5 +161,17 @@ if defined?(Mongoid::Document)
       end
     end
 
+    describe 'testing the timestamps option' do
+      let(:example) { TimestampExampleMongoid.create }
+
+      it 'should update existing timestamp fields' do
+        expect { example.open! }.to change { example.reload.opened_at }.from(nil).to(instance_of(::Time))
+      end
+
+      it 'should not fail if there is no corresponding timestamp field' do
+        expect { example.close! }.to change { example.reload.status }
+      end
+    end
+
   end
 end

data/spec/unit/state_spec.rb

@@ -17,12 +17,28 @@ describe AASM::Core::State do
     expect(state.name).to eq(:astate)
   end
 
-  it 'should set the display_name from name' do
-    expect(new_state.display_name).to eq('Astate')
-  end
+  describe '#display_name' do
+    subject(:display_name) { new_state(options).display_name }
+
+    context 'without options' do
+      let(:options) { {} }
+
+      context 'without I18n' do
+        before { allow(Module).to receive(:const_defined?).with(:I18n).and_return(nil) }
+
+        it 'should set the display_name from name' do
+          expect(display_name).to eq('Astate')
+        end
+      end
+    end
+
+    context 'with :display option' do
+      let(:options) { { display: "A State" } }
 
-  it 'should set the display_name from options' do
-    expect(new_state(:display => "A State").display_name).to eq('A State')
+      it 'should set the display_name from options' do
+        expect(display_name).to eq('A State')
+      end
+    end
   end
 
   it 'should set the options and expose them as options' do

data/spec/unit/timestamps_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'timestamps option' do
+  it 'calls a timestamp setter based on the state name when entering a new state' do
+    object = TimestampsExample.new
+    expect { object.open }.to change { object.opened_at }.from(nil).to(instance_of(::Time))
+  end
+
+  it 'overwrites any previous timestamp if a state is entered repeatedly' do
+    object = TimestampsExample.new
+    object.opened_at = ::Time.new(2000, 1, 1)
+    expect { object.open }.to change { object.opened_at }
+  end
+
+  it 'does nothing if there is no setter matching the new state' do
+    object = TimestampsExample.new
+    expect { object.close }.not_to change { object.closed_at }
+  end
+
+  it 'can be turned off and on' do
+    object = TimestampsExample.new
+    object.class.aasm.state_machine.config.timestamps = false
+    expect { object.open }.not_to change { object.opened_at }
+    object.class.aasm.state_machine.config.timestamps = true
+    expect { object.open }.to change { object.opened_at }
+  end
+
+  it 'calls a timestamp setter when using a named state machine' do
+    object = TimestampsWithNamedMachineExample.new
+    expect { object.open }.to change { object.opened_at }.from(nil).to(instance_of(::Time))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Thorsten Boettger
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-01 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -115,20 +115,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.17
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.1.20
+        version: 0.1.21
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.17
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.1.20
+        version: 0.1.21
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -232,10 +226,11 @@ files:
 - spec/database.rb
 - spec/database.yml
 - spec/en.yml
-- spec/en_deprecated_style.yml
 - spec/generators/active_record_generator_spec.rb
 - spec/generators/mongoid_generator_spec.rb
 - spec/generators/no_brainer_generator_spec.rb
+- spec/localizer_test_model_deprecated_style.yml
+- spec/localizer_test_model_new_style.yml
 - spec/models/active_record/active_record_callback.rb
 - spec/models/active_record/basic_active_record_two_state_machines_example.rb
 - spec/models/active_record/complex_active_record_example.rb
@@ -245,6 +240,7 @@ files:
 - spec/models/active_record/instance_level_skip_validation_example.rb
 - spec/models/active_record/invalid_persistor.rb
 - spec/models/active_record/localizer_test_model.rb
+- spec/models/active_record/namespaced.rb
 - spec/models/active_record/no_direct_assignment.rb
 - spec/models/active_record/no_scope.rb
 - spec/models/active_record/persisted_state.rb
@@ -255,6 +251,7 @@ files:
 - spec/models/active_record/silent_persistor.rb
 - spec/models/active_record/simple_new_dsl.rb
 - spec/models/active_record/thief.rb
+- spec/models/active_record/timestamp_example.rb
 - spec/models/active_record/transactor.rb
 - spec/models/active_record/transient.rb
 - spec/models/active_record/validator.rb
@@ -301,6 +298,7 @@ files:
 - spec/models/mongoid/silent_persistor_mongoid.rb
 - spec/models/mongoid/simple_mongoid.rb
 - spec/models/mongoid/simple_new_dsl_mongoid.rb
+- spec/models/mongoid/timestamp_example_mongoid.rb
 - spec/models/mongoid/validator_mongoid.rb
 - spec/models/multi_transitioner.rb
 - spec/models/multiple_transitions_that_differ_only_by_guard.rb
@@ -342,6 +340,8 @@ files:
 - spec/models/sub_classing.rb
 - spec/models/super_class.rb
 - spec/models/this_name_better_not_be_in_use.rb
+- spec/models/timestamps_example.rb
+- spec/models/timestamps_with_named_machine_example.rb
 - spec/models/valid_state_name.rb
 - spec/spec_helper.rb
 - spec/spec_helpers/active_record.rb
@@ -406,6 +406,7 @@ files:
 - spec/unit/states_on_one_line_example_spec.rb
 - spec/unit/subclassing_multiple_spec.rb
 - spec/unit/subclassing_spec.rb
+- spec/unit/timestamps_spec.rb
 - spec/unit/transition_spec.rb
 - test/minitest_helper.rb
 - test/unit/minitest_matcher_test.rb
@@ -436,10 +437,11 @@ test_files:
 - spec/database.rb
 - spec/database.yml
 - spec/en.yml
-- spec/en_deprecated_style.yml
 - spec/generators/active_record_generator_spec.rb
 - spec/generators/mongoid_generator_spec.rb
 - spec/generators/no_brainer_generator_spec.rb
+- spec/localizer_test_model_deprecated_style.yml
+- spec/localizer_test_model_new_style.yml
 - spec/models/active_record/active_record_callback.rb
 - spec/models/active_record/basic_active_record_two_state_machines_example.rb
 - spec/models/active_record/complex_active_record_example.rb
@@ -449,6 +451,7 @@ test_files:
 - spec/models/active_record/instance_level_skip_validation_example.rb
 - spec/models/active_record/invalid_persistor.rb
 - spec/models/active_record/localizer_test_model.rb
+- spec/models/active_record/namespaced.rb
 - spec/models/active_record/no_direct_assignment.rb
 - spec/models/active_record/no_scope.rb
 - spec/models/active_record/persisted_state.rb
@@ -459,6 +462,7 @@ test_files:
 - spec/models/active_record/silent_persistor.rb
 - spec/models/active_record/simple_new_dsl.rb
 - spec/models/active_record/thief.rb
+- spec/models/active_record/timestamp_example.rb
 - spec/models/active_record/transactor.rb
 - spec/models/active_record/transient.rb
 - spec/models/active_record/validator.rb
@@ -505,6 +509,7 @@ test_files:
 - spec/models/mongoid/silent_persistor_mongoid.rb
 - spec/models/mongoid/simple_mongoid.rb
 - spec/models/mongoid/simple_new_dsl_mongoid.rb
+- spec/models/mongoid/timestamp_example_mongoid.rb
 - spec/models/mongoid/validator_mongoid.rb
 - spec/models/multi_transitioner.rb
 - spec/models/multiple_transitions_that_differ_only_by_guard.rb
@@ -546,6 +551,8 @@ test_files:
 - spec/models/sub_classing.rb
 - spec/models/super_class.rb
 - spec/models/this_name_better_not_be_in_use.rb
+- spec/models/timestamps_example.rb
+- spec/models/timestamps_with_named_machine_example.rb
 - spec/models/valid_state_name.rb
 - spec/spec_helper.rb
 - spec/spec_helpers/active_record.rb
@@ -610,6 +617,7 @@ test_files:
 - spec/unit/states_on_one_line_example_spec.rb
 - spec/unit/subclassing_multiple_spec.rb
 - spec/unit/subclassing_spec.rb
+- spec/unit/timestamps_spec.rb
 - spec/unit/transition_spec.rb
 - test/minitest_helper.rb
 - test/unit/minitest_matcher_test.rb