aasm 2.1.1 → 5.2.0

data/README_FROM_VERSION_3_TO_4.md

@@ -0,0 +1,240 @@
+# Migrating from _AASM_ version 3 to 4
+
+## Must
+
+### Callback order has been changed
+
+The first callback to be run is `:before` of the event. A state's `:before_exit` callback
+is now run directly before its `:exit` callback. Event-based guards are now run before
+any of the transition guards are run. And finally, before running any state callbacks,
+all (event- and transition-based) guards are run to check whether the state callbacks
+can be run or not.
+
+
+### Callback `:on_transition` renamed to `:after` and changed its binding
+
+The transition callback `:on_transition` has been renamed to `:after` in order
+to make clear it is being called (namely _after_ doing the transition).
+
+Furthermore, in alignment with the other callbacks, it's not receiving the object
+at hand as first parameter and binds the current object to self.
+
+In summary, change from
+
+```ruby
+  aasm do
+    ...
+      transitions :from => :from_state, :to => :to_state, :on_transition => :do_something
+    ...
+  end
+
+  ...
+  def some_other_method(arg)
+    ...
+  end
+
+  def do_something(obj, arg1, arg2)
+    obj.some_other_method(arg1)
+  end
+```
+
+to
+
+```ruby
+  aasm do
+    ...
+      transitions :from => :from_state, :to => :to_state, :after => :do_something
+    ...
+  end
+
+  ...
+  def some_other_method(arg)
+    ...
+  end
+
+  def do_something(arg1, arg2)
+    some_other_method(arg1) # run on the object as self
+  end
+```
+
+
+### `after_commit` hooks are now event-based
+
+The `after_commit` hooks have been move from the state level to the event level.
+So, if you want some code block to be executed after the _AASM_ state has been
+saved **AND** committed, change this code
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm do
+    state :sleeping, :initial => true
+    state :running, :after_commit => :notify_about_running_job
+
+    event :run do
+      transitions :from => :sleeping, :to => :running
+    end
+  end
+
+  def notify_about_running_job
+    ...
+  end
+end
+```
+
+to
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm do
+    state :sleeping, :initial => true
+    state :running
+
+    event :run, :after_commit => :notify_about_running_job do
+      transitions :from => :sleeping, :to => :running
+    end
+  end
+
+  def notify_about_running_job
+    ...
+  end
+end
+```
+
+
+### Instance-level inspection
+
+Listing events for the current state now returns Event objects instead of event names (as symbols). So, change from
+
+```ruby
+job = Job.new
+
+job.aasm.events
+# => [:run]
+```
+
+to
+
+```ruby
+job = Job.new
+
+job.aasm.events.map(&:name)
+# => [:run]
+```
+
+Retrieving the list of permitted events has now been integrated into the `events` method. Change from
+
+```ruby
+job = Job.new
+
+job.aasm.permissible_events
+# => [:run]
+```
+
+to
+
+```ruby
+job = Job.new
+
+job.aasm.events(:permitted => true).map(&:name)
+# => [:run]
+```
+
+Class-based events now return a list of `Event` instances. Change from
+
+```ruby
+Job.aasm.events.values.map(&:name)
+# => [:run]
+```
+
+to
+
+```ruby
+Job.aasm.events.map(&:name)
+# => [:run]
+```
+
+
+## Could
+
+### Triggering an event without _to_state_
+
+When providing parameters to callbacks it is not required to provide the `to_state`
+anymore. So, assuming you have the following class:
+
+```ruby
+class Job
+  include AASM
+
+  aasm do
+    state :sleeping, :initial => true
+    state :running
+
+    event :run do
+      transitions :from => :sleeping, :to => :running, :after => :log
+    end
+  end
+
+  def log(message)
+    logger.info message
+  end
+end
+```
+
+then you could change from
+
+```ruby
+job = Job.new
+job.run(:running, "we want to run")
+```
+
+to this:
+
+```ruby
+job = Job.new
+job.run("we want to run")
+
+job.run(:running, "we want to run") # still supported to select the target state (the _to_state_)
+```
+
+On the other hand, you have to accept the arguments for **all** callback methods (and procs)
+you provide and use. If you don't want to provide these, you can splat them
+
+```ruby
+def before(*args); end
+# or
+def before(*_); end # to indicate that you don't want to use the arguments
+```
+
+### New configuration option: `no_direct_assignment`
+
+If you want to make sure that the _AASM_ column for storing the state is not directly assigned,
+configure _AASM_ to not allow direct assignment, like this:
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm :no_direct_assignment => 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.aasm_state # => 'sleeping'
+job.aasm_state = :running # => raises AASM::NoDirectAssignmentError
+job.aasm_state # => 'sleeping'
+```

data/Rakefile

@@ -1,95 +1,31 @@
-# Copyright 2008 Scott Barron (scott@elitists.net)
-# All rights reserved
+require 'bundler/gem_tasks'
 
-# This file may be distributed under an MIT style license.
-# See MIT-LICENSE for details.
-
-begin
-  require 'rubygems'
-  require 'rake/gempackagetask'
-  require 'rake/testtask'
-  require 'rake/rdoctask'
-  require 'spec/rake/spectask'
-rescue Exception
-  nil
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-if `ruby -Ilib -raasm -e "print AASM.Version"` =~ /([0-9.]+)$/
-  CURRENT_VERSION = $1
-else
-  CURRENT_VERSION = '0.0.0'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
 end
-$package_version = CURRENT_VERSION
 
-PKG_FILES = FileList['[A-Z]*',
-  'lib/**/*.rb',
-  'doc/**/*'
-]
+require 'rdoc/task'
+require 'aasm/version'
 
-desc 'Generate documentation for the acts as state machine plugin.'
-rd = Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'html'
-  rdoc.template = 'doc/jamis.rb'
+Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'AASM'
-  rdoc.options << '--line-numbers' << '--inline-source' <<  '--main' << 'README.rdoc' << '--title' << 'AASM'
-  rdoc.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'TODO', 'CHANGELOG')
-  rdoc.rdoc_files.include('lib/*.rb', 'lib/**/*.rb', 'doc/**/*.rdoc')
+  rdoc.title = "aasm #{AASM::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-if !defined?(Gem)
-  puts "Package target requires RubyGEMs"
+if ENV["APPRAISAL_INITIALIZED"] || ENV["TRAVIS"]
+  task :default => :spec
 else
-  spec = Gem::Specification.new do |s|
-    s.name = 'aasm'
-    s.version = $package_version
-    s.summary = 'State machine mixin for Ruby objects'
-    s.description = <<EOF
-AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.
-EOF
-
-    s.files = PKG_FILES.to_a
-    s.require_path = 'lib'
-    s.has_rdoc = true
-    s.extra_rdoc_files = rd.rdoc_files.reject {|fn| fn =~ /\.rb$/}.to_a
-    s.rdoc_options = rd.options
-
-    s.authors = ['Scott Barron', 'Scott Petersen', 'Travis Tilley']
-    s.email = 'ttilley@gmail.com'
-    s.homepage = 'http://github.com/ttilley/aasm'
-  end
-
-  package_task = Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_zip = true
-    pkg.need_tar = true
-  end
+  require 'appraisal'
+  task :default => :appraisal
 end
-
-if !defined?(Spec)
-  puts "spec and cruise targets require RSpec"
-else
-  desc "Run all examples with RCov"
-  Spec::Rake::SpecTask.new('cruise') do |t|
-    t.spec_files = FileList['spec/**/*.rb']
-    t.rcov = true
-    t.rcov_opts = ['--exclude', 'spec', '--exclude', 'Library', '--exclude', 'rcov.rb']
-  end
-
-  desc "Run all examples"
-  Spec::Rake::SpecTask.new('spec') do |t|
-    t.spec_files = FileList['spec/**/*.rb']
-    t.rcov = false
-    t.spec_opts = ['-cfs']
-  end
-end
-
-if !defined?(Gem)
-  puts "Package target requires RubyGEMs"
-else
-  desc "sudo gem uninstall aasm && rake gem && sudo gem install pkg/aasm-3.0.0.gem"
-  task :reinstall do
-    puts `sudo gem uninstall aasm && rake gem && sudo gem install pkg/aasm-3.0.0.gem`
-  end
-end
-
-task :default => [:spec]

data/TESTING.md

@@ -0,0 +1,25 @@
+## Install dependency matrix
+
+    appraisal install
+
+This will re-generate Gemfiles in `gemfile` folder
+
+Use rvm gemsets or similar to avoid global gem pollution
+
+## Run specs
+
+For all supported Rails/ORM combinations:
+
+    appraisal rspec
+
+Or for specific one:
+
+    appraisal rails_4.2 rspec
+
+Or for one particular test file
+
+    appraisal rails_4.2_mongoid_5 rspec spec/unit/persistence/mongoid_persistence_multiple_spec.rb
+
+Or down to one test case
+
+    appraisal rails_4.2_mongoid_5 rspec spec/unit/persistence/mongoid_persistence_multiple_spec.rb:92

data/aasm.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "aasm/version"
+
+Gem::Specification.new do |s|
+  s.name        = "aasm"
+  s.version     = AASM::VERSION
+  s.authors     = ["Thorsten Boettger", "Anil Maurya"]
+  s.email       = %q{aasm@mt7.de, anilmaurya8dec@gmail.com}
+  s.homepage    = %q{https://github.com/aasm/aasm}
+  s.summary     = %q{State machine mixin for Ruby objects}
+  s.description = %q{AASM is a continuation of the acts-as-state-machine rails plugin, built for plain Ruby objects.}
+  s.date        = Time.now
+  s.licenses    = ["MIT"]
+
+  s.platform              = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'concurrent-ruby', '~> 1.0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'sdoc'
+  s.add_development_dependency 'rspec', ">= 3"
+  s.add_development_dependency 'generator_spec'
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "codecov", ">= 0.1.21"
+
+  # debugging
+  # s.add_development_dependency 'debugger'
+  s.add_development_dependency 'pry'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/docker-compose.yml

@@ -0,0 +1,40 @@
+version: "2"
+
+services:
+  aasm:
+    image: aasm/aasm
+    build: .
+    command: bash -c 'bundle exec appraisal install && bundle exec appraisal rspec'
+    environment:
+      - DYNAMODB_HOST=dynamodb
+      - DYNAMODB_PORT=8000
+      - MONGODB_HOST=mongo
+      - MONGODB_PORT=27017
+      - RAILS_ENV=development
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - RETHINKDB_DB=rethinkdb_test
+      - RETHINKDB_HOST=rethinkdb
+      - RETHINKDB_PORT=28015
+    depends_on:
+      - dynamodb
+      - mongo
+      - redis
+      - rethinkdb
+    volumes:
+      - .:/application
+    volumes_from:
+      - bundle
+  bundle:
+    image: aasm/aasm
+    command: echo Bundler data container
+    volumes:
+      - /bundle
+  dynamodb:
+    image: cnadiminti/dynamodb-local:2017-02-16
+  mongo:
+    image: mongo:3.6.1
+  redis:
+    image: redis:4.0.6-alpine
+  rethinkdb:
+    image: rethinkdb:2.3.6

data/gemfiles/norails.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3", ">= 1.3.5", platforms: :ruby
+gem "rails", install_if: false
+gem "sequel"
+gem "redis-objects"
+
+gemspec path: "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "4.2.5"
+gem "nokogiri", "1.6.8.1", platforms: [:ruby_19]
+gem "mime-types", "~> 2", platforms: [:ruby_19, :jruby]
+gem "mongoid", "~> 4.0"
+gem "sequel"
+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", "~> 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_4.2_mongoid_5.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+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", "~> 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_4.2_nobrainer.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "4.2.5"
+gem "nobrainer", "~> 0.33.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "5.0.0"
+gem "mongoid", "~> 6.0"
+gem "sequel"
+gem "dynamoid", "~> 1.3", platforms: :ruby
+gem "aws-sdk", "~> 2", platforms: :ruby
+gem "redis-objects"
+gem "after_commit_everywhere", "~> 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.0_nobrainer.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "5.0.0"
+gem "nobrainer", "~> 0.33.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "5.1"
+gem "mongoid", "~>6.0"
+gem "sequel"
+gem "dynamoid", "~> 1.3", platforms: :ruby
+gem "aws-sdk", "~>2", platforms: :ruby
+gem "redis-objects"
+gem "after_commit_everywhere", "~> 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "5.2"
+gem "mongoid", "~>6.0"
+gem "sequel"
+gem "dynamoid", "~>2.2", platforms: :ruby
+gem "aws-sdk", "~>2", platforms: :ruby
+gem "redis-objects"
+gem "after_commit_everywhere", "~> 1.0"
+
+gemspec path: "../"