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

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

rspec ruby state-machine

Last synced: 13 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/state-machines/state_machines-rspec
• Owner: state-machines
• License: mit
• Created: 2015-08-15T14:19:59.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-06-09T21:57:14.000Z (over 3 years ago)
• Last Synced: 2024-10-31T09:41:51.476Z (20 days ago)
• Topics: rspec, ruby, state-machine
• Language: Ruby
• Homepage:
• Size: 72.3 KB
• Stars: 16
• Watchers: 4
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# state_machines-rspec

[![Gem Version](https://badge.fury.io/rb/state_machines-rspec.svg)](https://badge.fury.io/rb/state_machines-rspec)

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

Custom RSpec matchers for [state-machines/state_machines](https://github.com/state-machines/state_machines).

This repo is forked from [modocache/state_machine_rspec](https://github.com/modocache/state_machine_rspec).

## Matchers

### `have_state` & `reject_state`

```ruby

describe Vehicle do

  it { is_expected.to have_states :parked, :idling, :stalled, :first_gear,

                                  :second_gear, :third_gear }

  it { is_expected.to reject_state :flying }

  it { is_expected.to have_states :active, :off, on: :alarm_state }

  it { is_expected.to have_state :active, on: :alarm_state, value: 1 }

  it { is_expected.to reject_states :broken, :ringing, on: :alarm_state }

end

```

### `handle_event` & `reject_event`

```ruby

describe Vehicle do

  it { is_expected.to handle_events :shift_down, :crash, when: :third_gear }

  it { is_expected.to handle_events :enable_alarm, :disable_alarm,

                                    when: :active, on: :alarm_state }

  it { is_expected.to reject_events :park, :ignite, :idle, :shift_up, :repair,

                                    when: :third_gear }

end

```

### `transition_from`

```ruby

describe Vehicle do

  it { is_expected.to transition_from :idling, to_state: :parked,

                                      on_event: :park }

  it { is_expected.to transition_from :idling, :first_gear,

                                      to_state: :parked, on_event: :park }

  it { is_expected.to transition_from :active, to_state: :off,

                                      on_event: :disable_alarm, on: :alarm_state }

  it { is_expected.to transition_from :_any_, to_state: :stoped, on_event: :stop }

end

```

## Installation

Add these lines to your application's Gemfile:

```ruby

group :test do

  gem 'state_machines-rspec'

end

```

(Note that the orginal `state_machine_rspec` used `state_machine` singular and I'm using `state_machines` plural to fit in with `state-machines/state_machines`.)

And include the matchers in `spec/spec_helper.rb` or `spec/rails_helper.rb`

```ruby

RSpec.configure do |config|

  config.include StateMachinesRspec::Matchers

end

```

## Contributing

1. Fork it

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 new Pull Request