aasm 4.12.3 → 5.1.1

data/lib/aasm/persistence/base.rb

@@ -34,7 +34,7 @@ module AASM
       # This allows for nil aasm states - be sure to add validation to your model
       def aasm_read_state(name=:default)
         state = send(self.class.aasm(name).attribute_name)
-        if state.blank?
+        if !state || state.empty?
           aasm_new_record? ? aasm(name).determine_state_name(self.class.aasm(name).initial_state) : nil
         else
           state.to_sym

data/lib/aasm/persistence/core_data_query_persistence.rb

@@ -77,7 +77,8 @@ module AASM
         #
         def aasm_ensure_initial_state
           AASM::StateMachineStore.fetch(self.class, true).machine_names.each do |state_machine_name|
-            send("#{self.class.aasm(state_machine_name).attribute_name}=", aasm(state_machine_name).enter_initial_state.to_s) if send(self.class.aasm(state_machine_name).attribute_name).blank?
+            next if !send(self.class.aasm(state_machine_name).attribute_name) || send(self.class.aasm(state_machine_name).attribute_name).empty?
+            send("#{self.class.aasm(state_machine_name).attribute_name}=", aasm(state_machine_name).enter_initial_state.to_s)
           end
         end
       end # InstanceMethods

data/lib/aasm/persistence/dynamoid_persistence.rb

@@ -83,7 +83,7 @@ module AASM
         #
         def aasm_ensure_initial_state
           AASM::StateMachineStore.fetch(self.class, true).machine_names.each do |state_machine_name|
-            aasm(state_machine_name).enter_initial_state if send(self.class.aasm(state_machine_name).attribute_name).blank?
+            aasm(state_machine_name).enter_initial_state if !send(self.class.aasm(state_machine_name).attribute_name) || send(self.class.aasm(state_machine_name).attribute_name).empty?
           end
         end
       end # InstanceMethods

data/lib/aasm/persistence/mongoid_persistence.rb

@@ -106,7 +106,7 @@ module AASM
             # mongoid has_many relationship does not load child object attributes when
             # only ids are loaded, for example parent.child_ids will not load child object attributes.
             # This feature is introduced in mongoid > 4.
-            if attribute_names.include?(attribute_name) && attributes[attribute_name].blank?
+            if attribute_names.include?(attribute_name) && !attributes[attribute_name] || attributes[attribute_name].empty?
               # attribute_missing? is defined in mongoid > 4
               return if Mongoid::VERSION.to_f >= 4 && attribute_missing?(attribute_name)
               send("#{self.class.aasm(state_machine_name).attribute_name}=", aasm(state_machine_name).enter_initial_state.to_s)

data/lib/aasm/persistence/no_brainer_persistence.rb

