state_machine_rspec 0.1.2 → 0.1.3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.1.3](https://github.com/modocache/state_machine_rspec/compare/v0.1.2...v0.1.3)
+
+- Add `#description` to matchers.
+- Update rspec dependency.
+
 ## [0.1.2](https://github.com/modocache/state_machine_rspec/compare/v0.1.1...v0.1.2)
 
 - state_machine dependency updated from "~> 1.1.0" to ">= 1.1.0".

data/lib/matchers/events/handle_event.rb

@@ -12,6 +12,12 @@ module StateMachineRspec
         !invalid_events?
       end
 
+      def description
+        message = super
+        message << " on #{state_machine_scope.inspect}" if state_machine_scope
+        "handle #{message}"
+      end
+
       private
 
       def invalid_events?

data/lib/matchers/events/matcher.rb

@@ -26,10 +26,22 @@ module StateMachineRspec
             "subclasses of #{self.class} must override matches_events?"
         end
 
+        def description
+          message = @events.map{ |event| event.inspect }.join(', ')
+          message << " when #{state_name.inspect}" if state_name
+          message
+        end
+
+        protected
+
+        def state_machine_scope
+          @options.fetch(:on, nil)
+        end
+
         private
 
         def enter_when_state
-          if state_name = @options.fetch(:when, nil)
+          if state_name
             unless when_state = @introspector.state(state_name)
               raise StateMachineIntrospectorError,
                 "#{@subject.class} does not define state: #{state_name}"
@@ -40,6 +52,10 @@ module StateMachineRspec
           end
         end
 
+        def state_name
+          @options.fetch(:when, nil)
+        end
+
         def undefined_events?
           undefined_events = @introspector.undefined_events(@events)
           unless undefined_events.empty?

data/lib/matchers/events/reject_event.rb

@@ -12,6 +12,12 @@ module StateMachineRspec
         !valid_events?
       end
 
+      def description
+        message = super
+        message << " on #{state_machine_scope.inspect}" if state_machine_scope
+        "reject #{message}"
+      end
+
       private
 
       def valid_events?

data/lib/matchers/states/have_state.rb

@@ -14,6 +14,13 @@ module StateMachineRspec
         @failure_message.nil?
       end
 
+      def description
+        message = super
+        message << " == #{state_value.inspect}" if state_value
+        message << " on #{state_machine_scope.inspect}" if state_machine_scope
+        "have #{message}"
+      end
+
       private
 
       def undefined_states?
@@ -27,7 +34,6 @@ module StateMachineRspec
       end
 
       def incorrect_value?
-        state_value = @options.fetch(:value, nil)
         if state_value && @introspector.state(@states.first).value != state_value
           @failure_message = "Expected #{@states.first} to have value #{state_value}"
           true

data/lib/matchers/states/matcher.rb

@@ -11,12 +11,16 @@ module StateMachineRspec
           @states = states
         end
 
+        def description
+          @states.map{ |event| event.inspect }.join(', ')
+        end
+
         def matches?(subject)
           raise_if_multiple_values
 
           @subject = subject
           @introspector = StateMachineIntrospector.new(@subject,
-                                                       @options.fetch(:on, nil))
+                                                       state_machine_scope)
 
           return false unless matches_states?(@states)
           @failure_message.nil?
@@ -27,10 +31,20 @@ module StateMachineRspec
             "subclasses of #{self.class} must override matches_states?"
         end
 
+        protected
+
+        def state_machine_scope
+          @options.fetch(:on, nil)
+        end
+
+        def state_value
+          @options.fetch(:value, nil)
+        end
+
         private
 
         def raise_if_multiple_values
-          if @states.count > 1 && @options.fetch(:value, nil)
+          if @states.count > 1 && state_value
             raise ArgumentError, 'cannot make value assertions on ' +
                                  'multiple states at once'
           end

data/lib/matchers/states/reject_state.rb

@@ -12,6 +12,12 @@ module StateMachineRspec
         no_defined_states?
       end
 
+      def description
+        message = super
+        message << " on #{state_machine_scope.inspect}" if state_machine_scope
+        "not have #{message}"
+      end
+
       private
 
       def no_defined_states?

data/lib/state_machine_rspec/state_machine_introspector.rb

@@ -21,7 +21,7 @@ class StateMachineIntrospector
   end
 
   def defined_states(states)
-    states.keep_if { |s| state_defined? s }
+    states.select { |s| state_defined? s }
   end
 
   def undefined_events(events)
@@ -29,7 +29,7 @@ class StateMachineIntrospector
   end
 
   def valid_events(events)
