rails_state_machine 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a43d6bb47ef3e0965611b3bbeff34ab781a7ca117009a94175635f4e0e4c3cb5
+  data.tar.gz: 4f4d100446619829d4dacad6318c97bd80a0ea3be6116036efa0d3afffd21cf2
+SHA512:
+  metadata.gz: 510c5ac997b6481843a51f5f4a07433ac00c09ee5cd59c87e99793882fa6c3d9cc24bea5d70082336589c35fe39b6b468bc404dfae74dd5fa51c7ac85638d3d5
+  data.tar.gz: f8fa237d649a5ed98fc5e0a721493e4546f5d8b7f72e2d72ecb1bb291df23ff459ff398d9e6e13fdd340324a617f125d5c00c5d8ca67f1aad6b9cb9d36bce089

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+spec/support/database.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.4

data/.travis.yml

@@ -0,0 +1,27 @@
+sudo: false
+language: ruby
+cache: bundler
+
+before_script:
+  - psql -c 'create database rails_state_machine_test;' -U postgres
+  - mysql -e 'create database IF NOT EXISTS rails_state_machine_test;'
+
+notifications:
+  email:
+    - fail@makandra.de
+
+install:
+  # Replace default Travis CI bundler script with a version that doesn't
+  # explode when lockfile doesn't match recently bumped version
+  - bundle install --no-deployment --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}
+
+script: bundle exec rake current_rspec
+
+rvm:
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+
+gemfile:
+  - gemfiles/Gemfile.5.1.pg
+  - gemfiles/Gemfile.5.2.pg

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 1.0.0 2018-09-04
+
+### Compatible changes
+
+- First version.

data/Gemfile

@@ -0,0 +1 @@
+./gemfiles/Gemfile.5.1.pg

data/Gemfile.lock