@@ -0,0 +1,105 @@
+require 'aasm/persistence/orm'
+module AASM
+  module Persistence
+    module NoBrainerPersistence
+      # This method:
+      #
+      # * extends the model with ClassMethods
+      # * includes InstanceMethods
+      #
+      # Adds
+      #
+      #   before_validation :aasm_ensure_initial_state
+      #
+      # As a result, it doesn't matter when you define your methods - the following 2 are equivalent
+      #
+      #   class Foo
+      #     include NoBrainer::Document
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #     include AASM
+      #   end
+      #
+      #   class Foo
+      #     include NoBrainer::Document
+      #     include AASM
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #   end
+      #
+      def self.included(base)
+        base.send(:include, AASM::Persistence::Base)
+        base.send(:include, AASM::Persistence::ORM)
+        base.send(:include, AASM::Persistence::NoBrainerPersistence::InstanceMethods)
+        base.extend AASM::Persistence::NoBrainerPersistence::ClassMethods
+
+        base.after_initialize :aasm_ensure_initial_state
+      end
+
+      module ClassMethods
+        def aasm_create_scope(state_machine_name, scope_name)
+          scope_options = lambda {
+            where(aasm(state_machine_name).attribute_name.to_sym => scope_name.to_s)
+          }
+          send(:scope, scope_name, scope_options)
+        end
+      end
+
+      module InstanceMethods
+
+        private
+
+        def aasm_save
+          self.save
+        end
+
+        def aasm_raise_invalid_record
+          raise NoBrainer::Error::DocumentInvalid.new(self)
+        end
+
+        def aasm_supports_transactions?
+          false
+        end
+
+        def aasm_update_column(attribute_name, value)
+          write_attribute(attribute_name, value)
+          save(validate: false)
+
+          true
+        end
+
+        def aasm_read_attribute(name)
+          read_attribute(name)
+        end
+
+        def aasm_write_attribute(name, value)
+          write_attribute(name, value)
+        end
+
+        # Ensures that if the aasm_state column is nil and the record is new
+        # that the initial state gets populated before validation on create
+        #
+        #   foo = Foo.new
+        #   foo.aasm_state # => nil
+        #   foo.valid?
+        #   foo.aasm_state # => "open" (where :open is the initial state)
+        #
+        #
+        #   foo = Foo.find(:first)
+        #   foo.aasm_state # => 1
+        #   foo.aasm_state = nil
+        #   foo.valid?
+        #   foo.aasm_state # => nil
+        #
+        def aasm_ensure_initial_state
+          AASM::StateMachineStore.fetch(self.class, true).machine_names.each do |name|
+            aasm_column = self.class.aasm(name).attribute_name
+            aasm(name).enter_initial_state if !read_attribute(aasm_column) || read_attribute(aasm_column).empty?
+          end
+        end
+      end # InstanceMethods
+    end
+  end # Persistence
+end # AASM

data/lib/aasm/persistence/orm.rb

@@ -81,6 +81,10 @@ module AASM
         true
       end
 
+      def aasm_execute_after_commit
+        yield
+      end
+
       def aasm_write_state_attribute(state, name=:default)
         aasm_write_attribute(self.class.aasm(name).attribute_name, aasm_raw_attribute_value(state, name))
       end
@@ -116,32 +120,32 @@ module AASM
 
       # Returns true if event was fired successfully and transaction completed.
       def aasm_fire_event(state_machine_name, name, options, *args, &block)
-        if aasm_supports_transactions? && options[:persist]
-          event = self.class.aasm(state_machine_name).state_machine.events[name]
-          event.fire_callbacks(:before_transaction, self, *args)
-          event.fire_global_callbacks(:before_all_transactions, self, *args)
-
-          begin
-            success = if options[:persist] && use_transactions?(state_machine_name)
-              aasm_transaction(requires_new?(state_machine_name), requires_lock?(state_machine_name)) do
-                super
-              end
-            else
+        return super unless aasm_supports_transactions? && options[:persist]
+
+        event = self.class.aasm(state_machine_name).state_machine.events[name]
+        event.fire_callbacks(:before_transaction, self, *args)
+        event.fire_global_callbacks(:before_all_transactions, self, *args)
+
+        begin
+          success = if options[:persist] && use_transactions?(state_machine_name)
+            aasm_transaction(requires_new?(state_machine_name), requires_lock?(state_machine_name)) do
               super
             end
+          else
+            super
+          end
 
-            if success
+          if success && !(event.options.keys & [:after_commit, :after_all_commits]).empty?
+            aasm_execute_after_commit do
               event.fire_callbacks(:after_commit, self, *args)
               event.fire_global_callbacks(:after_all_commits, self, *args)
             end
-
-            success
-          ensure
-            event.fire_callbacks(:after_transaction, self, *args)
-            event.fire_global_callbacks(:after_all_transactions, self, *args)
           end
-        else
-          super
+
+          success
+        ensure
+          event.fire_callbacks(:after_transaction, self, *args)
+          event.fire_global_callbacks(:after_all_transactions, self, *args)
         end
       end
 

data/lib/aasm/persistence/plain_persistence.rb