-    events.keep_if { |e| valid_event? e }
+    events.select { |e| valid_event? e }
   end
 
   def invalid_events(events)

data/lib/state_machine_rspec/version.rb

@@ -1,3 +1,3 @@
 module StateMachineRspec
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/matchers/events/handle_event_spec.rb

@@ -106,4 +106,30 @@ describe StateMachineRspec::Matchers::HandleEventMatcher do
       end
     end
   end
+
+  describe '#description' do
+    context 'with no options' do
+      let(:matcher) { described_class.new([:placate, :mollify]) }
+
+      it 'returns a string description' do
+        matcher.description.should == 'handle :placate, :mollify'
+      end
+    end
+
+    context 'when :when state is specified' do
+      let(:matcher) { described_class.new([:destroy_food, when: :hangry]) }
+
+      it 'mentions the requisite state' do
+        matcher.description.should == 'handle :destroy_food when :hangry'
+      end
+    end
+
+    context 'when :on is specified' do
+      let(:matcher) { described_class.new([:ensmarmify, on: :tired_investors]) }
+
+      it 'mentions the state machine variable' do
+        matcher.description.should == 'handle :ensmarmify on :tired_investors'
+      end
+    end
+  end
 end

data/spec/matchers/events/reject_event_spec.rb

@@ -106,4 +106,30 @@ describe StateMachineRspec::Matchers::RejectEventMatcher do
       end
     end
   end
+
+  describe '#description' do
+    context 'with no options' do
+      let(:matcher) { described_class.new([:makeadealify, :hustlinate]) }
+
+      it 'returns a string description' do
+        matcher.description.should == 'reject :makeadealify, :hustlinate'
+      end
+    end
+
+    context 'when :when state is specified' do
+      let(:matcher) { described_class.new([:begargle, when: :sleep_encrusted]) }
+
+      it 'mentions the requisite state' do
+        matcher.description.should == 'reject :begargle when :sleep_encrusted'
+      end
+    end
+
+    context 'when :on is specified' do
+      let(:matcher) { described_class.new([:harrangue, on: :suspicious_crowd]) }
+
+      it 'mentions the state machine variable' do
+        matcher.description.should == 'reject :harrangue on :suspicious_crowd'
+      end
+    end
+  end
 end

data/spec/matchers/states/have_state_spec.rb

@@ -107,4 +107,30 @@ describe StateMachineRspec::Matchers::HaveStateMatcher do
       end
     end
   end
+
+  describe '#description' do
+    context 'with no options' do
+      let(:matcher) { described_class.new([:fancy_shirt, :cracked_toenail]) }
+
+      it 'returns a string description' do
+        matcher.description.should == 'have :fancy_shirt, :cracked_toenail'
+      end
+    end
+
+    context 'when :value is specified' do
+      let(:matcher) { described_class.new([:mustache, value: :really_shady]) }
+
+      it 'mentions the requisite state' do
+        matcher.description.should == 'have :mustache == :really_shady'
+      end
+    end
+
+    context 'when :on state machine is specified' do
+      let(:matcher) { described_class.new([:lunch, on: :tuesday]) }
+
+      it 'mentions the state machine variable' do
+        matcher.description.should == 'have :lunch on :tuesday'
+      end
+    end
+  end
 end

data/spec/matchers/states/reject_state_spec.rb

@@ -78,4 +78,22 @@ describe StateMachineRspec::Matchers::RejectStateMatcher do
       end
     end
   end
+
+  describe '#description' do
+    context 'with no options' do
+      let(:matcher) { described_class.new([:mustard, :tomatoes]) }
+
+      it 'returns a string description' do
+        matcher.description.should == 'not have :mustard, :tomatoes'
+      end
+    end
+
+    context 'when :on state machine is specified' do
+      let(:matcher) { described_class.new([:peanut_butter, on: :toast]) }
+
+      it 'mentions the state machine variable' do
+        matcher.description.should == 'not have :peanut_butter on :toast'
+      end
+    end
+  end
 end

data/state_machine_rspec.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rb-fsevent'
   spec.add_development_dependency 'terminal-notifier-guard'
 
-  spec.add_dependency 'rspec', '~> 2.9'
+  spec.add_dependency 'rspec', '~> 2.14'
   spec.add_dependency 'state_machine', '>= 1.1.0'
   spec.add_dependency 'activesupport'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machine_rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,7 +114,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: state_machine
   requirement: !ruby/object:Gem::Requirement
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: RSpec matchers for state_machine.