Merge pull request #269 from gocardless/v3.1.0

v3.1.0

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v3.1.0, 1 September 2017
+
+- Add support for Rails 5.0.x and 5.1.x (patch by [@kenchan0130](https://github.com/kenchan0130) and [@timrogers](https://github.com/timrogers))
+- Run tests in CircleCI instead of TravisCI (patch by [@timrogers](https://github.com/timrogers))
+- Update Rubocop and fix offences (patch by [@timrogers](https://github.com/timrogers))
+
 ## v3.0.0, 3 July 2017
 
 *Breaking changes*

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Harry Marr
+Copyright (c) 2013-2017 GoCardless
 
 MIT License
 

README.md

@@ -24,13 +24,19 @@ include JSON metadata set during a transition.
 - Database indices are used to offer database-level transaction duplication
 protection.
 
-## TL;DR Usage
+## Installation
+
+To get started, just add Statesman to your `Gemfile`, and then run `bundle`:
 
 ```ruby
+gem 'statesman', '~> 3.1.0'
+```
+
+## Usage
+
+First, create a state machine based on `Statesman::Machine`:
 
-#######################
-# State Machine Class #
-#######################
+```ruby
 class OrderStateMachine
   include Statesman::Machine
 
@@ -63,10 +69,11 @@ class OrderStateMachine
     MailerService.order_confirmation(order).deliver
   end
 end
+```
+
+Then, link it to your model:
 
-##############
-# Your Model #
-##############
+```ruby
 class Order < ActiveRecord::Base
   include Statesman::Adapters::ActiveRecordQueries
 
@@ -85,19 +92,20 @@ class Order < ActiveRecord::Base
   end
   private_class_method :initial_state
 end
+```
 
-####################
-# Transition Model #
-####################
+Next, you'll need to create a further model to represent state transitions:
+
+```ruby
 class OrderTransition < ActiveRecord::Base
   include Statesman::Adapters::ActiveRecordTransition
 
   belongs_to :order, inverse_of: :order_transitions
 end
 
-########################
-# Example method calls #
-########################
+Now, you can start working with your state machine:
+
+```ruby
 Order.first.state_machine.current_state # => "pending"
 Order.first.state_machine.allowed_transitions # => ["checking_out", "cancelled"]
 Order.first.state_machine.can_transition_to?(:cancelled) # => true/false
@@ -106,7 +114,6 @@ Order.first.state_machine.transition_to!(:cancelled) # => true/exception
 
 Order.in_state(:cancelled) # => [#<Order id: "123">]
 Order.not_in_state(:checking_out) # => [#<Order id: "123">]
-
 ```
 
 ## Persistence

lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "3.0.0".freeze
+  VERSION = "3.1.0".freeze
 end

statesman.gemspec

@@ -7,9 +7,9 @@ require 'statesman/version'
 Gem::Specification.new do |spec|
   spec.name          = "statesman"
   spec.version       = Statesman::VERSION
-  spec.authors       = ["Harry Marr", "Andy Appleton"]
+  spec.authors       = ["GoCardless"]
   spec.email         = ["[email protected]"]
-  spec.description   = 'A statesmanlike state machine library'
+  spec.description   = 'A statesman-like state machine library'
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/gocardless/statesman"
   spec.license       = "MIT"