@@ -5,7 +5,8 @@ module AASM
       # may be overwritten by persistence mixins
       def aasm_read_state(name=:default)
         # all the following lines behave like @current_state ||= aasm(name).enter_initial_state
-        current = aasm(name).instance_variable_get("@current_state_#{name}")
+        current = aasm(name).instance_variable_defined?("@current_state_#{name}") &&
+                  aasm(name).instance_variable_get("@current_state_#{name}")
         return current if current
         aasm(name).instance_variable_set("@current_state_#{name}", aasm(name).enter_initial_state)
       end

data/lib/aasm/persistence/redis_persistence.rb

@@ -69,7 +69,7 @@ module AASM
         def aasm_ensure_initial_state
           AASM::StateMachineStore.fetch(self.class, true).machine_names.each do |name|
             aasm_column = self.class.aasm(name).attribute_name
-            aasm(name).enter_initial_state if send(aasm_column).value.blank?
+            aasm(name).enter_initial_state if !send(aasm_column).value || send(aasm_column).value.empty?
           end
         end
 

data/lib/aasm/persistence/sequel_persistence.rb

@@ -15,7 +15,6 @@ module AASM
         end
 
         def before_create
-          aasm_ensure_initial_state
           super
         end
 

data/lib/aasm/rspec/allow_event.rb

@@ -1,13 +1,17 @@
 RSpec::Matchers.define :allow_event do |event|
   match do |obj|
     @state_machine_name ||= :default
-    obj.aasm(@state_machine_name).may_fire_event?(event)
+    obj.aasm(@state_machine_name).may_fire_event?(event, *@args)
   end
 
   chain :on do |state_machine_name|
     @state_machine_name = state_machine_name
   end
 
+  chain :with do |*args|
+    @args = args
+  end
+
   description do
     "allow event #{expected} (on :#{@state_machine_name})"
   end

data/lib/aasm/rspec/allow_transition_to.rb

@@ -1,13 +1,17 @@
 RSpec::Matchers.define :allow_transition_to do |state|
   match do |obj|
     @state_machine_name ||= :default
-    obj.aasm(@state_machine_name).states(:permitted => true).include?(state)
+    obj.aasm(@state_machine_name).states({:permitted => true}, *@args).include?(state)
   end
 
   chain :on do |state_machine_name|
     @state_machine_name = state_machine_name
   end
 
+  chain :with do |*args|
+    @args = args
+  end
+
   description do
     "allow transition to #{expected} (on :#{@state_machine_name})"
   end

data/lib/aasm/rspec/transition_from.rb

@@ -2,7 +2,11 @@ RSpec::Matchers.define :transition_from do |from_state|
   match do |obj|
     @state_machine_name ||= :default
     obj.aasm(@state_machine_name).current_state = from_state.to_sym
-    obj.send(@event, *@args) && obj.aasm(@state_machine_name).current_state == @to_state.to_sym
+    begin
+      obj.send(@event, *@args) && obj.aasm(@state_machine_name).current_state == @to_state.to_sym
+    rescue AASM::InvalidTransition
+      false
+    end
   end
 
   chain :on do |state_machine_name|

data/lib/aasm/version.rb

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

data/lib/generators/aasm/orm_helpers.rb

@@ -22,6 +22,12 @@ RUBY
 
       private
 
+      def column_exists?
+        table_name.singularize.humanize.constantize.column_names.include?(column_name.to_s)
+      rescue NameError
+        false
+      end
+
       def model_exists?
         File.exists?(File.join(destination_root, model_path))
       end

data/lib/generators/active_record/aasm_generator.rb

@@ -11,7 +11,9 @@ module ActiveRecord
       source_root File.expand_path("../templates", __FILE__)
 
       def copy_aasm_migration
-        if model_exists?
+        if column_exists?
+          puts "Both model and column exists"
+        elsif model_exists?
           migration_template "migration_existing.rb", "db/migrate/add_#{column_name}_to_#{table_name}.rb"
         else
           migration_template "migration.rb", "db/migrate/aasm_create_#{table_name}.rb"

