aasm 5.2.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e3ec7032fd9c8368ddfb4bed4e931edc5f9d96c02a69f89f7ee26913f7d8698
-  data.tar.gz: ddb4ef39501440da1869426eda3b4359e37eeef67b464c9e0d660e9f353510f6
+  metadata.gz: a088e1285940890f3c1a87b6cf0534e80702a96d2fb6eb42b43ff0cf50e6c57d
+  data.tar.gz: b96c64d2458639d217540b8787b1f718d80cd8e64b2661825435a795d5796a93
 SHA512:
-  metadata.gz: c294de071cad6569f855af1455c9d0281622ca5c9a3df0466baacaca569d8974718eb46d4c06e674f54629a77e2634d69829ee2910612ba146b4aaf786891544
-  data.tar.gz: a7b0c176cec262ad9d89538fe43e6df484f4d79328f85e853dcc9fe6b6ce9a9629f802e7de14659e5c91135a3a4df09a6066011983b1936eff06b17657c24cc5
+  metadata.gz: 85a0532a6257477070680b2864c27191f618a61091fe9ba0c2c0672e99aa53c4b61968e4987607c4e5747bb42686cff6667966c90cf4592e87ad0324175e711c
+  data.tar.gz: 1abfc89101b1cdf7440a82446b6c600d65fe6f2bfc83575a85dc2ef0edb04968cc509c9ff88ec2ce68f4aa8b72283f75301a0fcfefffa16fc0347cb31f11c492

data/README.md

@@ -221,18 +221,18 @@ You can pass parameters to events:
   job.run(:defragmentation)
 ```
 
-All guards and after callbacks will receive these parameters. In this case `set_process` would be called with 
+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
+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 guards 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
+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`
@@ -321,7 +321,7 @@ and then
 Let's assume you want to allow particular transitions only if a defined condition is
 given. For this you can set up a guard per transition, which will run before actually
 running the transition. If the guard returns `false` the transition will be
-denied (raising `AASM::InvalidTransition` or returning `false` itself):
+denied (raising `AASM::InvalidTransition`):
 
 ```ruby
 class Cleaner
@@ -364,7 +364,7 @@ job.clean                 # => raises AASM::InvalidTransition
 job.may_clean_if_needed?  # => true
 job.clean_if_needed!      # idle
 
-job.clean_if_dirty(:clean) # => false
+job.clean_if_dirty(:clean) # => raises AASM::InvalidTransition
 job.clean_if_dirty(:dirty) # => true
 ```
 
@@ -400,7 +400,7 @@ If you prefer a more Ruby-like guard syntax, you can use `if` and `unless` as we
   end
 ```
 
-You can invoke a Class instead a method since this Class responds to `call`
+You can invoke a Class instead of a method if the Class responds to `call`
 
 ```ruby
     event :sleep do
@@ -758,7 +758,7 @@ job.aasm.fire!(:run) # saved
 
 Saving includes running all validations on the `Job` class. If
 `whiny_persistence` flag is set to `true`, exception is raised in case of
