aasm 5.1.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f4099a66f8d753c2bd7c06b3c378dcd37b47acf9b2f7487784e7762742c1c4
-  data.tar.gz: 8971b36f1b066c08d3a4d278a99d7c1e5386be72182da62b51a82db1e60e9e9f
+  metadata.gz: 6e3ec7032fd9c8368ddfb4bed4e931edc5f9d96c02a69f89f7ee26913f7d8698
+  data.tar.gz: ddb4ef39501440da1869426eda3b4359e37eeef67b464c9e0d660e9f353510f6
 SHA512:
-  metadata.gz: c24e544b82cfc4616f3e3ff033b7a5ab68bff7bd834b115797e9127ca361effe241ffb1adaedcdb595711a6757f2e0a8e0a8d606a9bc812c28707a1ee845ef40
-  data.tar.gz: 421636d1e59e52b8d6b4ddff7dd373fecd9a19ef67b90935e856b1ee980bae9a5a4a8526e62238de9ecc84a7783362e8d5b2005c53b9c7754368be79724c6255
+  metadata.gz: c294de071cad6569f855af1455c9d0281622ca5c9a3df0466baacaca569d8974718eb46d4c06e674f54629a77e2634d69829ee2910612ba146b4aaf786891544
+  data.tar.gz: a7b0c176cec262ad9d89538fe43e6df484f4d79328f85e853dcc9fe6b6ce9a9629f802e7de14659e5c91135a3a4df09a6066011983b1936eff06b17657c24cc5

data/Appraisals

@@ -8,7 +8,7 @@ appraise 'rails_4.2' do
   gem 'aws-sdk', '~> 2', platforms: :ruby
   gem 'redis-objects'
   gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
-  gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'rails_4.2_nobrainer' do
@@ -21,7 +21,7 @@ appraise 'rails_4.2_mongoid_5' do
   gem 'rails', '4.2.5'
   gem 'mongoid', '~> 5.0'
   gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
-  gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'rails_5.0' do
@@ -31,7 +31,7 @@ appraise 'rails_5.0' do
   gem 'dynamoid', '~> 1.3', platforms: :ruby
   gem 'aws-sdk', '~> 2', platforms: :ruby
   gem 'redis-objects'
-  gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'rails_5.0_nobrainer' do
@@ -46,7 +46,7 @@ appraise 'rails_5.1' do
   gem 'dynamoid', '~> 1.3', platforms: :ruby
   gem 'aws-sdk', '~>2', platforms: :ruby
   gem 'redis-objects'
-  gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'rails_5.2' do
@@ -56,7 +56,7 @@ appraise 'rails_5.2' do
   gem 'dynamoid', '~>2.2', platforms: :ruby
   gem 'aws-sdk', '~>2', platforms: :ruby
   gem 'redis-objects'
-  gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'norails' do

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # CHANGELOG
 
 ## unreleased