data/lib/generators/nobrainer/aasm_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/named_base'
+require 'generators/aasm/orm_helpers'
+
+module NoBrainer
+  module Generators
+    class AASMGenerator < Rails::Generators::NamedBase
+      include AASM::Generators::OrmHelpers
+      namespace 'nobrainer:aasm'
+      argument :column_name, type: :string, default: 'aasm_state'
+
+      def generate_model
+        invoke 'nobrainer:model', [name] unless model_exists?
+      end
+
+      def inject_aasm_content
+        inject_into_file model_path, model_contents, after: "include NoBrainer::Document::Timestamps\n" if model_exists?
+      end
+
+      def inject_field_types
+        inject_into_file model_path, migration_data, after: "include NoBrainer::Document::Timestamps\n" if model_exists?
+      end
+
+      def migration_data
+        "  field :#{column_name}"
+      end
+    end
+  end
+end

data/lib/motion-aasm.rb

@@ -16,6 +16,7 @@ exclude_files = [
   'aasm/persistence/active_record_persistence.rb',
   'aasm/persistence/dynamoid_persistence.rb',
   'aasm/persistence/mongoid_persistence.rb',
+  'aasm/persistence/no_brainer_persistence.rb',
   'aasm/persistence/sequel_persistence.rb',
   'aasm/persistence/redis_persistence.rb'
 ]

data/spec/database.rb

@@ -11,13 +11,23 @@ ActiveRecord::Migration.suppress_messages do
   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"
+  end
 
   ActiveRecord::Migration.create_table "complex_active_record_examples", :force => true do |t|
     t.string "left"
     t.string "right"
   end
 
-  %w(validators multiple_validators workers invalid_persistors multiple_invalid_persistors silent_persistors multiple_silent_persistors).each do |table_name|
+  ActiveRecord::Migration.create_table "works", :force => true do |t|
+    t.string "status"
+  end
+
+  %w(validators multiple_validators workers invalid_persistors multiple_invalid_persistors silent_persistors multiple_silent_persistors active_record_callbacks).each do |table_name|
     ActiveRecord::Migration.create_table table_name, :force => true do |t|
       t.string "name"
       t.string "status"
@@ -41,4 +51,9 @@ ActiveRecord::Migration.suppress_messages do
     t.string "search"
     t.string "sync"
   end
+
+  ActiveRecord::Migration.create_table "instance_level_skip_validation_examples", :force => true do |t|
+    t.string "state"
+    t.string "some_string"
+  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/generators/active_record_generator_spec.rb

@@ -43,5 +43,11 @@ if defined?(ActiveRecord)
       assert_migration "db/migrate/add_state_to_jobs.rb"
     end
 
+    it "dont add column if column is already exists" do
+      require 'models/active_record/work.rb'
+      load_schema
+      run_generator %w(work status)
+      assert_no_migration "db/migrate/add_status_to_jobs.rb"
+    end
   end
 end

data/spec/generators/no_brainer_generator_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+if defined?(NoBrainer::Document)
+  require 'generator_spec'
+  require 'generators/nobrainer/aasm_generator'
+
+  describe NoBrainer::Generators::AASMGenerator, type: :generator do
+    destination File.expand_path('../../../tmp', __FILE__)
+
+    before(:all) do
+      prepare_destination
+    end
+
+    it 'creates model with aasm block for default column_name' do
+      run_generator %w[user]
+      assert_file 'app/models/user.rb', /include AASM\n\n  aasm do\n  end\n/
+    end
+
+    it 'creates model with aasm block for custom column_name' do
+      run_generator %w[user state]
+      assert_file 'app/models/user.rb', /aasm :column => 'state' do\n  end\n/
+    end
+
+    it 'creates model with aasm block for namespaced model' do
+      run_generator %w[Admin::User state]
+      assert_file 'app/models/admin/user.rb', /aasm :column => 'state' do\n  end\n/
+    end
+  end
+end