-failure. If `whiny_persistence` flag is set to false, methods with a bang return
+failure. If `whiny_persistence` flag is set to `false`, methods with a bang return
 `true` if the state transition is successful or `false` if an error occurs.
 
 If you want make sure the state gets saved without running validations (and
@@ -786,7 +786,7 @@ class Job < ActiveRecord::Base
 end
 ```
 
-Also You can skip the validation at instance level with `some_event_name_without_validation!` method.
+Also, you can skip the validation at instance level with `some_event_name_without_validation!` method.
 With this you have the flexibility of having validation for all your transitions by default and then skip it wherever required.
 Please note that only state column will be updated as mentioned in the above example.
 
@@ -1084,7 +1084,7 @@ end
 
 which then leads to `transaction(requires_new: false)`, the Rails default.
 
-Additionally, if you do not want any of your active record actions to be
+Additionally, if you do not want any of your ActiveRecord actions to be
 wrapped in a transaction, you can specify the `use_transactions` flag. This can
 be useful if you want want to persist things to the database that happen as a
 result of a transaction or callback, even when some error occurs. The
@@ -1104,7 +1104,7 @@ end
 
 ### Pessimistic Locking
 
-AASM supports [Active Record pessimistic locking via `with_lock`](http://api.rubyonrails.org/classes/ActiveRecord/Locking/Pessimistic.html#method-i-with_lock) for database persistence layers.
+AASM supports [ActiveRecord pessimistic locking via `with_lock`](http://api.rubyonrails.org/classes/ActiveRecord/Locking/Pessimistic.html#method-i-with_lock) for database persistence layers.
 
 | Option | Purpose |
 | ------ | ------- |
@@ -1160,7 +1160,7 @@ end
 Whatever column name is used, make sure to add a migration to provide this column
 (of type `string`).
 Do not add default value for column at the database level. If you add default
-value in database then AASM callbacks on the initial state will not be fired upon 
+value in database then AASM callbacks on the initial state will not be fired upon
 instantiation of the model.
 
 ```ruby
@@ -1461,7 +1461,7 @@ After installing AASM you can run generator:
 ```
 Replace NAME with the Model name, COLUMN_NAME is optional(default is 'aasm_state').
 This will create a model (if one does not exist) and configure it with aasm block.
-For Active record orm a migration file is added to add aasm state column to table.
+For ActiveRecord orm a migration file is added to add aasm state column to table.
 
 ### Docker
 
@@ -1491,6 +1491,12 @@ Feel free to
 * [Anil Maurya](http://github.com/anilmaurya) (since 2016)
 
 
+
+## Stargazers over time
+
+[![Stargazers over time](https://starchart.cc/aasm/aasm.svg)](https://starchart.cc/aasm/aasm)
+
+
 ## [Contributing](CONTRIBUTING.md)
 
 ## Warranty ##

data/lib/aasm/base.rb

@@ -223,7 +223,20 @@ module AASM
         end
       end
 
-      klass.send(:define_method, method_name, method_definition)
+      klass.send(:define_method, method_name, method_definition).tap do |sym|
+        apply_ruby2_keyword(klass, sym)
+      end
+    end
+
+    def apply_ruby2_keyword(klass, sym)
+      if RUBY_VERSION >= '2.7.1'
+        if klass.instance_method(sym).parameters.find { |type, _| type.to_s.start_with?('rest') }
+          # If there is a place where you are receiving in *args, do ruby2_keywords.
+          klass.module_eval do
+            ruby2_keywords sym
+          end
+        end
+      end
     end
 
     def namespace?

data/lib/aasm/core/event.rb

@@ -10,7 +10,7 @@ module AASM::Core
       @name = name
       @state_machine = state_machine
       @transitions = []
-      @valid_transitions = {}
+      @valid_transitions = Hash.new { |h, k| h[k] = {} }
       @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
@@ -79,8 +79,9 @@ module AASM::Core
 
     def fire_transition_callbacks(obj, *args)
       from_state = obj.aasm(state_machine.name).current_state
-      transition = @valid_transitions[from_state]
-      @valid_transitions[from_state].invoke_success_callbacks(obj, *args) if transition
+      transition = @valid_transitions[obj.object_id][from_state]
+      transition.invoke_success_callbacks(obj, *args) if transition
+      @valid_transitions.delete(obj.object_id)
     end
 
     def ==(event)
@@ -153,7 +154,7 @@ module AASM::Core
             result = transition
           else
             result = to_state || Array(transition.to).first
-            Array(transition.to).each {|to| @valid_transitions[to] = transition }
+            Array(transition.to).each {|to| @valid_transitions[obj.object_id][to] = transition }
             transition.execute(obj, *args)
           end
 

data/lib/aasm/core/invokers/class_invoker.rb

@@ -17,7 +17,7 @@ module AASM
         end
 
         def invoke_subject
-          @result = retrieve_instance.call
+          @result = instance.call
         end
 
         private

data/lib/aasm/core/invokers/literal_invoker.rb

@@ -30,7 +30,9 @@ module AASM
           raise(*record_error) unless record.respond_to?(subject, true)
           return record.__send__(subject) if subject_arity.zero?
           return record.__send__(subject, *args) if subject_arity < 0
-          record.__send__(subject, *args[0..(subject_arity - 1)])
+          req_args = args[0..(subject_arity - 1)]
+          return record.__send__(subject, **req_args[0]) if req_args[0].is_a?(Hash)
+          record.__send__(subject, *req_args)
         end
         # rubocop:enable Metrics/AbcSize
 

data/lib/aasm/errors.rb

@@ -17,5 +17,6 @@ module AASM
   end
 
   class UndefinedState < RuntimeError; end
+  class UndefinedEvent < UndefinedState; end
   class NoDirectAssignmentError < RuntimeError; end
 end

data/lib/aasm/instance_base.rb

@@ -1,6 +1,5 @@
 module AASM
   class InstanceBase
-
     attr_accessor :from_state, :to_state, :current_event
 
     def initialize(instance, name=:default) # instance of the class including AASM, name of the state machine
@@ -115,12 +114,15 @@ module AASM
     end
 
     def fire(event_name, *args, &block)
+      event_exists?(event_name)
+
       @instance.send(event_name, *args, &block)
     end
 
     def fire!(event_name, *args, &block)
-      event_name = event_name.to_s.+("!").to_sym
-      @instance.send(event_name, *args, &block)
+      event_exists?(event_name, true)
+      bang_event_name = "#{event_name}!".to_sym
+      @instance.send(bang_event_name, *args, &block)
     end
 
     def set_current_state_with_persistence(state)
@@ -129,5 +131,14 @@ module AASM
       save_success
     end
 
+    private
+
+    def event_exists?(event_name, bang = false)
+      event = @instance.class.aasm(@name).state_machine.events[event_name.to_sym]
+      return true if event
+
+      event_error = bang ? "#{event_name}!" : event_name
+      raise AASM::UndefinedEvent, "Event :#{event_error} doesn't exist" if event.nil?
+    end
   end
 end

data/lib/aasm/version.rb

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

data/lib/generators/aasm/orm_helpers.rb

@@ -29,7 +29,7 @@ RUBY
       end
 
       def model_exists?
-        File.exists?(File.join(destination_root, model_path))
+        File.exist?(File.join(destination_root, model_path))
       end
 
       def model_path

data/lib/generators/active_record/templates/migration.rb

@@ -1,4 +1,4 @@
-class AASMCreate<%= table_name.camelize %> < ActiveRecord::Migration[<%=  ActiveRecord::VERSION::STRING.to_f %>]
+class AasmCreate<%= table_name.camelize %> < ActiveRecord::Migration[<%=  ActiveRecord::VERSION::STRING.to_f %>]
   def change
     create_table(:<%= table_name %>) do |t|
       t.string :<%= column_name %>