-
-## 5.1.0
+## 5.2.0
+
+* fix: timestamp will work with named machine [#739](https://github.com/aasm/aasm/pull/739), thanks to [RolandStuder](https://github.com/RolandStuder)
+* Create namespaced scopes in PR [#735](https://github.com/aasm/aasm/pull/735), thanks to [caiohsramos](https://github.com/caiohsramos)
+* Fix multiple state machines example per class on README in PR [#732](https://github.com/aasm/aasm/pull/732), thanks to [RodrigoVitiello](https://github.com/RodrigoVitiello)
+* Update version in recommendation to add after_commit_everywhere in PR [#729](https://github.com/aasm/aasm/pull/729), thanks to [Envek](https://github.com/Envek)
+* Fix i18n Event translations failing [#721](https://github.com/aasm/aasm/issues/721) in PR [#723](https://github.com/aasm/aasm/pull/723), thanks to [the-spectator](https://github.com/the-spectator)
+* Add documentation to the Readme about how parameters are handled in AASM events in PR [#722](https://github.com/aasm/aasm/pull/722), thanks to [dstuebe](https://github.com/dstuebe)
+* Fix human_state cached across locales [#709](https://github.com/aasm/aasm/issues/709) in PR [716](https://github.com/aasm/aasm/pull/716), thanks to [the-spectator](https://github.com/the-spectator)
+* Relocate DslHelper from root namespace to under AASM namespace in PR [#711](https://github.com/aasm/aasm/pull/711) thank to [yujideveloper ](https://github.com/yujideveloper )
+* Document how to define transitions from any state in in PR [#699](https://github.com/aasm/aasm/pull/699) thanks to [hedgesky](https://github.com/hedgesky)
+* Add simple option for auto-generated timestamps in PR [#677](https://github.com/aasm/aasm/pull/677), thanks to [jaynetics](https://github.com/jaynetics)
+## 5.1.1
 
 * Fix Depreciation message for after_commit_everywhere [#695](https://github.com/aasm/aasm/issues/695) in PR [#696](https://github.com/aasm/aasm/pull/696)
 * Fix human_state to use display option [#684](https://github.com/aasm/aasm/issues/684) in PR [#697](https://github.com/aasm/aasm/pull/697)

data/README.md

@@ -20,6 +20,7 @@
   - [Extending AASM](#extending-aasm)
   - [ActiveRecord](#activerecord)
   - [Bang events](#bang-events)
+  - [Timestamps](#timestamps)
   - [ActiveRecord enums](#activerecord-enums)
   - [Sequel](#sequel)
   - [Dynamoid](#dynamoid)
@@ -212,15 +213,28 @@ class LogRunTime
 end
 ```
 
-Also, you can pass parameters to events:
+#### Parameters
+You can pass parameters to events:
 
 ```ruby
   job = Job.new
   job.run(:defragmentation)
 ```
 
-In this case the `set_process` would be called with `:defragmentation` argument.
+All guards and after callbacks will receive these parameters. In this case `set_process` would be called with 
+`:defragmentation` argument.
 
+If the first argument to the event is a state (e.g. `:running` or `:finished`), the first argument is consumed and 
+the state machine will attempt to transition to that state. Add comma separated parameter for gaurds and callbacks
+
+```ruby
+  job = Job.new
+  job.run(:running, :defragmentation)
+```
+In this case `set_process` won't be called, job will transition to running state and callback will receive 
+:defragmentation as parameter
+
+#### Error Handling
 In case of an error during the event processing the error is rescued and passed to `:error`
 callback, which can handle it or re-raise it for further propagation.
 
@@ -434,6 +448,14 @@ job.stage1_completed
 job.aasm.current_state # stage3
 ```
 
+You can define transition from any defined state by omitting `from`:
+
+```ruby
+event :abort do
+  transitions to: :aborted
+end
+```
+
 ### Display name for state
 
 You can define display name for state using :display option
@@ -495,13 +517,13 @@ simple = SimpleMultipleExample.new
 
 simple.aasm(:move).current_state
 # => :standing
-simple.aasm(:work).current
+simple.aasm(:work).current_state
 # => :sleeping
 
 simple.start
 simple.aasm(:move).current_state
 # => :standing
-simple.aasm(:work).current
+simple.aasm(:work).current_state
 # => :processing
 
 ```
@@ -698,7 +720,7 @@ end
 AASM comes with support for ActiveRecord and allows automatic persisting of the object's
 state in the database.
 
-Add `gem 'after_commit_everywhere', '~> 0.1', '>= 0.1.5'` to your Gemfile 
+Add `gem 'after_commit_everywhere', '~> 1.0'` to your Gemfile.
 
 ```ruby
 class Job < ActiveRecord::Base
@@ -800,6 +822,37 @@ job.aasm_state = :running # => raises AASM::NoDirectAssignmentError
 job.aasm_state # => 'sleeping'
 ```
 
+### Timestamps
+
+You can tell _AASM_ to try to write a timestamp whenever a new state is entered.
+If `timestamps: true` is set, _AASM_ will look for a field named like the new state plus `_at` and try to fill it:
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm timestamps: true do
+    state :sleeping, initial: true
+    state :running
+
+    event :run do
+      transitions from: :sleeping, to: :running
+    end
+  end
+end
+```
+
+resulting in this:
+
+```ruby
+job = Job.create
+job.running_at # => nil
+job.run!
+job.running_at # => 2020-02-20 20:00:00
+```
+
+Missing timestamp fields are silently ignored, so it is not necessary to have setters (such as ActiveRecord columns) for *all* states when using this option.
+
 #### ActiveRecord enums
 
 You can use
@@ -1007,7 +1060,7 @@ job.save! #notify_about_running_job is not run
 Please note that `:after_commit` AASM callbacks behaves around custom implementation
 of transaction pattern rather than a real-life DB transaction. This fact still causes
 the race conditions and redundant callback calls within nested transaction. In order
-to fix that it's highly recommended to add `gem 'after_commit_everywhere', '~> 0.1', '>= 0.1.5'`
+to fix that it's highly recommended to add `gem 'after_commit_everywhere', '~> 1.0'`
 to your `Gemfile`.
 
 If you want to encapsulate state changes within an own transaction, the behavior

data/aasm.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'generator_spec'
   s.add_development_dependency 'appraisal'
   s.add_development_dependency "simplecov"
-  s.add_development_dependency "codecov", ">= 0.1.17", '< 0.1.20'
+  s.add_development_dependency "codecov", ">= 0.1.21"
 
   # debugging
   # s.add_development_dependency 'debugger'

data/gemfiles/rails_4.2.gemfile

@@ -12,6 +12,6 @@ gem "dynamoid", "~> 1", platforms: :ruby
 gem "aws-sdk", "~> 2", platforms: :ruby
 gem "redis-objects"
 gem "activerecord-jdbcsqlite3-adapter", "1.3.24", platforms: :jruby
-gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+gem "after_commit_everywhere", "~> 1.0"
 
 gemspec path: "../"

data/gemfiles/rails_4.2_mongoid_5.gemfile

@@ -7,6 +7,6 @@ gem "rails", "4.2.5"
 gem "mime-types", "~> 2", platforms: [:ruby_19, :jruby]
 gem "mongoid", "~> 5.0"
 gem "activerecord-jdbcsqlite3-adapter", "1.3.24", platforms: :jruby
-gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+gem "after_commit_everywhere", "~> 1.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -9,6 +9,6 @@ gem "sequel"
 gem "dynamoid", "~> 1.3", platforms: :ruby
 gem "aws-sdk", "~> 2", platforms: :ruby
 gem "redis-objects"
-gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+gem "after_commit_everywhere", "~> 1.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -9,6 +9,6 @@ gem "sequel"
 gem "dynamoid", "~> 1.3", platforms: :ruby
 gem "aws-sdk", "~>2", platforms: :ruby
 gem "redis-objects"
-gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+gem "after_commit_everywhere", "~> 1.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -9,6 +9,6 @@ gem "sequel"
 gem "dynamoid", "~>2.2", platforms: :ruby
 gem "aws-sdk", "~>2", platforms: :ruby
 gem "redis-objects"
-gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
+gem "after_commit_everywhere", "~> 1.0"
 
 gemspec path: "../"

data/lib/aasm/base.rb

@@ -37,6 +37,9 @@ module AASM
       # string for a specific lock type i.e. FOR UPDATE NOWAIT
       configure :requires_lock, false
 
+      # automatically set `"#{state_name}_at" = ::Time.now` on state changes
+      configure :timestamps, false
+
       # set to true to forbid direct assignment of aasm_state column (in ActiveRecord)
       configure :no_direct_assignment, false
 
@@ -51,19 +54,12 @@ module AASM
       # Configure a logger, with default being a Logger to STDERR
       configure :logger, Logger.new(STDERR)
 
+      # setup timestamp-setting callback if enabled
+      setup_timestamps(@name)
+
       # make sure to raise an error if no_direct_assignment is enabled
       # and attribute is directly assigned though
-      aasm_name = @name
-
-      if @state_machine.config.no_direct_assignment
-        @klass.send(:define_method, "#{@state_machine.config.column}=") do |state_name|
-          if self.class.aasm(:"#{aasm_name}").state_machine.config.no_direct_assignment
-            raise AASM::NoDirectAssignmentError.new('direct assignment of AASM column has been disabled (see AASM configuration for this class)')
-          else
-            super(state_name)
-          end
-        end
-      end
+      setup_no_direct_assignment(@name)
     end
 
     # This method is both a getter and a setter
@@ -267,5 +263,28 @@ module AASM
       end
     end
 
+    def setup_timestamps(aasm_name)
+      return unless @state_machine.config.timestamps
+
+      after_all_transitions do
+        if self.class.aasm(:"#{aasm_name}").state_machine.config.timestamps
+          ts_setter = "#{aasm(aasm_name).to_state}_at="
+          respond_to?(ts_setter) && send(ts_setter, ::Time.now)
+        end
+      end
+    end
+
+    def setup_no_direct_assignment(aasm_name)
+      return unless @state_machine.config.no_direct_assignment
+
+      @klass.send(:define_method, "#{@state_machine.config.column}=") do |state_name|
+        if self.class.aasm(:"#{aasm_name}").state_machine.config.no_direct_assignment
+          raise AASM::NoDirectAssignmentError.new('direct assignment of AASM column has been disabled (see AASM configuration for this class)')
+        else
+          super(state_name)
+        end
+      end
+    end
+
   end
 end

data/lib/aasm/configuration.rb

@@ -24,6 +24,9 @@ module AASM
     # for ActiveRecord: use pessimistic locking
     attr_accessor :requires_lock
 
+    # automatically set `"#{state_name}_at" = ::Time.now` on state changes
+    attr_accessor :timestamps
+
     # forbid direct assignment in aasm_state column (in ActiveRecord)
     attr_accessor :no_direct_assignment
 

data/lib/aasm/core/event.rb

@@ -2,9 +2,9 @@
 
 module AASM::Core
   class Event
-    include DslHelper
+    include AASM::DslHelper
 
-    attr_reader :name, :state_machine, :options
+    attr_reader :name, :state_machine, :options, :default_display_name
 
     def initialize(name, state_machine, options = {}, &block)
       @name = name
@@ -13,6 +13,7 @@ module AASM::Core
       @valid_transitions = {}
       @guards = Array(options[:guard] || options[:guards] || options[:if])
       @unless = Array(options[:unless]) #TODO: This could use a better name
+      @default_display_name = name.to_s.gsub(/_/, ' ').capitalize
 
       # from aasm4
       @options = options # QUESTION: .dup ?
@@ -109,6 +110,10 @@ module AASM::Core
       transitions.flat_map(&:failures)
     end
 
+    def to_s
+      name.to_s
+    end
+
   private
 
     def attach_event_guards(definitions)

data/lib/aasm/core/state.rb

@@ -2,12 +2,13 @@
 
 module AASM::Core
   class State
-    attr_reader :name, :state_machine, :options
+    attr_reader :name, :state_machine, :options, :default_display_name
 
     def initialize(name, klass, state_machine, options={})
       @name = name
       @klass = klass
       @state_machine = state_machine
+      @default_display_name = name.to_s.gsub(/_/, ' ').capitalize
       update(options)
     end
 
@@ -54,11 +55,11 @@ module AASM::Core
     end
 
     def display_name
-      @display_name ||= begin
+      @display_name = begin
         if Module.const_defined?(:I18n)
           localized_name
         else
-          name.to_s.gsub(/_/, ' ').capitalize
+          @default_display_name
         end
       end
     end
@@ -75,8 +76,8 @@ module AASM::Core
   private
 
     def update(options = {})
-      if options.key?(:display) then
-        @display_name = options.delete(:display)
+      if options.key?(:display)
+        @default_display_name = options.delete(:display)
       end
       @options = options
       self

data/lib/aasm/core/transition.rb

@@ -2,7 +2,7 @@
 
 module AASM::Core
   class Transition
-    include DslHelper
+    include AASM::DslHelper
 
     attr_reader :from, :to, :event, :opts, :failures
     alias_method :options, :opts

data/lib/aasm/dsl_helper.rb

@@ -1,30 +1,32 @@
-module DslHelper
+module AASM
+  module DslHelper
 
-  class Proxy
-    attr_accessor :options
+    class Proxy
+      attr_accessor :options
 
-    def initialize(options, valid_keys, source)
-      @valid_keys = valid_keys
-      @source = source
+      def initialize(options, valid_keys, source)
+        @valid_keys = valid_keys
+        @source = source
 
-      @options = options
-    end
+        @options = options
+      end
 
-    def method_missing(name, *args, &block)
-      if @valid_keys.include?(name)
-        options[name] = Array(options[name])
-        options[name] << block if block
-        options[name] += Array(args)
-      else
-        @source.send name, *args, &block
+      def method_missing(name, *args, &block)
+        if @valid_keys.include?(name)
+          options[name] = Array(options[name])
+          options[name] << block if block
+          options[name] += Array(args)
+        else
+          @source.send name, *args, &block
+        end
       end
     end
-  end
 
-  def add_options_from_dsl(options, valid_keys, &block)
-    proxy = Proxy.new(options, valid_keys, self)
-    proxy.instance_eval(&block)
-    proxy.options
-  end
+    def add_options_from_dsl(options, valid_keys, &block)
+      proxy = Proxy.new(options, valid_keys, self)
+      proxy.instance_eval(&block)
+      proxy.options
+    end
 
-end
+  end
+end

data/lib/aasm/localizer.rb

@@ -5,7 +5,7 @@ module AASM
         list << :"#{i18n_scope(klass)}.events.#{i18n_klass(ancestor)}.#{event}"
         list
       end
-      translate_queue(checklist) || I18n.translate(checklist.shift, :default => event.to_s.humanize)
+      translate_queue(checklist) || I18n.translate(checklist.shift, :default => default_display_name(event))
     end
 
     def human_state_name(klass, state)
@@ -14,7 +14,7 @@ module AASM
         list << item_for(klass, state, ancestor, :old_style => true)
         list
       end
-      translate_queue(checklist) || I18n.translate(checklist.shift, :default => state.to_s.humanize)
+      translate_queue(checklist) || I18n.translate(checklist.shift, :default => default_display_name(state))
     end
 
   private
@@ -46,8 +46,18 @@ module AASM
     end
 
     def ancestors_list(klass)
+      has_active_record_base = defined?(::ActiveRecord::Base)
       klass.ancestors.select do |ancestor|
-        ancestor.respond_to?(:model_name) unless ancestor.name == 'ActiveRecord::Base'
+        not_active_record_base = has_active_record_base ? (ancestor != ::ActiveRecord::Base) : true
+        ancestor.respond_to?(:model_name) && not_active_record_base
+      end
+    end
+
+    def default_display_name(object) # Can use better arguement name
+      if object.respond_to?(:default_display_name)
+        object.default_display_name
+      else
+        object.to_s.gsub(/_/, ' ').capitalize
       end
     end
   end

data/lib/aasm/persistence/active_record_persistence.rb

@@ -73,7 +73,7 @@ module AASM
           rescue LoadError
             warn <<-MSG
   [DEPRECATION] :after_commit AASM callback is not safe in terms of race conditions and redundant calls.
-                Please add `gem 'after_commit_everywhere', '~> 0.1', '>= 0.1.5'` to your Gemfile in order to fix that.
+                Please add `gem 'after_commit_everywhere', '~> 1.0'` to your Gemfile in order to fix that.
             MSG
             yield
           end

data/lib/aasm/persistence/base.rb

@@ -59,7 +59,9 @@ module AASM
     # make sure to create a (named) scope for each state
     def state_with_scope(*args)
       names = state_without_scope(*args)
-      names.each { |name| create_scope(name) if create_scope?(name) }
+      names.each do |name|
+        create_scopes(name)
+      end
     end
     alias_method :state_without_scope, :state
     alias_method :state, :state_with_scope
@@ -71,7 +73,16 @@ module AASM
     end
 
     def create_scope(name)
-      @klass.aasm_create_scope(@name, name)
+      @klass.aasm_create_scope(@name, name) if create_scope?(name)
+    end
+
+    def create_scopes(name)
+      if namespace?
+        # Create default scopes even when namespace? for backward compatibility
+        namepaced_name = "#{namespace}_#{name}"
+        create_scope(namepaced_name)
+      end
+      create_scope(name)
     end
   end # Base
 

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "5.1.1"
+  VERSION = "5.2.0"
 end

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/localizer_test_model_deprecated_style.yml

@@ -4,3 +4,10 @@ en:
       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/localizer_test_model_new_style.yml

@@ -3,3 +3,9 @@ en:
     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

@@ -24,11 +24,19 @@ describe 'localized state names' 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/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/unit/localizer_spec.rb

@@ -29,12 +29,28 @@ if defined?(ActiveRecord)
     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
@@ -65,12 +81,28 @@ if defined?(ActiveRecord)
     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/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.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Thorsten Boettger
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-11 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
@@ -246,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
@@ -256,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
@@ -302,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
@@ -343,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
@@ -407,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
@@ -451,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
@@ -461,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
@@ -507,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
@@ -548,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
@@ -612,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