aasm 4.12.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 485dd737c1e66c6abf9ad6beec5b88610e282cf5
-  data.tar.gz: dc4e4de44fbb182924bc28b13aff6708766f2cfc
+  metadata.gz: 69f97deda18ab481d469c17a67f79bff67fe73ab
+  data.tar.gz: c0f8afb149306a0023e14b511b51f5c4dd681535
 SHA512:
-  metadata.gz: 8211acf5c307b6c04b04ff0aad09aecece63d8df1fc6dbe3de14e363ab415a1e0291510b2d4783cf9cd22391415a25e4ac72d7f43f35ea612b60f939ab6def2a
-  data.tar.gz: a95bd160171a94dfc8ac1a4de0594372c336cf546f38727cacc95ca73af43369419bc6b3637634faa02b7eae6b8c668d29c5b74a5eb930aba4a03af190f8364a
+  metadata.gz: 1c806b50bca06602c0f9fc72c7f8852315a68d2cfe1cd84e7010c30c21b67668359e6b00e3559e55366048582262b81902a86cbd35ec87afa8976a10293f0837
+  data.tar.gz: e2ef393b52f021463e8734a48e86fe59305d4e2b94e57e82cd4849e216599d17a68134c00331f096a621843a0d35aeff8183dd8232c9d89f4520f5f96b3086cc

data/.travis.yml

@@ -3,22 +3,26 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 1.9.3
   - 2.2.6
   - 2.3.3
-  - jruby-1.7 # JRuby in 1.9 mode
-  - jruby-9.0.5.0
+  - jruby-9.1.12.0
 
 services:
   - mongodb
   - redis-server
 
+addons:
+  rethinkdb: '2.3.6'
+
 gemfile:
   - gemfiles/rails_3.2.gemfile
   - gemfiles/rails_4.0.gemfile
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_4.2_mongoid_5.gemfile
+  - gemfiles/rails_4.2_nobrainer.gemfile
   - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.0_nobrainer.gemfile
+  - gemfiles/rails_5.1.gemfile
 
 before_script:
   - mkdir /tmp/dynamodb
@@ -32,20 +36,18 @@ script:
 
 matrix:
   exclude:
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails_5.0.gemfile
     - rvm: 2.2.6
       gemfile: gemfiles/rails_3.2.gemfile
     - rvm: 2.3.3
       gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: jruby-1.7
-      gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
-    - rvm: jruby-1.7
-      gemfile: gemfiles/rails_5.0.gemfile
-    - rvm: jruby-9.0.5.0
+    - rvm: jruby-9.1.12.0
       gemfile: gemfiles/rails_5.0.gemfile
+    - rvm: jruby-9.1.12.0
+      gemfile: gemfiles/rails_5.1.gemfile
+    - rvm: jruby-9.1.12.0
+      gemfile: gemfiles/rails_4.2_nobrainer.gemfile
+    - rvm: jruby-9.1.12.0
+      gemfile: gemfiles/rails_5.0_nobrainer.gemfile
 
 notifications:
   slack:

data/Appraisals

@@ -1,43 +1,66 @@
 appraise 'rails_3.2' do
-  gem 'rails', '~>3.2.22'
-  gem 'mongoid', '~>3.1'
+  gem 'rails', '~> 3.2.22'
+  gem 'mongoid', '~> 3.1'
   gem 'sequel'
-  gem 'bson_ext',                         :platforms => :ruby
+  gem 'bson_ext', platforms: :ruby
   gem 'test-unit', '~> 3.0'
+  gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
 end
 
 appraise 'rails_4.0' do
-  gem 'mime-types', '~> 2',               :platforms => [:ruby_19, :jruby]
+  gem 'mime-types', '~> 2', platforms: %i[ruby_19 jruby]
   gem 'rails', '4.0.13'
-  gem 'mongoid', '~>4.0'
+  gem 'mongoid', '~> 4.0'
   gem 'sequel'
