https://github.com/state-machines/state_machines-mongoid

StateMachines Mongoid Integration
https://github.com/state-machines/state_machines-mongoid

mongoid ruby state-machine

Last synced: 12 months ago
JSON representation

StateMachines Mongoid Integration

• Host: GitHub
• URL: https://github.com/state-machines/state_machines-mongoid
• Owner: state-machines
• License: mit
• Created: 2014-09-08T17:34:53.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-06-25T15:48:30.000Z (almost 3 years ago)
• Last Synced: 2025-06-09T00:41:20.967Z (about 1 year ago)
• Topics: mongoid, ruby, state-machine
• Language: Ruby
• Homepage: https://github.com/state-machines/state_machines-mongoid
• Size: 50.8 KB
• Stars: 13
• Watchers: 2
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/state-machines/state_machines-mongoid.svg?branch=master)](https://travis-ci.org/state-machines/state_machines-mongoid)

[![Code Climate](https://codeclimate.com/github/state-machines/state_machines-mongoid.svg)](https://codeclimate.com/github/state-machines/state_machines-mongoid)

# StateMachines Mongoid Integration

The Mongoid integration adds support for automatically

saving the record, named scopes, validation errors.

## Installation

Add this line to your application's Gemfile:

    gem 'state_machines-mongoid'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install state_machines-mongoid

## Usage

```ruby

class Vehicle

  include Mongoid::Document

  state_machine :initial => :parked do

    before_transition :parked => any - :parked, :do => :put_on_seatbelt

    after_transition any => :parked do |vehicle, transition|

      vehicle.seatbelt_on = 'off'

    end

    around_transition :benchmark

    event :ignite do

      transition :parked => :idling

    end

    state :first_gear, :second_gear do

      validates_presence_of :seatbelt_on

    end

  end

  def put_on_seatbelt

    self.seatbelt_on = 'on'

  end

  def benchmark

    #...

    yield

    #...

  end

end

```

Dependencies

Mongoid 4.0+

## Contributing

1. Fork it ( https://github.com/state-machines/state_machines-mongoid/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request