@@ -0,0 +1 @@
+./gemfiles/Gemfile.5.1.pg.lock

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 makandra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 makandra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,173 @@
+# Rails State Machine
+[![Build Status](https://travis-ci.org/makandra/rails_state_machine.svg?branch=master)](https://travis-ci.org/makandra/rails_state_machine)
+
+Rails State Machine is a ActiveRecord-bound state machine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_state_machine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_state_machine
+
+## Usage
+
+Your model needs a `state` attribute. You can then simply define your state machine as follows.
+
+```ruby
+class YourModel < ApplicationRecord
+  include RailsStateMachine::Model
+
+  state_machine do
+    state :draft, initial: true
+    state :review_pending
+    state :approved
+    state :rejected
+
+    event :request_review do
+      transitions from: [:draft, :rejected], to: :review_pending
+    end
+
+    event :approve do
+      transitions from: :review_pending, to: :approved
+    end
+
+    event :reject do
+      transitions from: :review_pending, to: :rejected
+    end
+  end
+end
+```
+
+This will define instance methods with the names of those events, and constants like `STATE_DRAFT` on the model.
+If a state is configured as `initial: true`, new instances will be assigned this state.
+
+A model instance offers these state machine methods:
+
+- `<state_name>?` to find out if this is the current state.
+- `<event_name>` call an event and transition into a new state. The record will be `save`d, if valid.
+- `<event_name>!` call an event and transition into a new state. Calls `save!` to save the record.
+- `may_<event_name>?` to find out if an event transition could be taken. Note that this will not validate if the model is valid afterwards.
+- `state_event=` to take a state event, but not save yet. Commonly used for forms where the controller takes a "state_event" param and saves.
+- `state_event` to get the name of the event that will be called
+
+Should you ever need to query the state machine for its states or events, it is accessible via `state_machine` class or instance methods on the model. This is mostly helpful in tests.
+
+If you want an event to be available for a different edge in your graph, you may define multiple `transitions` per event:
+
+```ruby
+event :request_feedback do
+  transitions from: :draft, to: :draft
+  transitions from: :review_pending, to: :review_pending
+end
+```
+
+As an alternative to using `RailsStateMachine::Model` and `state_machine do`, configure the state machine manually. This only adds the `state_machine` to your model, but no `states` or `state_events`.
+
+```ruby
+class YourModel < ApplicationRecord
+  RailsStateMachine::StateMachine.new(self).configure do
+    state :draft, initial: true
+    state :review_pending
+    state :approved
+    state :rejected
+
+    event :request_review do
+      transitions from: [:draft, :rejected], to: :review_pending
+    end
+
+    event :approve do
+      transitions from: :review_pending, to: :approved
+    end
+
+    event :reject do
+      transitions from: :review_pending, to: :rejected
+    end
+  end
+
+  def self.states
+    state_machine.state_names
+  end
+
+  def self.state_events
+    state_machine.event_names
+  end
+end
+```
+
+## Event callbacks
+
+Here is a list with all the available callbacks, listed in the same order in which they will get called during the respective operations. The callbacks are chained with the existing active record callbacks on the model.
+
+* `before_validation`
+* `before_save`
+* `after_save`
+
+Example:
+
+```ruby
+event :request_review do
+  transitions from: [:draft, :rejected], to: :review_pending
+
+  before_validation do
+    # this callback is chained with existing `before_validation` callbacks of the model
+  end
+
+  before_save do
+    # this callback is chained with existing `before_save` callbacks of the model
+  end
+
+  after_save do
+    # this callback is chained with existing `after_save` callbacks of the model
+  end
+end
+```
+
+## Development
+
+There are tests in `spec`. We only accept PRs with tests. To run tests:
+
+- Install Ruby 2.4.4
+- Copy the file `spec/support/database.sample.yml` to `spec/support/database.yml` and enter your PostgreSQL credentials. You can create the database afterwards with `createdb rails_state_machine_test`.
+- Run `bin/setup` to install development dependencies.
+- Run tests using `bundle exec rspec`
+
+We recommend to test large changes against multiple versions of Ruby and multiple dependency sets. Supported combinations are configured in `.travis.yml`. We provide some rake tasks to help with this:
+
+- Install development dependencies using `bundle matrix:install`
+- Run tests using `bundle matrix:spec`
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+If you would like to contribute:
+
+- Fork the repository.
+- Push your changes **with passing specs**.
+- Send us a pull request.
+
+We want to keep this gem leightweight and on topic. If you are unsure whether a change would make it into the gem, open an issue and discuss.
+
+Note that we have configured Travis CI to automatically run tests in all supported Ruby versions and dependency sets after each push. We will only merge pull requests after a green Travis build.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Arne Hartherz and Emanuel Denzel from [makandra](https://makandra.de/).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'gemika/tasks'
+rescue LoadError
+  puts 'Run `gem install gemika` for additional tasks'
+end
+
+task :default => 'matrix:spec'

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rails_state_machine'
+require 'pry-byebug'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler
+bundle install
+bundle exec rake matrix:install

data/gemfiles/Gemfile.5.1.pg

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Runtime dependencies
+gem 'rails', '~>5.1.0'
+gem 'pg'
+
+# Development dependencies
+gem 'rspec', '~>3.5'
+gem 'rake'
+gem 'pry-byebug'
+gem 'gemika'
+gem 'database_cleaner'
+
+# Gem under test
+gem 'rails_state_machine', :path => '..'

data/gemfiles/Gemfile.5.1.pg.lock

@@ -0,0 +1,149 @@
+PATH
+  remote: ..
+  specs:
+    rails_state_machine (1.0.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.4)
+      actionpack (= 5.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.4)
+      activesupport (= 5.1.4)
+      globalid (>= 0.3.6)
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    byebug (9.1.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    database_cleaner (1.6.2)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    gemika (0.3.2)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    nio4r (2.1.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pg (0.21.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.0)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    rack (2.0.3)
+    rack-test (0.7.0)
+      rack (>= 1.0, < 3)
+    rails (5.1.4)
+      actioncable (= 5.1.4)
+      actionmailer (= 5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      activemodel (= 5.1.4)
+      activerecord (= 5.1.4)
+      activesupport (= 5.1.4)
+      bundler (>= 1.3.0)
+      railties (= 5.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.2.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  gemika
+  pg
+  pry-byebug
+  rails (~> 5.1.0)
+  rails_state_machine!
+  rake
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   1.16.4

data/gemfiles/Gemfile.5.2.pg

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Runtime dependencies
+gem 'rails', '~>5.2.0'
+gem 'pg'
+
+# Development dependencies
+gem 'rspec', '~>3.5'
+gem 'rake'
+gem 'pry-byebug'
+gem 'gemika'
+gem 'database_cleaner'
+
+# Gem under test
+gem 'rails_state_machine', :path => '..'

data/gemfiles/Gemfile.5.2.pg.lock

@@ -0,0 +1,157 @@
+PATH
+  remote: ..
+  specs:
+    rails_state_machine (0.1.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    gemika (0.3.4)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    pg (1.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  gemika
+  pg
+  pry-byebug
+  rails (~> 5.2.0)
+  rails_state_machine!
+  rake
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   1.16.4

data/lib/rails_state_machine/event.rb

@@ -0,0 +1,104 @@
+module RailsStateMachine
+  class Event
+    Transition = Struct.new(:from, :to)
+
+    UndefinedStateError = Class.new(StandardError)
+    TransitionNotFoundError = Class.new(StandardError)
+    ExistingTransitionError = Class.new(StandardError)
+
+    attr_reader :name
+
+    def initialize(name, state_machine)
+      @name = name
+      @state_machine = state_machine
+
+      @before_validation = []
+      @before_save = []
+      @after_save = []
+      @after_commit = []
+
+      @transitions_by_state_name = {}
+    end
+
+    def configure(&block)
+      instance_eval(&block)
+    end
+
+    def transitions(**options)
+      if options.present?
+        add_transitions(options)
+      else
+        @transitions_by_state_name.values
+      end
+    end
+
+    def run_before_validation(record)
+      @before_validation.each do |block|
+        record.instance_eval(&block)
+      end
+    end
+
+    def run_before_save(record)
+      @before_save.each do |block|
+        record.instance_eval(&block)
+      end
+    end
+
+    def run_after_save(record)
+      @after_save.each do |block|
+        record.instance_eval(&block)
+      end
+    end
+
+    def run_after_commit(record)
+      @after_commit.each do |block|
+        record.instance_eval(&block)
+      end
+    end
+
+    def find_transition_from(state_name)
+      @transitions_by_state_name[state_name&.to_sym] || raise(TransitionNotFoundError, "#{name} does not transition from #{state_name}; defined are #{transitions}")
+    end
+
+    def allowed_from?(state_name)
+      @transitions_by_state_name.key?(state_name&.to_sym)
+    end
+
+    def future_state_name(state_name)
+      find_transition_from(state_name).to
+    end
+
+    private
+
+    def add_transitions(from:, to:)
+      froms = Array(from)
+      froms.each { |from| add_transition(from, to) }
+    end
+
+    def add_transition(from, to)
+      if !@state_machine.has_state?(from)
+        raise UndefinedStateError, "#{from} is not a valid state in the state machine of #{@state_machine.model}"
+      elsif allowed_from?(from)
+        raise ExistingTransitionError, "#{name} already defines a transition from #{from} (to #{future_state_name(from)})"
+      else
+        @transitions_by_state_name[from] = Transition.new(from, to)
+      end
+    end
+
+    def before_validation(&block)
+      @before_validation << block
+    end
+
+    def before_save(&block)
+      @before_save << block
+    end
+
+    def after_save(&block)
+      @after_save << block
+    end
+
+    def after_commit(&block)
+      @after_commit << block
+    end
+  end
+end

data/lib/rails_state_machine/model.rb

@@ -0,0 +1,21 @@
+module RailsStateMachine
+  module Model
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def state_machine(&block)
+        StateMachine.new(self).configure(&block)
+      end
+
+      def states
+        state_machine.state_names
+      end
+
+      def state_events
+        state_machine.event_names
+      end
+    end
+  end
+end

data/lib/rails_state_machine/state.rb

@@ -0,0 +1,14 @@
+module RailsStateMachine
+  class State
+    attr_reader :name, :options
+
+    def initialize(name, **options)
+      @name = name
+      @options = options
+    end
+
+    def initial?
+      !!options[:initial]
+    end
+  end
+end

data/lib/rails_state_machine/state_machine.rb

@@ -0,0 +1,229 @@
+module RailsStateMachine
+  class StateMachine
+    def initialize(model)
+      @model = model
+
+      model_constant('StateMachineMethods', Module.new)
+      @model.include(@model::StateMachineMethods)
+
+      @states_by_name = {}
+      @events_by_name = {}
+    end
+
+    def configure(&block)
+      instance_eval(&block)
+
+      define_state_methods
+      define_state_constants
+      register_initial_state
+
+      define_event_methods
+
+      register_callbacks
+      register_validations
+      register_state_machine
+
+      define_model_methods
+    end
+
+    def states
+      @states_by_name.values
+    end
+
+    def state_names
+      @states_by_name.keys
+    end
+
+    def events
+      @events_by_name.values
+    end
+
+    def event_names
+      @events_by_name.keys
+    end
+
+    def find_event(name)
+      @events_by_name.fetch(name.to_sym)
+    end
+
+    def has_state?(name)
+      @states_by_name.key?(name.to_sym)
+    end
+
+    private
+
+    def state(name, **options)
+      @states_by_name[name] = State.new(name, options)
+    end
+
+    def event(name, &block)
+      event = Event.new(name, self)
+      event.configure(&block)
+
+      model_methods do
+        define_method "#{event.name}" do |**attributes|
+          prepare_state_event_change(attributes.merge(state_event: event.name))
+          save
+        end
+
+        define_method "#{event.name}!" do |**attributes|
+          prepare_state_event_change(attributes.merge(state_event: event.name))
+          save!
+        end
+      end
+
+      @events_by_name[name] = event
+    end
+
+    def model_constant(name, value)
+      @model.const_set(name, value)
+    end
+
+    def model_methods(&block)
+      # Using a state machine defines several methods on the model.
+      # The model should be able to re-define them and `super` into the original method, if necessary.
+      # For that, we use a module to store all methods. The module is loaded into the model class.
+      @model::StateMachineMethods.module_eval(&block)
+    end
+
+    def define_state_methods
+      state_names.each do |state_name|
+        model_methods do
+          define_method "#{state_name}?" do
+            self.state.to_s == state_name.to_s
+          end
+        end
+      end
+    end
+
+    def define_state_constants
+      state_names.each do |state_name|
+        model_constant("STATE_#{state_name.upcase}", state_name)
+      end
+    end
+
+    def register_initial_state
+      initial_state = states.detect(&:initial?)
+      return unless initial_state
+
+      @model.after_initialize do
+        self.state ||= initial_state.name if new_record?
+      end
+    end
+
+    def define_event_methods
+      event_names.each do |event_name, event|
+        model_methods do
+          define_method "may_#{event_name}?" do
+            state_machine.find_event(event_name).allowed_from?(source_state)
+          end
+        end
+      end
+    end
+
+    def register_callbacks
+      @model.class_eval do
+        before_validation :run_state_event_before_validation
+        before_save :register_state_events_for_callbacks
+        before_save { flush_state_event_callbacks(:before_save) }
+        after_save { flush_state_event_callbacks(:after_save) }
+        after_commit { flush_state_event_callbacks(:after_commit) }
+      end
+    end
+
+    def register_validations
+      @model.class_eval do
+        after_validation :revert_state, if: -> { errors.any? }
+      end
+    end
+
+    def register_state_machine
+      @model.class_eval do
+        cattr_accessor :state_machine
+        delegate :state_machine, to: :class
+      end
+
+      @model.state_machine = self
+    end
+
+    def define_model_methods
+      model_methods do
+        def state_event=(event_name)
+          @next_state_machine_event = state_machine.find_event(event_name)
+          @state_before_state_event = source_state
+
+          # If the event can not transition from source_state, a TransitionNotFoundError will be raised
+          self.state = @next_state_machine_event.future_state_name(source_state).to_s
+        end
+
+        def state_event
+          @next_state_machine_event&.name
+        end
+
+        def source_state
+          if new_record?
+            state
+          else
+            state_in_database
+          end
+        end
+
+        private
+
+        def run_state_event_before_validation
+          # Since validations may be skipped, we will not register validation callbacks in @state_event_callbacks,
+          # but call them explicitly when before_validation callbacks are triggered.
+          @next_state_machine_event&.run_before_validation(self)
+        end
+
+        def register_state_events_for_callbacks
+          @state_event_callbacks ||= {
+            before_save: [],
+            after_save: [],
+            after_commit: []
+          }
+          @state_event_callbacks[:before_save] << @next_state_machine_event
+          @state_event_callbacks[:after_save] << @next_state_machine_event
+          @state_event_callbacks[:after_commit] << @next_state_machine_event
+          true
+        end
+
+        def flush_state_event_callbacks(name)
+          while (event = @state_event_callbacks[name].shift)
+            event.public_send("run_#{name}", self)
+          end
+        end
+
+        def unset_next_state_machine_event
+          @next_state_machine_event = nil
+        end
+
+        def revert_state
+          self.state = @state_before_state_event
+        end
+
+        def prepare_state_event_change(attributes)
+          if saved_changes?
+            # After calling `save`, ActiveRecord will flag the changes that it just stored as saved.
+            # https://github.com/rails/rails/blob/v5.1.4/activerecord/lib/active_record/attribute_methods/dirty.rb#L33-L46
+            #
+            # When taking multiple state events (e.g. a second event called inside an `after_save` callback) and thus
+            # saving after other changes were just saved, we need to mimic that behavior. Otherwise, ActiveRecord will
+            # print deprecation warnings like these:
+            #
+            #     DEPRECATION WARNING: The behavior of `attribute_was` inside of after callbacks will be changing in the
+            #     next version of Rails. The new return value will reflect the behavior of calling the method after
+            #     `save` returned (e.g. the opposite of what it returns now). To maintain the current behavior, use
+            #     `attribute_before_last_save` instead.
+            #
+            # These actually originate from ActiveRecord internals which try to determine the changes that should be
+            # stored for the second save. It is probably a shortcoming of ActiveRecord 5.1.x that will be fixed, but
+            # since the current/previous save was already successful, the right action is to just call `changes_applied`.
+            changes_applied
+          end
+          self.attributes = attributes
+        end
+      end
+    end
+  end
+end

data/lib/rails_state_machine/version.rb

@@ -0,0 +1,3 @@
+module RailsStateMachine
+  VERSION = '1.0.0'
+end

data/lib/rails_state_machine.rb

@@ -0,0 +1,5 @@
+require 'rails_state_machine/version'
+require 'rails_state_machine/state'
+require 'rails_state_machine/event'
+require 'rails_state_machine/state_machine'
+require 'rails_state_machine/model'

data/rails_state_machine.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_state_machine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_state_machine'
+  spec.version       = RailsStateMachine::VERSION
+  spec.authors       = ['Arne Hartherz', 'Emanuel Denzel']
+  spec.email         = ['arne.hartherz@makandra.de']
+
+  spec.summary       = %q{ActiveRecord-bound state machine}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/makandra/rails_state_machine'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.5'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rails_state_machine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arne Hartherz
+- Emanuel Denzel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: ActiveRecord-bound state machine
+email:
+- arne.hartherz@makandra.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/Gemfile.5.1.pg
+- gemfiles/Gemfile.5.1.pg.lock
+- gemfiles/Gemfile.5.2.pg
+- gemfiles/Gemfile.5.2.pg.lock
+- lib/rails_state_machine.rb
+- lib/rails_state_machine/event.rb
+- lib/rails_state_machine/model.rb
+- lib/rails_state_machine/state.rb
+- lib/rails_state_machine/state_machine.rb
+- lib/rails_state_machine/version.rb
+- rails_state_machine.gemspec
+homepage: https://github.com/makandra/rails_state_machine
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: ActiveRecord-bound state machine
+test_files: []