-  gem 'dynamoid', '~> 1',                 :platforms => :ruby
-  gem 'aws-sdk', '~>2',                   :platforms => :ruby
+  gem 'dynamoid', '~> 1', platforms: :ruby
+  gem 'aws-sdk', '~> 2', platforms: :ruby
   gem 'redis-objects'
+  gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
 end
 
 appraise 'rails_4.2' do
-  gem 'nokogiri', '1.6.8.1',              :platforms => [:ruby_19]
-  gem 'mime-types', '~> 2',               :platforms => [:ruby_19, :jruby]
+  gem 'nokogiri', '1.6.8.1', platforms: %i[ruby_19]
+  gem 'mime-types', '~> 2', platforms: %i[ruby_19 jruby]
   gem 'rails', '4.2.5'
-  gem 'mongoid', '~>4.0'
+  gem 'mongoid', '~> 4.0'
   gem 'sequel'
-  gem 'dynamoid', '~> 1',                 :platforms => :ruby
-  gem 'aws-sdk', '~>2',                   :platforms => :ruby
+  gem 'dynamoid', '~> 1', platforms: :ruby
+  gem 'aws-sdk', '~> 2', platforms: :ruby
   gem 'redis-objects'
+  gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
+end
+
+appraise 'rails_4.2_nobrainer' do
+  gem 'rails', '4.2.5'
+  gem 'nobrainer', '~> 0.33.0'
 end
 
 appraise 'rails_4.2_mongoid_5' do
-  gem 'mime-types', '~> 2',               :platforms => [:ruby_19, :jruby]
+  gem 'mime-types', '~> 2', platforms: %i[ruby_19 jruby]
   gem 'rails', '4.2.5'
-  gem 'mongoid', '~>5.0'
+  gem 'mongoid', '~> 5.0'
+  gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
 end
 
 appraise 'rails_5.0' do
   gem 'rails', '5.0.0'
+  gem 'mongoid', '~> 6.0'
+  gem 'sequel'
+  gem 'dynamoid', '~> 1', platforms: :ruby
+  gem 'aws-sdk', '~> 2', platforms: :ruby
+  gem 'redis-objects'
+end
+
+appraise 'rails_5.0_nobrainer' do
+  gem 'rails', '5.0.0'
+  gem 'nobrainer', '~> 0.33.0'
+end
+
+appraise 'rails_5.1' do
+  gem 'rails', '5.1'
   gem 'mongoid', '~>6.0'
   gem 'sequel'
-  gem 'dynamoid', '~> 1',                 :platforms => :ruby
-  gem 'aws-sdk', '~>2',                   :platforms => :ruby
+  gem 'dynamoid', '~> 1', platforms: :ruby
+  gem 'aws-sdk', '~>2', platforms: :ruby
   gem 'redis-objects'
 end

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # CHANGELOG
 
