aasm 4.5.1 → 5.5.0

data/CHANGELOG.md

@@ -1,272 +0,0 @@
-# CHANGELOG
-
-## 4.5.1
-
- * make sure to use override configuration options if state machine is defined more than once (see [issue #287](https://github.com/aasm/aasm/issues/287) for details)
-
-## 4.5.0
-
- * add RSpec matchers `have_state`, `allow_event` and `allow_transition_to` (see [issue #147](https://github.com/aasm/aasm/issues/147) for details)
- * add RSpec matcher `transition_from` (see [issue #178](https://github.com/aasm/aasm/issues/178) for details, thanks to [@thomasstephane](https://github.com/thomasstephane))
-
-## 4.4.1
-
- * add support for rejecting certain events on inspection (see [issue #272](https://github.com/aasm/aasm/issues/272)  for details, thanks to [@dubroe](https://github.com/dubroe))
-
-## 4.4.0
-
- * add support global transation callbacks (see [issue #221](https://github.com/aasm/aasm/issues/221) and [issue #253](https://github.com/aasm/aasm/issues/253) for details)
- * add support (bugfix) for Mongoid >= 5.0 (see [issue #277](https://github.com/aasm/aasm/issues/277) and [issue #278](https://github.com/aasm/aasm/issues/278) for details)
-
-## 4.3.0
-
- * add support for multiple state machines per class (see [issue #158](https://github.com/aasm/aasm/issues/158) and [issue #240](https://github.com/aasm/aasm/issues/240) for details)
-    * special thanks to [@evadne](https://github.com/evadne) for testing this feature, and providing comments and patches (see [issue #245](https://github.com/aasm/aasm/issues/245) for details)
-
-## 4.2.0
-
- * support turning off and on the configuration option for `no_direct_assignment` (see [issue #223](https://github.com/aasm/aasm/issues/223) for details)
- * event arguments are now passed to `:after_commit` callbacks as well (see [issue #238](https://github.com/aasm/aasm/pull/238), thanks to [@kuinak](https://github.com/kuinak))
-
-## 4.1.1
-
- * support block notation for `:after_commit` event callbacks (see [issue #224](https://github.com/aasm/aasm/issues/224) for details)
- * event arguments are now passed to state callbacks as well (not only to event callbacks) (see [issue #219](https://github.com/aasm/aasm/issues/219), thanks to [@tobithiel](https://github.com/tobithiel))
- * `AASM::InvalidTransition` now references the current object (with the state machine) and the _AASM_ event name (see [issue #217](https://github.com/aasm/aasm/issues/217), thanks to [@awsmsrc](https://github.com/awsmsrc))
- * bugfix: do not update unloaded state for [Sequel](http://sequel.jeremyevans.net/) (see [issue #218](https://github.com/aasm/aasm/issues/218), thanks to [@godfat](https://github.com/godfat))
-
-## 4.1.0
-
- * bugfix: initialize the aasm state column after initialization of the _Mongoid_ instance (see [issue #206](https://github.com/aasm/aasm/issues/206), thanks to [@Shwetakale ](https://github.com/Shwetakale ))
- * added support for mongomapper ORM (see [issue #203](https://github.com/aasm/aasm/issues/203), thanks to [@reidmorrison ](https://github.com/reidmorrison ))
- * `aasm_column` has been removed. Use `aasm.attribute_name` instead
- * `aasm_human_event_name` has been removed. Use `aasm.human_event_name` instead
-
-## 4.0.8
-
- * bugfix: may_event_name? should return true or false only (see [issue #200](https://github.com/aasm/aasm/issues/200) for details)
-
-## 4.0.7
-
- * bugfix: take private methods into account when checking for callbacks (see [issue #197](https://github.com/aasm/aasm/issues/197) for details)
-
-## 4.0.6
-
- * bugfix: `false` is treated as uninitialised state (same as `nil`) (see [issue #195](https://github.com/aasm/aasm/issues/195) for details)
- * bugfix: an event's `:error` callback now retrieves all arguments passed to the event (see [issue #196](https://github.com/aasm/aasm/issues/196) for details)
-
-## 4.0.5
-
- * bugfix: initialize the aasm state column after initialization of the _ActiveRecord_ instance only if the attribute has been loaded (see [issue #193](https://github.com/aasm/aasm/issues/193) for details)
-
-## 4.0.4
-
- * corrected callback order in README
- * bugfix: initialize the aasm state column after initialization of the _ActiveRecord_ instance (see [issue #191](https://github.com/aasm/aasm/issues/191) for details)
- * bugfix: avoid Rails autoloading conflicts (see [issue #137](https://github.com/aasm/aasm/issues/137) and [issue #139](https://github.com/aasm/aasm/issues/139) for details)
-
-## 4.0.3
-
- * bugfix: fire guards only once per transition, part 2 (see [issue #187](https://github.com/aasm/aasm/issues/187) for details)
- * `aasm_column` is deprecated. Use `aasm.attribute_name` instead
-
-## 4.0.2
-
- * bugfix: really support block-guards (defined within a transition block) (see [issue #186](https://github.com/aasm/aasm/issues/186) for details)
-
-## 4.0.1
-
- * fire guards only once per transition (see [issue #184](https://github.com/aasm/aasm/issues/184) for details)
- * `aasm_human_event_name` is deprecated, use `aasm.human_event_name` instead
-
-## 4.0.0
-
- * support `if` and `unless` guard syntax: (see [issue #179](https://github.com/aasm/aasm/issues/179) and [issue #181](https://github.com/aasm/aasm/issues/181)), thanks to [@bigtunacan](https://github.com/bigtunacan)
- * may configure to not allow direct assignment for persisted AASM models (see [issue #53](https://github.com/aasm/aasm/issues/53))
- * **DSL change**: callbacks don't require `to_state` parameter anymore, but still support it
-   (closing issues
-   [#11](https://github.com/aasm/aasm/issues/11),
-   [#58](https://github.com/aasm/aasm/issues/58) and
-   [#80](https://github.com/aasm/aasm/issues/80)
-   thanks to [@ejlangev](https://github.com/ejlangev))
- * **DSL change**: `after_commit` hooks are now event-based (see [issue #112](https://github.com/aasm/aasm/issues/112))
- * **DSL change**: event and state callbacks have been re-ordered; state callbacks are not run anymore if any guard fails
- * **DSL change**: `:on_transition` renamed to `:after`
- * **DSL change**: `:on_transition` renamed to `:after`
- * **DSL change**: transition `:after` binding changed (see [issue #59](https://github.com/aasm/aasm/issues/59), thanks to [@stiff](https://github.com/stiff))
- * **DSL change**: instance-based events inspection now returns event instances (instead of the event names as symbol)
- * **DSL change**: instance-based permissible_events has been removed in favor or events(:permissible => true)
- * **DSL change**: class-based events now returns a list of Event instances (instead of a hash with event names as keys)
- * **DSL change**: renamed permissible states and events to permitted states events
- * removed deprecated methods (mostly the ones prefixed with `aasm_`)
-
-## 3.4.0
-
- * allow retrieving the current event (`aasm.current_event`) (see [issue #159](https://github.com/aasm/aasm/issues/159) and [issue #168](https://github.com/aasm/aasm/issues/168))
-
-## 3.3.3
-
- * bugfix: support reloading development environment in Rails (see [issue #148](https://github.com/aasm/aasm/issues/148))
-
-## 3.3.2
-
- * bugfix: avoid conflicts with `failed` and `fired` event names (see [issue #157](https://github.com/aasm/aasm/issues/157)), thanks to [@MichaelXavier](https://github.com/MichaelXavier)
- * bugfix: not using transactions unless saving to the database (see [issue #162](https://github.com/aasm/aasm/issues/162) and [issue #164](https://github.com/aasm/aasm/issues/164)), thanks to [@roberthoner](https://github.com/roberthoner)
- * bugfix: `after_commit` should only run if saving to the database (see [issue #151](https://github.com/aasm/aasm/issues/151)), thanks to [@ivantsepp](https://github.com/ivantsepp)
-
-## 3.3.1
-
- * bugfix: permissible events will respect given `guards` (see [issue #150](https://github.com/aasm/aasm/issues/150))
-
-## 3.3.0
-
- * support for Rails 4.1 enum fields (see [issue #124](https://github.com/aasm/aasm/issues/124), thanks to [@bkon](https://github.com/bkon))
- * bugfix: allow lazy-evaluation for Rails 3 scopes (see [issue #144](https://github.com/aasm/aasm/issues/144), thanks to [@laurens](https://github.com/laurens))
-
-## 3.2.1
-
- * bugfix: permissible_events and events did not contain events with an empty "from" transition (see [issue #140](https://github.com/aasm/aasm/issues/140) and [issue #141](https://github.com/aasm/aasm/issues/141), thanks to [@daniel-rikowski](https://github.com/daniel-rikowski))
-
-## 3.2.0
-
- * support [Sequel](http://sequel.jeremyevans.net/) (see [issue #119](https://github.com/aasm/aasm/issues/119), thanks to [@godfat](https://github.com/godfat))
- * may not fire an unknown event (see [issue #128](https://github.com/aasm/aasm/issues/128)
-
-## 3.1.1
-
- * bugfix: don't require ActiveRecord for localizing AASM event and state name (see [issue #113](https://github.com/aasm/aasm/issues/113), thanks to [@silentshade](https://github.com/silentshade))
-
-## 3.1.0
-
- * validating the current state (see [issue #95](https://github.com/aasm/aasm/issues/95), thanks to [@ivantsepp](https://github.com/ivantsepp))
- * allow configuring behavior of nested transactions (see [issue #107](https://github.com/aasm/aasm/issues/107))
- * support multiple guards per transition
- * support event guards (see [issue #85](https://github.com/aasm/aasm/issues/85))
- * support reading from- and to-state during on_transition callback (see [issue #100](https://github.com/aasm/aasm/issues/100))
-
-## 3.0.26
-
- * support state.human_name (aliased to state.localized_name) (see [issue #105](https://github.com/aasm/aasm/issues/105))
-
-## 3.0.25
-
- * initialize the state even if validation is skipped (for ActiveRecord and Mongoid persistence) (see [issue #103](https://github.com/aasm/aasm/issues/103), thanks to [@vfonic](https://github.com/vfonic) and [@aaronklaassen](https://github.com/aaronklaassen))
-
-## 3.0.24
-
- * added support for event blocks (thanks to [@Intrepidd](https://github.com/Intrepidd))
-
-## 3.0.23
-
- * added support for `after_commit` callback (transaction support) (thanks to [@tisba](https://github.com/tisba))
-
-## 3.0.22
-
- * fixed [issue 88](https://github.com/aasm/aasm/issues/88): wrong number of arguments for transaction method
-
-## 3.0.21
-
- * support nested ActiveRecord transactions ([@ozeias](https://github.com/ozeias))
- * allow overwriting of events, can be very useful with inheritance ([@Intrepidd](https://github.com/Intrepidd))
-
-## 3.0.20
-
- * added configuration option to disable automatic scope creation
-
-## 3.0.19
-
- * fixed deprecation warning with *Rails 4* (`Relation#update_all` with conditions is deprecated)
- * fixing [issue #69](https://github.com/aasm/aasm/issues/69) ( *ActiveRecord* scopes are not chainable)
-
-## 3.0.18
-
- * fixing [issue #66](https://github.com/aasm/aasm/issues/66) (state methods not reflecting the current state)
-
-## 3.0.17
-
- * supporting instance level inspection for states (including permissible state, see [issue #54](https://github.com/aasm/aasm/issues/54))
- * added autocreation of constants for each state ([@jherdman](https://github.com/jherdman))
-
-## 3.0.16
-
- * added autocreation of state scopes for Mongoid (thanks to [@jonnyshields](https://github.com/johnnyshields))
-
-## 3.0.15
-
- * added support for localized state names (on a class level, like `Record.aasm.states.map(&:localized_name)`)
-
-## 3.0.14
-
- * supporting event inspection for to-states transitions (`Event#transitions_to_state?`)
-
-## 3.0.13
-
- * supporting *ActiveRecord* transactions when firing an event
-
-## 3.0.12
-
- * `aasm_from_states_for_state` now supports to filter for specific transition
-
-## 3.0.11
-
- * added class method `aasm_from_states_for_state` to retrieve all from states (regarding transitions) for a given state
-
-## 3.0.10
-
- * added support for transitions from all other states (thanks to [@swrobel](https://github.com/swrobel))
-
-## 3.0.9
-
- * guard checks (e.g. `may_edit?`) now support guard parameters as well
-
-## 3.0.8
-
- * fixed issue with generating docs using yard
-
-## 3.0.7
-
- * removed deprecation warning when localizing aasm state names (look at [issue #38](https://github.com/rubyist/aasm/issues/38) for details)
-
-## 3.0.6
-
- * bugfix: if configured to skip validation the code does not validate anymore
-
-## 3.0.5
-
- * bugfix: get rid of error with old rubygems versions
-
-## 3.0.4
-
- * bugfix: Subclasses of aasm-enabled classes don't lose settings anymore (thanks to codez)
-
-## 3.0.3
-
- * bugfix: ActiveRecord scopes are generated when using the new DSL
-
-## 3.0.2
-
- * ActiveRecord persistence can ignore validation when trying to save invalid models
-
-## 3.0.1
-
- * added support for Mongoid (Thanks, Michał Taberski)
-
-## 3.0.0
-
- * switched documentation to the new DSL
- * whiny transactions: by default, raise an exception if an event transition is not possible
- * you may disable whiny transactions
-
-## 2.4.0
-
- * supporting new DSL (which is much shorter)
-
-## 2.3.1
-
- * bugfix: avoid naming conflict with i18n
-
-## 2.3.0
-
- * supporting i18n
- * supporting regular expressions for hash values and strings
-

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,15 +0,0 @@
-source "https://rubygems.org"
-
-gem "sqlite3",                          :platforms => :ruby
-gem 'rubysl',                           :platforms => :rbx
-gem "jruby-openssl",                    :platforms => :jruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "rails", "~>4.2"
-gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
-gem 'sequel'
-# Since mongoid V4 requires incompatible bson V2, cannot have mongoid (V4 or greater)
-# and mongo_mapper ( or mongo ) in the same application
-# gem 'mongo_mapper', '~> 0.13'
-# gem 'bson_ext',                          :platforms => :ruby
-
-gemspec

data/HOWTO

@@ -1,12 +0,0 @@
-How to
-
-1. Run tests for Mongoid
-
-Start MongoDB
-
-  $> mongod
-
-Run the specs
-
-  $> rspec spec/unit/persistence/mongoid_persistance_spec.rb
-

data/PLANNED_CHANGES.md

@@ -1,11 +0,0 @@
-# Planned changes
-
-## later
-
-   * drop support for aasm_column ?
-
-
-# Currently working on
-
-
-# Changes so far

data/README_FROM_VERSION_3_TO_4.md

@@ -1,240 +0,0 @@
-# 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,26 +0,0 @@
-require 'bundler/gem_tasks'
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
-
-require 'rdoc/task'
-require 'aasm/version'
-
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "aasm #{AASM::VERSION}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-task :default => :spec

data/aasm.gemspec

@@ -1,31 +0,0 @@
-# -*- 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     = ["Scott Barron", "Travis Tilley", "Thorsten Boettger"]
-  s.email       = %q{scott@elitists.net, ttilley@gmail.com, aasm@mt7.de}
-  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_development_dependency 'rake'
-  s.add_development_dependency 'sdoc'
-  s.add_development_dependency 'rspec', ">= 3"
-
-  # 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/callbacks.txt

@@ -1,51 +0,0 @@
-callbacks
-
-AASM 3
-
-begin
-  old_state       exit                # old? should be deprecated -> use old_state.before_exit instead
-  event           before
-  old_state       before_exit
-  new_state       before_enter
-  new_state       enter               # old? should be deprecated -> use new_state.before_enter instead
-    ...update state...
-    transition    guard
-    event         guard
-    transition    on_transition
-    event         success             # if persist successful
-  old_state       after_exit
-  new_state       after_enter
-  event           after
-rescue
-  event           error
-end
-
-AASM 4
-
-todo
-
-done
-- move event.before before everything else
-- move old_state.before_exit before old_state.exit
-- move event.guard before transition.guard
-- fire guards before running state callbacks (test run)
-
-begin
-  event           before
-  event           guard               # test run
-  transition      guard               # test run
-  old_state       before_exit
-  old_state       exit
-  new_state       before_enter
-  new_state       enter
-    event         guard
-    transition    guard
-    transition    on_transition
-    ...update state...
-    event         success             # if persist successful
-  old_state       after_exit
-  new_state       after_enter
-  event           after
-rescue
-  event           error
-end