aasm 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7796dc2427b68fdbe78f6a79597c483b04f0cf70
-  data.tar.gz: 5b787a0ef49492a02f6beb7e5fffe6ab44c7724d
+  metadata.gz: 92b6a0df28245debe06c0ecbd3bd95e91b0cf323
+  data.tar.gz: 99bfa6652b17a26388b073ee431a1878ce961a4e
 SHA512:
-  metadata.gz: 2d429dd03690c213d5fed037d1d65b5fcc31f6ef83ff6a54ddd6092f46958f5bebe753d429bd8ecbd70e83ba210265895e83028fdbb5e5b8aab9031cea532a4f
-  data.tar.gz: 0b9fe7da0c4755fabb564fc05beb553d8fd666d6cc885079bef5eb6c97f2a08e81b8721bdac39b0453118b3a7835387eb2c4881855a19c9e72310b241d680c76
+  metadata.gz: d6cf5a7eea74d1c20108d48370d0f6048722efefb6af0110c70de56dd13032bcaabf57749add95ae25dc086faab8cbb5dcf9ad08ad4cafbafdfb400481ce1fd4
+  data.tar.gz: 90a92ba66f2b4d67c898a9076f324e0c99ce768aa5160f6d70dc74bca48e8ba4cf95317bf5e203b66985e9dcd77a52fb814dc65cc45f498dfeab20fde31fecb8

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 4.5.0
+
+ * add RSpec matchers `have_state`, `allow_event` and `allow_transition_to` (see [issue #147](https://github.com/aasm/aasm/issues/147) for details)
+ * add RSpec matcher `transition_from` (see [issue #178](https://github.com/aasm/aasm/issues/178) for details, thanks to [@thomasstephane](https://github.com/thomasstephane))
+
+## 4.4.1
+
+ * add support for rejecting certain events on inspection (see [issue #272](https://github.com/aasm/aasm/issues/272)  for details, thanks to [@dubroe](https://github.com/dubroe))
+
 ## 4.4.0
 
  * add support global transation callbacks (see [issue #221](https://github.com/aasm/aasm/issues/221) and [issue #253](https://github.com/aasm/aasm/issues/253) for details)

data/README.md

@@ -712,6 +712,8 @@ job.aasm.states(:permitted => true).map(&:name)
 # show all possible (triggerable) events (allowed by transitions)
 job.aasm.events.map(&:name)
 => [:sleep]
+job.aasm.events(:reject => :sleep).map(&:name)
+=> []
 
 # list states for select
 Job.aasm.states_for_select
@@ -719,6 +721,41 @@ Job.aasm.states_for_select
 ```
 
 
+### Testing
+
+AASM provides some matchers for [RSpec](http://rspec.info): `transition_from`, `have_state`, `allow_event` and `allow_transition_to`. Add `require 'aasm/rspec'` to your `spec_helper.rb` file and use them like this
+
+```ruby
+# classes with only the default state machine
+job = Job.new
+expect(job).to transition_from(:sleeping).to(:running).on_event(:run)
+expect(job).not_to transition_from(:sleeping).to(:cleaning).on_event(:run)
+expect(job).to have_state(:sleeping)
+expect(job).not_to have_state(:running)
+expect(job).to allow_event :run
+expect(job).to_not allow_event :clean
+expect(job).to allow_transition_to(:running)
+expect(job).to_not allow_transition_to(:cleaning)
+
+# classes with multiple state machine
+multiple = SimpleMultipleExample.new
+expect(multiple).to transition_from(:standing).to(:walking).on_event(:walk).on(:move)
+expect(multiple).to_not transition_from(:standing).to(:running).on_event(:walk).on(:move)
+expect(multiple).to have_state(:standing).on(:move)
+expect(multiple).not_to have_state(:walking).on(:move)
+expect(multiple).to allow_event(:walk).on(:move)
+expect(multiple).to_not allow_event(:hold).on(:move)
+expect(multiple).to allow_transition_to(:walking).on(:move)
+expect(multiple).to_not allow_transition_to(:running).on(:move)
+expect(multiple).to transition_from(:sleeping).to(:processing).on_event(:start).on(:work)
+expect(multiple).to_not transition_from(:sleeping).to(:sleeping).on_event(:start).on(:work)
+expect(multiple).to have_state(:sleeping).on(:work)
+expect(multiple).not_to have_state(:processing).on(:work)
+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)
+```
 
 ## <a id="installation">Installation ##
 

data/lib/aasm/instance_base.rb

@@ -49,6 +49,9 @@ module AASM
       state = options[:state] || current_state
       events = @instance.class.aasm(@name).events.select {|e| e.transitions_from_state?(state) }
 
+      options[:reject] = Array(options[:reject])
+      events.reject! { |e| options[:reject].include?(e.name) }
+
       if options[:permitted]
         # filters the results of events_for_current_state so that only those that
         # are really currently possible (given transition guards) are shown.

data/lib/aasm/rspec/allow_event.rb

@@ -0,0 +1,22 @@
+RSpec::Matchers.define :allow_event do |event|
+  match do |obj|
+    @state_machine_name ||= :default
+    obj.aasm(@state_machine_name).may_fire_event?(event)
+  end
+
+  chain :on do |state_machine_name|
+    @state_machine_name = state_machine_name
+  end
+
+  description do
+    "allow event #{expected} (on :#{@state_machine_name})"
+  end
+
+  failure_message do |obj|
+    "expected that the event :#{expected} would be allowed (on :#{@state_machine_name})"
+  end
+
+  failure_message_when_negated do |obj|
+    "expected that the event :#{expected} would not be allowed (on :#{@state_machine_name})"
+  end
+end

data/lib/aasm/rspec/allow_transition_to.rb

@@ -0,0 +1,22 @@
+RSpec::Matchers.define :allow_transition_to do |state|
+  match do |obj|
+    @state_machine_name ||= :default
+    obj.aasm(@state_machine_name).states(:permitted => true).include?(state)
+  end
+
+  chain :on do |state_machine_name|
+    @state_machine_name = state_machine_name
+  end
+
+  description do
+    "allow transition to #{expected} (on :#{@state_machine_name})"
+  end
+
+  failure_message do |obj|
+    "expected that the state :#{expected} would be reachable (on :#{@state_machine_name})"
+  end
+
+  failure_message_when_negated do |obj|
+    "expected that the state :#{expected} would not be reachable (on :#{@state_machine_name})"
+  end
+end

data/lib/aasm/rspec/have_state.rb

@@ -0,0 +1,22 @@
+RSpec::Matchers.define :have_state do |state|
+  match do |obj|
+    @state_machine_name ||= :default
+    obj.aasm(@state_machine_name).current_state == state.to_sym
+  end
+
+  chain :on do |state_machine_name|
+    @state_machine_name = state_machine_name
+  end
+
+  description do
+    "have state #{expected} (on :#{@state_machine_name})"
+  end
+
+  failure_message do |obj|
+    "expected that :#{obj.aasm(@state_machine_name).current_state} would be :#{expected} (on :#{@state_machine_name})"
+  end
+
+  failure_message_when_negated do |obj|
+    "expected that :#{obj.aasm(@state_machine_name).current_state} would not be :#{expected} (on :#{@state_machine_name})"
+  end
+end

data/lib/aasm/rspec/transition_from.rb

@@ -0,0 +1,32 @@
+RSpec::Matchers.define :transition_from do |from_state|
+  match do |obj|
+    @state_machine_name ||= :default
+    obj.aasm(@state_machine_name).current_state = from_state.to_sym
+    # expect(obj).to receive(:broadcast_event).with(@event.to_s, obj, from_state, @to_state)
+    obj.send(@event) && obj.aasm(@state_machine_name).current_state == @to_state.to_sym
+  end
+
+  chain :on do |state_machine_name|
+    @state_machine_name = state_machine_name
+  end
+
+  chain :to do |state|
+    @to_state = state
+  end
+
+  chain :on_event do |event|
+    @event = event
+  end
+
+  description do
+    "transition state to :#{@to_state} from :#{expected} on event :#{@event} (on :#{@state_machine_name})"
+  end
+
+  failure_message do |obj|
+    "expected that :#{obj.aasm(@state_machine_name).current_state} would be :#{@to_state} (on :#{@state_machine_name})"
+  end
+
+  failure_message_when_negated do |obj|
+    "expected that :#{obj.aasm(@state_machine_name).current_state} would not be :#{@to_state} (on :#{@state_machine_name})"
+  end
+end

data/lib/aasm/rspec.rb

@@ -0,0 +1,5 @@
+# relative-require all rspec files
+Dir[File.dirname(__FILE__) + '/rspec/*.rb'].each do |file|
+  require 'aasm/rspec/' + File.basename(file, File.extname(file))
+end
+

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.4.0"
+  VERSION = "4.5.0"
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
 require 'aasm'
 require 'rspec'
+require 'aasm/rspec'
 
 # require 'ruby-debug'; Debugger.settings[:autoeval] = true; debugger; rubys_debugger = 'annoying'
 # require 'ruby-debug/completion'

data/spec/unit/inspection_spec.rb

@@ -103,4 +103,9 @@ describe 'permitted events' do
     expect(foo.aasm.events(:permitted => true)).to include(:close)
     expect(foo.aasm.events(:permitted => true)).not_to include(:null)
   end
+
+  it 'should not include events in the reject option' do
+    expect(foo.aasm.events(:permitted => true, reject: :close)).not_to include(:close)
+    expect(foo.aasm.events(:permitted => true, reject: [:close])).not_to include(:close)
+  end
 end

data/spec/unit/rspec_matcher_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe 'state machine' do
+  let(:simple) { SimpleExample.new }
+  let(:multiple) { SimpleMultipleExample.new }
+
+  describe 'transition_from' do
+    it "works for simple state machines" do
+      expect(simple).to transition_from(:initialised).to(:filled_out).on_event(:fill_out)
+      expect(simple).to_not transition_from(:initialised).to(:authorised).on_event(:fill_out)
+    end
+
+    it "works for multiple state machines" do
+      expect(multiple).to transition_from(:standing).to(:walking).on_event(:walk).on(:move)
+      expect(multiple).to_not transition_from(:standing).to(:running).on_event(:walk).on(:move)
+
+      expect(multiple).to transition_from(:sleeping).to(:processing).on_event(:start).on(:work)
+      expect(multiple).to_not transition_from(:sleeping).to(:sleeping).on_event(:start).on(:work)
+    end
+  end
+
+  describe 'allow_transition_to' do
+    it "works for simple state machines" do
+      expect(simple).to allow_transition_to(:filled_out)
+      expect(simple).to_not allow_transition_to(:authorised)
+    end
+
+    it "works for multiple state machines" do
+      expect(multiple).to allow_transition_to(:walking).on(:move)
+      expect(multiple).to_not allow_transition_to(:standing).on(:move)
+
+      expect(multiple).to allow_transition_to(:processing).on(:work)
+      expect(multiple).to_not allow_transition_to(:sleeping).on(:work)
+    end
+  end
+
+  describe "have_state" do
+    it "works for simple state machines" do
+      expect(simple).to have_state :initialised
+      expect(simple).to_not have_state :filled_out
+      simple.fill_out
+      expect(simple).to have_state :filled_out
+    end
+
+    it "works for multiple state machines" do
+      expect(multiple).to have_state(:standing).on(:move)
+      expect(multiple).to_not have_state(:walking).on(:move)
+      multiple.walk
+      expect(multiple).to have_state(:walking).on(:move)
+
+      expect(multiple).to have_state(:sleeping).on(:work)
+      expect(multiple).to_not have_state(:processing).on(:work)
+      multiple.start
+      expect(multiple).to have_state(:processing).on(:work)
+    end
+  end
+
+  describe "allow_event" do
+    it "works for simple state machines" do
+      expect(simple).to allow_event :fill_out
+      expect(simple).to_not allow_event :authorise
+      simple.fill_out
+      expect(simple).to allow_event :authorise
+    end
+
+    it "works for multiple state machines" do
+      expect(multiple).to allow_event(:walk).on(:move)
+      expect(multiple).to_not allow_event(:hold).on(:move)
+      multiple.walk
+      expect(multiple).to allow_event(:hold).on(:move)
+
+      expect(multiple).to allow_event(:start).on(:work)
+      expect(multiple).to_not allow_event(:stop).on(:work)
+      multiple.start
+      expect(multiple).to allow_event(:stop).on(:work)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Scott Barron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -116,6 +116,11 @@ files:
 - lib/aasm/persistence/mongoid_persistence.rb
 - lib/aasm/persistence/plain_persistence.rb
 - lib/aasm/persistence/sequel_persistence.rb
+- lib/aasm/rspec.rb
+- lib/aasm/rspec/allow_event.rb
+- lib/aasm/rspec/allow_transition_to.rb
+- lib/aasm/rspec/have_state.rb
+- lib/aasm/rspec/transition_from.rb
 - lib/aasm/state_machine.rb
 - lib/aasm/version.rb
 - spec/database.rb
@@ -224,6 +229,7 @@ files:
 - spec/unit/persistence/sequel_persistence_spec.rb
 - spec/unit/readme_spec.rb
 - spec/unit/reloading_spec.rb
+- spec/unit/rspec_matcher_spec.rb
 - spec/unit/simple_example_spec.rb
 - spec/unit/simple_multiple_example_spec.rb
 - spec/unit/state_spec.rb
@@ -250,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: State machine mixin for Ruby objects
@@ -361,6 +367,7 @@ test_files:
 - spec/unit/persistence/sequel_persistence_spec.rb
 - spec/unit/readme_spec.rb
 - spec/unit/reloading_spec.rb
+- spec/unit/rspec_matcher_spec.rb
 - spec/unit/simple_example_spec.rb
 - spec/unit/simple_multiple_example_spec.rb
 - spec/unit/state_spec.rb