-## unreleased
+## 5.0.0
+
+* Chore(invokers): Refactor callback invokers, add class-callbacks support [#541](https://github.com/aasm/aasm/pull/541), thanks to [pandomic](https://github.com/pandomic)
+* Add docker setup to readme
+* Add support for Nobrainer (RethinkDB) [#522](https://github.com/aasm/aasm/pull/522), thanks to [zedtux] (https://github.com/zedtux)
+* Patch `allow_event` to accept event with custom arguments [#419](https://github.com/aasm/aasm/pull/419), thanks to [czhc](https://github.com/czhc)
+
+
 ## 4.12.3
 
 * Add to AASM fire(event) and fire!(event) methods [#494](https://github.com/aasm/aasm/pull/494), thanks to [slayer](https://github.com/slayer)

data/Dockerfile

@@ -0,0 +1,44 @@
+FROM ruby:2.3.4-slim
+
+LABEL maintainer="AASM"
+
+ENV DEBIAN_FRONTEND noninteractive
+
+# ~~~~ System locales ~~~~
+RUN apt-get update && apt-get install -y locales && \
+    dpkg-reconfigure locales && \
+    locale-gen C.UTF-8 && \
+    /usr/sbin/update-locale LANG=C.UTF-8 && \
+    echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && \
+    locale-gen
+
+# Set default locale for the environment
+ENV LC_ALL C.UTF-8
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US.UTF-8
+ENV APP_HOME /application
+
+# ~~~~ Application dependencies ~~~~
+RUN apt-get update
+RUN apt-get install -y libsqlite3-dev \
+                       build-essential \
+                       git
+
+# ~~~~ Bundler ~~~~
+RUN gem install bundler
+
+WORKDIR $APP_HOME
+RUN mkdir -p $APP_HOME/lib/aasm/
+
+COPY Gemfile* $APP_HOME/
+COPY *.gemspec $APP_HOME/
+COPY lib/aasm/version.rb $APP_HOME/lib/aasm/
+
+ENV BUNDLE_GEMFILE=$APP_HOME/Gemfile \
+  BUNDLE_JOBS=8 \
+  BUNDLE_PATH=/bundle
+
+RUN bundle install
+
+# ~~~~ Import application ~~~~
+COPY . $APP_HOME

data/Gemfile

@@ -3,5 +3,4 @@ source "https://rubygems.org"
 gemspec
 
 gem 'sqlite3',                          :platforms => :ruby
-gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
-gem 'rails', '5.1.3'
+gem 'rails', '5.1.4'

data/README.md

@@ -24,6 +24,7 @@
   - [Sequel](#sequel)
   - [Dynamoid](#dynamoid)
   - [Mongoid](#mongoid)
+  - [Nobrainer](#nobrainer)
   - [Redis](#redis)
   - [Automatic Scopes](#automatic-scopes)
   - [Transaction support](#transaction-support)
@@ -42,6 +43,7 @@
    - [Bundler](#or-if-you-are-using-bundler)
    - [Building your own gems](#building-your-own-gems)
   - [Generators](#generators)
+  - [Test suite with Docker](#docker)
   - [Latest changes](#latest-changes)
   - [Questions?](#questions)
   - [Maintainers](#maintainers)
@@ -52,10 +54,8 @@
 This package contains AASM, a library for adding finite state machines to Ruby classes.
 
 AASM started as the *acts_as_state_machine* plugin but has evolved into a more generic library
-that no longer targets only ActiveRecord models. It currently provides adapters for
-[ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html),
-and [Mongoid](http://mongoid.org/) but it can be used for any Ruby class, no matter what
-parent class it has (if any).
+that no longer targets only ActiveRecord models. It currently provides adapters for many
+ORMs but it can be used for any Ruby class, no matter what parent class it has (if any).
 
 ## Upgrade from version 3 to 4
 
@@ -130,16 +130,26 @@ the transition succeeds :
 
 ### Callbacks
 
-You can define a number of callbacks for your transitions. These methods will be
-called, when certain criteria are met, like entering a particular state:
+You can define a number of callbacks for your events, transitions and states. These methods, Procs or classes will be
+called when certain criteria are met, like entering a particular state:
 
 ```ruby
+class LogRunTime
+  def initialize(resource)
+    @resource = resource
+  end
+  
+  def call
+    # Do whatever you want with @resource
+  end
+end
+
 class Job
   include AASM
 
   aasm do
     state :sleeping, :initial => true, :before_enter => :do_something
-    state :running
+    state :running, before_enter: Proc.new { do_something && notify_somebody }
     state :finished
 
     after_all_transitions :log_status_change
@@ -195,6 +205,8 @@ is finished.
 
 AASM will also initialize `LogRunTime` and run the `call` method for you after the transition from `running` to `finished` in the example above. You can pass arguments to the class by defining an initialize method on it, like this:
 
+Note that Procs are executed in the context of a record, it means that you don't need to expect the record as an argument, just call the methods you need.
+
 ```ruby
 class LogRunTime
   # optional args parameter can be omitted, but if you define initialize
@@ -225,7 +237,7 @@ callback, which can handle it or re-raise it for further propagation.
 
 Also, you can define a method that will be called if any event fails:
 
-```
+```ruby
 def aasm_event_failed(event_name, old_state_name)
   # use custom exception/messages, report metrics, etc
 end
@@ -523,7 +535,7 @@ All _AASM_ class- and instance-level `aasm` methods accept a state machine selec
 So, for example, to use inspection on a class level, you have to use
 
 ```ruby
-SimpleMultipleExample.aasm(:work).states
+SimpleMultipleExample.aasm(:move).states.map(&:name)
 # => [:standing, :walking, :running]
 ```
 
@@ -630,7 +642,7 @@ class CustomAASMBase < AASM::Base
 end
 ```
 
-When we declare our model that has an AASM state machine, we simply declare the AASM block with a `:with` key to our own class.
+When we declare our model that has an AASM state machine, we simply declare the AASM block with a `:with_klass` key to our own class.
 
 ```ruby
 class SimpleCustomExample
@@ -825,6 +837,23 @@ class Job
 end
 ```
 
+### NoBrainer
+
+AASM also supports persistence to [RethinkDB](https://www.rethinkdb.com/)
+if you're using [Nobrainer](http://nobrainer.io/).
+Make sure to include NoBrainer::Document before you include AASM.
+
+```ruby
+class Job
+  include NoBrainer::Document
+  include AASM
+  field :aasm_state
+  aasm do
+    ...
+  end
+end
+```
+
 ### Redis
 
 AASM also supports persistence in Redis via
@@ -1193,6 +1222,9 @@ expect(multiple).to allow_event(:start).on(:move)
 expect(multiple).to_not allow_event(:stop).on(:move)
 expect(multiple).to allow_transition_to(:processing).on(:move)
 expect(multiple).to_not allow_transition_to(:sleeping).on(:move)
+# allow_event also accepts arguments
+expect(job).to allow_event(:run).with(:defragmentation)
+
 ```
 
 #### Minitest
@@ -1203,7 +1235,7 @@ AASM provides assertions and rspec-like expectations for [Minitest](https://gith
 
 List of supported assertions: `assert_have_state`, `refute_have_state`, `assert_transitions_from`, `refute_transitions_from`, `assert_event_allowed`, `refute_event_allowed`, `assert_transition_to_allowed`, `refute_transition_to_allowed`.
 
-Add `require 'aasm/minitest' to your `test_helper.rb` file and use them like this:
+Add `require 'aasm/minitest'` to your `test_helper.rb` file and use them like this:
 
 ```ruby
 # classes with only the default state machine
@@ -1312,6 +1344,14 @@ 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.
 
+### Docker
+
+Run test suite easily on docker
+```
+1. docker-compose build aasm
+2. docker-compose run --rm aasm
+```
+
 ## Latest changes ##
 
 Take a look at the [CHANGELOG](https://github.com/aasm/aasm/blob/master/CHANGELOG.md) for details about recent changes to the current version.

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/rails_3.2.gemfile

@@ -2,12 +2,12 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", :platforms => :ruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "rails", "~>3.2.22"
-gem "mongoid", "~>3.1"
+gem "sqlite3", platforms: :ruby
+gem "rails", "~> 3.2.22"
+gem "mongoid", "~> 3.1"
 gem "sequel"
-gem "bson_ext", :platforms => :ruby
+gem "bson_ext", platforms: :ruby
 gem "test-unit", "~> 3.0"
+gem "activerecord-jdbcsqlite3-adapter", "1.3.24", platforms: :jruby
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_4.0.gemfile

@@ -2,14 +2,14 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", :platforms => :ruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "sqlite3", platforms: :ruby
 gem "rails", "4.0.13"
-gem "mime-types", "~> 2", :platforms => [:ruby_19, :jruby]
-gem "mongoid", "~>4.0"
+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 "dynamoid", "~> 1", platforms: :ruby
+gem "aws-sdk", "~> 2", platforms: :ruby
 gem "redis-objects"
+gem "activerecord-jdbcsqlite3-adapter", "1.3.24", platforms: :jruby
 
-gemspec :path => "../"
+gemspec path: "../"